blob: 2b4819f184f33241f4e990d048f11bec244a813f [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_METHODOBJECT_H
2#define Py_METHODOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038/* Method object interface */
39
Guido van Rossum051ab121995-02-27 10:17:52 +000040extern DL_IMPORT(PyTypeObject) PyCFunction_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041
Guido van Rossumcaa63801995-01-12 11:45:45 +000042#define PyCFunction_Check(op) ((op)->ob_type == &PyCFunction_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043
Guido van Rossumcaa63801995-01-12 11:45:45 +000044typedef PyObject *(*PyCFunction) Py_FPROTO((PyObject *, PyObject *));
Guido van Rossumbebdc371995-07-26 17:58:29 +000045typedef PyObject *(*PyCFunctionWithKeywords)
46 Py_FPROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047
Guido van Rossumcaa63801995-01-12 11:45:45 +000048extern PyCFunction PyCFunction_GetFunction Py_PROTO((PyObject *));
49extern PyObject *PyCFunction_GetSelf Py_PROTO((PyObject *));
Guido van Rossumbebdc371995-07-26 17:58:29 +000050extern int PyCFunction_GetFlags Py_PROTO((PyObject *));
Guido van Rossum3f5da241990-12-20 15:06:42 +000051
Guido van Rossum92233511998-07-10 15:21:55 +000052/* Macros for direct access to these values. Type checks are *not*
53 done, so use with care. */
54#define PyCFunction_GET_FUNCTION(func) \
55 (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
56#define PyCFunction_GET_SELF(func) \
57 (((PyCFunctionObject *)func) -> m_self)
58#define PyCFunction_GET_FLAGS(func) \
59 (((PyCFunctionObject *)func) -> m_ml -> ml_flags)
60
Guido van Rossumcaa63801995-01-12 11:45:45 +000061struct PyMethodDef {
62 char *ml_name;
63 PyCFunction ml_meth;
64 int ml_flags;
65 char *ml_doc;
Guido van Rossum3f5da241990-12-20 15:06:42 +000066};
Guido van Rossumcaa63801995-01-12 11:45:45 +000067typedef struct PyMethodDef PyMethodDef;
Guido van Rossum3f5da241990-12-20 15:06:42 +000068
Guido van Rossumcaa63801995-01-12 11:45:45 +000069extern PyObject *Py_FindMethod
70 Py_PROTO((PyMethodDef[], PyObject *, char *));
Guido van Rossum9dc8d0e1995-01-07 10:32:29 +000071
Guido van Rossumcaa63801995-01-12 11:45:45 +000072extern PyObject *PyCFunction_New
73 Py_PROTO((PyMethodDef *, PyObject *));
Guido van Rossuma3309961993-07-28 09:05:47 +000074
Guido van Rossum5799b521995-01-04 19:06:22 +000075/* Flag passed to newmethodobject */
76#define METH_VARARGS 0x0001
Guido van Rossumbebdc371995-07-26 17:58:29 +000077#define METH_KEYWORDS 0x0002
Guido van Rossum5799b521995-01-04 19:06:22 +000078
Guido van Rossum69785031995-01-26 22:58:48 +000079typedef struct PyMethodChain {
80 PyMethodDef *methods; /* Methods of this type */
81 struct PyMethodChain *link; /* NULL or base type */
82} PyMethodChain;
83
84extern PyObject *Py_FindMethodInChain
85 Py_PROTO((PyMethodChain *, PyObject *, char *));
86
Guido van Rossum92233511998-07-10 15:21:55 +000087typedef struct {
88 PyObject_HEAD
89 PyMethodDef *m_ml;
90 PyObject *m_self;
91} PyCFunctionObject;
92
Guido van Rossuma3309961993-07-28 09:05:47 +000093#ifdef __cplusplus
94}
95#endif
96#endif /* !Py_METHODOBJECT_H */