blob: f290687b0a4c514e982e48860ab8487d3b982c7b [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
Benjamin Peterson466a7822009-07-02 21:44:01 +000010#define PyCF_MASK (CO_FUTURE_DIVISION | CO_FUTURE_ABSOLUTE_IMPORT | \
11 CO_FUTURE_WITH_STATEMENT | CO_FUTURE_PRINT_FUNCTION | \
12 CO_FUTURE_UNICODE_LITERALS | CO_FUTURE_BARRY_AS_BDFL)
Benjamin Petersonffeaa882009-07-02 21:54:36 +000013#define PyCF_MASK_OBSOLETE (CO_NESTED)
Just van Rossum3aaf42c2003-02-10 08:21:10 +000014#define PyCF_SOURCE_IS_UTF8 0x0100
Guido van Rossum4b499dd32003-02-13 22:07:59 +000015#define PyCF_DONT_IMPLY_DEDENT 0x0200
Martin v. Löwisbd260da2006-02-26 19:42:26 +000016#define PyCF_ONLY_AST 0x0400
Benjamin Petersonf5b52242009-03-02 23:31:26 +000017#define PyCF_IGNORE_COOKIE 0x0800
Tim Peterse2c18e92001-08-17 20:47:47 +000018
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000019#ifndef Py_LIMITED_API
Jeremy Hylton9f324e92001-03-01 22:59:14 +000020typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 int cf_flags; /* bitmask of CO_xxx flags relevant to future */
Jeremy Hylton9f324e92001-03-01 22:59:14 +000022} PyCompilerFlags;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000023#endif
Jeremy Hylton9f324e92001-03-01 22:59:14 +000024
Martin v. Löwis790465f2008-04-05 20:41:37 +000025PyAPI_FUNC(void) Py_SetProgramName(wchar_t *);
26PyAPI_FUNC(wchar_t *) Py_GetProgramName(void);
Guido van Rossum66d4b901998-02-06 22:28:05 +000027
Martin v. Löwis790465f2008-04-05 20:41:37 +000028PyAPI_FUNC(void) Py_SetPythonHome(wchar_t *);
29PyAPI_FUNC(wchar_t *) Py_GetPythonHome(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000030
Mark Hammond91a681d2002-08-12 07:21:58 +000031PyAPI_FUNC(void) Py_Initialize(void);
Martin v. Löwis336e85f2004-08-19 11:31:58 +000032PyAPI_FUNC(void) Py_InitializeEx(int);
Mark Hammond91a681d2002-08-12 07:21:58 +000033PyAPI_FUNC(void) Py_Finalize(void);
34PyAPI_FUNC(int) Py_IsInitialized(void);
35PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
36PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000037
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000038#ifndef Py_LIMITED_API
39PyAPI_FUNC(int) PyRun_SimpleStringFlags(const char *, PyCompilerFlags *);
Martin v. Löwis056a69c2006-03-01 16:55:42 +000040PyAPI_FUNC(int) PyRun_AnyFileFlags(FILE *, const char *, PyCompilerFlags *);
41PyAPI_FUNC(int) PyRun_AnyFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000042PyAPI_FUNC(int) PyRun_SimpleFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000043PyAPI_FUNC(int) PyRun_InteractiveOneFlags(FILE *, const char *, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000044PyAPI_FUNC(int) PyRun_InteractiveLoopFlags(FILE *, const char *, PyCompilerFlags *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000046PyAPI_FUNC(struct _mod *) PyParser_ASTFromString(const char *, const char *,
47 int, PyCompilerFlags *flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +000048 PyArena *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000049PyAPI_FUNC(struct _mod *) PyParser_ASTFromFile(FILE *, const char *,
50 const char*, int,
51 char *, char *,
Neal Norwitzadb69fc2005-12-17 20:54:49 +000052 PyCompilerFlags *, int *,
53 PyArena *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000054#endif
55
56#ifndef PyParser_SimpleParseString
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000057#define PyParser_SimpleParseString(S, B) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 PyParser_SimpleParseStringFlags(S, B, 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000059#define PyParser_SimpleParseFile(FP, S, B) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 PyParser_SimpleParseFileFlags(FP, S, B, 0)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000061#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062PyAPI_FUNC(struct _node *) PyParser_SimpleParseStringFlags(const char *, int,
63 int);
Martin v. Löwis95292d62002-12-11 14:04:59 +000064PyAPI_FUNC(struct _node *) PyParser_SimpleParseFileFlags(FILE *, const char *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 int, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000066
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000067#ifndef Py_LIMITED_API
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000068PyAPI_FUNC(PyObject *) PyRun_StringFlags(const char *, int, PyObject *,
69 PyObject *, PyCompilerFlags *);
Guido van Rossum5b722181993-03-30 17:46:03 +000070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000071PyAPI_FUNC(PyObject *) PyRun_FileExFlags(FILE *, const char *, int,
72 PyObject *, PyObject *, int,
73 PyCompilerFlags *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000074#endif
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000075
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000076#ifdef Py_LIMITED_API
Martin v. Löwis0d012f22010-12-04 12:00:49 +000077PyAPI_FUNC(PyObject *) Py_CompileString(const char *, const char *, int);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000078#else
Georg Brandl8334fd92010-12-04 10:26:46 +000079#define Py_CompileString(str, p, s) Py_CompileStringExFlags(str, p, s, NULL, -1)
80#define Py_CompileStringFlags(str, p, s, f) Py_CompileStringExFlags(str, p, s, f, -1)
81PyAPI_FUNC(PyObject *) Py_CompileStringExFlags(const char *, const char *, int,
82 PyCompilerFlags *, int);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000083#endif
Martin v. Löwis95292d62002-12-11 14:04:59 +000084PyAPI_FUNC(struct symtable *) Py_SymtableString(const char *, const char *, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000085
Mark Hammond91a681d2002-08-12 07:21:58 +000086PyAPI_FUNC(void) PyErr_Print(void);
87PyAPI_FUNC(void) PyErr_PrintEx(int);
88PyAPI_FUNC(void) PyErr_Display(PyObject *, PyObject *, PyObject *);
Guido van Rossumc6cf1dd1994-09-07 14:35:10 +000089
Collin Winter670e6922007-03-21 02:57:17 +000090/* Py_PyAtExit is for the atexit module, Py_AtExit is for low-level
91 * exit functions.
92 */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000093#ifndef Py_LIMITED_API
Collin Winter670e6922007-03-21 02:57:17 +000094PyAPI_FUNC(void) _Py_PyAtExit(void (*func)(void));
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000095#endif
Mark Hammond91a681d2002-08-12 07:21:58 +000096PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
Guido van Rossuma3309961993-07-28 09:05:47 +000097
Mark Hammond91a681d2002-08-12 07:21:58 +000098PyAPI_FUNC(void) Py_Exit(int);
Fred Drake3cf4d2b2000-07-09 00:55:06 +000099
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000100/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL. */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000101#ifndef Py_LIMITED_API
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102PyAPI_FUNC(void) _Py_RestoreSignals(void);
103
Martin v. Löwis95292d62002-12-11 14:04:59 +0000104PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000105#endif
Guido van Rossum5c4998b1997-02-14 19:51:34 +0000106
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000107/* Bootstrap */
Martin v. Löwis790465f2008-04-05 20:41:37 +0000108PyAPI_FUNC(int) Py_Main(int argc, wchar_t **argv);
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000109
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000110#ifndef Py_LIMITED_API
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000111/* Use macros for a bunch of old variants */
112#define PyRun_String(str, s, g, l) PyRun_StringFlags(str, s, g, l, NULL)
113#define PyRun_AnyFile(fp, name) PyRun_AnyFileExFlags(fp, name, 0, NULL)
114#define PyRun_AnyFileEx(fp, name, closeit) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 PyRun_AnyFileExFlags(fp, name, closeit, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000116#define PyRun_AnyFileFlags(fp, name, flags) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 PyRun_AnyFileExFlags(fp, name, 0, flags)
Mark Hammondf3ddaee2005-10-23 10:53:06 +0000118#define PyRun_SimpleString(s) PyRun_SimpleStringFlags(s, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000119#define PyRun_SimpleFile(f, p) PyRun_SimpleFileExFlags(f, p, 0, NULL)
120#define PyRun_SimpleFileEx(f, p, c) PyRun_SimpleFileExFlags(f, p, c, NULL)
121#define PyRun_InteractiveOne(f, p) PyRun_InteractiveOneFlags(f, p, NULL)
122#define PyRun_InteractiveLoop(f, p) PyRun_InteractiveLoopFlags(f, p, NULL)
123#define PyRun_File(fp, p, s, g, l) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 PyRun_FileExFlags(fp, p, s, g, l, 0, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000125#define PyRun_FileEx(fp, p, s, g, l, c) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 PyRun_FileExFlags(fp, p, s, g, l, c, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000127#define PyRun_FileFlags(fp, p, s, g, l, flags) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 PyRun_FileExFlags(fp, p, s, g, l, 0, flags)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000129#endif
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000130
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000131/* In getpath.c */
Martin v. Löwis790465f2008-04-05 20:41:37 +0000132PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
133PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
134PyAPI_FUNC(wchar_t *) Py_GetExecPrefix(void);
135PyAPI_FUNC(wchar_t *) Py_GetPath(void);
Kristján Valur Jónsson3b69db22010-09-27 05:32:54 +0000136PyAPI_FUNC(void) Py_SetPath(const wchar_t *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000137#ifdef MS_WINDOWS
138int _Py_CheckPython3();
139#endif
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000140
141/* In their own files */
Mark Hammonda2905272002-07-29 13:42:14 +0000142PyAPI_FUNC(const char *) Py_GetVersion(void);
143PyAPI_FUNC(const char *) Py_GetPlatform(void);
144PyAPI_FUNC(const char *) Py_GetCopyright(void);
145PyAPI_FUNC(const char *) Py_GetCompiler(void);
146PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000147#ifndef Py_LIMITED_API
Martin v. Löwis43b57802006-01-05 23:38:54 +0000148PyAPI_FUNC(const char *) _Py_svnversion(void);
149PyAPI_FUNC(const char *) Py_SubversionRevision(void);
150PyAPI_FUNC(const char *) Py_SubversionShortBranch(void);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000151#endif
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000152
Guido van Rossum29e46a91997-08-02 02:56:48 +0000153/* Internal -- various one-time initializations */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000154#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +0000155PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
156PyAPI_FUNC(PyObject *) _PySys_Init(void);
157PyAPI_FUNC(void) _PyImport_Init(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000158PyAPI_FUNC(void) _PyExc_Init(void);
Just van Rossum52e14d62002-12-30 22:08:05 +0000159PyAPI_FUNC(void) _PyImportHooks_Init(void);
Neal Norwitzb2501f42002-12-31 03:42:13 +0000160PyAPI_FUNC(int) _PyFrame_Init(void);
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000161PyAPI_FUNC(void) _PyFloat_Init(void);
Christian Heimes9c4756e2008-05-26 13:22:05 +0000162PyAPI_FUNC(int) PyByteArray_Init(void);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000163#endif
Guido van Rossum29e46a91997-08-02 02:56:48 +0000164
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000165/* Various internal finalizers */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000166#ifndef Py_LIMITED_API
Mark Hammonda2905272002-07-29 13:42:14 +0000167PyAPI_FUNC(void) _PyExc_Fini(void);
168PyAPI_FUNC(void) _PyImport_Fini(void);
169PyAPI_FUNC(void) PyMethod_Fini(void);
170PyAPI_FUNC(void) PyFrame_Fini(void);
171PyAPI_FUNC(void) PyCFunction_Fini(void);
Christian Heimes77c02eb2008-02-09 02:18:51 +0000172PyAPI_FUNC(void) PyDict_Fini(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000173PyAPI_FUNC(void) PyTuple_Fini(void);
Raymond Hettingerfb09f0e2004-10-07 03:58:07 +0000174PyAPI_FUNC(void) PyList_Fini(void);
Raymond Hettingerd7946662005-08-01 21:39:29 +0000175PyAPI_FUNC(void) PySet_Fini(void);
Christian Heimes72b710a2008-05-26 13:28:38 +0000176PyAPI_FUNC(void) PyBytes_Fini(void);
Christian Heimes9c4756e2008-05-26 13:22:05 +0000177PyAPI_FUNC(void) PyByteArray_Fini(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000178PyAPI_FUNC(void) PyFloat_Fini(void);
179PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
Antoine Pitrou696e0352010-08-08 22:18:46 +0000180PyAPI_FUNC(void) _PyGC_Fini(void);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000181#endif
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000182
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000183/* Stuff with no proper home (yet) */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000184#ifndef Py_LIMITED_API
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000185PyAPI_FUNC(char *) PyOS_Readline(FILE *, FILE *, char *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000186#endif
Mark Hammond5d546672002-08-12 13:06:35 +0000187PyAPI_DATA(int) (*PyOS_InputHook)(void);
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000188PyAPI_DATA(char) *(*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, char *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000189#ifndef Py_LIMITED_API
Jason Tishler0d2a75c2004-08-09 15:02:30 +0000190PyAPI_DATA(PyThreadState*) _PyOS_ReadlineTState;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000191#endif
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000192
193/* Stack size, in "pointers" (so we get extra safety margins
194 on 64-bit platforms). On a 32-bit platform, this translates
195 to a 8k margin. */
196#define PYOS_STACK_MARGIN 2048
197
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +0000198#if defined(WIN32) && !defined(MS_WIN64) && defined(_MSC_VER) && _MSC_VER >= 1300
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000199/* Enable stack checking under Microsoft C */
200#define USE_STACKCHECK
201#endif
202
Jack Jansen275abb32000-08-07 21:00:42 +0000203#ifdef USE_STACKCHECK
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000204/* Check that we aren't overflowing our stack */
Mark Hammond91a681d2002-08-12 07:21:58 +0000205PyAPI_FUNC(int) PyOS_CheckStack(void);
Jack Jansen275abb32000-08-07 21:00:42 +0000206#endif
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000207
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000208/* Signals */
209typedef void (*PyOS_sighandler_t)(int);
Mark Hammond91a681d2002-08-12 07:21:58 +0000210PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
211PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000212
213
Guido van Rossuma3309961993-07-28 09:05:47 +0000214#ifdef __cplusplus
215}
216#endif
217#endif /* !Py_PYTHONRUN_H */