Provided some debug helpers as plugin samples.

git-svn-id: svn://svn.gna.org/svn/chrysalide/trunk@330 abbe820e-26c8-41b2-8c08-b7b2b41f8b0a

5 files changed, 115 insertions, 183 deletions

diff --git a/plugins/pychrysa/format/dex/dex.c b/plugins/pychrysa/format/dex/dex.c
index cae87f7..3e2746e 100644
--- a/plugins/pychrysa/format/dex/dex.c
+++ b/plugins/pychrysa/format/dex/dex.c
@@ -168,7 +168,7 @@ static PyObject *py_dex_format_get_class(PyObject *self, PyObject *args)
 
 bool register_python_dex_format(PyObject *module)
 {
-    PyObject *pygobj_mod;                   /* Module Python-GObject       */
+    PyObject *parent_mod;                   /* Accès au module parent      */
     int ret;                                /* Bilan d'un appel            */
 
     static PyMethodDef py_dex_format_methods[] = {
@@ -206,11 +206,11 @@ bool register_python_dex_format(PyObject *module)
 
     };
 
-    pygobj_mod = PyImport_ImportModule("pychrysalide.format");
-    if (pygobj_mod == NULL) return false;
+    parent_mod = PyImport_ImportModule("pychrysalide.format");
+    if (parent_mod == NULL) return false;
 
-    py_dex_format_type.tp_base = (PyTypeObject *)PyObject_GetAttrString(pygobj_mod, "BinFormat");
-    Py_DECREF(pygobj_mod);
+    py_dex_format_type.tp_base = (PyTypeObject *)PyObject_GetAttrString(parent_mod, "ExeFormat");
+    Py_DECREF(parent_mod);
 
     if (PyType_Ready(&py_dex_format_type) < 0)
         return false;
@@ -218,8 +218,14 @@ bool register_python_dex_format(PyObject *module)
     Py_INCREF(&py_dex_format_type);
     ret = PyModule_AddObject(module, "DexFormat", (PyObject *)&py_dex_format_type);
 
+    parent_mod = PyImport_ImportModule("pychrysalide.format");
+    if (parent_mod == NULL) return false;
+
     pygobject_register_class(module, "GDexFormat", G_TYPE_DEX_FORMAT, &py_dex_format_type,
-                             Py_BuildValue("(O)", py_dex_format_type.tp_base));
+                             Py_BuildValue("(OO)", py_dex_format_type.tp_base,
+                                           PyObject_GetAttrString(parent_mod, "BinFormat")));
+
+    Py_DECREF(parent_mod);
 
     return (ret == 0);
 
diff --git a/plugins/pychrysa/format/executable.c b/plugins/pychrysa/format/executable.c
index 43375ea..d4f2df6 100644
--- a/plugins/pychrysa/format/executable.c
+++ b/plugins/pychrysa/format/executable.c
@@ -25,61 +25,23 @@
 #include "executable.h"
 
 
-#include "format.h"
+#include <pygobject.h>
 
 
+#include <format/format.h>
 
 
+#include "../quirks.h"
 
 
 
+/* Crée un nouvel objet Python de type 'BinFormat'. */
+static PyObject *py_executable_format_new(PyTypeObject *, PyObject *, PyObject *);
 
-/******************************************************************************
-*                                                                             *
-*  Paramètres  : format = instance existante GLib.                            *
-*                                                                             *
-*  Description : Crée un nouvel objet Python de type 'ExeFormat'.             *
-*                                                                             *
-*  Retour      : Instance Python mise en place.                               *
-*                                                                             *
-*  Remarques   : -                                                            *
-*                                                                             *
-******************************************************************************/
-
-PyObject *py_executable_format_from_c(GExeFormat *format)
-{
-    return NULL;//py_binary_format_from_c(G_BIN_FORMAT(format));
-
-}
-
-
-
-
-
-
-
-
-/* Classe 'format.executable' pour Python */
-typedef struct _py_executable
-{
-    PyObject_HEAD
-
-    GExeFormat *glib;                       /* Format d'exécutable GLib    */
 
-} py_executable;
 
 
-
-
-/* Crée un nouvel objet Python de type 'py_executable'. */
-static PyObject *py_executable_new(PyTypeObject *, PyObject *, PyObject *);
-
-
-
-
-
-/* Fournit le type d'objet 'format.executable' pour Python. */
-static PyTypeObject *get_format_executable_type(void);
+#define _(str) str
 
 
 
