summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/format/symbol.c
blob: 66e4dfc0fdb9a8bce36acab9a5cd77957a82845b (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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771

/* Chrysalide - Outil d'analyse de fichiers binaires
 * symbol.c - équivalent Python du fichier "format/symbol.h"
 *
 * Copyright (C) 2015-2017 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 "symbol.h"


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


#include <i18n.h>


#include <format/symbol-int.h>
#include <plugins/dt.h>


#include "constants.h"
#include "../access.h"
#include "../helpers.h"
#include "../analysis/routine.h"
#include "../analysis/db/items/comment.h"
#include "../arch/instruction.h"
#include "../arch/vmpa.h"
#include "../glibext/linegen.h"



/* ------------------------ GLUE POUR CREATION DEPUIS PYTHON ------------------------ */


/* Accompagne la création d'une instance dérivée en Python. */
static PyObject *py_binary_symbol_new(PyTypeObject *, PyObject *, PyObject *);

/* Initialise la classe des symboles d'exécutables. */
static void py_binary_symbol_init_gclass(GBinSymbolClass *, gpointer);

/* Fournit une étiquette pour viser un symbole. */
static char *g_binary_symbol_get_label_wrapper(const GBinSymbol *);

/* Initialise une instance sur la base du dérivé de GObject. */
static int py_binary_symbol_init(PyObject *, PyObject *, PyObject *);



/* --------------------- FONCTIONNALITES BASIQUES POUR SYMBOLES --------------------- */


/* Effectue une comparaison avec un objet Python 'BinSymbol'. */
static PyObject *py_binary_symbol_richcompare(PyObject *, PyObject *, int);

/* Fournit l'emplacement où se situe un symbole. */
static PyObject *py_binary_symbol_get_range(PyObject *, void *);

/* Définit la couverture physique / en mémoire d'un symbole. */
static int py_binary_symbol_set_range(PyObject *, PyObject *, void *);

/* Fournit le type du symbole. */
static PyObject *py_binary_symbol_get_stype(PyObject *, void *);

/* Définit le type du symbole. */
static int py_binary_symbol_set_stype(PyObject *, PyObject *, void *);

/* Fournit un étiquette pour viser un symbole. */
static PyObject *py_binary_symbol_get_label(PyObject *, void *);

/* Fournit la visibilité du symbole. */
static PyObject *py_binary_symbol_get_status(PyObject *, void *);

/* Définit la visibilité du symbole. */
static int py_binary_symbol_set_status(PyObject *, PyObject *, void *);

/* Définit un autre nom pour le symbole. */
static int py_binary_symbol_set_label(PyObject *, PyObject *, void *);



/* ---------------------------------------------------------------------------------- */
/*                          GLUE POUR CREATION DEPUIS PYTHON                          */
/* ---------------------------------------------------------------------------------- */


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

static PyObject *py_binary_symbol_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Objet à retourner           */
    PyTypeObject *base;                     /* Type de base à dériver      */
    bool first_time;                        /* Evite les multiples passages*/
    GType gtype;                            /* Nouveau type de processeur  */
    bool status;                            /* Bilan d'un enregistrement   */

    /* Validations diverses */

    base = get_python_binary_symbol_type();

    if (type == base)
        goto simple_way;

    /* Mise en place d'un type dédié */

    first_time = (g_type_from_name(type->tp_name) == 0);

    gtype = build_dynamic_type(G_TYPE_BIN_SYMBOL, type->tp_name,
                               (GClassInitFunc)py_binary_symbol_init_gclass, NULL, NULL);

    if (first_time)
    {
        status = register_class_for_dynamic_pygobject(gtype, type, base);

        if (!status)
        {
            result = NULL;
            goto exit;
        }

    }

    /* On crée, et on laisse ensuite la main à PyGObject_Type.tp_init() */

 simple_way:

    result = PyType_GenericNew(type, args, kwds);

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : class  = classe à initialiser.                               *
*                unused = données non utilisées ici.                          *
*                                                                             *
*  Description : Initialise la classe des symboles d'exécutables.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_binary_symbol_init_gclass(GBinSymbolClass *class, gpointer unused)
{
    class->get_label = g_binary_symbol_get_label_wrapper;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : symbol = symbole à venir consulter.                          *
*                                                                             *
*  Description : Fournit une étiquette pour viser un symbole.                 *
*                                                                             *
*  Retour      : Chaîne de caractères renvoyant au symbole.                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static char *g_binary_symbol_get_label_wrapper(const GBinSymbol *symbol)
{
    char *result;                           /* Etiquette à retourner       */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

    result = NULL;

    pyobj = pygobject_new(G_OBJECT(symbol));

    if (has_python_method(pyobj, "_get_label"))
    {
        pyret = run_python_method(pyobj, "_get_label", NULL);
        if (pyret == NULL) goto exit;

        if (PyUnicode_Check(pyret))
            result = strdup(PyUnicode_DATA(pyret));

        Py_DECREF(pyret);

    }

 exit:

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet à initialiser (théoriquement).                  *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Initialise une instance sur la base du dérivé de GObject.    *
*                                                                             *
*  Retour      : 0.                                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_binary_symbol_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    mrange_t range;                         /* Version native d'un espace  */
    unsigned long stype;                    /* Type prévu pour le  symbole */
    int ret;                                /* Bilan de lecture des args.  */
    GBinSymbol *symbol;                     /* Version GLib du symble      */

#define BINARY_SYMBOL_DOC                                                       \
    "BinSymbol represents all kinds of symbols, such as strings, routines or"   \
    " objects. If something can be linked to a physical or virtual location,"   \
    " it can be a symbol."                                                      \
    "\n"                                                                        \
    "Instances can be created using the following constructor:\n"               \
    "\n"                                                                        \
    "    BinSymbol(range, stype)"                                               \
    "\n"                                                                        \
    "Where range is a memory space defined by pychrysalide.arch.mrange and"     \
    " stype a pychrysalide.format.BinSymbol.SymbolType value."                  \
    "\n"                                                                        \
    "The following special method can be overridden:\n"                         \
    "* _get_label(self): provides a default label for the symbol."

    /* Récupération des paramètres */

    ret = PyArg_ParseTuple(args, "O&k", convert_any_to_mrange, &range, &stype);
    if (!ret) return -1;

    if (stype >= STP_COUNT)
    {
        PyErr_SetString(PyExc_ValueError, _("Invalid type of symbol."));
        return -1;
    }

    /* Initialisation d'un objet GLib */

    ret = forward_pygobjet_init(self);
    if (ret == -1) return -1;

    /* Eléments de base */

    symbol = G_BIN_SYMBOL(pygobject_get(self));

    g_binary_symbol_set_range(symbol, &range);
    g_binary_symbol_set_stype(symbol, stype);

    return 0;

}


/* ---------------------------------------------------------------------------------- */
/*                       FONCTIONNALITES BASIQUES POUR SYMBOLES                       */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : a  = premier object Python à consulter.                      *
*                b  = second object Python à consulter.                       *
*                op = type de comparaison menée.                              *
*                                                                             *
*  Description : Effectue une comparaison avec un objet Python 'BinSymbol'.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_binary_symbol_richcompare(PyObject *a, PyObject *b, int op)
{
    PyObject *result;                       /* Bilan à retourner           */
    int ret;                                /* Bilan de lecture des args.  */
    const GBinSymbol *sym_a;                /* Premier élément à traiter   */
    const GBinSymbol *sym_b;                /* Second élément à traiter    */
    int status;                             /* Résultat d'une comparaison  */

    ret = PyObject_IsInstance(b, (PyObject *)get_python_binary_symbol_type());
    if (!ret)
    {
        result = Py_NotImplemented;
        goto cmp_done;
    }

    sym_a = G_BIN_SYMBOL(pygobject_get(a));
    sym_b = G_BIN_SYMBOL(pygobject_get(b));

    status = g_binary_symbol_cmp(&sym_a, &sym_b);

    result = status_to_rich_cmp_state(status, op);

 cmp_done:

    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit l'emplacement où se situe un symbole.                *
*                                                                             *
*  Retour      : Zone mémoire couverte par le symbole.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_binary_symbol_get_range(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBinSymbol *symbol;                     /* Elément à consulter         */
    const mrange_t *range;                  /* Couverture courante         */

#define BINARY_SYMBOL_RANGE_ATTRIB PYTHON_GETSET_DEF_FULL   \
(                                                           \
    range, py_binary_symbol,                                \
    "Memory range covered by the symbol."                   \
)

    symbol = G_BIN_SYMBOL(pygobject_get(self));
    range = g_binary_symbol_get_range(symbol);

    result = build_from_internal_mrange(range);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Définit la couverture physique / en mémoire d'un symbole.    *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_binary_symbol_set_range(PyObject *self, PyObject *value, void *closure)
{
    int ret;                                /* Bilan d'analyse             */
    mrange_t *range;                        /* Espace mémoire à manipuler  */
    GBinSymbol *symbol;                     /* Elément à consulter         */

    ret = PyObject_IsInstance(value, (PyObject *)get_python_mrange_type());
    if (!ret) return -1;

    range = get_internal_mrange(value);

    symbol = G_BIN_SYMBOL(pygobject_get(self));

    g_binary_symbol_set_range(symbol, range);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le type du symbole.                                  *
*                                                                             *
*  Retour      : Type de symbole représenté.                                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_binary_symbol_get_stype(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBinSymbol *symbol;                     /* Elément à consulter         */
    SymbolType type;                        /* Type de symbole représenté  */

#define BINARY_SYMBOL_STYPE_ATTRIB PYTHON_GETSET_DEF_FULL   \
(                                                           \
    stype, py_binary_symbol,                                \
    "Type of the current symbol, as a value of type"        \
    " pychrysalide.format.BinSymbol.SymbolType."            \
)

    symbol = G_BIN_SYMBOL(pygobject_get(self));
    type = g_binary_symbol_get_stype(symbol);

    result = cast_with_constants_group_from_type(get_python_binary_symbol_type(), "SymbolType", type);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Définit le type du symbole.                                  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_binary_symbol_set_stype(PyObject *self, PyObject *value, void *closure)
{
    GBinSymbol *symbol;                     /* Elément à consulter         */
    SymbolType type;                        /* Type de symbole à définir   */

    if (!PyLong_Check(value))
        return -1;

    symbol = G_BIN_SYMBOL(pygobject_get(self));

    type = PyLong_AsUnsignedLong(value);

    g_binary_symbol_set_stype(symbol, type);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la visibilité du symbole.                            *
*                                                                             *
*  Retour      : Etat de la visibilité du symbole représenté.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_binary_symbol_get_status(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBinSymbol *symbol;                     /* Elément à consulter         */
    SymbolStatus status;                    /* Visibilité du symbole fourni*/

#define BINARY_SYMBOL_STATUS_ATTRIB PYTHON_GETSET_DEF_FULL      \
(                                                               \
    status, py_binary_symbol,                                   \
    "Status of the symbol's visibility, as a value of type"     \
    " pychrysalide.format.BinSymbol.SymbolStatus."              \
)

    symbol = G_BIN_SYMBOL(pygobject_get(self));
    status = g_binary_symbol_get_status(symbol);

    result = cast_with_constants_group_from_type(get_python_binary_symbol_type(), "SymbolStatus", status);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Définit la visibilité du symbole.                            *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_binary_symbol_set_status(PyObject *self, PyObject *value, void *closure)
{
    GBinSymbol *symbol;                     /* Elément à consulter         */
    SymbolStatus status;                    /* Visibilité à définir        */

    if (!PyLong_Check(value))
        return -1;

    symbol = G_BIN_SYMBOL(pygobject_get(self));

    status = PyLong_AsUnsignedLong(value);

    g_binary_symbol_set_status(symbol, status);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit un étiquette pour viser un symbole.                  *
*                                                                             *
*  Retour      : Chaîne de caractères renvoyant au symbole.                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_binary_symbol_get_label(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBinSymbol *symbol;                     /* Elément à consulter         */
    char *label;                            /* Désignation courante        */

#define BINARY_SYMBOL_LABEL_ATTRIB PYTHON_GETSET_DEF_FULL                       \
(                                                                               \
    label, py_binary_symbol,                                                    \
    "Label of the symbol, provided by the internal component or by the user."   \
)

    symbol = G_BIN_SYMBOL(pygobject_get(self));
    label = g_binary_symbol_get_label(symbol);

    if (label != NULL)
    {
        result = PyUnicode_FromString(label);
        free(label);
    }
    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 = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Définit un autre nom pour le symbole.                        *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_binary_symbol_set_label(PyObject *self, PyObject *value, void *closure)
{
    const char *alt;                        /* Etiquette alternative       */
    GBinSymbol *symbol;                     /* Elément à consulter         */

    if (value == Py_None)
        alt = NULL;

    else
    {
        if (!PyUnicode_Check(value))
            return -1;

        alt = PyUnicode_DATA(value);

    }

    symbol = G_BIN_SYMBOL(pygobject_get(self));

    g_binary_symbol_set_alt_label(symbol, alt);

    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_binary_symbol_type(void)
{
    static PyMethodDef binary_symbol_methods[] = {
        { NULL }
    };

    static PyGetSetDef binary_symbol_getseters[] = {
        BINARY_SYMBOL_RANGE_ATTRIB,
        BINARY_SYMBOL_STYPE_ATTRIB,
        BINARY_SYMBOL_STATUS_ATTRIB,
        BINARY_SYMBOL_LABEL_ATTRIB,
        { NULL }
    };

    static PyTypeObject binary_symbol_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.format.BinSymbol",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = BINARY_SYMBOL_DOC,

        .tp_richcompare = py_binary_symbol_richcompare,

        .tp_methods     = binary_symbol_methods,
        .tp_getset      = binary_symbol_getseters,

        .tp_init        = py_binary_symbol_init,
        .tp_new         = py_binary_symbol_new

    };

    return &binary_symbol_type;

}


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

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

    type = get_python_binary_symbol_type();

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

        dict = PyModule_GetDict(module);

        if (!ensure_python_line_generator_is_registered())
            return false;

        if (!register_class_for_pygobject(dict, G_TYPE_BIN_SYMBOL, type, &PyGObject_Type))
            return false;

        if (!define_binary_symbol_constants(type))
            return false;

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : arg = argument quelconque à tenter de convertir.             *
*                dst = destination des valeurs récupérées en cas de succès.   *
*                                                                             *
*  Description : Tente de convertir en symbole binaire.                       *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_binary_symbol(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */

    result = PyObject_IsInstance(arg, (PyObject *)get_python_binary_symbol_type());

    switch (result)
    {
        case -1:
            /* L'exception est déjà fixée par Python */
            result = 0;
            break;

        case 0:
            PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to binary symbol");
            break;

        case 1:
            *((GBinSymbol **)dst) = G_BIN_SYMBOL(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}