Relocated the raw instructions.

12 files changed, 262 insertions, 67 deletions

diff --git a/plugins/pychrysalide/arch/Makefile.am b/plugins/pychrysalide/arch/Makefile.am
index da78572..45fd567 100644
--- a/plugins/pychrysalide/arch/Makefile.am
+++ b/plugins/pychrysalide/arch/Makefile.am
@@ -10,7 +10,6 @@ libpychrysaarch_la_SOURCES =			\
 	module.h module.c					\
 	operand.h operand.c					\
 	processor.h processor.c				\
-	raw.h raw.c							\
 	register.h register.c				\
 	vmpa.h vmpa.c
 
diff --git a/plugins/pychrysalide/arch/constants.c b/plugins/pychrysalide/arch/constants.c
index b6b0e62..5e9ad37 100644
--- a/plugins/pychrysalide/arch/constants.c
+++ b/plugins/pychrysalide/arch/constants.c
@@ -25,7 +25,7 @@
 #include "constants.h"
 
 
-#include <arch/raw.h>
+#include <arch/instruction.h>
 #include <arch/vmpa.h>
 
 
@@ -149,44 +149,3 @@ bool define_arch_vmpa_constants(PyTypeObject *type)
     return result;
 
 }
-
-
-/******************************************************************************
-*                                                                             *
-*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
-*                                                                             *
-*  Description : Définit les constantes relatives aux instructions brutes.    *
-*                                                                             *
-*  Retour      : true en cas de succès de l'opération, false sinon.           *
-*                                                                             *
-*  Remarques   : -                                                            *
-*                                                                             *
-******************************************************************************/
-
-bool define_raw_instruction_constants(PyTypeObject *type)
-{
-    bool result;                            /* Bilan à retourner           */
-    PyObject *values;                       /* Groupe de valeurs à établir */
-
-    values = PyDict_New();
-
-    result = add_const_to_group(values, "PADDING", RIF_PADDING);
-    if (result) result = add_const_to_group(values, "STRING", RIF_STRING);
-
-    if (!result)
-    {
-        Py_DECREF(values);
-        goto exit;
-    }
-
-    result = attach_constants_group_to_type(type, true, "RawInstrFlag", values,
-                                            "Flags for some instruction properties.\n"
-                                            "\n"
-                                            "They can be seen as an extension of" \
-                                            " pychrysalide.arch.ArchInstruction.ArchInstrFlag");
-
- exit:
-
-    return result;
-
-}
diff --git a/plugins/pychrysalide/arch/constants.h b/plugins/pychrysalide/arch/constants.h
index 9488bc0..ecd6ce8 100644
--- a/plugins/pychrysalide/arch/constants.h
+++ b/plugins/pychrysalide/arch/constants.h
@@ -37,9 +37,6 @@ bool define_arch_instruction_constants(PyTypeObject *);
 /* Définit les constantes relatives aux emplacements. */
 bool define_arch_vmpa_constants(PyTypeObject *);
 
-/* Définit les constantes relatives aux instructions brutes. */
-bool define_raw_instruction_constants(PyTypeObject *);
-
 
 
 #endif  /* _PLUGINS_PYCHRYSALIDE_ARCH_CONSTANTS_H */
diff --git a/plugins/pychrysalide/arch/instructions/Makefile.am b/plugins/pychrysalide/arch/instructions/Makefile.am
index 885f96e..be7c6d7 100644
--- a/plugins/pychrysalide/arch/instructions/Makefile.am
+++ b/plugins/pychrysalide/arch/instructions/Makefile.am
@@ -4,6 +4,7 @@ noinst_LTLIBRARIES = libpychrysaarchinstructions.la
 libpychrysaarchinstructions_la_SOURCES =	\
 	constants.h constants.c				\
 	module.h module.c					\
+	raw.h raw.c							\
 	undefined.h undefined.c
 
 libpychrysaarchinstructions_la_LIBADD = 
diff --git a/plugins/pychrysalide/arch/instructions/constants.c b/plugins/pychrysalide/arch/instructions/constants.c
index 1f6a1d2..b5e08e1 100644
--- a/plugins/pychrysalide/arch/instructions/constants.c
+++ b/plugins/pychrysalide/arch/instructions/constants.c
@@ -25,6 +25,7 @@
 #include "constants.h"
 
 
