bpy_traceback.c

Go to the documentation of this file.

/*
 * $Id: bpy_traceback.c 36395 2011-04-30 13:58:31Z campbellbarton $
 *
 * ***** 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.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <Python.h>
#include <frameobject.h>

#include "bpy_traceback.h"

static const char *traceback_filepath(PyTracebackObject *tb)
{
        return _PyUnicode_AsString(tb->tb_frame->f_code->co_filename);
}

/* copied from pythonrun.c, 3.2.0 */
static int
parse_syntax_error(PyObject *err, PyObject **message, const char **filename,
                                   int *lineno, int *offset, const char **text)
{
        long hold;
        PyObject *v;

        /* old style errors */
        if (PyTuple_Check(err))
                return PyArg_ParseTuple(err, "O(ziiz)", message, filename,
                                                                lineno, offset, text);

        /* new style errors.  `err' is an instance */

        if (! (v = PyObject_GetAttrString(err, "msg")))
                goto finally;
        *message = v;

        if (!(v = PyObject_GetAttrString(err, "filename")))
                goto finally;
        if (v == Py_None)
                *filename = NULL;
        else if (! (*filename = _PyUnicode_AsString(v)))
                goto finally;

        Py_DECREF(v);
        if (!(v = PyObject_GetAttrString(err, "lineno")))
                goto finally;
        hold = PyLong_AsLong(v);
        Py_DECREF(v);
        v = NULL;
        if (hold < 0 && PyErr_Occurred())
                goto finally;
        *lineno = (int)hold;

        if (!(v = PyObject_GetAttrString(err, "offset")))
                goto finally;
        if (v == Py_None) {
                *offset = -1;
                Py_DECREF(v);
                v = NULL;
        }
        else {
                hold = PyLong_AsLong(v);
                Py_DECREF(v);
                v = NULL;
                if (hold < 0 && PyErr_Occurred())
                        goto finally;
                *offset = (int)hold;
        }

        if (!(v = PyObject_GetAttrString(err, "text")))
                goto finally;
        if (v == Py_None)
                *text = NULL;
        else if (!PyUnicode_Check(v) ||
                         !(*text = _PyUnicode_AsString(v)))
                goto finally;
        Py_DECREF(v);
        return 1;

finally:
        Py_XDECREF(v);
        return 0;
}
/* end copied function! */


void python_script_error_jump(const char *filepath, int *lineno, int *offset)
{
        PyObject *exception, *value;
        PyTracebackObject *tb;

        *lineno= -1;
        *offset= 0;

        PyErr_Fetch(&exception, &value, (PyObject **)&tb);

        if(exception && PyErr_GivenExceptionMatches(exception, PyExc_SyntaxError)) {
                /* no traceback available when SyntaxError.
                 * python has no api's to this. reference parse_syntax_error() from pythonrun.c */
                PyErr_NormalizeException(&exception, &value, (PyObject **)&tb);
                PyErr_Restore(exception, value, (PyObject *)tb);        /* takes away reference! */

                if(value) { /* should always be true */
                        PyObject *message;
                        const char *filename, *text;

                        if(parse_syntax_error(value, &message, &filename, lineno, offset, &text)) {
                                /* python adds a '/', prefix, so check for both */
                                if(     (strcmp(filename, filepath) == 0) || 
                                        ((filename[0] == '\\' || filename[0] == '/') && strcmp(filename + 1, filepath) == 0)
                                ) {
                                        /* good */
                                }
                                else {
                                        *lineno= -1;
                                }
                        }
                        else {
                                *lineno= -1;
                        }
                }
        }
        else {
                PyErr_NormalizeException(&exception, &value, (PyObject **)&tb);
                PyErr_Restore(exception, value, (PyObject *)tb);        /* takes away reference! */
                PyErr_Print();

                for(tb= (PyTracebackObject *)PySys_GetObject("last_traceback"); tb && (PyObject *)tb != Py_None; tb= tb->tb_next) {
                        if(strcmp(traceback_filepath(tb), filepath) != 0) {
                                *lineno= tb->tb_lineno;
                                break;
                        }
                }
        }
}