summaryrefslogtreecommitdiff
path: root/plugins/yaml/parser.c
blob: 8c0672396840700b012d664ff75753174d7541c0 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * parser.c - lecteur de contenu Yaml
 *
 * Copyright (C) 2019-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 "parser.h"


#include <assert.h>
#include <malloc.h>
#include <yaml.h>
#include <gio/gio.h>


#include <analysis/contents/file.h>


#include "collection.h"
#include "pair.h"


#define SCALAR_STYLE_TO_ORIGINAL_STYLE(v)               \
    ({                                                  \
        YamlOriginalStyle __result;                     \
        if (v == YAML_SINGLE_QUOTED_SCALAR_STYLE)       \
            __result = YOS_SINGLE_QUOTED;               \
        else if (v == YAML_DOUBLE_QUOTED_SCALAR_STYLE)  \
            __result = YOS_DOUBLE_QUOTED;               \
        else                                            \
            __result = YOS_PLAIN;                       \
        __result;                                       \
    })


/* Construit la version GLib d'un noeud YAML brut. */
static GYamlPair *build_pair_from_yaml(yaml_document_t *, int, int);

/* Transforme un noeud YAML brut en sa version Glib. */
static GYamlNode *translate_yaml_node(yaml_document_t *, yaml_node_t *);



