blob: ace58d31badc94d105e78c97bc01f138f7266643 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001/***********************************************************
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00002Copyright (c) 2000, BeOpen.com.
3Copyright (c) 1995-2000, Corporation for National Research Initiatives.
4Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
5All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +00006
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00007See the file "Misc/COPYRIGHT" for information on usage and
8redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +00009******************************************************************/
10
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011/* Method object interface */
12
Fred Drakeea9cb5a2000-07-09 00:20:36 +000013#ifndef Py_METHODOBJECT_H
14#define Py_METHODOBJECT_H
15#ifdef __cplusplus
16extern "C" {
17#endif
18
Guido van Rossum051ab121995-02-27 10:17:52 +000019extern DL_IMPORT(PyTypeObject) PyCFunction_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossumcaa63801995-01-12 11:45:45 +000021#define PyCFunction_Check(op) ((op)->ob_type == &PyCFunction_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000022
Guido van Rossumcaa63801995-01-12 11:45:45 +000023typedef PyObject *(*PyCFunction) Py_FPROTO((PyObject *, PyObject *));
Guido van Rossumbebdc371995-07-26 17:58:29 +000024typedef PyObject *(*PyCFunctionWithKeywords)
25 Py_FPROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000026
Fred Drakeea9cb5a2000-07-09 00:20:36 +000027extern DL_IMPORT(PyCFunction) PyCFunction_GetFunction(PyObject *);
28extern DL_IMPORT(PyObject *) PyCFunction_GetSelf(PyObject *);
29extern DL_IMPORT(int) PyCFunction_GetFlags(PyObject *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000030
Guido van Rossum92233511998-07-10 15:21:55 +000031/* Macros for direct access to these values. Type checks are *not*
32 done, so use with care. */
33#define PyCFunction_GET_FUNCTION(func) \
34 (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
35#define PyCFunction_GET_SELF(func) \
36 (((PyCFunctionObject *)func) -> m_self)
37#define PyCFunction_GET_FLAGS(func) \
38 (((PyCFunctionObject *)func) -> m_ml -> ml_flags)
39
Guido van Rossumcaa63801995-01-12 11:45:45 +000040struct PyMethodDef {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000041 char *ml_name;
42 PyCFunction ml_meth;
43 int ml_flags;
44 char *ml_doc;
Guido van Rossum3f5da241990-12-20 15:06:42 +000045};
Guido van Rossumcaa63801995-01-12 11:45:45 +000046typedef struct PyMethodDef PyMethodDef;
Guido van Rossum3f5da241990-12-20 15:06:42 +000047
Fred Drakeea9cb5a2000-07-09 00:20:36 +000048extern DL_IMPORT(PyObject *) Py_FindMethod(PyMethodDef[], PyObject *, char *);
Guido van Rossum9dc8d0e1995-01-07 10:32:29 +000049
Fred Drakeea9cb5a2000-07-09 00:20:36 +000050extern DL_IMPORT(PyObject *) PyCFunction_New(PyMethodDef *, PyObject *);
Guido van Rossuma3309961993-07-28 09:05:47 +000051
Guido van Rossum5799b521995-01-04 19:06:22 +000052/* Flag passed to newmethodobject */
53#define METH_VARARGS 0x0001
Guido van Rossumbebdc371995-07-26 17:58:29 +000054#define METH_KEYWORDS 0x0002
Guido van Rossum5799b521995-01-04 19:06:22 +000055
Guido van Rossum69785031995-01-26 22:58:48 +000056typedef struct PyMethodChain {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000057 PyMethodDef *methods; /* Methods of this type */
58 struct PyMethodChain *link; /* NULL or base type */
Guido van Rossum69785031995-01-26 22:58:48 +000059} PyMethodChain;
60
Fred Drakeea9cb5a2000-07-09 00:20:36 +000061extern DL_IMPORT(PyObject *) Py_FindMethodInChain(PyMethodChain *, PyObject *,
62 char *);
Guido van Rossum69785031995-01-26 22:58:48 +000063
Guido van Rossum92233511998-07-10 15:21:55 +000064typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000065 PyObject_HEAD
66 PyMethodDef *m_ml;
67 PyObject *m_self;
Guido van Rossum92233511998-07-10 15:21:55 +000068} PyCFunctionObject;
69
Guido van Rossuma3309961993-07-28 09:05:47 +000070#ifdef __cplusplus
71}
72#endif
73#endif /* !Py_METHODOBJECT_H */