/* OpenIDA - Outil d'analyse de fichiers binaires
 * binary.h - prototypes pour le traitement des flots de code binaire
 *
 * Copyright (C) 2008 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 _ANALYSIS_BINARY_H
#define _ANALYSIS_BINARY_H


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


#include "line.h"
#include "../arch/processor.h"
#include "../common/xml.h"
#include "../debug/break.h"
#include "../format/executable.h"
#include "../glibext/gcodebuffer.h"



#define G_TYPE_OPENIDA_BINARY               g_openida_binary_get_type()
#define G_OPENIDA_BINARY(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_openida_binary_get_type(), GOpenidaBinary))
#define G_IS_OPENIDA_BINARY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_openida_binary_get_type()))
#define G_OPENIDA_BINARY_GET_IFACE(inst)    (G_TYPE_INSTANCE_GET_INTERFACE((inst), g_openida_binary_get_type(), GOpenidaBinaryIface))
#define G_OPENIDA_BINARY_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_OPENIDA_BINARY, GOpenidaBinaryClass))


/* Description de fichier binaire (instance) */
typedef struct _GOpenidaBinary GOpenidaBinary;

/* Description de fichier binaire (classe) */
typedef struct _GOpenidaBinaryClass GOpenidaBinaryClass;


/* Modèle de sélection des parties */
typedef enum _BinaryPartModel
{
    BPM_DEFAULT,                            /* Selon le modèle par défaut  */
    BPM_ROUTINES,                           /* Sélection par les routines  */
    BPM_USER,                               /* Définitions utilisateur     */

    BPM_COUNT

} BinaryPartModel;


/* Indique le type défini pour une description de fichier binaire. */
GType g_openida_binary_get_type(void);

/* Charge en mémoire le contenu d'un fichier. */
GOpenidaBinary *g_openida_binary_new_from_file(const char *);

/* Charge en mémoire le contenu d'un fichier à partir d'XML. */
GOpenidaBinary *g_openida_binary_new_from_xml(xmlXPathContextPtr, const char *);

/* Ecrit une sauvegarde du binaire dans un fichier XML. */
bool g_openida_binary_save(const GOpenidaBinary *, xmlDocPtr, xmlXPathContextPtr, const char *);

/* Définit les parties de binaire à analyser. */
void g_openida_binary_set_parts(GOpenidaBinary *, BinaryPartModel, GBinPart **, size_t);

/* Fournit les parties de binaire analysées. */
GBinPart ***g_openida_binary_get_parts(const GOpenidaBinary *, BinaryPartModel *, size_t **);

/* Lance l'analyse d'un élément binaire chargé. */
void g_openida_binary_analyse(GOpenidaBinary *);

/* Fournit une description humaine d'un élément binaire. */
const char *g_openida_binary_to_string(const GOpenidaBinary *);

/* Fournit le fichier correspondant à l'élément binaire. */
const char *g_openida_binary_get_filename(const GOpenidaBinary *);

/* Fournit les détails du contenu binaire chargé en mémoire. */
bin_t *g_openida_binary_get_data(const GOpenidaBinary *, off_t *);

/* Fournit le format de fichier reconnu dans le contenu binaire. */
GExeFormat *g_openida_binary_get_format(const GOpenidaBinary *);

/* Fournit les options d'affichage définies pour le binaire. */
GRenderingOptions *g_openida_binary_get_options(const GOpenidaBinary *);

/* Donne la racine des lignes de rendu issues du désassemblage. */
GRenderingLine **g_openida_binary_get_lines_root(const GOpenidaBinary *);

/* Fournit les lignes de rendu issues du désassemblage. */
GRenderingLine *g_openida_binary_get_lines(const GOpenidaBinary *);

/* Fournit les instructions issues du désassemblage. */
GArchInstruction *g_openida_binary_get_instructions(const GOpenidaBinary *);

/* Fournit le tampon associé au contenu assembleur d'un binaire. */
GCodeBuffer *g_openida_binary_get_disassembled_buffer(const GOpenidaBinary *);

/* Fournit le tampon associé au contenu d'un fichier source. */
GCodeBuffer *g_openida_binary_get_decompiled_buffer(const GOpenidaBinary *, size_t);



/* ------------------------------ ELEMENTS DE DEBOGAGE ------------------------------ */


/* Ajoute un nouveau groupe de points d'arrêt au binaire. */
bool g_openida_binary_add_break_group(GOpenidaBinary *, const char *);

/* Ajoute ou supprime un point d'arrêt dans un binaire. */
void g_openida_binary_toggle_breakpoint(GOpenidaBinary *, vmpa_t);

/* Parcourt l'ensemble des groupes de points d'arrêt du binaire. */
void g_openida_binary_for_each_bp_group(GOpenidaBinary *, GExtFunc, gpointer);



#endif  /* _ANALYSIS_BINARY_H */