blob: f1a19c1b25eb7a490637132a48548d535690fd15 [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001
2/* Interfaces to configure, query, create & destroy the Python runtime */
3
4#ifndef Py_PYLIFECYCLE_H
5#define Py_PYLIFECYCLE_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
10PyAPI_FUNC(void) Py_SetProgramName(wchar_t *);
11PyAPI_FUNC(wchar_t *) Py_GetProgramName(void);
12
13PyAPI_FUNC(void) Py_SetPythonHome(wchar_t *);
14PyAPI_FUNC(wchar_t *) Py_GetPythonHome(void);
15
16#ifndef Py_LIMITED_API
17/* Only used by applications that embed the interpreter and need to
18 * override the standard encoding determination mechanism
19 */
20PyAPI_FUNC(int) Py_SetStandardStreamEncoding(const char *encoding,
21 const char *errors);
Eric Snow1abcf672017-05-23 21:46:51 -070022
23/* PEP 432 Multi-phase initialization API (Private while provisional!) */
24PyAPI_FUNC(void) _Py_InitializeCore(const _PyCoreConfig *);
25PyAPI_FUNC(int) _Py_IsCoreInitialized(void);
26PyAPI_FUNC(int) _Py_InitializeMainInterpreter(int install_sigs);
Nick Coghland6009512014-11-20 21:39:37 +100027#endif
28
Eric Snow1abcf672017-05-23 21:46:51 -070029/* Initialization and finalization */
Nick Coghland6009512014-11-20 21:39:37 +100030PyAPI_FUNC(void) Py_Initialize(void);
31PyAPI_FUNC(void) Py_InitializeEx(int);
32#ifndef Py_LIMITED_API
33PyAPI_FUNC(void) _Py_InitializeEx_Private(int, int);
34#endif
35PyAPI_FUNC(void) Py_Finalize(void);
Martin Panterb4ce1fc2015-11-30 03:18:29 +000036PyAPI_FUNC(int) Py_FinalizeEx(void);
Nick Coghland6009512014-11-20 21:39:37 +100037PyAPI_FUNC(int) Py_IsInitialized(void);
Eric Snow1abcf672017-05-23 21:46:51 -070038
39/* Subinterpreter support */
Nick Coghland6009512014-11-20 21:39:37 +100040PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
41PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
42
43
44/* Py_PyAtExit is for the atexit module, Py_AtExit is for low-level
45 * exit functions.
46 */
47#ifndef Py_LIMITED_API
48PyAPI_FUNC(void) _Py_PyAtExit(void (*func)(void));
49#endif
50PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
51
52PyAPI_FUNC(void) Py_Exit(int);
53
54/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL. */
55#ifndef Py_LIMITED_API
56PyAPI_FUNC(void) _Py_RestoreSignals(void);
57
58PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
59#endif
60
61/* Bootstrap __main__ (defined in Modules/main.c) */
62PyAPI_FUNC(int) Py_Main(int argc, wchar_t **argv);
63
64/* In getpath.c */
65PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
66PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
67PyAPI_FUNC(wchar_t *) Py_GetExecPrefix(void);
68PyAPI_FUNC(wchar_t *) Py_GetPath(void);
69PyAPI_FUNC(void) Py_SetPath(const wchar_t *);
70#ifdef MS_WINDOWS
71int _Py_CheckPython3();
72#endif
73
74/* In their own files */
75PyAPI_FUNC(const char *) Py_GetVersion(void);
76PyAPI_FUNC(const char *) Py_GetPlatform(void);
77PyAPI_FUNC(const char *) Py_GetCopyright(void);
78PyAPI_FUNC(const char *) Py_GetCompiler(void);
79PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
80#ifndef Py_LIMITED_API
Ned Deily5c4b0d02017-03-04 00:19:55 -050081PyAPI_FUNC(const char *) _Py_gitidentifier(void);
82PyAPI_FUNC(const char *) _Py_gitversion(void);
Nick Coghland6009512014-11-20 21:39:37 +100083#endif
84
85/* Internal -- various one-time initializations */
86#ifndef Py_LIMITED_API
87PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
Eric Snow6b4be192017-05-22 21:36:03 -070088PyAPI_FUNC(PyObject *) _PySys_BeginInit(void);
89PyAPI_FUNC(int) _PySys_EndInit(PyObject *sysdict);
Nick Coghland6009512014-11-20 21:39:37 +100090PyAPI_FUNC(void) _PyImport_Init(void);
91PyAPI_FUNC(void) _PyExc_Init(PyObject * bltinmod);
92PyAPI_FUNC(void) _PyImportHooks_Init(void);
93PyAPI_FUNC(int) _PyFrame_Init(void);
94PyAPI_FUNC(int) _PyFloat_Init(void);
95PyAPI_FUNC(int) PyByteArray_Init(void);
Eric Snow1abcf672017-05-23 21:46:51 -070096PyAPI_FUNC(void) _Py_HashRandomization_Init(_PyCoreConfig *core_config);
Nick Coghland6009512014-11-20 21:39:37 +100097#endif
98
99/* Various internal finalizers */
100#ifndef Py_LIMITED_API
101PyAPI_FUNC(void) _PyExc_Fini(void);
102PyAPI_FUNC(void) _PyImport_Fini(void);
103PyAPI_FUNC(void) PyMethod_Fini(void);
104PyAPI_FUNC(void) PyFrame_Fini(void);
105PyAPI_FUNC(void) PyCFunction_Fini(void);
106PyAPI_FUNC(void) PyDict_Fini(void);
107PyAPI_FUNC(void) PyTuple_Fini(void);
108PyAPI_FUNC(void) PyList_Fini(void);
109PyAPI_FUNC(void) PySet_Fini(void);
110PyAPI_FUNC(void) PyBytes_Fini(void);
111PyAPI_FUNC(void) PyByteArray_Fini(void);
112PyAPI_FUNC(void) PyFloat_Fini(void);
113PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
114PyAPI_FUNC(void) _PyGC_DumpShutdownStats(void);
115PyAPI_FUNC(void) _PyGC_Fini(void);
116PyAPI_FUNC(void) PySlice_Fini(void);
117PyAPI_FUNC(void) _PyType_Fini(void);
Eric Snow6b4be192017-05-22 21:36:03 -0700118PyAPI_FUNC(void) _Py_HashRandomization_Fini(void);
Yury Selivanoveb636452016-09-08 22:01:51 -0700119PyAPI_FUNC(void) PyAsyncGen_Fini(void);
Nick Coghland6009512014-11-20 21:39:37 +1000120
121PyAPI_DATA(PyThreadState *) _Py_Finalizing;
122#endif
123
124/* Signals */
125typedef void (*PyOS_sighandler_t)(int);
126PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
127PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
128
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +0300129#ifndef Py_LIMITED_API
Nick Coghland6009512014-11-20 21:39:37 +1000130/* Random */
Victor Stinnere66987e2016-09-06 16:33:52 -0700131PyAPI_FUNC(int) _PyOS_URandom(void *buffer, Py_ssize_t size);
132PyAPI_FUNC(int) _PyOS_URandomNonblock(void *buffer, Py_ssize_t size);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +0300133#endif /* !Py_LIMITED_API */
Nick Coghland6009512014-11-20 21:39:37 +1000134
135#ifdef __cplusplus
136}
137#endif
138#endif /* !Py_PYLIFECYCLE_H */