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 (init_i32()) goto end;
137 if ((i = PyNumber_Int(o)) == 0) goto end;
138 lo = PyInt_AsUnsignedLongMask(i);
139 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
141 hi = PyInt_AsUnsignedLongMask(i);
142 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
144 if (PyObject_IsTrue(i)) VALERR("out of range");
145 SET64(*(kludge64 *)pp, hi, lo);
152 int convmpw(PyObject *o, void *pp)
157 if (!convulong(o, &u)) goto end;
158 if (u > MPW_MAX) VALERR("out of range");
165 int convszt(PyObject *o, void *pp)
170 if (!convulong(o, &u)) goto end;
171 if (u > ~(size_t)0) VALERR("out of range");
178 int convbool(PyObject *o, void *pp)
180 if (!o) VALERR("can't delete");
181 *(int *)pp = PyObject_IsTrue(o);
187 /*----- Type messing ------------------------------------------------------*/
189 static const PyTypeObject emptytype = { 0 };
191 void *newtype(PyTypeObject *metaty,
192 const PyTypeObject *skel,
195 PyHeapTypeObject *ty =
196 (PyHeapTypeObject *)_PyObject_GC_Malloc(_PyObject_VAR_SIZE(metaty, 0));
197 if (!skel) skel = &emptytype;
198 memcpy(ty, skel, sizeof(*skel));
199 if (ty->ht_type.tp_base) Py_INCREF(ty->ht_type.tp_base);
200 #define COPY(blah) do { \
201 if (ty->ht_type.tp_as_##blah) { \
202 memcpy(&ty->as_##blah, \
203 ty->ht_type.tp_as_##blah, \
204 sizeof(ty->as_##blah)); \
205 ty->ht_type.tp_as_##blah = &ty->as_##blah; \
214 ty->ht_name = PyString_FromString(name);
215 else if (ty->ht_type.tp_name)
216 ty->ht_name = PyString_FromString(ty->ht_type.tp_name);
218 ty->ht_type.tp_name = PyString_AS_STRING(ty->ht_name);
219 DISCARD(PyObject_INIT(&ty->ht_type, metaty));
224 void typeready(PyTypeObject *ty)
227 PyDict_SetItemString(ty->tp_dict, "__module__", modname);
230 PyTypeObject *inittype(PyTypeObject *tyskel, PyTypeObject *meta)
232 PyTypeObject *ty = newtype(meta, tyskel, 0);
233 ty->tp_flags |= Py_TPFLAGS_HEAPTYPE;
238 /*----- Constants ---------------------------------------------------------*/
240 void setconstants(PyObject *mod, const struct nameval *c)
245 if (c->value > LONG_MAX)
246 x = PyLong_FromUnsignedLong(c->value);
248 x = PyInt_FromLong(c->value);
249 PyModule_AddObject(mod, (/*unconst*/ char *)c->name, x);
254 /*----- Building method tables --------------------------------------------*/
256 DA_DECL(method_v, PyMethodDef);
257 static method_v global_pymethods = DA_INIT;
258 void addmethods(const PyMethodDef *m)
262 for (n = 0; m[n].ml_name; n++);
263 DA_ENSURE(&global_pymethods, n);
264 memcpy(DA(&global_pymethods) + DA_LEN(&global_pymethods),
266 DA_EXTEND(&global_pymethods, n);
269 PyMethodDef *donemethods(void)
271 static const PyMethodDef mzero = { 0 };
272 DA_PUSH(&global_pymethods, mzero);
273 return (DA(&global_pymethods));
276 /*----- Exceptions --------------------------------------------------------*/
278 PyObject *mkexc(PyObject *mod, PyObject *base,
279 const char *name, PyMethodDef *mm)
281 PyObject *nameobj = 0;
287 if ((nameobj = PyString_FromFormat("%s.%s",
288 PyModule_GetName(mod),
290 (dict = PyDict_New()) == 0 ||
291 (exc = PyErr_NewException(PyString_AS_STRING(nameobj),
296 while (mm->ml_name) {
297 if ((func = PyCFunction_NewEx(mm, 0, mod)) == 0 ||
298 (meth = PyMethod_New(func, 0, exc)) == 0 ||
299 PyDict_SetItemString(dict, mm->ml_name, meth))
301 Py_DECREF(func); func = 0;
302 Py_DECREF(meth); meth = 0;
320 /*----- Generic dictionary methods ----------------------------------------*/
322 static PyTypeObject *itemiter_pytype, *valiter_pytype;
324 typedef struct iter_pyobj {
329 #define ITER_MAP(o) (((iter_pyobj *)(o))->map)
330 #define ITER_I(o) (((iter_pyobj *)(o))->i)
332 static void iter_pydealloc(PyObject *me)
333 { Py_DECREF(ITER_MAP(me)); Py_DECREF(ITER_I(me)); FREEOBJ(me); }
335 static PyObject *itemiter_pynext(PyObject *me)
337 PyObject *k = 0, *v = 0, *rc = 0;
339 if ((k = PyIter_Next(ITER_I(me))) != 0 &&
340 (v = PyObject_GetItem(ITER_MAP(me), k)) != 0)
341 rc = Py_BuildValue("(OO)", k, v);
342 Py_XDECREF(k); Py_XDECREF(v);
346 static PyTypeObject itemiter_pytype_skel = {
347 PyObject_HEAD_INIT(0) 0, /* Header */
348 "ItemIter", /* @tp_name@ */
349 sizeof(iter_pyobj), /* @tp_basicsize@ */
350 0, /* @tp_itemsize@ */
352 iter_pydealloc, /* @tp_dealloc@ */
354 0, /* @tp_getattr@ */
355 0, /* @tp_setattr@ */
356 0, /* @tp_compare@ */
358 0, /* @tp_as_number@ */
359 0, /* @tp_as_sequence@ */
360 0, /* @tp_as_mapping@ */
364 0, /* @tp_getattro@ */
365 0, /* @tp_setattro@ */
366 0, /* @tp_as_buffer@ */
367 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
371 "Iterates over the items of a mapping.",
373 0, /* @tp_traverse@ */
375 0, /* @tp_richcompare@ */
376 0, /* @tp_weaklistoffset@ */
377 PyObject_SelfIter, /* @tp_iter@ */
378 itemiter_pynext, /* @tp_iternext@ */
379 0, /* @tp_methods@ */
380 0, /* @tp_members@ */
384 0, /* @tp_descr_get@ */
385 0, /* @tp_descr_set@ */
386 0, /* @tp_dictoffset@ */
388 PyType_GenericAlloc, /* @tp_alloc@ */
389 abstract_pynew, /* @tp_new@ */
394 static PyObject *valiter_pynext(PyObject *me)
396 PyObject *k = 0, *rc = 0;
398 if ((k = PyIter_Next(ITER_I(me))) != 0)
399 rc = PyObject_GetItem(ITER_MAP(me), k);
404 static PyTypeObject valiter_pytype_skel = {
405 PyObject_HEAD_INIT(0) 0, /* Header */
406 "ValueIter", /* @tp_name@ */
407 sizeof(iter_pyobj), /* @tp_basicsize@ */
408 0, /* @tp_itemsize@ */
410 iter_pydealloc, /* @tp_dealloc@ */
412 0, /* @tp_getattr@ */
413 0, /* @tp_setattr@ */
414 0, /* @tp_compare@ */
416 0, /* @tp_as_number@ */
417 0, /* @tp_as_sequence@ */
418 0, /* @tp_as_mapping@ */
422 0, /* @tp_getattro@ */
423 0, /* @tp_setattro@ */
424 0, /* @tp_as_buffer@ */
425 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
429 "Iterates over the items of a mapping.",
431 0, /* @tp_traverse@ */
433 0, /* @tp_richcompare@ */
434 0, /* @tp_weaklistoffset@ */
435 PyObject_SelfIter, /* @tp_iter@ */
436 valiter_pynext, /* @tp_iternext@ */
437 0, /* @tp_methods@ */
438 0, /* @tp_members@ */
442 0, /* @tp_descr_get@ */
443 0, /* @tp_descr_set@ */
444 0, /* @tp_dictoffset@ */
446 PyType_GenericAlloc, /* @tp_alloc@ */
447 abstract_pynew, /* @tp_new@ */
452 PySequenceMethods gmap_pysequence = {
458 0, /* @sq_ass_item@ */
459 0, /* @sq_ass_slice@ */
460 PyMapping_HasKey, /* @sq_contains@ */
461 0, /* @sq_inplace_concat@ */
462 0 /* @sq_inplace_repeat@ */
465 Py_ssize_t gmap_pysize(PyObject *me)
467 PyObject *i = 0, *x = 0;
471 if ((i = PyObject_GetIter(me)) == 0) goto done;
472 while ((x = PyIter_Next(i)) != 0) { n++; Py_DECREF(x); x = 0; }
473 if (PyErr_Occurred()) goto done;
476 Py_XDECREF(i); Py_XDECREF(x);
480 PyObject *gmapmeth_has_key(PyObject *me, PyObject *arg)
483 if (!PyArg_ParseTuple(arg, "O:has_key", &k)) return (0);
484 return (getbool(PyMapping_HasKey(me, k)));
487 PyObject *gmapmeth_keys(PyObject *me, PyObject *arg)
489 PyObject *l = 0, *i = 0, *k, *rc = 0;
492 if (!PyArg_ParseTuple(arg, ":keys") ||
493 (l = PyList_New(0)) == 0 ||
494 (i = PyObject_GetIter(me)) == 0)
496 while ((k = PyIter_Next(i)) != 0)
497 { err = PyList_Append(l, k); Py_DECREF(k); if (err) goto done; }
498 if (PyErr_Occurred()) goto done;
501 Py_XDECREF(l); Py_XDECREF(i);
505 PyObject *gmapmeth_values(PyObject *me, PyObject *arg)
507 PyObject *l = 0, *i = 0, *k, *v, *rc = 0;
510 if (!PyArg_ParseTuple(arg, ":values") ||
511 (l = PyList_New(0)) == 0 ||
512 (i = PyObject_GetIter(me)) == 0)
514 while ((k = PyIter_Next(i)) != 0) {
515 if ((v = PyObject_GetItem(me, k)) == 0 ||
518 Py_DECREF(k); Py_XDECREF(v);
521 if (PyErr_Occurred()) goto done;
524 Py_XDECREF(l); Py_XDECREF(i);
528 PyObject *gmapmeth_items(PyObject *me, PyObject *arg)
530 PyObject *l = 0, *i = 0, *k, *v, *z, *rc = 0;
533 if (!PyArg_ParseTuple(arg, ":items") ||
534 (l = PyList_New(0)) == 0 ||
535 (i = PyObject_GetIter(me)) == 0)
537 while ((k = PyIter_Next(i)) != 0) {
539 if ((v = PyObject_GetItem(me, k)) == 0 ||
540 (z = Py_BuildValue("(OO)", k, v)) == 0 ||
543 Py_DECREF(k); Py_XDECREF(v); Py_XDECREF(z);
546 if (PyErr_Occurred()) goto done;
549 Py_XDECREF(l); Py_XDECREF(i);
553 PyObject *gmapmeth_iterkeys(PyObject *me, PyObject *arg)
555 if (!PyArg_ParseTuple(arg, ":iterkeys")) return (0);
556 return (PyObject_GetIter(me));
559 PyObject *gmapmeth_itervalues(PyObject *me, PyObject *arg)
564 if (!PyArg_ParseTuple(arg, ":itervalues") ||
565 (i = PyObject_GetIter(me)) == 0)
567 ii = PyObject_NEW(iter_pyobj, valiter_pytype);
568 ii->map = me; Py_INCREF(me);
570 return ((PyObject *)ii);
573 PyObject *gmapmeth_iteritems(PyObject *me, PyObject *arg)
578 if (!PyArg_ParseTuple(arg, ":iteritems") ||
579 (i = PyObject_GetIter(me)) == 0)
581 ii = PyObject_NEW(iter_pyobj, itemiter_pytype);
582 ii->map = me; Py_INCREF(me);
584 return ((PyObject *)ii);
587 PyObject *gmapmeth_clear(PyObject *me, PyObject *arg)
589 PyObject *i = 0, *k = 0, *rc = 0;
591 if (!PyArg_ParseTuple(arg, ":clear") ||
592 (i = PyObject_GetIter(me)) == 0)
594 while ((k = PyIter_Next(i)) != 0) {
595 PyObject_DelItem(me, k);
598 if (PyErr_Occurred()) goto end;
599 rc = me; Py_INCREF(me);
605 static char *def_kwlist[] = { "key", "default", 0 };
607 PyObject *gmapmeth_get(PyObject *me, PyObject *arg, PyObject *kw)
609 PyObject *k, *def = Py_None, *v;
611 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:get", def_kwlist, &k, &def))
613 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
618 PyObject *gmapmeth_setdefault(PyObject *me, PyObject *arg, PyObject *kw)
620 PyObject *k, *def = Py_None, *v;
622 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:setdefault",
623 def_kwlist, &k, &def))
625 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
627 if (PyObject_SetItem(me, k, def)) return (0);
631 PyObject *gmapmeth_pop(PyObject *me, PyObject *arg, PyObject *kw)
633 PyObject *k, *def = 0, *v;
635 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:pop", def_kwlist, &k, &def))
637 if ((v = PyObject_GetItem(me, k)) != 0) {
638 PyObject_DelItem(me, k);
645 PyObject *gmapmeth_update(PyObject *me, PyObject *arg)
647 PyObject *map, *i = 0, *k, *v, *rc = 0;
650 if (!PyArg_ParseTuple(arg, "O:update", &map) ||
651 (i = PyObject_GetIter(map)) == 0)
653 while ((k = PyIter_Next(i)) != 0) {
654 if ((v = PyObject_GetItem(map, k)) == 0 ||
655 PyObject_SetItem(me, k, v))
657 Py_DECREF(k); Py_XDECREF(v);
660 if (PyErr_Occurred()) goto end;
661 rc = me; Py_INCREF(me);
667 PyObject *gmapmeth_popitem(PyObject *me, PyObject *arg)
669 PyObject *i = 0, *k = 0, *v = 0, *rc = 0;
671 if (!PyArg_ParseTuple(arg, ":popitem") ||
672 (i = PyObject_GetIter(me)))
674 if ((k = PyIter_Next(i)) == 0) {
675 if (!PyErr_Occurred()) VALERR("popitem(): mapping is empty");
678 if ((v = PyObject_GetItem(me, k)) == 0 ||
679 PyObject_DelItem(me, k))
681 rc = Py_BuildValue("(OO)", k, v);
683 Py_XDECREF(i); Py_XDECREF(k); Py_XDECREF(v);
687 PyMethodDef gmap_pymethods[] = {
692 /*----- Initialization ----------------------------------------------------*/
694 void util_pyinit(void)
696 modname = PyString_FromString("catacomb");
697 INITTYPE(itemiter, root);
698 INITTYPE(valiter, root);
701 void util_pyinsert(PyObject *mod)
703 INSERT("ItemIter", itemiter_pytype);
704 INSERT("ValueIter", valiter_pytype);
707 /*----- That's all, folks -------------------------------------------------*/