blender-archive/source/blender/python/intern/bpy_capi_utils.c

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Campbell Barton
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/python/intern/bpy_capi_utils.c
 *  \ingroup pythonintern
 *
 * This file contains Blender/Python utility functions to help implementing API's.
 * This is not related to a particular module.
 */

#include <Python.h>

#include "BLI_utildefines.h"
#include "BLI_dynstr.h"

#include "bpy_capi_utils.h"

#include "MEM_guardedalloc.h"

#include "BKE_report.h"
#include "BKE_context.h"

#include "BLT_translation.h"

#include "../generic/py_capi_utils.h"

static bContext *__py_context = NULL;
bContext   *BPy_GetContext(void) { return __py_context; }
void        BPy_SetContext(bContext *C) { __py_context = C; }

char *BPy_enum_as_string(const EnumPropertyItem *item)
{
	DynStr *dynstr = BLI_dynstr_new();
	const EnumPropertyItem *e;
	char *cstring;

	for (e = item; item->identifier; item++) {
		if (item->identifier[0])
			BLI_dynstr_appendf(dynstr, (e == item) ? "'%s'" : ", '%s'", item->identifier);
	}

	cstring = BLI_dynstr_get_cstring(dynstr);
	BLI_dynstr_free(dynstr);
	return cstring;
}

short BPy_reports_to_error(ReportList *reports, PyObject *exception, const bool clear)
{
	char *report_str;

	report_str = BKE_reports_string(reports, RPT_ERROR);

	if (clear == true) {
		BKE_reports_clear(reports);
	}

	if (report_str) {
		PyErr_SetString(exception, report_str);
		MEM_freeN(report_str);
	}

	return (report_str == NULL) ? 0 : -1;
}


bool BPy_errors_to_report_ex(ReportList *reports, const bool use_full, const bool use_location)
{
	PyObject *pystring;

	if (!PyErr_Occurred())
		return 1;
	
	/* less hassle if we allow NULL */
	if (reports == NULL) {
		PyErr_Print();
		PyErr_Clear();
		return 1;
	}
	
	if (use_full) {
		pystring = PyC_ExceptionBuffer();
	}
	else {
		pystring = PyC_ExceptionBuffer_Simple();
	}
	
	if (pystring == NULL) {
		BKE_report(reports, RPT_ERROR, "Unknown py-exception, could not convert");
		return 0;
	}

	if (use_location) {
		const char *filename;
		int lineno;

		PyObject *pystring_format;  /* workaround, see below */
		const char *cstring;

		PyC_FileAndNum(&filename, &lineno);
		if (filename == NULL) {
			filename = "<unknown location>";
		}

#if 0 /* ARG!. workaround for a bug in blenders use of vsnprintf */
		BKE_reportf(reports, RPT_ERROR, "%s\nlocation: %s:%d\n", _PyUnicode_AsString(pystring), filename, lineno);
#else
		pystring_format = PyUnicode_FromFormat(
		        TIP_("%s\nlocation: %s:%d\n"),
		        _PyUnicode_AsString(pystring), filename, lineno);

		cstring = _PyUnicode_AsString(pystring_format);
		BKE_report(reports, RPT_ERROR, cstring);

		/* not exactly needed. just for testing */
		fprintf(stderr, TIP_("%s\nlocation: %s:%d\n"), cstring, filename, lineno);

		Py_DECREF(pystring_format);  /* workaround */
#endif
	}
	else {
		BKE_report(reports, RPT_ERROR, _PyUnicode_AsString(pystring));
	}


	Py_DECREF(pystring);
	return 1;
}

bool BPy_errors_to_report(ReportList *reports)
{
	return BPy_errors_to_report_ex(reports, true, true);
}