summaryrefslogtreecommitdiff
path: root/src/plugins/plugin-int.h
blob: 98a07bb35bc4f177b1234358db2b9b20606bd138 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

/* Chrysalide - Outil d'analyse de fichiers binaires
 * plugin-int.h - prototypes pour les structures internes des greffons
 *
 * Copyright (C) 2010-2019 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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _PLUGINS_PLUGIN_INT_H
#define _PLUGINS_PLUGIN_INT_H


#include <glib-object.h>
#include <stdbool.h>


#include "plugin.h"
#include "../analysis/content.h"
#include "../analysis/loaded.h"
#include "../common/bits.h"



/* Transfert de la conscience de soi. */
typedef void (* pg_set_self_fc) (GPluginModule *);

/* Prend acte du [dé]chargement du greffon. */
typedef bool (* pg_management_fc) (GPluginModule *);

/* Accompagne la fin du chargement des modules natifs. */
typedef void (* pg_plugins_loaded_fc) (GPluginModule *, PluginAction);

/* Crée une instance à partir d'un type dynamique externe. */
typedef gpointer (* pg_build_instance_fc) (GPluginModule *, PluginAction, GType);

/* Fournit le nom brut associé au greffon. */
typedef char * (* pg_get_modname_fc) (const GPluginModule *);

/* Procède à une opération liée à un contenu binaire. */
typedef void (* pg_handle_content_fc) (const GPluginModule *, PluginAction, GBinContent *, wgroup_id_t, GtkStatusStack *);

/* Procède à une opération liée à un contenu chargé. */
typedef void (* pg_handle_loaded_fc) (const GPluginModule *, PluginAction, GLoadedContent *, wgroup_id_t, GtkStatusStack *);

/* Complète une liste de resources pour thème. */
typedef void (* pg_include_theme_fc) (const GPluginModule *, PluginAction, gboolean, char ***, size_t *);

/* Rend compte de la création d'un panneau. */
typedef void (* pg_notify_panel_fc) (const GPluginModule *, PluginAction, GPanelItem *);

/* Rend compte d'un affichage ou d'un retrait de panneau. */
typedef void (* pg_notify_docking_fc) (const GPluginModule *, PluginAction, GPanelItem *, bool);

/* Assure l'interprétation d'un format en différé. */
typedef bool (* pg_handle_format_analysis_fc) (const GPluginModule *, PluginAction, GKnownFormat *, wgroup_id_t, GtkStatusStack *);

/* Procède à un préchargement de format de fichier. */
typedef bool (* pg_preload_format_fc) (const GPluginModule *, PluginAction, GBinFormat *, GPreloadInfo *, GtkStatusStack *);

/* Procède au rattachement d'éventuelles infos de débogage. */
typedef void (* pg_attach_debug) (const GPluginModule *, PluginAction, GExeFormat *);

/* Exécute une action pendant un désassemblage de binaire. */
typedef void (* pg_process_disassembly_fc) (const GPluginModule *, PluginAction, GLoadedBinary *, GtkStatusStack *, GProcContext *);

/* Effectue la détection d'effets d'outils externes. */
typedef void (* pg_detect_tools_fc) (const GPluginModule *, PluginAction, const GLoadedContent *, bool, char ***, size_t *);


/* Greffon pour Chrysalide (instance) */
struct _GPluginModule
{
    GObject parent;                         /* A laisser en premier        */

    char *filename;                         /* Fichier associé au greffon  */
    GModule *module;                        /* Abstration de manipulation  */

    const plugin_interface *interface;      /* Déclaration d'interfaçage   */

    PluginStatusFlags flags;                /* Fanion pour l'état courant  */

    bitfield_t *dependencies;               /* Cartographie des dépendances*/

};


/* Greffon pour Chrysalide (classe) */
struct _GPluginModuleClass
{
    GObjectClass parent;                    /* A laisser en premier        */

    pg_management_fc init;                  /* Procédure d'initialisation  */
    pg_management_fc exit;                  /* Procédure d'extinction      */

    pg_plugins_loaded_fc plugins_loaded;    /* Fin des chargements         */
    pg_build_instance_fc build_instance;    /* Création d'objets           */

    pg_get_modname_fc get_modname;          /* Fourniture du nom brut      */

    pg_include_theme_fc include_theme;      /* Extension d'un thème        */
    pg_notify_panel_fc notify_panel;        /* Création de panneau         */
    pg_notify_docking_fc notify_docking;    /* Affichage ou retrait        */

    pg_handle_content_fc handle_content;    /* Explorations ou résolutions */
    pg_handle_loaded_fc handle_loaded;      /* Traitement de contenu chargé*/

    pg_handle_format_analysis_fc handle_fmt_analysis; /* Analyse de format */
    pg_preload_format_fc preload_format;    /* Préchargement d'un format   */
    pg_attach_debug attach_debug;           /* Informations de débogage    */

    pg_process_disassembly_fc process_disass; /* Catégorie 'désassemblage' */

    pg_detect_tools_fc detect;              /* Lancement de détections     */

};



#endif  /* _PLUGINS_PLUGIN_INT_H */