blob: dc3864b8eb3dbf0ef37c495de51a67a834d255a7 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_CEVAL_H
2#define Py_CEVAL_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007
Guido van Rossumff4949e1992-08-05 19:58:53 +00008/* Interface to random parts in ceval.c */
Guido van Rossum3f5da241990-12-20 15:06:42 +00009
Mark Hammond91a681d2002-08-12 07:21:58 +000010PyAPI_FUNC(PyObject *) PyEval_CallObjectWithKeywords(
11 PyObject *, PyObject *, PyObject *);
Guido van Rossuma0490311991-07-27 21:33:03 +000012
Guido van Rossum83684531999-03-17 18:44:39 +000013/* DLL-level Backwards compatibility: */
14#undef PyEval_CallObject
Mark Hammond91a681d2002-08-12 07:21:58 +000015PyAPI_FUNC(PyObject *) PyEval_CallObject(PyObject *, PyObject *);
Guido van Rossum83684531999-03-17 18:44:39 +000016
Guido van Rossumd7ed6831997-08-30 15:02:50 +000017/* Inline this */
18#define PyEval_CallObject(func,arg) \
19 PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)
20
Mark Hammond91a681d2002-08-12 07:21:58 +000021PyAPI_FUNC(PyObject *) PyEval_CallFunction(PyObject *obj, char *format, ...);
22PyAPI_FUNC(PyObject *) PyEval_CallMethod(PyObject *obj,
Fred Drake5eb6d4e2000-07-08 23:37:28 +000023 char *methodname, char *format, ...);
Guido van Rossum3d109a01998-08-08 20:53:36 +000024
Mark Hammond91a681d2002-08-12 07:21:58 +000025PyAPI_FUNC(void) PyEval_SetProfile(Py_tracefunc, PyObject *);
26PyAPI_FUNC(void) PyEval_SetTrace(Py_tracefunc, PyObject *);
Fred Drake55fb6e02001-06-27 19:18:03 +000027
Guido van Rossum6297a7a2003-02-19 15:53:17 +000028struct _frame; /* Avoid including frameobject.h */
29
Mark Hammond91a681d2002-08-12 07:21:58 +000030PyAPI_FUNC(PyObject *) PyEval_GetBuiltins(void);
31PyAPI_FUNC(PyObject *) PyEval_GetGlobals(void);
32PyAPI_FUNC(PyObject *) PyEval_GetLocals(void);
Guido van Rossum6297a7a2003-02-19 15:53:17 +000033PyAPI_FUNC(struct _frame *) PyEval_GetFrame(void);
Mark Hammond91a681d2002-08-12 07:21:58 +000034PyAPI_FUNC(int) PyEval_GetRestricted(void);
Tim Peters5ba58662001-07-16 02:29:45 +000035
36/* Look at the current frame's (if any) code's co_flags, and turn on
37 the corresponding compiler flags in cf->cf_flags. Return 1 if any
38 flag was set, else return 0. */
Mark Hammond91a681d2002-08-12 07:21:58 +000039PyAPI_FUNC(int) PyEval_MergeCompilerFlags(PyCompilerFlags *cf);
Guido van Rossum3f5da241990-12-20 15:06:42 +000040
Mark Hammond91a681d2002-08-12 07:21:58 +000041PyAPI_FUNC(int) Py_FlushLine(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000042
Mark Hammond91a681d2002-08-12 07:21:58 +000043PyAPI_FUNC(int) Py_AddPendingCall(int (*func)(void *), void *arg);
44PyAPI_FUNC(int) Py_MakePendingCalls(void);
Guido van Rossum95664081994-09-14 13:23:36 +000045
Armin Rigo2b3eb402003-10-28 12:05:48 +000046/* Protection against deeply nested recursive calls */
Mark Hammond91a681d2002-08-12 07:21:58 +000047PyAPI_FUNC(void) Py_SetRecursionLimit(int);
48PyAPI_FUNC(int) Py_GetRecursionLimit(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000049
Armin Rigo2b3eb402003-10-28 12:05:48 +000050#define Py_EnterRecursiveCall(where) \
51 (_Py_MakeRecCheck(PyThreadState_GET()->recursion_depth) && \
52 _Py_CheckRecursiveCall(where))
53#define Py_LeaveRecursiveCall() \
54 (--PyThreadState_GET()->recursion_depth)
55PyAPI_FUNC(int) _Py_CheckRecursiveCall(char *where);
56PyAPI_DATA(int) _Py_CheckRecursionLimit;
57#ifdef USE_STACKCHECK
58# define _Py_MakeRecCheck(x) (++(x) > --_Py_CheckRecursionLimit)
59#else
60# define _Py_MakeRecCheck(x) (++(x) > _Py_CheckRecursionLimit)
61#endif
62
Mark Hammond91a681d2002-08-12 07:21:58 +000063PyAPI_FUNC(char *) PyEval_GetFuncName(PyObject *);
64PyAPI_FUNC(char *) PyEval_GetFuncDesc(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +000065
Jeremy Hylton985eba52003-02-05 23:13:00 +000066PyAPI_FUNC(PyObject *) PyEval_GetCallStats(PyObject *);
67
Skip Montanarod581d772002-09-03 20:10:45 +000068/* this used to be handled on a per-thread basis - now just two globals */
69PyAPI_DATA(volatile int) _Py_Ticker;
70PyAPI_DATA(int) _Py_CheckInterval;
71
Guido van Rossumff4949e1992-08-05 19:58:53 +000072/* Interface for threads.
73
74 A module that plans to do a blocking system call (or something else
75 that lasts a long time and doesn't touch Python data) can allow other
76 threads to run as follows:
77
78 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000079 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000080 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000081 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000082 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000083
Guido van Rossumcaa63801995-01-12 11:45:45 +000084 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
85 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000086 To leave the block in the middle (e.g., with return), you must insert
Skip Montanaro682c25a2000-09-15 18:19:27 +000087 a line containing Py_BLOCK_THREADS before the return, e.g.
Guido van Rossumff4949e1992-08-05 19:58:53 +000088
89 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000090 Py_BLOCK_THREADS
91 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000092 return NULL;
93 }
94
95 An alternative is:
96
Guido van Rossumcaa63801995-01-12 11:45:45 +000097 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000098 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000099 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000100 return NULL;
101 }
Guido van Rossumcaa63801995-01-12 11:45:45 +0000102 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000103
104 For convenience, that the value of 'errno' is restored across
Skip Montanaro682c25a2000-09-15 18:19:27 +0000105 Py_END_ALLOW_THREADS and Py_BLOCK_THREADS.
Guido van Rossumff4949e1992-08-05 19:58:53 +0000106
Guido van Rossumcaa63801995-01-12 11:45:45 +0000107 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
108 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +0000109
Guido van Rossumcaa63801995-01-12 11:45:45 +0000110 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +0000111 initthread() in "threadmodule.c".
112
113 Note that not yet all candidates have been converted to use this
114 mechanism!
115*/
116
Mark Hammond91a681d2002-08-12 07:21:58 +0000117PyAPI_FUNC(PyThreadState *) PyEval_SaveThread(void);
118PyAPI_FUNC(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000119
Guido van Rossumb6775db1994-08-01 11:34:53 +0000120#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000121
Mark Hammond91a681d2002-08-12 07:21:58 +0000122PyAPI_FUNC(void) PyEval_InitThreads(void);
123PyAPI_FUNC(void) PyEval_AcquireLock(void);
124PyAPI_FUNC(void) PyEval_ReleaseLock(void);
125PyAPI_FUNC(void) PyEval_AcquireThread(PyThreadState *tstate);
126PyAPI_FUNC(void) PyEval_ReleaseThread(PyThreadState *tstate);
127PyAPI_FUNC(void) PyEval_ReInitThreads(void);
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000128
Guido van Rossumcaa63801995-01-12 11:45:45 +0000129#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000130 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000131 _save = PyEval_SaveThread();
132#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
133#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
134#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000135 }
136
Guido van Rossumb6775db1994-08-01 11:34:53 +0000137#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000138
Guido van Rossumcaa63801995-01-12 11:45:45 +0000139#define Py_BEGIN_ALLOW_THREADS {
140#define Py_BLOCK_THREADS
141#define Py_UNBLOCK_THREADS
142#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000143
Guido van Rossumb6775db1994-08-01 11:34:53 +0000144#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000145
Mark Hammond91a681d2002-08-12 07:21:58 +0000146PyAPI_FUNC(int) _PyEval_SliceIndex(PyObject *, int *);
Guido van Rossum7c36ada2000-05-08 14:04:54 +0000147
148
Guido van Rossuma3309961993-07-28 09:05:47 +0000149#ifdef __cplusplus
150}
151#endif
152#endif /* !Py_CEVAL_H */