1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
/* Chrysalide - Outil d'analyse de fichiers binaires
* tree.c - équivalent Python du fichier "plugins/yaml/tree.c"
*
* Copyright (C) 2019-2020 Cyrille Bagard
*
* This file is part of Chrysalide.
*
* Chrysalide is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Chrysalide is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "tree.h"
#include <pygobject.h>
#include <i18n.h>
#include <plugins/pychrysalide/helpers.h>
#include "line.h"
#include "../tree.h"
/* Crée un nouvel objet Python de type 'YamlTree'. */
static PyObject *py_yaml_tree_new(PyTypeObject *, PyObject *, PyObject *);
/* Recherche les noeuds correspondant à un chemin. */
static PyObject *py_yaml_tree_find_by_path(PyObject *, PyObject *);
/* Fournit le noeud constituant la racine d'arborescence Yaml. */
static PyObject *py_yaml_tree_get_root(PyObject *, void *);
/******************************************************************************
* *
* Paramètres : type = type de l'objet à instancier. *
* args = arguments fournis à l'appel. *
* kwds = arguments de type key=val fournis. *
* *
* Description : Crée un nouvel objet Python de type 'YamlTree'. *
* *
* Retour : Instance Python mise en place. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_yaml_tree_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
PyObject *result; /* Instance à retourner */
PyObject *tuple; /* Liste de lignes Yaml */
int ret; /* Bilan de lecture des args. */
size_t count; /* Nombre d'éléments présents */
GYamlLine **lines; /* Lignes au format Yaml */
GYamlTree *tree; /* Création GLib à transmettre */
size_t i; /* Boucle de parcours #1 */
PyObject *item; /* Elément de la liste fournie */
size_t k; /* Boucle de parcours #2 */
#define YAML_TREE_DOC \
"YamlTree offers a hierarchical access to Yaml lines as a tree.\n" \
"\n" \
"Instances can be created using the following constructor:\n" \
"\n" \
" YamlTree(lines)" \
"\n" \
"Where lines are a tuple of Yaml lines used to built the tree."
ret = PyArg_ParseTuple(args, "O!", &PyTuple_Type, &tuple);
if (!ret) return NULL;
count = PyTuple_Size(tuple);
lines = (GYamlLine **)malloc(count * sizeof(GYamlLine *));
tree = NULL;
for (i = 0; i < count; i++)
{
item = PyTuple_GetItem(tuple, i);
ret = convert_to_yaml_line(item, &lines[i]);
if (ret == 0)
g_object_ref(G_OBJECT(lines[i]));
else
goto arg_error;
}
tree = g_yaml_tree_new(lines, count);
arg_error:
for (k = 0; k < i; k++)
g_object_unref(G_OBJECT(lines[i]));
free(lines);
/* S'il y a eu une erreur... */
if (i < count) return NULL;
if (tree == NULL)
{
result = Py_None;
Py_INCREF(result);
}
else
{
g_object_ref_sink(G_OBJECT(tree));
result = pygobject_new(G_OBJECT(tree));
g_object_unref(tree);
}
return result;
}
/******************************************************************************
* *
* Paramètres : self = variable non utilisée ici. *
* args = arguments fournis à l'appel. *
* *
* Description : Recherche les noeuds correspondant à un chemin. *
* *
* Retour : Liste de noeuds trouvés, éventuellement vide. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_yaml_tree_find_by_path(PyObject *self, PyObject *args)
{
PyObject *result; /* Instance à retourner */
int prepare; /* Orientation des résultats */
const char *path; /* Chemin d'accès à traiter */
int ret; /* Bilan de lecture des args. */
GYamlTree *tree; /* Version GLib du type */
GYamlNode **found; /* Créations GLib à transmettre*/
size_t count; /* Quantité de trouvailles */
size_t i; /* Boucle de parcours */
#define YAML_TREE_FIND_BY_PATH PYTHON_METHOD_DEF \
( \
find_by_path, "path, /, prepare=False", \
METH_VARARGS, py_yaml_tree, \
"Find nodes in a Yaml tree using a path.\n" \
"\n" \
"Paths are node keys separated by '/', such as '/my/path/to/node'." \
"\n" \
"In case where the path ends with a trailing '/', the operation can" \
" be used to prepare a further look by returning a node which can be" \
" searched by a new call to this function instead of returning all its" \
" contained nodes." \
)
prepare = 0;
ret = PyArg_ParseTuple(args, "s|p", &path, &prepare);
if (!ret) return NULL;
tree = G_YAML_TREE(pygobject_get(self));
g_yaml_tree_find_by_path(tree, path, prepare, &found, &count);
result = PyTuple_New(count);
for (i = 0; i < count; i++)
{
#ifndef NDEBUG
ret = PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(found[i])));
assert(ret == 0);
#else
PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(found[i])));
#endif
g_object_unref(G_OBJECT(found[i]));
}
if (found != NULL)
free(found);
return result;
}
/******************************************************************************
* *
* Paramètres : self = variable non utilisée ici. *
* args = arguments fournis à l'appel. *
* *
* Description : Recherche l'unique noeud correspondant à un chemin. *
* *
* Retour : Noeud avec correspondance établie ou None. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_yaml_tree_find_one_by_path(PyObject *self, PyObject *args)
{
PyObject *result; /* Instance à retourner */
int prepare; /* Orientation des résultats */
const char *path; /* Chemin d'accès à traiter */
int ret; /* Bilan de lecture des args. */
GYamlTree *tree; /* Version GLib du type */
GYamlNode *found; /* Création GLib à transmettre */
#define YAML_TREE_FIND_ONE_BY_PATH PYTHON_METHOD_DEF \
( \
find_one_by_path, "path, /, prepare=False", \
METH_VARARGS, py_yaml_tree, \
"Find a given node from a Yaml node using a path.\n" \
"\n" \
"Paths are node keys separated by '/', such as '/my/path/to/node'." \
"\n" \
"Only one node has to match the path for the function success." \
"\n" \
"In case where the path ends with a trailing '/', the operation can" \
" be used to prepare a further look by returning a node which can be" \
" searched by a new call to this function instead of returning all its" \
" contained nodes." \
)
prepare = 0;
ret = PyArg_ParseTuple(args, "s|p", &path, &prepare);
if (!ret) return NULL;
tree = G_YAML_TREE(pygobject_get(self));
found = g_yaml_tree_find_one_by_path(tree, path, prepare);
if (found == NULL)
{
result = Py_None;
Py_INCREF(result);
}
else
{
result = pygobject_new(G_OBJECT(found));
g_object_unref(G_OBJECT(found));
}
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Fournit le noeud constituant la racine d'arborescence Yaml. *
* *
* Retour : Noeud constituant la racine de l'arborescence. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_yaml_tree_get_root(PyObject *self, void *closure)
{
PyObject *result; /* Résultat à retourner */
GYamlTree *tree; /* Version GLib du type */
GYamlNode *root; /* Noeud racine d'arborescence */
#define YAML_TREE_ROOT_ATTRIB PYTHON_GET_DEF_FULL \
( \
root, py_yaml_tree, \
"Yaml node which is the root of the whole tree nodes." \
)
tree = G_YAML_TREE(pygobject_get(self));
root = g_yaml_tree_get_root(tree);
result = pygobject_new(G_OBJECT(root));
g_object_unref(G_OBJECT(root));
return result;
}
/******************************************************************************
* *
* Paramètres : - *
* *
* Description : Fournit un accès à une définition de type à diffuser. *
* *
* Retour : Définition d'objet pour Python. *
* *
* Remarques : - *
* *
******************************************************************************/
PyTypeObject *get_python_yaml_tree_type(void)
{
static PyMethodDef py_yaml_tree_methods[] = {
YAML_TREE_FIND_BY_PATH,
YAML_TREE_FIND_ONE_BY_PATH,
{ NULL }
};
static PyGetSetDef py_yaml_tree_getseters[] = {
YAML_TREE_ROOT_ATTRIB,
{ NULL }
};
static PyTypeObject py_yaml_tree_type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "pychrysalide.plugins.yaml.YamlTree",
.tp_basicsize = sizeof(PyGObject),
.tp_flags = Py_TPFLAGS_DEFAULT,
.tp_doc = YAML_TREE_DOC,
.tp_methods = py_yaml_tree_methods,
.tp_getset = py_yaml_tree_getseters,
.tp_new = py_yaml_tree_new
};
return &py_yaml_tree_type;
}
/******************************************************************************
* *
* Paramètres : module = module dont la définition est à compléter. *
* *
* Description : Prend en charge l'objet 'pychrysalide.plugins.....YamlTree. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool register_python_yaml_tree(PyObject *module)
{
PyTypeObject *type; /* Type Python 'YamlTree' */
PyObject *dict; /* Dictionnaire du module */
type = get_python_yaml_tree_type();
dict = PyModule_GetDict(module);
if (!register_class_for_pygobject(dict, G_TYPE_YAML_TREE, type, &PyGObject_Type))
return false;
return true;
}
/******************************************************************************
* *
* Paramètres : arg = argument quelconque à tenter de convertir. *
* dst = destination des valeurs récupérées en cas de succès. *
* *
* Description : Tente de convertir en arborescence de lignes au format Yaml. *
* *
* Retour : Bilan de l'opération, voire indications supplémentaires. *
* *
* Remarques : - *
* *
******************************************************************************/
int convert_to_yaml_tree(PyObject *arg, void *dst)
{
int result; /* Bilan à retourner */
result = PyObject_IsInstance(arg, (PyObject *)get_python_yaml_tree_type());
switch (result)
{
case -1:
/* L'exception est déjà fixée par Python */
result = 0;
break;
case 0:
PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to Yaml tree");
break;
case 1:
*((GYamlTree **)dst) = G_YAML_TREE(pygobject_get(arg));
break;
default:
assert(false);
break;
}
return result;
}
|
