blob: 15b18b42f78b4aaaece422eabed19edf7e7193bc [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001/***********************************************************
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00002Copyright (c) 2000, BeOpen.com.
3Copyright (c) 1995-2000, Corporation for National Research Initiatives.
4Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
5All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +00006
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00007See the file "Misc/COPYRIGHT" for information on usage and
8redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +00009******************************************************************/
10
Guido van Rossum3f5da241990-12-20 15:06:42 +000011/* Traceback implementation */
12
Guido van Rossum65bf9f21997-04-29 18:33:38 +000013#include "Python.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000014
15#include "compile.h"
16#include "frameobject.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000017#include "structmember.h"
Guido van Rossum7169dbb1992-02-26 15:17:59 +000018#include "osdefs.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000019
20typedef struct _tracebackobject {
Guido van Rossum65bf9f21997-04-29 18:33:38 +000021 PyObject_HEAD
Guido van Rossum3f5da241990-12-20 15:06:42 +000022 struct _tracebackobject *tb_next;
Guido van Rossum65bf9f21997-04-29 18:33:38 +000023 PyFrameObject *tb_frame;
Guido van Rossum3f5da241990-12-20 15:06:42 +000024 int tb_lasti;
25 int tb_lineno;
26} tracebackobject;
27
28#define OFF(x) offsetof(tracebackobject, x)
29
30static struct memberlist tb_memberlist[] = {
31 {"tb_next", T_OBJECT, OFF(tb_next)},
32 {"tb_frame", T_OBJECT, OFF(tb_frame)},
33 {"tb_lasti", T_INT, OFF(tb_lasti)},
34 {"tb_lineno", T_INT, OFF(tb_lineno)},
35 {NULL} /* Sentinel */
36};
37
Guido van Rossum65bf9f21997-04-29 18:33:38 +000038static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000039tb_getattr(tracebackobject *tb, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +000040{
Guido van Rossum65bf9f21997-04-29 18:33:38 +000041 return PyMember_Get((char *)tb, tb_memberlist, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +000042}
43
44static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000045tb_dealloc(tracebackobject *tb)
Guido van Rossum3f5da241990-12-20 15:06:42 +000046{
Guido van Rossumd724b232000-03-13 16:01:29 +000047 Py_TRASHCAN_SAFE_BEGIN(tb)
Guido van Rossum65bf9f21997-04-29 18:33:38 +000048 Py_XDECREF(tb->tb_next);
49 Py_XDECREF(tb->tb_frame);
Guido van Rossumb18618d2000-05-03 23:44:39 +000050 PyObject_DEL(tb);
Guido van Rossumd724b232000-03-13 16:01:29 +000051 Py_TRASHCAN_SAFE_END(tb)
Guido van Rossum3f5da241990-12-20 15:06:42 +000052}
53
Guido van Rossum9d78d8d1995-09-18 21:29:36 +000054#define Tracebacktype PyTraceBack_Type
55#define is_tracebackobject PyTraceBack_Check
Guido van Rossum681d79a1995-07-18 14:51:37 +000056
Guido van Rossum65bf9f21997-04-29 18:33:38 +000057PyTypeObject Tracebacktype = {
58 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum3f5da241990-12-20 15:06:42 +000059 0,
60 "traceback",
61 sizeof(tracebackobject),
62 0,
Guido van Rossum13836d91994-08-29 12:09:58 +000063 (destructor)tb_dealloc, /*tp_dealloc*/
Guido van Rossum3f5da241990-12-20 15:06:42 +000064 0, /*tp_print*/
Guido van Rossum13836d91994-08-29 12:09:58 +000065 (getattrfunc)tb_getattr, /*tp_getattr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +000066 0, /*tp_setattr*/
67 0, /*tp_compare*/
68 0, /*tp_repr*/
69 0, /*tp_as_number*/
70 0, /*tp_as_sequence*/
71 0, /*tp_as_mapping*/
72};
73
Guido van Rossum3f5da241990-12-20 15:06:42 +000074static tracebackobject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000075newtracebackobject(tracebackobject *next, PyFrameObject *frame, int lasti,
76 int lineno)
Guido van Rossum3f5da241990-12-20 15:06:42 +000077{
78 tracebackobject *tb;
79 if ((next != NULL && !is_tracebackobject(next)) ||
Guido van Rossum65bf9f21997-04-29 18:33:38 +000080 frame == NULL || !PyFrame_Check(frame)) {
81 PyErr_BadInternalCall();
Guido van Rossum3f5da241990-12-20 15:06:42 +000082 return NULL;
83 }
Guido van Rossum65bf9f21997-04-29 18:33:38 +000084 tb = PyObject_NEW(tracebackobject, &Tracebacktype);
Guido van Rossum3f5da241990-12-20 15:06:42 +000085 if (tb != NULL) {
Guido van Rossum65bf9f21997-04-29 18:33:38 +000086 Py_XINCREF(next);
Guido van Rossum3f5da241990-12-20 15:06:42 +000087 tb->tb_next = next;
Guido van Rossum65bf9f21997-04-29 18:33:38 +000088 Py_XINCREF(frame);
Guido van Rossum3f5da241990-12-20 15:06:42 +000089 tb->tb_frame = frame;
90 tb->tb_lasti = lasti;
91 tb->tb_lineno = lineno;
92 }
93 return tb;
94}
95
Guido van Rossum3f5da241990-12-20 15:06:42 +000096int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000097PyTraceBack_Here(PyFrameObject *frame)
Guido van Rossum3f5da241990-12-20 15:06:42 +000098{
Guido van Rossuma027efa1997-05-05 20:56:21 +000099 PyThreadState *tstate = frame->f_tstate;
100 tracebackobject *oldtb = (tracebackobject *) tstate->curexc_traceback;
101 tracebackobject *tb = newtracebackobject(oldtb,
102 frame, frame->f_lasti, frame->f_lineno);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000103 if (tb == NULL)
104 return -1;
Guido van Rossuma027efa1997-05-05 20:56:21 +0000105 tstate->curexc_traceback = (PyObject *)tb;
106 Py_XDECREF(oldtb);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000107 return 0;
108}
109
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000110static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000111tb_displayline(PyObject *f, char *filename, int lineno, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000112{
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000113 int err = 0;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000114 FILE *xfp;
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000115 char linebuf[1000];
Guido van Rossum3f5da241990-12-20 15:06:42 +0000116 int i;
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000117 if (filename == NULL || name == NULL)
118 return -1;
Guido van Rossum13836d91994-08-29 12:09:58 +0000119#ifdef MPW
120 /* This is needed by MPW's File and Line commands */
121#define FMT " File \"%.900s\"; line %d # in %s\n"
122#else
123 /* This is needed by Emacs' compile command */
124#define FMT " File \"%.900s\", line %d, in %s\n"
125#endif
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126 xfp = fopen(filename, "r");
127 if (xfp == NULL) {
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000128 /* Search tail of filename in sys.path before giving up */
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000129 PyObject *path;
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000130 char *tail = strrchr(filename, SEP);
131 if (tail == NULL)
132 tail = filename;
133 else
134 tail++;
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000135 path = PySys_GetObject("path");
136 if (path != NULL && PyList_Check(path)) {
137 int npath = PyList_Size(path);
Guido van Rossum582acec2000-06-28 22:07:35 +0000138 size_t taillen = strlen(tail);
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000139 char namebuf[MAXPATHLEN+1];
140 for (i = 0; i < npath; i++) {
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000141 PyObject *v = PyList_GetItem(path, i);
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000142 if (v == NULL) {
143 PyErr_Clear();
144 break;
145 }
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000146 if (PyString_Check(v)) {
Guido van Rossum582acec2000-06-28 22:07:35 +0000147 size_t len;
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000148 len = PyString_Size(v);
Guido van Rossumbfd5d7551994-09-29 09:38:04 +0000149 if (len + 1 + taillen >= MAXPATHLEN)
150 continue; /* Too long */
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000151 strcpy(namebuf, PyString_AsString(v));
Guido van Rossum582acec2000-06-28 22:07:35 +0000152 if (strlen(namebuf) != len)
Guido van Rossumbfd5d7551994-09-29 09:38:04 +0000153 continue; /* v contains '\0' */
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000154 if (len > 0 && namebuf[len-1] != SEP)
155 namebuf[len++] = SEP;
156 strcpy(namebuf+len, tail);
157 xfp = fopen(namebuf, "r");
158 if (xfp != NULL) {
159 filename = namebuf;
160 break;
161 }
162 }
163 }
164 }
Guido van Rossum3f5da241990-12-20 15:06:42 +0000165 }
Guido van Rossum13836d91994-08-29 12:09:58 +0000166 sprintf(linebuf, FMT, filename, lineno, name);
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000167 err = PyFile_WriteString(linebuf, f);
168 if (xfp == NULL || err != 0)
169 return err;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000170 for (i = 0; i < lineno; i++) {
Guido van Rossum3aca6531999-09-18 20:49:39 +0000171 char* pLastChar = &linebuf[sizeof(linebuf)-2];
172 do {
173 *pLastChar = '\0';
174 if (fgets(linebuf, sizeof linebuf, xfp) == NULL)
175 break;
176 /* fgets read *something*; if it didn't get as
177 far as pLastChar, it must have found a newline
178 or hit the end of the file; if pLastChar is \n,
179 it obviously found a newline; else we haven't
180 yet seen a newline, so must continue */
181 } while (*pLastChar != '\0' && *pLastChar != '\n');
Guido van Rossum3f5da241990-12-20 15:06:42 +0000182 }
183 if (i == lineno) {
Guido van Rossum7169dbb1992-02-26 15:17:59 +0000184 char *p = linebuf;
Guido van Rossume78c5d01995-07-07 22:45:41 +0000185 while (*p == ' ' || *p == '\t' || *p == '\014')
Guido van Rossum3f5da241990-12-20 15:06:42 +0000186 p++;
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000187 err = PyFile_WriteString(" ", f);
188 if (err == 0) {
189 err = PyFile_WriteString(p, f);
190 if (err == 0 && strchr(p, '\n') == NULL)
191 err = PyFile_WriteString("\n", f);
192 }
Guido van Rossum3f5da241990-12-20 15:06:42 +0000193 }
194 fclose(xfp);
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000195 return err;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000196}
197
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000198static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000199tb_printinternal(tracebackobject *tb, PyObject *f, int limit)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000200{
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000201 int err = 0;
Guido van Rossum67a5fdb1993-12-17 12:09:14 +0000202 int depth = 0;
203 tracebackobject *tb1 = tb;
204 while (tb1 != NULL) {
205 depth++;
206 tb1 = tb1->tb_next;
207 }
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000208 while (tb != NULL && err == 0) {
Guido van Rossumb3f515a1997-01-24 04:02:55 +0000209 if (depth <= limit) {
Guido van Rossum73237c51997-05-05 20:53:25 +0000210 if (Py_OptimizeFlag)
211 tb->tb_lineno = PyCode_Addr2Line(
212 tb->tb_frame->f_code, tb->tb_lasti);
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000213 err = tb_displayline(f,
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000214 PyString_AsString(
215 tb->tb_frame->f_code->co_filename),
Guido van Rossum13836d91994-08-29 12:09:58 +0000216 tb->tb_lineno,
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000217 PyString_AsString(tb->tb_frame->f_code->co_name));
Guido van Rossumb3f515a1997-01-24 04:02:55 +0000218 }
Guido van Rossum67a5fdb1993-12-17 12:09:14 +0000219 depth--;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000220 tb = tb->tb_next;
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000221 if (err == 0)
222 err = PyErr_CheckSignals();
Guido van Rossum3f5da241990-12-20 15:06:42 +0000223 }
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000224 return err;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000225}
226
227int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000228PyTraceBack_Print(PyObject *v, PyObject *f)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000229{
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000230 int err;
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000231 PyObject *limitv;
Guido van Rossum67a5fdb1993-12-17 12:09:14 +0000232 int limit = 1000;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000233 if (v == NULL)
234 return 0;
235 if (!is_tracebackobject(v)) {
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000236 PyErr_BadInternalCall();
Guido van Rossum3f5da241990-12-20 15:06:42 +0000237 return -1;
238 }
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000239 limitv = PySys_GetObject("tracebacklimit");
240 if (limitv && PyInt_Check(limitv)) {
241 limit = PyInt_AsLong(limitv);
Guido van Rossum67a5fdb1993-12-17 12:09:14 +0000242 if (limit <= 0)
243 return 0;
244 }
Guido van Rossum6d108872000-03-31 00:39:23 +0000245 err = PyFile_WriteString("Traceback (most recent call last):\n", f);
Guido van Rossum7e8d26d1997-05-22 22:35:47 +0000246 if (!err)
247 err = tb_printinternal((tracebackobject *)v, f, limit);
248 return err;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000249}