/* OpenIDA - Outil d'analyse de fichiers binaires
 * instruction-int.h - prototypes pour la définition générique interne des instructions
 *
 * Copyright (C) 2008-2011 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 _ARCH_INSTRUCTION_INT_H
#define _ARCH_INSTRUCTION_INT_H


#include "archbase.h"
#include "instruction.h"
#include "translate.h"
#include "../common/dllist.h"



/* Liste les registres lus et écrits par l'instruction. */
typedef void (* get_instruction_rw_regs_fc) (const GArchInstruction *, GArchRegister ***, size_t *, GArchRegister ***, size_t *);

/* Ajoute à un tampon GLib le contenu de l'instance spécifiée. */
typedef void (* print_instruction_fc) (const GArchInstruction *, GCodeBuffer *, MemoryDataSize, const bin_t *, AsmSyntax);

/* Traduit une instruction en version humainement lisible. */
typedef const char * (* get_instruction_text_fc) (const GArchInstruction *, const GExeFormat *, AsmSyntax);

/* Informe sur une éventuelle référence à une autre instruction. */
typedef InstructionLinkType (* get_instruction_link_fc) (const GArchInstruction *, vmpa_t *);

/* Indique si l'instruction correspond à un retour de fonction. */
typedef bool (* is_instruction_return_fc) (const GArchInstruction *);


/* Définition générique d'une instruction d'architecture (instance) */
struct _GArchInstruction
{
    GObject parent;                         /* A laisser en premier        */

    DL_LIST_ITEM(flow);                     /* Maillon de liste chaînée    */

    off_t offset;                           /* Position physique de départ */
    off_t length;                           /* Taille de l'instruction     */

    vmpa_t address;                         /* Position associée           */

    GArchOperand **operands;                /* Liste des opérandes         */
    size_t operands_count;                  /* Nbre. d'opérandes utilisées */

    GArchInstruction **from;                /* Origines des références     */
    size_t from_count;                      /* Nombre de ces origines      */
    GArchInstruction **to;                  /* Eventuelles lignes visées   */
    InstructionLinkType *links_type;        /* Type des liens de dest.     */
    size_t to_count;                        /* Nombre de ces destinations  */

    get_instruction_rw_regs_fc get_rw_regs; /* Liste des registres liés    */
    print_instruction_fc print;             /* Imprime l'ensemble          */
    get_instruction_text_fc get_text;       /* Texte humain équivalent     */
    get_instruction_link_fc get_link;       /* Référence à une instruction */
    is_instruction_return_fc is_return;     /* Retour de fonction ou pas ? */
    decomp_instr_fc decomp;                 /* Procédure de décompilation  */

};


/* Définition générique d'une instruction d'architecture (classe) */
struct _GArchInstructionClass
{
    GObjectClass parent;                    /* A laisser en premier        */

};


#define ainstr_list_prev_iter(iter, head) dl_list_prev_iter(iter, head, GArchInstruction, flow)
#define ainstr_list_next_iter(iter, head) dl_list_next_iter(iter, head, GArchInstruction, flow)
#define ainstr_list_add_tail(new, head) dl_list_add_tail(new, head, GArchInstruction, flow)
#define ainstr_list_for_each(pos, head) dl_list_for_each(pos, head, GArchInstruction, flow)



#endif  /* _ARCH_INSTRUCTION_INT_H */