blob: 8200e3cd1b88fbff185daf6af08ce5c15caa189b [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 Rossum83684531999-03-17 18:44:39 +000043/* DLL-level Backwards compatibility: */
44#undef PyEval_CallObject
45DL_IMPORT(PyObject *) PyEval_CallObject Py_PROTO((PyObject *, PyObject *));
46
Guido van Rossumd7ed6831997-08-30 15:02:50 +000047/* Inline this */
48#define PyEval_CallObject(func,arg) \
49 PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)
50
Guido van Rossum3d109a01998-08-08 20:53:36 +000051#ifdef HAVE_STDARG_PROTOTYPES
Guido van Rossum43466ec1998-12-04 18:48:25 +000052DL_IMPORT(PyObject *) PyEval_CallFunction Py_PROTO((PyObject *obj, char *format, ...));
53DL_IMPORT(PyObject *) PyEval_CallMethod Py_PROTO((PyObject *obj,
Guido van Rossum3d109a01998-08-08 20:53:36 +000054 char *methodname, char *format, ...));
55#else
56/* Better to have no prototypes at all for varargs functions in this case */
Guido van Rossum43466ec1998-12-04 18:48:25 +000057DL_IMPORT(PyObject *) PyEval_CallFunction();
58DL_IMPORT(PyObject *) PyEval_CallMethod();
Guido van Rossum3d109a01998-08-08 20:53:36 +000059#endif
60
Guido van Rossum43466ec1998-12-04 18:48:25 +000061DL_IMPORT(PyObject *) PyEval_GetBuiltins Py_PROTO((void));
62DL_IMPORT(PyObject *) PyEval_GetGlobals Py_PROTO((void));
63DL_IMPORT(PyObject *) PyEval_GetLocals Py_PROTO((void));
64DL_IMPORT(PyObject *) PyEval_GetOwner Py_PROTO((void));
65DL_IMPORT(PyObject *) PyEval_GetFrame Py_PROTO((void));
66DL_IMPORT(int) PyEval_GetRestricted Py_PROTO((void));
Guido van Rossum3f5da241990-12-20 15:06:42 +000067
Guido van Rossum43466ec1998-12-04 18:48:25 +000068DL_IMPORT(int) Py_FlushLine Py_PROTO((void));
Guido van Rossumff4949e1992-08-05 19:58:53 +000069
Guido van Rossum43466ec1998-12-04 18:48:25 +000070DL_IMPORT(int) Py_AddPendingCall Py_PROTO((int (*func) Py_PROTO((ANY *)), ANY *arg));
71DL_IMPORT(int) Py_MakePendingCalls Py_PROTO((void));
Guido van Rossum95664081994-09-14 13:23:36 +000072
Guido van Rossumff4949e1992-08-05 19:58:53 +000073
74/* Interface for threads.
75
76 A module that plans to do a blocking system call (or something else
77 that lasts a long time and doesn't touch Python data) can allow other
78 threads to run as follows:
79
80 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000081 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000082 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000083 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000084 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000085
Guido van Rossumcaa63801995-01-12 11:45:45 +000086 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
87 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000088 To leave the block in the middle (e.g., with return), you must insert
89 a line containing RET_SAVE before the return, e.g.
90
91 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000092 Py_BLOCK_THREADS
93 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000094 return NULL;
95 }
96
97 An alternative is:
98
Guido van Rossumcaa63801995-01-12 11:45:45 +000099 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000100 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +0000101 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000102 return NULL;
103 }
Guido van Rossumcaa63801995-01-12 11:45:45 +0000104 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000105
106 For convenience, that the value of 'errno' is restored across
Guido van Rossumcaa63801995-01-12 11:45:45 +0000107 Py_END_ALLOW_THREADS and RET_SAVE.
Guido van Rossumff4949e1992-08-05 19:58:53 +0000108
Guido van Rossumcaa63801995-01-12 11:45:45 +0000109 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
110 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +0000111
Guido van Rossumcaa63801995-01-12 11:45:45 +0000112 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +0000113 initthread() in "threadmodule.c".
114
115 Note that not yet all candidates have been converted to use this
116 mechanism!
117*/
118
Guido van Rossum43466ec1998-12-04 18:48:25 +0000119extern DL_IMPORT(PyThreadState *) PyEval_SaveThread Py_PROTO((void));
120extern DL_IMPORT(void) PyEval_RestoreThread Py_PROTO((PyThreadState *));
Guido van Rossumff4949e1992-08-05 19:58:53 +0000121
Guido van Rossumb6775db1994-08-01 11:34:53 +0000122#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000123
Guido van Rossum43466ec1998-12-04 18:48:25 +0000124extern DL_IMPORT(void) PyEval_InitThreads Py_PROTO((void));
125extern DL_IMPORT(void) PyEval_AcquireLock Py_PROTO((void));
126extern DL_IMPORT(void) PyEval_ReleaseLock Py_PROTO((void));
127extern DL_IMPORT(void) PyEval_AcquireThread Py_PROTO((PyThreadState *tstate));
128extern DL_IMPORT(void) PyEval_ReleaseThread Py_PROTO((PyThreadState *tstate));
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000129
Guido van Rossumcaa63801995-01-12 11:45:45 +0000130#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000131 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000132 _save = PyEval_SaveThread();
133#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
134#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
135#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000136 }
137
Guido van Rossumb6775db1994-08-01 11:34:53 +0000138#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000139
Guido van Rossumcaa63801995-01-12 11:45:45 +0000140#define Py_BEGIN_ALLOW_THREADS {
141#define Py_BLOCK_THREADS
142#define Py_UNBLOCK_THREADS
143#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000144
Guido van Rossumb6775db1994-08-01 11:34:53 +0000145#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000146
147#ifdef __cplusplus
148}
149#endif
150#endif /* !Py_CEVAL_H */