Provided Python bindings for the main menu bar.

5 files changed, 564 insertions, 0 deletions

diff --git a/plugins/pychrysalide/gui/Makefile.am b/plugins/pychrysalide/gui/Makefile.am
index 06c9db9..ca6bee5 100644
--- a/plugins/pychrysalide/gui/Makefile.am
+++ b/plugins/pychrysalide/gui/Makefile.am
@@ -4,6 +4,7 @@ noinst_LTLIBRARIES = libpychrysagui.la
 libpychrysagui_la_SOURCES =				\
 	constants.h constants.c				\
 	item.h item.c						\
+	menubar.h menubar.c					\
 	module.h module.c					\
 	panel.h panel.c
 
diff --git a/plugins/pychrysalide/gui/core/items.c b/plugins/pychrysalide/gui/core/items.c
index a54e5f3..ce3eaee 100644
--- a/plugins/pychrysalide/gui/core/items.c
+++ b/plugins/pychrysalide/gui/core/items.c
@@ -66,6 +66,59 @@ static PyObject *py_items_update_project(PyObject *, PyObject *);
 *                                                                             *
 ******************************************************************************/
 
+static PyObject *py_items_find_editor_item_by_key(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Trouvaille à retourner      */
+    const char *key;                        /* Objet des recherches        */
+    int ret;                                /* Bilan de lecture des args.  */
+    GEditorItem *found;                     /* Instance retrouvée ou NULL  */
+
+#define ITEMS_FIND_EDITOR_ITEM_BY_KEY_METHOD PYTHON_METHOD_DEF          \
+(                                                                       \
+    find_editor_item_by_key, "key",                                     \
+    METH_VARARGS, py_items,                                             \
+    "Find the editor component belonging to a given key."               \
+    "\n"                                                                \
+    "The key has to be provided as a simple (short) string, and the"    \
+    " result is a pychrysalide.gui.EditorItem instance or None if no"   \
+    " component is found for the given key."                            \
+)
+
+    ret = PyArg_ParseTuple(args, "s", &key);
+    if (!ret) return NULL;
+
+
+    found = find_editor_item_by_key(key);
+
+    if (found == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = pygobject_new(G_OBJECT(found));
+        g_object_ref(G_OBJECT(found));
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = classe représentant un binaire.                       *
+*                args = arguments fournis à l'appel.                          *
+*                                                                             *
+*  Description : Lance une actualisation du fait d'un changement de contenu.  *
+*                                                                             *
+*  Retour      : None.                                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
 static PyObject *py_items_change_current_content(PyObject *self, PyObject *args)
 {
     GLoadedContent *content;                /* Instance GLib correspondante*/
@@ -223,6 +276,7 @@ bool populate_gui_core_module_with_items(void)
     PyObject *module;                       /* Module à recompléter        */
 
     static PyMethodDef py_items_methods[] = {
+        ITEMS_FIND_EDITOR_ITEM_BY_KEY_METHOD,
         ITEMS_CHANGE_CURRENT_CONTENT_METHOD,
         ITEMS_CHANGE_CURRENT_VIEW_METHOD,
         ITEMS_UPDATE_CURRENT_VIEW_METHOD,
diff --git a/plugins/pychrysalide/gui/menubar.c b/plugins/pychrysalide/gui/menubar.c
new file mode 100644
index 0000000..0234fba
--- /dev/null
+++ b/plugins/pychrysalide/gui/menubar.c
@@ -0,0 +1,465 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * menubar.c - prototypes pour l'équivalent Python du fichier "gui/menubar.c"
+ *
+ * Copyright (C) 2020 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 "menubar.h"
+
+
+#include <malloc.h>
+#include <pygobject.h>
+
+
+#include <gui/menubar.h>
+
+
+#include "item.h"
+#include "../access.h"
+#include "../helpers.h"
+
+
+
+#define MENU_BAR_DOC                                                            \
+    "MenuBar is an object providing interactions with the main bar of menus.\n" \
+    "\n"                                                                        \
+    "This object is built by the GUI core of Chrysalide and is not aimed to"    \
+    " get created from Python bindings. This singleton is thus a"               \
+    " pychrysalide.gui.EditorItem instance which can be retrieved with"         \
+    " 'menubar' as key."
+
+
+/* Fournit le composant GTK associé au menu "Fichier". */
+static PyObject *py_menu_bar_get_file_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Edition". */
+static PyObject *py_menu_bar_get_edition_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Affichage". */
+static PyObject *py_menu_bar_get_view_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Projet". */
+static PyObject *py_menu_bar_get_project_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Binaire". */
+static PyObject *py_menu_bar_get_binary_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Débogage". */
+static PyObject *py_menu_bar_get_debug_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Options". */
+static PyObject *py_menu_bar_get_options_menu(PyObject *, void *);
+
+/* Fournit le composant GTK associé au menu "Aide". */
+static PyObject *py_menu_bar_get_help_menu(PyObject *, void *);
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Fichier".          *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_file_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_FILE_MENU_ATTRIB PYTHON_GET_DEF_FULL   \
+(                                                       \
+    file_menu, py_menu_bar,                             \
+    "File menu included in the main menubar, as a"      \
+    " Gtk.MenuItem instance."                           \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_file_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Edition".          *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_edition_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_EDITION_MENU_ATTRIB PYTHON_GET_DEF_FULL    \
+(                                                           \
+    edition_menu, py_menu_bar,                              \
+    "Edition menu included in the main menubar, as a"       \
+    " Gtk.MenuItem instance."                               \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_edition_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Affichage".        *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_view_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_VIEW_MENU_ATTRIB PYTHON_GET_DEF_FULL   \
+(                                                       \
+    view_menu, py_menu_bar,                             \
+    "View menu included in the main menubar, as a"      \
+    " Gtk.MenuItem instance."                           \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_view_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Projet".           *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_project_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_PROJECT_MENU_ATTRIB PYTHON_GET_DEF_FULL    \
+(                                                           \
+    project_menu, py_menu_bar,                              \
+    "Project menu included in the main menubar, as a"       \
+    " Gtk.MenuItem instance."                               \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_project_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Binaire".          *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_binary_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_BINARY_MENU_ATTRIB PYTHON_GET_DEF_FULL \
+(                                                       \
+    binary_menu, py_menu_bar,                           \
+    "Binary menu included in the main menubar, as a"    \
+    " Gtk.MenuItem instance."                           \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_binary_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Débogage".         *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_debug_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_DEBUG_MENU_ATTRIB PYTHON_GET_DEF_FULL  \
+(                                                       \
+    debug_menu, py_menu_bar,                            \
+    "Debug menu included in the main menubar, as a"     \
+    " Gtk.MenuItem instance."                           \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_debug_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Options".          *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_options_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_OPTIONS_MENU_ATTRIB PYTHON_GET_DEF_FULL    \
+(                                                           \
+    options_menu, py_menu_bar,                              \
+    "Options menu included in the main menubar, as a"       \
+    " Gtk.MenuItem instance."                               \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_options_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self    = objet Python concerné par l'appel.                 *
+*                closure = non utilisé ici.                                   *
+*                                                                             *
+*  Description : Fournit le composant GTK associé au menu "Aide".             *
+*                                                                             *
+*  Retour      : Instance de composant graphique correspondant au menu visé.  *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_menu_bar_get_help_menu(PyObject *self, void *closure)
+{
+    PyObject *result;                       /* Valeur à retourner          */
+    GMenuBar *bar;                          /* Elément à consulter         */
+    GtkWidget *menu;                        /* Composant GTK visé          */
+
+#define MENU_BAR_HELP_MENU_ATTRIB PYTHON_GET_DEF_FULL   \
+(                                                       \
+    help_menu, py_menu_bar,                             \
+    "Help menu included in the main menubar, as a"      \
+    " Gtk.MenuItem instance."                           \
+)
+
+    bar = G_MENU_BAR(pygobject_get(self));
+
+    menu = g_menu_bar_get_help_menu(bar);
+
+    result = pygobject_new(G_OBJECT(menu));
+    g_object_unref(G_OBJECT(menu));
+
+    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_menu_bar_type(void)
+{
+    static PyMethodDef py_menu_bar_methods[] = {
+        { NULL }
+    };
+
+    static PyGetSetDef py_menu_bar_getseters[] = {
+        MENU_BAR_FILE_MENU_ATTRIB,
+        MENU_BAR_EDITION_MENU_ATTRIB,
+        MENU_BAR_VIEW_MENU_ATTRIB,
+        MENU_BAR_PROJECT_MENU_ATTRIB,
+        MENU_BAR_BINARY_MENU_ATTRIB,
+        MENU_BAR_DEBUG_MENU_ATTRIB,
+        MENU_BAR_OPTIONS_MENU_ATTRIB,
+        MENU_BAR_HELP_MENU_ATTRIB,
+        { NULL }
+    };
+
+    static PyTypeObject py_menu_bar_type = {
+
+        PyVarObject_HEAD_INIT(NULL, 0)
+
+        .tp_name        = "pychrysalide.gui.MenuBar",
+
+        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
+
+        .tp_doc         = MENU_BAR_DOC,
+
+        .tp_methods     = py_menu_bar_methods,
+        .tp_getset      = py_menu_bar_getseters,
+
+        .tp_new         = no_python_constructor_allowed,
+
+    };
+
+    return &py_menu_bar_type;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : module = module dont la définition est à compléter.          *
+*                                                                             *
+*  Description : Prend en charge l'objet 'pychrysalide.gui.MenuBar'.          *
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool ensure_python_menu_bar_is_registered(void)
+{
+    PyTypeObject *type;                     /* Type Python 'MenuBar'       */
+    PyObject *module;                       /* Module à recompléter        */
+    PyObject *dict;                         /* Dictionnaire du module      */
+
+    type = get_python_menu_bar_type();
+
+    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
+    {
+        module = get_access_to_python_module("pychrysalide.gui");
+
+        dict = PyModule_GetDict(module);
+
+        if (!register_class_for_pygobject(dict, G_TYPE_MENU_BAR, type, get_python_editor_item_type()))
+            return false;
+
+    }
+
+    return true;
+
+}
diff --git a/plugins/pychrysalide/gui/menubar.h b/plugins/pychrysalide/gui/menubar.h
new file mode 100644
index 0000000..9ab7ed0
--- /dev/null
+++ b/plugins/pychrysalide/gui/menubar.h
@@ -0,0 +1,42 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * menubar.h - prototypes pour l'équivalent Python du fichier "gui/menubar.h"
+ *
+ * Copyright (C) 2020 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_GUI_MENUBAR_H
+#define _PLUGINS_PYCHRYSALIDE_GUI_MENUBAR_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Fournit un accès à une définition de type à diffuser. */
+PyTypeObject *get_python_menu_bar_type(void);
+
+/* Prend en charge l'objet 'pychrysalide.gui.MenuBar'. */
+bool ensure_python_menu_bar_is_registered(void);
+
+
+
+#endif  /* _PLUGINS_PYCHRYSALIDE_GUI_MENUBAR_H */
diff --git a/plugins/pychrysalide/gui/module.c b/plugins/pychrysalide/gui/module.c
index 66f0f24..1ff7b1b 100644
--- a/plugins/pychrysalide/gui/module.c
+++ b/plugins/pychrysalide/gui/module.c
@@ -30,6 +30,7 @@
 
 
 #include "item.h"
+#include "menubar.h"
 #include "panel.h"
 #include "core/module.h"
 #include "../helpers.h"
@@ -101,6 +102,7 @@ bool populate_gui_module(void)
     result = true;
 
     if (result) result = ensure_python_editor_item_is_registered();
+    if (result) result = ensure_python_menu_bar_is_registered();
     if (result) result = ensure_python_panel_item_is_registered();
 
     if (result) result = populate_gui_core_module();