summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/types/array.c
blob: 9c3a1ea2e18cbd366a3df5391128e2c8b80be7ce (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * array.c - équivalent Python du fichier "analysis/types/array.c"
 *
 * 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "array.h"


#include <pygobject.h>
#include <string.h>


#include <i18n.h>
#include <analysis/types/array.h>


#include "../type.h"
#include "../../access.h"
#include "../../helpers.h"



/* Crée un nouvel objet Python de type 'ArrayType'. */
static PyObject *py_array_type_new(PyTypeObject *, PyObject *, PyObject *);

/* Fournit le type des membres du tableau. */
static PyObject *py_array_type_get_members_type(PyObject *, void *);

/* Indique si la dimension du tableau est chiffrée. */
static PyObject *py_array_type_is_numbered(PyObject *, void *);

/* Fournit la dimension associée au tableau. */
static PyObject *py_array_type_get_dimension(PyObject *, void *);

/* Fournit la dimension associée au tableau. */
static PyObject *py_array_type_get_dimension_number(PyObject *, void *);

/* Définit la dimension associée au tableau. */
static int py_array_type_set_dimension_number(PyObject *, PyObject *, void *);

/* Fournit la dimension associée au tableau. */
static PyObject *py_array_type_get_dimension_expression(PyObject *, void *);

/* Définit la dimension associée au tableau. */
static int py_array_type_set_dimension_expression(PyObject *, PyObject *, void *);



/******************************************************************************
*                                                                             *
*  Paramètres  : type = type de l'objet à instancier.                         *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Crée un nouvel objet Python de type 'ArrayType'.             *
*                                                                             *
*  Retour      : Instance Python mise en place.                               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Instance à retourner        */
    GDataType *members;                     /* Version GLib du type        */
    int ret;                                /* Bilan de lecture des args.  */
    GDataType *dtype;                       /* Version GLib du type        */

    ret = PyArg_ParseTuple(args, "O&", convert_to_data_type, &members);
    if (!ret) return NULL;

    dtype = g_array_type_new(members);
    result = pygobject_new(G_OBJECT(dtype));
    g_object_unref(dtype);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le type des membres du tableau.                      *
*                                                                             *
*  Retour      : Instance d'un autre type.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_get_members_type(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArrayType *type;                       /* Version GLib du type        */
    GDataType *members;                     /* Type des membres du tableau */

    type = G_ARRAY_TYPE(pygobject_get(self));

    members = g_array_type_get_members_type(type);

    result = pygobject_new(G_OBJECT(members));

    g_object_unref(members);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si la dimension du tableau est chiffrée.             *
*                                                                             *
*  Retour      : Py_True si la dimension est chiffrée.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_is_numbered(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArrayType *type;                       /* Version GLib du type        */
    bool status;                            /* Nature de la dimension liée */

    type = G_ARRAY_TYPE(pygobject_get(self));

    status = g_array_type_is_dimension_numbered(type);

    result = status ? Py_True : Py_False;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la dimension associée au tableau.                    *
*                                                                             *
*  Retour      : Dimension de nature variable.                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_get_dimension(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArrayType *type;                       /* Version GLib du type        */
    bool status;                            /* Nature de la dimension liée */

    type = G_ARRAY_TYPE(pygobject_get(self));

    status = g_array_type_is_dimension_numbered(type);

    if (status)
        result = py_array_type_get_dimension_number(self, NULL);
    else
        result = py_array_type_get_dimension_expression(self, NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la dimension associée au tableau.                    *
*                                                                             *
*  Retour      : Dimension positive ou nulle.                                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_get_dimension_number(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArrayType *type;                       /* Version GLib du type        */
    ssize_t dim;                            /* Taille du tableau           */

    type = G_ARRAY_TYPE(pygobject_get(self));

    dim = g_array_type_get_dimension_number(type);

    result = PyLong_FromSsize_t(dim);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Définit la dimension associée au tableau.                    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_array_type_set_dimension_number(PyObject *self, PyObject *value, void *closure)
{
    GArrayType *type;                       /* Version GLib du type        */

    if (!PyLong_Check(value))
    {
        PyErr_SetString(PyExc_TypeError, _("The attribute value must be a number."));
        return -1;
    }

    type = G_ARRAY_TYPE(pygobject_get(self));

    g_array_type_set_dimension_number(type, PyLong_AsSsize_t(value));

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la dimension associée au tableau.                    *
*                                                                             *
*  Retour      : Expression de dimension.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_array_type_get_dimension_expression(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArrayType *type;                       /* Version GLib du type        */
    const char *dim;                        /* Taille du tableau           */

    type = G_ARRAY_TYPE(pygobject_get(self));

    dim = g_array_type_get_dimension_expression(type);

    if (dim != NULL)
        result = PyUnicode_FromString(dim);

    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Définit la dimension associée au tableau.                    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_array_type_set_dimension_expression(PyObject *self, PyObject *value, void *closure)
{
    GArrayType *type;                       /* Version GLib du type        */

    if (!PyUnicode_Check(value) && value != Py_None)
    {
        PyErr_SetString(PyExc_TypeError, _("The attribute value must be a string or None."));
        return -1;
    }

    type = G_ARRAY_TYPE(pygobject_get(self));

    if (value == Py_None)
        g_array_type_set_empty_dimension(type);

    else
        g_array_type_set_dimension_expression(type, strdup(PyUnicode_DATA(value)));

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_array_type_type(void)
{
    static PyMethodDef py_array_type_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_array_type_getseters[] = {
        {
            "members", py_array_type_get_members_type, NULL,
            "Provide the type of each members of the array.", NULL
        },
        {
            "numbered", py_array_type_is_numbered, NULL,
            "Tell if the dimension of the array is a number.", NULL
        },
        {
            "dimension", py_array_type_get_dimension, NULL,
            "Provide the array dimension.", NULL
        },
        {
            "dimension_number", py_array_type_get_dimension_number, py_array_type_set_dimension_number,
            "Give access to the array dimension as number.", NULL
        },
        {
            "dimension_expression", py_array_type_get_dimension_expression, py_array_type_set_dimension_expression,
            "Give access to the array dimension as expression.", NULL
        },
        { NULL }
    };

    static PyTypeObject py_array_type_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.types.ArrayType",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = "PyChrysalide array type",

        .tp_methods     = py_array_type_methods,
        .tp_getset      = py_array_type_getseters,
        .tp_new         = py_array_type_new

    };

    return &py_array_type_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : module = module dont la définition est à compléter.          *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.....types.ArrayType'.  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_array_type_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'ArrayType'     */
    PyObject *module;                       /* Module à recompléter        */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_array_type_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        module = get_access_to_python_module("pychrysalide.analysis.types");

        dict = PyModule_GetDict(module);

        if (!ensure_python_data_type_is_registered())
            return false;

        if (!register_class_for_pygobject(dict, G_TYPE_ARRAY_TYPE, type, get_python_data_type_type()))
            return false;

    }

    return true;

}