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