blob: e1af801bc055bc20dae7bd144599b0823f9c43dc [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
Mark Hammond91a681d2002-08-12 07:21:58 +000028PyAPI_FUNC(PyObject *) PyEval_GetBuiltins(void);
29PyAPI_FUNC(PyObject *) PyEval_GetGlobals(void);
30PyAPI_FUNC(PyObject *) PyEval_GetLocals(void);
31PyAPI_FUNC(PyObject *) PyEval_GetOwner(void);
32PyAPI_FUNC(PyObject *) PyEval_GetFrame(void);
33PyAPI_FUNC(int) PyEval_GetRestricted(void);
Tim Peters5ba58662001-07-16 02:29:45 +000034
35/* Look at the current frame's (if any) code's co_flags, and turn on
36 the corresponding compiler flags in cf->cf_flags. Return 1 if any
37 flag was set, else return 0. */
Mark Hammond91a681d2002-08-12 07:21:58 +000038PyAPI_FUNC(int) PyEval_MergeCompilerFlags(PyCompilerFlags *cf);
Guido van Rossum3f5da241990-12-20 15:06:42 +000039
Mark Hammond91a681d2002-08-12 07:21:58 +000040PyAPI_FUNC(int) Py_FlushLine(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000041
Mark Hammond91a681d2002-08-12 07:21:58 +000042PyAPI_FUNC(int) Py_AddPendingCall(int (*func)(void *), void *arg);
43PyAPI_FUNC(int) Py_MakePendingCalls(void);
Guido van Rossum95664081994-09-14 13:23:36 +000044
Mark Hammond91a681d2002-08-12 07:21:58 +000045PyAPI_FUNC(void) Py_SetRecursionLimit(int);
46PyAPI_FUNC(int) Py_GetRecursionLimit(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000047
Mark Hammond91a681d2002-08-12 07:21:58 +000048PyAPI_FUNC(char *) PyEval_GetFuncName(PyObject *);
49PyAPI_FUNC(char *) PyEval_GetFuncDesc(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +000050
Skip Montanarod581d772002-09-03 20:10:45 +000051/* this used to be handled on a per-thread basis - now just two globals */
52PyAPI_DATA(volatile int) _Py_Ticker;
53PyAPI_DATA(int) _Py_CheckInterval;
54
Guido van Rossumff4949e1992-08-05 19:58:53 +000055/* Interface for threads.
56
57 A module that plans to do a blocking system call (or something else
58 that lasts a long time and doesn't touch Python data) can allow other
59 threads to run as follows:
60
61 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000062 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000063 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000064 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000065 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000066
Guido van Rossumcaa63801995-01-12 11:45:45 +000067 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
68 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000069 To leave the block in the middle (e.g., with return), you must insert
Skip Montanaro682c25a2000-09-15 18:19:27 +000070 a line containing Py_BLOCK_THREADS before the return, e.g.
Guido van Rossumff4949e1992-08-05 19:58:53 +000071
72 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000073 Py_BLOCK_THREADS
74 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000075 return NULL;
76 }
77
78 An alternative is:
79
Guido van Rossumcaa63801995-01-12 11:45:45 +000080 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000081 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000082 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000083 return NULL;
84 }
Guido van Rossumcaa63801995-01-12 11:45:45 +000085 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000086
87 For convenience, that the value of 'errno' is restored across
Skip Montanaro682c25a2000-09-15 18:19:27 +000088 Py_END_ALLOW_THREADS and Py_BLOCK_THREADS.
Guido van Rossumff4949e1992-08-05 19:58:53 +000089
Guido van Rossumcaa63801995-01-12 11:45:45 +000090 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
91 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +000092
Guido van Rossumcaa63801995-01-12 11:45:45 +000093 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +000094 initthread() in "threadmodule.c".
95
96 Note that not yet all candidates have been converted to use this
97 mechanism!
98*/
99
Mark Hammond91a681d2002-08-12 07:21:58 +0000100PyAPI_FUNC(PyThreadState *) PyEval_SaveThread(void);
101PyAPI_FUNC(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000102
Guido van Rossumb6775db1994-08-01 11:34:53 +0000103#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000104
Mark Hammond91a681d2002-08-12 07:21:58 +0000105PyAPI_FUNC(void) PyEval_InitThreads(void);
106PyAPI_FUNC(void) PyEval_AcquireLock(void);
107PyAPI_FUNC(void) PyEval_ReleaseLock(void);
108PyAPI_FUNC(void) PyEval_AcquireThread(PyThreadState *tstate);
109PyAPI_FUNC(void) PyEval_ReleaseThread(PyThreadState *tstate);
110PyAPI_FUNC(void) PyEval_ReInitThreads(void);
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000111
Guido van Rossumcaa63801995-01-12 11:45:45 +0000112#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000113 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000114 _save = PyEval_SaveThread();
115#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
116#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
117#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000118 }
119
Guido van Rossumb6775db1994-08-01 11:34:53 +0000120#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000121
Guido van Rossumcaa63801995-01-12 11:45:45 +0000122#define Py_BEGIN_ALLOW_THREADS {
123#define Py_BLOCK_THREADS
124#define Py_UNBLOCK_THREADS
125#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000126
Guido van Rossumb6775db1994-08-01 11:34:53 +0000127#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000128
Mark Hammond91a681d2002-08-12 07:21:58 +0000129PyAPI_FUNC(int) _PyEval_SliceIndex(PyObject *, int *);
Guido van Rossum7c36ada2000-05-08 14:04:54 +0000130
131
Guido van Rossuma3309961993-07-28 09:05:47 +0000132#ifdef __cplusplus
133}
134#endif
135#endif /* !Py_CEVAL_H */