blob: 19ac064fdc07868237994bc00e4cbae071c6edc3 [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
Guido van Rossum43466ec1998-12-04 18:48:25 +000010DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords
Fred Drake5eb6d4e2000-07-08 23:37:28 +000011 (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
Fred Drake5eb6d4e2000-07-08 23:37:28 +000015DL_IMPORT(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
Fred Drake5eb6d4e2000-07-08 23:37:28 +000021DL_IMPORT(PyObject *) PyEval_CallFunction(PyObject *obj, char *format, ...);
22DL_IMPORT(PyObject *) PyEval_CallMethod(PyObject *obj,
23 char *methodname, char *format, ...);
Guido van Rossum3d109a01998-08-08 20:53:36 +000024
Fred Drake55fb6e02001-06-27 19:18:03 +000025DL_IMPORT(void) PyEval_SetProfile(Py_tracefunc, PyObject *);
26DL_IMPORT(void) PyEval_SetTrace(Py_tracefunc, PyObject *);
27
Fred Drake5eb6d4e2000-07-08 23:37:28 +000028DL_IMPORT(PyObject *) PyEval_GetBuiltins(void);
29DL_IMPORT(PyObject *) PyEval_GetGlobals(void);
30DL_IMPORT(PyObject *) PyEval_GetLocals(void);
31DL_IMPORT(PyObject *) PyEval_GetOwner(void);
32DL_IMPORT(PyObject *) PyEval_GetFrame(void);
33DL_IMPORT(int) PyEval_GetRestricted(void);
Jeremy Hylton061d1062001-03-22 02:32:48 +000034DL_IMPORT(int) PyEval_GetNestedScopes(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000035
Fred Drake5eb6d4e2000-07-08 23:37:28 +000036DL_IMPORT(int) Py_FlushLine(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000037
Thomas Wouters334fb892000-07-25 12:56:38 +000038DL_IMPORT(int) Py_AddPendingCall(int (*func)(void *), void *arg);
Fred Drake5eb6d4e2000-07-08 23:37:28 +000039DL_IMPORT(int) Py_MakePendingCalls(void);
Guido van Rossum95664081994-09-14 13:23:36 +000040
Tim Peters51de6902000-09-01 00:01:58 +000041DL_IMPORT(void) Py_SetRecursionLimit(int);
42DL_IMPORT(int) Py_GetRecursionLimit(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000043
44/* Interface for threads.
45
46 A module that plans to do a blocking system call (or something else
47 that lasts a long time and doesn't touch Python data) can allow other
48 threads to run as follows:
49
50 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000051 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000052 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000053 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000054 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000055
Guido van Rossumcaa63801995-01-12 11:45:45 +000056 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
57 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000058 To leave the block in the middle (e.g., with return), you must insert
Skip Montanaro682c25a2000-09-15 18:19:27 +000059 a line containing Py_BLOCK_THREADS before the return, e.g.
Guido van Rossumff4949e1992-08-05 19:58:53 +000060
61 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000062 Py_BLOCK_THREADS
63 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000064 return NULL;
65 }
66
67 An alternative is:
68
Guido van Rossumcaa63801995-01-12 11:45:45 +000069 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000070 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000071 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000072 return NULL;
73 }
Guido van Rossumcaa63801995-01-12 11:45:45 +000074 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000075
76 For convenience, that the value of 'errno' is restored across
Skip Montanaro682c25a2000-09-15 18:19:27 +000077 Py_END_ALLOW_THREADS and Py_BLOCK_THREADS.
Guido van Rossumff4949e1992-08-05 19:58:53 +000078
Guido van Rossumcaa63801995-01-12 11:45:45 +000079 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
80 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +000081
Guido van Rossumcaa63801995-01-12 11:45:45 +000082 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +000083 initthread() in "threadmodule.c".
84
85 Note that not yet all candidates have been converted to use this
86 mechanism!
87*/
88
Fred Drake5eb6d4e2000-07-08 23:37:28 +000089extern DL_IMPORT(PyThreadState *) PyEval_SaveThread(void);
90extern DL_IMPORT(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossumff4949e1992-08-05 19:58:53 +000091
Guido van Rossumb6775db1994-08-01 11:34:53 +000092#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +000093
Fred Drake5eb6d4e2000-07-08 23:37:28 +000094extern DL_IMPORT(void) PyEval_InitThreads(void);
95extern DL_IMPORT(void) PyEval_AcquireLock(void);
96extern DL_IMPORT(void) PyEval_ReleaseLock(void);
97extern DL_IMPORT(void) PyEval_AcquireThread(PyThreadState *tstate);
98extern DL_IMPORT(void) PyEval_ReleaseThread(PyThreadState *tstate);
Tim Peters8ebe84d2000-08-27 20:00:35 +000099extern DL_IMPORT(void) PyEval_ReInitThreads(void);
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000100
Guido van Rossumcaa63801995-01-12 11:45:45 +0000101#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000102 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000103 _save = PyEval_SaveThread();
104#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
105#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
106#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000107 }
108
Guido van Rossumb6775db1994-08-01 11:34:53 +0000109#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000110
Guido van Rossumcaa63801995-01-12 11:45:45 +0000111#define Py_BEGIN_ALLOW_THREADS {
112#define Py_BLOCK_THREADS
113#define Py_UNBLOCK_THREADS
114#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000115
Guido van Rossumb6775db1994-08-01 11:34:53 +0000116#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000117
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000118extern DL_IMPORT(int) _PyEval_SliceIndex(PyObject *, int *);
Guido van Rossum7c36ada2000-05-08 14:04:54 +0000119
120
Guido van Rossuma3309961993-07-28 09:05:47 +0000121#ifdef __cplusplus
122}
123#endif
124#endif /* !Py_CEVAL_H */