Include/pystate.h

   1
   2 /* Thread and interpreter state structures and their interfaces */
   3
   4
   5 #ifndef Py_PYSTATE_H
   6 #define Py_PYSTATE_H
   7 #ifdef __cplusplus
   8 extern "C" {
   9 #endif
  10
  11 /* State shared between threads */
  12
  13 struct _ts; /* Forward */
  14 struct _is; /* Forward */
  15
  16 typedef struct _is {
  17
  18     struct _is *next;
  19     struct _ts *tstate_head;
  20
  21     PyObject *modules;
  22     PyObject *sysdict;
  23     PyObject *builtins;
  24
  25 #ifdef HAVE_DLOPEN
  26     int dlopenflags;
  27 #endif
  28
  29 } PyInterpreterState;
  30
  31
  32 /* State unique per thread */
  33
  34 struct _frame; /* Avoid including frameobject.h */
  35
  36 /* Py_tracefunc return -1 when raising an exception, or 0 for success. */
  37 typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *);
  38
  39 /* The following values are used for 'what' for tracefunc functions: */
  40 #define PyTrace_CALL 0
  41 #define PyTrace_EXCEPTION 1
  42 #define PyTrace_LINE 2
  43 #define PyTrace_RETURN 3
  44
  45 typedef struct _ts {
  46
  47     struct _ts *next;
  48     PyInterpreterState *interp;
  49
  50     struct _frame *frame;
  51     int recursion_depth;
  52     int tracing;
  53     int use_tracing;
  54
  55     Py_tracefunc c_profilefunc;
  56     Py_tracefunc c_tracefunc;
  57     PyObject *c_profileobj;
  58     PyObject *c_traceobj;
  59
  60     PyObject *curexc_type;
  61     PyObject *curexc_value;
  62     PyObject *curexc_traceback;
  63
  64     PyObject *exc_type;
  65     PyObject *exc_value;
  66     PyObject *exc_traceback;
  67
  68     PyObject *dict;
  69
  70     /* XXX signal handlers should also be here */
  71
  72 } PyThreadState;
  73
  74
  75 PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void);
  76 PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *);
  77 PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *);
  78
  79 PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *);
  80 PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *);
  81 PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *);
  82 #ifdef WITH_THREAD
  83 PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void);
  84 #endif
  85
  86 PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void);
  87 PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *);
  88 PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void);
  89
  90
  91 /* Variable and macro for in-line access to current thread state */
  92
  93 PyAPI_DATA(PyThreadState *) _PyThreadState_Current;
  94
  95 #ifdef Py_DEBUG
  96 #define PyThreadState_GET() PyThreadState_Get()
  97 #else
  98 #define PyThreadState_GET() (_PyThreadState_Current)
  99 #endif
 100
 101 /* Routines for advanced debuggers, requested by David Beazley.
 102    Don't use unless you know what you are doing! */
 103 PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void);
 104 PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *);
 105 PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *);
 106 PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111 #endif /* !Py_PYSTATE_H */