blob: 62977badca05c127a954d0690a012fefd2416f11 [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 Rossum884afd61995-07-18 14:21:06 +000040PyObject *PyEval_CallObjectWithKeywords
41 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 Rossumcaa63801995-01-12 11:45:45 +000047PyObject *PyEval_GetBuiltins Py_PROTO((void));
48PyObject *PyEval_GetGlobals Py_PROTO((void));
49PyObject *PyEval_GetLocals Py_PROTO((void));
50PyObject *PyEval_GetOwner Py_PROTO((void));
51PyObject *PyEval_GetFrame Py_PROTO((void));
52int PyEval_GetRestricted Py_PROTO((void));
Guido van Rossum3f5da241990-12-20 15:06:42 +000053
Guido van Rossum745b8cf1997-05-22 22:23:46 +000054int Py_FlushLine Py_PROTO((void));
Guido van Rossumff4949e1992-08-05 19:58:53 +000055
Guido van Rossumcaa63801995-01-12 11:45:45 +000056int Py_AddPendingCall Py_PROTO((int (*func) Py_PROTO((ANY *)), ANY *arg));
57int Py_MakePendingCalls Py_PROTO((void));
Guido van Rossum95664081994-09-14 13:23:36 +000058
Guido van Rossumff4949e1992-08-05 19:58:53 +000059
60/* Interface for threads.
61
62 A module that plans to do a blocking system call (or something else
63 that lasts a long time and doesn't touch Python data) can allow other
64 threads to run as follows:
65
66 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000067 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000068 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000069 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000070 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000071
Guido van Rossumcaa63801995-01-12 11:45:45 +000072 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
73 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000074 To leave the block in the middle (e.g., with return), you must insert
75 a line containing RET_SAVE before the return, e.g.
76
77 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000078 Py_BLOCK_THREADS
79 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000080 return NULL;
81 }
82
83 An alternative is:
84
Guido van Rossumcaa63801995-01-12 11:45:45 +000085 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000086 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000087 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000088 return NULL;
89 }
Guido van Rossumcaa63801995-01-12 11:45:45 +000090 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000091
92 For convenience, that the value of 'errno' is restored across
Guido van Rossumcaa63801995-01-12 11:45:45 +000093 Py_END_ALLOW_THREADS and RET_SAVE.
Guido van Rossumff4949e1992-08-05 19:58:53 +000094
Guido van Rossumcaa63801995-01-12 11:45:45 +000095 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
96 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +000097
Guido van Rossumcaa63801995-01-12 11:45:45 +000098 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +000099 initthread() in "threadmodule.c".
100
101 Note that not yet all candidates have been converted to use this
102 mechanism!
103*/
104
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000105extern PyThreadState *PyEval_SaveThread Py_PROTO((void));
106extern void PyEval_RestoreThread Py_PROTO((PyThreadState *));
Guido van Rossumff4949e1992-08-05 19:58:53 +0000107
Guido van Rossumb6775db1994-08-01 11:34:53 +0000108#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000109
Guido van Rossuma8478891997-07-19 19:27:30 +0000110extern void PyEval_InitThreads Py_PROTO((void));
Guido van Rossum29e46a91997-08-02 02:56:48 +0000111extern void PyEval_AcquireLock Py_PROTO((void));
112extern void PyEval_ReleaseLock Py_PROTO((void));
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000113extern void PyEval_AcquireThread Py_PROTO((PyThreadState *tstate));
114extern void PyEval_ReleaseThread Py_PROTO((PyThreadState *tstate));
115
Guido van Rossumcaa63801995-01-12 11:45:45 +0000116#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000117 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000118 _save = PyEval_SaveThread();
119#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
120#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
121#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000122 }
123
Guido van Rossumb6775db1994-08-01 11:34:53 +0000124#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000125
Guido van Rossumcaa63801995-01-12 11:45:45 +0000126#define Py_BEGIN_ALLOW_THREADS {
127#define Py_BLOCK_THREADS
128#define Py_UNBLOCK_THREADS
129#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000130
Guido van Rossumb6775db1994-08-01 11:34:53 +0000131#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000132
133#ifdef __cplusplus
134}
135#endif
136#endif /* !Py_CEVAL_H */