summaryrefslogtreecommitdiff
path: root/src/plugins/plugin-int.h
blob: 03040d13471090d443c1e99b62f08acf398e8091 (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
135
136
137
138
139
140
141
142
143
144
145
146
147

/* Chrysalide - Outil d'analyse de fichiers binaires
 * plugin-int.h - prototypes pour les structures internes des greffons
 *
 * Copyright (C) 2010-2017 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 _FORMAT_PLUGINS_PLUGIN_INT_H
#define _FORMAT_PLUGINS_PLUGIN_INT_H


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


#include "plugin.h"
#include "plugin-def.h"
#include "../analysis/content.h"
#include "../common/bits.h"
#include "../core/logs.h"



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

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




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

/* Procède à une opération liée au format de fichier uniquement. */
typedef bool (* pg_handle_format) (const GPluginModule *, PluginAction, GBinFormat *, GtkStatusStack *);

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






/* Précise le nom associé au greffon. */
//typedef char * (* get_plugin_name_fc) (void);

/* Procède à l'initialisation du greffon. */
//typedef bool (* init_plugin_fc) (GPluginModule *, GObject *);

/* Procède à l'extinction du greffon. */
//typedef void (* exit_plugin_fc) (GPluginModule *);

/* Fournit une indication sur le type d'opération(s) menée(s). */
//typedef PluginAction (* get_plugin_action_fc) (const GPluginModule *);

/* Identifie un format à associer à un contenu binaire. */
//typedef MatchingFormatAction (* is_matching_fc) (const GPluginModule *, char **, bin_t **, off_t *);

/* Exécute une action définie sur un binaire chargé. */
//typedef bool (* execute_action_on_binary_fc) (const GPluginModule *, GLoadedBinary *, PluginAction);

/* Exécute une action relative à un débogueur. */
//typedef bool (* execute_on_debugger_fc) (const GPluginModule *, GBinaryDebugger *, PluginAction);


/* 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*/

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

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


    //char *name;                             /* Nom associé au greffon      */
    //PluginType type;                        /* Type(s) du greffon          */

    //init_plugin_fc init;                    /* Procédure d'initialisation  */
    //exit_plugin_fc exit;                    /* Procédure d'extinction      */
    //get_plugin_action_fc get_action;        /* Opération(s) menée(s)       */

    //is_matching_fc is_matching;             /* Recherche de correspondance */

    //execute_action_on_binary_fc exec_on_bin;/* Action sur un binaire       */
    //execute_on_debugger_fc handle_debugger; /* Action liée à un débogueur  */


    pg_handle_content handle_content;       /* Explorations ou résolutions */
    pg_handle_format handle_format;         /* Manipulation du format      */
    pg_preload_format preload_format;       /* Préchargement d'un format   */

};


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

};



/* Présente dans le journal un message simple. */
void g_plugin_module_log_simple_message(const GPluginModule *, LogMessageType, const char *);

/* Présente dans le journal un message complexe. */
void g_plugin_module_log_variadic_message(const GPluginModule *, LogMessageType, const char *, ...);








#endif  /* _FORMAT_PLUGINS_PLUGIN_INT_H */