2 * collectd - src/pyconfig.c
3 * Copyright (C) 2009 Sven Trenkel
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Sven Trenkel <collectd at semidefinite.de>
28 #include <structmember.h>
36 static char config_doc[] = "This represents a piece of collectd's config file.\n"
37 "It is passed to scripts with config callbacks (see \"register_config\")\n"
38 "and is of little use if created somewhere else.\n"
40 "It has no methods beyond the bare minimum and only exists for its\n"
43 static char parent_doc[] = "This represents the parent of this node. On the root node\n"
44 "of the config tree it will be None.\n";
46 static char key_doc[] = "This is the keyword of this item, ie the first word of any\n"
47 "given line in the config file. It will always be a string.\n";
49 static char values_doc[] = "This is a tuple (which might be empty) of all value, ie words\n"
50 "following the keyword in any given line in the config file.\n"
52 "Every item in this tuple will be either a string or a float or a bool,\n"
53 "depending on the contents of the configuration file.\n";
55 static char children_doc[] = "This is a tuple of child nodes. For most nodes this will be\n"
56 "empty. If this node represents a block instead of a single line of the config\n"
57 "file it will contain all nodes in this block.\n";
59 static PyObject *Config_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
62 self = (Config *) type->tp_alloc(type, 0);
69 self->children = NULL;
70 return (PyObject *) self;
73 static int Config_init(PyObject *s, PyObject *args, PyObject *kwds) {
74 PyObject *key = NULL, *parent = NULL, *values = NULL, *children = NULL, *tmp;
75 Config *self = (Config *) s;
76 static char *kwlist[] = {"key", "parent", "values", "children", NULL};
78 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|OOO", kwlist,
79 &key, &parent, &values, &children))
82 if (!IS_BYTES_OR_UNICODE(key)) {
83 PyErr_SetString(PyExc_TypeError, "argument 1 must be str");
90 values = PyTuple_New(0);
93 if (children == NULL) {
94 children = PyTuple_New(0);
101 if (parent != NULL) {
104 self->parent = parent;
107 if (values != NULL) {
110 self->values = values;
113 if (children != NULL) {
114 tmp = self->children;
116 self->children = children;
122 static PyObject *Config_repr(PyObject *s) {
123 Config *self = (Config *) s;
124 PyObject *ret = NULL;
125 static PyObject *node_prefix = NULL, *root_prefix = NULL, *ending = NULL;
127 /* This is ok because we have the GIL, so this is thread-save by default. */
128 if (node_prefix == NULL)
129 node_prefix = cpy_string_to_unicode_or_bytes("<collectd.Config node ");
130 if (root_prefix == NULL)
131 root_prefix = cpy_string_to_unicode_or_bytes("<collectd.Config root node ");
133 ending = cpy_string_to_unicode_or_bytes(">");
134 if (node_prefix == NULL || root_prefix == NULL || ending == NULL)
137 ret = PyObject_Str(self->key);
138 CPY_SUBSTITUTE(PyObject_Repr, ret, ret);
139 if (self->parent == NULL || self->parent == Py_None)
140 CPY_STRCAT(&ret, root_prefix);
142 CPY_STRCAT(&ret, node_prefix);
143 CPY_STRCAT(&ret, ending);
148 static int Config_traverse(PyObject *self, visitproc visit, void *arg) {
149 Config *c = (Config *) self;
153 Py_VISIT(c->children);
156 static int Config_clear(PyObject *self) {
157 Config *c = (Config *) self;
161 Py_CLEAR(c->children);
165 static void Config_dealloc(PyObject *self) {
167 self->ob_type->tp_free(self);
170 static PyMemberDef Config_members[] = {
171 {"parent", T_OBJECT, offsetof(Config, parent), 0, parent_doc},
172 {"key", T_OBJECT_EX, offsetof(Config, key), 0, key_doc},
173 {"values", T_OBJECT_EX, offsetof(Config, values), 0, values_doc},
174 {"children", T_OBJECT_EX, offsetof(Config, children), 0, children_doc},
178 PyTypeObject ConfigType = {
180 "collectd.Config", /* tp_name */
181 sizeof(Config), /* tp_basicsize */
182 0, /* Will be filled in later */
183 Config_dealloc, /* tp_dealloc */
188 Config_repr, /* tp_repr */
189 0, /* tp_as_number */
190 0, /* tp_as_sequence */
191 0, /* tp_as_mapping */
197 0, /* tp_as_buffer */
198 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
199 config_doc, /* tp_doc */
200 Config_traverse, /* tp_traverse */
201 Config_clear, /* tp_clear */
202 0, /* tp_richcompare */
203 0, /* tp_weaklistoffset */
207 Config_members, /* tp_members */
211 0, /* tp_descr_get */
212 0, /* tp_descr_set */
213 0, /* tp_dictoffset */
214 Config_init, /* tp_init */
216 Config_new /* tp_new */