blob: 5b96d9e21eadc57861a8a7ba0cc85c54bce6129e [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 Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossumff4949e1992-08-05 19:58:53 +000038/* Interface to random parts in ceval.c */
Guido van Rossum3f5da241990-12-20 15:06:42 +000039
Guido van Rossum43466ec1998-12-04 18:48:25 +000040DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords
Guido van Rossum884afd61995-07-18 14:21:06 +000041 Py_PROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossuma0490311991-07-27 21:33:03 +000042
Guido van Rossumd7ed6831997-08-30 15:02:50 +000043/* Inline this */
44#define PyEval_CallObject(func,arg) \
45 PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)
46
Guido van Rossum3d109a01998-08-08 20:53:36 +000047#ifdef HAVE_STDARG_PROTOTYPES
Guido van Rossum43466ec1998-12-04 18:48:25 +000048DL_IMPORT(PyObject *) PyEval_CallFunction Py_PROTO((PyObject *obj, char *format, ...));
49DL_IMPORT(PyObject *) PyEval_CallMethod Py_PROTO((PyObject *obj,
Guido van Rossum3d109a01998-08-08 20:53:36 +000050 char *methodname, char *format, ...));
51#else
52/* Better to have no prototypes at all for varargs functions in this case */
Guido van Rossum43466ec1998-12-04 18:48:25 +000053DL_IMPORT(PyObject *) PyEval_CallFunction();
54DL_IMPORT(PyObject *) PyEval_CallMethod();
Guido van Rossum3d109a01998-08-08 20:53:36 +000055#endif
56
Guido van Rossum43466ec1998-12-04 18:48:25 +000057DL_IMPORT(PyObject *) PyEval_GetBuiltins Py_PROTO((void));
58DL_IMPORT(PyObject *) PyEval_GetGlobals Py_PROTO((void));
59DL_IMPORT(PyObject *) PyEval_GetLocals Py_PROTO((void));
60DL_IMPORT(PyObject *) PyEval_GetOwner Py_PROTO((void));
61DL_IMPORT(PyObject *) PyEval_GetFrame Py_PROTO((void));
62DL_IMPORT(int) PyEval_GetRestricted Py_PROTO((void));
Guido van Rossum3f5da241990-12-20 15:06:42 +000063
Guido van Rossum43466ec1998-12-04 18:48:25 +000064DL_IMPORT(int) Py_FlushLine Py_PROTO((void));
Guido van Rossumff4949e1992-08-05 19:58:53 +000065
Guido van Rossum43466ec1998-12-04 18:48:25 +000066DL_IMPORT(int) Py_AddPendingCall Py_PROTO((int (*func) Py_PROTO((ANY *)), ANY *arg));
67DL_IMPORT(int) Py_MakePendingCalls Py_PROTO((void));
Guido van Rossum95664081994-09-14 13:23:36 +000068
Guido van Rossumff4949e1992-08-05 19:58:53 +000069
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 Rossumcaa63801995-01-12 11:45:45 +000077 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000078 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000079 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000080 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000081
Guido van Rossumcaa63801995-01-12 11:45:45 +000082 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
83 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000084 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 Rossumcaa63801995-01-12 11:45:45 +000088 Py_BLOCK_THREADS
89 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000090 return NULL;
91 }
92
93 An alternative is:
94
Guido van Rossumcaa63801995-01-12 11:45:45 +000095 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000096 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000097 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000098 return NULL;
99 }
Guido van Rossumcaa63801995-01-12 11:45:45 +0000100 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000101
102 For convenience, that the value of 'errno' is restored across
Guido van Rossumcaa63801995-01-12 11:45:45 +0000103 Py_END_ALLOW_THREADS and RET_SAVE.
Guido van Rossumff4949e1992-08-05 19:58:53 +0000104
Guido van Rossumcaa63801995-01-12 11:45:45 +0000105 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
106 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +0000107
Guido van Rossumcaa63801995-01-12 11:45:45 +0000108 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +0000109 initthread() in "threadmodule.c".
110
111 Note that not yet all candidates have been converted to use this
112 mechanism!
113*/
114
Guido van Rossum43466ec1998-12-04 18:48:25 +0000115extern DL_IMPORT(PyThreadState *) PyEval_SaveThread Py_PROTO((void));
116extern DL_IMPORT(void) PyEval_RestoreThread Py_PROTO((PyThreadState *));
Guido van Rossumff4949e1992-08-05 19:58:53 +0000117
Guido van Rossumb6775db1994-08-01 11:34:53 +0000118#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000119
Guido van Rossum43466ec1998-12-04 18:48:25 +0000120extern DL_IMPORT(void) PyEval_InitThreads Py_PROTO((void));
121extern DL_IMPORT(void) PyEval_AcquireLock Py_PROTO((void));
122extern DL_IMPORT(void) PyEval_ReleaseLock Py_PROTO((void));
123extern DL_IMPORT(void) PyEval_AcquireThread Py_PROTO((PyThreadState *tstate));
124extern DL_IMPORT(void) PyEval_ReleaseThread Py_PROTO((PyThreadState *tstate));
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000125
Guido van Rossumcaa63801995-01-12 11:45:45 +0000126#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000127 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000128 _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 Rossumff4949e1992-08-05 19:58:53 +0000132 }
133
Guido van Rossumb6775db1994-08-01 11:34:53 +0000134#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000135
Guido van Rossumcaa63801995-01-12 11:45:45 +0000136#define Py_BEGIN_ALLOW_THREADS {
137#define Py_BLOCK_THREADS
138#define Py_UNBLOCK_THREADS
139#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000140
Guido van Rossumb6775db1994-08-01 11:34:53 +0000141#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000142
143#ifdef __cplusplus
144}
145#endif
146#endif /* !Py_CEVAL_H */