summaryrefslogtreecommitdiff
path: root/src/glibext/generators/prologue.c
blob: f88393b341c93c420fa69f33d7358a904622c5fd (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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

/* Chrysalide - Outil d'analyse de fichiers binaires
 * prologue.c - génération à la volée de lignes d'introduction
 *
 * Copyright (C) 2016-2017 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "prologue.h"


#include <assert.h>
#include <malloc.h>


#include "../gbufferline.h"
#include "../linegen-int.h"
#include "../linesegment.h"
#include "../../format/executable.h"



/* Tampon pour générateur de lignes en prologue (instance) */
struct _GIntroGenerator
{
    GObject parent;                         /* A laisser en premier        */

    vmpa2t addr;                            /* Position première           */

    char **text;                            /* Lignes brutes à représenter */
    size_t count;                           /* Quantité de ces lignes      */

};

/* Tampon pour générateur de lignes en prologue (classe) */
struct _GIntroGeneratorClass
{
    GObjectClass parent;                    /* A laisser en premier        */

};


/* Procède à l'initialisation d'une classe de générateur. */
static void g_intro_generator_class_init(GIntroGeneratorClass *);

/* Procède à l'initialisation d'un générateur de lignes d'intro. */
static void g_intro_generator_init(GIntroGenerator *);

/* Procède à l'initialisation de l'interface de génération. */
static void g_intro_generator_interface_init(GLineGeneratorInterface *);

/* Supprime toutes les références externes. */
static void g_intro_generator_dispose(GIntroGenerator *);

/* Procède à la libération totale de la mémoire. */
static void g_intro_generator_finalize(GIntroGenerator *);

/* Indique le nombre de ligne prêtes à être générées. */
static size_t g_intro_generator_count_lines(const GIntroGenerator *);

/* Retrouve l'emplacement correspondant à une position donnée. */
static void g_intro_generator_compute_addr(const GIntroGenerator *, gint, vmpa2t *, size_t, size_t);

/* Détermine si le conteneur s'inscrit dans une plage donnée. */
static int g_intro_generator_contains_addr(const GIntroGenerator *, const vmpa2t *, size_t, size_t);

/* Renseigne sur les propriétés liées à un générateur. */
static BufferLineFlags g_intro_generator_get_flags(const GIntroGenerator *, size_t, size_t);

/* Imprime dans une ligne de rendu le contenu représenté. */
static void g_intro_generator_print(GIntroGenerator *, GBufferLine *, size_t, size_t);



/* Détermine le type du générateur de lignes d'introduction à la volée. */
G_DEFINE_TYPE_WITH_CODE(GIntroGenerator, g_intro_generator, G_TYPE_OBJECT,
                        G_IMPLEMENT_INTERFACE(G_TYPE_LINE_GENERATOR, g_intro_generator_interface_init));


/******************************************************************************
*                                                                             *
*  Paramètres  : class = classe de composant GLib à initialiser.              *
*                                                                             *
*  Description : Procède à l'initialisation d'une classe de générateur.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_class_init(GIntroGeneratorClass *class)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(class);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_intro_generator_dispose;
    object->finalize = (GObjectFinalizeFunc)g_intro_generator_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = composant GLib à initialiser.                    *
*                                                                             *
*  Description : Procède à l'initialisation d'un générateur de lignes d'intro.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_init(GIntroGenerator *generator)
{
    generator->text = NULL;
    generator->count = 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : iface = interface GLib à initialiser.                        *
*                                                                             *
*  Description : Procède à l'initialisation de l'interface de génération.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_interface_init(GLineGeneratorInterface *iface)
{
    iface->count = (linegen_count_lines_fc)g_intro_generator_count_lines;
    iface->compute = (linegen_compute_fc)g_intro_generator_compute_addr;
    iface->contains = (linegen_contains_fc)g_intro_generator_contains_addr;
    iface->get_flags = (linegen_get_flags_fc)g_intro_generator_get_flags;
    iface->print = (linegen_print_fc)g_intro_generator_print;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = instance d'objet GLib à traiter.                 *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_dispose(GIntroGenerator *generator)
{
    G_OBJECT_CLASS(g_intro_generator_parent_class)->dispose(G_OBJECT(generator));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = instance d'objet GLib à traiter.                 *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_finalize(GIntroGenerator *generator)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < generator->count; i++)
        free(generator->text[i]);

    if (generator->text != NULL)
        free(generator->text);

    G_OBJECT_CLASS(g_intro_generator_parent_class)->finalize(G_OBJECT(generator));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : lang  = trauducteur pour l'impression finale.                *
*                text  = tableau de lignes à conserver.                       *
*                count = taille du tableau fourni.                            *
*                                                                             *
*  Description : Crée un nouveau générateur de lignes d'introduction.         *
*                                                                             *
*  Retour      : Composant GLib créé ou NULL en cas d'échec.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GIntroGenerator *g_intro_generator_new(const GBinFormat *format, const GCodingLanguage *lang, char **text, size_t count)
{
    GIntroGenerator *result;                /* Composant à retourner       */
    vmpa2t first;                           /* Première position           */

    if (!g_exe_format_translate_offset_into_vmpa(G_EXE_FORMAT(format), 0, &first))
        return NULL;

    result = g_object_new(G_TYPE_INTRO_GENERATOR, NULL);

    copy_vmpa(&result->addr, &first);

    result->text = text;
    result->count = count;

    g_coding_language_encapsulate_comments(lang, &result->text, &result->count);

    result->text = (char **)realloc(result->text, ++result->count * sizeof(char *));

    result->text[result->count - 1] = NULL;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = générateur à consulter.                          *
*                                                                             *
*  Description : Indique le nombre de ligne prêtes à être générées.           *
*                                                                             *
*  Retour      : Nombre de lignes devant apparaître au final.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static size_t g_intro_generator_count_lines(const GIntroGenerator *generator)
{
    return generator->count;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = générateur à consulter.                          *
*                x         = position géographique sur la ligne concernée.    *
*                addr      = position en mémoire à analyser.                  *
*                index     = indice de cette même ligne dans le tampon global.*
*                repeat    = indice d'utilisations successives du générateur. *
*                                                                             *
*  Description : Retrouve l'emplacement correspondant à une position donnée.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_compute_addr(const GIntroGenerator *generator, gint x, vmpa2t *addr, size_t index, size_t repeat)
{
    copy_vmpa(addr, &generator->addr);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = générateur à consulter.                          *
*                addr      = position en mémoire à analyser.                  *
*                index     = indice de cette même ligne dans le tampon global.*
*                repeat    = indice d'utilisations successives du générateur. *
*                                                                             *
*  Description : Détermine si le conteneur s'inscrit dans une plage donnée.   *
*                                                                             *
*  Retour      : Bilan de la détermination, utilisable en comparaisons.       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int g_intro_generator_contains_addr(const GIntroGenerator *generator, const vmpa2t *addr, size_t index, size_t repeat)
{
    return cmp_vmpa(addr, &generator->addr);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = générateur à consulter.                          *
*                index     = indice de cette même ligne dans le tampon global.*
*                repeat    = indice d'utilisations successives du générateur. *
*                                                                             *
*  Description : Renseigne sur les propriétés liées à un générateur.          *
*                                                                             *
*  Retour      : Propriétés particulières associées.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static BufferLineFlags g_intro_generator_get_flags(const GIntroGenerator *generator, size_t index, size_t repeat)
{
    return BLF_NONE;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : generator = générateur à utiliser pour l'impression.         *
*                line      = ligne de rendu à compléter.                      *
*                index     = indice de cette même ligne dans le tampon global.*
*                repeat    = indice d'utilisations successives du générateur. *
*                                                                             *
*  Description : Imprime dans une ligne de rendu le contenu représenté.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_intro_generator_print(GIntroGenerator *generator, GBufferLine *line, size_t index, size_t repeat)
{
    assert(repeat < generator->count);

    if ((repeat + 1) != generator->count)
    {
        g_buffer_line_start_merge_at(line, BLC_PHYSICAL);

        g_buffer_line_append_text(line, BLC_PHYSICAL, SL(generator->text[repeat]), RTT_COMMENT, NULL);

        if (repeat == 0)
            g_buffer_line_add_flag(line, BLF_WIDTH_MANAGER);

    }

}