summaryrefslogtreecommitdiff
path: root/plugins/kaitai/parsers/type.c
blob: 81efbeb9ce1c7ae203fdb2af3a7e712568554259 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * struct.c - définition d'une structure Kaitai
 *
 * Copyright (C) 2019 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/>.
 */


#include "type.h"


#include <malloc.h>
#include <string.h>
#include <plugins/yaml/pair.h>


#include "type-int.h"
#include "../parser.h"



/* Initialise la classe des types particuliers pour Kaitai. */
static void g_kaitai_type_class_init(GKaitaiTypeClass *);

/* Initialise un type particulier pour Kaitai. */
static void g_kaitai_type_init(GKaitaiType *);

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

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



/* Indique le type défini pour un type particulier pour Kaitai. */
G_DEFINE_TYPE(GKaitaiType, g_kaitai_type, G_TYPE_KAITAI_STRUCT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des types particuliers pour Kaitai.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_kaitai_type_class_init(GKaitaiTypeClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_kaitai_type_dispose;
    object->finalize = (GObjectFinalizeFunc)g_kaitai_type_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : kstruct = instance à initialiser.                            *
*                                                                             *
*  Description : Initialise un type particulier pour Kaitai.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_kaitai_type_init(GKaitaiType *type)
{
    type->name = NULL;

}


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

static void g_kaitai_type_dispose(GKaitaiType *type)
{
    G_OBJECT_CLASS(g_kaitai_type_parent_class)->dispose(G_OBJECT(type));

}


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

static void g_kaitai_type_finalize(GKaitaiType *type)
{
    if (type->name != NULL)
        free(type->name);

    G_OBJECT_CLASS(g_kaitai_type_parent_class)->finalize(G_OBJECT(type));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : parent = noeud Yaml contenant l'attribut à constituer.       *
*                                                                             *
*  Description : Construit un lecteur de type pour Kaitai.                    *
*                                                                             *
*  Retour      : Instance mise en place ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GKaitaiType *g_kaitai_type_new(GYamlNode *parent)
{
    GKaitaiType *result;                    /* Structure à retourner       */

    result = g_object_new(G_TYPE_KAITAI_TYPE, NULL);

    if (!g_kaitai_type_create(result, parent))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type   = lecteur de type Kaitai à initialiser pleinement.    *
*                parent = noeud Yaml contenant l'attribut à constituer.       *
*                                                                             *
*  Description : Met en place un lecteur de type pour Kaitai.                 *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_kaitai_type_create(GKaitaiType *type, GYamlNode *parent)
{
    bool result;                            /* Bilan à retourner           */
    const char *name;                       /* Désignation du type         */
    char *sub_path;                         /* Chemin d'accès suivant      */
    GYamlNode *sub;                         /* Contenu Yaml d'un type      */

    result = false;

    /* Extraction du nom */

    if (!G_IS_YAML_PAIR(parent))
        goto exit;

    name = g_yaml_pair_get_key(G_YAML_PAIR(parent));

    type->name = strdup(name);

    /* Extraction des bases du type */

    asprintf(&sub_path, "/%s/", name);
    sub = g_yaml_node_find_first_by_path(parent, sub_path);
    free(sub_path);

    if (sub == NULL)
        goto exit;

    result = g_kaitai_structure_create(G_KAITAI_STRUCT(type), sub);

    g_object_unref(G_OBJECT(sub));

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : name     = nom à attribuer au futur type.                    *
*                filename = chemin vers une définition Kaitai à charger.      *
*                                                                             *
*  Description : Construit un lecteur de type externe pour Kaitai.            *
*                                                                             *
*  Retour      : Instance mise en place ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GKaitaiType *g_kaitai_type_new_as_import(const char *name, const char *filename)
{
    GKaitaiType *result;                    /* Structure à retourner       */

    result = g_object_new(G_TYPE_KAITAI_TYPE, NULL);

    if (!g_kaitai_type_create_as_import(result, name, filename))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type     = lecteur de type Kaitai à initialiser pleinement.  *
*                name     = nom à attribuer au futur type.                    *
*                filename = chemin vers une définition Kaitai à charger.      *
*                                                                             *
*  Description : Met en place un lecteur de type externe pour Kaitai.         *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_kaitai_type_create_as_import(GKaitaiType *type, const char *name, const char *filename)
{
    bool result;                            /* Bilan à retourner           */

    /* Extraction du nom */

    type->name = strdup(name);

    /* Extraction des bases du type */

    result = g_kaitai_structure_create_from_file(G_KAITAI_STRUCT(type), filename);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = définition de type particulier à consulter.           *
*                                                                             *
*  Description : Indique le nom de scène du type représenté.                  *
*                                                                             *
*  Retour      : Désignation humaine.                                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_kaitai_type_get_name(const GKaitaiType *type)
{
    const char *result;                     /* Nom à retourner             */

    result = type->name;

    return result;

}