/* Chrysalide - Outil d'analyse de fichiers binaires
 * executable.h - prototypes pour le support des 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_H
#define _FORMAT_EXECUTABLE_H


#include <stdbool.h>


#include "../glibext/helpers.h"
#include "../glibext/portion.h"



#define G_TYPE_EXECUTABLE_FORMAT (g_executable_format_get_type())

DECLARE_GTYPE(GExecutableFormat, g_executable_format, G, EXECUTABLE_FORMAT);


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

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

/* Procède à l'enregistrement d'une portion dans un format. */
bool g_executable_format_include_portion(GExecutableFormat *, GBinaryPortion *, const vmpa2t *);

/* Fournit la première couche des portions composent le binaire. */
GBinaryPortion *g_executable_format_get_portions(GExecutableFormat *);

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

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


#define g_executable_format_translate_offset_into_address(fmt, off, addr)               \
    ({                                                                                  \
        bool __result;                                                                  \
        vmpa2t __pos;                                                                   \
        __result = g_executable_format_translate_offset_into_vmpa(fmt, off, &__pos);    \
        *addr = get_virt_addr(&__pos);                                                  \
        __result;                                                                       \
    })

#define g_executable_format_translate_address_into_offset(fmt, addr, off)               \
    ({                                                                                  \
        bool __result;                                                                  \
        vmpa2t __pos;                                                                   \
        __result = g_executable_format_translate_address_into_vmpa(fmt, addr, &__pos);  \
        *off = get_phy_addr(&__pos);                                                    \
        __result;                                                                       \
    })



#endif  /* _FORMAT_EXECUTABLE_H */