/* OpenIDA - Outil d'analyse de fichiers binaires
 * line_comment.c - représentation des lignes commentaires entières
 *
 * Copyright (C) 2008 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/>.
 */


#include "line_comment.h"


#include <malloc.h>
#include <string.h>


#include "line-int.h"



/* Ligne de représentation de commentaires entière (instance) */
struct _GCommentLine
{
    GRenderingLine parent;                  /* Instance parente            */

    char *comment;                          /* Texte à afficher            */
    const GRenderingOptions *options;       /* Options de représentation   */

};


/* Ligne de représentation de commentaires entière (classe) */
struct _GCommentLineClass
{
    GRenderingLineClass parent;             /* Classe parente              */

};


/* Initialise la classe des lignes de commentaires entière. */
static void g_comment_line_class_init(GCommentLineClass *);

/* Initialise la classe des lignes de commentaires entière. */
static void g_comment_line_init(GCommentLine *);

/* Ajoute à un texte GTK le contenu de la ligne de commentaires. */
static void g_comment_line_add_to_gtk_buffer(GCommentLine *, MainRendering, GtkTextBuffer *, GtkTextIter *, size_t [SAR_COUNT]);



/* Indique le type définit par la GLib pour la ligne. */
G_DEFINE_TYPE(GCommentLine, g_comment_line, G_TYPE_RENDERING_LINE);



/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des lignes de commentaires entière.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_comment_line_class_init(GCommentLineClass *klass)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : line = instance à initialiser.                               *
*                                                                             *
*  Description : Initialise la classe des lignes de commentaires entière.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_comment_line_init(GCommentLine *line)
{
    GContentExporter *exporter_parent;      /* Instance parente #1         */
    GRenderingLine *line_parent;            /* Instance parente #2         */

    exporter_parent = G_CONTENT_EXPORTER(line);

    exporter_parent->add_to_gtk_buffer = (add_to_gtk_buffer_fc)g_comment_line_add_to_gtk_buffer;

    line_parent = G_RENDERING_LINE(line);

    line_parent->type = RLT_PROTOTYPE/* TODO */;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : line      = ligne de représentation à actualiser.            *
*                rendering = support effectif final des lignes de code.       *
*                buffer    = zone de texte à venir compléter.                 *
*                iter      = point d'insertion du nouveau texte.              *
*                lengths   = taille des différentes composantes de la ligne.  *
*                                                                             *
*  Description : Ajoute à un texte GTK le contenu de la ligne de commentaires.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_comment_line_add_to_gtk_buffer(GCommentLine *line, MainRendering rendering, GtkTextBuffer *buffer, GtkTextIter *iter, size_t lengths[SAR_COUNT])
{
    bool show_address;                      /* Affichage de l'adresse ?    */
    bool show_code;                         /* Affichage du code brut ?    */
    MemoryDataSize msize;                   /* Taille du bus d'adresses    */
    char address[VMPA_MAX_SIZE];            /* Adresse au format texte     */
    size_t len;                             /* Taille de l'élément inséré  */

    show_address = g_rendering_options_has_to_show_address(line->options, rendering);
    show_code = g_rendering_options_has_to_show_code(line->options, rendering);

    /* Eventuelle adresse virtuelle ou physique */

    if (show_address)
    {
        msize = g_arch_processor_get_memory_size(g_rendering_options_get_processor(line->options));

        len = vmpa_to_string(G_RENDERING_LINE(line)->offset, msize, address);

        g_content_exporter_insert_with_gtk_tag(G_CONTENT_EXPORTER(line), buffer, iter,
                                           address, len, RTT_NONE);

        g_content_exporter_insert_with_gtk_tag(G_CONTENT_EXPORTER(line), buffer, iter,
                                               "\t", 1, RTT_NONE);

    }

    /* Eventuel code brut (sauté) */

    if (show_code)
        g_content_exporter_insert_with_gtk_tag(G_CONTENT_EXPORTER(line), buffer, iter,
                                               "\t", 1, RTT_NONE);

    /* Commentaire proprement dit */

    g_content_exporter_insert_with_gtk_tag(G_CONTENT_EXPORTER(line), buffer, iter,
                                           "; ", 2, RTT_COMMENT);

    len = strlen(line->comment);

    g_content_exporter_insert_with_gtk_tag(G_CONTENT_EXPORTER(line), buffer, iter,
                                           line->comment, len, RTT_COMMENT);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : offset  = emplacement physique ou en mémoire.                *
*                comment = texte à afficher au final.                         *
*                options = paramétrage du rendu.                              *
*                                                                             *
*  Description : Crée une ligne de commentaires entière.                      *
*                                                                             *
*  Retour      : Adresse de la structure mise en place.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GRenderingLine *g_comment_line_new(uint64_t offset, const char *comment, const GRenderingOptions *options)
{
    GCommentLine *result;                   /* Structure à retourner       */

    result = g_object_new(G_TYPE_COMMENT_LINE, NULL);

    G_RENDERING_LINE(result)->offset = offset;

    result->comment = strdup(comment);
    result->options = options;

    return G_RENDERING_LINE(result);

}