/******************************************************************************
*                                                                             *
*  Paramètres  : document = gestionnaire de l'ensemble des noeuds bruts.      *
*                key      = indice de la clef du noeud à convertir.           *
*                value    = indice de la valeur du noeud à convertir.         *
*                                                                             *
*  Description : Construit la version GLib d'un noeud YAML brut.              *
*                                                                             *
*  Retour      : Noeud GLib obtenu ou NULL en cas d'échec.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GYamlPair *build_pair_from_yaml(yaml_document_t *document, int key, int value)
{
    GYamlPair *result;                      /* Racine à retourner          */
    yaml_node_t *key_node;                  /* Noeud brut de la clef       */
    yaml_node_t *value_node;                /* Noeud brut de la valeur     */
    GYamlNode *children;                    /* Collection de noeuds YAML   */

    result = NULL;

    key_node = yaml_document_get_node(document, key);
    assert(key_node != NULL);

    if (key_node->type != YAML_SCALAR_NODE)
        goto exit;

    value_node = yaml_document_get_node(document, value);
    assert(value_node != NULL);

    if (value_node->type == YAML_SCALAR_NODE)
        result = g_yaml_pair_new((char *)key_node->data.scalar.value,
                                 SCALAR_STYLE_TO_ORIGINAL_STYLE(key_node->data.scalar.style),
                                 (char *)value_node->data.scalar.value,
                                 SCALAR_STYLE_TO_ORIGINAL_STYLE(value_node->data.scalar.style));

    else
    {
        children = translate_yaml_node(document, value_node);

        if (children != NULL)
        {
            result = g_yaml_pair_new((char *)key_node->data.scalar.value,
                                     SCALAR_STYLE_TO_ORIGINAL_STYLE(key_node->data.scalar.style),
                                     NULL, YOS_PLAIN);

            g_yaml_pair_set_children(result, G_YAML_COLLEC(children));

        }

    }

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : document = gestionnaire de l'ensemble des noeuds bruts.      *
*                node     = point de départ des transformations.              *
*                                                                             *
*  Description : Transforme un noeud YAML brut en sa version Glib.            *
*                                                                             *
*  Retour      : Noeud GLib obtenu ou NULL en cas d'échec.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GYamlNode *translate_yaml_node(yaml_document_t *document, yaml_node_t *node)
{
    GYamlNode *result;                      /* Racine à retourner          */
    yaml_node_item_t *index;                /* Elément d'une série         */
    yaml_node_t *item;                      /* Elément d'une série         */
    GYamlNode *child;                       /* Version GLib de l'élément   */
    yaml_node_pair_t *pair;                 /* Combinaison clef/valeur     */
    GYamlPair *sub;                         /* Sous-noeud à intégrer       */

    switch (node->type)
    {
        case YAML_SCALAR_NODE:
            result = G_YAML_NODE(g_yaml_pair_new((char *)node->data.scalar.value,
                                                 SCALAR_STYLE_TO_ORIGINAL_STYLE(node->data.scalar.style),
                                                 NULL, YOS_PLAIN));
            break;

        case YAML_SEQUENCE_NODE:

            result = G_YAML_NODE(g_yaml_collection_new(true));

            for (index = node->data.sequence.items.start; index < node->data.sequence.items.top; index++)
            {
                item = yaml_document_get_node(document, *index);
                assert(item != NULL);

                child = translate_yaml_node(document, item);

                if (child == NULL)
                {
                    g_clear_object(&result);
                    break;
                }

                g_yaml_collection_add_node(G_YAML_COLLEC(result), child);

            }

            break;

        case YAML_MAPPING_NODE:

            result = G_YAML_NODE(g_yaml_collection_new(false));

            for (pair = node->data.mapping.pairs.start; pair < node->data.mapping.pairs.top; pair++)
            {
                sub = build_pair_from_yaml(document, pair->key, pair->value);

                if (sub == NULL)
                {
                    g_clear_object(&result);
                    break;
                }

                g_yaml_collection_add_node(G_YAML_COLLEC(result), G_YAML_NODE(sub));

            }

            break;

        default:
            assert(false);
            result = NULL;
            break;

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : text = définitions textuelles d'un contenu brut.             *
*                len  = taille de ces définitions.                            *
*                                                                             *
*  Description : Crée une arborescence YAML pour contenu au format adapté.    *
*                                                                             *
*  Retour      : Arborescence YAML mise en place ou NULL en cas d'échec.      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlNode *parse_yaml_from_text(const char *text, size_t len)
{
    GYamlNode *result;                      /* Racine à retourner          */
    yaml_parser_t parser;                   /* Lecteur du contenu fourni   */
    yaml_document_t document;               /* Document YAML constitué     */
    int ret;                                /* Bilan de la constitution    */
    yaml_node_t *root;                      /* Elément racine brut         */

    result = NULL;

    yaml_parser_initialize(&parser);

    yaml_parser_set_input_string(&parser, (const unsigned char *)text, len);

    ret = yaml_parser_load(&parser, &document);
    if (ret != 1) goto bad_loading;

    root = yaml_document_get_root_node(&document);

    if (root != NULL)
        result = translate_yaml_node(&document, root);

    yaml_document_delete(&document);

 bad_loading:

    yaml_parser_delete(&parser);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : filename = chemin vers des définitions de règles.            *
*                                                                             *
*  Description : Crée une arborescence YAML pour fichier au format adapté.    *
*                                                                             *
*  Retour      : Arborescence YAML mise en place ou NULL en cas d'échec.      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GYamlNode *parse_yaml_from_file(const char *filename)
{
    GYamlNode *result;                      /* Racine à retourner          */
    GBinContent *content;                   /* Fichier à parcourir         */
    phys_t size;                            /* Taille du contenu associé   */
    vmpa2t start;                           /* Tête de lecture             */
    const bin_t *data;                      /* Données à consulter         */
    char *dumped;                           /* Contenu manipulable         */

    result = NULL;

    content = g_file_content_new(filename);
    if (content == NULL) goto no_content;

    size = g_binary_content_compute_size(content);

    g_binary_content_compute_start_pos(content, &start);
    data = g_binary_content_get_raw_access(content, &start, size);

    dumped = malloc((size + 1) * sizeof(char));

    memcpy(dumped, data, size);
    dumped[size] = '\0';

    result = parse_yaml_from_text(dumped, size);

    free(dumped);

    g_object_unref(G_OBJECT(content));

 no_content:

    return result;

}