summaryrefslogtreecommitdiff
path: root/plugins/kaitai/scope.c
blob: fad88905530c2ea24e4736d3e101d54305006aa5 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * scope.c - recherches d'éléments de lecture
 *
 * Copyright (C) 2023 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 "scope.h"


#include "parsers/struct.h"



/******************************************************************************
*                                                                             *
*  Paramètres  : locals = contexte de variables locales à initialiser.        *
*                meta   = informations générales à disposition.               *
*                                                                             *
*  Description : Initialise un contexte pour correspondances Kaitai établies. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void init_record_scope(kaitai_scope_t *locals, GKaitaiMeta *meta)
{
    locals->meta = meta;

    if (meta != NULL)
        g_object_ref(G_OBJECT(meta));

    locals->root = NULL;
    locals->parent = NULL;
    locals->last = NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = contexte de variables locales à réinitialiser.      *
*                                                                             *
*  Description : Vide un contexte de correspondances Kaitai établies.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void reset_record_scope(kaitai_scope_t *locals)
{
    g_clear_object(&locals->meta);

    g_clear_object(&locals->root);
    g_clear_object(&locals->parent);
    g_clear_object(&locals->last);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : dest = contexte de variables locales à initialiser.          *
*                src  = contexte de variables locales à copier.               *
*                                                                             *
*  Description : Copie un contexte de correspondances Kaitai établies.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void copy_record_scope(kaitai_scope_t *dest, const kaitai_scope_t *src)
{
    reset_record_scope(dest);

#define COPY_SCOPE_ITEM(itm)                    \
    dest->itm = src->itm;                       \
    if (dest->itm != NULL)                      \
        g_object_ref(G_OBJECT(dest->itm));

    COPY_SCOPE_ITEM(meta);

    COPY_SCOPE_ITEM(root);
    COPY_SCOPE_ITEM(parent);
    COPY_SCOPE_ITEM(last);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = variables locales pour les résolutions de types.    *
*                                                                             *
*  Description : Retourne le souvenir d'une correspondance racine.            *
*                                                                             *
*  Retour      : Dernière correspondance établie ou NULL.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GMatchRecord *get_root_record(const kaitai_scope_t *locals)
{
    GMatchRecord *result;                   /* Instance à retourner        */

    result = locals->root;

    if (result != NULL)
        g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = variables locales pour les résolutions de types.    *
*                                                                             *
*  Description : Retourne le souvenir de la correspondance parente effectuée. *
*                                                                             *
*  Retour      : Dernière correspondance établie ou NULL.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GMatchRecord *get_parent_record(const kaitai_scope_t *locals)
{
    GMatchRecord *result;                   /* Instance à retourner        */

    result = locals->parent;

    if (result != NULL)
        g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = variables locales pour les résolutions de types.    *
*                record = dernière correspondance établie.                    *
*                                                                             *
*  Description : Conserve le souvenir de la dernière correspondance effectuée.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void remember_last_record(kaitai_scope_t *locals, GMatchRecord *record)
{
    g_clear_object(&locals->last);

    locals->last = record;

    if (record != NULL)
        g_object_ref(G_OBJECT(record));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = variables locales pour les résolutions de types.    *
*                                                                             *
*  Description : Retourne le souvenir de la dernière correspondance effectuée.*
*                                                                             *
*  Retour      : Dernière correspondance établie ou NULL.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GMatchRecord *get_last_record(const kaitai_scope_t *locals)
{
    GMatchRecord *result;                   /* Instance à retourner        */

    result = locals->last;

    if (result != NULL)
        g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : locals = variables locales pour les résolutions de types.    *
*                name   = désignation du type particulier ciblé.              *
*                                                                             *
*  Description : Recherche la définition d'un type nouveau pour Kaitai.       *
*                                                                             *
*  Retour      : Type prêt à emploi ou NULL si non trouvé.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GKaitaiType *find_sub_type(const kaitai_scope_t *locals, const char *name)
{
    GKaitaiType *result;                    /* Instance à retourner        */
    size_t i;                               /* Boucle de parcours          */
    GKaitaiParser *parser;                  /* Lecteur d'origine           */

    GMatchRecord *list[] = { locals->last, locals->parent, locals->root };

    result = NULL;

    for (i = 0; i < 3; i++)
    {
        if (list[i] == NULL)
            continue;

        parser = g_match_record_get_creator(list[i]);

        if (G_IS_KAITAI_STRUCT(parser))
            result = g_kaitai_structure_find_sub_type(G_KAITAI_STRUCT(parser), name);

        g_object_unref(G_OBJECT(parser));

        if (result != NULL)
            break;

    }

    return result;

}