| 
									
										
										
										
											1991-02-19 12:39:46 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2000-07-08 23:37:28 +00:00
										 |  |  | #ifndef Py_TRACEBACK_H
 | 
					
						
							|  |  |  | #define Py_TRACEBACK_H
 | 
					
						
							|  |  |  | #ifdef __cplusplus
 | 
					
						
							|  |  |  | extern "C" { | 
					
						
							|  |  |  | #endif
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  | #include "pystate.h"
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-03-21 18:37:23 +00:00
										 |  |  | struct _frame; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											1990-12-20 15:06:42 +00:00
										 |  |  | /* Traceback interface */ | 
					
						
							| 
									
										
										
										
											2010-12-03 20:14:31 +00:00
										 |  |  | #ifndef Py_LIMITED_API
 | 
					
						
							| 
									
										
										
										
											2004-03-21 18:37:23 +00:00
										 |  |  | typedef struct _traceback { | 
					
						
							| 
									
										
										
										
											2010-06-17 23:08:50 +00:00
										 |  |  |     PyObject_HEAD | 
					
						
							|  |  |  |     struct _traceback *tb_next; | 
					
						
							|  |  |  |     struct _frame *tb_frame; | 
					
						
							|  |  |  |     int tb_lasti; | 
					
						
							|  |  |  |     int tb_lineno; | 
					
						
							| 
									
										
										
										
											2004-03-21 18:37:23 +00:00
										 |  |  | } PyTracebackObject; | 
					
						
							| 
									
										
										
										
											2010-12-03 20:14:31 +00:00
										 |  |  | #endif
 | 
					
						
							| 
									
										
										
										
											1994-12-30 15:33:50 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2002-08-12 07:21:58 +00:00
										 |  |  | PyAPI_FUNC(int) PyTraceBack_Here(struct _frame *); | 
					
						
							|  |  |  | PyAPI_FUNC(int) PyTraceBack_Print(PyObject *, PyObject *); | 
					
						
							| 
									
										
										
										
											2010-12-03 20:14:31 +00:00
										 |  |  | #ifndef Py_LIMITED_API
 | 
					
						
							| 
									
										
										
										
											2010-06-17 23:08:50 +00:00
										 |  |  | PyAPI_FUNC(int) _Py_DisplaySourceLine(PyObject *, PyObject *, int, int); | 
					
						
							| 
									
										
										
										
											2015-06-21 15:59:46 +03:00
										 |  |  | PyAPI_FUNC(void) _PyTraceback_Add(const char *, const char *, int); | 
					
						
							| 
									
										
										
										
											2010-12-03 20:14:31 +00:00
										 |  |  | #endif
 | 
					
						
							| 
									
										
										
										
											1993-07-28 09:05:47 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2002-03-19 16:02:35 +00:00
										 |  |  | /* Reveal traceback type so we can typecheck traceback objects */ | 
					
						
							| 
									
										
										
										
											2002-08-12 07:21:58 +00:00
										 |  |  | PyAPI_DATA(PyTypeObject) PyTraceBack_Type; | 
					
						
							| 
									
										
										
										
											2007-12-19 02:45:37 +00:00
										 |  |  | #define PyTraceBack_Check(v) (Py_TYPE(v) == &PyTraceBack_Type)
 | 
					
						
							| 
									
										
										
										
											1995-07-18 14:21:06 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-09-11 11:03:14 +03:00
										 |  |  | #ifndef Py_LIMITED_API
 | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  | /* Write the Python traceback into the file 'fd'. For example:
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |        Traceback (most recent call first): | 
					
						
							|  |  |  |          File "xxx", line xxx in <xxx> | 
					
						
							|  |  |  |          File "xxx", line xxx in <xxx> | 
					
						
							|  |  |  |          ... | 
					
						
							|  |  |  |          File "xxx", line xxx in <xxx> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    This function is written for debug purpose only, to dump the traceback in | 
					
						
							|  |  |  |    the worst case: after a segmentation fault, at fatal error, etc. That's why, | 
					
						
							|  |  |  |    it is very limited. Strings are truncated to 100 characters and encoded to | 
					
						
							|  |  |  |    ASCII with backslashreplace. It doesn't write the source code, only the | 
					
						
							|  |  |  |    function name, filename and line number of each frame. Write only the first | 
					
						
							|  |  |  |    100 frames: if the traceback is truncated, write the line " ...". | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    This function is signal safe. */ | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-01 13:06:43 +03:00
										 |  |  | PyAPI_FUNC(void) _Py_DumpTraceback( | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  |     int fd, | 
					
						
							|  |  |  |     PyThreadState *tstate); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* Write the traceback of all threads into the file 'fd'. current_thread can be
 | 
					
						
							| 
									
										
										
										
											2016-03-16 22:45:24 +01:00
										 |  |  |    NULL. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    Return NULL on success, or an error message on error. | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  |    This function is written for debug purpose only. It calls | 
					
						
							|  |  |  |    _Py_DumpTraceback() for each thread, and so has the same limitations. It | 
					
						
							|  |  |  |    only write the traceback of the first 100 threads: write "..." if there are | 
					
						
							|  |  |  |    more threads. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-03-16 22:45:24 +01:00
										 |  |  |    If current_tstate is NULL, the function tries to get the Python thread state | 
					
						
							|  |  |  |    of the current thread. It is not an error if the function is unable to get | 
					
						
							|  |  |  |    the current Python thread state. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    If interp is NULL, the function tries to get the interpreter state from | 
					
						
							|  |  |  |    the current Python thread state, or from | 
					
						
							|  |  |  |    _PyGILState_GetInterpreterStateUnsafe() in last resort. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    It is better to pass NULL to interp and current_tstate, the function tries | 
					
						
							|  |  |  |    different options to retrieve these informations. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  |    This function is signal safe. */ | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-01 13:06:43 +03:00
										 |  |  | PyAPI_FUNC(const char*) _Py_DumpTracebackThreads( | 
					
						
							| 
									
										
										
										
											2016-03-16 22:45:24 +01:00
										 |  |  |     int fd, | 
					
						
							|  |  |  |     PyInterpreterState *interp, | 
					
						
							|  |  |  |     PyThreadState *current_tstate); | 
					
						
							| 
									
										
										
										
											2016-09-11 11:03:14 +03:00
										 |  |  | #endif /* !Py_LIMITED_API */
 | 
					
						
							| 
									
										
										
										
											2011-03-31 01:31:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-03-15 21:49:37 +01:00
										 |  |  | #ifndef Py_LIMITED_API
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* Write a Unicode object into the file descriptor fd. Encode the string to
 | 
					
						
							|  |  |  |    ASCII using the backslashreplace error handler. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    Do nothing if text is not a Unicode object. The function accepts Unicode | 
					
						
							|  |  |  |    string which is not ready (PyUnicode_WCHAR_KIND). | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    This function is signal safe. */ | 
					
						
							|  |  |  | PyAPI_FUNC(void) _Py_DumpASCII(int fd, PyObject *text); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* Format an integer as decimal into the file descriptor fd.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    This function is signal safe. */ | 
					
						
							| 
									
										
										
										
											2016-03-23 10:32:26 +01:00
										 |  |  | PyAPI_FUNC(void) _Py_DumpDecimal( | 
					
						
							|  |  |  |     int fd, | 
					
						
							|  |  |  |     unsigned long value); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* Format an integer as hexadecimal into the file descriptor fd with at least
 | 
					
						
							|  |  |  |    width digits. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    The maximum width is sizeof(unsigned long)*2 digits. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |    This function is signal safe. */ | 
					
						
							|  |  |  | PyAPI_FUNC(void) _Py_DumpHexadecimal( | 
					
						
							|  |  |  |     int fd, | 
					
						
							|  |  |  |     unsigned long value, | 
					
						
							|  |  |  |     Py_ssize_t width); | 
					
						
							| 
									
										
										
										
											2016-03-15 21:49:37 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | #endif   /* !Py_LIMITED_API */
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											1993-07-28 09:05:47 +00:00
										 |  |  | #ifdef __cplusplus
 | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | #endif
 | 
					
						
							|  |  |  | #endif /* !Py_TRACEBACK_H */
 |