Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_CEVAL_H |
| 2 | #define Py_CEVAL_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 7 | /*********************************************************** |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 8 | Copyright (c) 2000, BeOpen.com. |
| 9 | Copyright (c) 1995-2000, Corporation for National Research Initiatives. |
| 10 | Copyright (c) 1990-1995, Stichting Mathematisch Centrum. |
| 11 | All rights reserved. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 13 | See the file "Misc/COPYRIGHT" for information on usage and |
| 14 | redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 15 | ******************************************************************/ |
| 16 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 17 | /* Interface to random parts in ceval.c */ |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 18 | |
Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame] | 19 | DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 20 | (PyObject *, PyObject *, PyObject *); |
Guido van Rossum | a049031 | 1991-07-27 21:33:03 +0000 | [diff] [blame] | 21 | |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 22 | /* DLL-level Backwards compatibility: */ |
| 23 | #undef PyEval_CallObject |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 24 | DL_IMPORT(PyObject *) PyEval_CallObject(PyObject *, PyObject *); |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 25 | |
Guido van Rossum | d7ed683 | 1997-08-30 15:02:50 +0000 | [diff] [blame] | 26 | /* Inline this */ |
| 27 | #define PyEval_CallObject(func,arg) \ |
| 28 | PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL) |
| 29 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 30 | DL_IMPORT(PyObject *) PyEval_CallFunction(PyObject *obj, char *format, ...); |
| 31 | DL_IMPORT(PyObject *) PyEval_CallMethod(PyObject *obj, |
| 32 | char *methodname, char *format, ...); |
Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 33 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 34 | DL_IMPORT(PyObject *) PyEval_GetBuiltins(void); |
| 35 | DL_IMPORT(PyObject *) PyEval_GetGlobals(void); |
| 36 | DL_IMPORT(PyObject *) PyEval_GetLocals(void); |
| 37 | DL_IMPORT(PyObject *) PyEval_GetOwner(void); |
| 38 | DL_IMPORT(PyObject *) PyEval_GetFrame(void); |
| 39 | DL_IMPORT(int) PyEval_GetRestricted(void); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 40 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 41 | DL_IMPORT(int) Py_FlushLine(void); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 42 | |
Thomas Wouters | 334fb89 | 2000-07-25 12:56:38 +0000 | [diff] [blame] | 43 | DL_IMPORT(int) Py_AddPendingCall(int (*func)(void *), void *arg); |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 44 | DL_IMPORT(int) Py_MakePendingCalls(void); |
Guido van Rossum | 9566408 | 1994-09-14 13:23:36 +0000 | [diff] [blame] | 45 | |
Tim Peters | 51de690 | 2000-09-01 00:01:58 +0000 | [diff] [blame^] | 46 | DL_IMPORT(void) Py_SetRecursionLimit(int); |
| 47 | DL_IMPORT(int) Py_GetRecursionLimit(void); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 48 | |
| 49 | /* Interface for threads. |
| 50 | |
| 51 | A module that plans to do a blocking system call (or something else |
| 52 | that lasts a long time and doesn't touch Python data) can allow other |
| 53 | threads to run as follows: |
| 54 | |
| 55 | ...preparations here... |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 56 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 57 | ...blocking system call here... |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 58 | Py_END_ALLOW_THREADS |
Guido van Rossum | 66cb311 | 1994-12-30 15:33:50 +0000 | [diff] [blame] | 59 | ...interpret result here... |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 61 | The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a |
| 62 | {}-surrounded block. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 63 | To leave the block in the middle (e.g., with return), you must insert |
| 64 | a line containing RET_SAVE before the return, e.g. |
| 65 | |
| 66 | if (...premature_exit...) { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 67 | Py_BLOCK_THREADS |
| 68 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 69 | return NULL; |
| 70 | } |
| 71 | |
| 72 | An alternative is: |
| 73 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 74 | Py_BLOCK_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 75 | if (...premature_exit...) { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 76 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 77 | return NULL; |
| 78 | } |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 79 | Py_UNBLOCK_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 80 | |
| 81 | For convenience, that the value of 'errno' is restored across |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 82 | Py_END_ALLOW_THREADS and RET_SAVE. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 83 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 84 | WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND |
| 85 | Py_END_ALLOW_THREADS!!! |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 87 | The function PyEval_InitThreads() should be called only from |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 88 | initthread() in "threadmodule.c". |
| 89 | |
| 90 | Note that not yet all candidates have been converted to use this |
| 91 | mechanism! |
| 92 | */ |
| 93 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 94 | extern DL_IMPORT(PyThreadState *) PyEval_SaveThread(void); |
| 95 | extern DL_IMPORT(void) PyEval_RestoreThread(PyThreadState *); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 96 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 97 | #ifdef WITH_THREAD |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 98 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 99 | extern DL_IMPORT(void) PyEval_InitThreads(void); |
| 100 | extern DL_IMPORT(void) PyEval_AcquireLock(void); |
| 101 | extern DL_IMPORT(void) PyEval_ReleaseLock(void); |
| 102 | extern DL_IMPORT(void) PyEval_AcquireThread(PyThreadState *tstate); |
| 103 | extern DL_IMPORT(void) PyEval_ReleaseThread(PyThreadState *tstate); |
Tim Peters | 8ebe84d | 2000-08-27 20:00:35 +0000 | [diff] [blame] | 104 | extern DL_IMPORT(void) PyEval_ReInitThreads(void); |
Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 105 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 106 | #define Py_BEGIN_ALLOW_THREADS { \ |
Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 107 | PyThreadState *_save; \ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 108 | _save = PyEval_SaveThread(); |
| 109 | #define Py_BLOCK_THREADS PyEval_RestoreThread(_save); |
| 110 | #define Py_UNBLOCK_THREADS _save = PyEval_SaveThread(); |
| 111 | #define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \ |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 112 | } |
| 113 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 114 | #else /* !WITH_THREAD */ |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 115 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 116 | #define Py_BEGIN_ALLOW_THREADS { |
| 117 | #define Py_BLOCK_THREADS |
| 118 | #define Py_UNBLOCK_THREADS |
| 119 | #define Py_END_ALLOW_THREADS } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 120 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 121 | #endif /* !WITH_THREAD */ |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 122 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 123 | extern DL_IMPORT(int) _PyEval_SliceIndex(PyObject *, int *); |
Guido van Rossum | 7c36ada | 2000-05-08 14:04:54 +0000 | [diff] [blame] | 124 | |
| 125 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 126 | #ifdef __cplusplus |
| 127 | } |
| 128 | #endif |
| 129 | #endif /* !Py_CEVAL_H */ |