summaryrefslogtreecommitdiff
path: root/plugins/kaitai/stream.c
blob: 66d0f8ebbd9bb62200dfe03930a7aff2272d30ca (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * stream.c - données associées à un flux de données Kaitai
 *
 * 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 "stream.h"


#include "stream-int.h"



/* Initialise la classe des flux de données pour Kaitai. */
static void g_kaitai_stream_class_init(GKaitaiStreamClass *);

/* Initialise un flux de données accessibles à Kaitai. */
static void g_kaitai_stream_init(GKaitaiStream *);

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

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



/* Indique le type défini pour un flux de données manipulé par une lecture Kaitai. */
G_DEFINE_TYPE(GKaitaiStream, g_kaitai_stream, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des flux de données pour Kaitai.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_kaitai_stream_class_init(GKaitaiStreamClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_kaitai_stream_dispose;
    object->finalize = (GObjectFinalizeFunc)g_kaitai_stream_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : stream = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise un flux de données accessibles à Kaitai.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_kaitai_stream_init(GKaitaiStream *stream)
{

}


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

static void g_kaitai_stream_dispose(GKaitaiStream *stream)
{
    G_OBJECT_CLASS(g_kaitai_stream_parent_class)->dispose(G_OBJECT(stream));

}


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

static void g_kaitai_stream_finalize(GKaitaiStream *stream)
{
    G_OBJECT_CLASS(g_kaitai_stream_parent_class)->finalize(G_OBJECT(stream));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : content = contenu binaire parcouru par une analyse Kaitai.   *
*                pos     = tête de lecture courante.                          *
*                                                                             *
*  Description : Rassemble les éléments constituant un flux de données Kaitai.*
*                                                                             *
*  Retour      : Instance mise en place ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GKaitaiStream *g_kaitai_stream_new(GBinContent *content, const vmpa2t *pos)
{
    GKaitaiStream *result;                  /* Structure à retourner       */

    result = g_object_new(G_TYPE_KAITAI_STREAM, NULL);

    if (!g_kaitai_stream_create(result, content, pos))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : attrib  = lecteur d'attribut Kaitai à initialiser pleinement.*
*                content = contenu binaire parcouru par une analyse Kaitai.   *
*                pos     = tête de lecture courante.                          *
*                                                                             *
*  Description : Met en place un flux de données pour Kaitai.                 *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_kaitai_stream_create(GKaitaiStream *stream, GBinContent *content, const vmpa2t *pos)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    stream->content = content;
    g_object_ref(G_OBJECT(content));

    copy_vmpa(&stream->pos, pos);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : stream  = flux de données Kaitai à consulter.                *
*                                                                             *
*  Description : Indique le contenu de données binaires lié au flux Kaitai.   *
*                                                                             *
*  Retour      : Contenu binaire associé au flux de données.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GBinContent *g_kaitai_stream_get_content(const GKaitaiStream *stream)
{
    GBinContent *result;                    /* Instance à renvoyer         */

    result = stream->content;

    g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : stream  = flux de données Kaitai à consulter.                *
*                                                                             *
*  Description : Détermine si la fin des données a été atteinte.              *
*                                                                             *
*  Retour      : true si la tête de lecture est en position finale, ou false. *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_kaitai_stream_has_reached_eof(const GKaitaiStream *stream)
{
    bool result;                            /* Bilan à retourner           */
    vmpa2t end;                             /* Position finale du flux     */
    int ret;                                /* Bilan d'une comparaison     */

    g_binary_content_compute_end_pos(stream->content, &end);

    ret = cmp_vmpa_by_phy(&stream->pos, &end);

    result = (ret == 0);

    return result;

}