blob: 79ca7ec74aca3bce4881881db3bf05122a3b165e [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 Stinnerd7e76402011-02-22 23:38:34 +000015PyAPI_FUNC(PyObject *) PyModule_New(
16 const char *name /* UTF-8 encoded string */
17 );
Mark Hammond91a681d2002-08-12 07:21:58 +000018PyAPI_FUNC(PyObject *) PyModule_GetDict(PyObject *);
Victor Stinnerbd475112011-02-23 00:21:43 +000019PyAPI_FUNC(PyObject *) PyModule_GetNameObject(PyObject *);
Neal Norwitz312e10d2007-08-26 02:21:42 +000020PyAPI_FUNC(const char *) PyModule_GetName(PyObject *);
21PyAPI_FUNC(const char *) PyModule_GetFilename(PyObject *);
Victor Stinner6c00c142010-08-17 23:37:11 +000022PyAPI_FUNC(PyObject *) PyModule_GetFilenameObject(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000023#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +000024PyAPI_FUNC(void) _PyModule_Clear(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000025#endif
Martin v. Löwis1a214512008-06-11 05:26:20 +000026PyAPI_FUNC(struct PyModuleDef*) PyModule_GetDef(PyObject*);
27PyAPI_FUNC(void*) PyModule_GetState(PyObject*);
28
29typedef struct PyModuleDef_Base {
30 PyObject_HEAD
31 PyObject* (*m_init)(void);
32 Py_ssize_t m_index;
33 PyObject* m_copy;
34} PyModuleDef_Base;
35
David Malcolm82e73cb2010-11-17 21:20:18 +000036#define PyModuleDef_HEAD_INIT { \
37 PyObject_HEAD_INIT(NULL) \
38 NULL, /* m_init */ \
39 0, /* m_index */ \
40 NULL, /* m_copy */ \
41 }
Martin v. Löwis1a214512008-06-11 05:26:20 +000042
43typedef struct PyModuleDef{
44 PyModuleDef_Base m_base;
45 const char* m_name;
46 const char* m_doc;
47 Py_ssize_t m_size;
48 PyMethodDef *m_methods;
49 inquiry m_reload;
50 traverseproc m_traverse;
51 inquiry m_clear;
52 freefunc m_free;
53}PyModuleDef;
54
Guido van Rossuma3309961993-07-28 09:05:47 +000055
56#ifdef __cplusplus
57}
58#endif
59#endif /* !Py_MODULEOBJECT_H */