@@ -90,78 +52,20 @@ static PyTypeObject *get_format_executable_type(void);
 *                args = arguments fournis à l'appel.                          *
 *                kwds = arguments de type key=val fournis.                    *
 *                                                                             *
-*  Description : Crée un nouvel objet Python de type 'py_executable'.         *
-*                                                                             *
-*  Retour      : -                                                            *
-*                                                                             *
-*  Remarques   : -                                                            *
-*                                                                             *
-******************************************************************************/
-
-static PyObject *py_executable_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
-{
-    py_executable *result;                  /* Instance à retourner        */
-
-    result = (py_executable *)type->tp_alloc(type, 0);
-
-    return (PyObject *)result;
-
-}
-
-
-/******************************************************************************
-*                                                                             *
-*  Paramètres  : executable = objet GLib existant à transposer.               *
+*  Description : Crée un nouvel objet Python de type 'BinFormat'.             *
 *                                                                             *
-*  Description : Convertit une instance GLib en objet Python 'py_executable'. *
-*                                                                             *
-*  Retour      : -                                                            *
+*  Retour      : Instance Python mise en place.                               *
 *                                                                             *
 *  Remarques   : -                                                            *
 *                                                                             *
 ******************************************************************************/
 
-PyObject *py_executable_convert(GExeFormat *executable)
+static PyObject *py_executable_format_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
 {
-    py_executable *result;                  /* Instance à retourner        */
-    PyTypeObject *type;                     /* Type Python à instancier    */
-
-    result = (py_executable *)g_object_get_data(G_OBJECT(executable), "python_object");
-
-    if (result == NULL)
-    {
-        type = get_format_executable_type();
-
-        result = (py_executable *)type->tp_alloc(type, 0);
-
-        result->glib = executable;
-        g_object_ref(executable);
-
-        g_object_set_data(G_OBJECT(executable), "python_object", result);
-
-    }
-    else Py_INCREF((PyObject *)result);
-
-    return (PyObject *)result;
-
-}
+    PyErr_SetString(PyExc_ValueError, 
+                    _("pychrysalide.format.ExeFormat can not be instanciated directly"));
 
-
-/******************************************************************************
-*                                                                             *
-*  Paramètres  : executable = instance Python dont la référence est à donner. *
-*                                                                             *
-*  Description : Fournit l'instance GLib d'une instance Python.               *
-*                                                                             *
-*  Retour      : -                                                            *
-*                                                                             *
-*  Remarques   : -                                                            *
-*                                                                             *
-******************************************************************************/
-
-GExeFormat *py_executable_get_glib_instance(PyObject *executable)
-{
-    return ((py_executable *)executable)->glib;
+    return NULL;
 
 }
 
@@ -171,81 +75,59 @@ GExeFormat *py_executable_get_glib_instance(PyObject *executable)
 
 
 
-
-
-
 /******************************************************************************
 *                                                                             *
-*  Paramètres  : -                                                            *
+*  Paramètres  : module = module dont la définition est à compléter.          *
 *                                                                             *
-*  Description : Fournit le type d'objet 'format.executable' pour Python.     *
+*  Description : Prend en charge l'objet 'pychrysalide.gui.panels.BinFormat'. *
 *                                                                             *
-*  Retour      : Adresse du type vivant à manipuler.                          *
+*  Retour      : Bilan de l'opération.                                        *
 *                                                                             *
 *  Remarques   : -                                                            *
 *                                                                             *
 ******************************************************************************/
 
