blob: 5258d57c903d766543cf6891e61d09b1f7f25acb [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 Rossumfd71b9e2000-06-30 23:50:40 +00008Copyright (c) 2000, BeOpen.com.
9Copyright (c) 1995-2000, Corporation for National Research Initiatives.
10Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
11All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000012
Guido van Rossumfd71b9e2000-06-30 23:50:40 +000013See the file "Misc/COPYRIGHT" for information on usage and
14redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015******************************************************************/
16
Guido van Rossumff4949e1992-08-05 19:58:53 +000017/* Interface to random parts in ceval.c */
Guido van Rossum3f5da241990-12-20 15:06:42 +000018
Guido van Rossum43466ec1998-12-04 18:48:25 +000019DL_IMPORT(PyObject *) PyEval_CallObjectWithKeywords
Fred Drake5eb6d4e2000-07-08 23:37:28 +000020 (PyObject *, PyObject *, PyObject *);
Guido van Rossuma0490311991-07-27 21:33:03 +000021
Guido van Rossum83684531999-03-17 18:44:39 +000022/* DLL-level Backwards compatibility: */
23#undef PyEval_CallObject
Fred Drake5eb6d4e2000-07-08 23:37:28 +000024DL_IMPORT(PyObject *) PyEval_CallObject(PyObject *, PyObject *);
Guido van Rossum83684531999-03-17 18:44:39 +000025
Guido van Rossumd7ed6831997-08-30 15:02:50 +000026/* Inline this */
27#define PyEval_CallObject(func,arg) \
28 PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)
29
Guido van Rossum3d109a01998-08-08 20:53:36 +000030#ifdef HAVE_STDARG_PROTOTYPES
Fred Drake5eb6d4e2000-07-08 23:37:28 +000031DL_IMPORT(PyObject *) PyEval_CallFunction(PyObject *obj, char *format, ...);
32DL_IMPORT(PyObject *) PyEval_CallMethod(PyObject *obj,
33 char *methodname, char *format, ...);
Guido van Rossum3d109a01998-08-08 20:53:36 +000034#else
35/* Better to have no prototypes at all for varargs functions in this case */
Guido van Rossum43466ec1998-12-04 18:48:25 +000036DL_IMPORT(PyObject *) PyEval_CallFunction();
37DL_IMPORT(PyObject *) PyEval_CallMethod();
Guido van Rossum3d109a01998-08-08 20:53:36 +000038#endif
39
Fred Drake5eb6d4e2000-07-08 23:37:28 +000040DL_IMPORT(PyObject *) PyEval_GetBuiltins(void);
41DL_IMPORT(PyObject *) PyEval_GetGlobals(void);
42DL_IMPORT(PyObject *) PyEval_GetLocals(void);
43DL_IMPORT(PyObject *) PyEval_GetOwner(void);
44DL_IMPORT(PyObject *) PyEval_GetFrame(void);
45DL_IMPORT(int) PyEval_GetRestricted(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000046
Fred Drake5eb6d4e2000-07-08 23:37:28 +000047DL_IMPORT(int) Py_FlushLine(void);
Guido van Rossumff4949e1992-08-05 19:58:53 +000048
Fred Drake5eb6d4e2000-07-08 23:37:28 +000049DL_IMPORT(int) Py_AddPendingCall(int (*func)(ANY *), ANY *arg);
50DL_IMPORT(int) Py_MakePendingCalls(void);
Guido van Rossum95664081994-09-14 13:23:36 +000051
Guido van Rossumff4949e1992-08-05 19:58:53 +000052
53/* Interface for threads.
54
55 A module that plans to do a blocking system call (or something else
56 that lasts a long time and doesn't touch Python data) can allow other
57 threads to run as follows:
58
59 ...preparations here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000060 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000061 ...blocking system call here...
Guido van Rossumcaa63801995-01-12 11:45:45 +000062 Py_END_ALLOW_THREADS
Guido van Rossum66cb3111994-12-30 15:33:50 +000063 ...interpret result here...
Guido van Rossumff4949e1992-08-05 19:58:53 +000064
Guido van Rossumcaa63801995-01-12 11:45:45 +000065 The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
66 {}-surrounded block.
Guido van Rossumff4949e1992-08-05 19:58:53 +000067 To leave the block in the middle (e.g., with return), you must insert
68 a line containing RET_SAVE before the return, e.g.
69
70 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000071 Py_BLOCK_THREADS
72 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000073 return NULL;
74 }
75
76 An alternative is:
77
Guido van Rossumcaa63801995-01-12 11:45:45 +000078 Py_BLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000079 if (...premature_exit...) {
Guido van Rossumcaa63801995-01-12 11:45:45 +000080 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumff4949e1992-08-05 19:58:53 +000081 return NULL;
82 }
Guido van Rossumcaa63801995-01-12 11:45:45 +000083 Py_UNBLOCK_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +000084
85 For convenience, that the value of 'errno' is restored across
Guido van Rossumcaa63801995-01-12 11:45:45 +000086 Py_END_ALLOW_THREADS and RET_SAVE.
Guido van Rossumff4949e1992-08-05 19:58:53 +000087
Guido van Rossumcaa63801995-01-12 11:45:45 +000088 WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
89 Py_END_ALLOW_THREADS!!!
Guido van Rossumff4949e1992-08-05 19:58:53 +000090
Guido van Rossumcaa63801995-01-12 11:45:45 +000091 The function PyEval_InitThreads() should be called only from
Guido van Rossumff4949e1992-08-05 19:58:53 +000092 initthread() in "threadmodule.c".
93
94 Note that not yet all candidates have been converted to use this
95 mechanism!
96*/
97
Fred Drake5eb6d4e2000-07-08 23:37:28 +000098extern DL_IMPORT(PyThreadState *) PyEval_SaveThread(void);
99extern DL_IMPORT(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000100
Guido van Rossumb6775db1994-08-01 11:34:53 +0000101#ifdef WITH_THREAD
Guido van Rossumff4949e1992-08-05 19:58:53 +0000102
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000103extern DL_IMPORT(void) PyEval_InitThreads(void);
104extern DL_IMPORT(void) PyEval_AcquireLock(void);
105extern DL_IMPORT(void) PyEval_ReleaseLock(void);
106extern DL_IMPORT(void) PyEval_AcquireThread(PyThreadState *tstate);
107extern DL_IMPORT(void) PyEval_ReleaseThread(PyThreadState *tstate);
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000108
Guido van Rossumcaa63801995-01-12 11:45:45 +0000109#define Py_BEGIN_ALLOW_THREADS { \
Guido van Rossum2fca21f71997-07-18 23:56:58 +0000110 PyThreadState *_save; \
Guido van Rossumcaa63801995-01-12 11:45:45 +0000111 _save = PyEval_SaveThread();
112#define Py_BLOCK_THREADS PyEval_RestoreThread(_save);
113#define Py_UNBLOCK_THREADS _save = PyEval_SaveThread();
114#define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \
Guido van Rossumff4949e1992-08-05 19:58:53 +0000115 }
116
Guido van Rossumb6775db1994-08-01 11:34:53 +0000117#else /* !WITH_THREAD */
Guido van Rossumff4949e1992-08-05 19:58:53 +0000118
Guido van Rossumcaa63801995-01-12 11:45:45 +0000119#define Py_BEGIN_ALLOW_THREADS {
120#define Py_BLOCK_THREADS
121#define Py_UNBLOCK_THREADS
122#define Py_END_ALLOW_THREADS }
Guido van Rossumff4949e1992-08-05 19:58:53 +0000123
Guido van Rossumb6775db1994-08-01 11:34:53 +0000124#endif /* !WITH_THREAD */
Guido van Rossuma3309961993-07-28 09:05:47 +0000125
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000126extern DL_IMPORT(int) _PyEval_SliceIndex(PyObject *, int *);
Guido van Rossum7c36ada2000-05-08 14:04:54 +0000127
128
Guido van Rossuma3309961993-07-28 09:05:47 +0000129#ifdef __cplusplus
130}
131#endif
132#endif /* !Py_CEVAL_H */