/* Chrysalide - Outil d'analyse de fichiers binaires
 * executable-int.h - prototypes de code utile aux formats d'exécutables
 *
 * Copyright (C) 2009-2024 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 _FORMAT_EXECUTABLE_INT_H
#define _FORMAT_EXECUTABLE_INT_H


#include "executable.h"


#include "program-int.h"



/* Indique le type d'architecture visée par le format. */
typedef char * (* get_target_machine_fc) (const GExecutableFormat *);

/* Fournit l'adresse principale associée à un format. */
typedef bool (* get_main_addr_fc) (GExecutableFormat *, vmpa2t *);

/* Etend la définition des portions au sein d'un binaire. */
typedef bool (* refine_portions_fc) (GExecutableFormat *);

/* Fournit l'emplacement correspondant à une position physique. */
typedef bool (* translate_phys_fc) (GExecutableFormat *, phys_t, vmpa2t *);

/* Fournit l'emplacement correspondant à une adresse virtuelle. */
typedef bool (* translate_virt_fc) (GExecutableFormat *, virt_t, vmpa2t *);


/* Format d'exécutable générique (instance) */
struct _GExecutableFormat
{
    GProgramFormat parent;                  /* A laisser en premier        */

    GBinaryPortion *portions;               /* Couches de morceaux binaires*/

};

/* Format d'exécutable générique (classe) */
struct _GExecutableFormatClass
{
    GProgramFormatClass parent;             /* A laisser en premier        */

    get_target_machine_fc get_machine;      /* Architecture ciblée         */

    get_main_addr_fc get_main_addr;         /* Obtention d'adresse première*/
    refine_portions_fc refine_portions;     /* Décrit les portions binaires*/

    translate_phys_fc translate_phys;       /* Correspondance phys -> vmpa */
    translate_virt_fc translate_virt;       /* Correspondance virt -> vmpa */

};


/* Met en place un nouveau contenu binaire à analyser. */
bool g_executable_format_create(GExecutableFormat *, GBinContent *);

/* Fournit l'emplacement correspondant à une position physique. */
bool g_executable_format_translate_offset_into_vmpa_without_virt(const GExecutableFormat *, phys_t, vmpa2t *);

/* Fournit l'emplacement correspondant à une position physique. */
bool g_executable_format_translate_offset_into_vmpa_with_portions(GExecutableFormat *, phys_t, vmpa2t *);

/* Fournit l'emplacement correspondant à une adresse virtuelle. */
bool g_executable_format_translate_address_into_vmpa_without_virt(const GExecutableFormat *, virt_t, vmpa2t *);

/* Fournit l'emplacement correspondant à une adresse virtuelle. */
bool g_executable_format_translate_address_into_vmpa_with_portions(GExecutableFormat *, virt_t, vmpa2t *);



#endif  /* _FORMAT_EXECUTABLE_INT_H */