path: root/src/gui/panels/symbols.c

/* Chrysalide - Outil d'analyse de fichiers binaires
 * symbols.c - panneau d'affichage des symboles
 *
 * Copyright (C) 2008-2013 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA 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.
 *
 *  OpenIDA 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 "symbols.h"


#include <i18n.h>


#include <malloc.h>
#include <regex.h>
#include <string.h>
#include <gdk/gdkkeysyms.h>


#include "panel-int.h"
#include "../../format/format.h"
#include "../../gtkext/easygtk.h"
#include "../../gtkext/support.h"



/* -------------------------- PARTIE PRINCIPALE DU PANNEAU -------------------------- */


/* Panneau d'aperçu de graphiques (instance) */
struct _GSymbolsPanel
{
    GPanelItem parent;                      /* A laisser en premier        */

    GtkTreeView *treeview;                  /* Composant d'affichage       */
    GtkTreeStore *store;                    /* Modèle de gestion           */

    GLoadedBinary *binary;                  /* Binaire à prendre en compte */

    regex_t *filter;                        /* Filtre appliqué ou NULL     */

};

/* Panneau d'aperçu de graphiques (classe) */
struct _GSymbolsPanelClass
{
    GPanelItemClass parent;                 /* A laisser en premier        */

};


/* Colonnes de la liste des symboles */
typedef enum _SymbolsColumn
{
    SBC_ADDRESS,                            /* Adresse mémoire du symbole  */

    SBC_ICON,                               /* Image de représentation     */
    SBC_NAME,                               /* Désignation humaine         */

    SBC_EXPAND,                             /* Affichage des classes       */

    SBC_COUNT                               /* Nombre de colonnes          */

} SymbolsColumn;


/* Initialise la classe des panneaux d'aperçu de graphiques. */
static void g_symbols_panel_class_init(GSymbolsPanelClass *);

/* Initialise une instance de panneau d'aperçu de graphiques. */
static void g_symbols_panel_init(GSymbolsPanel *);

/* Réagit au changement d'affichage des symboles. */
static void on_symbols_display_change(GtkToggleToolButton *, GSymbolsPanel *);

/* Réagit au changement de sélection des symboles. */
static void on_symbols_selection_change(GtkTreeSelection *, GSymbolsPanel *);

/* Réagit à un changement d'affichage principal de contenu. */
static void change_symbols_panel_current_binary(GSymbolsPanel *, GLoadedBinary *);



/* ------------------------- AFFICHAGE A L'AIDE D'UNE LISTE ------------------------- */


/* Réagit à un changement d'affichage principal de contenu. */
static void reload_symbols_for_new_list_view(GSymbolsPanel *);



/* -------------------------- AFFICHAGE SOUS FORME D'ARBRE -------------------------- */


/* S'assure qu'un noeud donné existe bien. */
static GtkTreeIter ensure_symbol_node_exist(GtkTreeStore *, GtkTreeIter *, const char *);

/* Détermine le point d'insertion parent d'une routine. */
static bool find_parent_for_routine(GtkTreeStore *, const GBinRoutine *, GtkTreeIter *);

/* Réagit à un changement d'affichage principal de contenu. */
static void reload_symbols_for_new_tree_view(GSymbolsPanel *);

/* Réagit à une nouvelle demande de réorganisation. */
static void reorganize_symbols_tree_view(GtkToolButton *, GObject *);

/* Fait en sorte que toutes les classes soient affichées. */
static gboolean show_all_classes_in_tree_view(GtkTreeModel *, GtkTreePath *, GtkTreeIter *, GtkTreeView *);



/* ------------------------- FILTRAGE DES SYMBOLES PRESENTS ------------------------- */


/* Démarre l'actualisation du filtrage des symboles. */
static gboolean filter_symbols_from_key_press(GtkEntry *, GdkEventKey *, GSymbolsPanel *);

/* Démarre l'actualisation du filtrage des symboles. */
static void filter_symbols_from_icons(GtkEntry *, GtkEntryIconPosition, GdkEventButton *, GSymbolsPanel *);

/* Exécute un nouveau filtrage des symboles affichés. */
static void do_filtering_on_symbols(GSymbolsPanel *, GtkEntry *);

/* Détermine si un nom de symbole doit être filtré ou non. */
static bool is_symbol_filtered(GSymbolsPanel *, const char *);



