summaryrefslogtreecommitdiff
path: root/plugins/yaml/python/collection.c
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/yaml/python/collection.c')
-rw-r--r--plugins/yaml/python/collection.c370
1 files changed, 370 insertions, 0 deletions
diff --git a/plugins/yaml/python/collection.c b/plugins/yaml/python/collection.c
new file mode 100644
index 0000000..7166784
--- /dev/null
+++ b/plugins/yaml/python/collection.c
@@ -0,0 +1,370 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * collection.c - équivalent Python du fichier "plugins/yaml/collection.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 "collection.h"
+
+
+#include <pygobject.h>
+
+
+#include <plugins/pychrysalide/helpers.h>
+
+
+#include "../collection.h"
+
+
+
+/* Crée un nouvel objet Python de type 'YamlCollection'. */
+static PyObject *py_yaml_collection_new(PyTypeObject *, PyObject *, PyObject *);
+
+/* Recherche les noeuds correspondant à un chemin. */
+static PyObject *py_yaml_collection_find_by_path(PyObject *, PyObject *);
+
+/* Indique la nature d'une collection Yaml. */
+static PyObject *py_yaml_collection_is_sequence(PyObject *, void *);
+
+/* Fournit la liste des noeuds intégrés dans une collection. */
+static PyObject *py_yaml_collection_get_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 'YamlCollection'. *
+* *
+* Retour : Instance Python mise en place. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_collection_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+ PyObject *result; /* Instance à retourner */
+ int seq; /* Indicateur de type */
+ int ret; /* Bilan de lecture des args. */
+ GYamlCollection *collec; /* Création GLib à transmettre */
+
+#define YAML_COLLECTION_DOC \
+ "YamlCollection handle a collection of Yaml nodes.\n" \
+ "\n" \
+ "Instances can be created using the following constructor:\n" \
+ "\n" \
+ " YamlCollection(seq=False)\n" \
+ "\n" \
+ "Where seq defines if the collection will be a sequence or a mapping of nodes."
+
+ ret = PyArg_ParseTuple(args, "p", &seq);
+ if (!ret) return NULL;
+
+ collec = g_yaml_collection_new(seq);
+
+ g_object_ref_sink(G_OBJECT(collec));
+ result = pygobject_new(G_OBJECT(collec));
+ g_object_unref(collec);
+
+ 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_collection_find_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. */
+ GYamlCollection *collec; /* Version GLib du type */
+ GYamlNode **found; /* Créations GLib à transmettre*/
+ size_t count; /* Quantité de trouvailles */
+ size_t i; /* Boucle de parcours */
+
+#define YAML_COLLECTION_FIND_BY_PATH PYTHON_METHOD_DEF \
+( \
+ find_by_path, "path", \
+ METH_VARARGS, py_yaml_collection, \
+ "Find nodes from a Yaml node using a 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;
+
+ collec = G_YAML_COLLEC(pygobject_get(self));
+
+ g_yaml_collection_find_by_path(collec, path, &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 = objet Python concerné par l'appel. *
+* closure = non utilisé ici. *
+* *
+* Description : Fournit la liste des noeuds intégrés dans une collection. *
+* *
+* Retour : Enfants d'un noeud issu d'une collection Yaml. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_collection_get_nodes(PyObject *self, void *closure)
+{
+ PyObject *result; /* Résultat à retourner */
+ GYamlCollection *collec; /* 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_COLLECTION_NODES_ATTRIB PYTHON_GET_DEF_FULL \
+( \
+ nodes, py_yaml_collection, \
+ "List of nodes contained in the current collection." \
+)
+
+ collec = G_YAML_COLLEC(pygobject_get(self));
+
+ nodes = g_yaml_collection_get_nodes(collec, &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 : self = objet Python concerné par l'appel. *
+* closure = non utilisé ici. *
+* *
+* Description : Indique la nature d'une collection Yaml. *
+* *
+* Retour : Nature de la collection. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_collection_is_sequence(PyObject *self, void *closure)
+{
+ PyObject *result; /* Résultat à retourner */
+ GYamlCollection *collec; /* Version GLib du type */
+ bool status; /* Bilan de consultation */
+
+#define YAML_COLLECTION_IS_SEQUENCE_ATTRIB PYTHON_IS_DEF_FULL \
+( \
+ sequence, py_yaml_collection, \
+ "Nature of the collection: True is the collection is a sequence," \
+ " False if it is a mapping of \"key: value\" nodes." \
+)
+
+ collec = G_YAML_COLLEC(pygobject_get(self));
+
+ status = g_yaml_collection_is_sequence(collec);
+
+ result = status ? Py_True : Py_False;
+ Py_INCREF(result);
+
+ 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_collection_type(void)
+{
+ static PyMethodDef py_yaml_collection_methods[] = {
+ YAML_COLLECTION_FIND_BY_PATH,
+ { NULL }
+ };
+
+ static PyGetSetDef py_yaml_collection_getseters[] = {
+ YAML_COLLECTION_IS_SEQUENCE_ATTRIB,
+ YAML_COLLECTION_NODES_ATTRIB,
+ { NULL }
+ };
+
+ static PyTypeObject py_yaml_collection_type = {
+
+ PyVarObject_HEAD_INIT(NULL, 0)
+
+ .tp_name = "pychrysalide.plugins.yaml.YamlCollection",
+ .tp_basicsize = sizeof(PyGObject),
+
+ .tp_flags = Py_TPFLAGS_DEFAULT,
+
+ .tp_doc = YAML_COLLECTION_DOC,
+
+ .tp_methods = py_yaml_collection_methods,
+ .tp_getset = py_yaml_collection_getseters,
+ .tp_new = py_yaml_collection_new
+
+ };
+
+ return &py_yaml_collection_type;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : module = module dont la définition est à compléter. *
+* *
+* Description : Prend en charge l'objet 'pychrysalide.....YamlCollection. *
+* *
+* Retour : Bilan de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+bool register_python_yaml_collection(PyObject *module)
+{
+ PyTypeObject *type; /* Type Python 'YamlCollection'*/
+ PyObject *dict; /* Dictionnaire du module */
+
+ type = get_python_yaml_collection_type();
+
+ dict = PyModule_GetDict(module);
+
+ if (!register_class_for_pygobject(dict, G_TYPE_YAML_COLLEC, 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 collection de noeuds de format Yaml. *
+* *
+* Retour : Bilan de l'opération, voire indications supplémentaires. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+int convert_to_yaml_collection(PyObject *arg, void *dst)
+{
+ int result; /* Bilan à retourner */
+
+ result = PyObject_IsInstance(arg, (PyObject *)get_python_yaml_collection_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 collection");
+ break;
+
+ case 1:
+ *((GYamlCollection **)dst) = G_YAML_COLLEC(pygobject_get(arg));
+ break;
+
+ default:
+ assert(false);
+ break;
+
+ }
+
+ return result;
+
+}
generated by cgit v0.11.2-87-g4458 at 2024-05-03 17:25:31 (GMT)