summaryrefslogtreecommitdiff
path: root/src/analysis/line_comment.c
blob: 8af1777f0e0074f6abafd4927977c46004552803 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267

/* 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 du texte simple à un fichier ouvert en écriture. */
static void g_comment_line_add_text(GCommentLine *, GRenderingOptions *, MainRendering, FILE *);

/* 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_text = (add_text_fc)g_comment_line_add_text;
    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.            *
*                options   = options de rendu.                                *
*                rendering = support effectif final des lignes de code.       *
*                stream    = flux ouvert en écriture.                         *
*                                                                             *
*  Description : Ajoute du texte simple à un fichier ouvert en écriture.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_comment_line_add_text(GCommentLine *line, GRenderingOptions *options, MainRendering rendering, FILE *stream)
{
    GContentExporter *exporter;             /* Autre vision de la ligne    */
    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é  */

    exporter = G_CONTENT_EXPORTER(line);

    show_address = g_rendering_options_has_to_show_address(options, rendering);
    show_code = g_rendering_options_has_to_show_code(options, rendering);

    /* Eventuelle adresse virtuelle ou physique */

    if (show_address)
    {
        msize = g_arch_processor_get_memory_size(g_rendering_options_get_processor(options));

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

        g_content_exporter_insert_text(exporter, stream, address, len, RTT_NONE);
        g_content_exporter_insert_text(exporter, stream, "\t", 1, RTT_NONE);

    }

    /* Eventuel code brut (sauté) */

    if (show_code)
        g_content_exporter_insert_text(exporter, stream, "\t", 1, RTT_NONE);

    /* Commentaire proprement dit */

    g_content_exporter_insert_text(exporter, stream, "; ", 2, RTT_COMMENT);

    len = strlen(line->comment);

    g_content_exporter_insert_text(exporter, stream, line->comment, len, RTT_COMMENT);

}


/******************************************************************************
*                                                                             *
*  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);

}