/* ---------------------------------------------------------------------------------- */
/*                            PARTIE PRINCIPALE DU PANNEAU                            */
/* ---------------------------------------------------------------------------------- */


/* Indique le type définit pour un panneau d'aperçu de graphiques. */
G_DEFINE_TYPE(GSymbolsPanel, g_symbols_panel, G_TYPE_PANEL_ITEM);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des panneaux d'aperçu de graphiques.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_symbols_panel_class_init(GSymbolsPanelClass *klass)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = instance à initialiser.                              *
*                                                                             *
*  Description : Initialise une instance de panneau d'aperçu de graphiques.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_symbols_panel_init(GSymbolsPanel *panel)
{
    GEditorItem *base;                      /* Version basique d'instance  */
    GObject *ref;                           /* Espace de référencement     */
    GtkWidget *box;                         /* Séparation horizontale      */
    GtkWidget *toolbar;                     /* Barre d'outils              */
    GtkWidget *button;                      /* Bouton de cette même barre  */
    GtkWidget *separator;                   /* Barre de séparation vert.   */
    GtkWidget *entry;                       /* Zone de recherche           */
    GtkWidget *scrollwnd;                   /* Support défilant            */
    GtkWidget *treeview;                    /* Affichage de la liste       */
    GtkCellRenderer *renderer;              /* Moteur de rendu de colonne  */
    GtkTreeViewColumn *column;              /* Colonne de la liste         */
    GtkTreeSelection *select;               /* Sélection dans la liste     */

    base = G_EDITOR_ITEM(panel);

    base->widget = gtk_vbox_new(FALSE, 0);
    gtk_widget_show(base->widget);

    ref = G_OBJECT(base->widget);
    g_object_set_data(ref, "panel", panel);

    /* Barre d'outils supérieure */

    box = gtk_hbox_new(FALSE, 0);
    gtk_widget_show(box);
    gtk_box_pack_start(GTK_BOX(base->widget), box, FALSE, FALSE, 0);

    toolbar = gtk_toolbar_new();
    gtk_widget_show(toolbar);
    gtk_box_pack_start(GTK_BOX(box), toolbar, TRUE, TRUE, 0);

    button = qck_create_toggle_tool_button(ref, "list", _("List"), "tbutton_list_view.png",
                                           G_CALLBACK(on_symbols_display_change), panel);
    gtk_tool_item_set_tooltip_text(GTK_TOOL_ITEM(button),
                                   _("Show symbols using a list view"));
    gtk_toolbar_insert(GTK_TOOLBAR(toolbar), GTK_TOOL_ITEM(button), -1);

    button = qck_create_toggle_tool_button(ref, "tree", _("Tree"),  "tbutton_tree_view.png", 
                                           G_CALLBACK(on_symbols_display_change), panel);
    gtk_tool_item_set_tooltip_text(GTK_TOOL_ITEM(button),
                                   _("Show symbols using a tree view"));
    gtk_toggle_tool_button_set_active(GTK_TOGGLE_TOOL_BUTTON(button), TRUE);
    gtk_toolbar_insert(GTK_TOOLBAR(toolbar), GTK_TOOL_ITEM(button), -1);

    separator = qck_create_tool_separator(NULL, NULL);
    gtk_container_add(GTK_CONTAINER(toolbar), separator);

    button = qck_create_tool_button(ref, "collapse", _("Collapse"),  "tbutton_collapse.png",
                                    G_CALLBACK(reorganize_symbols_tree_view), ref);
    gtk_tool_item_set_tooltip_text(GTK_TOOL_ITEM(button),
                                   _("Collapse all symbol nodes in the tree view"));
    gtk_toolbar_insert(GTK_TOOLBAR(toolbar), GTK_TOOL_ITEM(button), -1);

    button = qck_create_tool_button(ref, "expand", _("Expand"),  "tbutton_expand.png",
                                    G_CALLBACK(reorganize_symbols_tree_view), ref);
    gtk_tool_item_set_tooltip_text(GTK_TOOL_ITEM(button),
                                   _("Expand all symbol nodes in the tree view"));
    gtk_toolbar_insert(GTK_TOOLBAR(toolbar), GTK_TOOL_ITEM(button), -1);

    button = qck_create_tool_button(ref, "classes", _("Classes"),  "symbol_class_classic.png",
                                    G_CALLBACK(reorganize_symbols_tree_view), ref);
    gtk_tool_item_set_tooltip_text(GTK_TOOL_ITEM(button),
                                   _("Show all classes in the tree view"));
    gtk_toolbar_insert(GTK_TOOLBAR(toolbar), GTK_TOOL_ITEM(button), -1);

    separator = qck_create_tool_separator(NULL, NULL);
    gtk_container_add(GTK_CONTAINER(toolbar), separator);

    /* Espace de recherche */

    entry = qck_create_entry(ref, "search", "");
    gtk_widget_set_tooltip_text(entry, _("Filter symbols using POSIX extended regular expressions"));

    gtk_entry_set_icon_from_stock(GTK_ENTRY(entry), GTK_ENTRY_ICON_SECONDARY, GTK_STOCK_FIND);

    g_signal_connect(G_OBJECT(entry), "key-press-event",
                     G_CALLBACK(filter_symbols_from_key_press), panel);
    g_signal_connect(G_OBJECT(entry), "icon-press",
                     G_CALLBACK(filter_symbols_from_icons), panel);

    gtk_box_pack_start(GTK_BOX(box), entry, TRUE, TRUE, 0);

    /* Liste arborescente ou linéaire */

    scrollwnd = gtk_scrolled_window_new(NULL, NULL);
    gtk_widget_show(scrollwnd);
    gtk_box_pack_start(GTK_BOX(base->widget), scrollwnd, TRUE, TRUE, 0);

    gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrollwnd), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
    gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrollwnd), GTK_SHADOW_IN);

    panel->store = gtk_tree_store_new(SBC_COUNT, G_TYPE_STRING, GDK_TYPE_PIXBUF, G_TYPE_STRING, G_TYPE_BOOLEAN);

    treeview = gtk_tree_view_new_with_model(GTK_TREE_MODEL(panel->store));
    gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(treeview), FALSE);
    gtk_tree_view_set_enable_tree_lines(GTK_TREE_VIEW(treeview), TRUE);
    gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(treeview), TRUE);

    panel->treeview = GTK_TREE_VIEW(treeview);

    gtk_widget_show(treeview);
    gtk_container_add(GTK_CONTAINER(scrollwnd), treeview);

    g_object_unref(G_OBJECT(panel->store));

    /*
    column = gtk_tree_view_column_new();
    gtk_tree_view_column_set_visible(column, FALSE);
    gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
    gtk_tree_view_set_expander_column(GTK_TREE_VIEW(treeview), column);
    */

    renderer = gtk_cell_renderer_text_new();
    column = gtk_tree_view_column_new_with_attributes("Address", renderer, "text", SBC_ADDRESS, NULL);
    //gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
    //gtk_tree_view_set_expander_column(GTK_TREE_VIEW(treeview), column);

    column = gtk_tree_view_column_new();
    gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
    gtk_tree_view_set_expander_column(GTK_TREE_VIEW(treeview), column);

    renderer = gtk_cell_renderer_pixbuf_new();
    //column = gtk_tree_view_column_new_with_attributes("Icon", renderer, "pixbuf", SBC_ICON, NULL);
    gtk_tree_view_column_pack_start(column, renderer, FALSE);
    gtk_tree_view_column_add_attribute(column, renderer, "pixbuf", SBC_ICON);

    renderer = gtk_cell_renderer_text_new();
    //column = gtk_tree_view_column_new_with_attributes("Name", renderer, "text", SBC_NAME, NULL);
    gtk_tree_view_column_pack_end(column, renderer, TRUE);
    gtk_tree_view_column_add_attribute(column, renderer, "text", SBC_NAME);
    //gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
    //gtk_tree_view_set_expander_column(GTK_TREE_VIEW(treeview), column);

    select = gtk_tree_view_get_selection(GTK_TREE_VIEW(treeview));
    gtk_tree_selection_set_mode(select, GTK_SELECTION_SINGLE);
    g_signal_connect(G_OBJECT(select), "changed", G_CALLBACK(on_symbols_selection_change), panel);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ref = espace de référencement global.                        *
