[libsigrokdecode.git] / exception.c

/*
 * This file is part of the libsigrokdecode project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "libsigrokdecode.h"
#include <stdarg.h>
#include <glib.h>

static char *py_stringify(PyObject *py_obj)
{
	PyObject *py_str, *py_bytes;
	char *str = NULL;

	/* Note: Caller already ran PyGILState_Ensure(). */

	if (!py_obj)
		return NULL;

	py_str = PyObject_Str(py_obj);
	if (!py_str || !PyUnicode_Check(py_str))
		goto cleanup;

	py_bytes = PyUnicode_AsUTF8String(py_str);
	if (!py_bytes)
		goto cleanup;

	str = g_strdup(PyBytes_AsString(py_bytes));
	Py_DECREF(py_bytes);

cleanup:
	Py_XDECREF(py_str);
	if (!str) {
		PyErr_Clear();
		srd_dbg("Failed to stringify object.");
	}
	return str;
}

static char *py_get_string_attr(PyObject *py_obj, const char *attr)
{
	PyObject *py_str, *py_bytes;
	char *str = NULL;

	/* Note: Caller already ran PyGILState_Ensure(). */

	if (!py_obj)
		return NULL;

	py_str = PyObject_GetAttrString(py_obj, attr);
	if (!py_str || !PyUnicode_Check(py_str))
		goto cleanup;

	py_bytes = PyUnicode_AsUTF8String(py_str);
	if (!py_bytes)
		goto cleanup;

	str = g_strdup(PyBytes_AsString(py_bytes));
	Py_DECREF(py_bytes);

cleanup:
	Py_XDECREF(py_str);
	if (!str) {
		PyErr_Clear();
		srd_dbg("Failed to get object attribute %s.", attr);
	}
	return str;
}

/** @private */
SRD_PRIV void srd_exception_catch(const char *format, ...)
{
	int i, ret;
	va_list args;
	PyObject *py_etype, *py_evalue, *py_etraceback;
	PyObject *py_mod, *py_func, *py_tracefmt;
	char *msg, *etype_name, *evalue_str, *outstr;
	const char *etype_name_fallback;
	PyGILState_STATE gstate;
	GString *s;

	py_etype = py_evalue = py_etraceback = py_mod = py_func = NULL;

	va_start(args, format);
	msg = g_strdup_vprintf(format, args);
	va_end(args);

	gstate = PyGILState_Ensure();

	PyErr_Fetch(&py_etype, &py_evalue, &py_etraceback);
	if (!py_etype) {
		/* No current exception, so just print the message. */
		srd_err("%s.", msg);
		goto cleanup;
	}
	PyErr_NormalizeException(&py_etype, &py_evalue, &py_etraceback);

	etype_name = py_get_string_attr(py_etype, "__name__");
	evalue_str = py_stringify(py_evalue);
	etype_name_fallback = (etype_name) ? etype_name : "(unknown exception)";

	if (evalue_str)
		srd_err("%s: %s: %s", etype_name_fallback, msg, evalue_str);
	else
		srd_err("%s: %s.", etype_name_fallback, msg);

	g_free(evalue_str);
	g_free(etype_name);

	/* If there is no traceback object, we are done. */
	if (!py_etraceback)
		goto cleanup;

	py_mod = py_import_by_name("traceback");
	if (!py_mod)
		goto cleanup;

	py_func = PyObject_GetAttrString(py_mod, "format_exception");
	if (!py_func || !PyCallable_Check(py_func))
		goto cleanup;

	/* Call into Python to format the stack trace. */
	py_tracefmt = PyObject_CallFunctionObjArgs(py_func,
			py_etype, py_evalue, py_etraceback, NULL);
	if (!py_tracefmt || !PyList_Check(py_tracefmt))
		goto cleanup;

	s = g_string_sized_new(128);
	for (i = 0; i < PyList_Size(py_tracefmt); i++) {
		ret = py_listitem_as_str(py_tracefmt, i, &outstr);
		if (ret == 0) {
			s = g_string_append(s, outstr);
			g_free(outstr);
		}
	}
	srd_err("%s", s->str);
	g_string_free(s, TRUE);

	Py_DECREF(py_tracefmt);

cleanup:
	Py_XDECREF(py_func);
	Py_XDECREF(py_mod);
	Py_XDECREF(py_etraceback);
	Py_XDECREF(py_evalue);
	Py_XDECREF(py_etype);

	/* Just in case. */
	PyErr_Clear();

	PyGILState_Release(gstate);

	g_free(msg);
}
Commit	Line	Data
ec871a27	1	/*
50bd5d25	2	* This file is part of the libsigrokdecode project.
ec871a27 BV	3	*
	4	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
36784362	20	#include <config.h>
f6c7eade MC	21	#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
f6c7eade MC	22	#include "libsigrokdecode.h"
ec871a27 BV	23	#include <stdarg.h>
ec871a27 BV	24	#include <glib.h>
201a85a8 DE	25
	26	static char py_stringify(PyObject py_obj)
	27	{
	28	PyObject py_str, py_bytes;
	29	char *str = NULL;
	30
514b2edc UH	31	/* Note: Caller already ran PyGILState_Ensure(). */
514b2edc UH	32
201a85a8 DE	33	if (!py_obj)
	34	return NULL;
	35
	36	py_str = PyObject_Str(py_obj);
	37	if (!py_str \|\| !PyUnicode_Check(py_str))
	38	goto cleanup;
	39
	40	py_bytes = PyUnicode_AsUTF8String(py_str);
	41	if (!py_bytes)
	42	goto cleanup;
	43
	44	str = g_strdup(PyBytes_AsString(py_bytes));
	45	Py_DECREF(py_bytes);
	46
	47	cleanup:
	48	Py_XDECREF(py_str);
	49	if (!str) {
	50	PyErr_Clear();
	51	srd_dbg("Failed to stringify object.");
	52	}
	53	return str;
	54	}
	55
	56	static char py_get_string_attr(PyObject py_obj, const char *attr)
	57	{
	58	PyObject py_str, py_bytes;
	59	char *str = NULL;
	60
514b2edc UH	61	/* Note: Caller already ran PyGILState_Ensure(). */
514b2edc UH	62
201a85a8 DE	63	if (!py_obj)
	64	return NULL;
	65
	66	py_str = PyObject_GetAttrString(py_obj, attr);
	67	if (!py_str \|\| !PyUnicode_Check(py_str))
	68	goto cleanup;
	69
	70	py_bytes = PyUnicode_AsUTF8String(py_str);
	71	if (!py_bytes)
	72	goto cleanup;
	73
	74	str = g_strdup(PyBytes_AsString(py_bytes));
	75	Py_DECREF(py_bytes);
	76
	77	cleanup:
	78	Py_XDECREF(py_str);
	79	if (!str) {
	80	PyErr_Clear();
	81	srd_dbg("Failed to get object attribute %s.", attr);
	82	}
	83	return str;
	84	}
