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



/* Pointe le fichier contenant le greffon manipulé. */
typedef char * (* get_plugin_filename_fc) (const GPluginModule *);

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

/* Prend acte de (l'|la dés)activation du greffon. */
typedef bool (* pg_management_fc) (GPluginModule *);




/* Transfert de la conscience de soi. */
typedef void (* pg_set_self_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);

#if 0

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

#ifdef INCLUDE_GTK_SUPPORT

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

#endif

/* 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 *);
#endif


/* Marqueur identifiable */
#define CHRYSALIDE_PLUGIN_MAGIC 0xdeadc0de


/* Version identifiant les définitions courantes */
typedef uint32_t plugin_abi_version_t;

#define DEFINE_PLUGIN_ABI_VERSION(maj, min, rev) \
    (((maj & 0xff) << 24) | ((min & 0xff) << 16) | (rev & 0xffff))

#define GET_ABI_MAJ_VERSION(vs) ((vs >> 24) & 0xff)
#define GET_ABI_MIN_VERSION(vs) ((vs >> 16) & 0xff)
#define GET_ABI_REV_VERSION(vs) (vs & 0xffff)

/**
 * 0.3.0 : dernière version avec actions et fonctions associées
 * 1.0.0 (04/01/25) : bascule en chargement d'objet et interfaces
 */
#define CURRENT_ABI_VERSION DEFINE_PLUGIN_ABI_VERSION(1, 0, 0)


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

    uint32_t magic;                         /* Vérification a minima       */
    plugin_abi_version_t abi_version;       /* Version du protocole utilisé*/

    char *name;                             /* Désignation humaine courte  */
    char *desc;                             /* Description plus loquace    */
    char *version;                          /* Version du greffon          */
    char *url;                              /* Site Web associé            */

    char **required;                        /* Pré-chargements requis      */
    size_t required_count;                  /* Quantité de ces dépendances */

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

    get_plugin_filename_fc get_filename;    /* Obtention du chemin         */
    get_plugin_modname_fc get_modname;      /* Fourniture du nom brut      */

    pg_management_fc enable;                /* Procédure d'activation      */
    pg_management_fc disable;               /* Procédure d'extinction      */



    /////////////////////////////////////////////

#if 0

    pg_management_fc init;                  /* Procédure d'initialisation  */
    pg_management_fc manage;                /* Etape dans la vie du greffon*/
    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           */

#if 0
#ifdef INCLUDE_GTK_SUPPORT
    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        */
#endif

    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
#endif

    /////////////////////////////////////////////


};



#define STORE_PLUGIN_ABI(p)                     \
    do                                          \
    {                                           \
        GPluginModule *_p;                      \
        _p = G_PLUGIN_MODULE(p);                \
        _p->magic = CHRYSALIDE_PLUGIN_MAGIC;    \
        _p->abi_version = CURRENT_ABI_VERSION;  \
    }                                           \
    while (0);


/* Met en place un greffon. */
bool g_plugin_module_create(GPluginModule *, const char *, const char *, const char *, const char *, const char * const *, size_t);



#endif  /* _PLUGINS_PLUGIN_INT_H */