Included the string symbols in the Python API.

8 files changed, 472 insertions, 0 deletions

diff --git a/plugins/pychrysalide/arch/Makefile.am b/plugins/pychrysalide/arch/Makefile.am
index da66457..6210ed3 100644
--- a/plugins/pychrysalide/arch/Makefile.am
+++ b/plugins/pychrysalide/arch/Makefile.am
@@ -2,6 +2,7 @@
 noinst_LTLIBRARIES = libpychrysaarch.la
 
 libpychrysaarch_la_SOURCES =			\
+	feeder.h feeder.c					\
 	immediate.h immediate.c				\
 	instriter.h instriter.c				\
 	instruction.h instruction.c			\
diff --git a/plugins/pychrysalide/arch/feeder.c b/plugins/pychrysalide/arch/feeder.c
new file mode 100644
index 0000000..b50124d
--- /dev/null
+++ b/plugins/pychrysalide/arch/feeder.c
@@ -0,0 +1,113 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * feeder.c - prototypes pour l'équivalent Python du fichier "arch/feeder.c"
+ *
+ * Copyright (C) 2018 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 "feeder.h"
+
+
+#include <assert.h>
+#include <pygobject.h>
+
+
+#include <arch/feeder.h>
+
+
+#include "../access.h"
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Fournit un accès à une définition de type à diffuser.        *
+*                                                                             *
+*  Retour      : Définition d'objet pour Python.                              *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+PyTypeObject *get_python_proxy_feeder_type(void)
+{
+    static PyMethodDef py_proxy_feeder_methods[] = {
+        { NULL }
+    };
+
+    static PyGetSetDef py_proxy_feeder_getseters[] = {
+        { NULL }
+    };
+
+    static PyTypeObject py_proxy_feeder_type = {
+
+        PyVarObject_HEAD_INIT(NULL, 0)
+
+        .tp_name        = "pychrysalide.arch.ProxyFeeder",
+        .tp_basicsize   = sizeof(PyObject),
+
+        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
+
+        .tp_doc         = "PyChrysalide proxy feeder",
+
+        .tp_methods     = py_proxy_feeder_methods,
+        .tp_getset      = py_proxy_feeder_getseters
+
+    };
+
+    return &py_proxy_feeder_type;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Prend en charge l'objet 'pychrysalide.arch.ProxyFeeder'.     *
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool ensure_python_proxy_feeder_is_registered(void)
+{
+    PyTypeObject *type;                     /* Type Python 'ProxyFeeder'   */
+    PyObject *module;                       /* Module à recompléter        */
+    PyObject *dict;                         /* Dictionnaire du module      */
+
+    type = get_python_proxy_feeder_type();
+
+    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
+    {
+        module = get_access_to_python_module("pychrysalide.arch");
+
+        dict = PyModule_GetDict(module);
+        pyg_register_interface(dict, "ProxyFeeder", G_TYPE_PROXY_FEEDER, type);
+
+    }
+
+    return true;
+
+}
diff --git a/plugins/pychrysalide/arch/feeder.h b/plugins/pychrysalide/arch/feeder.h
new file mode 100644
index 0000000..2655bbc
--- /dev/null
+++ b/plugins/pychrysalide/arch/feeder.h
@@ -0,0 +1,42 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * feeder.h - prototypes pour l'équivalent Python du fichier "arch/feeder.h"
+ *
+ * Copyright (C) 2018 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_ARCH_FEEDER_H
+#define _PLUGINS_PYCHRYSALIDE_ARCH_FEEDER_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Fournit un accès à une définition de type à diffuser. */
+PyTypeObject *get_python_proxy_feeder_type(void);
+
+/* Prend en charge l'objet 'pychrysalide.arch.ProxyFeeder'. */
+bool ensure_python_proxy_feeder_is_registered(void);
+
+
+
+#endif  /* _PLUGINS_PYCHRYSALIDE_ARCH_FEEDER_H */
diff --git a/plugins/pychrysalide/arch/module.c b/plugins/pychrysalide/arch/module.c
index c81a762..009dc7b 100644
--- a/plugins/pychrysalide/arch/module.c
+++ b/plugins/pychrysalide/arch/module.c
@@ -31,6 +31,7 @@
 #include <arch/archbase.h>
 
 
+#include "feeder.h"
 #include "immediate.h"
 #include "instriter.h"
 #include "instruction.h"
@@ -148,6 +149,7 @@ bool populate_arch_module(void)
 
     result = true;
 
+    if (result) result = ensure_python_proxy_feeder_is_registered();
     if (result) result = ensure_python_imm_operand_is_registered();
     if (result) result = ensure_python_instr_iterator_is_registered();
     if (result) result = ensure_python_arch_instruction_is_registered();
diff --git a/plugins/pychrysalide/format/Makefile.am b/plugins/pychrysalide/format/Makefile.am
index f96bf81..847f8e4 100644
--- a/plugins/pychrysalide/format/Makefile.am
+++ b/plugins/pychrysalide/format/Makefile.am
@@ -6,6 +6,7 @@ libpychrysaformat_la_SOURCES =			\
 	flat.h flat.c						\
 	format.h format.c					\
 	module.h module.c					\
+	strsym.h strsym.c					\
 	symbol.h symbol.c					\
 	symiter.h symiter.c
 
diff --git a/plugins/pychrysalide/format/module.c b/plugins/pychrysalide/format/module.c
index 46d8f43..2f90792 100644
--- a/plugins/pychrysalide/format/module.c
+++ b/plugins/pychrysalide/format/module.c
@@ -31,6 +31,7 @@
 #include "executable.h"
 #include "flat.h"
 #include "format.h"
+#include "strsym.h"
 #include "symbol.h"
 #include "symiter.h"
 #include "../helpers.h"
@@ -95,6 +96,7 @@ bool populate_format_module(void)
     if (result) result = ensure_python_executable_format_is_registered();
     if (result) result = ensure_python_flat_format_is_registered();
     if (result) result = ensure_python_binary_format_is_registered();
+    if (result) result = ensure_python_string_symbol_is_registered();
     if (result) result = ensure_python_binary_symbol_is_registered();
     if (result) result = ensure_python_sym_iterator_is_registered();
 
diff --git a/plugins/pychrysalide/format/strsym.c b/plugins/pychrysalide/format/strsym.c
new file mode 100644
index 0000000..f0f47d0
--- /dev/null
+++ b/plugins/pychrysalide/format/strsym.c
@@ -0,0 +1,269 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * strsym.c - équivalent Python du fichier "format/strsym.h"
+ *
+ * Copyright (C) 2015-2017 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 "strsym.h"
+
+
+#include <malloc.h>
+#include <pygobject.h>
+
+
+#include <i18n.h>
+
+
+#include <format/strsym.h>
+
+
+#include "symbol.h"
+#include "../access.h"
+#include "../helpers.h"
+#include "../arch/feeder.h"
+
+
+
+/* Fournit la chaîne brute de caractères du symbole. */
+static PyObject *py_string_symbol_get_raw(PyObject *, void *);
+
+/* Fournit la chaîne de caractères du symbole. */
+static PyObject *py_string_symbol_get_utf8(PyObject *, void *);
+
+/* Fournit l'encodage d'une chaîne de caractères. */
+static PyObject *py_string_symbol_get_encoding(PyObject *, void *);
+
+/* Définit les constantes pour les chaînes de caractères. */
+static bool py_string_symbol_define_constants(PyTypeObject *);
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit la chaîne brute de caractères du symbole.            *
+*                                                                             *
+*  Retour      : Chaîne de caractères d'origine.                              *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_string_symbol_get_raw(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GStrSymbol *symbol;                     /* Elément à consulter         */
+    const char *data;                       /* Données à manipuler         */
+
+    symbol = G_STR_SYMBOL(pygobject_get(self));
+    data = g_string_symbol_get_raw(symbol);
+
+    result = PyBytes_FromString(data);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit la chaîne de caractères du symbole.                  *
+*                                                                             *
+*  Retour      : Chaîne de caractères, à priori en UTF-8.                     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_string_symbol_get_utf8(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GStrSymbol *symbol;                     /* Elément à consulter         */
+    const char *data;                       /* Données à manipuler         */
+
+    symbol = G_STR_SYMBOL(pygobject_get(self));
+    data = g_string_symbol_get_raw(symbol);
+
+    result = PyUnicode_FromString(data);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit l'encodage d'une chaîne de caractères.               *
+*                                                                             *
+*  Retour      : Type d'encodage utilisé.                                     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_string_symbol_get_encoding(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GStrSymbol *symbol;                     /* Elément à consulter         */
+    StringEncodingType encoding;            /* Encodage associé à la chaîne*/
+
+    symbol = G_STR_SYMBOL(pygobject_get(self));
+    encoding = g_string_symbol_get_encoding(symbol);
+
+    result = PyLong_FromLong(encoding);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : obj_type = type dont le dictionnaire est à compléter.        *
+*                                                                             *
+*  Description : Définit les constantes pour les chaînes de caractères.       *
+*                                                                             *
+*  Retour      : true en cas de succès de l'opération, false sinon.           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static bool py_string_symbol_define_constants(PyTypeObject *obj_type)
+{
+    bool result;                            /* Bilan à retourner           */
+
+    result = true;
+
+    result &= PyDict_AddIntMacro(obj_type, SET_ASCII);
+    result &= PyDict_AddIntMacro(obj_type, SET_UTF_8);
+    result &= PyDict_AddIntMacro(obj_type, SET_MUTF_8);
+
+    result &= PyDict_AddIntMacro(obj_type, SET_GUESS);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Fournit un accès à une définition de type à diffuser.        *
+*                                                                             *
+*  Retour      : Définition d'objet pour Python.                              *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+PyTypeObject *get_python_string_symbol_type(void)
+{
+    static PyMethodDef py_str_symbol_methods[] = {
+        { NULL }
+    };
+
+    static PyGetSetDef py_str_symbol_getseters[] = {
+        {
+            "raw", py_string_symbol_get_raw, NULL,
+            "String content as raw data.", NULL
+        },
+        {
+            "utf8", py_string_symbol_get_utf8, NULL,
+            "String content as UTF-8 data.", NULL
+        },
+        {
+            "encoding", py_string_symbol_get_encoding, NULL,
+            "Encoding of the string.", NULL
+        },
+        { NULL }
+    };
+
+    static PyTypeObject py_str_symbol_type = {
+
+        PyVarObject_HEAD_INIT(NULL, 0)
+
+        .tp_name        = "pychrysalide.format.StrSymbol",
+        .tp_basicsize   = sizeof(PyGObject),
+
+        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
+
+        .tp_doc         = "PyChrysalide string symbol",
+
+        .tp_methods     = py_str_symbol_methods,
+        .tp_getset      = py_str_symbol_getseters
+
+    };
+
+    return &py_str_symbol_type;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Prend en charge l'objet 'pychrysalide.format.StrSymbol'.     *
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool ensure_python_string_symbol_is_registered(void)
+{
+    PyTypeObject *type;                     /* Type Python 'StrSymbol'     */
+    PyObject *module;                       /* Module à recompléter        */
+    PyObject *dict;                         /* Dictionnaire du module      */
+
+    type = get_python_string_symbol_type();
+
+    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
+    {
+        module = get_access_to_python_module("pychrysalide.format");
+
+        dict = PyModule_GetDict(module);
+
+        if (!ensure_python_proxy_feeder_is_registered())
+            return false;
+
+        if (!register_class_for_pygobject(dict, G_TYPE_STR_SYMBOL, type, get_python_binary_symbol_type()))
+            return false;
+
+        if (!py_string_symbol_define_constants(type))
+            return false;
+
+    }
+
+    return true;
+
+}
diff --git a/plugins/pychrysalide/format/strsym.h b/plugins/pychrysalide/format/strsym.h
new file mode 100644
index 0000000..3b1b587
--- /dev/null
+++ b/plugins/pychrysalide/format/strsym.h
@@ -0,0 +1,42 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * strsym.h - prototypes pour l'équivalent Python du fichier "format/strsym.h"
+ *
+ * Copyright (C) 2018 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_FORMAT_STRSYM_H
+#define _PLUGINS_PYCHRYSALIDE_FORMAT_STRSYM_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Fournit un accès à une définition de type à diffuser. */
+PyTypeObject *get_python_string_symbol_type(void);
+
+/* Prend en charge l'objet 'pychrysalide.format.StrSymbol'. */
+bool ensure_python_string_symbol_is_registered(void);
+
+
+
+#endif  /* _PLUGINS_PYCHRYSALIDE_FORMAT_STRSYM_H */