Extended the Python bindings for registers.

4 files changed, 326 insertions, 4 deletions

diff --git a/plugins/pychrysalide/glibext/Makefile.am b/plugins/pychrysalide/glibext/Makefile.am
index 28d27f6..c5fee67 100644
--- a/plugins/pychrysalide/glibext/Makefile.am
+++ b/plugins/pychrysalide/glibext/Makefile.am
@@ -2,6 +2,7 @@
 noinst_LTLIBRARIES = libpychrysaglibext.la
 
 libpychrysaglibext_la_SOURCES =			\
+	constants.h constants.c				\
 	binarycursor.h binarycursor.c		\
 	binportion.h binportion.c			\
 	buffercache.h buffercache.c			\
diff --git a/plugins/pychrysalide/glibext/bufferline.c b/plugins/pychrysalide/glibext/bufferline.c
index d6b391a..47b2bc4 100644
--- a/plugins/pychrysalide/glibext/bufferline.c
+++ b/plugins/pychrysalide/glibext/bufferline.c
@@ -31,17 +31,23 @@
 
 
 #include <i18n.h>
-
-
 #include <glibext/gbufferline.h>
+#include <plugins/dt.h>
 
 
+#include "constants.h"
 #include "../access.h"
 #include "../helpers.h"
 #include "../arch/vmpa.h"
 
 
 
+/* Accompagne la création d'une instance dérivée en Python. */
+static PyObject *py_buffer_line_new(PyTypeObject *, PyObject *, PyObject *);
+
+/* Ajoute du texte à formater dans une ligne donnée. */
+static PyObject *py_buffer_line_append_text(PyObject *, PyObject *);
+
 /* Reconstruit et fournit le texte présent sur une ligne tampon. */
 static PyObject *py_buffer_line_get_text(PyObject *, PyObject *);
 
