/* OpenIDA - Outil d'analyse de fichiers binaires
 * plugin-int.h - prototypes pour les structures internes des greffons
 *
 * Copyright (C) 2010-2012 Cyrille Bagard
 *
 *  This file is part of OpenIDA.
 *
 *  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 Foobar.  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 "plugin-def.h"
#include "../gui/panels/log.h"




/* 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 OpenIDA (instance) */
struct _GPluginModule
{
    GObject parent;                         /* A laisser en premier        */

    GModule *module;                        /* Abstration de manipulation  */

    char *name;                             /* Nom associé au greffon      */
    char *filename;                         /* Fichier 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  */

};


/* Greffon pour OpenIDA (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 *, ...);



/* Ajoute un greffon à la liste principale de greffons. */
void add_plugin_to_main_list(GPluginModule *);




#endif  /* _FORMAT_PLUGINS_PLUGIN_INT_H */