[pyke] / pyke.h

/* -*-c-*-
 *
 * Pyke: the Python Kit for Extensions
 *
 * (c) 2019 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of Pyke: the Python Kit for Extensions.
 *
 * Pyke is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * Pyke is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Pyke.  If not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef PYKE_H
#define PYKE_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#define PY_SSIZE_T_CLEAN

#include <Python.h>
#include <structmember.h>

/*----- Other preliminaries -----------------------------------------------*/

#define NOTHING
#define COMMA ,

/*----- Symbol visibility -------------------------------------------------*
 *
 * This library is very messy regarding symbol namespace.  Keep this mess
 * within our shared-object.
 */

#define GOBBLE_SEMI extern int notexist
#if defined(__GNUC__) && defined(__ELF__)
#  define PRIVATE_SYMBOLS _Pragma("GCC visibility push(hidden)") GOBBLE_SEMI
#  define PUBLIC_SYMBOLS _Pragma("GCC visibility pop") GOBBLE_SEMI
#  define EXPORT __attribute__((__visibility__("default")))
#else
#  define PRIVATE_SYMBOLS GOBBLE_SEMI
#  define PUBLIC_SYMBOLS GOBBLE_SEMI
#  define EXPORT
#endif

PRIVATE_SYMBOLS;

/*----- Utilities for returning values and exceptions ---------------------*/

/* Returning values. */
#define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
#define RETURN_NONE RETURN_OBJ(Py_None)
#define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
#define RETURN_TRUE RETURN_OBJ(Py_True)
#define RETURN_FALSE RETURN_OBJ(Py_False)
#define RETURN_ME RETURN_OBJ(me)

/* Returning exceptions.  (Note that `KeyError' is `MAPERR' here, because
 * Catacomb has its own kind of `KeyError'.)
 */
#define EXCERR(exc, str) do {						\
  PyErr_SetString(exc, str);						\
  goto end;								\
} while (0)
#define VALERR(str) EXCERR(PyExc_ValueError, str)
#define OVFERR(str) EXCERR(PyExc_OverflowError, str)
#define TYERR(str) EXCERR(PyExc_TypeError, str)
#define IXERR(str) EXCERR(PyExc_IndexError, str)
#define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
#define SYSERR(str) EXCERR(PyExc_SystemError, str)
#define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
#define MAPERR(idx) do {						\
  PyErr_SetObject(PyExc_KeyError, idx);					\
  goto end;								\
} while (0)
#define OSERR(name) do {						\
  PyErr_SetFromErrnoWithFilename(PyExc_OSError, name);			\
  goto end;								\
} while (0)

/* Saving and restoring exceptions. */
struct excinfo { PyObject *ty, *val, *tb; };
#define EXCINFO_INIT { 0, 0, 0 }
#define INIT_EXCINFO(exc) do {						\
  struct excinfo *_exc = (exc); _exc->ty = _exc->val = _exc->tb = 0;	\
} while (0)
#define RELEASE_EXCINFO(exc) do {					\
  struct excinfo *_exc = (exc);						\
  Py_XDECREF(_exc->ty);	 _exc->ty  = 0;					\
  Py_XDECREF(_exc->val); _exc->val = 0;					\
  Py_XDECREF(_exc->tb);	 _exc->tb  = 0;					\
} while (0)
#define STASH_EXCINFO(exc) do {						\
  struct excinfo *_exc = (exc);						\
  PyErr_Fetch(&_exc->ty, &_exc->val, &_exc->tb);			\
  PyErr_NormalizeException(&_exc->ty, &_exc->val, &_exc->tb);		\
} while (0)
#define RESTORE_EXCINFO(exc) do {					\
  struct excinfo *_exc = (exc);						\
  PyErr_Restore(_exc->ty, _exc->val, _exc->tb);				\
  _exc->ty = _exc->val = _exc->tb = 0;					\
} while (0)
extern void report_lost_exception(struct excinfo *, const char *, ...);
extern void report_lost_exception_v(struct excinfo *, const char *, va_list);
extern void stash_exception(struct excinfo *, const char *, ...);
extern void restore_exception(struct excinfo *, const char *, ...);

