Added all documentation.
[python/dscho.git] / Include / modsupport.h
bloba90b279c536bff4e077fe4c2161f2cdbf3e4b852
1 #ifndef Py_MODSUPPORT_H
2 #define Py_MODSUPPORT_H
3 #ifdef __cplusplus
4 extern "C" {
5 #endif
7 /***********************************************************
8 Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9 The Netherlands.
11 All Rights Reserved
13 Permission to use, copy, modify, and distribute this software and its
14 documentation for any purpose and without fee is hereby granted,
15 provided that the above copyright notice appear in all copies and that
16 both that copyright notice and this permission notice appear in
17 supporting documentation, and that the names of Stichting Mathematisch
18 Centrum or CWI or Corporation for National Research Initiatives or
19 CNRI not be used in advertising or publicity pertaining to
20 distribution of the software without specific, written prior
21 permission.
23 While CWI is the initial source for this software, a modified version
24 is made available by the Corporation for National Research Initiatives
25 (CNRI) at the Internet address ftp://ftp.python.org.
27 STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28 REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29 MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30 CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32 PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34 PERFORMANCE OF THIS SOFTWARE.
36 ******************************************************************/
38 /* Module support interface */
40 #ifdef HAVE_STDARG_PROTOTYPES
42 #include <stdarg.h>
44 extern DL_IMPORT(int) PyArg_Parse Py_PROTO((PyObject *, char *, ...));
45 extern DL_IMPORT(int) PyArg_ParseTuple Py_PROTO((PyObject *, char *, ...));
46 extern DL_IMPORT(int) PyArg_ParseTupleAndKeywords Py_PROTO((PyObject *, PyObject *,
47 char *, char **, ...));
48 extern DL_IMPORT(PyObject *) Py_BuildValue Py_PROTO((char *, ...));
50 #else
52 #include <varargs.h>
54 /* Better to have no prototypes at all for varargs functions in this case */
55 extern DL_IMPORT(int) PyArg_Parse();
56 extern DL_IMPORT(int) PyArg_ParseTuple();
57 extern DL_IMPORT(PyObject *) Py_BuildValue();
59 #endif
61 extern DL_IMPORT(int) PyArg_VaParse Py_PROTO((PyObject *, char *, va_list));
62 extern DL_IMPORT(PyObject *) Py_VaBuildValue Py_PROTO((char *, va_list));
64 #define PYTHON_API_VERSION 1007
65 #define PYTHON_API_STRING "1007"
66 /* The API version is maintained (independently from the Python version)
67 so we can detect mismatches between the interpreter and dynamically
68 loaded modules. These are diagnosticised by an error message but
69 the module is still loaded (because the mismatch can only be tested
70 after loading the module). The error message is intended to
71 explain the core dump a few seconds later.
73 The symbol PYTHON_API_STRING defines the same value as a string
74 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
76 Please add a line or two to the top of this log for each API
77 version change:
79 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
81 3-Dec-1998 GvR 1008 Python 1.5.2b1
83 18-Jan-1997 GvR 1007 string interning and other speedups
85 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
87 30-Jul-1996 GvR Slice and ellipses syntax added
89 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
91 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
93 10-Jan-1995 GvR Renamed globals to new naming scheme
95 9-Jan-1995 GvR Initial version (incompatible with older API)
98 #ifdef MS_WINDOWS
99 /* Special defines for Windows versions used to live here. Things
100 have changed, and the "Version" is now in a global string variable.
101 Reason for this is that this for easier branding of a "custom DLL"
102 without actually needing a recompile. */
103 #endif /* MS_WINDOWS */
105 #ifdef Py_TRACE_REFS
106 /* When we are tracing reference counts, rename Py_InitModule4 so
107 modules compiled with incompatible settings will generate a
108 link-time error. */
109 #define Py_InitModule4 Py_InitModule4TraceRefs
110 #endif
112 extern DL_IMPORT(PyObject *) Py_InitModule4 Py_PROTO((char *, PyMethodDef *,
113 char *, PyObject *, int));
114 #define Py_InitModule(name, methods) \
115 Py_InitModule4(name, methods, (char *)NULL, (PyObject *)NULL, \
116 PYTHON_API_VERSION)
118 #define Py_InitModule3(name, methods, doc) \
119 Py_InitModule4(name, methods, doc, (PyObject *)NULL, \
120 PYTHON_API_VERSION)
122 extern DL_IMPORT(char *) _Py_PackageContext;
124 #ifdef __cplusplus
126 #endif
127 #endif /* !Py_MODSUPPORT_H */