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 # define CONVu64(n) do { \
106 if (!convk64(o, &k)) goto end; \
107 t = GET64(uint64, k); \
108 if (t > MASK##n) VALERR("out of range"); \
112 # define CONVu64(n) assert(!"shouldn't be possible")
116 int convu##n(PyObject *o, void *pp) \
121 if (MASK##n > ULONG_MAX) \
124 if (!convulong(o, &u)) goto end; \
125 if (u > MASK##n) VALERR("out of range"); \
134 int convuint(PyObject *o, void *pp)
139 if (!convulong(o, &u)) goto end;
140 if (u > UINT_MAX) VALERR("out of range");
147 int convk64(PyObject *o, void *pp)
153 if (!o) VALERR("can't delete");
154 if (init_i32()) goto end;
155 if ((i = PyNumber_Int(o)) == 0) goto end;
156 lo = PyInt_AsUnsignedLongMask(i);
157 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
159 hi = PyInt_AsUnsignedLongMask(i);
160 if ((t = PyNumber_InPlaceRshift(i, i32)) == 0) goto end;
162 if (PyObject_IsTrue(i)) VALERR("out of range");
163 SET64(*(kludge64 *)pp, hi, lo);
170 int convmpw(PyObject *o, void *pp)
175 if (!convulong(o, &u)) goto end;
176 if (u > MPW_MAX) VALERR("out of range");
183 int convszt(PyObject *o, void *pp)
188 if (!convulong(o, &u)) goto end;
189 if (u > ~(size_t)0) VALERR("out of range");
196 int convbool(PyObject *o, void *pp)
198 if (!o) VALERR("can't delete");
199 *(int *)pp = PyObject_IsTrue(o);
205 /*----- Type messing ------------------------------------------------------*/
207 static const PyTypeObject emptytype = { 0 };
209 void *newtype(PyTypeObject *metaty,
210 const PyTypeObject *skel,
213 PyHeapTypeObject *ty =
214 (PyHeapTypeObject *)_PyObject_GC_Malloc(_PyObject_VAR_SIZE(metaty, 0));
215 if (!skel) skel = &emptytype;
216 memcpy(ty, skel, sizeof(*skel));
217 if (ty->ht_type.tp_base) Py_INCREF(ty->ht_type.tp_base);
218 #define COPY(blah) do { \
219 if (ty->ht_type.tp_as_##blah) { \
220 memcpy(&ty->as_##blah, \
221 ty->ht_type.tp_as_##blah, \
222 sizeof(ty->as_##blah)); \
223 ty->ht_type.tp_as_##blah = &ty->as_##blah; \
232 ty->ht_name = PyString_FromString(name);
233 else if (ty->ht_type.tp_name)
234 ty->ht_name = PyString_FromString(ty->ht_type.tp_name);
236 ty->ht_type.tp_name = PyString_AS_STRING(ty->ht_name);
237 DISCARD(PyObject_INIT(&ty->ht_type, metaty));
242 void typeready(PyTypeObject *ty)
245 PyDict_SetItemString(ty->tp_dict, "__module__", modname);
248 PyTypeObject *inittype(PyTypeObject *tyskel, PyTypeObject *meta)
250 PyTypeObject *ty = newtype(meta, tyskel, 0);
251 ty->tp_flags |= Py_TPFLAGS_HEAPTYPE;
256 /*----- Constants ---------------------------------------------------------*/
258 void setconstants(PyObject *mod, const struct nameval *c)
263 if (c->value > LONG_MAX)
264 x = PyLong_FromUnsignedLong(c->value);
266 x = PyInt_FromLong(c->value);
267 PyModule_AddObject(mod, (/*unconst*/ char *)c->name, x);
272 /*----- Building method tables --------------------------------------------*/
274 DA_DECL(method_v, PyMethodDef);
275 static method_v global_pymethods = DA_INIT;
276 void addmethods(const PyMethodDef *m)
280 for (n = 0; m[n].ml_name; n++);
281 DA_ENSURE(&global_pymethods, n);
282 memcpy(DA(&global_pymethods) + DA_LEN(&global_pymethods),
284 DA_EXTEND(&global_pymethods, n);
287 PyMethodDef *donemethods(void)
289 static const PyMethodDef mzero = { 0 };
290 DA_PUSH(&global_pymethods, mzero);
291 return (DA(&global_pymethods));
294 /*----- Exceptions --------------------------------------------------------*/
296 PyObject *mkexc(PyObject *mod, PyObject *base,
297 const char *name, PyMethodDef *mm)
299 PyObject *nameobj = 0;
305 if ((nameobj = PyString_FromFormat("%s.%s",
306 PyModule_GetName(mod),
308 (dict = PyDict_New()) == 0 ||
309 (exc = PyErr_NewException(PyString_AS_STRING(nameobj),
314 while (mm->ml_name) {
315 if ((func = PyCFunction_NewEx(mm, 0, mod)) == 0 ||
316 (meth = PyMethod_New(func, 0, exc)) == 0 ||
317 PyDict_SetItemString(dict, mm->ml_name, meth))
319 Py_DECREF(func); func = 0;
320 Py_DECREF(meth); meth = 0;
338 /*----- Generic dictionary methods ----------------------------------------*/
340 static PyTypeObject *itemiter_pytype, *valiter_pytype;
342 typedef struct iter_pyobj {
347 #define ITER_MAP(o) (((iter_pyobj *)(o))->map)
348 #define ITER_I(o) (((iter_pyobj *)(o))->i)
350 static void iter_pydealloc(PyObject *me)
351 { Py_DECREF(ITER_MAP(me)); Py_DECREF(ITER_I(me)); FREEOBJ(me); }
353 static PyObject *itemiter_pynext(PyObject *me)
355 PyObject *k = 0, *v = 0, *rc = 0;
357 if ((k = PyIter_Next(ITER_I(me))) != 0 &&
358 (v = PyObject_GetItem(ITER_MAP(me), k)) != 0)
359 rc = Py_BuildValue("(OO)", k, v);
360 Py_XDECREF(k); Py_XDECREF(v);
364 static PyTypeObject itemiter_pytype_skel = {
365 PyObject_HEAD_INIT(0) 0, /* Header */
366 "ItemIter", /* @tp_name@ */
367 sizeof(iter_pyobj), /* @tp_basicsize@ */
368 0, /* @tp_itemsize@ */
370 iter_pydealloc, /* @tp_dealloc@ */
372 0, /* @tp_getattr@ */
373 0, /* @tp_setattr@ */
374 0, /* @tp_compare@ */
376 0, /* @tp_as_number@ */
377 0, /* @tp_as_sequence@ */
378 0, /* @tp_as_mapping@ */
382 0, /* @tp_getattro@ */
383 0, /* @tp_setattro@ */
384 0, /* @tp_as_buffer@ */
385 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
389 "Iterates over the items of a mapping.",
391 0, /* @tp_traverse@ */
393 0, /* @tp_richcompare@ */
394 0, /* @tp_weaklistoffset@ */
395 PyObject_SelfIter, /* @tp_iter@ */
396 itemiter_pynext, /* @tp_iternext@ */
397 0, /* @tp_methods@ */
398 0, /* @tp_members@ */
402 0, /* @tp_descr_get@ */
403 0, /* @tp_descr_set@ */
404 0, /* @tp_dictoffset@ */
406 PyType_GenericAlloc, /* @tp_alloc@ */
407 abstract_pynew, /* @tp_new@ */
412 static PyObject *valiter_pynext(PyObject *me)
414 PyObject *k = 0, *rc = 0;
416 if ((k = PyIter_Next(ITER_I(me))) != 0)
417 rc = PyObject_GetItem(ITER_MAP(me), k);
422 static PyTypeObject valiter_pytype_skel = {
423 PyObject_HEAD_INIT(0) 0, /* Header */
424 "ValueIter", /* @tp_name@ */
425 sizeof(iter_pyobj), /* @tp_basicsize@ */
426 0, /* @tp_itemsize@ */
428 iter_pydealloc, /* @tp_dealloc@ */
430 0, /* @tp_getattr@ */
431 0, /* @tp_setattr@ */
432 0, /* @tp_compare@ */
434 0, /* @tp_as_number@ */
435 0, /* @tp_as_sequence@ */
436 0, /* @tp_as_mapping@ */
440 0, /* @tp_getattro@ */
441 0, /* @tp_setattro@ */
442 0, /* @tp_as_buffer@ */
443 Py_TPFLAGS_DEFAULT | /* @tp_flags@ */
447 "Iterates over the items of a mapping.",
449 0, /* @tp_traverse@ */
451 0, /* @tp_richcompare@ */
452 0, /* @tp_weaklistoffset@ */
453 PyObject_SelfIter, /* @tp_iter@ */
454 valiter_pynext, /* @tp_iternext@ */
455 0, /* @tp_methods@ */
456 0, /* @tp_members@ */
460 0, /* @tp_descr_get@ */
461 0, /* @tp_descr_set@ */
462 0, /* @tp_dictoffset@ */
464 PyType_GenericAlloc, /* @tp_alloc@ */
465 abstract_pynew, /* @tp_new@ */
470 PySequenceMethods gmap_pysequence = {
476 0, /* @sq_ass_item@ */
477 0, /* @sq_ass_slice@ */
478 PyMapping_HasKey, /* @sq_contains@ */
479 0, /* @sq_inplace_concat@ */
480 0 /* @sq_inplace_repeat@ */
483 Py_ssize_t gmap_pysize(PyObject *me)
485 PyObject *i = 0, *x = 0;
489 if ((i = PyObject_GetIter(me)) == 0) goto done;
490 while ((x = PyIter_Next(i)) != 0) { n++; Py_DECREF(x); x = 0; }
491 if (PyErr_Occurred()) goto done;
494 Py_XDECREF(i); Py_XDECREF(x);
498 PyObject *gmapmeth_has_key(PyObject *me, PyObject *arg)
501 if (!PyArg_ParseTuple(arg, "O:has_key", &k)) return (0);
502 return (getbool(PyMapping_HasKey(me, k)));
505 PyObject *gmapmeth_keys(PyObject *me, PyObject *arg)
507 PyObject *l = 0, *i = 0, *k, *rc = 0;
510 if (!PyArg_ParseTuple(arg, ":keys") ||
511 (l = PyList_New(0)) == 0 ||
512 (i = PyObject_GetIter(me)) == 0)
514 while ((k = PyIter_Next(i)) != 0)
515 { err = PyList_Append(l, k); Py_DECREF(k); if (err) goto done; }
516 if (PyErr_Occurred()) goto done;
519 Py_XDECREF(l); Py_XDECREF(i);
523 PyObject *gmapmeth_values(PyObject *me, PyObject *arg)
525 PyObject *l = 0, *i = 0, *k, *v, *rc = 0;
528 if (!PyArg_ParseTuple(arg, ":values") ||
529 (l = PyList_New(0)) == 0 ||
530 (i = PyObject_GetIter(me)) == 0)
532 while ((k = PyIter_Next(i)) != 0) {
533 if ((v = PyObject_GetItem(me, k)) == 0 ||
536 Py_DECREF(k); Py_XDECREF(v);
539 if (PyErr_Occurred()) goto done;
542 Py_XDECREF(l); Py_XDECREF(i);
546 PyObject *gmapmeth_items(PyObject *me, PyObject *arg)
548 PyObject *l = 0, *i = 0, *k, *v, *z, *rc = 0;
551 if (!PyArg_ParseTuple(arg, ":items") ||
552 (l = PyList_New(0)) == 0 ||
553 (i = PyObject_GetIter(me)) == 0)
555 while ((k = PyIter_Next(i)) != 0) {
557 if ((v = PyObject_GetItem(me, k)) == 0 ||
558 (z = Py_BuildValue("(OO)", k, v)) == 0 ||
561 Py_DECREF(k); Py_XDECREF(v); Py_XDECREF(z);
564 if (PyErr_Occurred()) goto done;
567 Py_XDECREF(l); Py_XDECREF(i);
571 PyObject *gmapmeth_iterkeys(PyObject *me, PyObject *arg)
573 if (!PyArg_ParseTuple(arg, ":iterkeys")) return (0);
574 return (PyObject_GetIter(me));
577 PyObject *gmapmeth_itervalues(PyObject *me, PyObject *arg)
582 if (!PyArg_ParseTuple(arg, ":itervalues") ||
583 (i = PyObject_GetIter(me)) == 0)
585 ii = PyObject_NEW(iter_pyobj, valiter_pytype);
586 ii->map = me; Py_INCREF(me);
588 return ((PyObject *)ii);
591 PyObject *gmapmeth_iteritems(PyObject *me, PyObject *arg)
596 if (!PyArg_ParseTuple(arg, ":iteritems") ||
597 (i = PyObject_GetIter(me)) == 0)
599 ii = PyObject_NEW(iter_pyobj, itemiter_pytype);
600 ii->map = me; Py_INCREF(me);
602 return ((PyObject *)ii);
605 PyObject *gmapmeth_clear(PyObject *me, PyObject *arg)
607 PyObject *i = 0, *k = 0, *rc = 0;
609 if (!PyArg_ParseTuple(arg, ":clear") ||
610 (i = PyObject_GetIter(me)) == 0)
612 while ((k = PyIter_Next(i)) != 0) {
613 PyObject_DelItem(me, k);
616 if (PyErr_Occurred()) goto end;
617 rc = me; Py_INCREF(me);
623 static char *def_kwlist[] = { "key", "default", 0 };
625 PyObject *gmapmeth_get(PyObject *me, PyObject *arg, PyObject *kw)
627 PyObject *k, *def = Py_None, *v;
629 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:get", def_kwlist, &k, &def))
631 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
636 PyObject *gmapmeth_setdefault(PyObject *me, PyObject *arg, PyObject *kw)
638 PyObject *k, *def = Py_None, *v;
640 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:setdefault",
641 def_kwlist, &k, &def))
643 if ((v = PyObject_GetItem(me, k)) != 0) return (v);
645 if (PyObject_SetItem(me, k, def)) return (0);
649 PyObject *gmapmeth_pop(PyObject *me, PyObject *arg, PyObject *kw)
651 PyObject *k, *def = 0, *v;
653 if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO:pop", def_kwlist, &k, &def))
655 if ((v = PyObject_GetItem(me, k)) != 0) {
656 PyObject_DelItem(me, k);
663 PyObject *gmapmeth_update(PyObject *me, PyObject *arg)
665 PyObject *map, *i = 0, *k, *v, *rc = 0;
668 if (!PyArg_ParseTuple(arg, "O:update", &map) ||
669 (i = PyObject_GetIter(map)) == 0)
671 while ((k = PyIter_Next(i)) != 0) {
672 if ((v = PyObject_GetItem(map, k)) == 0 ||
673 PyObject_SetItem(me, k, v))
675 Py_DECREF(k); Py_XDECREF(v);
678 if (PyErr_Occurred()) goto end;
679 rc = me; Py_INCREF(me);
685 PyObject *gmapmeth_popitem(PyObject *me, PyObject *arg)
687 PyObject *i = 0, *k = 0, *v = 0, *rc = 0;
689 if (!PyArg_ParseTuple(arg, ":popitem") ||
690 (i = PyObject_GetIter(me)))
692 if ((k = PyIter_Next(i)) == 0) {
693 if (!PyErr_Occurred()) VALERR("popitem(): mapping is empty");
696 if ((v = PyObject_GetItem(me, k)) == 0 ||
697 PyObject_DelItem(me, k))
699 rc = Py_BuildValue("(OO)", k, v);
701 Py_XDECREF(i); Py_XDECREF(k); Py_XDECREF(v);
705 PyMethodDef gmap_pymethods[] = {
710 /*----- Initialization ----------------------------------------------------*/
712 void util_pyinit(void)
714 modname = PyString_FromString("catacomb");
715 INITTYPE(itemiter, root);
716 INITTYPE(valiter, root);
719 void util_pyinsert(PyObject *mod)
721 INSERT("ItemIter", itemiter_pytype);
722 INSERT("ValueIter", valiter_pytype);
725 /*----- That's all, folks -------------------------------------------------*/