/*----- Conversions -------------------------------------------------------*/

/* Define an input conversion (`O&') function: check that the object has
 * Python type TY, and extract a C pointer to CTY by calling EXT on the
 * object (which may well be a macro).
 */
#define CONVFUNC(ty, cty, ext)						\
  int conv##ty(PyObject *o, void *p)					\
  {									\
    if (!PyObject_TypeCheck(o, ty##_pytype))				\
      TYERR("wanted a " #ty);						\
    *(cty *)p = ext(o);							\
    return (1);								\
  end:									\
    return (0);								\
  }

/* Input conversion functions for standard kinds of objects, with overflow
 * checking where applicable.
 */
extern int convulong(PyObject *, void *); /* unsigned long */
extern int convuint(PyObject *, void *); /* unsigned int */
extern int convszt(PyObject *, void *);	/* size_t */
extern int convbool(PyObject *, void *); /* bool */

/* Output conversions. */
extern PyObject *getbool(int);		/* bool */
extern PyObject *getulong(unsigned long); /* any kind of unsigned integer */

/*----- Miscellaneous utilities -------------------------------------------*/

#define FREEOBJ(obj)							\
  (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
  /* Actually free OBJ, e.g., in a deallocation function. */

extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
  /* A `tp_new' function which refuses to make the object. */

#ifndef CONVERT_CAREFULLY
#  define CONVERT_CAREFULLY(newty, expty, obj)				\
     (!sizeof(*(expty *)0 = (obj)) + (/*unconst*/ newty)(obj))
  /* Convert OBJ to the type NEWTY, having previously checked that it is
   * convertible to the expected type EXPTY.
   *
   * Because of the way we set up types, we can make many kinds of tables be
   * `const' which can't usually be so (because Python will want to fiddle
   * with their reference counts); and, besides, Python's internals are
   * generally quite bad at being `const'-correct about tables.  One frequent
   * application of this macro, then, is in removing `const' from a type
   * without sacrificing all type safety.  The other common use is in
   * checking that method function types match up with the signatures
   * expected in their method definitions.
   */
#endif

#define KWLIST CONVERT_CAREFULLY(char **, const char *const *, kwlist)
  /* Strip `const' qualifiers from the keyword list `kwlist'.  Useful when
   * calling `PyArg_ParseTupleAndKeywords', which isn't `const'-correct.
   */

/*----- Type definitions --------------------------------------------------*
 *
 * Pyke types are defined in a rather unusual way.
 *
 * The main code defines a `type skeleton' of type `PyTypeObject',
 * conventionally named `TY_pytype_skel'.  Unlike typical Python type
 * definitions in extensions, this can (and should) be read-only.  Also,
 * there's no point in setting the `tp_base' pointer here, because the actual
 * runtime base type object won't, in general, be known at compile time.
 * Instead, the type skeletons are converted into Python `heap types' by the
 * `INITTYPE' macro.  The main difference is that Python code can add
 * attributes to heap types, and we make extensive use of this ability.
 */

extern void *newtype(PyTypeObject */*meta*/,
		     const PyTypeObject */*skel*/, const char */*name*/);
  /* Make and return a new Python type object, of type META (typically
   * `PyType_Type', but may be a subclass), filled in from the skeleton SKEL
   * (null to inherit everything), and named NAME.  The caller can mess with
   * the type object further at this time: call `typeready' when it's set up
   * properly.
   */

extern void typeready(PyTypeObject *);
  /* The type object is now ready to be used. */

extern PyTypeObject *inittype(PyTypeObject */*skel*/,
			      PyTypeObject */*meta*/);
  /* All-in-one function to construct a working type from a type skeleton
   * SKEL, with metaclass META.  The caller is expected to have filled in the
   * direct superclass in SKEL->tp_base.
   */

/* Alias for built-in types, to fit in with Pyke naming conventions. */
#define root_pytype 0
#define type_pytype &PyType_Type

#define INITTYPE_META(ty, base, meta) do {				\
  ty##_pytype_skel.tp_base = base##_pytype;				\
  ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype);		\
} while (0)
#define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
  /* Macros to initialize a type from its skeleton. */

/* Macros for filling in `PyMethodDef' tables, ensuring that functions have
 * the expected signatures.
 */
#define STD_METHOD(decor, func, doc)					\
  { #func, decor(func), METH_VARARGS, doc },
#define KEYWORD_METHOD(decor, func, doc)				\
  { #func,								\
    CONVERT_CAREFULLY(PyCFunction, PyCFunctionWithKeywords, decor(func)), \
    METH_VARARGS | METH_KEYWORDS,					\
    doc },

/* Convenience wrappers for filling in `PyMethodDef' tables, following
 * Pyke naming convention.  Define `METHNAME' locally as
 *
 *	#define METHNAME(name) foometh_##func
 *
 * around the method table.
 */
#define METH(func, doc) STD_METHOD(METHNAME, func, doc)
#define KWMETH(func, doc) KEYWORD_METHOD(METHNAME, func, doc)

/* Convenience wrappers for filling in `PyGetSetDef' tables, following Pyke
 * naming convention.  Define `GETSETNAME' locally as
 *
 *	#define GETSETNAME(op, name) foo##op##_##func
 *
 * around the get/set table.
 */
#define GET(func, doc)							\
  { #func, GETSETNAME(get, func), 0, doc },
#define GETSET(func, doc)						\
  { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },

/* Convenience wrapper for filling in `PyMemberDef' tables.  Define
 * `MEMBERSTRUCT' locally as
 *
 *	#define MEMBERSTRUCT foo_pyobj
 *
 * around the member table.
 */
#define MEMBER(name, ty, f, doc)					\
  { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },

/*----- Populating modules ------------------------------------------------*/

extern PyObject *modname;
  /* The overall module name.  Set this with `PyString_FromString'. */

extern PyObject *home_module;
  /* The overall module object. */

extern PyObject *mkexc(PyObject */*mod*/, PyObject */*base*/,
		       const char */*name*/, PyMethodDef */*methods*/);
  /* Make and return an exception class called NAME, which will end up in
   * module MOD (though it is not added at this time).  The new class is a
   * subclass of BASE.  Attach the METHODS to it.
   */

#define INSERT(name, ob) do {						\
  PyObject *_o = (PyObject *)(ob);					\
  Py_INCREF(_o);							\
  PyModule_AddObject(mod, name, _o);					\
} while (0)
  /* Insert a Python object OB into the module `mod' under the given NAME. */

/* Numeric constants. */
struct nameval { const char *name; unsigned f; unsigned long value; };
#define CF_SIGNED 1u
extern void setconstants(PyObject *, const struct nameval *);

#define INSEXC(name, var, base, meth)					\
  INSERT(name, var = mkexc(mod, base, name, meth))
  /* Insert an exception class into the module `mod'; other arguments are as
   * for `mkexc'.
   */

/*----- Submodules --------------------------------------------------------*
 *
 * It's useful to split the Python module up into multiple source files, and
 * have each one contribute its definitions into the main module.
 *
 * Define a list-macro `MODULES' in the master header file naming the
 * submodules to be processed, and run
 *
 *	MODULES(DECLARE_MODINIT)
 *
 * to declare the interface functions.
 *
 * Each submodule FOO defines two functions: `FOO_pyinit' initializes types
 * (see `INITTYPE' above) and accumulates methods (`addmethods' below), while
 * `FOO_pyinsert' populates the module with additional definitions
 * (especially types, though also constants).
 *
 * The top-level module initialization should call `INIT_MODULES' before
 * creating the Python module, and `INSERT_MODULES' afterwards to make
 * everything work.
 */

extern void addmethods(const PyMethodDef *);
extern PyMethodDef *donemethods(void);
  /* Accumulate method-table fragments, and return the combined table of all
   * of the fragments.
   */

#define DECLARE_MODINIT(m)						\
  extern void m##_pyinit(void);						\
  extern void m##_pyinsert(PyObject *);
  /* Declare submodule interface functions. */

#define DOMODINIT(m) m##_pyinit();
#define DOMODINSERT(m) m##_pyinsert(mod);
#define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
#define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
  /* Top-level dispatch to the various submodules. */

/*----- Generic mapping support -------------------------------------------*/

/* Mapping methods. */
#define GMAP_METMNAME(func) gmapmeth_##func
#define GMAP_METH(func, doc) STD_METHOD(GMAP_METMNAME, func, doc)
#define GMAP_KWMETH(func, doc) KEYWORD_METHOD(GMAP_METMNAME, func, doc)
#define GMAP_METHDECL(func, doc)					\
  extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
#define GMAP_KWMETHDECL(func, doc)					\
  extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);

#define GMAP_DOROMETHODS(METH, KWMETH)					\
  METH	(has_key,	"D.has_key(KEY) -> BOOL")			\
  METH	(keys,		"D.keys() -> LIST")				\
  METH	(values,	"D.values() -> LIST")				\
  METH	(items,		"D.items() -> LIST")				\
  METH	(iterkeys,	"D.iterkeys() -> ITER")				\
  METH	(itervalues,	"D.itervalues() -> ITER")			\
  METH	(iteritems,	"D.iteritems() -> ITER")			\
  KWMETH(get,		"D.get(KEY, [default = None]) -> VALUE")

#define GMAP_DOMETHODS(METH, KWMETH)					\
  GMAP_DOROMETHODS(METH, KWMETH)					\
  METH	(clear,		"D.clear()")					\
  KWMETH(setdefault,	"D.setdefault(K, [default = None]) -> VALUE")	\
  KWMETH(pop,		"D.pop(KEY, [default = <error>]) -> VALUE")	\
  METH	(popitem,	"D.popitem() -> (KEY, VALUE)")			\
  METH	(update,	"D.update(MAP)")

GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
#define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
#define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)

/* Mapping protocol implementation. */
extern Py_ssize_t gmap_pysize(PyObject *); /* for `mp_length' */
extern PySequenceMethods gmap_pysequence; /* for `tp_as_sequence' */
extern PyMethodDef gmap_pymethods[]; /* all the standard methods */

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif
Commit	Line	Data
c1756f78 MW	1	/* --c--
	2	*
	3	* Pyke: the Python Kit for Extensions
	4	*
	5	* (c) 2019 Straylight/Edgeware
	6	*/
	7
	8	/----- Licensing notice --------------------------------------------------
	9	*
	10	* This file is part of Pyke: the Python Kit for Extensions.
	11	*
	12	* Pyke is free software: you can redistribute it and/or modify it under
	13	* the terms of the GNU General Public License as published by the Free
	14	* Software Foundation; either version 2 of the License, or (at your
	15	* option) any later version.
	16	*
	17	* Pyke is distributed in the hope that it will be useful, but WITHOUT
	18	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	19	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	20	* for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with Pyke. If not, write to the Free Software Foundation, Inc.,
	24	* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	25	*/
	26
	27	#ifndef PYKE_H
	28	#define PYKE_H
	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
	34	/----- Header files ------------------------------------------------------/
	35
	36	#define PY_SSIZE_T_CLEAN
	37
	38	#include <Python.h>
	39	#include <structmember.h>
	40
	41	/----- Other preliminaries -----------------------------------------------/
	42
	43	#define NOTHING
	44	#define COMMA ,
	45
	46	/----- Symbol visibility -------------------------------------------------
	47	*
	48	* This library is very messy regarding symbol namespace. Keep this mess
	49	* within our shared-object.
	50	*/
	51
	52	#define GOBBLE_SEMI extern int notexist
	53	#if defined(__GNUC__) && defined(__ELF__)
	54	# define PRIVATE_SYMBOLS _Pragma("GCC visibility push(hidden)") GOBBLE_SEMI
	55	# define PUBLIC_SYMBOLS _Pragma("GCC visibility pop") GOBBLE_SEMI
	56	# define EXPORT __attribute__((__visibility__("default")))
	57	#else
	58	# define PRIVATE_SYMBOLS GOBBLE_SEMI
	59	# define PUBLIC_SYMBOLS GOBBLE_SEMI
	60	# define EXPORT
	61	#endif
	62
	63	PRIVATE_SYMBOLS;
	64
65	/----- Utilities for returning values and exceptions ---------------------/
66
67	/* Returning values. */
68	#define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
69	#define RETURN_NONE RETURN_OBJ(Py_None)
70	#define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
71	#define RETURN_TRUE RETURN_OBJ(Py_True)
72	#define RETURN_FALSE RETURN_OBJ(Py_False)
73	#define RETURN_ME RETURN_OBJ(me)
74
75	/* Returning exceptions. (Note that `KeyError' is `MAPERR' here, because
76	* Catacomb has its own kind of `KeyError'.)
77	*/
78	#define EXCERR(exc, str) do { \
79	PyErr_SetString(exc, str); \
80	goto end; \
81	} while (0)
82	#define VALERR(str) EXCERR(PyExc_ValueError, str)
83	#define OVFERR(str) EXCERR(PyExc_OverflowError, str)
84	#define TYERR(str) EXCERR(PyExc_TypeError, str)
85	#define IXERR(str) EXCERR(PyExc_IndexError, str)
86	#define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
87	#define SYSERR(str) EXCERR(PyExc_SystemError, str)
88	#define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
fcfa1c86	89	#define MAPERR(idx) do { \
c1756f78 MW	90	PyErr_SetObject(PyExc_KeyError, idx); \
	91	goto end; \
	92	} while (0)
	93	#define OSERR(name) do { \
	94	PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
	95	goto end; \
	96	} while (0)
	97
	98	/* Saving and restoring exceptions. */
	99	struct excinfo { PyObject ty, val, *tb; };
	100	#define EXCINFO_INIT { 0, 0, 0 }
	101	#define INIT_EXCINFO(exc) do { \
	102	struct excinfo *_exc = (exc); _exc->ty = _exc->val = _exc->tb = 0; \
	103	} while (0)
	104	#define RELEASE_EXCINFO(exc) do { \
	105	struct excinfo *_exc = (exc); \
	106	Py_XDECREF(_exc->ty); _exc->ty = 0; \
	107	Py_XDECREF(_exc->val); _exc->val = 0; \
	108	Py_XDECREF(_exc->tb); _exc->tb = 0; \
	109	} while (0)
	110	#define STASH_EXCINFO(exc) do { \
	111	struct excinfo *_exc = (exc); \
	112	PyErr_Fetch(&_exc->ty, &_exc->val, &_exc->tb); \
	113	PyErr_NormalizeException(&_exc->ty, &_exc->val, &_exc->tb); \
	114	} while (0)
	115	#define RESTORE_EXCINFO(exc) do { \
	116	struct excinfo *_exc = (exc); \
	117	PyErr_Restore(_exc->ty, _exc->val, _exc->tb); \
	118	_exc->ty = _exc->val = _exc->tb = 0; \
	119	} while (0)
	120	extern void report_lost_exception(struct excinfo , const char , ...);
	121	extern void report_lost_exception_v(struct excinfo , const char , va_list);
	122	extern void stash_exception(struct excinfo , const char , ...);
	123	extern void restore_exception(struct excinfo , const char , ...);
	124
	125	/----- Conversions -------------------------------------------------------/
	126
	127	/* Define an input conversion (`O&') function: check that the object has
	128	* Python type TY, and extract a C pointer to CTY by calling EXT on the
	129	* object (which may well be a macro).
	130	*/
	131	#define CONVFUNC(ty, cty, ext) \
	132	int conv##ty(PyObject o, void p) \
	133	{ \
	134	if (!PyObject_TypeCheck(o, ty##_pytype)) \
	135	TYERR("wanted a " #ty); \
	136	(cty )p = ext(o); \
	137	return (1); \
	138	end: \
	139	return (0); \
	140	}
	141
	142	/* Input conversion functions for standard kinds of objects, with overflow
	143	* checking where applicable.
	144	*/
	145	extern int convulong(PyObject , void ); /* unsigned long */
	146	extern int convuint(PyObject , void ); /* unsigned int */
	147	extern int convszt(PyObject , void ); /* size_t */
	148	extern int convbool(PyObject , void ); /* bool */
	149
	150	/* Output conversions. */
	151	extern PyObject getbool(int); / bool */
	152	extern PyObject getulong(unsigned long); / any kind of unsigned integer */
	153
154	/----- Miscellaneous utilities -------------------------------------------/
155
156	#define FREEOBJ(obj) \
157	(((PyObject )(obj))->ob_type->tp_free((PyObject )(obj)))
158	/* Actually free OBJ, e.g., in a deallocation function. */
159
160	extern PyObject abstract_pynew(PyTypeObject , PyObject , PyObject );
161	/* A `tp_new' function which refuses to make the object. */
162
dce47d50 MW	163	#ifndef CONVERT_CAREFULLY
	164	# define CONVERT_CAREFULLY(newty, expty, obj) \
	165	(!sizeof((expty )0 = (obj)) + (/unconst/ newty)(obj))
	166	/* Convert OBJ to the type NEWTY, having previously checked that it is
	167	* convertible to the expected type EXPTY.
	168	*
	169	* Because of the way we set up types, we can make many kinds of tables be
	170	* `const' which can't usually be so (because Python will want to fiddle
	171	* with their reference counts); and, besides, Python's internals are
	172	* generally quite bad at being `const'-correct about tables. One frequent
	173	* application of this macro, then, is in removing `const' from a type
	174	* without sacrificing all type safety. The other common use is in
	175	* checking that method function types match up with the signatures
	176	* expected in their method definitions.
	177	*/
	178	#endif
	179
	180	#define KWLIST CONVERT_CAREFULLY(char *, const char const *, kwlist)
c1756f78 MW	181	/* Strip `const' qualifiers from the keyword list `kwlist'. Useful when
	182	* calling `PyArg_ParseTupleAndKeywords', which isn't `const'-correct.
	183	*/
	184
	185	/----- Type definitions --------------------------------------------------
	186	*
	187	* Pyke types are defined in a rather unusual way.
	188	*
	189	* The main code defines a `type skeleton' of type `PyTypeObject',
	190	* conventionally named `TY_pytype_skel'. Unlike typical Python type
	191	* definitions in extensions, this can (and should) be read-only. Also,
	192	* there's no point in setting the `tp_base' pointer here, because the actual
	193	* runtime base type object won't, in general, be known at compile time.
	194	* Instead, the type skeletons are converted into Python `heap types' by the
	195	* `INITTYPE' macro. The main difference is that Python code can add
	196	* attributes to heap types, and we make extensive use of this ability.
	197	*/
	198
	199	extern void newtype(PyTypeObject /meta/,
	200	const PyTypeObject /skel/, const char /name/);
	201	/* Make and return a new Python type object, of type META (typically
	202	* `PyType_Type', but may be a subclass), filled in from the skeleton SKEL
	203	* (null to inherit everything), and named NAME. The caller can mess with
	204	* the type object further at this time: call `typeready' when it's set up
	205	* properly.
	206	*/
	207
	208	extern void typeready(PyTypeObject *);
	209	/* The type object is now ready to be used. */
	210
	211	extern PyTypeObject inittype(PyTypeObject /skel/,
	212	PyTypeObject /meta*/);
	213	/* All-in-one function to construct a working type from a type skeleton
	214	* SKEL, with metaclass META. The caller is expected to have filled in the
	215	* direct superclass in SKEL->tp_base.
	216	*/
	217
	218	/* Alias for built-in types, to fit in with Pyke naming conventions. */
	219	#define root_pytype 0
	220	#define type_pytype &PyType_Type
	221
	222	#define INITTYPE_META(ty, base, meta) do { \
	223	ty##_pytype_skel.tp_base = base##_pytype; \
	224	ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
	225	} while (0)
	226	#define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
	227	/* Macros to initialize a type from its skeleton. */
	228
dce47d50 MW	229	/* Macros for filling in `PyMethodDef' tables, ensuring that functions have
	230	* the expected signatures.
	231	*/
	232	#define STD_METHOD(decor, func, doc) \
	233	{ #func, decor(func), METH_VARARGS, doc },
	234	#define KEYWORD_METHOD(decor, func, doc) \
	235	{ #func, \
	236	CONVERT_CAREFULLY(PyCFunction, PyCFunctionWithKeywords, decor(func)), \
	237	METH_VARARGS \| METH_KEYWORDS, \
	238	doc },
	239
c1756f78 MW	240	/* Convenience wrappers for filling in `PyMethodDef' tables, following
	241	* Pyke naming convention. Define `METHNAME' locally as
	242	*
	243	* #define METHNAME(name) foometh_##func
	244	*
	245	* around the method table.
	246	*/
dce47d50 MW	247	#define METH(func, doc) STD_METHOD(METHNAME, func, doc)
dce47d50 MW	248	#define KWMETH(func, doc) KEYWORD_METHOD(METHNAME, func, doc)
c1756f78 MW	249
	250	/* Convenience wrappers for filling in `PyGetSetDef' tables, following Pyke
	251	* naming convention. Define `GETSETNAME' locally as
	252	*
	253	* #define GETSETNAME(op, name) foo##op##_##func
	254	*
	255	* around the get/set table.
	256	*/
	257	#define GET(func, doc) \
	258	{ #func, GETSETNAME(get, func), 0, doc },
	259	#define GETSET(func, doc) \
	260	{ #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
	261
	262	/* Convenience wrapper for filling in `PyMemberDef' tables. Define
	263	* `MEMBERSTRUCT' locally as
	264	*
	265	* #define MEMBERSTRUCT foo_pyobj
	266	*
	267	* around the member table.
	268	*/
	269	#define MEMBER(name, ty, f, doc) \
	270	{ #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
	271
	272	/----- Populating modules ------------------------------------------------/
	273
	274	extern PyObject *modname;
	275	/* The overall module name. Set this with `PyString_FromString'. */
	276
	277	extern PyObject *home_module;
	278	/* The overall module object. */
	279
	280	extern PyObject mkexc(PyObject /mod/, PyObject /base*/,
	281	const char /name/, PyMethodDef /methods/);
	282	/* Make and return an exception class called NAME, which will end up in
	283	* module MOD (though it is not added at this time). The new class is a
	284	* subclass of BASE. Attach the METHODS to it.
	285	*/
	286
	287	#define INSERT(name, ob) do { \
	288	PyObject _o = (PyObject )(ob); \
	289	Py_INCREF(_o); \
	290	PyModule_AddObject(mod, name, _o); \
	291	} while (0)
	292	/* Insert a Python object OB into the module `mod' under the given NAME. */
	293
	294	/* Numeric constants. */
	295	struct nameval { const char *name; unsigned f; unsigned long value; };
	296	#define CF_SIGNED 1u
	297	extern void setconstants(PyObject , const struct nameval );
	298
	299	#define INSEXC(name, var, base, meth) \
	300	INSERT(name, var = mkexc(mod, base, name, meth))
	301	/* Insert an exception class into the module `mod'; other arguments are as
	302	* for `mkexc'.
	303	*/
	304
	305	/----- Submodules --------------------------------------------------------
	306	*
	307	* It's useful to split the Python module up into multiple source files, and
	308	* have each one contribute its definitions into the main module.
	309	*
	310	* Define a list-macro `MODULES' in the master header file naming the
	311	* submodules to be processed, and run
	312	*
313	* MODULES(DECLARE_MODINIT)
314	*
315	* to declare the interface functions.
316	*
317	* Each submodule FOO defines two functions: `FOO_pyinit' initializes types
318	* (see `INITTYPE' above) and accumulates methods (`addmethods' below), while
319	* `FOO_pyinsert' populates the module with additional definitions
320	* (especially types, though also constants).
321	*
322	* The top-level module initialization should call `INIT_MODULES' before
323	* creating the Python module, and `INSERT_MODULES' afterwards to make
324	* everything work.
325	*/
326
327	extern void addmethods(const PyMethodDef *);
328	extern PyMethodDef *donemethods(void);
329	/* Accumulate method-table fragments, and return the combined table of all
330	* of the fragments.
331	*/
332
333	#define DECLARE_MODINIT(m) \
334	extern void m##_pyinit(void); \
335	extern void m##_pyinsert(PyObject *);
336	/* Declare submodule interface functions. */
337
338	#define DOMODINIT(m) m##_pyinit();
339	#define DOMODINSERT(m) m##_pyinsert(mod);
340	#define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
341	#define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
342	/* Top-level dispatch to the various submodules. */
343
344	/----- Generic mapping support -------------------------------------------/
345
346	/* Mapping methods. */
dce47d50 MW	347	#define GMAP_METMNAME(func) gmapmeth_##func
	348	#define GMAP_METH(func, doc) STD_METHOD(GMAP_METMNAME, func, doc)
	349	#define GMAP_KWMETH(func, doc) KEYWORD_METHOD(GMAP_METMNAME, func, doc)
c1756f78 MW	350	#define GMAP_METHDECL(func, doc) \
	351	extern PyObject gmapmeth_##func(PyObject , PyObject *);
	352	#define GMAP_KWMETHDECL(func, doc) \
	353	extern PyObject gmapmeth_##func(PyObject , PyObject , PyObject );
	354
	355	#define GMAP_DOROMETHODS(METH, KWMETH) \
	356	METH (has_key, "D.has_key(KEY) -> BOOL") \
	357	METH (keys, "D.keys() -> LIST") \
	358	METH (values, "D.values() -> LIST") \
	359	METH (items, "D.items() -> LIST") \
	360	METH (iterkeys, "D.iterkeys() -> ITER") \
	361	METH (itervalues, "D.itervalues() -> ITER") \
	362	METH (iteritems, "D.iteritems() -> ITER") \
	363	KWMETH(get, "D.get(KEY, [default = None]) -> VALUE")
	364
	365	#define GMAP_DOMETHODS(METH, KWMETH) \
	366	GMAP_DOROMETHODS(METH, KWMETH) \
	367	METH (clear, "D.clear()") \
	368	KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
	369	KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
	370	METH (popitem, "D.popitem() -> (KEY, VALUE)") \
	371	METH (update, "D.update(MAP)")
	372
	373	GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
	374	#define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
	375	#define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
	376
	377	/* Mapping protocol implementation. */
	378	extern Py_ssize_t gmap_pysize(PyObject ); / for `mp_length' */
	379	extern PySequenceMethods gmap_pysequence; /* for `tp_as_sequence' */
	380	extern PyMethodDef gmap_pymethods[]; /* all the standard methods */
	381
	382	/----- That's all, folks -------------------------------------------------/
	383
	384	#ifdef __cplusplus
	385	}
	386	#endif
	387
	388	#endif