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;
86 if (!o) VALERR("can't delete");
89 if (i < 0) VALERR("must be nonnegative");
92 if ((t = PyNumber_Long(o)) == 0) goto end;
93 *p = PyLong_AsUnsignedLong(t);
95 if (PyErr_Occurred()) goto end;
103 int convu##n(PyObject *o, void *pp) \
108 if (!convulong(o, &u)) goto end; \
109 if (u > MASK##n) VALERR("out of range"); \
117 int convuint(PyObject *o, void *pp)
122 if (!convulong(o, &u)) goto end;
123 if (u > UINT_MAX) VALERR("out of range");
130 int convk64(PyObject *o, void *pp)
136 if (!o) VALERR("can't delete");
137 if (init_i32()) goto end;
138 if ((i = PyNumber_Int(o)) == 0) goto end;
139 lo = PyInt_AsUnsignedLongMask(i);
140 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
142 hi = PyInt_AsUnsignedLongMask(i);
143 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
145 if (PyObject_IsTrue(i)) VALERR("out of range");
146 SET64(*(kludge64 *)pp, hi, lo);
153 int convmpw(PyObject *o, void *pp)
158 if (!convulong(o, &u)) goto end;
159 if (u > MPW_MAX) VALERR("out of range");
166 int convszt(PyObject *o, void *pp)
171 if (!convulong(o, &u)) goto end;
172 if (u > ~(size_t)0) VALERR("out of range");
179 int convbool(PyObject *o, void *pp)
181 if (!o) VALERR("can't delete");
182 *(int *)pp = PyObject_IsTrue(o);
188 /*----- Type messing ------------------------------------------------------*/
190 static const PyTypeObject emptytype = { 0 };
192 void *newtype(PyTypeObject *metaty,
193 const PyTypeObject *skel,
196 PyHeapTypeObject *ty =
197 (PyHeapTypeObject *)_PyObject_GC_Malloc(_PyObject_VAR_SIZE(metaty, 0));
198 if (!skel) skel = &emptytype;
199 memcpy(ty, skel, sizeof(*skel));
200 if (ty->ht_type.tp_base) Py_INCREF(ty->ht_type.tp_base);
201 #define COPY(blah) do { \
202 if (ty->ht_type.tp_as_##blah) { \
203 memcpy(&ty->as_##blah, \
204 ty->ht_type.tp_as_##blah, \
205 sizeof(ty->as_##blah)); \
206 ty->ht_type.tp_as_##blah = &ty->as_##blah; \
215 ty->ht_name = PyString_FromString(name);
216 else if (ty->ht_type.tp_name)
217 ty->ht_name = PyString_FromString(ty->ht_type.tp_name);
219 ty->ht_type.tp_name = PyString_AS_STRING(ty->ht_name);
220 DISCARD(PyObject_INIT(&ty->ht_type, metaty));
225 void typeready(PyTypeObject *ty)
228 PyDict_SetItemString(ty->tp_dict, "__module__", modname);
231 PyTypeObject *inittype(PyTypeObject *tyskel, PyTypeObject *meta)
233 PyTypeObject *ty = newtype(meta, tyskel, 0);
234 ty->tp_flags |= Py_TPFLAGS_HEAPTYPE;
239 /*----- Constants ---------------------------------------------------------*/
241 void setconstants(PyObject *mod, const struct nameval *c)
246 if (c->value > LONG_MAX)
247 x = PyLong_FromUnsignedLong(c->value);
249 x = PyInt_FromLong(c->value);
250 PyModule_AddObject(mod, (/*unconst*/ char *)c->name, x);
255 /*----- Building method tables --------------------------------------------*/
257 DA_DECL(method_v, PyMethodDef);
258 static method_v global_pymethods = DA_INIT;
259 void addmethods(const PyMethodDef *m)
263 for (n = 0; m[n].ml_name; n++);
264 DA_ENSURE(&global_pymethods, n);
265 memcpy(DA(&global_pymethods) + DA_LEN(&global_pymethods),
267 DA_EXTEND(&global_pymethods, n);
270 PyMethodDef *donemethods(void)
272 static const PyMethodDef mzero = { 0 };
273 DA_PUSH(&global_pymethods, mzero);
274 return (DA(&global_pymethods));
277 /*----- Exceptions --------------------------------------------------------*/
279 PyObject *mkexc(PyObject *mod, PyObject *base,
280 const char *name, PyMethodDef *mm)
282 PyObject *nameobj = 0;
288 if ((nameobj = PyString_FromFormat("%s.%s",
289 PyModule_GetName(mod),
291 (dict = PyDict_New()) == 0 ||
292 (exc = PyErr_NewException(PyString_AS_STRING(nameobj),
297 while (mm->ml_name) {
298 if ((func = PyCFunction_NewEx(mm, 0, mod)) == 0 ||
299 (meth = PyMethod_New(func, 0, exc)) == 0 ||
300 PyDict_SetItemString(dict, mm->ml_name, meth))
302 Py_DECREF(func); func = 0;
303 Py_DECREF(meth); meth = 0;
321 /*----- Generic dictionary methods ----------------------------------------*/
323 static PyTypeObject *itemiter_pytype, *valiter_pytype;
325 typedef struct iter_pyobj {
330 #define ITER_MAP(o) (((iter_pyobj *)(o))->map)
331 #define ITER_I(o) (((iter_pyobj *)(o))->i)
333 static void iter_pydealloc(PyObject *me)
334 { Py_DECREF(ITER_MAP(me)); Py_DECREF(ITER_I(me)); FREEOBJ(me); }
336 static PyObject *itemiter_pynext(PyObject *me)
338 PyObject *k = 0, *v = 0, *rc = 0;
340 if ((k = PyIter_Next(ITER_I(me))) != 0 &&
341 (v = PyObject_GetItem(ITER_MAP(me), k)) != 0)
342 rc = Py_BuildValue("(OO)", k, v);
343 Py_XDECREF(k); Py_XDECREF(v);
347 static PyTypeObject itemiter_pytype_skel = {
348 PyObject_HEAD_INIT(0) 0, /* Header */
349 "ItemIter", /* @tp_name@ */
350 sizeof(iter_pyobj), /* @tp_basicsize@ */
351 0, /* @tp_itemsize@ */
353 iter_pydealloc, /* @tp_dealloc@ */
355 0, /* @tp_getattr@ */
356 0, /* @tp_setattr@ */
357 0, /* @tp_compare@ */
359 0, /* @tp_as_number@ */
360 0, /* @tp_as_sequence@ */
361 0, /* @tp_as_mapping@ */
365 0, /* @tp_getattro@ */
366 0, /* @tp_setattro@ */
367 0, /* @tp_as_buffer@ */
368 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
372 "Iterates over the items of a mapping.",
374 0, /* @tp_traverse@ */
376 0, /* @tp_richcompare@ */
377 0, /* @tp_weaklistoffset@ */
378 PyObject_SelfIter, /* @tp_iter@ */
379 itemiter_pynext, /* @tp_iternext@ */
380 0, /* @tp_methods@ */
381 0, /* @tp_members@ */
385 0, /* @tp_descr_get@ */
386 0, /* @tp_descr_set@ */
387 0, /* @tp_dictoffset@ */
389 PyType_GenericAlloc, /* @tp_alloc@ */
390 abstract_pynew, /* @tp_new@ */
395 static PyObject *valiter_pynext(PyObject *me)
397 PyObject *k = 0, *rc = 0;
399 if ((k = PyIter_Next(ITER_I(me))) != 0)
400 rc = PyObject_GetItem(ITER_MAP(me), k);
405 static PyTypeObject valiter_pytype_skel = {
406 PyObject_HEAD_INIT(0) 0, /* Header */
407 "ValueIter", /* @tp_name@ */
408 sizeof(iter_pyobj), /* @tp_basicsize@ */
409 0, /* @tp_itemsize@ */
411 iter_pydealloc, /* @tp_dealloc@ */
413 0, /* @tp_getattr@ */
414 0, /* @tp_setattr@ */
415 0, /* @tp_compare@ */
417 0, /* @tp_as_number@ */
418 0, /* @tp_as_sequence@ */
419 0, /* @tp_as_mapping@ */
423 0, /* @tp_getattro@ */
424 0, /* @tp_setattro@ */
425 0, /* @tp_as_buffer@ */
426 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
430 "Iterates over the items of a mapping.",
432 0, /* @tp_traverse@ */
434 0, /* @tp_richcompare@ */
435 0, /* @tp_weaklistoffset@ */
436 PyObject_SelfIter, /* @tp_iter@ */
437 valiter_pynext, /* @tp_iternext@ */
438 0, /* @tp_methods@ */
439 0, /* @tp_members@ */
443 0, /* @tp_descr_get@ */
444 0, /* @tp_descr_set@ */
445 0, /* @tp_dictoffset@ */
447 PyType_GenericAlloc, /* @tp_alloc@ */
448 abstract_pynew, /* @tp_new@ */
453 PySequenceMethods gmap_pysequence = {
459 0, /* @sq_ass_item@ */
460 0, /* @sq_ass_slice@ */
461 PyMapping_HasKey, /* @sq_contains@ */
462 0, /* @sq_inplace_concat@ */
463 0 /* @sq_inplace_repeat@ */
466 Py_ssize_t gmap_pysize(PyObject *me)
468 PyObject *i = 0, *x = 0;
472 if ((i = PyObject_GetIter(me)) == 0) goto done;
473 while ((x = PyIter_Next(i)) != 0) { n++; Py_DECREF(x); x = 0; }
474 if (PyErr_Occurred()) goto done;
477 Py_XDECREF(i); Py_XDECREF(x);
481 PyObject *gmapmeth_has_key(PyObject *me, PyObject *arg)
484 if (!PyArg_ParseTuple(arg, "O:has_key", &k)) return (0);
485 return (getbool(PyMapping_HasKey(me, k)));
488 PyObject *gmapmeth_keys(PyObject *me, PyObject *arg)
490 PyObject *l = 0, *i = 0, *k, *rc = 0;
493 if (!PyArg_ParseTuple(arg, ":keys") ||
494 (l = PyList_New(0)) == 0 ||
495 (i = PyObject_GetIter(me)) == 0)
497 while ((k = PyIter_Next(i)) != 0)
498 { err = PyList_Append(l, k); Py_DECREF(k); if (err) goto done; }
499 if (PyErr_Occurred()) goto done;
502 Py_XDECREF(l); Py_XDECREF(i);
506 PyObject *gmapmeth_values(PyObject *me, PyObject *arg)
508 PyObject *l = 0, *i = 0, *k, *v, *rc = 0;
511 if (!PyArg_ParseTuple(arg, ":values") ||
512 (l = PyList_New(0)) == 0 ||
513 (i = PyObject_GetIter(me)) == 0)
515 while ((k = PyIter_Next(i)) != 0) {
516 if ((v = PyObject_GetItem(me, k)) == 0 ||
519 Py_DECREF(k); Py_XDECREF(v);
522 if (PyErr_Occurred()) goto done;
525 Py_XDECREF(l); Py_XDECREF(i);
529 PyObject *gmapmeth_items(PyObject *me, PyObject *arg)
531 PyObject *l = 0, *i = 0, *k, *v, *z, *rc = 0;
534 if (!PyArg_ParseTuple(arg, ":items") ||
535 (l = PyList_New(0)) == 0 ||
536 (i = PyObject_GetIter(me)) == 0)
538 while ((k = PyIter_Next(i)) != 0) {
540 if ((v = PyObject_GetItem(me, k)) == 0 ||
541 (z = Py_BuildValue("(OO)", k, v)) == 0 ||
544 Py_DECREF(k); Py_XDECREF(v); Py_XDECREF(z);
547 if (PyErr_Occurred()) goto done;
550 Py_XDECREF(l); Py_XDECREF(i);
554 PyObject *gmapmeth_iterkeys(PyObject *me, PyObject *arg)
556 if (!PyArg_ParseTuple(arg, ":iterkeys")) return (0);
557 return (PyObject_GetIter(me));
560 PyObject *gmapmeth_itervalues(PyObject *me, PyObject *arg)
565 if (!PyArg_ParseTuple(arg, ":itervalues") ||
566 (i = PyObject_GetIter(me)) == 0)
568 ii = PyObject_NEW(iter_pyobj, valiter_pytype);
569 ii->map = me; Py_INCREF(me);
571 return ((PyObject *)ii);
574 PyObject *gmapmeth_iteritems(PyObject *me, PyObject *arg)
579 if (!PyArg_ParseTuple(arg, ":iteritems") ||
580 (i = PyObject_GetIter(me)) == 0)
582 ii = PyObject_NEW(iter_pyobj, itemiter_pytype);
583 ii->map = me; Py_INCREF(me);
585 return ((PyObject *)ii);
588 PyObject *gmapmeth_clear(PyObject *me, PyObject *arg)
590 PyObject *i = 0, *k = 0, *rc = 0;
592 if (!PyArg_ParseTuple(arg, ":clear") ||
593 (i = PyObject_GetIter(me)) == 0)
595 while ((k = PyIter_Next(i)) != 0) {
596 PyObject_DelItem(me, k);
599 if (PyErr_Occurred()) goto end;
600 rc = me; Py_INCREF(me);
606 static const char *const def_kwlist[] = { "key", "default", 0 };
608 PyObject *gmapmeth_get(PyObject *me, PyObject *arg, PyObject *kw)
610 PyObject *k, *def = Py_None, *v;
612 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:get",
613 (/*unconst*/ char **)def_kwlist,
616 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
621 PyObject *gmapmeth_setdefault(PyObject *me, PyObject *arg, PyObject *kw)
623 PyObject *k, *def = Py_None, *v;
625 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:setdefault",
626 (/*unconst*/ char **)def_kwlist,
629 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
631 if (PyObject_SetItem(me, k, def)) return (0);
635 PyObject *gmapmeth_pop(PyObject *me, PyObject *arg, PyObject *kw)
637 PyObject *k, *def = 0, *v;
639 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:pop",
640 (/*unconst*/ char **)def_kwlist,
643 if ((v = PyObject_GetItem(me, k)) != 0) {
644 PyObject_DelItem(me, k);
651 PyObject *gmapmeth_update(PyObject *me, PyObject *arg)
653 PyObject *map, *i = 0, *k, *v, *rc = 0;
656 if (!PyArg_ParseTuple(arg, "O:update", &map) ||
657 (i = PyObject_GetIter(map)) == 0)
659 while ((k = PyIter_Next(i)) != 0) {
660 if ((v = PyObject_GetItem(map, k)) == 0 ||
661 PyObject_SetItem(me, k, v))
663 Py_DECREF(k); Py_XDECREF(v);
666 if (PyErr_Occurred()) goto end;
667 rc = me; Py_INCREF(me);
673 PyObject *gmapmeth_popitem(PyObject *me, PyObject *arg)
675 PyObject *i = 0, *k = 0, *v = 0, *rc = 0;
677 if (!PyArg_ParseTuple(arg, ":popitem") ||
678 (i = PyObject_GetIter(me)))
680 if ((k = PyIter_Next(i)) == 0) {
681 if (!PyErr_Occurred()) VALERR("popitem(): mapping is empty");
684 if ((v = PyObject_GetItem(me, k)) == 0 ||
685 PyObject_DelItem(me, k))
687 rc = Py_BuildValue("(OO)", k, v);
689 Py_XDECREF(i); Py_XDECREF(k); Py_XDECREF(v);
693 PyMethodDef gmap_pymethods[] = {
698 /*----- Initialization ----------------------------------------------------*/
700 void util_pyinit(void)
702 modname = PyString_FromString("catacomb");
703 INITTYPE(itemiter, root);
704 INITTYPE(valiter, root);
707 void util_pyinsert(PyObject *mod)
709 INSERT("ItemIter", itemiter_pytype);
710 INSERT("ValueIter", valiter_pytype);
713 /*----- That's all, folks -------------------------------------------------*/