blob: 6bfc175050064fa3f5ab5dbade726707d8e7a214 [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
Neal Norwitzcbce2802006-04-03 06:26:32 +000010#define PyCF_MASK (CO_FUTURE_DIVISION | CO_FUTURE_ABSOLUTE_IMPORT | \
Christian Heimes3c608332008-03-26 22:01:37 +000011 CO_FUTURE_WITH_STATEMENT | CO_FUTURE_PRINT_FUNCTION | \
12 CO_FUTURE_UNICODE_LITERALS)
Neal Norwitzab51f5f2006-02-25 15:43:10 +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
Tim Peterse2c18e92001-08-17 20:47:47 +000017
Jeremy Hylton9f324e92001-03-01 22:59:14 +000018typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000019 int cf_flags; /* bitmask of CO_xxx flags relevant to future */
Jeremy Hylton9f324e92001-03-01 22:59:14 +000020} PyCompilerFlags;
21
Mark Hammond91a681d2002-08-12 07:21:58 +000022PyAPI_FUNC(void) Py_SetProgramName(char *);
23PyAPI_FUNC(char *) Py_GetProgramName(void);
Guido van Rossum66d4b901998-02-06 22:28:05 +000024
Mark Hammond91a681d2002-08-12 07:21:58 +000025PyAPI_FUNC(void) Py_SetPythonHome(char *);
26PyAPI_FUNC(char *) Py_GetPythonHome(void);
Guido van Rossum3f5da241990-12-20 15:06:42 +000027
Mark Hammond91a681d2002-08-12 07:21:58 +000028PyAPI_FUNC(void) Py_Initialize(void);
Martin v. Löwis336e85f2004-08-19 11:31:58 +000029PyAPI_FUNC(void) Py_InitializeEx(int);
Mark Hammond91a681d2002-08-12 07:21:58 +000030PyAPI_FUNC(void) Py_Finalize(void);
31PyAPI_FUNC(int) Py_IsInitialized(void);
32PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
33PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000034
Martin v. Löwis056a69c2006-03-01 16:55:42 +000035PyAPI_FUNC(int) PyRun_AnyFileFlags(FILE *, const char *, PyCompilerFlags *);
36PyAPI_FUNC(int) PyRun_AnyFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000037PyAPI_FUNC(int) PyRun_SimpleStringFlags(const char *, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000038PyAPI_FUNC(int) PyRun_SimpleFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000039PyAPI_FUNC(int) PyRun_InteractiveOneFlags(FILE *, const char *, PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000040PyAPI_FUNC(int) PyRun_InteractiveLoopFlags(FILE *, const char *, PyCompilerFlags *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000041
Antoine Pitrouc83ea132010-05-09 14:46:46 +000042PyAPI_FUNC(struct _mod *) PyParser_ASTFromString(const char *, const char *,
43 int, PyCompilerFlags *flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +000044 PyArena *);
Antoine Pitrouc83ea132010-05-09 14:46:46 +000045PyAPI_FUNC(struct _mod *) PyParser_ASTFromFile(FILE *, const char *, int,
46 char *, char *,
Neal Norwitzadb69fc2005-12-17 20:54:49 +000047 PyCompilerFlags *, int *,
48 PyArena *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000049#define PyParser_SimpleParseString(S, B) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000050 PyParser_SimpleParseStringFlags(S, B, 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000051#define PyParser_SimpleParseFile(FP, S, B) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000052 PyParser_SimpleParseFileFlags(FP, S, B, 0)
53PyAPI_FUNC(struct _node *) PyParser_SimpleParseStringFlags(const char *, int,
54 int);
Martin v. Löwis95292d62002-12-11 14:04:59 +000055PyAPI_FUNC(struct _node *) PyParser_SimpleParseFileFlags(FILE *, const char *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000056 int, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000057
Antoine Pitrouc83ea132010-05-09 14:46:46 +000058PyAPI_FUNC(PyObject *) PyRun_StringFlags(const char *, int, PyObject *,
59 PyObject *, PyCompilerFlags *);
Guido van Rossum5b722181993-03-30 17:46:03 +000060
Antoine Pitrouc83ea132010-05-09 14:46:46 +000061PyAPI_FUNC(PyObject *) PyRun_FileExFlags(FILE *, const char *, int,
62 PyObject *, PyObject *, int,
63 PyCompilerFlags *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000064
65#define Py_CompileString(str, p, s) Py_CompileStringFlags(str, p, s, NULL)
Martin v. Löwis95292d62002-12-11 14:04:59 +000066PyAPI_FUNC(PyObject *) Py_CompileStringFlags(const char *, const char *, int,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000067 PyCompilerFlags *);
Martin v. Löwis95292d62002-12-11 14:04:59 +000068PyAPI_FUNC(struct symtable *) Py_SymtableString(const char *, const char *, int);
Guido van Rossum3f5da241990-12-20 15:06:42 +000069
Mark Hammond91a681d2002-08-12 07:21:58 +000070PyAPI_FUNC(void) PyErr_Print(void);
71PyAPI_FUNC(void) PyErr_PrintEx(int);
72PyAPI_FUNC(void) PyErr_Display(PyObject *, PyObject *, PyObject *);
Guido van Rossumc6cf1dd1994-09-07 14:35:10 +000073
Mark Hammond91a681d2002-08-12 07:21:58 +000074PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
Guido van Rossuma3309961993-07-28 09:05:47 +000075
Mark Hammond91a681d2002-08-12 07:21:58 +000076PyAPI_FUNC(void) Py_Exit(int);
Fred Drake3cf4d2b2000-07-09 00:55:06 +000077
Martin v. Löwis95292d62002-12-11 14:04:59 +000078PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
Guido van Rossum5c4998b1997-02-14 19:51:34 +000079
Mark Hammondfe51c6d2002-08-02 02:27:13 +000080/* Bootstrap */
81PyAPI_FUNC(int) Py_Main(int argc, char **argv);
82
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000083/* Use macros for a bunch of old variants */
84#define PyRun_String(str, s, g, l) PyRun_StringFlags(str, s, g, l, NULL)
85#define PyRun_AnyFile(fp, name) PyRun_AnyFileExFlags(fp, name, 0, NULL)
86#define PyRun_AnyFileEx(fp, name, closeit) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000087 PyRun_AnyFileExFlags(fp, name, closeit, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000088#define PyRun_AnyFileFlags(fp, name, flags) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000089 PyRun_AnyFileExFlags(fp, name, 0, flags)
Mark Hammondf3ddaee2005-10-23 10:53:06 +000090#define PyRun_SimpleString(s) PyRun_SimpleStringFlags(s, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000091#define PyRun_SimpleFile(f, p) PyRun_SimpleFileExFlags(f, p, 0, NULL)
92#define PyRun_SimpleFileEx(f, p, c) PyRun_SimpleFileExFlags(f, p, c, NULL)
93#define PyRun_InteractiveOne(f, p) PyRun_InteractiveOneFlags(f, p, NULL)
94#define PyRun_InteractiveLoop(f, p) PyRun_InteractiveLoopFlags(f, p, NULL)
95#define PyRun_File(fp, p, s, g, l) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000096 PyRun_FileExFlags(fp, p, s, g, l, 0, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000097#define PyRun_FileEx(fp, p, s, g, l, c) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000098 PyRun_FileExFlags(fp, p, s, g, l, c, NULL)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000099#define PyRun_FileFlags(fp, p, s, g, l, flags) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000100 PyRun_FileExFlags(fp, p, s, g, l, 0, flags)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000101
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000102/* In getpath.c */
Mark Hammonda2905272002-07-29 13:42:14 +0000103PyAPI_FUNC(char *) Py_GetProgramFullPath(void);
104PyAPI_FUNC(char *) Py_GetPrefix(void);
105PyAPI_FUNC(char *) Py_GetExecPrefix(void);
106PyAPI_FUNC(char *) Py_GetPath(void);
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000107
108/* In their own files */
Mark Hammonda2905272002-07-29 13:42:14 +0000109PyAPI_FUNC(const char *) Py_GetVersion(void);
110PyAPI_FUNC(const char *) Py_GetPlatform(void);
111PyAPI_FUNC(const char *) Py_GetCopyright(void);
112PyAPI_FUNC(const char *) Py_GetCompiler(void);
113PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
Martin v. Löwis43b57802006-01-05 23:38:54 +0000114PyAPI_FUNC(const char *) _Py_svnversion(void);
115PyAPI_FUNC(const char *) Py_SubversionRevision(void);
116PyAPI_FUNC(const char *) Py_SubversionShortBranch(void);
Georg Brandl3a5508e2011-03-06 10:42:21 +0100117PyAPI_FUNC(const char *) _Py_hgidentifier(void);
118PyAPI_FUNC(const char *) _Py_hgversion(void);
Guido van Rossum57d8e3f1997-07-19 19:50:52 +0000119
Guido van Rossum29e46a91997-08-02 02:56:48 +0000120/* Internal -- various one-time initializations */
Mark Hammond91a681d2002-08-12 07:21:58 +0000121PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
122PyAPI_FUNC(PyObject *) _PySys_Init(void);
123PyAPI_FUNC(void) _PyImport_Init(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000124PyAPI_FUNC(void) _PyExc_Init(void);
Just van Rossum52e14d62002-12-30 22:08:05 +0000125PyAPI_FUNC(void) _PyImportHooks_Init(void);
Neal Norwitzb2501f42002-12-31 03:42:13 +0000126PyAPI_FUNC(int) _PyFrame_Init(void);
Neal Norwitzdc392e32003-01-01 15:18:32 +0000127PyAPI_FUNC(int) _PyInt_Init(void);
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000128PyAPI_FUNC(int) _PyLong_Init(void);
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000129PyAPI_FUNC(void) _PyFloat_Init(void);
Christian Heimes3497f942008-05-26 12:29:14 +0000130PyAPI_FUNC(int) PyByteArray_Init(void);
Antoine Pitroucc3fa882012-02-21 20:42:48 +0100131PyAPI_FUNC(void) _PyRandom_Init(void);
Guido van Rossum29e46a91997-08-02 02:56:48 +0000132
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000133/* Various internal finalizers */
Mark Hammonda2905272002-07-29 13:42:14 +0000134PyAPI_FUNC(void) _PyExc_Fini(void);
135PyAPI_FUNC(void) _PyImport_Fini(void);
136PyAPI_FUNC(void) PyMethod_Fini(void);
137PyAPI_FUNC(void) PyFrame_Fini(void);
138PyAPI_FUNC(void) PyCFunction_Fini(void);
Christian Heimesf75dbef2008-02-08 00:11:31 +0000139PyAPI_FUNC(void) PyDict_Fini(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000140PyAPI_FUNC(void) PyTuple_Fini(void);
Raymond Hettingerfb09f0e2004-10-07 03:58:07 +0000141PyAPI_FUNC(void) PyList_Fini(void);
Raymond Hettingerd7946662005-08-01 21:39:29 +0000142PyAPI_FUNC(void) PySet_Fini(void);
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000143PyAPI_FUNC(void) PyString_Fini(void);
Mark Hammonda2905272002-07-29 13:42:14 +0000144PyAPI_FUNC(void) PyInt_Fini(void);
145PyAPI_FUNC(void) PyFloat_Fini(void);
146PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
Christian Heimes3497f942008-05-26 12:29:14 +0000147PyAPI_FUNC(void) PyByteArray_Fini(void);
Guido van Rossum8e5e4461997-08-12 14:57:21 +0000148
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000149/* Stuff with no proper home (yet) */
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000150PyAPI_FUNC(char *) PyOS_Readline(FILE *, FILE *, char *);
Mark Hammond5d546672002-08-12 13:06:35 +0000151PyAPI_DATA(int) (*PyOS_InputHook)(void);
Martin v. Löwis566f6af2002-10-26 14:39:10 +0000152PyAPI_DATA(char) *(*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, char *);
Jason Tishler0d2a75c2004-08-09 15:02:30 +0000153PyAPI_DATA(PyThreadState*) _PyOS_ReadlineTState;
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000154
155/* Stack size, in "pointers" (so we get extra safety margins
156 on 64-bit platforms). On a 32-bit platform, this translates
157 to a 8k margin. */
158#define PYOS_STACK_MARGIN 2048
159
Amaury Forgeot d'Arca4dd2e22008-06-13 00:42:22 +0000160#if defined(WIN32) && !defined(MS_WIN64) && defined(_MSC_VER) && _MSC_VER >= 1300
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000161/* Enable stack checking under Microsoft C */
162#define USE_STACKCHECK
163#endif
164
Jack Jansen275abb32000-08-07 21:00:42 +0000165#ifdef USE_STACKCHECK
Fredrik Lundh2f15b252000-08-27 19:15:31 +0000166/* Check that we aren't overflowing our stack */
Mark Hammond91a681d2002-08-12 07:21:58 +0000167PyAPI_FUNC(int) PyOS_CheckStack(void);
Jack Jansen275abb32000-08-07 21:00:42 +0000168#endif
Guido van Rossum3fb1aea1997-08-12 15:14:22 +0000169
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000170/* Signals */
171typedef void (*PyOS_sighandler_t)(int);
Mark Hammond91a681d2002-08-12 07:21:58 +0000172PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
173PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000174
Barry Warsaw1e13eb02012-02-20 20:42:21 -0500175/* Random */
176PyAPI_FUNC(int) _PyOS_URandom (void *buffer, Py_ssize_t size);
Guido van Rossumc7247ce2000-09-16 16:31:31 +0000177
Guido van Rossuma3309961993-07-28 09:05:47 +0000178#ifdef __cplusplus
179}
180#endif
181#endif /* !Py_PYTHONRUN_H */