+#include <arch/instructions/raw.h>
 #include <arch/instructions/undefined.h>
 
 
@@ -36,6 +37,47 @@
 *                                                                             *
 *  Paramètres  : type = type dont le dictionnaire est à compléter.            *
 *                                                                             *
+*  Description : Définit les constantes relatives aux instructions brutes.    *
+*                                                                             *
+*  Retour      : true en cas de succès de l'opération, false sinon.           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool define_raw_instruction_constants(PyTypeObject *type)
+{
+    bool result;                            /* Bilan à retourner           */
+    PyObject *values;                       /* Groupe de valeurs à établir */
+
+    values = PyDict_New();
+
+    result = add_const_to_group(values, "PADDING", RIF_PADDING);
+    if (result) result = add_const_to_group(values, "STRING", RIF_STRING);
+
+    if (!result)
+    {
+        Py_DECREF(values);
+        goto exit;
+    }
+
+    result = attach_constants_group_to_type(type, true, "RawInstrFlag", values,
+                                            "Flags for some instruction properties.\n"
+                                            "\n"
+                                            "They can be seen as an extension of" \
+                                            " pychrysalide.arch.ArchInstruction.ArchInstrFlag");
+
+ exit:
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
+*                                                                             *
 *  Description : Définit les constantes liées aux comportements erratiques.   *
 *                                                                             *
 *  Retour      : true en cas de succès de l'opération, false sinon.           *
diff --git a/plugins/pychrysalide/arch/instructions/constants.h b/plugins/pychrysalide/arch/instructions/constants.h
index c25f3f8..2f0c587 100644
--- a/plugins/pychrysalide/arch/instructions/constants.h
+++ b/plugins/pychrysalide/arch/instructions/constants.h
@@ -31,6 +31,9 @@
 
 
 
+/* Définit les constantes relatives aux instructions brutes. */
+bool define_raw_instruction_constants(PyTypeObject *);
+
 /* Définit les constantes liées aux comportements erratiques. */
 bool define_undefined_instruction_constants(PyTypeObject *);
 
diff --git a/plugins/pychrysalide/arch/instructions/module.c b/plugins/pychrysalide/arch/instructions/module.c
index 13a9c8e..5280db8 100644
--- a/plugins/pychrysalide/arch/instructions/module.c
+++ b/plugins/pychrysalide/arch/instructions/module.c
@@ -28,6 +28,7 @@
 #include <assert.h>
 
 
+#include "raw.h"
 #include "undefined.h"
 #include "../../helpers.h"
 
@@ -95,6 +96,7 @@ bool populate_arch_instructions_module(void)
 
     result = true;
 
+    if (result) result = ensure_python_raw_instruction_is_registered();
     if (result) result = ensure_python_undefined_instruction_is_registered();
 
     assert(result);
diff --git a/plugins/pychrysalide/arch/raw.c b/plugins/pychrysalide/arch/instructions/raw.c
index 43f2e5e..10e5c8f 100644
--- a/plugins/pychrysalide/arch/raw.c
+++ b/plugins/pychrysalide/arch/instructions/raw.c
@@ -1,6 +1,6 @@
 
 /* Chrysalide - Outil d'analyse de fichiers binaires
- * raw.c - équivalent Python du fichier "arch/raw.h"
+ * raw.c - équivalent Python du fichier "arch/instructions/raw.h"
  *
  * Copyright (C) 2018-2020 Cyrille Bagard
  *
@@ -28,20 +28,25 @@
 #include <pygobject.h>
 
 
-#include <arch/raw.h>
+#include <i18n.h>
+#include <arch/instructions/raw.h>
+#include <plugins/dt.h>
 
 
 #include "constants.h"
-#include "instruction.h"
-#include "../access.h"
-#include "../helpers.h"
+#include "../instruction.h"
+#include "../vmpa.h"
+#include "../../access.h"
+#include "../../helpers.h"
+#include "../../analysis/content.h"
 
 
 
-#define RAW_INSTRUCTION_DOC                                                     \
-    "The RawInstruction object handles data which is not (yet?) disassembled"   \
-    " as code in a binary."
+/* Accompagne la création d'une instance dérivée en Python. */
+static PyObject *py_raw_instruction_new(PyTypeObject *, PyObject *, PyObject *);
 
+/* Initialise une instance sur la base du dérivé de GObject. */
+static int py_raw_instruction_init(PyObject *, PyObject *, PyObject *);
 
 /* Indique si le contenu de l'instruction est du bourrage. */
 static PyObject *py_raw_instruction_get_padding(PyObject *, void *);
@@ -59,6 +64,192 @@ static int py_raw_instruction_set_string(PyObject *, PyObject *, void *);
 
 /******************************************************************************
 *                                                                             *
+*  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_raw_instruction_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   */
+
+    /* Validations diverses */
+
+    base = get_python_raw_instruction_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_RAW_INSTRUCTION, 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 = objet à initialiser (théoriquement).                  *
+*                args = arguments fournis à l'appel.                          *
+*                kwds = arguments de type key=val fournis.                    *
+*                                                                             *
+*  Description : Initialise une instance sur la base du dérivé de GObject.    *
+*                                                                             *
+*  Retour      : 0.                                                           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static int py_raw_instruction_init(PyObject *self, PyObject *args, PyObject *kwds)
+{
+    int result;                             /* Bilan à retourner           */
+    vmpa2t *addr;                           /* Texte de lecture            */
+    unsigned long mem_size;                 /* Taille de portion brute     */
+    unsigned long long value;               /* Valeur brute à considérer   */
+    GBinContent *content;                   /* Contenu à lire au besoin    */
+    unsigned long count;                    /* Nombre d'éléments à lister  */
+    unsigned int endian;                    /* Type de boutisme impliqué   */
+    int ret;                                /* Bilan de lecture des args.  */
+    PyObject *new_args;                     /* Nouveaux arguments épurés   */
+    PyObject *new_kwds;                     /* Nouveau dictionnaire épuré  */
+    GArchInstruction *fake;                 /* Instruction à copier        */
+    GArchInstruction *instr;                /* Instruction à manipuler     */
+    size_t op_count;                        /* Nombre d'opérande à copier  */
+    size_t i;                               /* Boucle de parcours          */
+    GArchOperand *op;                       /* Opérande à transférer       */
+
+    static char *kwlist[] = { "addr", "mem_size", "value", "content", "count", "endian", NULL };
+
+#define RAW_INSTRUCTION_DOC                                                     \
+    "The RawInstruction object handles data which is not (yet?) disassembled"   \
+    " as code in a binary.\n"                                                   \
+    "\n"                                                                        \
+    "Raw values pointed by this kind of instruction can be immediate values"    \
+    " or strings.\n"                                                            \
+    "\n"                                                                        \
+    "Instances can be created using one of the following constructors:\n"       \
+    "\n"                                                                        \
+    "    RawInstruction(addr, size, value=int)\n"                               \
+    "    RawInstruction(addr, size, content=object, count=int, endian=int)"     \
+    "\n"                                                                        \
+    "Where addr is always a location defined by a pychrysalide.arch.vmpa"       \
+    " object and size is a pychrysalide.analysis.BinContent.MemoryDataSize"     \
+    " constant defining the size of the read immediate value(s).\n"             \
+    "\n"                                                                        \
+    "In the first case, value is used to build an immediate operand for the"    \
+    " instruction.\n"                                                           \
+    "\n"                                                                        \
+    "In the second case, content is a pychrysalide.analysis.BinContent"         \
+    " instance, count states how many items belong to the array and endian"     \
+    " is a pychrysalide.analysis.BinContent.SourceEndian constant defining"     \
+    " the byte order used to read values."
+
+    result = -1;
+
+    /* Récupération des paramètres */
+
+    value = 0;
+    content = NULL;
+    count = 0;
+    endian = 0;
+
+    ret = PyArg_ParseTupleAndKeywords(args, kwds, "O&k|KO&kI", kwlist,
+                                      convert_any_to_vmpa, &addr, &mem_size,
+                                      &value, convert_to_binary_content, &content, &count, &endian);
+    if (!ret) return -1;
+
+    /* Initialisation d'un objet GLib */
+
+    new_args = PyTuple_New(0);
+    new_kwds = PyDict_New();
+
+    ret = PyGObject_Type.tp_init(self, new_args, new_kwds);
+
+    Py_DECREF(new_kwds);
+    Py_DECREF(new_args);
+
+    if (ret == -1) goto clean_exit;
+
+    /* Eléments de base */
+
+    if (content != NULL)
+        fake = g_raw_instruction_new_array(content, mem_size, count, addr, endian);
+    else
+        fake = g_raw_instruction_new_from_value(addr, mem_size, value);
+
+    if (fake == NULL)
+    {
+        PyErr_SetString(PyExc_ValueError, _("Unable to build the object with the given parameters."));
+        goto clean_exit;
+    }
+
+    instr = G_ARCH_INSTRUCTION(pygobject_get(self));
+
+    g_arch_instruction_lock_operands(fake);
+
+    op_count = _g_arch_instruction_count_operands(fake);
+
+    for (i = 0; i < op_count; i++)
+    {
+        op = _g_arch_instruction_get_operand(fake, i);
+        g_arch_instruction_attach_extra_operand(instr, op);
+    }
+
+    g_arch_instruction_unlock_operands(fake);
+
+    g_arch_instruction_set_range(instr, g_arch_instruction_get_range(fake));
+
+    g_object_unref(G_OBJECT(fake));
+
+    result = 0;
+
+ clean_exit:
+
+    clean_vmpa_arg(addr);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
 *  Paramètres  : self    = classe représentant une instruction.               *
 *                closure = adresse non utilisée ici.                          *
 *                                                                             *
@@ -227,7 +418,7 @@ PyTypeObject *get_python_raw_instruction_type(void)
 
         PyVarObject_HEAD_INIT(NULL, 0)
 
-        .tp_name        = "pychrysalide.arch.RawInstruction",
+        .tp_name        = "pychrysalide.arch.instructions.RawInstruction",
         .tp_basicsize   = sizeof(PyGObject),
 
         .tp_flags       = Py_TPFLAGS_DEFAULT,
@@ -237,6 +428,9 @@ PyTypeObject *get_python_raw_instruction_type(void)
         .tp_methods     = py_raw_instruction_methods,
         .tp_getset      = py_raw_instruction_getseters,
 
+        .tp_init        = py_raw_instruction_init,
+        .tp_new         = py_raw_instruction_new,
+
     };
 
     return &py_raw_instruction_type;
@@ -248,7 +442,7 @@ PyTypeObject *get_python_raw_instruction_type(void)
 *                                                                             *
 *  Paramètres  : module = module dont la définition est à compléter.          *
 *                                                                             *
-*  Description : Prend en charge l'objet 'pychrysalide.arch.ArchInstruction'. *
+*  Description : Prend en charge l'objet 'pychrysalide.arch...RawInstruction'.*
 *                                                                             *
 *  Retour      : Bilan de l'opération.                                        *
 *                                                                             *
@@ -266,7 +460,7 @@ bool ensure_python_raw_instruction_is_registered(void)
 
     if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
     {
-        module = get_access_to_python_module("pychrysalide.arch");
+        module = get_access_to_python_module("pychrysalide.arch.instructions");
 
         dict = PyModule_GetDict(module);
 
diff --git a/plugins/pychrysalide/arch/raw.h b/plugins/pychrysalide/arch/instructions/raw.h
index e05e773..46518b5 100644
--- a/plugins/pychrysalide/arch/raw.h
+++ b/plugins/pychrysalide/arch/instructions/raw.h
@@ -1,6 +1,6 @@
 
 /* Chrysalide - Outil d'analyse de fichiers binaires
- * raw.h - prototypes pour l'équivalent Python du fichier "arch/raw.h"
+ * raw.h - prototypes pour l'équivalent Python du fichier "arch/instructions/raw.h"
  *
  * Copyright (C) 2018-2020 Cyrille Bagard
  *
@@ -22,8 +22,8 @@
  */
 
 
-#ifndef _PLUGINS_PYCHRYSALIDE_ARCH_RAW_H
-#define _PLUGINS_PYCHRYSALIDE_ARCH_RAW_H
+#ifndef _PLUGINS_PYCHRYSALIDE_ARCH_INSTRUCTIONS_RAW_H
+#define _PLUGINS_PYCHRYSALIDE_ARCH_INSTRUCTIONS_RAW_H
 
 
 #include <Python.h>
@@ -34,7 +34,7 @@
 /* Fournit un accès à une définition de type à diffuser. */
 PyTypeObject *get_python_raw_instruction_type(void);
 
-/* Prend en charge l'objet 'pychrysalide.arch.RawInstruction'. */
+/* Prend en charge l'objet 'pychrysalide.arch.instructions.RawInstruction'. */
 bool ensure_python_raw_instruction_is_registered(void);
 
 /* Tente de convertir en instruction brute. */
@@ -42,4 +42,4 @@ int convert_to_raw_instruction(PyObject *, void *);
 
 
 
-#endif  /* _PLUGINS_PYCHRYSALIDE_ARCH_RAW_H */
+#endif  /* _PLUGINS_PYCHRYSALIDE_ARCH_INSTRUCTIONS_RAW_H */
diff --git a/plugins/pychrysalide/arch/instructions/undefined.c b/plugins/pychrysalide/arch/instructions/undefined.c
index a2c989e..ee7dc51 100644
--- a/plugins/pychrysalide/arch/instructions/undefined.c
+++ b/plugins/pychrysalide/arch/instructions/undefined.c
@@ -269,7 +269,7 @@ PyTypeObject *get_python_undefined_instruction_type(void)
 *                                                                             *
 *  Paramètres  : module = module dont la définition est à compléter.          *
 *                                                                             *
-*  Description : Prend en charge l'objet 'pychrysalide.arch.ArchInstruction'. *
+*  Description : Prend en charge l'objet 'pychrysalide.....UndefInstruction'. *
 *                                                                             *
 *  Retour      : Bilan de l'opération.                                        *
 *                                                                             *
@@ -279,7 +279,7 @@ PyTypeObject *get_python_undefined_instruction_type(void)
 
 bool ensure_python_undefined_instruction_is_registered(void)
 {
-    PyTypeObject *type;                     /* Type Python 'UndefinedInstruction'*/
+    PyTypeObject *type;                     /* Type 'UndefinedInstruction' */
     PyObject *module;                       /* Module à recompléter        */
     PyObject *dict;                         /* Dictionnaire du module      */
 
diff --git a/plugins/pychrysalide/arch/instructions/undefined.h b/plugins/pychrysalide/arch/instructions/undefined.h
index 4e9090c..3fa0453 100644
--- a/plugins/pychrysalide/arch/instructions/undefined.h
+++ b/plugins/pychrysalide/arch/instructions/undefined.h
@@ -34,7 +34,7 @@
 /* Fournit un accès à une définition de type à diffuser. */
 PyTypeObject *get_python_undefined_instruction_type(void);
 
-/* Prend en charge l'objet 'pychrysalide.arch.UndefinedInstruction'. */
+/* Prend en charge l'objet 'pychrysalide.arch.instructions.UndefInstruction'. */
 bool ensure_python_undefined_instruction_is_registered(void);
 
 /* Tente de convertir en instruction non définie. */
diff --git a/plugins/pychrysalide/arch/module.c b/plugins/pychrysalide/arch/module.c
index 05942a5..1fa017d 100644
--- a/plugins/pychrysalide/arch/module.c
+++ b/plugins/pychrysalide/arch/module.c
@@ -38,7 +38,6 @@
 #include "instruction.h"
 #include "operand.h"
 #include "processor.h"
-#include "raw.h"
 #include "register.h"
 #include "vmpa.h"
 #include "instructions/module.h"
@@ -174,7 +173,6 @@ bool populate_arch_module(void)
     if (result) result = ensure_python_arch_instruction_is_registered();
     if (result) result = ensure_python_arch_operand_is_registered();
     if (result) result = ensure_python_arch_processor_is_registered();
-    if (result) result = ensure_python_raw_instruction_is_registered();
     if (result) result = ensure_python_arch_register_is_registered();
     if (result) result = ensure_python_vmpa_is_registered();
     if (result) result = ensure_python_mrange_is_registered();