Updated all the code relative to GUI items.

7 files changed, 303 insertions, 50 deletions

diff --git a/plugins/pychrysalide/gui/Makefile.am b/plugins/pychrysalide/gui/Makefile.am
index 7f983d9..06c9db9 100644
--- a/plugins/pychrysalide/gui/Makefile.am
+++ b/plugins/pychrysalide/gui/Makefile.am
@@ -3,7 +3,7 @@ noinst_LTLIBRARIES = libpychrysagui.la
 
 libpychrysagui_la_SOURCES =				\
 	constants.h constants.c				\
-	editem.h editem.c					\
+	item.h item.c						\
 	module.h module.c					\
 	panel.h panel.c
 
diff --git a/plugins/pychrysalide/gui/constants.c b/plugins/pychrysalide/gui/constants.c
index 40942f6..3cd943c 100644
--- a/plugins/pychrysalide/gui/constants.c
+++ b/plugins/pychrysalide/gui/constants.c
@@ -71,3 +71,59 @@ bool define_panel_item_constants(PyTypeObject *type)
     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 PanelItemPersonality.        *
+*                                                                             *
+*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+int convert_to_panel_item_personality(PyObject *arg, void *dst)
+{
+    int result;                             /* Bilan à retourner           */
+    unsigned long value;                    /* Valeur transcrite           */
+
+    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 PanelItemPersonality");
+            break;
+
+        case 1:
+            value = PyLong_AsUnsignedLong(arg);
+
+            if (value > PIP_COUNT)
+            {
+                PyErr_SetString(PyExc_TypeError, "invalid value for PanelItemPersonality");
+                result = 0;
+            }
+
+            else
+                *((PanelItemPersonality *)dst) = value;
+
+            break;
+
+        default:
+            assert(false);
+            break;
+
+    }
+
+    return result;
+
+}
diff --git a/plugins/pychrysalide/gui/constants.h b/plugins/pychrysalide/gui/constants.h
index 8810ee1..247546c 100644
--- a/plugins/pychrysalide/gui/constants.h
+++ b/plugins/pychrysalide/gui/constants.h
@@ -34,6 +34,9 @@
 /* Définit les constantes pour les panneaux graphiques. */
 bool define_panel_item_constants(PyTypeObject *);
 
+/* Tente de convertir en constante PanelItemPersonality. */
+int convert_to_panel_item_personality(PyObject *, void *);
+
 
 
 #endif  /* _PLUGINS_PYCHRYSALIDE_GUI_CONSTANTS_H */
diff --git a/plugins/pychrysalide/gui/editem.c b/plugins/pychrysalide/gui/item.c
index 504f074..45190e4 100644
--- a/plugins/pychrysalide/gui/editem.c
+++ b/plugins/pychrysalide/gui/item.c
@@ -1,6 +1,6 @@
 
 /* Chrysalide - Outil d'analyse de fichiers binaires
- * editem.c - prototypes pour l'équivalent Python du fichier "gui/editem.c"
+ * item.c - prototypes pour l'équivalent Python du fichier "gui/item.c"
  *
  * Copyright (C) 2018-2020 Cyrille Bagard
  *
@@ -22,13 +22,14 @@
  */
 
 
-#include "editem.h"
+#include "item.h"
 
 
+#include <malloc.h>
 #include <pygobject.h>
 
 
-#include <gui/editem-int.h>
+#include <gui/item-int.h>
 
 
 #include "../access.h"
@@ -47,6 +48,11 @@
     " is aimed to deal with all editor items at once. Thus such functions are"  \
     " located in this module."                                                  \
     "\n"                                                                        \
+    "Several items have to be defined as class attributes in the final"         \
+    " class:\n"                                                                 \
+    "* *_key*: a string providing a small name used to identify the item;\n"    \
+    "* *_widget*: a Gtk.Widget instance for the content to display.\n"          \
+    "\n"                                                                        \
     "The following special method can be overridden:\n"                         \
     "* _change_content(self, old, new): get notified about a"                   \
     " pychrysalide.analysis.LoadedContent change.\n"                            \
@@ -66,6 +72,12 @@
 /* ------------------------ GLUE POUR CREATION DEPUIS PYTHON ------------------------ */
 
 
+/* Fournit le nom interne attribué à l'élément réactif. */
+static char *py_editor_item_get_key_wrapper(const GEditorItem *);
+
+/* Fournit le composant GTK associé à l'élément réactif. */
+static GtkWidget *py_editor_item_get_widget_wrapper(const GEditorItem *);
+
 /* Réagit à un changement de contenu chargé en cours d'analyse. */
 static void py_editor_item_change_content_wrapper(GEditorItem *, GLoadedContent *, GLoadedContent *);
 
