/* OpenIDA - Outil d'analyse de fichiers binaires
 * line.h - prototypes pour la représentation des lignes de rendu
 *
 * Copyright (C) 2009-2010 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_LINE_H
#define _ANALYSIS_LINE_H


#include <gtk/gtk.h>


#include "roptions.h"



/* ------------------------ TRAITEMENT INDIVIDUEL DES LIGNES ------------------------ */


/* Définitions des types de ligne */
typedef enum _RenderingLineType
{
    RLT_PROLOGUE,                           /* Description de l'analyse    */
    RLT_PROTOTYPE,                          /* Prototype de fonction       */
    RLT_CODE                                /* Code en langage machine     */

} RenderingLineType;

/* Image à afficher en marge de ligne */
typedef enum _RenderingLineFlag
{
    RLF_NONE            = (0 << 0),         /* Ligne commune               */
    RLF_ENTRY_POINT     = (1 << 0),         /* Point d'entrée du prgm.     */
    RLF_BREAK_POINT     = (1 << 1),         /* Point d'arrêt               */
    RLF_RUNNING_BP      = (1 << 2)          /* Point d'arrêt activé        */

} RenderingLineFlag;


#define G_TYPE_RENDERING_LINE               g_rendering_line_get_type()
#define G_RENDERING_LINE(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_rendering_line_get_type(), GRenderingLine))
#define G_IS_RENDERING_LINE(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_rendering_line_get_type()))
#define G_RENDERING_LINE_GET_IFACE(inst)    (G_TYPE_INSTANCE_GET_INTERFACE((inst), g_rendering_line_get_type(), GRenderingLineIface))
#define G_RENDERING_LINE_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_RENDERING_LINE, GRenderingLineClass))


/* Ligne de représentation générique (instance) */
typedef struct _GRenderingLine GRenderingLine;

/* Ligne de représentation générique (classe) */
typedef struct _GRenderingLineClass GRenderingLineClass;


/* Indique le type définit pour une ligne de représentation. */
GType g_rendering_line_get_type(void);

/* Fournit l'adresse physique ou en mémoire d'une ligne. */
vmpa_t get_rendering_line_address(const GRenderingLine *);

/* Fournit la longueur du code représenté par une ligne. */
off_t get_rendering_line_length(const GRenderingLine *);

/* Fournit le commentaire associé à la ligne s'il existe. */
const char *get_rendering_line_comment(const GRenderingLine *);

/* Définit ou supprime un commentaire pour la ligne indiquée. */
void set_rendering_line_comment(GRenderingLine *, const char *);

/* Fournit le type d'une ligne. */
RenderingLineType get_rendering_line_type(const GRenderingLine *);

/* Ajoute une information supplémentaire à une ligne. */
void g_rendering_line_add_flag(GRenderingLine *, RenderingLineFlag);

/* Retire une information supplémentaire d'une ligne. */
void g_rendering_line_remove_flag(GRenderingLine *, RenderingLineFlag);

/* Bascule l'état d'une information sur d'une ligne. */
void g_rendering_line_toggle_flag(GRenderingLine *, RenderingLineFlag);

/* Fournit les informations supplémentaires d'une ligne. */
RenderingLineFlag g_rendering_line_get_flags(const GRenderingLine *);

/* Etablit un lien entre deux lignes de représentation. */
void g_rendering_line_link_with(GRenderingLine *, GRenderingLine *, InstructionLinkType);

/* Indique si la ligne a une ou plusieurs origines. */
bool g_rendering_line_has_sources(const GRenderingLine *);

/* Indique si la ligne a une suite autre que la ligne suivante. */
bool g_rendering_line_has_destinations(const GRenderingLine *);

/* Fournit la ligne de code de destination du lien de la ligne. */
size_t g_rendering_line_get_destinations(const GRenderingLine *, GRenderingLine ***, InstructionLinkType **);



/* ------------------------ TRAITEMENT DES LIGNES PAR GROUPE ------------------------ */


/* Ajoute une ligne à un ensemble existant. */
void g_rendering_line_add_to_lines(GRenderingLine **, GRenderingLine *);

/* Insère une ligne dans un ensemble existant.  */
void g_rendering_line_insert_into_lines(GRenderingLine **, GRenderingLine *, bool);

/* Insère des lignes dans un ensemble existant. */
void g_rendering_line_insert_lines(GRenderingLine **, GRenderingLine **);

/* Supprime une série de lignes comprises dans un intervalle. */
void g_rendering_line_remove_range(GRenderingLine **, vmpa_t, vmpa_t);

/* Fusionne deux listes de lignes de rendu. */
void g_rendering_line_merge(GRenderingLine **, GRenderingLine **);

/* Fournit l'élement suivant un autre pour un parcours. */
GRenderingLine *g_rendering_line_get_next_iter(GRenderingLine *, const GRenderingLine *, const GRenderingLine *);

/* Fournit l'élement précédant un autre pour un parcours. */
GRenderingLine *g_rendering_line_get_prev_iter(GRenderingLine *, const GRenderingLine *, const GRenderingLine *);

/* Fournit le dernier élément d'une liste de lignes. */
GRenderingLine *g_rendering_line_get_last_iter(GRenderingLine *, GRenderingLine *);

/* Recherche une ligne d'après sa position en mémoire/physique. */
GRenderingLine *g_rendering_line_find_by_address(GRenderingLine *, const GRenderingLine *, vmpa_t);

/* Donne la première ligne de code correspondant à une adresse. */
GRenderingLine *g_rendering_line_loop_for_code(GRenderingLine *, const GRenderingLine *);



#endif  /* _ANALYSIS_LINE_H */