summaryrefslogtreecommitdiff
path: root/plugins/yaml/collection.c
blob: cdc63d97cd5edf915fc25a0ed366b05511ca4b38 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * collection.h - collection de noeuds YAML de type "sequence" ou "mapping"
 *
 * 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 "collection.h"


#include <malloc.h>


#include "collection-int.h"



/* -------------------- DEFINITIONS PROPRES POUR LE SUPPORT YAML -------------------- */


/* Initialise la classe des collections de noeuds YAML. */
static void g_yaml_collection_class_init(GYamlCollectionClass *);

/* Initialise une instance de collection de noeuds YAML. */
static void g_yaml_collection_init(GYamlCollection *);

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

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



/* --------------------- IMPLEMENTATION DES FONCTIONS DE CLASSE --------------------- */


/* Recherche le premier noeud correspondant à un chemin. */
static GYamlNode *g_yaml_collection_find_first_by_path(GYamlCollection *, const char *);



/* ---------------------------------------------------------------------------------- */
/*                      DEFINITIONS PROPRES POUR LE SUPPORT YAML                      */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour une collection de noeuds YAML. */
G_DEFINE_TYPE(GYamlCollection, g_yaml_collection, G_TYPE_YAML_NODE);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des collections de noeuds YAML.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_yaml_collection_class_init(GYamlCollectionClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */
    GYamlNodeClass *node;                   /* Version parente de classe   */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_yaml_collection_dispose;
    object->finalize = (GObjectFinalizeFunc)g_yaml_collection_finalize;

    node = G_YAML_NODE_CLASS(klass);

    node->find = (find_first_yaml_node_fc)g_yaml_collection_find_first_by_path;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une instance de collection de noeuds YAML.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_yaml_collection_init(GYamlCollection *collec)
{
    collec->is_seq = false;

    collec->nodes = NULL;
    collec->count = 0;

}


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

static void g_yaml_collection_dispose(GYamlCollection *collec)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < collec->count; i++)
        g_clear_object(&collec->nodes[i]);

    G_OBJECT_CLASS(g_yaml_collection_parent_class)->dispose(G_OBJECT(collec));

}


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

static void g_yaml_collection_finalize(GYamlCollection *collec)
{
    if (collec->nodes != NULL)
        free(collec->nodes);

    G_OBJECT_CLASS(g_yaml_collection_parent_class)->finalize(G_OBJECT(collec));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : seq = indique la nature de la future collection.             *
*                                                                             *
*  Description : Construit une collection de noeuds YAML.                     *
*                                                                             *
*  Retour      : Instance mise en place ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlCollection *g_yaml_collection_new(bool seq)
{
    GYamlCollection *result;                /* Structure à retourner       */

    result = g_object_new(G_TYPE_YAML_COLLEC, NULL);

    if (!g_yaml_collection_create(result, seq))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = noeud d'arborescence YAML à initialiser pleinement. *
*                seq    = indique la nature de la future collection.          *
*                                                                             *
*  Description : Met en place une collection de noeuds YAML.                  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_yaml_collection_create(GYamlCollection *collec, bool seq)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    collec->is_seq = seq;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = noeud d'arborescence YAML à consulter.              *
*                                                                             *
*  Description : Indique la nature d'une collection YAML.                     *
*                                                                             *
*  Retour      : Nature de la collection.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_yaml_collection_is_sequence(const GYamlCollection *collec)
{
    bool result;                            /* Statut à retourner          */

    result = collec->is_seq;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = collection de noeuds YAML à compléter.              *
*                node   = noeud à rattacher.                                  *
*                                                                             *
*  Description : Ajoute un noeud à une collection de noeuds YAML.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_yaml_collection_add_node(GYamlCollection *collec, GYamlNode *node)
{
    collec->nodes = realloc(collec->nodes, ++collec->count * sizeof(GYamlNode *));

    collec->nodes[collec->count - 1] = node;
    g_object_ref_sink(G_OBJECT(node));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = noeud d'arborescence YAML à consulter.              *
*                count  = taille de la liste constituée. [OUT]                *
*                                                                             *
*  Description : Fournit la liste des noeuds intégrés dans une collection.    *
*                                                                             *
*  Retour      : Enfants d'un noeud issu d'une collection YAML.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlNode **g_yaml_collection_get_nodes(const GYamlCollection *collec, size_t *count)
{
    GYamlNode **result;                     /* Liste à retourner           */
    size_t i;                               /* Boucle de parcours          */

    *count = collec->count;

    result = malloc(*count * sizeof(GYamlNode *));

    for (i = 0; i < *count; i++)
    {
        result[i] = collec->nodes[i];
        g_object_ref(G_OBJECT(result[i]));
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = noeud d'arborescence YAML à consulter.              *
*                                                                             *
*  Description : Fournit le premier noeud intégré dans une collection.        *
*                                                                             *
*  Retour      : Noeud issu d'une collection YAML.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlNode *g_yaml_collection_get_first_node(const GYamlCollection *collec)
{
    GYamlNode *result;                      /* Elément à retourner         */

    if (collec->count == 0)
        result = NULL;

    else
    {
        result = collec->nodes[0];
        g_object_ref(G_OBJECT(result));
    }

    return result;

}



/* ---------------------------------------------------------------------------------- */
/*                       IMPLEMENTATION DES FONCTIONS DE CLASSE                       */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = noeud d'arborescence YAML à consulter.              *
*                path   = chemin d'accès à parcourir.                         *
*                                                                             *
*  Description : Recherche le premier noeud correspondant à un chemin.        *
*                                                                             *
*  Retour      : Noeud avec la correspondance établie ou NULL si non trouvé.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GYamlNode *g_yaml_collection_find_first_by_path(GYamlCollection *collec, const char *path)
{
    GYamlNode *result;                      /* Trouvaille à retourner      */
    size_t i;                               /* Boucle de parcours          */

    result = NULL;

    for (i = 0; i < collec->count && result == NULL; i++)
        result = g_yaml_node_find_first_by_path(collec->nodes[i], path);

    return result;

}