*                                                                             *
*  Description : Crée un panneau d'affichage des symboles.                    *
*                                                                             *
*  Retour      : Adresse de la structure mise en place.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GEditorItem *g_symbols_panel_new(GObject *ref)
{
    GEditorItem *result;                    /* Structure à retourner       */

    result = g_object_new(G_TYPE_SYMBOLS_PANEL, NULL);

    g_panel_item_init_ext(G_PANEL_ITEM(result), ref, PANEL_SYMBOLS_ID,
                          _("Binary symbols"), G_EDITOR_ITEM(result)->widget, "eM");

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ref = espace de référencement global.                        *
*                                                                             *
*  Description : Construit et intègre un panneau d'affichage des symboles.    *
*                                                                             *
*  Retour      : Adresse du panneau mis en place.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GPanelItem *create_symbols_panel(GObject *ref)
{
    GEditorItem *result;                    /* Elément réactif à renvoyer  */

    result = g_symbols_panel_new(ref);

    /* Enregistre correctement le tout */
    result->update_binary = (update_item_binary_fc)change_symbols_panel_current_binary;
    register_editor_item(result);

    return G_PANEL_ITEM(result);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : button = bouton de la barre activé.                          *
*                panel  = structure contenant les informations maîtresses.    *
*                                                                             *
*  Description : Réagit au changement d'affichage des symboles.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void on_symbols_display_change(GtkToggleToolButton *button, GSymbolsPanel *panel)
{
    GObject *ref;                           /* Espace de référencement     */
    GtkToggleToolButton *list;              /* Bouton pour les listes      */
    GtkToggleToolButton *tree;              /* Bouton pour l'arborescence  */
    gboolean state;                         /* Etat du bouton courant      */
    GtkToggleToolButton *other;             /* Bouton à traiter            */
    GtkWidget *option;                      /* Bouton dont l'accès change  */

    ref = G_OBJECT(G_EDITOR_ITEM(panel)->widget);

    list = GTK_TOGGLE_TOOL_BUTTON(g_object_get_data(ref, "list"));
    tree = GTK_TOGGLE_TOOL_BUTTON(g_object_get_data(ref, "tree"));

    /* Désactivation de l'autre bouton */

    state = gtk_toggle_tool_button_get_active(button);

    if (button == list) other = tree;
    else other = list;

    g_signal_handlers_disconnect_by_func(other, G_CALLBACK(on_symbols_display_change), panel);
    gtk_toggle_tool_button_set_active(other, !state);
    g_signal_connect(other, "toggled", G_CALLBACK(on_symbols_display_change), panel);

    /* Définition des accès sur le reste de la barre */

    state = gtk_toggle_tool_button_get_active(tree);

    option = GTK_WIDGET(g_object_get_data(ref, "collapse"));
    if (option != NULL)
        gtk_widget_set_sensitive(option, state);

    option = GTK_WIDGET(g_object_get_data(ref, "expand"));
    if (option != NULL)
        gtk_widget_set_sensitive(option, state);

    option = GTK_WIDGET(g_object_get_data(ref, "classes"));
    if (option != NULL)
        gtk_widget_set_sensitive(option, state);

    /* Actualisation */

    if (panel->binary != NULL)
    {
        g_object_ref(G_OBJECT(panel->binary));
        change_symbols_panel_current_binary(panel, panel->binary);
        g_object_unref(G_OBJECT(panel->binary));
    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : selection = sélection modifiée.                              *
*                panel     = structure contenant les informations maîtresses. *
*                                                                             *
*  Description : Réagit au changement de sélection des symboles.              *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void on_symbols_selection_change(GtkTreeSelection *selection, GSymbolsPanel *panel)
{
    GtkTreeIter iter;                       /* Point de sélection          */
    GtkTreeModel *model;                    /* Modèle de gestion           */
    gchar *string;                          /* Chaîne sélectionnée         */
    vmpa_t address;                         /* Adresse à rejoindre         */

    if (gtk_tree_selection_get_selected(selection, &model, &iter))
    {
        gtk_tree_model_get(model, &iter, SBC_ADDRESS, &string, -1);

        if (string != NULL)
        {
            address = strtoll(string, NULL, 16);
            g_free(string);

            gtk_view_panel_scroll_to_address(g_editor_item_get_current_view(G_EDITOR_ITEM(panel)),
                                             address);

        }

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel  = panneau à mettre à jour.                            *
*                binary = nouvelle instance de binaire analysé.               *
*                                                                             *
*  Description : Réagit à un changement d'affichage principal de contenu.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void change_symbols_panel_current_binary(GSymbolsPanel *panel, GLoadedBinary *binary)
{
    GtkToggleToolButton *button;            /* Mode de représentation      */
    GtkRequisition req;                     /* Nouvelle taille idéale      */

    if (panel->binary != NULL)
        g_object_unref(G_OBJECT(panel->binary));

    panel->binary = binary;
    g_object_ref(G_OBJECT(binary));

    gtk_tree_store_clear(panel->store);

    button = g_object_get_data(G_OBJECT(G_EDITOR_ITEM(panel)->widget), "list");

    if (gtk_toggle_tool_button_get_active(button))
        reload_symbols_for_new_list_view(panel);
    else
    {
        reload_symbols_for_new_tree_view(panel);
        reorganize_symbols_tree_view(NULL, G_OBJECT(G_EDITOR_ITEM(panel)->widget));
    }

    gtk_widget_size_request(GTK_WIDGET(panel->treeview), &req);
    gtk_widget_set_size_request(GTK_WIDGET(panel->treeview), req.width, req.height);

}



/* ---------------------------------------------------------------------------------- */
/*                           AFFICHAGE A L'AIDE D'UNE LISTE                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau à mettre à jour.                             *
*                                                                             *
*  Description : Réagit à un changement d'affichage principal de contenu.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void reload_symbols_for_new_list_view(GSymbolsPanel *panel)
{
    GExeFormat *format;                     /* Format associé au binaire   */
    GBinRoutine **routines;                 /* Liste des routines trouvées */
    size_t routines_count;                  /* Nombre de ces routines      */
    GArchProcessor *proc;                   /* Architecture utilisée       */
    size_t i;                               /* Boucle de parcours          */
    const char *name;                       /* Désignation du symbole      */
    vmpa_t address;                         /* Adresse associée au symbole */
    char tmp[VMPA_MAX_SIZE];                /* Version humainement lisible */
    GdkPixbuf *pixbuf;                      /* Icone pour l'élément inséré */
    GtkTreeIter iter;                       /* Point d'insertion           */

    format = g_loaded_binary_get_format(panel->binary);

    routines = g_binary_format_get_routines(G_BIN_FORMAT(format), &routines_count);
    qsort(routines, routines_count, sizeof(GBinRoutine *), (__compar_fn_t)g_binary_routine_rcompare);

    if (routines != NULL)
    {
        proc = get_arch_processor_from_format(format);

        for (i = 0; i < routines_count; i++)
        {
            name = g_binary_routine_to_string(routines[i]);

            if (is_symbol_filtered(panel, name))
                continue;

            address = g_binary_routine_get_address(routines[i]);
            vmpa_to_string(address, g_arch_processor_get_memory_size(proc), tmp);

            pixbuf = get_pixbuf_from_file("symbol_routine_classic.png");

            gtk_tree_store_append(panel->store, &iter, NULL);
            gtk_tree_store_set(panel->store, &iter,
                               SBC_ICON, pixbuf,
                               SBC_ADDRESS, tmp,
                               SBC_NAME, name,
                               -1);

        }

    }

}



/* ---------------------------------------------------------------------------------- */
/*                            AFFICHAGE SOUS FORME D'ARBRE                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : store  = gestion des différents éléments insérés.            *
*                parent = point d'insertion parent à retrouver. [OUT]         *
*                name   = nom du noeud ciblé.                                 *
*                                                                             *
*  Description : S'assure qu'un noeud donné existe bien.                      *
*                                                                             *
*  Retour      : Point d'insertion prochain.                                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GtkTreeIter ensure_symbol_node_exist(GtkTreeStore *store, GtkTreeIter *parent, const char *name)
{
    bool found;                             /* Bilan des recherches        */
    GtkTreeIter iter;                       /* Boucle de parcours          */
    gchar *string;                          /* Chaîne sélectionnée         */
    GdkPixbuf *pixbuf;                      /* Icone pour l'élément inséré */

    found = false;

    if (gtk_tree_model_iter_children(GTK_TREE_MODEL(store), &iter, parent))
        do
        {
            gtk_tree_model_get(GTK_TREE_MODEL(store), &iter, SBC_NAME, &string, -1);
            found = (strcmp(string, name) == 0);
            g_free(string);

            if (found) break;

        }
        while (gtk_tree_model_iter_next(GTK_TREE_MODEL(store), &iter));

    if (!found) 
    {
        pixbuf = get_pixbuf_from_file("symbol_package.png");

        gtk_tree_store_append(store, &iter, parent);
        gtk_tree_store_set(store, &iter,
                           SBC_ICON, pixbuf,
                           SBC_NAME, name,
                           -1);

    }

    return iter;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : store   = gestion des différents éléments insérés.           *
*                routine = routine à intégrer.                                *
*                parent  = point d'insertion parent à constituer.             *
*                                                                             *
*  Description : Détermine le point d'insertion parent d'une routine.         *
*                                                                             *
*  Retour      : true si le point n'est pas la racine, false sinon.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool find_parent_for_routine(GtkTreeStore *store, const GBinRoutine *routine, GtkTreeIter *parent)
{
    GDataType *namespace;                   /* Espace d'appartenance       */
    char *string;                           /* Conversion en chaîne        */
    char *iter;                             /* Boucle de parcours          */
    char *token;                            /* Partie de texte isolée      */ 
    char *saveptr;                          /* Ctx. interne de découpage   */

    namespace = g_binary_routine_get_namespace(routine);
    if (namespace == NULL) return false;

    string = g_data_type_to_string(namespace);

    for (iter = string; ; iter = NULL)
    {
        token = strtok_r(iter, "::", &saveptr);
        if (token == NULL) break;

        *parent = ensure_symbol_node_exist(store, (iter == string ? NULL : parent), token);

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau à mettre à jour.                             *
*                                                                             *
*  Description : Réagit à un changement d'affichage principal de contenu.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void reload_symbols_for_new_tree_view(GSymbolsPanel *panel)
{
    GExeFormat *format;                     /* Format associé au binaire   */
    GBinRoutine **routines;                 /* Liste des routines trouvées */
    size_t routines_count;                  /* Nombre de ces routines      */
    GArchProcessor *proc;                   /* Architecture utilisée       */
    size_t i;                               /* Boucle de parcours          */
    const char *name;                       /* Désignation du symbole      */
    vmpa_t address;                         /* Adresse associée au symbole */
    char tmp[VMPA_MAX_SIZE];                /* Version humainement lisible */
    GtkTreeIter parent;                     /* Point d'insertion parent    */
    GtkTreeIter iter;                       /* Point d'insertion           */
    GdkPixbuf *pixbuf;                      /* Icone pour l'élément inséré */

    format = g_loaded_binary_get_format(panel->binary);

    routines = g_binary_format_get_routines(G_BIN_FORMAT(format), &routines_count);
    qsort(routines, routines_count, sizeof(GBinRoutine *), (__compar_fn_t)g_binary_routine_rcompare);

    if (routines != NULL)
    {
        proc = get_arch_processor_from_format(format);

        for (i = 0; i < routines_count; i++)
        {
            name = g_binary_routine_to_string(routines[i]);

            if (is_symbol_filtered(panel, name))
                continue;

            address = g_binary_routine_get_address(routines[i]);
            vmpa_to_string(address, g_arch_processor_get_memory_size(proc), tmp);

            if (find_parent_for_routine(panel->store, routines[i], &parent))
            {
                pixbuf = get_pixbuf_from_file("symbol_class_classic.png");

                gtk_tree_store_set(panel->store, &parent,
                                   SBC_ICON, pixbuf,
                                   SBC_EXPAND, TRUE,
                                   -1);

                gtk_tree_store_append(panel->store, &iter, &parent);

            }
            else
                gtk_tree_store_append(panel->store, &iter, NULL);

            pixbuf = get_pixbuf_from_file("symbol_routine_classic.png");

            gtk_tree_store_set(panel->store, &iter,
                               SBC_ICON, pixbuf,
                               SBC_ADDRESS, tmp,
                               SBC_NAME, name,
                               -1);

            if (pixbuf != NULL)
                g_object_unref(G_OBJECT(pixbuf));


        }

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : button = bouton concerné par l'action.                       *
*                ref    = espace de référencement des composants.             *
*                                                                             *
*  Description : Réagit à une nouvelle demande de réorganisation.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void reorganize_symbols_tree_view(GtkToolButton *button, GObject *ref)
{
    GSymbolsPanel *panel;                   /* Données du panneau          */

    panel = (GSymbolsPanel *)g_object_get_data(ref, "panel");

    if (g_object_get_data(ref, "collapse") == button)
        gtk_tree_view_collapse_all(panel->treeview);

    else if (g_object_get_data(ref, "expand") == button)
        gtk_tree_view_expand_all(panel->treeview);

    else
        gtk_tree_model_foreach(GTK_TREE_MODEL(panel->store),
                               (GtkTreeModelForeachFunc)show_all_classes_in_tree_view,
                               panel->treeview);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : model    = modèle de gestion des éléments.                   *
*                path     = chemin d'accès à l'élément courant.               *
*                iter     = itérateur courant.                                *
*                treeview = arborescence à manipuler ici.                     *
*                                                                             *
*  Description : Fait en sorte que toutes les classes soient affichées.       *
*                                                                             *
*  Retour      : FALSE pour continuer le parcours.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static gboolean show_all_classes_in_tree_view(GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, GtkTreeView *treeview)
{
    gboolean expand;                        /* Besoin en intervention      */
    GtkTreePath *tmp;                       /* Copie pour modification     */

    gtk_tree_model_get(model, iter, SBC_EXPAND, &expand, -1);

    if (expand)
    {
        tmp = gtk_tree_path_copy(path);

        if (gtk_tree_path_up(tmp))
            gtk_tree_view_expand_to_path(treeview, tmp);

        gtk_tree_path_free(tmp);

    }

    return FALSE;

}



/* ---------------------------------------------------------------------------------- */
/*                           FILTRAGE DES SYMBOLES PRESENTS                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : entry  = entrée de texte contenant le filtre brut.           *
*                event  = informations liées à l'événement.                   *
*                panel  = panneau assurant l'affichage des symboles.          *
*                                                                             *
*  Description : Démarre l'actualisation du filtrage des symboles.            *
*                                                                             *
*  Retour      : FALSE pour poursuivre la propagation de l'événement.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static gboolean filter_symbols_from_key_press(GtkEntry *entry, GdkEventKey *event, GSymbolsPanel *panel)
{
    switch (event->keyval)
    {
        case GDK_KEY_Return:
        case GDK_KEY_KP_Enter:
            do_filtering_on_symbols(panel, entry);
            break;

    }

    return FALSE;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : entry    = entrée de texte contenant le filtre brut.         *
*                icon_pos = position de l'image de fond.                      *
*                event    = informations liées à l'événement.                 *
*                panel    = panneau assurant l'affichage des symboles.        *
*                                                                             *
*  Description : Démarre l'actualisation du filtrage des symboles.            *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void filter_symbols_from_icons(GtkEntry *entry, GtkEntryIconPosition icon_pos, GdkEventButton *event, GSymbolsPanel *panel)
{
    do_filtering_on_symbols(panel, entry);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau assurant l'affichage des symboles.           *
*                entry = entrée de texte contenant le filtre brut.            *
*                                                                             *
*  Description : Exécute un nouveau filtrage des symboles affichés.           *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void do_filtering_on_symbols(GSymbolsPanel *panel, GtkEntry *entry)
{
    const gchar *text;                      /* Texte de l'utilisateur      */
    int ret;                                /* Bilan de mise en place      */
    GdkColor error;                         /* Couleur d'erreur            */

    if (panel->filter != NULL)
    {
        regfree(panel->filter);
        free(panel->filter);
        panel->filter = NULL;
    }

    text = gtk_entry_get_text(entry);

    if (strlen(text) > 0)
    {
        panel->filter = (regex_t *)calloc(1, sizeof(regex_t));
        ret = regcomp(panel->filter, text, REG_EXTENDED);

        if (ret != 0)
        {
            free(panel->filter);
            panel->filter = NULL;

            error.red = 65535;
            error.green = 0;
            error.blue = 0;
            gtk_widget_modify_text(GTK_WIDGET(entry), GTK_STATE_NORMAL, &error);

            return;

        }

    }

    gtk_widget_modify_text(GTK_WIDGET(entry), GTK_STATE_NORMAL, NULL);

    g_object_ref(G_OBJECT(panel->binary));
    change_symbols_panel_current_binary(panel, panel->binary);
    g_object_unref(G_OBJECT(panel->binary));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau assurant l'affichage des symboles.           *
*                name  = désignation du symbole à traiter.                    *
*                                                                             *
*  Description : Détermine si un nom de symbole doit être filtré ou non.      *
*                                                                             *
*  Retour      : true si le symbol ne doit pas être affiché, false sinon.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool is_symbol_filtered(GSymbolsPanel *panel, const char *name)
{
    regmatch_t match;                       /* Récupération des trouvailles*/
    int ret;                                /* Bilan du filtrage           */

    if (panel->filter == NULL)
        return false;

    ret = regexec(panel->filter, name, 1, &match, 0);
    if (ret == REG_NOMATCH)
        return true;

    return false;

}