Aggregate YAML values from sequences when requested and possible.

4 files changed, 344 insertions, 5 deletions

diff --git a/plugins/yaml/python/Makefile.am b/plugins/yaml/python/Makefile.am
index 89b319c..f3dc989 100644
--- a/plugins/yaml/python/Makefile.am
+++ b/plugins/yaml/python/Makefile.am
@@ -3,6 +3,7 @@ noinst_LTLIBRARIES = libyamlpython.la
 
 libyamlpython_la_SOURCES =					\
 	collection.h collection.c				\
+	constants.h constants.c					\
 	module.h module.c						\
 	node.h node.c							\
 	pair.h pair.c							\
diff --git a/plugins/yaml/python/constants.c b/plugins/yaml/python/constants.c
new file mode 100644
index 0000000..ff04584
--- /dev/null
+++ b/plugins/yaml/python/constants.c
@@ -0,0 +1,127 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * constants.c - prise en charge des constantes liées à YAML
+ *
+ * Copyright (C) 2023 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 "constants.h"
+
+
+#include <plugins/pychrysalide/helpers.h>
+
+
+#include "../pair.h"
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
+*                                                                             *
+*  Description : Définit les constantes relatives au noeuds principaux.       *
+*                                                                             *
+*  Retour      : true en cas de succès de l'opération, false sinon.           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool define_yaml_pair_constants(PyTypeObject *type)
+{
+    bool result;                            /* Bilan à retourner           */
+    PyObject *values;                       /* Groupe de valeurs à établir */
+
+    values = PyDict_New();
+
+    result = add_const_to_group(values, "PLAIN", YOS_PLAIN);
+    if (result) result = add_const_to_group(values, "SINGLE_QUOTED", YOS_SINGLE_QUOTED);
+    if (result) result = add_const_to_group(values, "DOUBLE_QUOTED", YOS_DOUBLE_QUOTED);
+
+    if (!result)
+    {
+        Py_DECREF(values);
+        goto exit;
+    }
+
+    result = attach_constants_group_to_type(type, false, "YamlOriginalStyle", values,
+                                            "Original style of scalar YAML nodes.");
+
+ exit:
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  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 constante YamlOriginalStyle.           *
+*                                                                             *
+*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+int convert_to_yaml_pair_original_style(PyObject *arg, void *dst)
+{
+    int result;                             /* Bilan à retourner           */
+    unsigned long value;                    /* Valeur transcrite           */
+
+    result = PyObject_IsInstance(arg, (PyObject *)&PyLong_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 YamlOriginalStyle");
+            break;
+
+        case 1:
+            value = PyLong_AsUnsignedLong(arg);
+
+            if (value > YOS_DOUBLE_QUOTED)
+            {
+                PyErr_SetString(PyExc_TypeError, "invalid value for YamlOriginalStyle");
+                result = 0;
+            }
+
+            else
+                *((YamlOriginalStyle *)dst) = value;
+
+            break;
+
+        default:
+            assert(false);
+            break;
+
+    }
+
+    return result;
+
+}
diff --git a/plugins/yaml/python/constants.h b/plugins/yaml/python/constants.h
new file mode 100644
index 0000000..d31bb69
--- /dev/null
+++ b/plugins/yaml/python/constants.h
@@ -0,0 +1,42 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * constants.h - prototypes pour la prise en charge des constantes liées à YAML
+ *
+ * Copyright (C) 2023 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_CONSTANTS_H
+#define _PLUGINS_YAML_PYTHON_CONSTANTS_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Définit les constantes relatives au noeuds principaux. */
+bool define_yaml_pair_constants(PyTypeObject *);
+
+/* Tente de convertir en constante YamlOriginalStyle. */
+int convert_to_yaml_pair_original_style(PyObject *, void *);
+
+
+
+#endif  /* _PLUGINS_YAML_PYTHON_CONSTANTS_H */
diff --git a/plugins/yaml/python/pair.c b/plugins/yaml/python/pair.c
index adaf04d..65132f6 100644
--- a/plugins/yaml/python/pair.c
+++ b/plugins/yaml/python/pair.c
@@ -26,6 +26,7 @@
 
 
 #include <assert.h>
+#include <malloc.h>
 #include <pygobject.h>
 
 
@@ -34,6 +35,7 @@
 
 
 #include "collection.h"
+#include "constants.h"
 #include "node.h"
 #include "../pair-int.h"
 
@@ -44,12 +46,21 @@ CREATE_DYN_CONSTRUCTOR(yaml_pair, G_TYPE_YAML_PAIR);
 /* Initialise une instance sur la base du dérivé de GObject. */
 static int py_yaml_pair_init(PyObject *, PyObject *, PyObject *);
 
+/* Rassemble une éventuelle séquence de valeurs attachées. */
+static PyObject *py_yaml_pair_aggregate_value(PyObject *, PyObject *);
+
 /* Fournit la clef représentée dans une paire en YAML. */
 static PyObject *py_yaml_pair_get_key(PyObject *, void *);
 
+/* Indique le format d'origine YAML associé à la clef. */
+static PyObject *py_yaml_pair_get_key_style(PyObject *, void *);
+
 /* Fournit l'éventuelle valeur d'une paire en YAML. */
 static PyObject *py_yaml_pair_get_value(PyObject *, void *);
 
+/* Indique le format d'origine YAML associé à la clef. */
+static PyObject *py_yaml_pair_get_value_style(PyObject *, void *);
+
 /* Attache une collection de noeuds YAML à un noeud. */
 static int py_yaml_pair_set_children(PyObject *, PyObject *, void *);
 
@@ -74,7 +85,9 @@ static PyObject *py_yaml_pair_get_children(PyObject *, void *);
 
 static int py_yaml_pair_init(PyObject *self, PyObject *args, PyObject *kwds)
 {
+    YamlOriginalStyle kstyle;               /* Format d'origine de la clef */
     const char *value;                      /* Eventuelle valeur associée  */
+    YamlOriginalStyle vstyle;               /* Format d'origine de la val. */
     const char *key;                        /* Clef associée au noeud      */
     int ret;                                /* Bilan de lecture des args.  */
     GYamlPair *pair;                        /* Création GLib à transmettre */
@@ -84,16 +97,35 @@ static int py_yaml_pair_init(PyObject *self, PyObject *args, PyObject *kwds)
     "\n"                                                                \
     "Instances can be created using the following constructor:\n"       \
     "\n"                                                                \
-    "    YamlPair(key, value=None)\n"                                   \
+    "    YamlPair(key, kstyle=PLAIN, value=None, vstyle=PLAIN)\n"       \
     "\n"                                                                \
     "Where *key* defines the name for the YAML node, and *value*"       \
-    " provides an optional direct value for the node."
+    " provides an optional direct value for the node. The *kstyle* and" \
+    " *vstyle* arguements are"                                          \
+    " pychrysalide.plugins.yaml.YamlPair.YamlOriginalStyle states"      \
+    " linking an original format to the provided relative strings.\n"   \
+    "\n"                                                                \
+    "The two style are mainly used to aggregate children values into"   \
+    " a raw array. The following declarations are indeed equivalent"    \
+    " and pychrysalide.plugins.yaml.YamlPair.aggregate_value()"         \
+    " build the latter version from the former one:\n"                  \
+    "\n"                                                                \
+    "a: [ 1, 2, 3 ]\n"                                                  \
+    "\n"                                                                \
+    "a:\n"                                                              \
+    "    - 1\n"                                                         \
+    "    - 2\n"                                                         \
+    "    - 3"                                                           \
 
     /* Récupération des paramètres */
 
+    kstyle = YOS_PLAIN;
     value = NULL;
+    vstyle = YOS_PLAIN;
 
-    ret = PyArg_ParseTuple(args, "s|s", &key, &value);
+    ret = PyArg_ParseTuple(args, "s|O&sO&",
+                           &key, convert_to_yaml_pair_original_style, &kstyle,
+                           &value, convert_to_yaml_pair_original_style, &vstyle);
     if (!ret) return -1;
 
     /* Initialisation d'un objet GLib */
@@ -105,7 +137,7 @@ static int py_yaml_pair_init(PyObject *self, PyObject *args, PyObject *kwds)
 
     pair = G_YAML_PAIR(pygobject_get(self));
 
-    if (!g_yaml_pair_create(pair, key, value))
+    if (!g_yaml_pair_create(pair, key, kstyle, value, vstyle))
     {
         PyErr_SetString(PyExc_ValueError, _("Unable to create YAML pair."));
         return -1;
@@ -119,6 +151,58 @@ static int py_yaml_pair_init(PyObject *self, PyObject *args, PyObject *kwds)
 
 /******************************************************************************
 *                                                                             *
+*  Paramètres  : self = serveur à manipuler.                                  *
+*                args = arguments d'appel non utilisés ici.                   *
+*                                                                             *
+*  Description : Rassemble une éventuelle séquence de valeurs attachées.      *
+*                                                                             *
+*  Retour      : Valeur sous forme de chaîne de caractères ou None.           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_yaml_pair_aggregate_value(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Bilan à retourner           */
+    GYamlPair *node;                        /* Version GLib du type        */
+    char *value;                            /* Chaîne à transmettre        */
+
+#define YAML_PAIR_AGGREGATE_VALUE_METHOD PYTHON_METHOD_DEF  \
+(                                                           \
+    aggregate_value, "$self, /",                            \
+    METH_NOARGS, py_yaml_pair,                              \
+    "Provide the value linked to the YAML node, rebuilding" \
+    " it from inner sequenced values if necessary and"      \
+    " possible."                                            \
+    "\n"                                                    \
+    "The result is a string value, or *None* if none"       \
+    " available."                                           \
+)
+
+    node = G_YAML_PAIR(pygobject_get(self));
+
+    value = g_yaml_pair_aggregate_value(node);
+
+    if (value == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+
+    else
+    {
+        result = PyUnicode_FromString(value);
+        free(value);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
 *  Paramètres  : self    = objet Python concerné par l'appel.                 *
 *                closure = non utilisé ici.                                   *
 *                                                                             *
@@ -160,6 +244,44 @@ static PyObject *py_yaml_pair_get_key(PyObject *self, void *closure)
 *  Paramètres  : self    = objet Python concerné par l'appel.                 *
 *                closure = non utilisé ici.                                   *
 *                                                                             *
+*  Description : Indique le format d'origine YAML associé à la clef.          *
+*                                                                             *
+*  Retour      : Valeur renseignée lors du chargement du noeud.               *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_yaml_pair_get_key_style(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Résultat à retourner        */
+    GYamlPair *node;                        /* Version GLib du noeud       */
+    YamlOriginalStyle style;                /* Format à transmettre        */
+
+#define YAML_PAIR_KEY_STYLE_ATTRIB PYTHON_GET_DEF_FULL      \
+(                                                           \
+    key_style, py_yaml_pair,                                \
+    "Original format for the YAML node Key, as a"           \
+    " pychrysalide.plugins.yaml.YamlPair.YamlOriginalStyle" \
+    " value."                                               \
+)
+
+    node = G_YAML_PAIR(pygobject_get(self));
+
+    style = g_yaml_pair_get_key_style(node);
+
+    result = cast_with_constants_group_from_type(get_python_yaml_pair_type(), "YamlOriginalStyle", style);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
 *  Description : Fournit l'éventuelle valeur d'une paire en YAML.             *
 *                                                                             *
 *  Retour      : Valeur sous forme de chaîne de caractères ou None.           *
@@ -178,7 +300,7 @@ static PyObject *py_yaml_pair_get_value(PyObject *self, void *closure)
 (                                                           \
     value, py_yaml_pair,                                    \
     "Value linked to the YAML key/value pair node, as a"    \
-    " string value, or None if none defined."               \
+    " string value, or *None* if none defined."             \
 )
 
     node = G_YAML_PAIR(pygobject_get(self));
@@ -201,6 +323,47 @@ static PyObject *py_yaml_pair_get_value(PyObject *self, void *closure)
 
 /******************************************************************************
 *                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Indique le format d'origine YAML associé à la clef.          *
+*                                                                             *
+*  Retour      : Valeur renseignée lors du chargement du noeud.               *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_yaml_pair_get_value_style(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Résultat à retourner        */
+    GYamlPair *node;                        /* Version GLib du noeud       */
+    YamlOriginalStyle style;                /* Format à transmettre        */
+
+#define YAML_PAIR_VALUE_STYLE_ATTRIB PYTHON_GET_DEF_FULL    \
+(                                                           \
+    value_style, py_yaml_pair,                              \
+    "Original format for the YAML node Value, as a"         \
+    " pychrysalide.plugins.yaml.YamlPair.YamlOriginalStyle" \
+    " value.\n"                                             \
+    "\n"                                                    \
+    "Even if there is no value for the node, the default"   \
+    " style is returned: *PLAIN*."                          \
+)
+
+    node = G_YAML_PAIR(pygobject_get(self));
+
+    style = g_yaml_pair_get_value_style(node);
+
+    result = cast_with_constants_group_from_type(get_python_yaml_pair_type(), "YamlOriginalStyle", style);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
 *  Paramètres  : self    = contenu binaire à manipuler.                       *
 *                value   = collection de noeuds YAML.                         *
 *                closure = adresse non utilisée ici.                          *
@@ -308,12 +471,15 @@ static PyObject *py_yaml_pair_get_children(PyObject *self, void *closure)
 PyTypeObject *get_python_yaml_pair_type(void)
 {
     static PyMethodDef py_yaml_pair_methods[] = {
+        YAML_PAIR_AGGREGATE_VALUE_METHOD,
         { NULL }
     };
 
     static PyGetSetDef py_yaml_pair_getseters[] = {
         YAML_PAIR_KEY_ATTRIB,
+        YAML_PAIR_KEY_STYLE_ATTRIB,
         YAML_PAIR_VALUE_ATTRIB,
+        YAML_PAIR_VALUE_STYLE_ATTRIB,
         YAML_PAIR_CHILDREN_ATTRIB,
         { NULL }
     };
@@ -367,6 +533,9 @@ bool register_python_yaml_pair(PyObject *module)
     if (!register_class_for_pygobject(dict, G_TYPE_YAML_PAIR, type, get_python_yaml_node_type()))
         return false;
 
+    if (!define_yaml_pair_constants(type))
+        return false;
+
     return true;
 
 }