ec871a27	85
57790bc8	86	/** @private */
aafeeaea	87	SRD_PRIV void srd_exception_catch(const char *format, ...)
ec871a27	88	{
752086e9	89	int i, ret;
ec871a27	90	va_list args;
201a85a8	91	PyObject py_etype, py_evalue, *py_etraceback;
e9dd2fea	92	PyObject py_mod, py_func, *py_tracefmt;
752086e9	93	char msg, etype_name, evalue_str, outstr;
201a85a8	94	const char *etype_name_fallback;
514b2edc	95	PyGILState_STATE gstate;
752086e9	96	GString *s;
ec871a27	97
201a85a8	98	py_etype = py_evalue = py_etraceback = py_mod = py_func = NULL;
ec871a27	99
201a85a8 DE	100	va_start(args, format);
	101	msg = g_strdup_vprintf(format, args);
	102	va_end(args);
ec871a27	103
514b2edc UH	104	gstate = PyGILState_Ensure();
514b2edc UH	105
201a85a8 DE	106	PyErr_Fetch(&py_etype, &py_evalue, &py_etraceback);
	107	if (!py_etype) {
	108	/* No current exception, so just print the message. */
	109	srd_err("%s.", msg);
	110	goto cleanup;
ec871a27	111	}
201a85a8	112	PyErr_NormalizeException(&py_etype, &py_evalue, &py_etraceback);
ec871a27	113
201a85a8 DE	114	etype_name = py_get_string_attr(py_etype, "__name__");
	115	evalue_str = py_stringify(py_evalue);
	116	etype_name_fallback = (etype_name) ? etype_name : "(unknown exception)";
	117
	118	if (evalue_str)
	119	srd_err("%s: %s: %s", etype_name_fallback, msg, evalue_str);
ec871a27	120	else
201a85a8	121	srd_err("%s: %s.", etype_name_fallback, msg);
ec871a27	122
201a85a8 DE	123	g_free(evalue_str);
	124	g_free(etype_name);
	125
	126	/* If there is no traceback object, we are done. */
	127	if (!py_etraceback)
	128	goto cleanup;
	129
e9dd2fea	130	py_mod = py_import_by_name("traceback");
201a85a8 DE	131	if (!py_mod)
	132	goto cleanup;
	133
	134	py_func = PyObject_GetAttrString(py_mod, "format_exception");
	135	if (!py_func \|\| !PyCallable_Check(py_func))
	136	goto cleanup;
	137
	138	/* Call into Python to format the stack trace. */
	139	py_tracefmt = PyObject_CallFunctionObjArgs(py_func,
	140	py_etype, py_evalue, py_etraceback, NULL);
752086e9	141	if (!py_tracefmt \|\| !PyList_Check(py_tracefmt))
201a85a8 DE	142	goto cleanup;
201a85a8 DE	143
752086e9 UH	144	s = g_string_sized_new(128);
	145	for (i = 0; i < PyList_Size(py_tracefmt); i++) {
	146	ret = py_listitem_as_str(py_tracefmt, i, &outstr);
	147	if (ret == 0) {
	148	s = g_string_append(s, outstr);
	149	g_free(outstr);
	150	}
ec871a27	151	}
752086e9 UH	152	srd_err("%s", s->str);
	153	g_string_free(s, TRUE);
	154
	155	Py_DECREF(py_tracefmt);
ec871a27	156
201a85a8 DE	157	cleanup:
	158	Py_XDECREF(py_func);
	159	Py_XDECREF(py_mod);
	160	Py_XDECREF(py_etraceback);
	161	Py_XDECREF(py_evalue);
	162	Py_XDECREF(py_etype);
ec871a27 BV	163
	164	/* Just in case. */
	165	PyErr_Clear();
201a85a8	166
514b2edc UH	167	PyGILState_Release(gstate);
514b2edc UH	168
201a85a8	169	g_free(msg);
ec871a27	170	}