summaryrefslogtreecommitdiff
path: root/src/common/ibuf.c
blob: 07c548717903622e0bbf17c8f9671d792cc3638e (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * ibuf.c - lecture progressive d'un tampon de données
 *
 * Copyright (C) 2018 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 "ibuf.h"


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



/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à initialiser. [OUT]                *
*                                                                             *
*  Description : Initialise un contenu textuel pour une lecture ultérieure.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void init_text_input_buffer(input_buffer *ibuf, const char *text)
{
    ibuf->text = text;

    ibuf->len = strlen(text);
    ibuf->pos = 0;

}

/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                                                                             *
*  Description : Fournit la taille totale du tampon constitué.                *
*                                                                             *
*  Retour      : Valeur positive (ou nulle !).                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

size_t get_input_buffer_size(const input_buffer *ibuf)
{
    size_t result;                          /* Quantité à retourner        */

    result = ibuf->len;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                                                                             *
*  Description : Compte le nombre d'octets encore non lus.                    *
*                                                                             *
*  Retour      : Nombre d'octets encore disponibles pour un traitement.       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

size_t count_input_buffer_remaining(const input_buffer *ibuf)
{
    size_t result;                          /* Quantité à renvoyer         */

    assert(ibuf->pos <= (ibuf->len + 1));

    if (ibuf->pos > ibuf->len)
        result = 0;

    else
        result = ibuf->len - ibuf->pos;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                                                                             *
*  Description : Détermine s'il reste encore des données disponibles.         *
*                                                                             *
*  Retour      : true si des données sont encore présentes, false sinon.      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool input_buffer_contain_data(const input_buffer *ibuf)
{
    bool result;                            /* Bilan à retourner           */
    size_t remaining;                       /* Quantité restante           */

    remaining = count_input_buffer_remaining(ibuf);

    result = (remaining > 0);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf  = tampon de données à modifier.                        *
*                count = progression de la tête de lecture à marquer.         *
*                                                                             *
*  Description : Avance la tête de lecture dans le tampon de données.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void advance_input_buffer(input_buffer *ibuf, size_t count)
{
    assert((ibuf->pos + count) <= (ibuf->len + 1));

    ibuf->pos += count;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                                                                             *
*  Description : Fournit un accès brut au niveau de la tête de lecture.       *
*                                                                             *
*  Retour      : Référence au texte brut courant.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *get_input_buffer_text_access(const input_buffer *ibuf)
{
    return ibuf->text + ibuf->pos;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                remaining = taille de la chaîne retournée. [OUT]             *
*                                                                             *
*  Description : Fournit la chaîne de caractère restant à traiter.            *
*                                                                             *
*  Retour      : Pointeur vers les données courantes.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *get_input_buffer_string(const input_buffer *ibuf, size_t *remaining)
{
    const char *result;                     /* Pointeur à retourner        */

    assert(ibuf->pos <= ibuf->len);

    result = ibuf->text + ibuf->pos;

    *remaining = ibuf->len - ibuf->pos;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à parcourir.                        *
*                                                                             *
*  Description : Fournit le caractère courant à la tête de lecture courante.  *
*                                                                             *
*  Retour      : Caractère courant.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

char peek_input_buffer_char(const input_buffer *ibuf)
{
    assert(ibuf->pos <= ibuf->len);

    return *(ibuf->text + ibuf->pos);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à parcourir.                        *
*                                                                             *
*  Description : Fournit le caractère suivant la tête de lecture courante.    *
*                                                                             *
*  Retour      : Caractère courant.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

char peek_input_buffer_next_char(const input_buffer *ibuf)
{
    char result;                            /* Valeur à retourner          */

    assert(ibuf->pos <= ibuf->len);

    if (ibuf->pos == ibuf->len)
        result = '\0';

    else
        result = *(ibuf->text + ibuf->pos + 1);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à parcourir.                        *
*                                                                             *
*  Description : Fournit et avance la tête de lecture courante.               *
*                                                                             *
*  Retour      : Caractère courant.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

char get_input_buffer_next_char(input_buffer *ibuf)
{
    char result;                            /* Valeur à retourner          */

    assert(ibuf->pos <= ibuf->len);

    result = *(ibuf->text + ibuf->pos);

    advance_input_buffer(ibuf, 1);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à parcourir.                        *
*                out  = caractère courant, s'il existe.                       *
*                                                                             *
*  Description : Fournit et avance la tête de lecture courante, si possible.  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool get_input_buffer_next_char_carefully(input_buffer *ibuf, char *out)
{
    char result;                            /* Valeur à retourner          */

    assert(ibuf->pos <= ibuf->len);

    result = input_buffer_contain_data(ibuf);

    if (result)
    {
        *out = *(ibuf->text + ibuf->pos);

        advance_input_buffer(ibuf, 1);

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à parcourir.                        *
*                c    = caractère à retrouver.                                *
*                                                                             *
*  Description : Vérifie la nature du caractère courant.                      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool check_input_buffer_char(input_buffer *ibuf, char c)
{
    bool result;                            /* Validation à retourner      */

    if (peek_input_buffer_char(ibuf) == c)
    {
        result = true;
        advance_input_buffer(ibuf, 1);
    }
    else
        result = false;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                pos  = sauvegarde de la tête de lecture. [OUT]               *
*                                                                             *
*  Description : Note la position courante de la tête de lecture.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void save_input_buffer_pos(const input_buffer *ibuf, size_t *pos)
{
    *pos = ibuf->pos;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : ibuf = tampon de données à consulter.                        *
*                pos  = tête de lecture à définir pour le tampon courant.     *
*                                                                             *
*  Description : Restaure la position de la tête de lecture.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void restore_input_buffer_pos(input_buffer *ibuf, size_t pos)
{
    assert(pos <= ibuf->len);

    ibuf->pos = pos;

}