summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/constval.c
blob: ab5b81f2f72fa5d10ea60165ff8ae1e77a060741 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * constval.c - conversion de constantes C en équivalent Python
 *
 * 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 "constval.h"


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


#include <i18n.h>


#include "access.h"
#include "helpers.h"



/* Objet à vocation interne */
typedef struct _PyConstvalObject
{
    PyLongObject base;                      /* A laisser en premier        */

    /**
     * Le champ suivant est rajouté à la fin de l'allocation
     * de l'objet PyLongObject, dont la taille est dynamique.
     */

    /*char *name;*/                         /* Désignation de la valeur    */

} PyConstvalObject;



/* Interdit la création d'une instance depuis Python. */
static PyObject *py_constval_new(PyTypeObject *, PyObject *, PyObject *);

/* Libère la mémoire occupée par la description en sortie. */
static void py_constval_finalize(PyObject *);

/* Calcule l'emplacement reservé pour une désignation de valeur. */
static char **py_constval_compute_name_ptr(PyConstvalObject *);

/* Construit une représentation textuelle de l'objet. */
static PyObject *py_constval_str(PyObject *);

/* Fournit une réduction de l'objet en vue d'une sérialisation. */
static PyObject *py_constval_reduce(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : type = type du nouvel objet à mettre en place.               *
*                args = éventuelle liste d'arguments.                         *
*                kwds = éventuel dictionnaire de valeurs mises à disposition. *
*                                                                             *
*  Description : Interdit la création d'une instance depuis Python.           *
*                                                                             *
*  Retour      : NULL.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_constval_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Instance à retourner        */
    unsigned long value;                    /* Valeur entière              */
    const char *name;                       /* Désignation humaine         */
    int ret;                                /* Bilan de lecture des args.  */

    ret = PyArg_ParseTuple(args, "ks", &value, &name);
    if (!ret) return NULL;

    result = build_constval_from_c_code(name, value);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = valeur constante C convertie en Python.               *
*                                                                             *
*  Description : Libère la mémoire occupée par la description en sortie.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_constval_finalize(PyObject *self)
{
    PyConstvalObject *constval;             /* Autre version de l'objet    */
    char **ptr;                             /* Désignation à convertir     */

    constval = (PyConstvalObject *)self;

    ptr = py_constval_compute_name_ptr(constval);

    free(*ptr);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = valeur constante C convertie en Python.               *
*                                                                             *
*  Description : Calcule l'emplacement reservé pour une désignation de valeur.*
*                                                                             *
*  Retour      : Pointeur vers l'adresse de désignation.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static char **py_constval_compute_name_ptr(PyConstvalObject *self)
{
    digit *result;                          /* Adresse mémoire à retourner */
    Py_ssize_t size;                        /* Taille supplémentaire       */

    size = Py_SIZE(&self->base);

    if (size < 0)
        size = -size;

    result = &self->base.ob_digit[size];

    return (char **)result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = valeur constante C convertie en Python.               *
*                                                                             *
*  Description : Construit une représentation textuelle de l'objet.           *
*                                                                             *
*  Retour      : Chaîne de caractère Unicode.                                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_constval_str(PyObject *self)
{
    PyObject *result;                       /* Elément à retourner         */
    PyConstvalObject *constval;             /* Autre version de l'objet    */
    char **ptr;                             /* Désignation à convertir     */

    constval = (PyConstvalObject *)self;

    ptr = py_constval_compute_name_ptr(constval);

    result = PyUnicode_FromString(*ptr);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = architecture concernée par la procédure.              *
*                args = instruction représentant le point de départ.          *
*                                                                             *
*  Description : Fournit une réduction de l'objet en vue d'une sérialisation. *
*                                                                             *
*  Retour      : Données utiles à une reconstruction.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_constval_reduce(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Données à retourner         */
    unsigned long value;                    /* Valeur entière              */
    PyConstvalObject *constval;             /* Autre version de l'objet    */
    char **ptr;                             /* Désignation à convertir     */
    PyObject *params;                       /* Paramètres de construction  */

    value = PyLong_AsUnsignedLong(self);

    constval = (PyConstvalObject *)self;

    ptr = py_constval_compute_name_ptr(constval);

    params = Py_BuildValue("(ks)", value, *ptr);

    result = Py_BuildValue("(OO)", Py_TYPE(self), params);

    Py_DECREF(params);

    return result;

}


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

PyTypeObject *get_python_py_constval_type(void)
{
    static PyMethodDef py_constval_methods[] = {
        {
            "__reduce__", py_constval_reduce,
            METH_NOARGS,
            "__reduce__($self, /)\n--\n\nProvide information to rebuild the object."
        },
        { NULL }
    };

    static PyGetSetDef py_constval_getseters[] = {
        { NULL }
    };

    static PyTypeObject py_constval_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.PyConstvalObject",
        .tp_basicsize   = offsetof(PyLongObject, ob_digit),
        .tp_itemsize    = sizeof(digit),

        .tp_str         = py_constval_str,

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_FINALIZE,

        .tp_doc         = "PyChrysalide object for C constant values",

        .tp_methods     = py_constval_methods,
        .tp_getset      = py_constval_getseters,
        .tp_base        = &PyLong_Type,

        .tp_new         = py_constval_new,

        .tp_finalize    = py_constval_finalize,

    };

    return &py_constval_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.PyConstvalObject'.     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_py_constval_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'PyConstval...' */
    PyObject *module;                       /* Module à recompléter        */

    type = get_python_py_constval_type();

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

        if (PyType_Ready(type) != 0)
            return false;

        if (!register_python_module_object(module, type))
            return false;

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : name  = désignation de la constante à représenter.           *
*                value = valeur de la constante à représenter.                *
*                                                                             *
*  Description : Construit un objet pour valeur constante en C.               *
*                                                                             *
*  Retour      : Object Python résultant de la construction opérée.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyObject *build_constval_from_c_code(const char *name, unsigned long value)
{
    PyObject *result;                       /* Instance à retourner        */
    PyLongObject *tmp;                      /* Construction temporaire     */
    Py_ssize_t size;                        /* Taille supplémentaire       */
    PyTypeObject *type;                     /* Type Python 'PyConstval...' */
    PyConstvalObject *constval;             /* Autre version de l'objet    */
    char **ptr;                             /* Désignation à convertir     */

    /* Création d'une base de travail */

    tmp = (PyLongObject *)PyLong_FromUnsignedLong(value);

    size = Py_SIZE(tmp);

    if (size < 0)
        size = -size;

    /**
     * En allouant 2 éléments "digit" supplémentaires, on est assuré
     * de disposer de l'espace nécessaire pour la conservation
     * d'un pointeur.
     */

    result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) + (size + 2) * sizeof(digit));

    if (!result)
    {
        PyErr_NoMemory();
        return NULL;
    }

    type = get_python_py_constval_type();

    result = PyObject_INIT_VAR(result, type, size);

    /* Copie de la valeur */

    Py_SIZE(result) = Py_SIZE(tmp);

    constval = (PyConstvalObject *)result;

    while (--size >= 0)
        constval->base.ob_digit[size] = tmp->ob_digit[size];

    Py_DECREF(tmp);

    /* Copie de la désignation */

    ptr = py_constval_compute_name_ptr(constval);

    *ptr = strdup(name);

    return result;

}