home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / pystate.h < prev    next >
C/C++ Source or Header  |  2003-12-30  |  5KB  |  173 lines
  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.     PyObject *codec_search_path;
  26.     PyObject *codec_search_cache;
  27.     PyObject *codec_error_registry;
  28.  
  29. #ifdef HAVE_DLOPEN
  30.     int dlopenflags;
  31. #endif
  32.  
  33. } PyInterpreterState;
  34.  
  35.  
  36. /* State unique per thread */
  37.  
  38. struct _frame; /* Avoid including frameobject.h */
  39.  
  40. /* Py_tracefunc return -1 when raising an exception, or 0 for success. */
  41. typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *);
  42.  
  43. /* The following values are used for 'what' for tracefunc functions: */
  44. #define PyTrace_CALL 0
  45. #define PyTrace_EXCEPTION 1
  46. #define PyTrace_LINE 2
  47. #define PyTrace_RETURN 3
  48.  
  49. typedef struct _ts {
  50.  
  51.     struct _ts *next;
  52.     PyInterpreterState *interp;
  53.  
  54.     struct _frame *frame;
  55.     int recursion_depth;
  56.     int tracing;
  57.     int use_tracing;
  58.  
  59.     Py_tracefunc c_profilefunc;
  60.     Py_tracefunc c_tracefunc;
  61.     PyObject *c_profileobj;
  62.     PyObject *c_traceobj;
  63.  
  64.     PyObject *curexc_type;
  65.     PyObject *curexc_value;
  66.     PyObject *curexc_traceback;
  67.  
  68.     PyObject *exc_type;
  69.     PyObject *exc_value;
  70.     PyObject *exc_traceback;
  71.  
  72.     PyObject *dict;
  73.  
  74.     int tick_counter;
  75.     int gilstate_counter;
  76.  
  77.     PyObject *async_exc; /* Asynchronous exception to raise */
  78.     long thread_id; /* Thread id where this tstate was created */
  79.  
  80.     /* XXX signal handlers should also be here */
  81.  
  82. } PyThreadState;
  83.  
  84.  
  85. PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void);
  86. PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *);
  87. PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *);
  88.  
  89. PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *);
  90. PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *);
  91. PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *);
  92. #ifdef WITH_THREAD
  93. PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void);
  94. #endif
  95.  
  96. PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void);
  97. PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *);
  98. PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void);
  99. PyAPI_FUNC(int) PyThreadState_SetAsyncExc(long, PyObject *);
  100.  
  101.  
  102. /* Variable and macro for in-line access to current thread state */
  103.  
  104. PyAPI_DATA(PyThreadState *) _PyThreadState_Current;
  105.  
  106. #ifdef Py_DEBUG
  107. #define PyThreadState_GET() PyThreadState_Get()
  108. #else
  109. #define PyThreadState_GET() (_PyThreadState_Current)
  110. #endif
  111.  
  112. typedef 
  113.     enum {PyGILState_LOCKED, PyGILState_UNLOCKED}
  114.         PyGILState_STATE;
  115.  
  116. /* Ensure that the current thread is ready to call the Python
  117.    C API, regardless of the current state of Python, or of its
  118.    thread lock.  This may be called as many times as desired
  119.    by a thread so long as each call is matched with a call to 
  120.    PyGILState_Release().  In general, other thread-state APIs may 
  121.    be used between _Ensure() and _Release() calls, so long as the 
  122.    thread-state is restored to its previous state before the Release().
  123.    For example, normal use of the Py_BEGIN_ALLOW_THREADS/
  124.    Py_END_ALLOW_THREADS macros are acceptable.
  125.  
  126.    The return value is an opaque "handle" to the thread state when
  127.    PyGILState_Acquire() was called, and must be passed to
  128.    PyGILState_Release() to ensure Python is left in the same state. Even
  129.    though recursive calls are allowed, these handles can *not* be shared - 
  130.    each unique call to PyGILState_Ensure must save the handle for its 
  131.    call to PyGILState_Release.
  132.  
  133.    When the function returns, the current thread will hold the GIL.
  134.  
  135.    Failure is a fatal error.
  136. */
  137. PyAPI_FUNC(PyGILState_STATE) PyGILState_Ensure(void);
  138.  
  139. /* Release any resources previously acquired.  After this call, Python's
  140.    state will be the same as it was prior to the corresponding
  141.    PyGILState_Acquire call (but generally this state will be unknown to 
  142.    the caller, hence the use of the GILState API.)
  143.  
  144.    Every call to PyGILState_Ensure must be matched by a call to 
  145.    PyGILState_Release on the same thread.
  146. */
  147. PyAPI_FUNC(void) PyGILState_Release(PyGILState_STATE);
  148.  
  149. /* Helper/diagnostic function - get the current thread state for
  150.    this thread.  May return NULL if no GILState API has been used 
  151.    on the current thread.  Note the main thread always has such a 
  152.    thread-state, even if no auto-thread-state call has been made 
  153.    on the main thread.
  154. */
  155. PyAPI_FUNC(PyThreadState *) PyGILState_GetThisThreadState(void);
  156.  
  157. /* Routines for advanced debuggers, requested by David Beazley.
  158.    Don't use unless you know what you are doing! */
  159. PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void);
  160. PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *);
  161. PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *);
  162. PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *);
  163.  
  164. typedef struct _frame *(*PyThreadFrameGetter)(PyThreadState *self_);
  165.  
  166. /* hook for PyEval_GetFrame(), requested for Psyco */
  167. PyAPI_DATA(PyThreadFrameGetter) _PyThreadState_GetFrame;
  168.  
  169. #ifdef __cplusplus
  170. }
  171. #endif
  172. #endif /* !Py_PYSTATE_H */
  173.