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