@@ -86,8 +98,8 @@ static void py_editor_item_focus_cursor_wrapper(GEditorItem *, GLoadedContent *,
 /* -------------------------- FONCTIONNALITES D'UN ELEMENT -------------------------- */
 
 
-/* Fournit le nom humain attribué à l'élément réactif. */
-static PyObject *py_editor_item_get_name(PyObject *, void *);
+/* Fournit le nom interne attribué à l'élément réactif. */
+static PyObject *py_editor_item_get_key(PyObject *, void *);
 
 /* Fournit le composant GTK associé à l'élément réactif. */
 static PyObject *py_editor_item_get_widget(PyObject *, void *);
@@ -114,6 +126,9 @@ static PyObject *py_editor_item_get_widget(PyObject *, void *);
 
 void py_editor_item_init_gclass(GEditorItemClass *class, gpointer unused)
 {
+    class->get_key = py_editor_item_get_key_wrapper;
+    class->get_widget = py_editor_item_get_widget_wrapper;
+
     class->change_content = py_editor_item_change_content_wrapper;
     class->change_view = py_editor_item_change_view_wrapper;
     class->update_view = py_editor_item_update_view_wrapper;
@@ -127,6 +142,144 @@ void py_editor_item_init_gclass(GEditorItemClass *class, gpointer unused)
 /******************************************************************************
 *                                                                             *
 *  Paramètres  : item = instance à consulter.                                 *
+*                                                                             *
+*  Description : Fournit le nom interne attribué à l'élément réactif.         *
+*                                                                             *
+*  Retour      : Désignation (courte) de l'élément de l'éditeur.              *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static char *py_editor_item_get_key_wrapper(const GEditorItem *item)
+{
+    char *result;                           /* Désignation à retourner     */
+    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
+    PyObject *pyobj;                        /* Objet Python concerné       */
+    PyObject *pykey;                        /* Clef en objet Python        */
+    int ret;                                /* Bilan d'une conversion      */
+
+#define EDITOR_ITEM_KEY_ATTRIB_WRAPPER PYTHON_GETTER_WRAPPER_DEF    \
+(                                                                   \
+    _key,                                                          \
+    "Provide the internal name to use for the editor item.\n"       \
+    "\n"                                                            \
+    "The result has to be a string."                                \
+)
+
+    result = NULL;
+
+    gstate = PyGILState_Ensure();
+
+    pyobj = pygobject_new(G_OBJECT(item));
+
+    if (PyObject_HasAttrString(pyobj, "_key"))
+    {
+        pykey = PyObject_GetAttrString(pyobj, "_key");
+
+        if (pykey != NULL)
+        {
+            ret = PyUnicode_Check(pykey);
+
+            if (ret)
+                result = strdup(PyUnicode_AsUTF8(pykey));
+
+            Py_DECREF(pykey);
+
+        }
+
+    }
+
+    Py_DECREF(pyobj);
+
+    PyGILState_Release(gstate);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : item = instance à consulter.                                 *
+*                                                                             *
+*  Description : Fournit le composant GTK associé à l'élément réactif.        *
+*                                                                             *
+*  Retour      : Instance de composant graphique chargé.                      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static GtkWidget *py_editor_item_get_widget_wrapper(const GEditorItem *item)
+{
+    GtkWidget *result;                      /* Composant GTK à renvoyer    */
+    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
+    PyObject *pyobj;                        /* Objet Python concerné       */
+    PyObject *pywidget;                     /* Composant en objet Python   */
+    PyObject *gtk_mod;                      /* Module Python Gtk           */
+    PyObject *type;                         /* Module "GtkWidget"          */
+    int ret;                                /* Bilan d'une conversion      */
+
+#define EDITOR_ITEM_WIDGET_ATTRIB_WRAPPER PYTHON_GETTER_WRAPPER_DEF     \
+(                                                                       \
+    _widget,                                                            \
+    "Provide the Gtk widget base involved in the editor item.\n"        \
+    "\n"                                                                \
+    "The result has to be a Gtk.Widget instance."                       \
+)
+
+    result = NULL;
+
+    gstate = PyGILState_Ensure();
+
+    pyobj = pygobject_new(G_OBJECT(item));
+
+    if (PyObject_HasAttrString(pyobj, "_widget"))
+    {
+        pywidget = PyObject_GetAttrString(pyobj, "_widget");
+
+        if (pywidget != NULL)
+        {
+            gtk_mod = PyImport_ImportModule("gi.repository.Gtk");
+
+            if (gtk_mod == NULL)
+            {
+                PyErr_SetString(PyExc_TypeError, "unable to find the Gtk Python module");
+                goto exit;
+            }
+
+            type = PyObject_GetAttrString(gtk_mod, "Widget");
+
+            Py_DECREF(gtk_mod);
+
+            ret = PyObject_TypeCheck(pywidget, (PyTypeObject *)type);
+
+            Py_DECREF(type);
+
+            if (ret)
+                result = GTK_WIDGET(pygobject_get(pywidget));
+
+            Py_DECREF(pywidget);
+
+        }
+
+    }
+
+ exit:
+
+    Py_DECREF(pyobj);
+
+    PyGILState_Release(gstate);
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : item = instance à consulter.                                 *
 *                old  = ancien contenu chargé analysé.                        *
 *                new  = nouveau contenu chargé à analyser.                    *
 *                                                                             *
@@ -404,7 +557,7 @@ static void py_editor_item_focus_cursor_wrapper(GEditorItem *item, GLoadedConten
 *  Paramètres  : self    = objet Python concerné par l'appel.                 *
 *                closure = non utilisé ici.                                   *
 *                                                                             *
-*  Description : Fournit le nom humain attribué à l'élément réactif.          *
+*  Description : Fournit le nom interne attribué à l'élément réactif.         *
 *                                                                             *
 *  Retour      : Désignation (courte) de l'élément de l'éditeur.              *
 *                                                                             *
@@ -412,24 +565,26 @@ static void py_editor_item_focus_cursor_wrapper(GEditorItem *item, GLoadedConten
 *                                                                             *
 ******************************************************************************/
 
-static PyObject *py_editor_item_get_name(PyObject *self, void *closure)
+static PyObject *py_editor_item_get_key(PyObject *self, void *closure)
 {
     PyObject *result;                       /* Valeur à retourner          */
     GEditorItem *item;                      /* Elément à consulter         */
-    const char *name;                       /* Désignation humaine         */
+    char *key;                              /* Désignation humaine         */
 
-#define EDITOR_ITEM_NAME_ATTRIB PYTHON_GET_DEF_FULL     \
+#define EDITOR_ITEM_KEY_ATTRIB PYTHON_GET_DEF_FULL      \
 (                                                       \
-    name, py_editor_item,                               \
-    "Human name given to the editor item."              \
+    key, py_editor_item,                                \
+    "Internal name given to the editor item."              \
 )
 
     item = G_EDITOR_ITEM(pygobject_get(self));
-    name = g_editor_item_get_name(item);
-
-    if (name != NULL)
-        result = PyUnicode_FromString(name);
+    key = g_editor_item_get_key(item);
 
+    if (key != NULL)
+    {
+        result = PyUnicode_FromString(key);
+        free(key);
+    }
     else
     {
         result = Py_None;
@@ -463,7 +618,7 @@ static PyObject *py_editor_item_get_widget(PyObject *self, void *closure)
 #define EDITOR_ITEM_WIDGET_ATTRIB PYTHON_GET_DEF_FULL   \
 (                                                       \
     widget, py_editor_item,                             \
-    "Base GTK widget involed in the editor item."       \
+    "GTK widget base involed in the editor item."       \
 )
 
     item = G_EDITOR_ITEM(pygobject_get(self));
@@ -505,7 +660,9 @@ PyTypeObject *get_python_editor_item_type(void)
     };
 
     static PyGetSetDef py_editor_item_getseters[] = {
-        EDITOR_ITEM_NAME_ATTRIB,
+        EDITOR_ITEM_KEY_ATTRIB_WRAPPER,
+        EDITOR_ITEM_WIDGET_ATTRIB_WRAPPER,
+        EDITOR_ITEM_KEY_ATTRIB,
         EDITOR_ITEM_WIDGET_ATTRIB,
         { NULL }
     };
diff --git a/plugins/pychrysalide/gui/editem.h b/plugins/pychrysalide/gui/item.h
index 6af3b18..2b54963 100644
--- a/plugins/pychrysalide/gui/editem.h
+++ b/plugins/pychrysalide/gui/item.h
@@ -1,6 +1,6 @@
 
 /* Chrysalide - Outil d'analyse de fichiers binaires
- * editem.h - prototypes pour l'équivalent Python du fichier "gui/editem.h"
+ * item.h - prototypes pour l'équivalent Python du fichier "gui/item.h"
  *
  * Copyright (C) 2018 Cyrille Bagard
  *
@@ -22,15 +22,15 @@
  */
 
 
-#ifndef _PLUGINS_PYCHRYSALIDE_GUI_EDITEM_H
-#define _PLUGINS_PYCHRYSALIDE_GUI_EDITEM_H
+#ifndef _PLUGINS_PYCHRYSALIDE_GUI_ITEM_H
+#define _PLUGINS_PYCHRYSALIDE_GUI_ITEM_H
 
 
 #include <Python.h>
 #include <stdbool.h>
 
 
-#include <gui/editem.h>
+#include <gui/item.h>
 
 
 
@@ -53,4 +53,4 @@ bool ensure_python_editor_item_is_registered(void);
 
 
 
-#endif  /* _PLUGINS_PYCHRYSALIDE_GUI_EDITEM_H */
+#endif  /* _PLUGINS_PYCHRYSALIDE_GUI_ITEM_H */
diff --git a/plugins/pychrysalide/gui/module.c b/plugins/pychrysalide/gui/module.c
index 9c06940..66f0f24 100644
--- a/plugins/pychrysalide/gui/module.c
+++ b/plugins/pychrysalide/gui/module.c
@@ -29,7 +29,7 @@
 
 
 
-#include "editem.h"
+#include "item.h"
 #include "panel.h"
 #include "core/module.h"
 #include "../helpers.h"
diff --git a/plugins/pychrysalide/gui/panel.c b/plugins/pychrysalide/gui/panel.c
index 33ff4e3..d9a2bc5 100644
--- a/plugins/pychrysalide/gui/panel.c
+++ b/plugins/pychrysalide/gui/panel.c
@@ -36,9 +36,10 @@
 
 
 #include "constants.h"
-#include "editem.h"
+#include "item.h"
 #include "../access.h"
 #include "../helpers.h"
+#include "../glibext/named.h"
 #include "../gtkext/dockable.h"
 
 
@@ -66,6 +67,9 @@ static PyObject *py_panel_item_dock(PyObject *, PyObject *);
 /* Supprime un panneau de l'ensemble affiché. */
 static PyObject *py_panel_item_undock(PyObject *, PyObject *);
 
+/* Fournit le chemin d'accès à utiliser pour les encapsulations. */
+static PyObject *py_panel_item_get_named_widget(PyObject *, void *);
+
 /* Fournit une indication sur la personnalité du panneau. */
 static PyObject *py_panel_item_get_personality(PyObject *, void *);
 
@@ -184,17 +188,14 @@ static void py_panel_item_init_gclass(GPanelItemClass *class, gpointer unused)
 
 static int py_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
 {
-    unsigned long personality;              /* Nature du panneau           */
-    const char *name;                       /* Désignation humaine         */
-    const char *lname;                      /* Nom version longue          */
-    PyGObject *widget;                      /* Composant visuel du panneau */
+    PanelItemPersonality personality;       /* Nature du panneau           */
+    GNamedWidget *widget;                   /* Composant visuel du panneau */
     int startup;                            /* Recommandation au démarrage */
     const char *path;                       /* Placement à l'affichage     */
     int ret;                                /* Bilan de lecture des args.  */
     GPanelItem *panel;                      /* Panneau à manipuler         */
-    GEditorItem *item;                      /* Version basique d'instance  */
 
-    static char *kwlist[] = { "name", "widget", "personality", "lname", "dock", "path", NULL };
+    static char *kwlist[] = { "personality", "widget", "dock", "path", NULL };
 
 #define PANEL_ITEM_DOC                                                          \
     "PanelItem is an abstract class for panels available in the main GUI"       \
@@ -202,15 +203,14 @@ static int py_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
     "\n"                                                                        \
     "Instances can be created using the following constructor:\n"               \
     "\n"                                                                        \
-    "    PanelItem(name=str, widget=Gtk.Widget,"                                \
-    " personality=PanelItemPersonality, lname=str, dock=bool, path=str)"        \
+    "    PanelItem(personality, widget, dock, path)"                            \
     "\n"                                                                        \
     "Where:\n"                                                                  \
-    "* name is the displayed label on the notebook tab when docked.\n"          \
-    "* widget is the main widget inside the panel.\n"                           \
     "* personality defines how many instances of the panels can be created"     \
     " at the same time.\n"                                                      \
-    "* lname is the long description used for the tooltip.\n"                   \
+    "* widget is an implementation of the pychrysalide.glibext.NamedWidget"     \
+    " interface (see pychrysalide.gtkext.BuiltNamedWidget for a ready-to-use"   \
+    " helper).\n"                                                               \
     "* dock defines if the panel is docked by default.\n"                       \
     "* path states the location of the panel inside the main GUI.\n"            \
     "\n"                                                                        \
@@ -218,22 +218,25 @@ static int py_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
     " transitional dictionary inside the panel *__init__()* constructor:\n"     \
     "\n"                                                                        \
     "    params = {\n"                                                          \
-    "        'name' : 'Tab label',\n"                                           \
-    "        'widget' : self._my_gtk_widget,\n"                                 \
     "        'personality' : PanelItemPersonality.PIP_SINGLETON,\n"             \
-    "        'lname' : 'Long description for tooltip',\n"                       \
+    "        'widget' : my_named_widget_instance,\n"                            \
     "        'dock' : True,\n"                                                  \
     "        'path' : 'MES'\n"                                                  \
     "    }\n"                                                                   \
     "    super(MyPanel, self).__init__(**params)\n"                             \
     "\n"                                                                        \
+    "The PanelItem definition handles internally the supply of the *_widget*"   \
+    " attribute for pychrysalide.gui.EditorItem.\n"                             \
+    "\n"                                                                        \
     "For more details about the panel path, please refer to"                    \
     " pychrysalide.gtkext.GtkDockable."
 
     /* Récupération des paramètres */
 
-    ret = PyArg_ParseTupleAndKeywords(args, kwds, "sOksps", kwlist,
-                                      &name, &widget, &personality, &lname, &startup, &path);
+    ret = PyArg_ParseTupleAndKeywords(args, kwds, "O&O&ps", kwlist,
+                                      convert_to_panel_item_personality, &personality,
+                                      convert_to_named_widget, &widget,
+                                      &startup, &path);
     if (!ret) return -1;
 
     /* Initialisation d'un objet GLib */
@@ -245,15 +248,7 @@ static int py_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
 
     panel = G_PANEL_ITEM(pygobject_get(self));
 
-    item = G_EDITOR_ITEM(panel);
-
-    item->name = strdup(name);;
-    item->widget = GTK_WIDGET(pygobject_get(widget));
-
     panel->personality = personality;
-    panel->lname = strdup(lname);
-    panel->dock_at_startup = startup;
-    panel->path = strdup(path);
 
     /**
      * Si Python ne voit plus la variable représentant le panneau utilisée,
@@ -262,7 +257,11 @@ static int py_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
      * On sera donc en situation de Use-After-Free, dont les conséquences
      * arrivent très vite.
      */
-    g_object_ref(G_OBJECT(item->widget));
+    panel->widget = widget;
+    g_object_ref(G_OBJECT(widget));
+
+    panel->dock_at_startup = startup;
+    panel->path = strdup(path);
 
     return 0;
 
@@ -346,6 +345,43 @@ static PyObject *py_panel_item_undock(PyObject *self, PyObject *args)
 *  Paramètres  : self    = objet Python concerné par l'appel.                 *
 *                closure = non utilisé ici.                                   *
 *                                                                             *
+*  Description : Fournit le chemin d'accès à utiliser pour les encapsulations.*
+*                                                                             *
+*  Retour      : Chemin d'accès défini.                                       *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_panel_item_get_named_widget(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GPanelItem *item;                       /* Panneau à consulter         */
+    GNamedWidget *widget;                   /* Composant nommé à transférer*/
+
+#define PANEL_ITEM_NAMED_WIDGET_ATTRIB PYTHON_GET_DEF_FULL  \
+(                                                           \
+    named_widget, py_panel_item,                            \
+    "Named widget as core component of the panel item."     \
+)
+
+    item = G_PANEL_ITEM(pygobject_get(self));
+    widget = gtk_panel_item_get_named_widget(item);
+
+    result = pygobject_new(G_OBJECT(widget));
+
+    g_object_unref(G_OBJECT(widget));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
 *  Description : Fournit une indication sur la personnalité du panneau.       *
 *                                                                             *
 *  Retour      : Identifiant lié à la nature du panneau.                      *
@@ -502,6 +538,7 @@ PyTypeObject *get_python_panel_item_type(void)
     };
 
     static PyGetSetDef py_panel_item_getseters[] = {
+        PANEL_ITEM_NAMED_WIDGET_ATTRIB,
         PANEL_ITEM_PERSONALITY_ATTRIB,
         PANEL_ITEM_PATH_ATTRIB,
         PANEL_ITEM_DOCKED_ATTRIB,