-static PyTypeObject *get_format_executable_type(void)
+bool register_python_executable_format(PyObject *module)
 {
-    static PyTypeObject *result = NULL;     /* Type pour objet à retourner */
+    PyObject *parent_mod;                   /* Accès au module parent      */
+    int ret;                                /* Bilan d'un appel            */
 
-    static PyMethodDef py_executable_methods[] = {
+    static PyMethodDef py_executable_format_methods[] = {
         { NULL }
     };
 
-    static PyGetSetDef py_executable_getset[] = {
+    static PyGetSetDef py_executable_format_getseters[] = {
         { NULL }
     };
 
-    static PyTypeObject py_executable_type = {
+    static PyTypeObject py_executable_format_type = {
 
         PyObject_HEAD_INIT(NULL)
 
-        .tp_name        = "pyoida.format.Executable",
-        .tp_basicsize   = sizeof(py_executable),
+        .tp_name        = "pychrysalide.format.ExeFormat",
+        .tp_basicsize   = sizeof(PyGObject),
 
         .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 
-        .tp_doc         = "PyOIDA loaded executable to analyse",
+        .tp_doc         = "PyChrysalide executable format",
 
-        .tp_methods     = py_executable_methods,
-        .tp_getset      = py_executable_getset,
-        .tp_new         = (newfunc)py_executable_new
+        .tp_methods     = py_executable_format_methods,
+        .tp_getset      = py_executable_format_getseters,
+        .tp_new         = (newfunc)py_executable_format_new
 
     };
 
-    if (result == NULL) result = &py_executable_type;
-
-    return result;
-
-}
-
-
-/******************************************************************************
-*                                                                             *
-*  Paramètres  : module = module dont la définition est à compléter.          *
-*                                                                             *
-*  Description : Ajoute l'objet 'format.executable' au module Python.         *
-*                                                                             *
-*  Retour      : -                                                            *
-*                                                                             *
-*  Remarques   : -                                                            *
-*                                                                             *
-******************************************************************************/
-
-bool add_format_executable_to_python_module(PyObject *module)
-{
-    PyTypeObject *py_executable_type;       /* Type défini pour Python     */
-    int ret;                                /* Bilan d'un appel            */
+    parent_mod = PyImport_ImportModule("pychrysalide.format");
+    if (parent_mod == NULL) return false;
 
-    py_executable_type = get_format_executable_type();
+    py_executable_format_type.tp_base = (PyTypeObject *)PyObject_GetAttrString(parent_mod, "BinFormat");
+    Py_DECREF(parent_mod);
 
-    if (PyType_Ready(py_executable_type) < 0)
+    if (PyType_Ready(&py_executable_format_type) < 0)
         return false;
 
-    Py_INCREF(py_executable_type);
-    ret = PyModule_AddObject(module, "Executable", (PyObject *)py_executable_type);
+    Py_INCREF(&py_executable_format_type);
+    ret = PyModule_AddObject(module, "ExeFormat", (PyObject *)&py_executable_format_type);
 
     return (ret == 0);
 
diff --git a/plugins/pychrysa/format/executable.h b/plugins/pychrysa/format/executable.h
index 4109784..50faee6 100644
--- a/plugins/pychrysa/format/executable.h
+++ b/plugins/pychrysa/format/executable.h
@@ -2,7 +2,7 @@
 /* OpenIDA - Outil d'analyse de fichiers binaires
  * executable.h - prototypes pour l'équivalent Python du fichier "format/executable.h"
  *
- * Copyright (C) 2010 Cyrille Bagard
+ * Copyright (C) 2010-2013 Cyrille Bagard
  *
  *  This file is part of OpenIDA.
  *
@@ -22,32 +22,18 @@
  */
 
 
-#ifndef _PLUGINS_PYOIDA_FORMAT_EXECUTABLE_H
-#define _PLUGINS_PYOIDA_FORMAT_EXECUTABLE_H
+#ifndef _PLUGINS_PYCHRYSA_FORMAT_EXECUTABLE_H
+#define _PLUGINS_PYCHRYSA_FORMAT_EXECUTABLE_H
 
 
 #include <Python.h>
 #include <stdbool.h>
 
-#include <format/executable.h>
 
 
+/* Prend en charge l'objet 'pychrysalide.format.ExeFormat'. */
+bool register_python_executable_format(PyObject *module);
 
-/* Crée un nouvel objet Python de type 'ExeFormat'. */
-PyObject *py_executable_format_from_c(GExeFormat *);
 
 
-
-
-/* Convertit une instance GLib en objet Python 'py_executable'. */
-PyObject *py_executable_convert(GExeFormat *);
-
-/* Fournit l'instance GLib d'une instance Python. */
-GExeFormat *py_executable_get_glib_instance(PyObject *);
-
-/* Ajoute l'objet 'format.executable' au module Python. */
-bool add_format_executable_to_python_module(PyObject *);
-
-
-
-#endif  /* _PLUGINS_PYOIDA_FORMAT_EXECUTABLE_H */
+#endif  /* _PLUGINS_PYCHRYSA_FORMAT_EXECUTABLE_H */
diff --git a/plugins/pychrysa/format/format.c b/plugins/pychrysa/format/format.c
index 4032da0..8a4bfb4 100644
--- a/plugins/pychrysa/format/format.c
+++ b/plugins/pychrysa/format/format.c
@@ -31,11 +31,19 @@
 #include <format/format.h>
 
 
-#include "dex/dex.h"
 #include "../quirks.h"
 
 
 
+
+
+
+#define _(str) str
+
+
+
+
+
 /* Crée un nouvel objet Python de type 'BinFormat'. */
 static PyObject *py_binary_format_new(PyTypeObject *, PyObject *, PyObject *);
 
@@ -43,6 +51,11 @@ static PyObject *py_binary_format_new(PyTypeObject *, PyObject *, PyObject *);
 static PyObject *py_binary_format_resolve_relative_routine(PyObject *, PyObject *);
 
 
+/* Fournit le prototype de toutes les routines détectées. */
+static PyObject *py_binary_format_get_routines(PyObject *, void *);
+
+
+
 
 /******************************************************************************
 *                                                                             *
@@ -60,7 +73,10 @@ static PyObject *py_binary_format_resolve_relative_routine(PyObject *, PyObject
 
 static PyObject *py_binary_format_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
 {
-    Py_RETURN_NONE;
+    PyErr_SetString(PyExc_ValueError, 
+                    _("pychrysalide.format.BinFormat can not be instanciated directly"));
+
+    return NULL;
 
 }
 
@@ -70,9 +86,14 @@ static PyObject *py_binary_format_new(PyTypeObject *type, PyObject *args, PyObje
 
 
 
+
+
+
+
+
 /******************************************************************************
 *                                                                             *
-*  Paramètres  : self = classe représentant un binaire.                       *
+*  Paramètres  : self = classe représentant un format binaire.                *
 *                args = arguments fournis à l'appel.                          *
 *                                                                             *
 *  Description : Recherche une position dans une routine selon une adresse.   *
@@ -113,6 +134,39 @@ static PyObject *py_binary_format_resolve_relative_routine(PyObject *self, PyObj
 
 
 
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = classe représentant un format binaire.             *
+*                closure = adresse non utilisée ici.                          *
+*                                                                             *
+*  Description : Fournit le prototype de toutes les routines détectées.       *
+*                                                                             *
+*  Retour      : Liste de routine, vide ou non.                               *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_binary_format_get_routines(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Tuple à retourner           */
+    GBinFormat *format;                     /* Format à manipuler          */
+    GBinRoutine **routines;                 /* Routines binaires présentes */
+    size_t count;                           /* Quantité de ces routines    */
+    size_t i;                               /* Boucle de parcours          */
+
+    format = G_BIN_FORMAT(pygobject_get(self));
+    routines = g_binary_format_get_routines(format, &count);
+
+    result = PyTuple_New(count);
+
+    for (i = 0; i < count; i++)
+        PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(routines[i])));
+
+    return result;
+
+}
+
 
 
 
@@ -143,6 +197,10 @@ bool register_python_binary_format(PyObject *module)
     };
 
     static PyGetSetDef py_binary_format_getseters[] = {
+        {
+            "routines", (getter)py_binary_format_get_routines, (setter)NULL,
+            "Provide the list of all detected routines in the binary format.", NULL
+        },
         { NULL }
     };
 
diff --git a/plugins/pychrysa/format/module.c b/plugins/pychrysa/format/module.c
index 92c3966..3045dac 100644
--- a/plugins/pychrysa/format/module.c
+++ b/plugins/pychrysa/format/module.c
@@ -2,7 +2,7 @@
 /* OpenIDA - Outil d'analyse de fichiers binaires
  * module.c - intégration du répertoire format en tant que module
  *
- * Copyright (C) 2010 Cyrille Bagard
+ * Copyright (C) 2010-2013 Cyrille Bagard
  *
  *  This file is part of OpenIDA.
  *
@@ -64,7 +64,7 @@ bool add_format_module_to_python_module(PyObject *super)
     result = (ret == 0);
 
     result &= register_python_binary_format(module);
-    result &= add_format_executable_to_python_module(module);
+    result &= register_python_executable_format(module);
 
     result &= add_format_dex_module_to_python_module(module);