Restore the definition of main operands.gtk4

1 files changed, 461 insertions, 0 deletions

diff --git a/plugins/pychrysalide/arch/operand-ui.c b/plugins/pychrysalide/arch/operand-ui.c
new file mode 100644
index 0000000..5062513
--- /dev/null
+++ b/plugins/pychrysalide/arch/operand-ui.c
@@ -0,0 +1,461 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * operand-ui.c - équivalent Python du fichier "arch/operand-ui.c"
+ *
+ * Copyright (C) 2025 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 "operand-ui.h"
+
+
+#include <assert.h>
+#include <pygobject.h>
+
+
+#include <arch/operand-ui-int.h>
+
+
+#include "../access.h"
+#include "../helpers.h"
+
+
+
+/* Procède à l'initialisation de l'interface d'exportation. */
+static void py_arch_operand_ui_interface_init(GArchOperandUIInterface *, gpointer *);
+
+/* Traduit un opérande en version humainement lisible. */
+static void py_arch_operand_ui_print_wrapper(const GArchOperandUI *, GBufferLine *);
+
+/* Construit un petit résumé concis de l'opérande. */
+static char *py_arch_operand_ui_build_tooltip_wrapper(const GArchOperandUI *, const GLoadedBinary *);
+
+/* Traduit un opérande en version humainement lisible. */
+static PyObject *py_arch_operand_ui_print(PyObject *, PyObject *);
+
+/* Construit un petit résumé concis de l'opérande. */
+static PyObject *py_arch_operand_ui_build_tooltip(PyObject *, PyObject *);
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : iface  = interface GLib à initialiser.                       *
+*                unused = adresse non utilisée ici.                           *
+*                                                                             *
+*  Description : Procède à l'initialisation de l'interface d'exportation.     *
+*                                                                             *
+*  Retour      : -                                                            *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static void py_arch_operand_ui_interface_init(GArchOperandUIInterface *iface, gpointer *unused)
+{
+#define ARCH_OPERAND_UI_DOC                                                 \
+    "The ArchOperandUI interface ensure pychrysalide.arch.ArchOperand"      \
+    " implementations provide UI features when Chrysalide is running with"  \
+    " a GUI.\n"                                                             \
+    "\n"                                                                    \
+    "A typical class declaration for a new implementation looks like:\n"    \
+    "\n"                                                                    \
+    "    class NewImplem(ArchOperand, ArchOperandUi):\n"                    \
+    "        ...\n"                                                         \
+    "\n"                                                                    \
+    "The following method has to be defined for new implementations:\n"     \
+    "* pychrysalide.arch.ArchOperandUI._print();\n"                         \
+    "* pychrysalide.arch.ArchOperandUI._build_tooltip().\n"
+
+    iface->print = py_arch_operand_ui_print_wrapper;
+    iface->build_tooltip = py_arch_operand_ui_build_tooltip_wrapper;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : operand = registre visé par la procédure.                    *
+*                                                                             *
+*  Description : Traduit un opérande en version humainement lisible.          *
+*                                                                             *
+*  Retour      : -                                                            *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static void py_arch_operand_ui_print_wrapper(const GArchOperandUI *operand, GBufferLine *line)
+{
+    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
+    PyObject *pyobj;                        /* Objet Python concerné       */
+    PyObject *args;                         /* Arguments pour l'appel      */
+    PyObject *pyret;                        /* Bilan de consultation       */
+
+#define ARCH_OPERAND_UI_PRINT_WRAPPER PYTHON_WRAPPER_DEF            \
+(                                                                   \
+    _print, "$self, line, /",                                       \
+    METH_VARARGS,                                                   \
+    "Abstract method used to print an operand into a rendering"     \
+    " *line*, which is a provided pychrysalide.glibext.BufferLine"  \
+    " instance."                                                    \
+)
+
+    gstate = PyGILState_Ensure();
+
+    pyobj = pygobject_new(G_OBJECT(operand));
+
+    if (has_python_method(pyobj, "_print"))
+    {
+        args = PyTuple_New(1);
+        PyTuple_SetItem(args, 0, pygobject_new(G_OBJECT(line)));
+
+        pyret = run_python_method(pyobj, "_print", args);
+
+        Py_XDECREF(pyret);
+
+        Py_DECREF(args);
+
+    }
+
+    Py_DECREF(pyobj);
+
+    PyGILState_Release(gstate);
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : operand = opérande à consulter.                              *
+*                binary  = informations relatives au binaire chargé.          *
+*                                                                             *
+*  Description : Construit un petit résumé concis de l'opérande.              *
+*                                                                             *
+*  Retour      : Chaîne de caractères à libérer après usage ou NULL.          *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static char *py_arch_operand_ui_build_tooltip_wrapper(const GArchOperandUI *operand, const GLoadedBinary *binary)
+{
+    char *result;                           /* Description à retourner     */
+    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
+    PyObject *pyobj;                        /* Objet Python concerné       */
+    PyObject *args;                         /* Arguments pour l'appel      */
+    PyObject *pyret;                        /* Bilan de consultation       */
+
+#define ARCH_OPERAND_UI_BUILD_TOOLTIP_WRAPPER PYTHON_WRAPPER_DEF    \
+(                                                                   \
+    _build_tooltip, "$self, binary, /",                             \
+    METH_VARARGS,                                                   \
+    "Abstract method used to build a tooltip text shown when the"   \
+    " mouse is over an operand.\n"                                  \
+    "\n"                                                            \
+    "A pychrysalide.analysis.LoadedBinary instance is provided in"  \
+    " case of need."                                                \
+)
+
+    result = NULL;
+
+    gstate = PyGILState_Ensure();
+
+    pyobj = pygobject_new(G_OBJECT(operand));
+
+    if (has_python_method(pyobj, "_build_tooltip"))
+    {
+        args = PyTuple_New(1);
+        PyTuple_SetItem(args, 0, pygobject_new(G_OBJECT(binary)));
+
+        pyret = run_python_method(pyobj, "_build_tooltip", args);
+
+        if (pyret != NULL)
+        {
+            if (PyUnicode_Check(pyret))
+                result = strdup(PyUnicode_AsUTF8(pyret));
+        }
+
+        Py_XDECREF(pyret);
+
+        Py_DECREF(args);
+
+    }
+
+    Py_DECREF(pyobj);
+
+    PyGILState_Release(gstate);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = objet manipulé ici.                                   *
+*                args = adresse non utilisée ici.                             *
+*                                                                             *
+*  Description : Traduit un opérande en version humainement lisible.          *
+*                                                                             *
+*  Retour      : -                                                            *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_arch_operand_ui_print(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Emplacement à retourner     */
+
+#if 0   // TODO
+
+    GBufferLine *line;                      /* Zone d'impression du rendu  */
+    int ret;                                /* Bilan de lecture des args.  */
+    GArchOperandUI *operand;                /* Mécanismes natifs           */
+
+#define ARCH_OPERAND_UI_PRINT_METHOD PYTHON_METHOD_DEF              \
+(                                                                   \
+    print, "$self, line",                                           \
+    METH_VARARGS, py_arch_operand_ui,                               \
+    "Translate an operand into a human readable version.\n"         \
+    "\n"                                                            \
+    "The *line* arguement is a pychrysalide.glibext.BufferLine"     \
+    " instance which has to get filled with rendering"              \
+    " information.\n"                                               \
+    "\n"                                                            \
+    "The result returns nothing (*None*)."                          \
+)
+
+    ret = PyArg_ParseTuple(args, "O&", convert_to_buffer_line, &line);
+    if (!ret) return NULL;
+
+    operand = G_ARCH_OPERAND_UI(pygobject_get(self));
+
+    g_arch_operand_ui_print(operand, line);
+
+#endif
+
+    result = Py_None;
+    Py_INCREF(result);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = objet manipulé ici.                                   *
+*                args = adresse non utilisée ici.                             *
+*                                                                             *
+*  Description : Construit un petit résumé concis de l'opérande.              *
+*                                                                             *
+*  Retour      : Chaîne de caractères à libérer après usage ou None.          *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_arch_operand_ui_build_tooltip(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Emplacement à retourner     */
+
+#if 0   // TODO
+
+    GLoadedBinary *binary;                  /* Infos sur le binaire chargé */
+    int ret;                                /* Bilan de lecture des args.  */
+    GArchOperandUI *operand;                /* Mécanismes natifs           */
+    char *tooltip;                          /* Eventuelle indication       */
+
+#define ARCH_OPERAND_UI_BUILD_TOOLTIP_METHOD PYTHON_METHOD_DEF      \
+(                                                                   \
+    build_tooltip, "$self, binary",                                 \
+    METH_VARARGS, py_arch_operand_ui,                               \
+    "Build a tooltip text shown when the mouse is over an"          \
+    " operand.\n"                                                   \
+    "\n"                                                            \
+    "The *binary* argument is a pychrysalide.analysis.LoadedBinary" \
+    " instance provided in case of need."                           \
+    "\n"                                                            \
+    "The result is a string or *None* in case of error."            \
+)
+
+    ret = PyArg_ParseTuple(args, "O&", convert_to_loaded_binary, &binary);
+    if (!ret) return NULL;
+
+    operand = G_ARCH_OPERAND_UI(pygobject_get(self));
+
+    tooltip = g_arch_operand_ui_build_tooltip(operand, binary);
+
+    if (tooltip != NULL)
+    {
+        PyUnicode_FromString(tooltip);
+        free(tooltip);
+    }
+    else
+
+#endif
+
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+
+    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_arch_operand_ui_type(void)
+{
+    static PyMethodDef py_arch_operand_ui_methods[] = {
+        ARCH_OPERAND_UI_PRINT_WRAPPER,
+        ARCH_OPERAND_UI_BUILD_TOOLTIP_WRAPPER,
+#if 0   // TODO
+        ARCH_OPERAND_UI_PRINT_METHOD,
+        ARCH_OPERAND_UI_BUILD_TOOLTIP_METHOD,
+#endif
+        { NULL }
+    };
+
+    static PyGetSetDef py_arch_operand_ui_getseters[] = {
+        { NULL }
+    };
+
+    static PyTypeObject py_arch_operand_ui_type = {
+
+        PyVarObject_HEAD_INIT(NULL, 0)
+
+        .tp_name        = "pychrysalide.arch.ArchOperandUI",
+        .tp_basicsize   = sizeof(PyObject),
+
+        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
+
+        .tp_doc         = ARCH_OPERAND_UI_DOC,
+
+        .tp_methods     = py_arch_operand_ui_methods,
+        .tp_getset      = py_arch_operand_ui_getseters
+
+    };
+
+    return &py_arch_operand_ui_type;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Prend en charge l'objet 'pychrysalide.arch.ArchOperandUI'.   *
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool ensure_python_arch_operand_ui_is_registered(void)
+{
+    PyTypeObject *type;                     /* Type Python 'ArchOperandUI' */
+    PyObject *module;                       /* Module à recompléter        */
+    PyObject *dict;                         /* Dictionnaire du module      */
+
+    static GInterfaceInfo info = {          /* Paramètres d'inscription    */
+
+        .interface_init = (GInterfaceInitFunc)py_arch_operand_ui_interface_init,
+        .interface_finalize = NULL,
+        .interface_data = NULL,
+
+    };
+
+    type = get_python_arch_operand_ui_type();
+
+    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
+    {
+        module = get_access_to_python_module("pychrysalide.arch");
+
+        dict = PyModule_GetDict(module);
+
+        if (!register_interface_for_pygobject(dict, G_TYPE_ARCH_OPERAND_UI, type, &info))
+            return false;
+
+    }
+
+    return true;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  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 interface d'exportation graphique.     *
+*                                                                             *
+*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+int convert_to_arch_operand_ui(PyObject *arg, void *dst)
+{
+    int result;                             /* Bilan à retourner           */
+
+    result = PyObject_IsInstance(arg, (PyObject *)get_python_arch_operand_ui_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 UI arch operand");
+            break;
+
+        case 1:
+            *((GArchOperandUI **)dst) = G_ARCH_OPERAND_UI(pygobject_get(arg));
+            break;
+
+        default:
+            assert(false);
+            break;
+
+    }
+
+    return result;
+
+}