Minor edits
[pytest.git] / Include / pythonrun.h
blobcfc40e3a20ef5f812be595523fa78f3cf4218812
2 /* Interfaces to parse and execute pieces of python code */
4 #ifndef Py_PYTHONRUN_H
5 #define Py_PYTHONRUN_H
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
10 #define PyCF_MASK (CO_FUTURE_DIVISION | CO_FUTURE_ABSOLUTE_IMPORT | \
11 CO_FUTURE_WITH_STATEMENT)
12 #define PyCF_MASK_OBSOLETE (CO_NESTED)
13 #define PyCF_SOURCE_IS_UTF8 0x0100
14 #define PyCF_DONT_IMPLY_DEDENT 0x0200
15 #define PyCF_ONLY_AST 0x0400
17 typedef struct {
18 int cf_flags; /* bitmask of CO_xxx flags relevant to future */
19 } PyCompilerFlags;
21 PyAPI_FUNC(void) Py_SetProgramName(char *);
22 PyAPI_FUNC(char *) Py_GetProgramName(void);
24 PyAPI_FUNC(void) Py_SetPythonHome(char *);
25 PyAPI_FUNC(char *) Py_GetPythonHome(void);
27 PyAPI_FUNC(void) Py_Initialize(void);
28 PyAPI_FUNC(void) Py_InitializeEx(int);
29 PyAPI_FUNC(void) Py_Finalize(void);
30 PyAPI_FUNC(int) Py_IsInitialized(void);
31 PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
32 PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
34 PyAPI_FUNC(int) PyRun_AnyFileFlags(FILE *, const char *, PyCompilerFlags *);
35 PyAPI_FUNC(int) PyRun_AnyFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
36 PyAPI_FUNC(int) PyRun_SimpleStringFlags(const char *, PyCompilerFlags *);
37 PyAPI_FUNC(int) PyRun_SimpleFileExFlags(FILE *, const char *, int, PyCompilerFlags *);
38 PyAPI_FUNC(int) PyRun_InteractiveOneFlags(FILE *, const char *, PyCompilerFlags *);
39 PyAPI_FUNC(int) PyRun_InteractiveLoopFlags(FILE *, const char *, PyCompilerFlags *);
41 PyAPI_FUNC(struct _mod *) PyParser_ASTFromString(const char *, const char *,
42 int, PyCompilerFlags *flags,
43 PyArena *);
44 PyAPI_FUNC(struct _mod *) PyParser_ASTFromFile(FILE *, const char *, int,
45 char *, char *,
46 PyCompilerFlags *, int *,
47 PyArena *);
48 #define PyParser_SimpleParseString(S, B) \
49 PyParser_SimpleParseStringFlags(S, B, 0)
50 #define PyParser_SimpleParseFile(FP, S, B) \
51 PyParser_SimpleParseFileFlags(FP, S, B, 0)
52 PyAPI_FUNC(struct _node *) PyParser_SimpleParseStringFlags(const char *, int,
53 int);
54 PyAPI_FUNC(struct _node *) PyParser_SimpleParseFileFlags(FILE *, const char *,
55 int, int);
57 PyAPI_FUNC(PyObject *) PyRun_StringFlags(const char *, int, PyObject *,
58 PyObject *, PyCompilerFlags *);
60 PyAPI_FUNC(PyObject *) PyRun_FileExFlags(FILE *, const char *, int,
61 PyObject *, PyObject *, int,
62 PyCompilerFlags *);
64 #define Py_CompileString(str, p, s) Py_CompileStringFlags(str, p, s, NULL)
65 PyAPI_FUNC(PyObject *) Py_CompileStringFlags(const char *, const char *, int,
66 PyCompilerFlags *);
67 PyAPI_FUNC(struct symtable *) Py_SymtableString(const char *, const char *, int);
69 PyAPI_FUNC(void) PyErr_Print(void);
70 PyAPI_FUNC(void) PyErr_PrintEx(int);
71 PyAPI_FUNC(void) PyErr_Display(PyObject *, PyObject *, PyObject *);
73 PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
75 PyAPI_FUNC(void) Py_Exit(int);
77 PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
79 /* Bootstrap */
80 PyAPI_FUNC(int) Py_Main(int argc, char **argv);
82 /* Use macros for a bunch of old variants */
83 #define PyRun_String(str, s, g, l) PyRun_StringFlags(str, s, g, l, NULL)
84 #define PyRun_AnyFile(fp, name) PyRun_AnyFileExFlags(fp, name, 0, NULL)
85 #define PyRun_AnyFileEx(fp, name, closeit) \
86 PyRun_AnyFileExFlags(fp, name, closeit, NULL)
87 #define PyRun_AnyFileFlags(fp, name, flags) \
88 PyRun_AnyFileExFlags(fp, name, 0, flags)
89 #define PyRun_SimpleString(s) PyRun_SimpleStringFlags(s, NULL)
90 #define PyRun_SimpleFile(f, p) PyRun_SimpleFileExFlags(f, p, 0, NULL)
91 #define PyRun_SimpleFileEx(f, p, c) PyRun_SimpleFileExFlags(f, p, c, NULL)
92 #define PyRun_InteractiveOne(f, p) PyRun_InteractiveOneFlags(f, p, NULL)
93 #define PyRun_InteractiveLoop(f, p) PyRun_InteractiveLoopFlags(f, p, NULL)
94 #define PyRun_File(fp, p, s, g, l) \
95 PyRun_FileExFlags(fp, p, s, g, l, 0, NULL)
96 #define PyRun_FileEx(fp, p, s, g, l, c) \
97 PyRun_FileExFlags(fp, p, s, g, l, c, NULL)
98 #define PyRun_FileFlags(fp, p, s, g, l, flags) \
99 PyRun_FileExFlags(fp, p, s, g, l, 0, flags)
101 /* In getpath.c */
102 PyAPI_FUNC(char *) Py_GetProgramFullPath(void);
103 PyAPI_FUNC(char *) Py_GetPrefix(void);
104 PyAPI_FUNC(char *) Py_GetExecPrefix(void);
105 PyAPI_FUNC(char *) Py_GetPath(void);
107 /* In their own files */
108 PyAPI_FUNC(const char *) Py_GetVersion(void);
109 PyAPI_FUNC(const char *) Py_GetPlatform(void);
110 PyAPI_FUNC(const char *) Py_GetCopyright(void);
111 PyAPI_FUNC(const char *) Py_GetCompiler(void);
112 PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
113 PyAPI_FUNC(const char *) _Py_svnversion(void);
114 PyAPI_FUNC(const char *) Py_SubversionRevision(void);
115 PyAPI_FUNC(const char *) Py_SubversionShortBranch(void);
117 /* Internal -- various one-time initializations */
118 PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
119 PyAPI_FUNC(PyObject *) _PySys_Init(void);
120 PyAPI_FUNC(void) _PyImport_Init(void);
121 PyAPI_FUNC(void) _PyExc_Init(void);
122 PyAPI_FUNC(void) _PyImportHooks_Init(void);
123 PyAPI_FUNC(int) _PyFrame_Init(void);
124 PyAPI_FUNC(int) _PyInt_Init(void);
125 PyAPI_FUNC(void) _PyFloat_Init(void);
127 /* Various internal finalizers */
128 PyAPI_FUNC(void) _PyExc_Fini(void);
129 PyAPI_FUNC(void) _PyImport_Fini(void);
130 PyAPI_FUNC(void) PyMethod_Fini(void);
131 PyAPI_FUNC(void) PyFrame_Fini(void);
132 PyAPI_FUNC(void) PyCFunction_Fini(void);
133 PyAPI_FUNC(void) PyTuple_Fini(void);
134 PyAPI_FUNC(void) PyList_Fini(void);
135 PyAPI_FUNC(void) PySet_Fini(void);
136 PyAPI_FUNC(void) PyString_Fini(void);
137 PyAPI_FUNC(void) PyInt_Fini(void);
138 PyAPI_FUNC(void) PyFloat_Fini(void);
139 PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
141 /* Stuff with no proper home (yet) */
142 PyAPI_FUNC(char *) PyOS_Readline(FILE *, FILE *, char *);
143 PyAPI_DATA(int) (*PyOS_InputHook)(void);
144 PyAPI_DATA(char) *(*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, char *);
145 PyAPI_DATA(PyThreadState*) _PyOS_ReadlineTState;
147 /* Stack size, in "pointers" (so we get extra safety margins
148 on 64-bit platforms). On a 32-bit platform, this translates
149 to a 8k margin. */
150 #define PYOS_STACK_MARGIN 2048
152 #if defined(WIN32) && !defined(MS_WIN64) && defined(_MSC_VER)
153 /* Enable stack checking under Microsoft C */
154 #define USE_STACKCHECK
155 #endif
157 #ifdef USE_STACKCHECK
158 /* Check that we aren't overflowing our stack */
159 PyAPI_FUNC(int) PyOS_CheckStack(void);
160 #endif
162 /* Signals */
163 typedef void (*PyOS_sighandler_t)(int);
164 PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
165 PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
168 #ifdef __cplusplus
170 #endif
171 #endif /* !Py_PYTHONRUN_H */