blob: 33497ceafca22f9bbcf7c821b30a52a72cb4ae7a [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Interfaces to parse and execute pieces of python code */
3
Fred Drake3cf4d2b2000-07-09 00:55:06 +00004#ifndef Py_PYTHONRUN_H
5#define Py_PYTHONRUN_H
6#ifdef __cplusplus
7extern "C" {
8#endif
Guido van Rossum57d8e3f1997-07-19 19:50:52 +00009
Tim Peters2bbdba32002-04-12 01:20:10 +000010#define PyCF_MASK (CO_FUTURE_DIVISION)
11#define PyCF_MASK_OBSOLETE (CO_GENERATOR_ALLOWED | CO_NESTED)
Just van Rossum3aaf42c2003-02-10 08:21:10 +000012#define PyCF_SOURCE_IS_UTF8 0x0100
Guido van Rossum4b499dd32003-02-13 22:07:59 +000013#define PyCF_DONT_IMPLY_DEDENT 0x0200
Tim Peterse2c18e92001-08-17 20:47:47 +000014
Jeremy Hylton9f324e92001-03-01 22:59:14 +000015typedef struct {
Jeremy Hyltonfdd12f62001-08-10 21:38:04 +000016 int cf_flags; /* bitmask of CO_xxx flags relevant to future */
Jeremy Hylton9f324e92001-03-01 22:59:14 +000017} PyCompilerFlags;
18
Mark Hammond91a681d2002-08-12 07:21:58 +000019PyAPI_FUNC(void) Py_SetProgramName(char *);
20PyAPI_FUNC(char *) Py_GetProgramName(void);
Guido van Rossum66d4b901998-02-06 22:28:05 +000021
Mark Hammond91a681d2002-08-12 07:21:58 +000022PyAPI_FUNC(void) Py_SetPythonHome(char *);
23PyAPI_FUNC(char *) Py_GetPythonHome(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000024
Mark Hammond91a681d2002-08-12 07:21:58 +000025PyAPI_FUNC(void) Py_Initialize(void);
Martin v. Löwis336e85f2004-08-19 11:31:58 +000026PyAPI_FUNC(void) Py_InitializeEx(int);
Mark Hammond91a681d2002-08-12 07:21:58 +000027PyAPI_FUNC(void) Py_Finalize(void);
28PyAPI_FUNC(int) Py_IsInitialized(void);
29PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
30PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000031
Martin v. Löwis95292d62002-12-11 14:04:59 +000032PyAPI_FUNC(int) PyRun_AnyFile(FILE *, const char *);
33PyAPI_FUNC(int) PyRun_AnyFileEx(FILE *, const char *, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000034
Martin v. Löwis95292d62002-12-11 14:04:59 +000035PyAPI_FUNC(int) PyRun_AnyFileFlags(FILE *, const char *, PyCompilerFlags *);
36PyAPI_FUNC(int) PyRun_AnyFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
Jeremy Hyltonbc320242001-03-22 02:47:58 +000037
Martin v. Löwis95292d62002-12-11 14:04:59 +000038PyAPI_FUNC(int) PyRun_SimpleString(const char *);
39PyAPI_FUNC(int) PyRun_SimpleStringFlags(const char *, PyCompilerFlags *);
40PyAPI_FUNC(int) PyRun_SimpleFile(FILE *, const char *);
41PyAPI_FUNC(int) PyRun_SimpleFileEx(FILE *, const char *, int);
42PyAPI_FUNC(int) PyRun_SimpleFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
43PyAPI_FUNC(int) PyRun_InteractiveOne(FILE *, const char *);
44PyAPI_FUNC(int) PyRun_InteractiveOneFlags(FILE *, const char *, PyCompilerFlags *);
45PyAPI_FUNC(int) PyRun_InteractiveLoop(FILE *, const char *);
46PyAPI_FUNC(int) PyRun_InteractiveLoopFlags(FILE *, const char *, PyCompilerFlags *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000047
Martin v. Löwis95292d62002-12-11 14:04:59 +000048PyAPI_FUNC(struct _node *) PyParser_SimpleParseString(const char *, int);
49PyAPI_FUNC(struct _node *) PyParser_SimpleParseFile(FILE *, const char *, int);
50PyAPI_FUNC(struct _node *) PyParser_SimpleParseStringFlags(const char *, int, int);
51PyAPI_FUNC(struct _node *) PyParser_SimpleParseStringFlagsFilename(const char *,
52 const char *,
Thomas Heller6b17abf2002-07-09 09:23:27 +000053 int,
54 int);
Martin v. Löwis95292d62002-12-11 14:04:59 +000055PyAPI_FUNC(struct _node *) PyParser_SimpleParseFileFlags(FILE *, const char *,
Tim Petersfe2127d2001-07-16 05:37:24 +000056 int, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000057
Martin v. Löwis95292d62002-12-11 14:04:59 +000058PyAPI_FUNC(PyObject *) PyRun_String(const char *, int, PyObject *, PyObject *);
59PyAPI_FUNC(PyObject *) PyRun_File(FILE *, const char *, int, PyObject *, PyObject *);
60PyAPI_FUNC(PyObject *) PyRun_FileEx(FILE *, const char *, int,
Guido van Rossum0df002c2000-08-27 19:21:52 +000061 PyObject *, PyObject *, int);
Martin v. Löwis95292d62002-12-11 14:04:59 +000062PyAPI_FUNC(PyObject *) PyRun_StringFlags(const char *, int, PyObject *, PyObject *,
Jeremy Hyltonbc320242001-03-22 02:47:58 +000063 PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000064PyAPI_FUNC(PyObject *) PyRun_FileFlags(FILE *, const char *, int, PyObject *,
Jeremy Hyltonbc320242001-03-22 02:47:58 +000065 PyObject *, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000066PyAPI_FUNC(PyObject *) PyRun_FileExFlags(FILE *, const char *, int, PyObject *,
Jeremy Hyltonbc320242001-03-22 02:47:58 +000067 PyObject *, int, PyCompilerFlags *);
Guido van Rossum5b722181993-03-30 17:46:03 +000068
Martin v. Löwis95292d62002-12-11 14:04:59 +000069PyAPI_FUNC(PyObject *) Py_CompileString(const char *, const char *, int);
70PyAPI_FUNC(PyObject *) Py_CompileStringFlags(const char *, const char *, int,
Jeremy Hyltonbc320242001-03-22 02:47:58 +000071 PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000072PyAPI_FUNC(struct symtable *) Py_SymtableString(const char *, const char *, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000073
Mark Hammond91a681d2002-08-12 07:21:58 +000074PyAPI_FUNC(void) PyErr_Print(void);
75PyAPI_FUNC(void) PyErr_PrintEx(int);
76PyAPI_FUNC(void) PyErr_Display(PyObject *, PyObject *, PyObject *);
Guido van Rossumc6cf1dd1994-09-07 14:35:10 +000077
Mark Hammond91a681d2002-08-12 07:21:58 +000078PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
Guido van Rossuma3309961993-07-28 09:05:47 +000079
Mark Hammond91a681d2002-08-12 07:21:58 +000080PyAPI_FUNC(void) Py_Exit(int);
Fred Drake3cf4d2b2000-07-09 00:55:06 +000081
Martin v. Löwis95292d62002-12-11 14:04:59 +000082PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
Guido van Rossum5c4998b1997-02-14 19:51:34 +000083
Mark Hammondfe51c6d2002-08-02 02:27:13 +000084/* Bootstrap */
85PyAPI_FUNC(int) Py_Main(int argc, char **argv);
86
Guido van Rossum57d8e3f1997-07-19 19:50:52 +000087/* In getpath.c */
Mark Hammonda2905272002-07-29 13:42:14 +000088PyAPI_FUNC(char *) Py_GetProgramFullPath(void);
89PyAPI_FUNC(char *) Py_GetPrefix(void);
90PyAPI_FUNC(char *) Py_GetExecPrefix(void);
91PyAPI_FUNC(char *) Py_GetPath(void);
Guido van Rossum57d8e3f1997-07-19 19:50:52 +000092
93/* In their own files */
Mark Hammonda2905272002-07-29 13:42:14 +000094PyAPI_FUNC(const char *) Py_GetVersion(void);
95PyAPI_FUNC(const char *) Py_GetPlatform(void);
96PyAPI_FUNC(const char *) Py_GetCopyright(void);
97PyAPI_FUNC(const char *) Py_GetCompiler(void);
98PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
Guido van Rossum57d8e3f1997-07-19 19:50:52 +000099
Guido van Rossum29e46a91997-08-02 02:56:48 +0000100/* Internal -- various one-time initializations */
Mark Hammond91a681d2002-08-12 07:21:58 +0000101PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
102PyAPI_FUNC(PyObject *) _PySys_Init(void);
103PyAPI_FUNC(void) _PyImport_Init(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000104PyAPI_FUNC(void) _PyExc_Init(void);
Just van Rossum52e14d62002-12-30 22:08:05 +0000105PyAPI_FUNC(void) _PyImportHooks_Init(void);
Neal Norwitzb2501f42002-12-31 03:42:13 +0000106PyAPI_FUNC(int) _PyFrame_Init(void);
Neal Norwitzdc392e32003-01-01 15:18:32 +0000107PyAPI_FUNC(int) _PyInt_Init(void);
Guido van Rossum29e46a91997-08-02 02:56:48 +0000108
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000109/* Various internal finalizers */
Mark Hammonda2905272002-07-29 13:42:14 +0000110PyAPI_FUNC(void) _PyExc_Fini(void);
111PyAPI_FUNC(void) _PyImport_Fini(void);
112PyAPI_FUNC(void) PyMethod_Fini(void);
113PyAPI_FUNC(void) PyFrame_Fini(void);
114PyAPI_FUNC(void) PyCFunction_Fini(void);
115PyAPI_FUNC(void) PyTuple_Fini(void);
Raymond Hettingerfb09f0e2004-10-07 03:58:07 +0000116PyAPI_FUNC(void) PyList_Fini(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000117PyAPI_FUNC(void) PyString_Fini(void);
118PyAPI_FUNC(void) PyInt_Fini(void);
119PyAPI_FUNC(void) PyFloat_Fini(void);
120PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000121
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000122/* Stuff with no proper home (yet) */
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000123PyAPI_FUNC(char *) PyOS_Readline(FILE *, FILE *, char *);
Mark Hammond5d546672002-08-12 13:06:35 +0000124PyAPI_DATA(int) (*PyOS_InputHook)(void);
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000125PyAPI_DATA(char) *(*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, char *);
Jason Tishler0d2a75c2004-08-09 15:02:30 +0000126PyAPI_DATA(PyThreadState*) _PyOS_ReadlineTState;
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000127
128/* Stack size, in "pointers" (so we get extra safety margins
129 on 64-bit platforms). On a 32-bit platform, this translates
130 to a 8k margin. */
131#define PYOS_STACK_MARGIN 2048
132
Trent Mick0a7af402000-10-11 17:18:11 +0000133#if defined(WIN32) && !defined(MS_WIN64) && defined(_MSC_VER)
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000134/* Enable stack checking under Microsoft C */
135#define USE_STACKCHECK
136#endif
137
Jack Jansen275abb32000-08-07 21:00:42 +0000138#ifdef USE_STACKCHECK
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000139/* Check that we aren't overflowing our stack */
Mark Hammond91a681d2002-08-12 07:21:58 +0000140PyAPI_FUNC(int) PyOS_CheckStack(void);
Jack Jansen275abb32000-08-07 21:00:42 +0000141#endif
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000142
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000143/* Signals */
144typedef void (*PyOS_sighandler_t)(int);
Mark Hammond91a681d2002-08-12 07:21:58 +0000145PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
146PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000147
148
Guido van Rossuma3309961993-07-28 09:05:47 +0000149#ifdef __cplusplus
150}
151#endif
152#endif /* !Py_PYTHONRUN_H */