3 * Miscellaneous utilities (not Catacomb-specific)
5 * (c) 2005 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the Python interface to Catacomb.
12 * Catacomb/Python is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * Catacomb/Python is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with Catacomb/Python; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 /*----- Header files ------------------------------------------------------*/
29 #include "catacomb-python.h"
31 /*----- External values ---------------------------------------------------*/
33 static PyObject *modname = 0;
35 /*----- Conversions -------------------------------------------------------*/
37 PyObject *getulong(unsigned long w)
40 return (PyInt_FromLong(w));
42 return (PyLong_FromUnsignedLong(w));
45 static PyObject *i32 = 0;
46 static int init_i32(void)
47 { if (!i32 && (i32 = PyInt_FromLong(32)) == 0) return (-1); return (0); }
49 PyObject *getk64(kludge64 u)
51 PyObject *i = 0, *j = 0, *t;
54 if (init_i32()) goto end;
55 if ((i = PyLong_FromUnsignedLong(HI64(u))) == 0) goto end;
56 if ((t = PyNumber_InPlaceLshift(i, i32)) == 0) goto end;
58 if ((j = PyLong_FromUnsignedLong(LO64(u))) == 0) goto end;
59 if ((t = PyNumber_InPlaceOr(i, j)) == 0) goto end;
61 if ((rc = PyNumber_Int(i)) == 0) goto end;
68 PyObject *getbool(int b)
74 PyObject *abstract_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
76 PyErr_SetString(PyExc_TypeError, "can't instantiate this class");
80 int convulong(PyObject *o, void *pp)
83 unsigned long *p = pp;
88 if (i < 0) VALERR("must be nonnegative");
91 if ((t = PyNumber_Long(o)) == 0) goto end;
92 *p = PyLong_AsUnsignedLong(t);
94 if (PyErr_Occurred()) goto end;
102 int convu##n(PyObject *o, void *pp) \
107 if (!convulong(o, &u)) goto end; \
108 if (u > MASK##n) VALERR("out of range"); \
116 int convuint(PyObject *o, void *pp)
121 if (!convulong(o, &u)) goto end;
122 if (u > UINT_MAX) VALERR("out of range");
129 int convk64(PyObject *o, void *pp)
135 if (init_i32()) goto end;
136 if ((i = PyNumber_Int(o)) == 0) goto end;
137 lo = PyInt_AsUnsignedLongMask(i);
138 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
140 hi = PyInt_AsUnsignedLongMask(i);
141 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
143 if (PyObject_IsTrue(i)) VALERR("out of range");
144 SET64(*(kludge64 *)pp, hi, lo);
151 int convmpw(PyObject *o, void *pp)
156 if (!convulong(o, &u)) goto end;
157 if (u > MPW_MAX) VALERR("out of range");
164 int convszt(PyObject *o, void *pp)
169 if (!convulong(o, &u)) goto end;
170 if (u > ~(size_t)0) VALERR("out of range");
177 int convbool(PyObject *o, void *pp)
179 *(int *)pp = PyObject_IsTrue(o);
183 /*----- Type messing ------------------------------------------------------*/
185 static const PyTypeObject emptytype = { 0 };
187 void *newtype(PyTypeObject *metaty,
188 const PyTypeObject *skel,
191 PyHeapTypeObject *ty =
192 (PyHeapTypeObject *)_PyObject_GC_Malloc(_PyObject_VAR_SIZE(metaty, 0));
193 if (!skel) skel = &emptytype;
194 memcpy(ty, skel, sizeof(*skel));
195 if (ty->ht_type.tp_base) Py_INCREF(ty->ht_type.tp_base);
196 #define COPY(blah) do { \
197 if (ty->ht_type.tp_as_##blah) { \
198 memcpy(&ty->as_##blah, \
199 ty->ht_type.tp_as_##blah, \
200 sizeof(ty->as_##blah)); \
201 ty->ht_type.tp_as_##blah = &ty->as_##blah; \
210 ty->ht_name = PyString_FromString(name);
211 else if (ty->ht_type.tp_name)
212 ty->ht_name = PyString_FromString(ty->ht_type.tp_name);
214 ty->ht_type.tp_name = PyString_AS_STRING(ty->ht_name);
215 DISCARD(PyObject_INIT(&ty->ht_type, metaty));
220 void typeready(PyTypeObject *ty)
223 PyDict_SetItemString(ty->tp_dict, "__module__", modname);
226 PyTypeObject *inittype(PyTypeObject *tyskel, PyTypeObject *meta)
228 PyTypeObject *ty = newtype(meta, tyskel, 0);
229 ty->tp_flags |= Py_TPFLAGS_HEAPTYPE;
234 /*----- Constants ---------------------------------------------------------*/
236 void setconstants(PyObject *mod, const struct nameval *c)
241 if (c->value > LONG_MAX)
242 x = PyLong_FromUnsignedLong(c->value);
244 x = PyInt_FromLong(c->value);
245 PyModule_AddObject(mod, (/*unconst*/ char *)c->name, x);
250 /*----- Building method tables --------------------------------------------*/
252 DA_DECL(method_v, PyMethodDef);
253 static method_v global_pymethods = DA_INIT;
254 void addmethods(const PyMethodDef *m)
258 for (n = 0; m[n].ml_name; n++);
259 DA_ENSURE(&global_pymethods, n);
260 memcpy(DA(&global_pymethods) + DA_LEN(&global_pymethods),
262 DA_EXTEND(&global_pymethods, n);
265 PyMethodDef *donemethods(void)
267 static const PyMethodDef mzero = { 0 };
268 DA_PUSH(&global_pymethods, mzero);
269 return (DA(&global_pymethods));
272 /*----- Exceptions --------------------------------------------------------*/
274 PyObject *mkexc(PyObject *mod, PyObject *base,
275 const char *name, PyMethodDef *mm)
277 PyObject *nameobj = 0;
283 if ((nameobj = PyString_FromFormat("%s.%s",
284 PyModule_GetName(mod),
286 (dict = PyDict_New()) == 0 ||
287 (exc = PyErr_NewException(PyString_AS_STRING(nameobj),
292 while (mm->ml_name) {
293 if ((func = PyCFunction_NewEx(mm, 0, mod)) == 0 ||
294 (meth = PyMethod_New(func, 0, exc)) == 0 ||
295 PyDict_SetItemString(dict, mm->ml_name, meth))
297 Py_DECREF(func); func = 0;
298 Py_DECREF(meth); meth = 0;
316 /*----- Generic dictionary methods ----------------------------------------*/
318 static PyTypeObject *itemiter_pytype, *valiter_pytype;
320 typedef struct iter_pyobj {
325 #define ITER_MAP(o) (((iter_pyobj *)(o))->map)
326 #define ITER_I(o) (((iter_pyobj *)(o))->i)
328 static void iter_pydealloc(PyObject *me)
329 { Py_DECREF(ITER_MAP(me)); Py_DECREF(ITER_I(me)); FREEOBJ(me); }
331 static PyObject *itemiter_pynext(PyObject *me)
333 PyObject *k = 0, *v = 0, *rc = 0;
335 if ((k = PyIter_Next(ITER_I(me))) != 0 &&
336 (v = PyObject_GetItem(ITER_MAP(me), k)) != 0)
337 rc = Py_BuildValue("(OO)", k, v);
338 Py_XDECREF(k); Py_XDECREF(v);
342 static PyTypeObject itemiter_pytype_skel = {
343 PyObject_HEAD_INIT(0) 0, /* Header */
344 "ItemIter", /* @tp_name@ */
345 sizeof(iter_pyobj), /* @tp_basicsize@ */
346 0, /* @tp_itemsize@ */
348 iter_pydealloc, /* @tp_dealloc@ */
350 0, /* @tp_getattr@ */
351 0, /* @tp_setattr@ */
352 0, /* @tp_compare@ */
354 0, /* @tp_as_number@ */
355 0, /* @tp_as_sequence@ */
356 0, /* @tp_as_mapping@ */
360 0, /* @tp_getattro@ */
361 0, /* @tp_setattro@ */
362 0, /* @tp_as_buffer@ */
363 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
367 "Iterates over the items of a mapping.",
369 0, /* @tp_traverse@ */
371 0, /* @tp_richcompare@ */
372 0, /* @tp_weaklistoffset@ */
373 PyObject_SelfIter, /* @tp_iter@ */
374 itemiter_pynext, /* @tp_iternext@ */
375 0, /* @tp_methods@ */
376 0, /* @tp_members@ */
380 0, /* @tp_descr_get@ */
381 0, /* @tp_descr_set@ */
382 0, /* @tp_dictoffset@ */
384 PyType_GenericAlloc, /* @tp_alloc@ */
385 abstract_pynew, /* @tp_new@ */
390 static PyObject *valiter_pynext(PyObject *me)
392 PyObject *k = 0, *rc = 0;
394 if ((k = PyIter_Next(ITER_I(me))) != 0)
395 rc = PyObject_GetItem(ITER_MAP(me), k);
400 static PyTypeObject valiter_pytype_skel = {
401 PyObject_HEAD_INIT(0) 0, /* Header */
402 "ValueIter", /* @tp_name@ */
403 sizeof(iter_pyobj), /* @tp_basicsize@ */
404 0, /* @tp_itemsize@ */
406 iter_pydealloc, /* @tp_dealloc@ */
408 0, /* @tp_getattr@ */
409 0, /* @tp_setattr@ */
410 0, /* @tp_compare@ */
412 0, /* @tp_as_number@ */
413 0, /* @tp_as_sequence@ */
414 0, /* @tp_as_mapping@ */
418 0, /* @tp_getattro@ */
419 0, /* @tp_setattro@ */
420 0, /* @tp_as_buffer@ */
421 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
425 "Iterates over the items of a mapping.",
427 0, /* @tp_traverse@ */
429 0, /* @tp_richcompare@ */
430 0, /* @tp_weaklistoffset@ */
431 PyObject_SelfIter, /* @tp_iter@ */
432 valiter_pynext, /* @tp_iternext@ */
433 0, /* @tp_methods@ */
434 0, /* @tp_members@ */
438 0, /* @tp_descr_get@ */
439 0, /* @tp_descr_set@ */
440 0, /* @tp_dictoffset@ */
442 PyType_GenericAlloc, /* @tp_alloc@ */
443 abstract_pynew, /* @tp_new@ */
448 PySequenceMethods gmap_pysequence = {
454 0, /* @sq_ass_item@ */
455 0, /* @sq_ass_slice@ */
456 PyMapping_HasKey, /* @sq_contains@ */
457 0, /* @sq_inplace_concat@ */
458 0 /* @sq_inplace_repeat@ */
461 Py_ssize_t gmap_pysize(PyObject *me)
463 PyObject *i = 0, *x = 0;
467 if ((i = PyObject_GetIter(me)) == 0) goto done;
468 while ((x = PyIter_Next(i)) != 0) { n++; Py_DECREF(x); x = 0; }
469 if (PyErr_Occurred()) goto done;
472 Py_XDECREF(i); Py_XDECREF(x);
476 PyObject *gmapmeth_has_key(PyObject *me, PyObject *arg)
479 if (!PyArg_ParseTuple(arg, "O:has_key", &k)) return (0);
480 return (getbool(PyMapping_HasKey(me, k)));
483 PyObject *gmapmeth_keys(PyObject *me, PyObject *arg)
485 PyObject *l = 0, *i = 0, *k, *rc = 0;
488 if (!PyArg_ParseTuple(arg, ":keys") ||
489 (l = PyList_New(0)) == 0 ||
490 (i = PyObject_GetIter(me)) == 0)
492 while ((k = PyIter_Next(i)) != 0)
493 { err = PyList_Append(l, k); Py_DECREF(k); if (err) goto done; }
494 if (PyErr_Occurred()) goto done;
497 Py_XDECREF(l); Py_XDECREF(i);
501 PyObject *gmapmeth_values(PyObject *me, PyObject *arg)
503 PyObject *l = 0, *i = 0, *k, *v, *rc = 0;
506 if (!PyArg_ParseTuple(arg, ":values") ||
507 (l = PyList_New(0)) == 0 ||
508 (i = PyObject_GetIter(me)) == 0)
510 while ((k = PyIter_Next(i)) != 0) {
511 if ((v = PyObject_GetItem(me, k)) == 0 ||
514 Py_DECREF(k); Py_XDECREF(v);
517 if (PyErr_Occurred()) goto done;
520 Py_XDECREF(l); Py_XDECREF(i);
524 PyObject *gmapmeth_items(PyObject *me, PyObject *arg)
526 PyObject *l = 0, *i = 0, *k, *v, *z, *rc = 0;
529 if (!PyArg_ParseTuple(arg, ":items") ||
530 (l = PyList_New(0)) == 0 ||
531 (i = PyObject_GetIter(me)) == 0)
533 while ((k = PyIter_Next(i)) != 0) {
535 if ((v = PyObject_GetItem(me, k)) == 0 ||
536 (z = Py_BuildValue("(OO)", k, v)) == 0 ||
539 Py_DECREF(k); Py_XDECREF(v); Py_XDECREF(z);
542 if (PyErr_Occurred()) goto done;
545 Py_XDECREF(l); Py_XDECREF(i);
549 PyObject *gmapmeth_iterkeys(PyObject *me, PyObject *arg)
551 if (!PyArg_ParseTuple(arg, ":iterkeys")) return (0);
552 return (PyObject_GetIter(me));
555 PyObject *gmapmeth_itervalues(PyObject *me, PyObject *arg)
560 if (!PyArg_ParseTuple(arg, ":itervalues") ||
561 (i = PyObject_GetIter(me)) == 0)
563 ii = PyObject_NEW(iter_pyobj, valiter_pytype);
564 ii->map = me; Py_INCREF(me);
566 return ((PyObject *)ii);
569 PyObject *gmapmeth_iteritems(PyObject *me, PyObject *arg)
574 if (!PyArg_ParseTuple(arg, ":iteritems") ||
575 (i = PyObject_GetIter(me)) == 0)
577 ii = PyObject_NEW(iter_pyobj, itemiter_pytype);
578 ii->map = me; Py_INCREF(me);
580 return ((PyObject *)ii);
583 PyObject *gmapmeth_clear(PyObject *me, PyObject *arg)
585 PyObject *i = 0, *k = 0, *rc = 0;
587 if (!PyArg_ParseTuple(arg, ":clear") ||
588 (i = PyObject_GetIter(me)) == 0)
590 while ((k = PyIter_Next(i)) != 0) {
591 PyObject_DelItem(me, k);
594 if (PyErr_Occurred()) goto end;
595 rc = me; Py_INCREF(me);
601 static char *def_kwlist[] = { "key", "default", 0 };
603 PyObject *gmapmeth_get(PyObject *me, PyObject *arg, PyObject *kw)
605 PyObject *k, *def = Py_None, *v;
607 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:get", def_kwlist, &k, &def))
609 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
614 PyObject *gmapmeth_setdefault(PyObject *me, PyObject *arg, PyObject *kw)
616 PyObject *k, *def = Py_None, *v;
618 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:setdefault",
619 def_kwlist, &k, &def))
621 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
623 if (PyObject_SetItem(me, k, def)) return (0);
627 PyObject *gmapmeth_pop(PyObject *me, PyObject *arg, PyObject *kw)
629 PyObject *k, *def = 0, *v;
631 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:pop", def_kwlist, &k, &def))
633 if ((v = PyObject_GetItem(me, k)) != 0) {
634 PyObject_DelItem(me, k);
641 PyObject *gmapmeth_update(PyObject *me, PyObject *arg)
643 PyObject *map, *i = 0, *k, *v, *rc = 0;
646 if (!PyArg_ParseTuple(arg, "O:update", &map) ||
647 (i = PyObject_GetIter(map)) == 0)
649 while ((k = PyIter_Next(i)) != 0) {
650 if ((v = PyObject_GetItem(map, k)) == 0 ||
651 PyObject_SetItem(me, k, v))
653 Py_DECREF(k); Py_XDECREF(v);
656 if (PyErr_Occurred()) goto end;
657 rc = me; Py_INCREF(me);
663 PyObject *gmapmeth_popitem(PyObject *me, PyObject *arg)
665 PyObject *i = 0, *k = 0, *v = 0, *rc = 0;
667 if (!PyArg_ParseTuple(arg, ":popitem") ||
668 (i = PyObject_GetIter(me)))
670 if ((k = PyIter_Next(i)) == 0) {
671 if (!PyErr_Occurred()) VALERR("popitem(): mapping is empty");
674 if ((v = PyObject_GetItem(me, k)) == 0 ||
675 PyObject_DelItem(me, k))
677 rc = Py_BuildValue("(OO)", k, v);
679 Py_XDECREF(i); Py_XDECREF(k); Py_XDECREF(v);
683 PyMethodDef gmap_pymethods[] = {
688 /*----- Initialization ----------------------------------------------------*/
690 void util_pyinit(void)
692 modname = PyString_FromString("catacomb");
693 INITTYPE(itemiter, root);
694 INITTYPE(valiter, root);
697 void util_pyinsert(PyObject *mod)
699 INSERT("ItemIter", itemiter_pytype);
700 INSERT("ValueIter", valiter_pytype);
703 /*----- That's all, folks -------------------------------------------------*/