diff options
Diffstat (limited to 'plugins/yaml/python/pair.c')
| -rw-r--r-- | plugins/yaml/python/pair.c | 314 |
1 files changed, 257 insertions, 57 deletions
diff --git a/plugins/yaml/python/pair.c b/plugins/yaml/python/pair.c index db5597d..1fffbeb 100644 --- a/plugins/yaml/python/pair.c +++ b/plugins/yaml/python/pair.c @@ -26,74 +26,176 @@ #include <assert.h> +#include <malloc.h> #include <pygobject.h> +#include <i18n.h> +#include <plugins/pychrysalide/access.h> #include <plugins/pychrysalide/helpers.h> #include "collection.h" -#include "line.h" +#include "constants.h" #include "node.h" -#include "../pair.h" +#include "../pair-int.h" -/* Crée un nouvel objet Python de type 'YamlPair'. */ -static PyObject *py_yaml_pair_new(PyTypeObject *, PyObject *, PyObject *); +CREATE_DYN_CONSTRUCTOR(yaml_pair, G_TYPE_YAML_PAIR); -/* Fournit la clef représentée dans une paire en Yaml. */ +/* 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 *); -/* Fournit l'éventuelle valeur d'une paire en Yaml. */ +/* 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 *); -/* Attache une collection de noeuds Yaml à un noeud. */ -static int py_yaml_pair_set_collection(PyObject *, 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 *); /* Fournit une éventuelle collection rattachée à un noeud. */ -static PyObject *py_yaml_pair_get_collection(PyObject *, void *); +static PyObject *py_yaml_pair_get_children(PyObject *, void *); /****************************************************************************** * * -* Paramètres : type = type de l'objet à instancier. * +* Paramètres : self = objet à initialiser (théoriquement). * * args = arguments fournis à l'appel. * * kwds = arguments de type key=val fournis. * * * -* Description : Crée un nouvel objet Python de type 'YamlPair'. * +* Description : Initialise une instance sur la base du dérivé de GObject. * * * -* Retour : Instance Python mise en place. * +* Retour : 0. * * * * Remarques : - * * * ******************************************************************************/ -static PyObject *py_yaml_pair_new(PyTypeObject *type, PyObject *args, PyObject *kwds) +static int py_yaml_pair_init(PyObject *self, PyObject *args, PyObject *kwds) { - PyObject *result; /* Instance à retourner */ - GYamlLine *key; /* Ligne principale du noeud */ + 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 *node; /* Création GLib à transmettre */ + GYamlPair *pair; /* Création GLib à transmettre */ #define YAML_PAIR_DOC \ - "YamlPair handles a key/value pair node in a Yaml tree.\n" \ + "YamlPair handles a key/value pair node in a YAML tree.\n" \ "\n" \ "Instances can be created using the following constructor:\n" \ "\n" \ - " YamlPair(line)\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. 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" \ - "Where key is the original Yaml line for the pair." + "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|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 */ + + ret = forward_pygobjet_init(self); + if (ret == -1) return -1; + + /* Eléments de base */ + + pair = G_YAML_PAIR(pygobject_get(self)); + + if (!g_yaml_pair_create(pair, key, kstyle, value, vstyle)) + { + PyErr_SetString(PyExc_ValueError, _("Unable to create YAML pair.")); + return -1; + + } + + return 0; + +} + + +/****************************************************************************** +* * +* 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 */ - ret = PyArg_ParseTuple(args, "O&", &convert_to_yaml_line, &key); - if (!ret) return NULL; +#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_new(key); + node = G_YAML_PAIR(pygobject_get(self)); + + value = g_yaml_pair_aggregate_value(node); + + if (value == NULL) + { + result = Py_None; + Py_INCREF(result); + } - g_object_ref_sink(G_OBJECT(node)); - result = pygobject_new(G_OBJECT(node)); - g_object_unref(node); + else + { + result = PyUnicode_FromString(value); + free(value); + } return result; @@ -105,7 +207,7 @@ static PyObject *py_yaml_pair_new(PyTypeObject *type, PyObject *args, PyObject * * Paramètres : self = objet Python concerné par l'appel. * * closure = non utilisé ici. * * * -* Description : Fournit la clef représentée dans une paire en Yaml. * +* Description : Fournit la clef représentée dans une paire en YAML. * * * * Retour : Clef sous forme de chaîne de caractères. * * * @@ -122,7 +224,8 @@ static PyObject *py_yaml_pair_get_key(PyObject *self, void *closure) #define YAML_PAIR_KEY_ATTRIB PYTHON_GET_DEF_FULL \ ( \ key, py_yaml_pair, \ - "Key linked to the Yaml key/value pair node." \ + "Key linked to the YAML key/value pair node," \ + " as a string value." \ ) node = G_YAML_PAIR(pygobject_get(self)); @@ -142,7 +245,45 @@ 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 : Fournit l'éventuelle valeur d'une paire en Yaml. * +* 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. * * * @@ -159,7 +300,8 @@ static PyObject *py_yaml_pair_get_value(PyObject *self, void *closure) #define YAML_PAIR_VALUE_ATTRIB PYTHON_GET_DEF_FULL \ ( \ value, py_yaml_pair, \ - "Value linked to the Yaml key/value pair node or None." \ + "Value linked to the YAML key/value pair node, as a" \ + " string value, or *None* if none defined." \ ) node = G_YAML_PAIR(pygobject_get(self)); @@ -182,11 +324,52 @@ 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. * +* value = collection de noeuds YAML. * * closure = adresse non utilisée ici. * * * -* Description : Attache une collection de noeuds Yaml à un noeud. * +* Description : Attache une collection de noeuds YAML à un noeud. * * * * Retour : Jeu d'attributs liés au contenu courant. * * * @@ -194,28 +377,28 @@ static PyObject *py_yaml_pair_get_value(PyObject *self, void *closure) * * ******************************************************************************/ -static int py_yaml_pair_set_collection(PyObject *self, PyObject *value, void *closure) +static int py_yaml_pair_set_children(PyObject *self, PyObject *value, void *closure) { int result; /* Bilan à renvoyer */ GYamlPair *node; /* Version GLib du noeud */ - GYamlCollection *collec; /* Version GLib de la valeur */ + GYamlCollection *children; /* Version GLib de la valeur */ node = G_YAML_PAIR(pygobject_get(self)); if (value == Py_None) { - g_yaml_pair_set_collection(node, NULL); + g_yaml_pair_set_children(node, NULL); result = 0; } else { - if (!convert_to_yaml_collection(value, &collec)) + if (!convert_to_yaml_collection(value, &children)) result = -1; else { - g_yaml_pair_set_collection(node, collec); + g_yaml_pair_set_children(node, children); result = 0; } @@ -233,29 +416,31 @@ static int py_yaml_pair_set_collection(PyObject *self, PyObject *value, void *cl * * * Description : Fournit une éventuelle collection rattachée à un noeud. * * * -* Retour : Collection de noeuds Yaml ou None. * +* Retour : Collection de noeuds YAML ou None. * * * * Remarques : - * * * ******************************************************************************/ -static PyObject *py_yaml_pair_get_collection(PyObject *self, void *closure) +static PyObject *py_yaml_pair_get_children(PyObject *self, void *closure) { PyObject *result; /* Instance à retourner */ GYamlPair *node; /* Version GLib du noeud */ - GYamlCollection *collec; /* Collection à transmettre */ - -#define YAML_PAIR_COLLECTION_ATTRIB PYTHON_GETSET_DEF_FULL \ -( \ - collection, py_yaml_pair, \ - "Provide or define the collection of nodes attached to another Yaml node." \ + GYamlCollection *children; /* Collection à transmettre */ + +#define YAML_PAIR_CHILDREN_ATTRIB PYTHON_GETSET_DEF_FULL \ +( \ + children, py_yaml_pair, \ + "Provide or define the collection of nodes attached to another" \ + " YAML node. The collection, if defined, is handled as a" \ + " pychrysalide.plugins.yaml.YamlCollection instance." \ ) node = G_YAML_PAIR(pygobject_get(self)); - collec = g_yaml_pair_get_collection(node); + children = g_yaml_pair_get_children(node); - if (collec == NULL) + if (children == NULL) { result = Py_None; Py_INCREF(result); @@ -263,8 +448,8 @@ static PyObject *py_yaml_pair_get_collection(PyObject *self, void *closure) else { - result = pygobject_new(G_OBJECT(collec)); - g_object_unref(collec); + result = pygobject_new(G_OBJECT(children)); + g_object_unref(children); } return result; @@ -287,13 +472,16 @@ static PyObject *py_yaml_pair_get_collection(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_COLLECTION_ATTRIB, + YAML_PAIR_VALUE_STYLE_ATTRIB, + YAML_PAIR_CHILDREN_ATTRIB, { NULL } }; @@ -310,7 +498,9 @@ PyTypeObject *get_python_yaml_pair_type(void) .tp_methods = py_yaml_pair_methods, .tp_getset = py_yaml_pair_getseters, - .tp_new = py_yaml_pair_new + + .tp_init = py_yaml_pair_init, + .tp_new = py_yaml_pair_new, }; @@ -321,7 +511,7 @@ PyTypeObject *get_python_yaml_pair_type(void) /****************************************************************************** * * -* Paramètres : module = module dont la définition est à compléter. * +* Paramètres : - * * * * Description : Prend en charge l'objet 'pychrysalide.plugins.....YamlPair. * * * @@ -331,17 +521,27 @@ PyTypeObject *get_python_yaml_pair_type(void) * * ******************************************************************************/ -bool register_python_yaml_pair(PyObject *module) +bool ensure_python_yaml_pair_is_registered(void) { PyTypeObject *type; /* Type Python 'YamlPair' */ + PyObject *module; /* Module à recompléter */ PyObject *dict; /* Dictionnaire du module */ type = get_python_yaml_pair_type(); - dict = PyModule_GetDict(module); + if (!PyType_HasFeature(type, Py_TPFLAGS_READY)) + { + module = get_access_to_python_module("pychrysalide.plugins.yaml"); + + dict = PyModule_GetDict(module); - if (!register_class_for_pygobject(dict, G_TYPE_YAML_PAIR, type, get_python_yaml_node_type())) - return false; + if (!register_class_for_pygobject(dict, G_TYPE_YAML_PAIR, type)) + return false; + + if (!define_yaml_pair_constants(type)) + return false; + + } return true; @@ -353,7 +553,7 @@ bool register_python_yaml_pair(PyObject *module) * 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. * +* Description : Tente de convertir en noeud d'arborescence de format YAML. * * * * Retour : Bilan de l'opération, voire indications supplémentaires. * * * @@ -375,7 +575,7 @@ int convert_to_yaml_pair(PyObject *arg, void *dst) break; case 0: - PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to Yaml key/value pair"); + PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to YAML key/value pair"); break; case 1: |