/* Chrysalide - Outil d'analyse de fichiers binaires
 * processor.h - prototypes pour la gestion générique des architectures
 *
 * Copyright (C) 2008-2012 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  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_PROCESSOR_H
#define _ARCH_PROCESSOR_H


#include <glib-object.h>


#include "context.h"
#include "instruction.h"
#include "../common/endianness.h"
#include "../decomp/context.h"
#include "../format/format.h"



#define G_TYPE_ARCH_PROCESSOR               g_arch_processor_get_type()
#define G_ARCH_PROCESSOR(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_arch_processor_get_type(), GArchProcessor))
#define G_IS_ARCH_PROCESSOR(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_arch_processor_get_type()))
#define G_ARCH_PROCESSOR_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_ARCH_PROCESSOR, GArchProcessorClass))
#define G_IS_ARCH_PROCESSOR_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_ARCH_PROCESSOR))
#define G_ARCH_PROCESSOR_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_ARCH_PROCESSOR, GArchProcessorClass))



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

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


/* Indique le type défini pour un processeur d'architecture. */
GType g_arch_processor_get_type(void);

/* Fournit un contexte propre au processeur d'une architecture. */
GProcContext *g_arch_processor_get_context(const GArchProcessor *);

/* Fournit un contexte lié au processeur pour une décompilation. */
GDecContext *g_arch_processor_get_decomp_context(const GArchProcessor *);

/* Fournit le boustime du processeur d'une architecture. */
SourceEndian g_arch_processor_get_endianness(const GArchProcessor *);

/* Fournit la taille de l'espace mémoire d'une architecture. */
MemoryDataSize g_arch_processor_get_memory_size(const GArchProcessor *);

/* Fournit la taille min. des instructions d'une architecture. */
MemoryDataSize g_arch_processor_get_instruction_size(const GArchProcessor *);

/* Décode une instruction dans un flux de données. */
GArchInstruction *g_arch_processor_decode_instruction(const GArchProcessor *, GProcContext *, const bin_t *, off_t *, off_t, vmpa_t, GBinFormat *);



/* ------------------------ ARCHITECTURES DANS LEUR ENSEMBLE ------------------------ */


/* Type de processeurs disponibles */
typedef enum _ArchProcessorType
{
    APT_ARM,                                /* ARM vX                      */
    APT_DALVIK,                             /* Dalvik Virtual Machine      */
    APT_JVM,                                /* Java Virtual Machine        */
    APT_MIPS,                               /* Mips 32 ou 64 bits          */
    APT_386,                                /* Intel 80386                 */

    APT_COUNT

} ArchProcessorType;


/* Procède au chargement des différentes architectures. */
bool init_all_processors(void);

/* Fournit le processeur d'architecture correspondant à un type. */
GArchProcessor *get_arch_processor_for_type(ArchProcessorType);

/* Fournit le processeur d'architecture lié à un format. */
GArchProcessor *get_arch_processor_from_format(const GExeFormat *);



#endif  /* _ARCH_PROCESSOR_H */