summaryrefslogtreecommitdiff
path: root/plugins/yaml/pair.c
blob: 4faba8830478d446fd6501da339c854ca50fae64 (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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549

/* Chrysalide - Outil d'analyse de fichiers binaires
 * pair.c - noeud YAML de paire clef/valeur
 *
 * Copyright (C) 2020-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 "pair.h"


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


#include <common/extstr.h>


#include "pair-int.h"



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


/* Initialise la classe des noeuds d'arborescence YAML. */
static void g_yaml_pair_class_init(GYamlPairClass *);

/* Initialise une instance de noeud d'arborescence YAML. */
static void g_yaml_pair_init(GYamlPair *);

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

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



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


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



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


/* Indique le type défini pour un noeud d'arborescence YAML. */
G_DEFINE_TYPE(GYamlPair, g_yaml_pair, G_TYPE_YAML_NODE);


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

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

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_yaml_pair_dispose;
    object->finalize = (GObjectFinalizeFunc)g_yaml_pair_finalize;

    node = G_YAML_NODE_CLASS(klass);

    node->find = (find_first_yaml_node_fc)g_yaml_pair_find_first_by_path;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = instance à initialiser.                               *
*                                                                             *
*  Description : Initialise une instance de noeud d'arborescence YAML.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_yaml_pair_init(GYamlPair *pair)
{
    pair->key = NULL;
    pair->key_style = YOS_PLAIN;

    pair->value = NULL;
    pair->value_style = YOS_PLAIN;

    pair->children = NULL;

}


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

static void g_yaml_pair_dispose(GYamlPair *pair)
{
    g_clear_object(&pair->children);

    G_OBJECT_CLASS(g_yaml_pair_parent_class)->dispose(G_OBJECT(pair));

}


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

static void g_yaml_pair_finalize(GYamlPair *pair)
{
    if (pair->key != NULL)
        free(pair->key);

    if (pair->value != NULL)
        free(pair->value);

    G_OBJECT_CLASS(g_yaml_pair_parent_class)->finalize(G_OBJECT(pair));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : key    = désignation pour le noeud YAML.                     *
*                kstyle = format d'origine de la clef.                        *
*                value  = éventuelle valeur directe portée par le noeud.      *
*                vstyle = éventuel format d'origine de l'éventuelle valeur.   *
*                                                                             *
*  Description : Construit un noeud d'arborescence YAML.                      *
*                                                                             *
*  Retour      : Instance mise en place ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlPair *g_yaml_pair_new(const char *key, YamlOriginalStyle kstyle, const char *value, YamlOriginalStyle vstyle)
{
    GYamlPair *result;                      /* Structure à retourner       */

    result = g_object_new(G_TYPE_YAML_PAIR, NULL);

    if (!g_yaml_pair_create(result, key, kstyle, value, vstyle))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair   = paire YAML à initialiser pleinement.                *
*                key    = désignation pour le noeud YAML.                     *
*                kstyle = format d'origine de la clef.                        *
*                value  = éventuelle valeur directe portée par le noeud.      *
*                vstyle = éventuel format d'origine de l'éventuelle valeur.   *
*                                                                             *
*  Description : Met en place une pair clef/valeur YAML.                      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_yaml_pair_create(GYamlPair *pair, const char *key, YamlOriginalStyle kstyle, const char *value, YamlOriginalStyle vstyle)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    pair->key = strdup(key);
    pair->key_style = kstyle;

    if (value != NULL)
    {
        pair->value = strdup(value);
        pair->value_style = vstyle;
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Fournit la clef représentée dans une paire en YAML.          *
*                                                                             *
*  Retour      : Clef sous forme de chaîne de caractères.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_yaml_pair_get_key(const GYamlPair *pair)
{
    char *result;                           /* Valeur à retourner          */

    result = pair->key;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Indique le format d'origine YAML associé à la clef.          *
*                                                                             *
*  Retour      : Valeur renseignée lors du chargement du noeud.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

YamlOriginalStyle g_yaml_pair_get_key_style(const GYamlPair *pair)
{
    YamlOriginalStyle result;               /* Indication à retourner      */

    result = pair->key_style;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Fournit l'éventuelle valeur d'une paire en YAML.             *
*                                                                             *
*  Retour      : Valeur sous forme de chaîne de caractères ou NULL.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_yaml_pair_get_value(const GYamlPair *pair)
{
    char *result;                           /* Valeur à retourner          */

    result = pair->value;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Indique le format d'origine YAML associé à la valeur.        *
*                                                                             *
*  Retour      : Valeur renseignée lors du chargement du noeud.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

YamlOriginalStyle g_yaml_pair_get_value_style(const GYamlPair *pair)
{
    YamlOriginalStyle result;               /* Indication à retourner      */

    result = pair->value_style;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Rassemble une éventuelle séquence de valeurs attachées.      *
*                                                                             *
*  Retour      : Valeur sous forme de chaîne de caractères ou NULL.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

char *g_yaml_pair_aggregate_value(const GYamlPair *pair)
{
    char *result;                           /* Valeur à retourner          */
    GYamlNode **nodes;                      /* Eventuels noeuds trouvés    */
    size_t count;                           /* Quantité de ces noeuds      */
    size_t i;                               /* Boucle de parcours          */
    GYamlPair *child;                       /* Couple clef/valeur enfant   */
    bool failed;                            /* Détection d'un échec        */

    result = NULL;

    if (pair->value != NULL)
        result = strdup(pair->value);

    else if (pair->children != NULL)
    {
        if (!g_yaml_collection_is_sequence(pair->children))
            goto exit;

        nodes = g_yaml_collection_get_nodes(pair->children, &count);

        if (count == 0)
            result = strdup("[ ]");

        else
        {
            result = strdup("[ ");

            for (i = 0; i < count; i++)
            {
                if (!G_IS_YAML_PAIR(nodes[i]))
                    break;

                child = G_YAML_PAIR(nodes[i]);

                if (child->value != NULL)
                    break;

                if (i > 0)
                    result = stradd(result, ", ");

                switch (child->key_style)
                {
                    case YOS_PLAIN:
                        result = stradd(result, child->key);
                        break;

                    case YOS_SINGLE_QUOTED:
                        result = straddfmt(result, "'%s'", child->key);
                        break;

                    case YOS_DOUBLE_QUOTED:
                        result = straddfmt(result, "\"%s\"", child->key);
                        break;

                }

                g_object_unref(G_OBJECT(nodes[i]));

            }

            failed = (i < count);

            for (; i < count; i++)
                g_object_unref(G_OBJECT(nodes[i]));

            free(nodes);

            if (failed)
            {
                free(result);
                result = NULL;
            }

            else
                result = stradd(result, " ]");

        }

    }

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair     = noeud d'arborescence YAML à compléter.            *
*                children = collection de noeuds YAML.                        *
*                                                                             *
*  Description : Attache une collection de noeuds YAML à un noeud.            *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_yaml_pair_set_children(GYamlPair *pair, GYamlCollection *children)
{
    g_clear_object(&pair->children);

    g_object_ref_sink(G_OBJECT(children));
    pair->children = children;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = noeud d'arborescence YAML à consulter.                *
*                                                                             *
*  Description : Fournit une éventuelle collection rattachée à un noeud.      *
*                                                                             *
*  Retour      : Collection de noeuds YAML ou NULL.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlCollection *g_yaml_pair_get_children(const GYamlPair *pair)
{
    GYamlCollection *result;                /* Collection à renvoyer       */

    result = pair->children;

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

    return result;

}



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


/******************************************************************************
*                                                                             *
*  Paramètres  : pair = 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_pair_find_first_by_path(GYamlPair *pair, const char *path)
{
    GYamlNode *result;                      /* Trouvaille à retourner      */
    char *next;                             /* Prochaine partie du chemin  */
    size_t cmplen;                          /* Etendue de la comparaison   */
    int ret;                                /* Bilan d'une comparaison     */

    assert(path[0] != '/' && path[0] != '\0');

    /* Correspondance au niveau du noeud ? */

    next = strchr(path, '/');

    if (next == NULL)
        ret = strcmp(path, pair->key);

    else
    {
        cmplen = next - path;
        assert(cmplen > 0);

        ret = strncmp(path, pair->key, cmplen);

    }

    /* Si correspondance il y a... */

    if (ret == 0)
    {
        /* ...  et que la recherche se trouve en bout de parcours */
        if (next == NULL)
        {
            result = G_YAML_NODE(pair);
            g_object_ref(G_OBJECT(result));
        }

        /* Recherche supplémentaire dans les sous-noeuds ? */

        else if (pair->children != NULL)
            result = g_yaml_node_find_first_by_path(G_YAML_NODE(pair->children), path + cmplen);

        else
            result = NULL;

    }

    else
        result = NULL;

    return result;

}