blob: 083117324422724f25a380b122fbc5feb8e17b4b [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 Rossumfd71b9e2000-06-30 23:50:40 +00008Copyright (c) 2000, BeOpen.com.
9Copyright (c) 1995-2000, Corporation for National Research Initiatives.
10Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
11All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000012
Guido van Rossumfd71b9e2000-06-30 23:50:40 +000013See the file "Misc/COPYRIGHT" for information on usage and
14redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015******************************************************************/
16
Guido van Rossumff4949e1992-08-05 19:58:53 +000017/* Interface to random parts in ceval.c */
Guido van Rossum3f5da241990-12-20 15:06:42 +000018
Guido van Rossum43466ec1998-12-04 18:48:25 +000019DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords
Fred Drake5eb6d4e2000-07-08 23:37:28 +000020 (PyObject *, PyObject *, PyObject *);
Guido van Rossuma0490311991-07-27 21:33:03 +000021
Guido van Rossum83684531999-03-17 18:44:39 +000022/* DLL-level Backwards compatibility: */
23#undef PyEval_CallObject
Fred Drake5eb6d4e2000-07-08 23:37:28 +000024DL_IMPORT(PyObject *) PyEval_CallObject(PyObject *, PyObject *);
Guido van Rossum83684531999-03-17 18:44:39 +000025
Guido van Rossumd7ed6831997-08-30 15:02:50 +000026/* Inline this */
27#define PyEval_CallObject(func,arg) \
28 PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)
29
Fred Drake5eb6d4e2000-07-08 23:37:28 +000030DL_IMPORT(PyObject *) PyEval_CallFunction(PyObject *obj, char *format, ...);
31DL_IMPORT(PyObject *) PyEval_CallMethod(PyObject *obj,
32 char *methodname, char *format, ...);
Guido van Rossum3d109a01998-08-08 20:53:36 +000033
Fred Drake5eb6d4e2000-07-08 23:37:28 +000034DL_IMPORT(PyObject *) PyEval_GetBuiltins(void);
35DL_IMPORT(PyObject *) PyEval_GetGlobals(void);
36DL_IMPORT(PyObject *) PyEval_GetLocals(void);
37DL_IMPORT(PyObject *) PyEval_GetOwner(void);
38DL_IMPORT(PyObject *) PyEval_GetFrame(void);
39DL_IMPORT(int) PyEval_GetRestricted(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000040
Fred Drake5eb6d4e2000-07-08 23:37:28 +000041DL_IMPORT(int) Py_FlushLine(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000042
Thomas Wouters334fb892000-07-25 12:56:38 +000043DL_IMPORT(int) Py_AddPendingCall(int (*func)(void *), void *arg);
Fred Drake5eb6d4e2000-07-08 23:37:28 +000044DL_IMPORT(int) Py_MakePendingCalls(void);
Guido van Rossum95664081994-09-14 13:23:36 +000045
Guido van Rossumff4949e1992-08-05 19:58:53 +000046
47/* Interface for threads.
48
49 A module that plans to do a blocking system call (or something else
50 that lasts a long time and doesn't touch Python data) can allow other
51 threads to run as follows:
52
53 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000054 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000055 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000056 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000057 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000058
Guido van Rossumcaa63801995-01-12 11:45:45 +000059 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
60 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000061 To leave the block in the middle (e.g., with return), you must insert
62 a line containing RET_SAVE before the return, e.g.
63
64 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000065 Py_BLOCK_THREADS
66 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000067 return NULL;
68 }
69
70 An alternative is:
71
Guido van Rossumcaa63801995-01-12 11:45:45 +000072 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000073 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000074 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000075 return NULL;
76 }
Guido van Rossumcaa63801995-01-12 11:45:45 +000077 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000078
79 For convenience, that the value of 'errno' is restored across
Guido van Rossumcaa63801995-01-12 11:45:45 +000080 Py_END_ALLOW_THREADS and RET_SAVE.
Guido van Rossumff4949e1992-08-05 19:58:53 +000081
Guido van Rossumcaa63801995-01-12 11:45:45 +000082 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
83 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +000084
Guido van Rossumcaa63801995-01-12 11:45:45 +000085 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +000086 initthread() in "threadmodule.c".
87
88 Note that not yet all candidates have been converted to use this
89 mechanism!
90*/
91
Fred Drake5eb6d4e2000-07-08 23:37:28 +000092extern DL_IMPORT(PyThreadState *) PyEval_SaveThread(void);
93extern DL_IMPORT(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossumff4949e1992-08-05 19:58:53 +000094
Guido van Rossumb6775db1994-08-01 11:34:53 +000095#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +000096
Fred Drake5eb6d4e2000-07-08 23:37:28 +000097extern DL_IMPORT(void) PyEval_InitThreads(void);
98extern DL_IMPORT(void) PyEval_AcquireLock(void);
99extern DL_IMPORT(void) PyEval_ReleaseLock(void);
100extern DL_IMPORT(void) PyEval_AcquireThread(PyThreadState *tstate);
101extern DL_IMPORT(void) PyEval_ReleaseThread(PyThreadState *tstate);
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000102
Guido van Rossumcaa63801995-01-12 11:45:45 +0000103#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000104 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000105 _save = PyEval_SaveThread();
106#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
107#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
108#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000109 }
110
Guido van Rossumb6775db1994-08-01 11:34:53 +0000111#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000112
Guido van Rossumcaa63801995-01-12 11:45:45 +0000113#define Py_BEGIN_ALLOW_THREADS {
114#define Py_BLOCK_THREADS
115#define Py_UNBLOCK_THREADS
116#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000117
Guido van Rossumb6775db1994-08-01 11:34:53 +0000118#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000119
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000120extern DL_IMPORT(int) _PyEval_SliceIndex(PyObject *, int *);
Guido van Rossum7c36ada2000-05-08 14:04:54 +0000121
122
Guido van Rossuma3309961993-07-28 09:05:47 +0000123#ifdef __cplusplus
124}
125#endif
126#endif /* !Py_CEVAL_H */