summaryrefslogtreecommitdiff
path: root/plugins/yaml/python
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/yaml/python')
-rw-r--r--plugins/yaml/python/Makefile.am1
-rw-r--r--plugins/yaml/python/collection.c71
-rw-r--r--plugins/yaml/python/module.c4
-rw-r--r--plugins/yaml/python/node.c237
-rw-r--r--plugins/yaml/python/scalar.c353
-rw-r--r--plugins/yaml/python/scalar.h45
-rw-r--r--plugins/yaml/python/tree.c78
7 files changed, 512 insertions, 277 deletions
diff --git a/plugins/yaml/python/Makefile.am b/plugins/yaml/python/Makefile.am
index a750343..8d6ddaa 100644
--- a/plugins/yaml/python/Makefile.am
+++ b/plugins/yaml/python/Makefile.am
@@ -7,6 +7,7 @@ libyamlpython_la_SOURCES = \
module.h module.c \
node.h node.c \
reader.h reader.c \
+ scalar.h scalar.c \
tree.h tree.c
libyamlpython_la_LDFLAGS =
diff --git a/plugins/yaml/python/collection.c b/plugins/yaml/python/collection.c
index 7166784..e21bb9e 100644
--- a/plugins/yaml/python/collection.c
+++ b/plugins/yaml/python/collection.c
@@ -31,6 +31,7 @@
#include <plugins/pychrysalide/helpers.h>
+#include "node.h"
#include "../collection.h"
@@ -38,9 +39,6 @@
/* 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 *);
@@ -71,7 +69,7 @@ static PyObject *py_yaml_collection_new(PyTypeObject *type, PyObject *args, PyOb
GYamlCollection *collec; /* Création GLib à transmettre */
#define YAML_COLLECTION_DOC \
- "YamlCollection handle a collection of Yaml nodes.\n" \
+ "YamlCollection handles a collection of Yaml nodes.\n" \
"\n" \
"Instances can be created using the following constructor:\n" \
"\n" \
@@ -95,68 +93,6 @@ static PyObject *py_yaml_collection_new(PyTypeObject *type, PyObject *args, PyOb
/******************************************************************************
* *
-* 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. *
* *
@@ -264,7 +200,6 @@ static PyObject *py_yaml_collection_is_sequence(PyObject *self, void *closure)
PyTypeObject *get_python_yaml_collection_type(void)
{
static PyMethodDef py_yaml_collection_methods[] = {
- YAML_COLLECTION_FIND_BY_PATH,
{ NULL }
};
@@ -317,7 +252,7 @@ bool register_python_yaml_collection(PyObject *module)
dict = PyModule_GetDict(module);
- if (!register_class_for_pygobject(dict, G_TYPE_YAML_COLLEC, type, &PyGObject_Type))
+ if (!register_class_for_pygobject(dict, G_TYPE_YAML_COLLEC, type, get_python_yaml_node_type()))
return false;
return true;
diff --git a/plugins/yaml/python/module.c b/plugins/yaml/python/module.c
index 2a4401e..0726dc4 100644
--- a/plugins/yaml/python/module.c
+++ b/plugins/yaml/python/module.c
@@ -37,6 +37,7 @@
#include "line.h"
#include "node.h"
#include "reader.h"
+#include "scalar.h"
#include "tree.h"
@@ -109,10 +110,11 @@ bool populate_yaml_module(void)
module = get_access_to_python_module("pychrysalide.plugins.yaml");
+ if (result) result = register_python_yaml_node(module);
if (result) result = register_python_yaml_collection(module);
if (result) result = register_python_yaml_line(module);
- if (result) result = register_python_yaml_node(module);
if (result) result = register_python_yaml_reader(module);
+ if (result) result = register_python_yaml_scalar(module);
if (result) result = register_python_yaml_tree(module);
assert(result);
diff --git a/plugins/yaml/python/node.c b/plugins/yaml/python/node.c
index 17aa065..31daa04 100644
--- a/plugins/yaml/python/node.c
+++ b/plugins/yaml/python/node.c
@@ -37,8 +37,14 @@
-/* Crée un nouvel objet Python de type 'YamlNode'. */
-static PyObject *py_yaml_node_new(PyTypeObject *, PyObject *, PyObject *);
+#define YAML_NODE_DOC \
+ "YamlNode handles a node in a Yaml tree.\n" \
+ "\n" \
+ "There are three kinds of node contents defined in the Yaml specifications:\n" \
+ "* scalar, implemented by the pychrysalide.plugins.yaml.YamlScalar object.\n" \
+ "* sequence and mapping, implemented by the pychrysalide.plugins.yaml.YamlCollection object."
+
+
/* Recherche les noeuds correspondant à un chemin. */
static PyObject *py_yaml_node_find_by_path(PyObject *, PyObject *);
@@ -46,59 +52,6 @@ static PyObject *py_yaml_node_find_by_path(PyObject *, PyObject *);
/* Recherche l'unique noeud correspondant à un chemin. */
static PyObject *py_yaml_node_find_one_by_path(PyObject *, PyObject *);
-/* Fournit la ligne principale associée à un noeud. */
-static PyObject *py_yaml_node_get_yaml_line(PyObject *, void *);
-
-/* Attache une collection de noeuds Yaml à un noeud. */
-static int py_yaml_node_set_collection(PyObject *, PyObject *, void *);
-
-/* Fournit une éventuelle collection rattachée à un noeud. */
-static PyObject *py_yaml_node_get_collection(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 'YamlNode'. *
-* *
-* Retour : Instance Python mise en place. *
-* *
-* Remarques : - *
-* *
-******************************************************************************/
-
-static PyObject *py_yaml_node_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
-{
- PyObject *result; /* Instance à retourner */
- GYamlLine *key; /* Ligne principale du noeud */
- int ret; /* Bilan de lecture des args. */
- GYamlNode *node; /* Création GLib à transmettre */
-
-#define YAML_NODE_DOC \
- "YamlNode handle a node in a Yaml tree.\n" \
- "\n" \
- "Instances can be created using the following constructor:\n" \
- "\n" \
- " YamlNode(key)\n" \
- "\n" \
- "Where key is the main Yaml line for the node."
-
- ret = PyArg_ParseTuple(args, "O&", &convert_to_yaml_line, &key);
- if (!ret) return NULL;
-
- node = g_yaml_node_new(key);
-
- g_object_ref_sink(G_OBJECT(node));
- result = pygobject_new(G_OBJECT(node));
- g_object_unref(node);
-
- return result;
-
-}
/******************************************************************************
@@ -117,6 +70,7 @@ static PyObject *py_yaml_node_new(PyTypeObject *type, PyObject *args, PyObject *
static PyObject *py_yaml_node_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. */
GYamlNode *node; /* Version GLib du noeud */
@@ -126,19 +80,26 @@ static PyObject *py_yaml_node_find_by_path(PyObject *self, PyObject *args)
#define YAML_NODE_FIND_BY_PATH PYTHON_METHOD_DEF \
( \
- find_by_path, "path", \
+ find_by_path, "path, /, prepare=False", \
METH_VARARGS, py_yaml_node, \
"Find nodes from a Yaml node 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." \
)
- ret = PyArg_ParseTuple(args, "s", &path);
+ prepare = 0;
+
+ ret = PyArg_ParseTuple(args, "s|p", &path, &prepare);
if (!ret) return NULL;
node = G_YAML_NODE(pygobject_get(self));
- g_yaml_node_find_by_path(node, path, &found, &count);
+ g_yaml_node_find_by_path(node, path, prepare, &found, &count);
result = PyTuple_New(count);
@@ -179,6 +140,7 @@ static PyObject *py_yaml_node_find_by_path(PyObject *self, PyObject *args)
static PyObject *py_yaml_node_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. */
GYamlNode *node; /* Version GLib du noeud */
@@ -186,21 +148,28 @@ static PyObject *py_yaml_node_find_one_by_path(PyObject *self, PyObject *args)
#define YAML_NODE_FIND_ONE_BY_PATH PYTHON_METHOD_DEF \
( \
- find_one_by_path, "path", \
+ find_one_by_path, "path, /, prepare=False", \
METH_VARARGS, py_yaml_node, \
"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." \
)
- ret = PyArg_ParseTuple(args, "s", &path);
+ prepare = 0;
+
+ ret = PyArg_ParseTuple(args, "s|p", &path, &prepare);
if (!ret) return NULL;
node = G_YAML_NODE(pygobject_get(self));
- found = g_yaml_node_find_one_by_path(node, path);
+ found = g_yaml_node_find_one_by_path(node, path, prepare);
if (found == NULL)
{
@@ -220,146 +189,6 @@ static PyObject *py_yaml_node_find_one_by_path(PyObject *self, PyObject *args)
/******************************************************************************
* *
-* Paramètres : self = objet Python concerné par l'appel. *
-* closure = non utilisé ici. *
-* *
-* Description : Fournit la ligne principale associée à un noeud. *
-* *
-* Retour : Ligne Yaml à l'origine du noeud. *
-* *
-* Remarques : - *
-* *
-******************************************************************************/
-
-static PyObject *py_yaml_node_get_yaml_line(PyObject *self, void *closure)
-{
- PyObject *result; /* Résultat à retourner */
- GYamlNode *node; /* Version GLib du noeud */
- GYamlLine *line; /* Line Yaml associée */
-
-#define YAML_NODE_YAML_LINE_ATTRIB PYTHON_GET_DEF_FULL \
-( \
- yaml_line, py_yaml_node, \
- "Orginal Yaml line linked to the node." \
-)
-
- node = G_YAML_NODE(pygobject_get(self));
-
- line = g_yaml_node_get_yaml_line(node);
-
- if (line == NULL)
- {
- result = Py_None;
- Py_INCREF(result);
- }
- else
- {
- result = pygobject_new(G_OBJECT(line));
- g_object_unref(G_OBJECT(line));
- }
-
- return result;
-
-}
-
-
-
-
-
-/******************************************************************************
-* *
-* Paramètres : self = contenu binaire à manipuler. *
-* value = collection de noeuds Yaml. *
-* closure = adresse non utilisée ici. *
-* *
-* Description : Attache une collection de noeuds Yaml à un noeud. *
-* *
-* Retour : Jeu d'attributs liés au contenu courant. *
-* *
-* Remarques : - *
-* *
-******************************************************************************/
-
-static int py_yaml_node_set_collection(PyObject *self, PyObject *value, void *closure)
-{
- int result; /* Bilan à renvoyer */
- GYamlNode *node; /* Version GLib du noeud */
- GYamlCollection *collec; /* Version GLib de la valeur */
-
- node = G_YAML_NODE(pygobject_get(self));
-
- if (value == Py_None)
- {
- g_yaml_node_set_collection(node, NULL);
- result = 0;
- }
-
- else
- {
- if (!convert_to_yaml_collection(value, &collec))
- result = -1;
-
- else
- {
- g_yaml_node_set_collection(node, collec);
- result = 0;
- }
-
- }
-
- return result;
-
-}
-
-
-/******************************************************************************
-* *
-* Paramètres : self = contenu binaire à manipuler. *
-* closure = adresse non utilisée ici. *
-* *
-* Description : Fournit une éventuelle collection rattachée à un noeud. *
-* *
-* Retour : Collection de noeuds Yaml ou None. *
-* *
-* Remarques : - *
-* *
-******************************************************************************/
-
-static PyObject *py_yaml_node_get_collection(PyObject *self, void *closure)
-{
- PyObject *result; /* Instance à retourner */
- GYamlNode *node; /* Version GLib du noeud */
- GYamlCollection *collec; /* Collection à transmettre */
-
-#define YAML_NODE_COLLECTION_ATTRIB PYTHON_GETSET_DEF_FULL \
-( \
- collection, py_yaml_node, \
- "Provide or define the collection of nodes attached to another Yaml node." \
-)
-
- node = G_YAML_NODE(pygobject_get(self));
-
- collec = g_yaml_node_get_collection(node);
-
- if (collec == NULL)
- {
- result = Py_None;
- Py_INCREF(result);
- }
-
- else
- {
- result = pygobject_new(G_OBJECT(collec));
- g_object_unref(collec);
- }
-
- return result;
-
-}
-
-
-/******************************************************************************
-* *
* Paramètres : - *
* *
* Description : Fournit un accès à une définition de type à diffuser. *
@@ -379,8 +208,6 @@ PyTypeObject *get_python_yaml_node_type(void)
};
static PyGetSetDef py_yaml_node_getseters[] = {
- YAML_NODE_YAML_LINE_ATTRIB,
- YAML_NODE_COLLECTION_ATTRIB,
{ NULL }
};
@@ -391,13 +218,13 @@ PyTypeObject *get_python_yaml_node_type(void)
.tp_name = "pychrysalide.plugins.yaml.YamlNode",
.tp_basicsize = sizeof(PyGObject),
- .tp_flags = Py_TPFLAGS_DEFAULT,
+ .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_IS_ABSTRACT | Py_TPFLAGS_BASETYPE,
.tp_doc = YAML_NODE_DOC,
.tp_methods = py_yaml_node_methods,
.tp_getset = py_yaml_node_getseters,
- .tp_new = py_yaml_node_new
+ .tp_new = no_python_constructor_allowed
};
diff --git a/plugins/yaml/python/scalar.c b/plugins/yaml/python/scalar.c
new file mode 100644
index 0000000..ee38edf
--- /dev/null
+++ b/plugins/yaml/python/scalar.c
@@ -0,0 +1,353 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * scalar.c - équivalent Python du fichier "plugins/yaml/scalar.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 "scalar.h"
+
+
+#include <pygobject.h>
+
+
+#include <plugins/pychrysalide/helpers.h>
+
+
+#include "collection.h"
+#include "line.h"
+#include "node.h"
+#include "../scalar.h"
+
+
+
+/* Crée un nouvel objet Python de type 'YamlScalar'. */
+static PyObject *py_yaml_scalar_new(PyTypeObject *, PyObject *, PyObject *);
+
+/* Fournit la ligne principale associée à un noeud. */
+static PyObject *py_yaml_scalar_get_yaml_line(PyObject *, void *);
+
+/* Attache une collection de noeuds Yaml à un noeud. */
+static int py_yaml_scalar_set_collection(PyObject *, PyObject *, void *);
+
+/* Fournit une éventuelle collection rattachée à un noeud. */
+static PyObject *py_yaml_scalar_get_collection(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 'YamlScalar'. *
+* *
+* Retour : Instance Python mise en place. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_scalar_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+ PyObject *result; /* Instance à retourner */
+ GYamlLine *key; /* Ligne principale du noeud */
+ int ret; /* Bilan de lecture des args. */
+ GYamlScalar *node; /* Création GLib à transmettre */
+
+#define YAML_SCALAR_DOC \
+ "YamlScalar handles a scalar node in a Yaml tree.\n" \
+ "\n" \
+ "Instances can be created using the following constructor:\n" \
+ "\n" \
+ " YamlScalar(key)\n" \
+ "\n" \
+ "Where key is the main Yaml line for the scalar."
+
+ ret = PyArg_ParseTuple(args, "O&", &convert_to_yaml_line, &key);
+ if (!ret) return NULL;
+
+ node = g_yaml_scalar_new(key);
+
+ g_object_ref_sink(G_OBJECT(node));
+ result = pygobject_new(G_OBJECT(node));
+ g_object_unref(node);
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = objet Python concerné par l'appel. *
+* closure = non utilisé ici. *
+* *
+* Description : Fournit la ligne principale associée à un noeud. *
+* *
+* Retour : Ligne Yaml à l'origine du noeud. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_scalar_get_yaml_line(PyObject *self, void *closure)
+{
+ PyObject *result; /* Résultat à retourner */
+ GYamlScalar *node; /* Version GLib du noeud */
+ GYamlLine *line; /* Line Yaml associée */
+
+#define YAML_SCALAR_YAML_LINE_ATTRIB PYTHON_GET_DEF_FULL \
+( \
+ yaml_line, py_yaml_scalar, \
+ "Orginal Yaml line linked to the scalar." \
+)
+
+ node = G_YAML_SCALAR(pygobject_get(self));
+
+ line = g_yaml_scalar_get_yaml_line(node);
+
+ if (line == NULL)
+ {
+ result = Py_None;
+ Py_INCREF(result);
+ }
+ else
+ {
+ result = pygobject_new(G_OBJECT(line));
+ g_object_unref(G_OBJECT(line));
+ }
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = contenu binaire à manipuler. *
+* value = collection de noeuds Yaml. *
+* closure = adresse non utilisée ici. *
+* *
+* Description : Attache une collection de noeuds Yaml à un noeud. *
+* *
+* Retour : Jeu d'attributs liés au contenu courant. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static int py_yaml_scalar_set_collection(PyObject *self, PyObject *value, void *closure)
+{
+ int result; /* Bilan à renvoyer */
+ GYamlScalar *node; /* Version GLib du noeud */
+ GYamlCollection *collec; /* Version GLib de la valeur */
+
+ node = G_YAML_SCALAR(pygobject_get(self));
+
+ if (value == Py_None)
+ {
+ g_yaml_scalar_set_collection(node, NULL);
+ result = 0;
+ }
+
+ else
+ {
+ if (!convert_to_yaml_collection(value, &collec))
+ result = -1;
+
+ else
+ {
+ g_yaml_scalar_set_collection(node, collec);
+ result = 0;
+ }
+
+ }
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = contenu binaire à manipuler. *
+* closure = adresse non utilisée ici. *
+* *
+* Description : Fournit une éventuelle collection rattachée à un noeud. *
+* *
+* Retour : Collection de noeuds Yaml ou None. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_yaml_scalar_get_collection(PyObject *self, void *closure)
+{
+ PyObject *result; /* Instance à retourner */
+ GYamlScalar *node; /* Version GLib du noeud */
+ GYamlCollection *collec; /* Collection à transmettre */
+
+#define YAML_SCALAR_COLLECTION_ATTRIB PYTHON_GETSET_DEF_FULL \
+( \
+ collection, py_yaml_scalar, \
+ "Provide or define the collection of nodes attached to another Yaml node." \
+)
+
+ node = G_YAML_SCALAR(pygobject_get(self));
+
+ collec = g_yaml_scalar_get_collection(node);
+
+ if (collec == NULL)
+ {
+ result = Py_None;
+ Py_INCREF(result);
+ }
+
+ else
+ {
+ result = pygobject_new(G_OBJECT(collec));
+ g_object_unref(collec);
+ }
+
+ 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_scalar_type(void)
+{
+ static PyMethodDef py_yaml_scalar_methods[] = {
+ { NULL }
+ };
+
+ static PyGetSetDef py_yaml_scalar_getseters[] = {
+ YAML_SCALAR_YAML_LINE_ATTRIB,
+ YAML_SCALAR_COLLECTION_ATTRIB,
+ { NULL }
+ };
+
+ static PyTypeObject py_yaml_scalar_type = {
+
+ PyVarObject_HEAD_INIT(NULL, 0)
+
+ .tp_name = "pychrysalide.plugins.yaml.YamlScalar",
+ .tp_basicsize = sizeof(PyGObject),
+
+ .tp_flags = Py_TPFLAGS_DEFAULT,
+
+ .tp_doc = YAML_SCALAR_DOC,
+
+ .tp_methods = py_yaml_scalar_methods,
+ .tp_getset = py_yaml_scalar_getseters,
+ .tp_new = py_yaml_scalar_new
+
+ };
+
+ return &py_yaml_scalar_type;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : module = module dont la définition est à compléter. *
+* *
+* Description : Prend en charge l'objet 'pychrysalide.plugins.....YamlScalar.*
+* *
+* Retour : Bilan de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+bool register_python_yaml_scalar(PyObject *module)
+{
+ PyTypeObject *type; /* Type Python 'YamlScalar' */
+ PyObject *dict; /* Dictionnaire du module */
+
+ type = get_python_yaml_scalar_type();
+
+ dict = PyModule_GetDict(module);
+
+ if (!register_class_for_pygobject(dict, G_TYPE_YAML_SCALAR, type, get_python_yaml_node_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 noeud d'arborescence de format Yaml. *
+* *
+* Retour : Bilan de l'opération, voire indications supplémentaires. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+int convert_to_yaml_scalar(PyObject *arg, void *dst)
+{
+ int result; /* Bilan à retourner */
+
+ result = PyObject_IsInstance(arg, (PyObject *)get_python_yaml_scalar_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 scalar");
+ break;
+
+ case 1:
+ *((GYamlScalar **)dst) = G_YAML_SCALAR(pygobject_get(arg));
+ break;
+
+ default:
+ assert(false);
+ break;
+
+ }
+
+ return result;
+
+}
diff --git a/plugins/yaml/python/scalar.h b/plugins/yaml/python/scalar.h
new file mode 100644
index 0000000..3812bd7
--- /dev/null
+++ b/plugins/yaml/python/scalar.h
@@ -0,0 +1,45 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * scalar.h - prototypes pour l'équivalent Python du fichier "plugins/yaml/scalar.h"
+ *
+ * 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
+ */
+
+
+#ifndef _PLUGINS_YAML_PYTHON_SCALAR_H
+#define _PLUGINS_YAML_PYTHON_SCALAR_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Fournit un accès à une définition de type à diffuser. */
+PyTypeObject *get_python_yaml_scalar_type(void);
+
+/* Prend en charge l'objet 'pychrysalide.plugins.yaml.YamlScalar'. */
+bool register_python_yaml_scalar(PyObject *);
+
+/* Tente de convertir en noeud d'arborescence de format Yaml. */
+int convert_to_yaml_scalar(PyObject *, void *);
+
+
+
+#endif /* _PLUGINS_YAML_PYTHON_SCALAR_H */
diff --git a/plugins/yaml/python/tree.c b/plugins/yaml/python/tree.c
index eeab3de..c23406a 100644
--- a/plugins/yaml/python/tree.c
+++ b/plugins/yaml/python/tree.c
@@ -150,6 +150,7 @@ static PyObject *py_yaml_tree_new(PyTypeObject *type, PyObject *args, PyObject *
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 */
@@ -159,19 +160,26 @@ static PyObject *py_yaml_tree_find_by_path(PyObject *self, PyObject *args)
#define YAML_TREE_FIND_BY_PATH PYTHON_METHOD_DEF \
( \
- find_by_path, "path", \
+ 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." \
)
- ret = PyArg_ParseTuple(args, "s", &path);
+ 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, &found, &count);
+ g_yaml_tree_find_by_path(tree, path, prepare, &found, &count);
result = PyTuple_New(count);
@@ -198,6 +206,69 @@ static PyObject *py_yaml_tree_find_by_path(PyObject *self, PyObject *args)
/******************************************************************************
* *
+* 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. *
* *
@@ -249,6 +320,7 @@ 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 }
};
generated by cgit v0.11.2-87-g4458 at 2024-12-27 10:31:06 (GMT)