@@ -64,6 +70,131 @@ static bool py_buffer_line_define_constants(PyTypeObject *);
 
 /******************************************************************************
 *                                                                             *
+*  Paramètres  : type = type du nouvel objet à mettre en place.               *
+*                args = éventuelle liste d'arguments.                         *
+*                kwds = éventuel dictionnaire de valeurs mises à disposition. *
+*                                                                             *
+*  Description : Accompagne la création d'une instance dérivée en Python.     *
+*                                                                             *
+*  Retour      : Nouvel objet Python mis en place ou NULL en cas d'échec.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_buffer_line_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+    PyObject *result;                       /* Objet à retourner           */
+    PyTypeObject *base;                     /* Type de base à dériver      */
+    bool first_time;                        /* Evite les multiples passages*/
+    GType gtype;                            /* Nouveau type de processeur  */
+    bool status;                            /* Bilan d'un enregistrement   */
+
+#define BUFFER_LINE_DOC                                                     \
+    "The BufferLine object is used to display processed data: disassembled" \
+    " instruction, binary content in hexadecimal form, aso.\n"              \
+    "\n"                                                                    \
+    "Instances can be created using the following constructor:\n"           \
+    "\n"                                                                    \
+    "    BufferLine()"                                                      \
+    "\n"                                                                    \
+    "Such objets aim to be created from the Chrysalide core only, and"      \
+    " then get populated by plugins on demand."
+
+    /* Validations diverses */
+
+    base = get_python_buffer_line_type();
+
+    if (type == base)
+        goto simple_way;
+
+    /* Mise en place d'un type dédié */
+
+    first_time = (g_type_from_name(type->tp_name) == 0);
+
+    gtype = build_dynamic_type(G_TYPE_BUFFER_LINE, type->tp_name, NULL, NULL, NULL);
+
+    if (first_time)
+    {
+        status = register_class_for_dynamic_pygobject(gtype, type, base);
+
+        if (!status)
+        {
+            result = NULL;
+            goto exit;
+        }
+
+    }
+
+    /* On crée, et on laisse ensuite la main à PyGObject_Type.tp_init() */
+
+ simple_way:
+
+    result = PyType_GenericNew(type, args, kwds);
+
+ exit:
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = classe représentant une ligne de tampon.              *
+*                args = arguments fournis à l'appel.                          *
+*                                                                             *
+*  Description : Ajoute du texte à formater dans une ligne donnée.            *
+*                                                                             *
+*  Retour      : -                                                            *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_buffer_line_append_text(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Trouvailles à retourner     */
+    unsigned long column;                   /* Indice de colonne           */
+    const char *text;                       /* Texte à ajouter             */
+    RenderingTagType type;                  /* Type de rendu attendu       */
+    GObject *creator;                       /* Eventuel créateur à associer*/
+    int ret;                                /* Bilan de lecture des args.  */
+    GBufferLine *line;                      /* Version native              */
+
+#define BUFFER_LINE_APPEND_TEXT_METHOD PYTHON_METHOD_DEF            \
+(                                                                   \
+    append_text, "$self, column, text, tag, /, creator=None",       \
+    METH_VARARGS, py_buffer_line,                                   \
+    "Append some text to a line at a given column index. The"       \
+    " expected rendering for this text is defined by the tag, which"\
+    " must be a pychrysalide.glibext.BufferLine.RenderingTagType"   \
+    " value."                                                       \
+    "\n"                                                            \
+    "An optional GObject instance may be provided as origin of the" \
+    " creation."                                                    \
+)
+
+    creator = NULL;
+
+    ret = PyArg_ParseTuple(args, "ksO&|O&", &column, &text,
+                           convert_to_rendering_tag_type, &type, convert_to_gobject, &creator);
+    if (!ret) return NULL;
+
+    line = G_BUFFER_LINE(pygobject_get(self));
+
+    g_buffer_line_append_text(line, column, text, strlen(text), type, creator);
+
+    result = Py_None;
+    Py_INCREF(result);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
 *  Paramètres  : self = classe représentant une ligne de tampon.              *
 *                args = arguments fournis à l'appel.                          *
 *                                                                             *
@@ -292,6 +423,7 @@ static bool py_buffer_line_define_constants(PyTypeObject *obj_type)
 PyTypeObject *get_python_buffer_line_type(void)
 {
     static PyMethodDef py_buffer_line_methods[] = {
+        BUFFER_LINE_APPEND_TEXT_METHOD,
         {
             "get_text", py_buffer_line_get_text,
             METH_VARARGS,
@@ -329,13 +461,15 @@ PyTypeObject *get_python_buffer_line_type(void)
         .tp_name        = "pychrysalide.glibext.BufferLine",
         .tp_basicsize   = sizeof(PyGObject),
 
-        .tp_flags       = Py_TPFLAGS_DEFAULT,
+        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 
-        .tp_doc         = "PyChrysalide buffer line",
+        .tp_doc         = BUFFER_LINE_DOC,
 
         .tp_methods     = py_buffer_line_methods,
         .tp_getset      = py_buffer_line_getseters,
 
+        .tp_new         = py_buffer_line_new
+
     };
 
     return &py_buffer_line_type;
@@ -372,6 +506,9 @@ bool ensure_python_buffer_line_is_registered(void)
         if (!register_class_for_pygobject(dict, G_TYPE_BUFFER_LINE, type, &PyGObject_Type))
             return false;
 
+        if (!define_line_segment_constants(type))
+            return false;
+
         if (!py_buffer_line_define_constants(type))
             return false;
 
diff --git a/plugins/pychrysalide/glibext/constants.c b/plugins/pychrysalide/glibext/constants.c
new file mode 100644
index 0000000..d18e051
--- /dev/null
+++ b/plugins/pychrysalide/glibext/constants.c
@@ -0,0 +1,142 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * constants.c - ajout des constantes de base pour les extensions à la GLib
+ *
+ * Copyright (C) 2020 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 <glibext/linesegment.h>
+
+
+#include "../helpers.h"
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
+*                                                                             *
+*  Description : Définit les constantes relatives aux segments de ligne.      *
+*                                                                             *
+*  Retour      : true en cas de succès de l'opération, false sinon.           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool define_line_segment_constants(PyTypeObject *type)
+{
+    bool result;                            /* Bilan à retourner           */
+    PyObject *values;                       /* Groupe de valeurs à établir */
+
+    values = PyDict_New();
+
+    result = add_const_to_group(values, "NONE", RTT_NONE);
+    if (result) result = add_const_to_group(values, "RAW", RTT_RAW);
+    if (result) result = add_const_to_group(values, "RAW_FULL", RTT_RAW_FULL);
+    if (result) result = add_const_to_group(values, "RAW_NULL", RTT_RAW_NULL);
+    if (result) result = add_const_to_group(values, "PRINTABLE", RTT_PRINTABLE);
+    if (result) result = add_const_to_group(values, "NOT_PRINTABLE", RTT_NOT_PRINTABLE);
+    if (result) result = add_const_to_group(values, "COMMENT", RTT_COMMENT);
+    if (result) result = add_const_to_group(values, "INDICATION", RTT_INDICATION);
+    if (result) result = add_const_to_group(values, "PHYS_ADDR_PAD", RTT_PHYS_ADDR_PAD);
+    if (result) result = add_const_to_group(values, "PHYS_ADDR", RTT_PHYS_ADDR);
+    if (result) result = add_const_to_group(values, "VIRT_ADDR_PAD", RTT_VIRT_ADDR_PAD);
+    if (result) result = add_const_to_group(values, "VIRT_ADDR", RTT_VIRT_ADDR);
+    if (result) result = add_const_to_group(values, "RAW_CODE", RTT_RAW_CODE);
+    if (result) result = add_const_to_group(values, "RAW_CODE_NULL", RTT_RAW_CODE_NULL);
+    if (result) result = add_const_to_group(values, "LABEL", RTT_LABEL);
+    if (result) result = add_const_to_group(values, "INSTRUCTION", RTT_INSTRUCTION);
+    if (result) result = add_const_to_group(values, "IMMEDIATE", RTT_IMMEDIATE);
+    if (result) result = add_const_to_group(values, "REGISTER", RTT_REGISTER);
+    if (result) result = add_const_to_group(values, "PUNCT", RTT_PUNCT);
+    if (result) result = add_const_to_group(values, "HOOK", RTT_HOOK);
+    if (result) result = add_const_to_group(values, "SIGNS", RTT_SIGNS);
+    if (result) result = add_const_to_group(values, "LTGT", RTT_LTGT);
+    if (result) result = add_const_to_group(values, "SECTION", RTT_SECTION);
+    if (result) result = add_const_to_group(values, "SEGMENT", RTT_SEGMENT);
+    if (result) result = add_const_to_group(values, "STRING", RTT_STRING);
+    if (result) result = add_const_to_group(values, "VAR_NAME", RTT_VAR_NAME);
+    if (result) result = add_const_to_group(values, "KEY_WORD", RTT_KEY_WORD);
+    if (result) result = add_const_to_group(values, "ERROR", RTT_ERROR);
+    if (result) result = add_const_to_group(values, "COUNT", RTT_COUNT);
+
+    if (!result)
+    {
+        Py_DECREF(values);
+        goto exit;
+    }
+
+    result = attach_constants_group_to_type(type, false, "RenderingTagType", values,
+                                            "Kinds of text rendering.");
+
+ 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 RenderingTagType.            *
+*                                                                             *
+*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+int convert_to_rendering_tag_type(PyObject *arg, void *dst)
+{
+    int result;                             /* Bilan à retourner           */
+
+    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 RenderingTagType");
+            break;
+
+        case 1:
+            *((RenderingTagType *)dst) = PyLong_AsUnsignedLong(arg);
+            break;
+
+        default:
+            assert(false);
+            break;
+
+    }
+
+    return result;
+
+}
diff --git a/plugins/pychrysalide/glibext/constants.h b/plugins/pychrysalide/glibext/constants.h
new file mode 100644
index 0000000..472507b
--- /dev/null
+++ b/plugins/pychrysalide/glibext/constants.h
@@ -0,0 +1,42 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * constants.h - prototypes pour l'ajout des constantes de base pour les extensions à la GLib
+ *
+ * Copyright (C) 2020 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_PYCHRYSALIDE_GLIBEXT_CONSTANTS_H
+#define _PLUGINS_PYCHRYSALIDE_GLIBEXT_CONSTANTS_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Définit les constantes relatives aux segments de ligne. */
+bool define_line_segment_constants(PyTypeObject *);
+
+/* Tente de convertir en constante RenderingTagType. */
+int convert_to_rendering_tag_type(PyObject *, void *);
+
+
+
+#endif  /* _PLUGINS_PYCHRYSALIDE_GLIBEXT_CONSTANTS_H */