| 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 | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 8 | Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam, | 
|  | 9 | The Netherlands. | 
| Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 10 |  | 
|  | 11 | All Rights Reserved | 
|  | 12 |  | 
| Guido van Rossum | d266eb4 | 1996-10-25 14:44:06 +0000 | [diff] [blame] | 13 | Permission to use, copy, modify, and distribute this software and its | 
|  | 14 | documentation for any purpose and without fee is hereby granted, | 
| Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 15 | provided that the above copyright notice appear in all copies and that | 
| Guido van Rossum | d266eb4 | 1996-10-25 14:44:06 +0000 | [diff] [blame] | 16 | both that copyright notice and this permission notice appear in | 
| Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 17 | supporting documentation, and that the names of Stichting Mathematisch | 
| Guido van Rossum | d266eb4 | 1996-10-25 14:44:06 +0000 | [diff] [blame] | 18 | Centrum or CWI or Corporation for National Research Initiatives or | 
|  | 19 | CNRI not be used in advertising or publicity pertaining to | 
|  | 20 | distribution of the software without specific, written prior | 
|  | 21 | permission. | 
| Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 22 |  | 
| Guido van Rossum | d266eb4 | 1996-10-25 14:44:06 +0000 | [diff] [blame] | 23 | While CWI is the initial source for this software, a modified version | 
|  | 24 | is made available by the Corporation for National Research Initiatives | 
|  | 25 | (CNRI) at the Internet address ftp://ftp.python.org. | 
|  | 26 |  | 
|  | 27 | STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH | 
|  | 28 | REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF | 
|  | 29 | MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH | 
|  | 30 | CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL | 
|  | 31 | DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR | 
|  | 32 | PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | 
|  | 33 | TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR | 
|  | 34 | PERFORMANCE OF THIS SOFTWARE. | 
| Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 35 |  | 
|  | 36 | ******************************************************************/ | 
|  | 37 |  | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 38 | /* Interface to random parts in ceval.c */ | 
| Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 39 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 40 | DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords | 
| Guido van Rossum | 884afd6 | 1995-07-18 14:21:06 +0000 | [diff] [blame] | 41 | Py_PROTO((PyObject *, PyObject *, PyObject *)); | 
| Guido van Rossum | a049031 | 1991-07-27 21:33:03 +0000 | [diff] [blame] | 42 |  | 
| Guido van Rossum | d7ed683 | 1997-08-30 15:02:50 +0000 | [diff] [blame] | 43 | /* Inline this */ | 
|  | 44 | #define PyEval_CallObject(func,arg) \ | 
|  | 45 | PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL) | 
|  | 46 |  | 
| Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 47 | #ifdef HAVE_STDARG_PROTOTYPES | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 48 | DL_IMPORT(PyObject *) PyEval_CallFunction Py_PROTO((PyObject *obj, char *format, ...)); | 
|  | 49 | DL_IMPORT(PyObject *) PyEval_CallMethod Py_PROTO((PyObject *obj, | 
| Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 50 | char *methodname, char *format, ...)); | 
|  | 51 | #else | 
|  | 52 | /* Better to have no prototypes at all for varargs functions in this case */ | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 53 | DL_IMPORT(PyObject *) PyEval_CallFunction(); | 
|  | 54 | DL_IMPORT(PyObject *) PyEval_CallMethod(); | 
| Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 55 | #endif | 
|  | 56 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 57 | DL_IMPORT(PyObject *) PyEval_GetBuiltins Py_PROTO((void)); | 
|  | 58 | DL_IMPORT(PyObject *) PyEval_GetGlobals Py_PROTO((void)); | 
|  | 59 | DL_IMPORT(PyObject *) PyEval_GetLocals Py_PROTO((void)); | 
|  | 60 | DL_IMPORT(PyObject *) PyEval_GetOwner Py_PROTO((void)); | 
|  | 61 | DL_IMPORT(PyObject *) PyEval_GetFrame Py_PROTO((void)); | 
|  | 62 | DL_IMPORT(int) PyEval_GetRestricted Py_PROTO((void)); | 
| Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 63 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 64 | DL_IMPORT(int) Py_FlushLine Py_PROTO((void)); | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 65 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 66 | DL_IMPORT(int) Py_AddPendingCall Py_PROTO((int (*func) Py_PROTO((ANY *)), ANY *arg)); | 
|  | 67 | DL_IMPORT(int) Py_MakePendingCalls Py_PROTO((void)); | 
| Guido van Rossum | 9566408 | 1994-09-14 13:23:36 +0000 | [diff] [blame] | 68 |  | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 69 |  | 
|  | 70 | /* Interface for threads. | 
|  | 71 |  | 
|  | 72 | A module that plans to do a blocking system call (or something else | 
|  | 73 | that lasts a long time and doesn't touch Python data) can allow other | 
|  | 74 | threads to run as follows: | 
|  | 75 |  | 
|  | 76 | ...preparations here... | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 77 | Py_BEGIN_ALLOW_THREADS | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 78 | ...blocking system call here... | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 79 | Py_END_ALLOW_THREADS | 
| Guido van Rossum | 66cb311 | 1994-12-30 15:33:50 +0000 | [diff] [blame] | 80 | ...interpret result here... | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 81 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 82 | The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a | 
|  | 83 | {}-surrounded block. | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 84 | To leave the block in the middle (e.g., with return), you must insert | 
|  | 85 | a line containing RET_SAVE before the return, e.g. | 
|  | 86 |  | 
|  | 87 | if (...premature_exit...) { | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 88 | Py_BLOCK_THREADS | 
|  | 89 | PyErr_SetFromErrno(PyExc_IOError); | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 90 | return NULL; | 
|  | 91 | } | 
|  | 92 |  | 
|  | 93 | An alternative is: | 
|  | 94 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 95 | Py_BLOCK_THREADS | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 96 | if (...premature_exit...) { | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 97 | PyErr_SetFromErrno(PyExc_IOError); | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 98 | return NULL; | 
|  | 99 | } | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 100 | Py_UNBLOCK_THREADS | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 101 |  | 
|  | 102 | For convenience, that the value of 'errno' is restored across | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 103 | Py_END_ALLOW_THREADS and RET_SAVE. | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 104 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 105 | WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND | 
|  | 106 | Py_END_ALLOW_THREADS!!! | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 107 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 108 | The function PyEval_InitThreads() should be called only from | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 109 | initthread() in "threadmodule.c". | 
|  | 110 |  | 
|  | 111 | Note that not yet all candidates have been converted to use this | 
|  | 112 | mechanism! | 
|  | 113 | */ | 
|  | 114 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 115 | extern DL_IMPORT(PyThreadState *) PyEval_SaveThread Py_PROTO((void)); | 
|  | 116 | extern DL_IMPORT(void) PyEval_RestoreThread Py_PROTO((PyThreadState *)); | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 117 |  | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 118 | #ifdef WITH_THREAD | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 119 |  | 
| Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame^] | 120 | extern DL_IMPORT(void) PyEval_InitThreads Py_PROTO((void)); | 
|  | 121 | extern DL_IMPORT(void) PyEval_AcquireLock Py_PROTO((void)); | 
|  | 122 | extern DL_IMPORT(void) PyEval_ReleaseLock Py_PROTO((void)); | 
|  | 123 | extern DL_IMPORT(void) PyEval_AcquireThread Py_PROTO((PyThreadState *tstate)); | 
|  | 124 | extern DL_IMPORT(void) PyEval_ReleaseThread Py_PROTO((PyThreadState *tstate)); | 
| Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 125 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 126 | #define Py_BEGIN_ALLOW_THREADS { \ | 
| Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 127 | PyThreadState *_save; \ | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 128 | _save = PyEval_SaveThread(); | 
|  | 129 | #define Py_BLOCK_THREADS	PyEval_RestoreThread(_save); | 
|  | 130 | #define Py_UNBLOCK_THREADS	_save = PyEval_SaveThread(); | 
|  | 131 | #define Py_END_ALLOW_THREADS	PyEval_RestoreThread(_save); \ | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 132 | } | 
|  | 133 |  | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 134 | #else /* !WITH_THREAD */ | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 135 |  | 
| Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 136 | #define Py_BEGIN_ALLOW_THREADS { | 
|  | 137 | #define Py_BLOCK_THREADS | 
|  | 138 | #define Py_UNBLOCK_THREADS | 
|  | 139 | #define Py_END_ALLOW_THREADS } | 
| Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 140 |  | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 141 | #endif /* !WITH_THREAD */ | 
| Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 142 |  | 
|  | 143 | #ifdef __cplusplus | 
|  | 144 | } | 
|  | 145 | #endif | 
|  | 146 | #endif /* !Py_CEVAL_H */ |