diff options
Diffstat (limited to 'plugins/yaml/python/tree.c')
-rw-r--r-- | plugins/yaml/python/tree.c | 366 |
1 files changed, 366 insertions, 0 deletions
diff --git a/plugins/yaml/python/tree.c b/plugins/yaml/python/tree.c new file mode 100644 index 0000000..9e1a2a3 --- /dev/null +++ b/plugins/yaml/python/tree.c @@ -0,0 +1,366 @@ + +/* Chrysalide - Outil d'analyse de fichiers binaires + * tree.c - équivalent Python du fichier "plugins/yaml/tree.c" + * + * Copyright (C) 2019 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 le noeud correspondant à un chemin. */ +static PyObject *py_yaml_tree_find_node_by_path(PyObject *, PyObject *); + +/* Fournit la liste des premiers noeuds de l'arborescence Yaml. */ +static PyObject *py_yaml_tree_get_root_nodes(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 */ + Py_ssize_t indent; /* Indice de ligne associée */ + 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 */ + size_t i; /* Boucle de parcours #1 */ + PyObject *item; /* Elément de la liste fournie */ + size_t k; /* Boucle de parcours #2 */ + GYamlTree *tree; /* Création GLib à transmettre */ + +#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(indent, lines)" \ + "\n" \ + "Where indent provides the length of a single level of indentation" \ + " and lines are a tuple of Yaml lines used to built the tree." + + ret = PyArg_ParseTuple(args, "nO!", &indent, &PyTuple_Type, &tuple); + if (!ret) return NULL; + + count = PyTuple_Size(tuple); + + lines = (GYamlLine **)malloc(count * sizeof(GYamlLine *)); + + 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(indent, 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 le noeud correspondant à un chemin. * +* * +* Retour : Eventuel noeud trouvé ou NULL si aucun. * +* * +* Remarques : - * +* * +******************************************************************************/ + +static PyObject *py_yaml_tree_find_node_by_path(PyObject *self, PyObject *args) +{ + PyObject *result; /* Instance à retourner */ + 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_BY_PATH PYTHON_METHOD_DEF \ +( \ + find_node_by_path, "path", \ + METH_VARARGS, py_yaml_tree, \ + "Find a node in a Yaml tree by its path.\n" \ + "\n" \ + "Paths are node keys separated by '/', such as '/my/path/to/node'." \ +) + + ret = PyArg_ParseTuple(args, "s", &path); + if (!ret) return NULL; + + tree = G_YAML_TREE(pygobject_get(self)); + + found = g_yaml_tree_find_node_by_path(tree, path); + + if (found == NULL) + { + result = Py_None; + Py_INCREF(result); + } + + else + { + result = pygobject_new(G_OBJECT(found)); + g_object_unref(found); + } + + return result; + +} + + +/****************************************************************************** +* * +* Paramètres : self = objet Python concerné par l'appel. * +* closure = non utilisé ici. * +* * +* Description : Fournit la liste des premiers noeuds de l'arborescence Yaml. * +* * +* Retour : Noeuds constituant les racines de l'arborescence. * +* * +* Remarques : - * +* * +******************************************************************************/ + +static PyObject *py_yaml_tree_get_root_nodes(PyObject *self, void *closure) +{ + PyObject *result; /* Résultat à retourner */ + GYamlTree *tree; /* Version GLib du type */ + size_t count; /* Quantité de noeuds à traiter*/ + GYamlNode **nodes; /* Liste des noeuds à la racine*/ + size_t i; /* Boucle de parcours */ +#ifndef NDEBUG + int ret; /* Bilan d'une insertion */ +#endif + +#define YAML_TREE_ROOT_NODES_ATTRIB PYTHON_GET_DEF_FULL \ +( \ + root_nodes, py_yaml_tree, \ + "List of Yaml nodes which are the roots of all tree nodes." \ +) + + tree = G_YAML_TREE(pygobject_get(self)); + + nodes = g_yaml_tree_get_root_nodes(tree, &count); + + result = PyTuple_New(count); + + for (i = 0; i < count; i++) + { +#ifndef NDEBUG + ret = PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(nodes[i]))); + assert(ret == 0); +#else + PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(nodes[i]))); +#endif + + g_object_unref(G_OBJECT(nodes[i])); + + } + + free(nodes); + + 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, + { NULL } + }; + + static PyGetSetDef py_yaml_tree_getseters[] = { + YAML_TREE_ROOT_NODES_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; + +} |