Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1 | #include "Python.h" |
Guido van Rossum | e6b90ea | 2001-08-15 18:09:11 +0000 | [diff] [blame] | 2 | #include "structmember.h" |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 3 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 4 | PyDoc_STRVAR(xxsubtype__doc__, |
Tim Peters | 65760b2 | 2001-12-10 22:53:30 +0000 | [diff] [blame] | 5 | "xxsubtype is an example module showing how to subtype builtin types from C.\n" |
| 6 | "test_descr.py in the standard test suite requires it in order to complete.\n" |
| 7 | "If you don't care about the examples, and don't intend to run the Python\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 8 | "test suite, you can recompile Python without Modules/xxsubtype.c."); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 9 | |
Tim Peters | dd5c05f | 2001-12-17 01:27:01 +0000 | [diff] [blame] | 10 | /* We link this module statically for convenience. If compiled as a shared |
| 11 | library instead, some compilers don't allow addresses of Python objects |
| 12 | defined in other libraries to be used in static initializers here. The |
| 13 | DEFERRED_ADDRESS macro is used to tag the slots where such addresses |
| 14 | appear; the module init function must fill in the tagged slots at runtime. |
| 15 | The argument is for documentation -- the macro ignores it. |
| 16 | */ |
| 17 | #define DEFERRED_ADDRESS(ADDR) 0 |
| 18 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 19 | /* spamlist -- a list subtype */ |
| 20 | |
| 21 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 22 | PyListObject list; |
| 23 | int state; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 24 | } spamlistobject; |
| 25 | |
| 26 | static PyObject * |
| 27 | spamlist_getstate(spamlistobject *self, PyObject *args) |
| 28 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 29 | if (!PyArg_ParseTuple(args, ":getstate")) |
| 30 | return NULL; |
| 31 | return PyLong_FromLong(self->state); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 32 | } |
| 33 | |
| 34 | static PyObject * |
| 35 | spamlist_setstate(spamlistobject *self, PyObject *args) |
| 36 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 37 | int state; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 38 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 39 | if (!PyArg_ParseTuple(args, "i:setstate", &state)) |
| 40 | return NULL; |
| 41 | self->state = state; |
| 42 | Py_INCREF(Py_None); |
| 43 | return Py_None; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 44 | } |
| 45 | |
Fred Drake | f841aa6 | 2002-03-28 15:49:54 +0000 | [diff] [blame] | 46 | static PyObject * |
| 47 | spamlist_specialmeth(PyObject *self, PyObject *args, PyObject *kw) |
| 48 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 49 | PyObject *result = PyTuple_New(3); |
Fred Drake | f841aa6 | 2002-03-28 15:49:54 +0000 | [diff] [blame] | 50 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 51 | if (result != NULL) { |
| 52 | if (self == NULL) |
| 53 | self = Py_None; |
| 54 | if (kw == NULL) |
| 55 | kw = Py_None; |
| 56 | Py_INCREF(self); |
| 57 | PyTuple_SET_ITEM(result, 0, self); |
| 58 | Py_INCREF(args); |
| 59 | PyTuple_SET_ITEM(result, 1, args); |
| 60 | Py_INCREF(kw); |
| 61 | PyTuple_SET_ITEM(result, 2, kw); |
| 62 | } |
| 63 | return result; |
Fred Drake | f841aa6 | 2002-03-28 15:49:54 +0000 | [diff] [blame] | 64 | } |
| 65 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 66 | static PyMethodDef spamlist_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 67 | {"getstate", (PyCFunction)spamlist_getstate, METH_VARARGS, |
| 68 | PyDoc_STR("getstate() -> state")}, |
| 69 | {"setstate", (PyCFunction)spamlist_setstate, METH_VARARGS, |
| 70 | PyDoc_STR("setstate(state)")}, |
| 71 | /* These entries differ only in the flags; they are used by the tests |
| 72 | in test.test_descr. */ |
| 73 | {"classmeth", (PyCFunction)spamlist_specialmeth, |
| 74 | METH_VARARGS | METH_KEYWORDS | METH_CLASS, |
| 75 | PyDoc_STR("classmeth(*args, **kw)")}, |
| 76 | {"staticmeth", (PyCFunction)spamlist_specialmeth, |
| 77 | METH_VARARGS | METH_KEYWORDS | METH_STATIC, |
| 78 | PyDoc_STR("staticmeth(*args, **kw)")}, |
| 79 | {NULL, NULL}, |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 80 | }; |
| 81 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 82 | static int |
| 83 | spamlist_init(spamlistobject *self, PyObject *args, PyObject *kwds) |
| 84 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 85 | if (PyList_Type.tp_init((PyObject *)self, args, kwds) < 0) |
| 86 | return -1; |
| 87 | self->state = 0; |
| 88 | return 0; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 89 | } |
| 90 | |
Guido van Rossum | 88dcf03 | 2001-08-15 18:18:58 +0000 | [diff] [blame] | 91 | static PyObject * |
| 92 | spamlist_state_get(spamlistobject *self) |
| 93 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 94 | return PyLong_FromLong(self->state); |
Guido van Rossum | 88dcf03 | 2001-08-15 18:18:58 +0000 | [diff] [blame] | 95 | } |
| 96 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 97 | static PyGetSetDef spamlist_getsets[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 98 | {"state", (getter)spamlist_state_get, NULL, |
| 99 | PyDoc_STR("an int variable for demonstration purposes")}, |
| 100 | {0} |
Guido van Rossum | 88dcf03 | 2001-08-15 18:18:58 +0000 | [diff] [blame] | 101 | }; |
| 102 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 103 | static PyTypeObject spamlist_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 104 | PyVarObject_HEAD_INIT(DEFERRED_ADDRESS(&PyType_Type), 0) |
| 105 | "xxsubtype.spamlist", |
| 106 | sizeof(spamlistobject), |
| 107 | 0, |
| 108 | 0, /* tp_dealloc */ |
| 109 | 0, /* tp_print */ |
| 110 | 0, /* tp_getattr */ |
| 111 | 0, /* tp_setattr */ |
| 112 | 0, /* tp_reserved */ |
| 113 | 0, /* tp_repr */ |
| 114 | 0, /* tp_as_number */ |
| 115 | 0, /* tp_as_sequence */ |
| 116 | 0, /* tp_as_mapping */ |
| 117 | 0, /* tp_hash */ |
| 118 | 0, /* tp_call */ |
| 119 | 0, /* tp_str */ |
| 120 | 0, /* tp_getattro */ |
| 121 | 0, /* tp_setattro */ |
| 122 | 0, /* tp_as_buffer */ |
| 123 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
| 124 | 0, /* tp_doc */ |
| 125 | 0, /* tp_traverse */ |
| 126 | 0, /* tp_clear */ |
| 127 | 0, /* tp_richcompare */ |
| 128 | 0, /* tp_weaklistoffset */ |
| 129 | 0, /* tp_iter */ |
| 130 | 0, /* tp_iternext */ |
| 131 | spamlist_methods, /* tp_methods */ |
| 132 | 0, /* tp_members */ |
| 133 | spamlist_getsets, /* tp_getset */ |
| 134 | DEFERRED_ADDRESS(&PyList_Type), /* tp_base */ |
| 135 | 0, /* tp_dict */ |
| 136 | 0, /* tp_descr_get */ |
| 137 | 0, /* tp_descr_set */ |
| 138 | 0, /* tp_dictoffset */ |
| 139 | (initproc)spamlist_init, /* tp_init */ |
| 140 | 0, /* tp_alloc */ |
| 141 | 0, /* tp_new */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 142 | }; |
| 143 | |
| 144 | /* spamdict -- a dict subtype */ |
| 145 | |
| 146 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 147 | PyDictObject dict; |
| 148 | int state; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 149 | } spamdictobject; |
| 150 | |
| 151 | static PyObject * |
| 152 | spamdict_getstate(spamdictobject *self, PyObject *args) |
| 153 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 154 | if (!PyArg_ParseTuple(args, ":getstate")) |
| 155 | return NULL; |
| 156 | return PyLong_FromLong(self->state); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | static PyObject * |
| 160 | spamdict_setstate(spamdictobject *self, PyObject *args) |
| 161 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 162 | int state; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 163 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 164 | if (!PyArg_ParseTuple(args, "i:setstate", &state)) |
| 165 | return NULL; |
| 166 | self->state = state; |
| 167 | Py_INCREF(Py_None); |
| 168 | return Py_None; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | static PyMethodDef spamdict_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 172 | {"getstate", (PyCFunction)spamdict_getstate, METH_VARARGS, |
| 173 | PyDoc_STR("getstate() -> state")}, |
| 174 | {"setstate", (PyCFunction)spamdict_setstate, METH_VARARGS, |
| 175 | PyDoc_STR("setstate(state)")}, |
| 176 | {NULL, NULL}, |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 177 | }; |
| 178 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 179 | static int |
| 180 | spamdict_init(spamdictobject *self, PyObject *args, PyObject *kwds) |
| 181 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 182 | if (PyDict_Type.tp_init((PyObject *)self, args, kwds) < 0) |
| 183 | return -1; |
| 184 | self->state = 0; |
| 185 | return 0; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 186 | } |
| 187 | |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 188 | static PyMemberDef spamdict_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 189 | {"state", T_INT, offsetof(spamdictobject, state), READONLY, |
| 190 | PyDoc_STR("an int variable for demonstration purposes")}, |
| 191 | {0} |
Guido van Rossum | e6b90ea | 2001-08-15 18:09:11 +0000 | [diff] [blame] | 192 | }; |
| 193 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 194 | static PyTypeObject spamdict_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 195 | PyVarObject_HEAD_INIT(DEFERRED_ADDRESS(&PyType_Type), 0) |
| 196 | "xxsubtype.spamdict", |
| 197 | sizeof(spamdictobject), |
| 198 | 0, |
| 199 | 0, /* tp_dealloc */ |
| 200 | 0, /* tp_print */ |
| 201 | 0, /* tp_getattr */ |
| 202 | 0, /* tp_setattr */ |
| 203 | 0, /* tp_reserved */ |
| 204 | 0, /* tp_repr */ |
| 205 | 0, /* tp_as_number */ |
| 206 | 0, /* tp_as_sequence */ |
| 207 | 0, /* tp_as_mapping */ |
| 208 | 0, /* tp_hash */ |
| 209 | 0, /* tp_call */ |
| 210 | 0, /* tp_str */ |
| 211 | 0, /* tp_getattro */ |
| 212 | 0, /* tp_setattro */ |
| 213 | 0, /* tp_as_buffer */ |
| 214 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
| 215 | 0, /* tp_doc */ |
| 216 | 0, /* tp_traverse */ |
| 217 | 0, /* tp_clear */ |
| 218 | 0, /* tp_richcompare */ |
| 219 | 0, /* tp_weaklistoffset */ |
| 220 | 0, /* tp_iter */ |
| 221 | 0, /* tp_iternext */ |
| 222 | spamdict_methods, /* tp_methods */ |
| 223 | spamdict_members, /* tp_members */ |
| 224 | 0, /* tp_getset */ |
| 225 | DEFERRED_ADDRESS(&PyDict_Type), /* tp_base */ |
| 226 | 0, /* tp_dict */ |
| 227 | 0, /* tp_descr_get */ |
| 228 | 0, /* tp_descr_set */ |
| 229 | 0, /* tp_dictoffset */ |
| 230 | (initproc)spamdict_init, /* tp_init */ |
| 231 | 0, /* tp_alloc */ |
| 232 | 0, /* tp_new */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 233 | }; |
| 234 | |
Neil Schemenauer | 2677512 | 2001-10-21 22:26:43 +0000 | [diff] [blame] | 235 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 236 | spam_bench(PyObject *self, PyObject *args) |
| 237 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 238 | PyObject *obj, *name, *res; |
| 239 | int n = 1000; |
| 240 | time_t t0, t1; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 241 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 242 | if (!PyArg_ParseTuple(args, "OS|i", &obj, &name, &n)) |
| 243 | return NULL; |
| 244 | t0 = clock(); |
| 245 | while (--n >= 0) { |
| 246 | res = PyObject_GetAttr(obj, name); |
| 247 | if (res == NULL) |
| 248 | return NULL; |
| 249 | Py_DECREF(res); |
| 250 | } |
| 251 | t1 = clock(); |
| 252 | return PyFloat_FromDouble((double)(t1-t0) / CLOCKS_PER_SEC); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | static PyMethodDef xxsubtype_functions[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 256 | {"bench", spam_bench, METH_VARARGS}, |
| 257 | {NULL, NULL} /* sentinel */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 258 | }; |
| 259 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 260 | static struct PyModuleDef xxsubtypemodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 261 | PyModuleDef_HEAD_INIT, |
| 262 | "xxsubtype", |
| 263 | xxsubtype__doc__, |
| 264 | -1, |
| 265 | xxsubtype_functions, |
| 266 | NULL, |
| 267 | NULL, |
| 268 | NULL, |
| 269 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 270 | }; |
| 271 | |
| 272 | |
Mark Hammond | fe51c6d | 2002-08-02 02:27:13 +0000 | [diff] [blame] | 273 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 274 | PyInit_xxsubtype(void) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 275 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 276 | PyObject *m; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 277 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 278 | /* Fill in deferred data addresses. This must be done before |
| 279 | PyType_Ready() is called. Note that PyType_Ready() automatically |
| 280 | initializes the ob.ob_type field to &PyType_Type if it's NULL, |
| 281 | so it's not necessary to fill in ob_type first. */ |
| 282 | spamdict_type.tp_base = &PyDict_Type; |
| 283 | if (PyType_Ready(&spamdict_type) < 0) |
| 284 | return NULL; |
Tim Peters | dd5c05f | 2001-12-17 01:27:01 +0000 | [diff] [blame] | 285 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 286 | spamlist_type.tp_base = &PyList_Type; |
| 287 | if (PyType_Ready(&spamlist_type) < 0) |
| 288 | return NULL; |
Tim Peters | dd5c05f | 2001-12-17 01:27:01 +0000 | [diff] [blame] | 289 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 290 | m = PyModule_Create(&xxsubtypemodule); |
| 291 | if (m == NULL) |
| 292 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 293 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 294 | if (PyType_Ready(&spamlist_type) < 0) |
| 295 | return NULL; |
| 296 | if (PyType_Ready(&spamdict_type) < 0) |
| 297 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 298 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 299 | Py_INCREF(&spamlist_type); |
| 300 | if (PyModule_AddObject(m, "spamlist", |
| 301 | (PyObject *) &spamlist_type) < 0) |
| 302 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 303 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 304 | Py_INCREF(&spamdict_type); |
| 305 | if (PyModule_AddObject(m, "spamdict", |
| 306 | (PyObject *) &spamdict_type) < 0) |
| 307 | return NULL; |
| 308 | return m; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 309 | } |