blob: 229d7fadc244fd000ef120c8585651b00200916e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module object interface */
3
Fred Drake3cf4d2b2000-07-09 00:55:06 +00004#ifndef Py_MODULEOBJECT_H
5#define Py_MODULEOBJECT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Mark Hammond91a681d2002-08-12 07:21:58 +000010PyAPI_DATA(PyTypeObject) PyModule_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011
Guido van Rossumb8755092001-09-10 18:21:59 +000012#define PyModule_Check(op) PyObject_TypeCheck(op, &PyModule_Type)
Christian Heimes90aa7642007-12-19 02:45:37 +000013#define PyModule_CheckExact(op) (Py_TYPE(op) == &PyModule_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000014
Victor Stinner0639b562011-03-04 12:57:07 +000015PyAPI_FUNC(PyObject *) PyModule_NewObject(
16 PyObject *name
17 );
Victor Stinnerd7e76402011-02-22 23:38:34 +000018PyAPI_FUNC(PyObject *) PyModule_New(
19 const char *name /* UTF-8 encoded string */
20 );
Mark Hammond91a681d2002-08-12 07:21:58 +000021PyAPI_FUNC(PyObject *) PyModule_GetDict(PyObject *);
Victor Stinnerbd475112011-02-23 00:21:43 +000022PyAPI_FUNC(PyObject *) PyModule_GetNameObject(PyObject *);
Neal Norwitz312e10d2007-08-26 02:21:42 +000023PyAPI_FUNC(const char *) PyModule_GetName(PyObject *);
24PyAPI_FUNC(const char *) PyModule_GetFilename(PyObject *);
Victor Stinner6c00c142010-08-17 23:37:11 +000025PyAPI_FUNC(PyObject *) PyModule_GetFilenameObject(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000026#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +000027PyAPI_FUNC(void) _PyModule_Clear(PyObject *);
Serhiy Storchaka87a5c512014-02-10 18:21:34 +020028PyAPI_FUNC(void) _PyModule_ClearDict(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000029#endif
Martin v. Löwis1a214512008-06-11 05:26:20 +000030PyAPI_FUNC(struct PyModuleDef*) PyModule_GetDef(PyObject*);
31PyAPI_FUNC(void*) PyModule_GetState(PyObject*);
32
Yury Selivanovca829102015-06-02 19:06:47 -040033#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
34/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100035PyAPI_FUNC(PyObject *) PyModuleDef_Init(struct PyModuleDef*);
Steve Dower11d7b142015-05-23 14:44:37 -070036PyAPI_DATA(PyTypeObject) PyModuleDef_Type;
Yury Selivanovca829102015-06-02 19:06:47 -040037#endif
Nick Coghland5cacbb2015-05-23 22:24:10 +100038
Martin v. Löwis1a214512008-06-11 05:26:20 +000039typedef struct PyModuleDef_Base {
40 PyObject_HEAD
41 PyObject* (*m_init)(void);
42 Py_ssize_t m_index;
43 PyObject* m_copy;
44} PyModuleDef_Base;
45
David Malcolm82e73cb2010-11-17 21:20:18 +000046#define PyModuleDef_HEAD_INIT { \
47 PyObject_HEAD_INIT(NULL) \
48 NULL, /* m_init */ \
49 0, /* m_index */ \
50 NULL, /* m_copy */ \
51 }
Martin v. Löwis1a214512008-06-11 05:26:20 +000052
Yury Selivanovca829102015-06-02 19:06:47 -040053struct PyModuleDef_Slot;
54#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
55/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100056typedef struct PyModuleDef_Slot{
57 int slot;
58 void *value;
59} PyModuleDef_Slot;
60
Nick Coghland5cacbb2015-05-23 22:24:10 +100061#define Py_mod_create 1
62#define Py_mod_exec 2
63
64#ifndef Py_LIMITED_API
65#define _Py_mod_LAST_SLOT 2
66#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000067
Yury Selivanovca829102015-06-02 19:06:47 -040068#endif /* New in 3.5 */
69
70typedef struct PyModuleDef{
71 PyModuleDef_Base m_base;
72 const char* m_name;
73 const char* m_doc;
74 Py_ssize_t m_size;
75 PyMethodDef *m_methods;
76 struct PyModuleDef_Slot* m_slots;
77 traverseproc m_traverse;
78 inquiry m_clear;
79 freefunc m_free;
80}PyModuleDef;
81
Guido van Rossuma3309961993-07-28 09:05:47 +000082#ifdef __cplusplus
83}
84#endif
85#endif /* !Py_MODULEOBJECT_H */