summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/type.c
blob: d2801bf438746c3bb41d5829c33aec9f44211e2d (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
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170

/* Chrysalide - Outil d'analyse de fichiers binaires
 * type.c - équivalent Python du fichier "analysis/type.c"
 *
 * Copyright (C) 2018-2019 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 "type.h"


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


#include <i18n.h>


#include <analysis/type-int.h>
#include <plugins/dt.h>


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



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


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

/* Initialise la classe des types quelconques. */
static void py_data_type_init_gclass(GDataTypeClass *, gpointer);

/* Calcule une empreinte pour un type de données. */
static guint py_data_type_hash_wrapper(const GDataType *);

/* Crée un copie d'un type existant. */
static GDataType *py_data_type_dup_wrapper(const GDataType *);

/* Décrit le type fourni sous forme de caractères. */
static char *py_data_type_to_string_wrapper(const GDataType *, bool);

/* Indique si le type assure une gestion des espaces de noms. */
static bool py_data_type_handle_namespaces_wrapper(const GDataType *);

/* Indique si le type est un pointeur. */
static bool py_data_type_is_pointer_wrapper(const GDataType *);

/* Indique si le type est une référence. */
static bool py_data_type_is_reference_wrapper(const GDataType *);

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



/* ----------------- FONCTIONNALITES BASIQUES POUR TYPES DE DONNEES ----------------- */


/* Décrit le type fourni sous forme de caractères. */
static PyObject *py_data_type_to_str(PyObject *);

/* Crée un copie d'un type existant. */
static PyObject *py_data_type_dup(PyObject *, PyObject *);

/* Calcule une empreinte pour un type de données. */
static PyObject *py_data_type_get_hash(PyObject *, void *);

/* Fournit le groupe d'appartenance d'un type donné. */
static PyObject *py_data_type_get_namespace(PyObject *, void *);

/* Définit le groupe d'appartenance d'un type donné. */
static int py_data_type_set_namespace(PyObject *, PyObject *, void *);

/* Fournit les qualificatifs associés à une instance de type. */
static PyObject *py_data_type_get_qualifiers(PyObject *, void *);

/* Définit l'ensemble des qualificatifs d'une instance de type. */
static int py_data_type_set_qualifiers(PyObject *, PyObject *, void *);

/* Indique si le type assure une gestion des espaces de noms. */
static PyObject *py_data_type_handle_namespaces(PyObject *, void *);

/* Indique si le type est un pointeur. */
static PyObject *py_data_type_is_pointer(PyObject *, void *);

/* Indique si le type est une référence. */
static PyObject *py_data_type_is_reference(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_data_type_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_data_type_type();

    if (type == base)
    {
        result = NULL;
        PyErr_Format(PyExc_RuntimeError, _("%s is an abstract class"), type->tp_name);
        goto exit;
    }

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

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

    gtype = build_dynamic_type(G_TYPE_DATA_TYPE, type->tp_name,
                               (GClassInitFunc)py_data_type_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() */

    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 types quelconques.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_data_type_init_gclass(GDataTypeClass *class, gpointer unused)
{
    class->hash = py_data_type_hash_wrapper;
    class->dup = py_data_type_dup_wrapper;
    class->to_string = py_data_type_to_string_wrapper;

    class->handle_ns = py_data_type_handle_namespaces_wrapper;
    class->is_pointer = py_data_type_is_pointer_wrapper;
    class->is_reference = py_data_type_is_reference_wrapper;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type à consulter.                                     *
*                                                                             *
*  Description : Calcule une empreinte pour un type de données.               *
*                                                                             *
*  Retour      : Valeur arbitraire sur 32 bits, idéalement unique par type.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static guint py_data_type_hash_wrapper(const GDataType *type)
{
    guint result;                           /* Empreinte à renvoyer        */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_HASH_WRAPPER PYTHON_WRAPPER_DEF               \
(                                                               \
    _hash, "$self, /",                                          \
    METH_NOARGS,                                                \
    "Abstract method used to create a hash of the data type.\n" \
    "\n"                                                        \
    "The returned value has to be a 32-bit integer."            \
)

    result = 0;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_hash"))
    {
        pyret = run_python_method(pyobj, "_hash", NULL);

        if (pyret != NULL)
        {
            if (PyLong_Check(pyret))
                result = PyLong_AsUnsignedLong(pyret);
        }

        Py_XDECREF(pyret);

    }

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type à dupliquer.                                     *
*                                                                             *
*  Description : Crée un copie d'un type existant.                            *
*                                                                             *
*  Retour      : Nouvelle instance de type identique à celle fournie.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GDataType *py_data_type_dup_wrapper(const GDataType *type)
{
    GDataType *result;                      /* Copie à retourner           */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_DUP_WRAPPER PYTHON_WRAPPER_DEF                \
(                                                               \
    _dup, "$self, /",                                           \
    METH_NOARGS,                                                \
    "Abstract method used to create a copy of a data type.\n"   \
    "\n"                                                        \
    "The returned value has to be a new instance of the"        \
    " pychrysalide.analysis.DataType class."                    \
)

    result = NULL;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_dup"))
    {
        pyret = run_python_method(pyobj, "_dup", NULL);

        if (pyret != NULL)
        {
            if (PyObject_TypeCheck(pyret, get_python_data_type_type()))
            {
                result = G_DATA_TYPE(pygobject_get(pyret));
                g_object_ref(G_OBJECT(result));
            }
        }

        Py_XDECREF(pyret);

    }

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type    = type à convertir.                                  *
*                include = doit-on inclure les espaces de noms ?              *
*                                                                             *
*  Description : Décrit le type fourni sous forme de caractères.              *
*                                                                             *
*  Retour      : Chaîne à libérer de la mémoire après usage.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static char *py_data_type_to_string_wrapper(const GDataType *type, bool include)
{
    char *result;                           /* Etiquette à retourner       */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *arg;                          /* Version Python de l'argument*/
    PyObject *args;                         /* Arguments pour l'appel      */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_TO_STRING_WRAPPER PYTHON_WRAPPER_DEF              \
(                                                                   \
    _to_string, "$self, include, /",                                \
    METH_VARARGS,                                                   \
    "Abstract method used to provide the string represention of"    \
    " a data type.\n"                                               \
    "\n"                                                            \
    "The *include* argument defines if the type namespace has to"   \
    " get prepended, if it exists.\n"                               \
    "\n"                                                            \
    "The returned value has to be a string."                        \
)

    result = NULL;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_to_string"))
    {
        arg = include ? Py_True : Py_False;
        Py_INCREF(arg);

        args = PyTuple_New(1);
        PyTuple_SetItem(args, 0, arg);

        pyret = run_python_method(pyobj, "_to_string", args);

        if (pyret != NULL)
        {
            if (PyUnicode_Check(pyret))
                result = strdup(PyUnicode_DATA(pyret));
        }

        Py_XDECREF(pyret);

        Py_DECREF(args);

    }

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type à consulter.                                     *
*                                                                             *
*  Description : Indique si le type assure une gestion des espaces de noms.   *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_data_type_handle_namespaces_wrapper(const GDataType *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_HANDLE_NAMESPACES_WRAPPER PYTHON_TRUE_WRAPPER_DEF     \
(                                                                       \
    _handle_namespaces, "$self, /",                                     \
    METH_NOARGS,                                                        \
    "Abstract method used to state if the type handles namespaces"      \
    " or not.\n"                                                        \
    "\n"                                                                \
    "The return is a boolean value. If this method does not"            \
    " exist, the True value is assumed."                                \
)

    result = true;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_handle_namespaces"))
    {
        pyret = run_python_method(pyobj, "_handle_namespaces", NULL);

        result = (pyret == Py_True);

        Py_XDECREF(pyret);

    }

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type à consulter.                                     *
*                                                                             *
*  Description : Indique si le type est un pointeur.                          *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_data_type_is_pointer_wrapper(const GDataType *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_IS_POINTER_WRAPPER PYTHON_FALSE_WRAPPER_DEF   \
(                                                               \
    _is_pointer, "$self, /",                                    \
    METH_NOARGS,                                                \
    "Abstract method used to state if the type points to"       \
    " another type or not.\n"                                   \
    "\n"                                                        \
    "The return is a boolean value. If this method does not"    \
    " exist, the False value is assumed."                       \
)

    result = false;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_is_pointer"))
    {
        pyret = run_python_method(pyobj, "_is_pointer", NULL);

        result = (pyret == Py_True);

        Py_XDECREF(pyret);

    }

    Py_DECREF(pyobj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type à consulter.                                     *
*                                                                             *
*  Description : Indique si le type est une référence.                        *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_data_type_is_reference_wrapper(const GDataType *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define DATA_TYPE_IS_REFERENCE_WRAPPER PYTHON_FALSE_WRAPPER_DEF \
(                                                               \
    _is_reference, "$self, /",                                  \
    METH_NOARGS,                                                \
    "Abstract method used to state if the type refers to"       \
    " another type or not.\n"                                   \
    "\n"                                                        \
    "The return is a boolean value. If this method does not"    \
    " exist, the False value is assumed."                       \
)

    result = false;

    pyobj = pygobject_new(G_OBJECT(type));

    if (has_python_method(pyobj, "_is_reference"))
    {
        pyret = run_python_method(pyobj, "_is_reference", NULL);

        result = (pyret == Py_True);

        Py_XDECREF(pyret);

    }

    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_data_type_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    int ret;                                /* Bilan de lecture des args.  */

#define DATA_TYPE_DOC                                                   \
    "The DataType object is the base class for all data types.\n"       \
    "\n"                                                                \
    "Instances can be created using the following constructor:\n"       \
    "\n"                                                                \
    "    DataType()"                                                    \
    "\n"                                                                \
    "The following methods have to be defined for new classes:\n"       \
    "* pychrysalide.analysis.DataType._hash();\n"                       \
    "* pychrysalide.analysis.DataType._dup();\n"                        \
    "* pychrysalide.analysis.DataType._to_string()."                    \
    "\n"                                                                \
    "Some extra method definitions are optional for new classes:\n"     \
    "* pychrysalide.analysis.DataType._handle_namespaces();\n"          \
    "* pychrysalide.analysis.DataType._is_pointer();\n"                 \
    "* pychrysalide.analysis.DataType._is_reference();"                 \

    /* Initialisation d'un objet GLib */

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

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                   FONCTIONNALITES BASIQUES POUR TYPES DE DONNEES                   */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = instance d'un type version Python à traiter.          *
*                                                                             *
*  Description : Décrit le type fourni sous forme de caractères.              *
*                                                                             *
*  Retour      : Chaîne de caractère construite pour l'occasion.              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_to_str(PyObject *self)
{
    PyObject *result;                       /* Représentation à retourner  */
    GDataType *type;                        /* Version native de l'objet   */
    char *desc;                             /* Description du type         */

    type = G_DATA_TYPE(pygobject_get(self));

    desc = g_data_type_to_string(type, true);

    result = PyUnicode_FromString(desc);

    free(desc);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = serveur à manipuler.                                  *
*                args = arguments d'appel non utilisés ici.                   *
*                                                                             *
*  Description : Crée un copie d'un type existant.                            *
*                                                                             *
*  Retour      : Nouvelle instance de type identique à celle fournie.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_dup(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GDataType *type;                        /* Version native de l'objet   */
    GDataType *copy;                        /* Copie du type obtenue       */

#define DATA_TYPE_DUP_METHOD PYTHON_METHOD_DEF              \
(                                                           \
    dup, "$self, /",                                        \
    METH_NOARGS, py_data_type,                              \
    "Create a copy of a data type.\n"                       \
    "\n"                                                    \
    "The returned value has to be a new instance of the"    \
    " pychrysalide.analysis.DataType class."                \
)

    type = G_DATA_TYPE(pygobject_get(self));

    copy = g_data_type_dup(type);

    if (copy != NULL)
    {
        result = pygobject_new(G_OBJECT(copy));
        g_object_unref(G_OBJECT(copy));
    }

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Calcule une empreinte pour un type de données.               *
*                                                                             *
*  Retour      : Valeur arbitraire sur 32 bits, idéalement unique par type.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_get_hash(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    guint hash;                             /* Empreinte à transmettre     */

#define DATA_TYPE_HASH_ATTRIB PYTHON_GET_DEF_FULL       \
(                                                       \
    hash, py_data_type,                                 \
    "Hash value for the type, as a 32-bit integer.\n"   \
    "\n"                                                \
    "Each proporty change implies a hash change."       \
)

    type = G_DATA_TYPE(pygobject_get(self));

    hash = g_data_type_hash(type);

    result = PyLong_FromUnsignedLong(hash);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le groupe d'appartenance d'un type donné.            *
*                                                                             *
*  Retour      : Eventuelle instance d'appartenance ou None.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_get_namespace(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    GDataType *ns;                          /* Espace de noms              */
    const char *sep;                        /* Séparateur d'espace         */

#define DATA_TYPE_NAMESPACE_ATTRIB PYTHON_GETSET_DEF_FULL               \
(                                                                       \
    namespace, py_data_type,                                            \
    "Namespace for the type, None if any.\n"                            \
    "\n"                                                                \
    "This property carries a tuple of two values:\n"                    \
    "* a namespace, as a pychrysalide.analysis.DataType.TypeQualifier"  \
    " instance;\n"                                                      \
    "* a namespace separator, as a string."                             \
)

    type = G_DATA_TYPE(pygobject_get(self));

    ns = g_data_type_get_namespace(type);
    sep = g_data_type_get_namespace_separator(type);

    if (ns != NULL && sep != NULL)
    {
        result = PyTuple_New(2);

        PyTuple_SetItem(result, 0, pygobject_new(G_OBJECT(ns)));
        g_object_unref(G_OBJECT(ns));

        PyTuple_SetItem(result, 1, PyUnicode_FromString(sep));

    }

    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 le groupe d'appartenance d'un type donné.            *
*                                                                             *
*  Retour      : Bilan de l'opération pour Python.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_data_type_set_namespace(PyObject *self, PyObject *value, void *closure)
{
    GDataType *type;                        /* Elément à traiter           */
    GDataType *ns;                          /* Espace de noms              */
    char *sep;                              /* Séparateur des espaces      */

    if ((!PyTuple_Check(value) || (PyTuple_Check(value) && PyTuple_Size(value) != 2)) && value != Py_None)
    {
        PyErr_SetString(PyExc_TypeError,
                        _("The attribute value must be a tuple with GDataType and a separator or None."));
        return -1;
    }

    type = G_DATA_TYPE(pygobject_get(self));

    if (value == Py_None)
        g_data_type_set_namespace(type, NULL, NULL);

    else
    {
        if (!PyObject_IsInstance(PyTuple_GetItem(value, 0), (PyObject *)get_python_data_type_type()))
        {
            PyErr_SetString(PyExc_TypeError, _("The first tuple item must be a GDataType."));
            return -1;
        }

        if (!PyUnicode_Check(PyTuple_GetItem(value, 1)))
        {
            PyErr_SetString(PyExc_TypeError, _("The second tuple item must be a string."));
            return -1;
        }

        ns = G_DATA_TYPE(pygobject_get(PyTuple_GetItem(value, 0)));
        sep = strdup(PyUnicode_DATA(PyTuple_GetItem(value, 1)));

        g_object_ref(G_OBJECT(ns));
        g_data_type_set_namespace(type, ns, sep);

    }

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit les qualificatifs associés à une instance de type.   *
*                                                                             *
*  Retour      : Qualificatifs éventuels.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_get_qualifiers(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    TypeQualifier qualifiers;               /* Qualificatifs en place      */

#define DATA_TYPE_QUALIFIERS_ATTRIB PYTHON_GETSET_DEF_FULL                          \
(                                                                                   \
    qualifiers, py_data_type,                                                       \
    "Qualifier for the data type, *TypeQualifier.NONE* if any.\n"                   \
    "\n"                                                                            \
    "This property carries a pychrysalide.analysis.DataType.TypeQualifier value."   \
)

    type = G_DATA_TYPE(pygobject_get(self));
    qualifiers = g_data_type_get_qualifiers(type);

    result = cast_with_constants_group_from_type(get_python_data_type_type(), "TypeQualifier", qualifiers);

    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 l'ensemble des qualificatifs d'une instance de type. *
*                                                                             *
*  Retour      : Bilan de l'opération pour Python.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_data_type_set_qualifiers(PyObject *self, PyObject *value, void *closure)
{
    GDataType *type;                        /* Elément à traiter           */
    TypeQualifier qualifiers;               /* Qualificatifs à intégrer    */
    int ret;                                /* Bilan d'une conversion      */

    ret = convert_to_data_type_qualifier(value, &qualifiers);
    if (ret != 1) return -1;

    type = G_DATA_TYPE(pygobject_get(self));

    g_data_type_set_qualifiers(type, qualifiers);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si le type assure une gestion des espaces de noms.   *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_handle_namespaces(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    bool status;                            /* Etat à faire suivre         */

#define DATA_TYPE_NAMESPACES_ATTRIB PYTHON_RAWGET_DEF_FULL      \
(                                                               \
    handle_namespaces, py_data_type,                            \
    "True if the type handles namespaces, False otherwise."     \
)

    type = G_DATA_TYPE(pygobject_get(self));

    status = g_data_type_handle_namespaces(type);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si le type est un pointeur.                          *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_is_pointer(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    bool status;                            /* Etat à faire suivre         */

#define DATA_TYPE_POINTER_ATTRIB PYTHON_IS_DEF_FULL     \
(                                                       \
    pointer, py_data_type,                              \
    "True if the type is a pointer, False otherwise."   \
)

    type = G_DATA_TYPE(pygobject_get(self));

    status = g_data_type_is_pointer(type);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si le type est une référence.                        *
*                                                                             *
*  Retour      : Bilan de la consultation.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_data_type_is_reference(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDataType *type;                        /* Elément à consulter         */
    bool status;                            /* Etat à faire suivre         */

#define DATA_TYPE_REFERENCE_ATTRIB PYTHON_IS_DEF_FULL   \
(                                                       \
    reference, py_data_type,                            \
    "True if the type is a reference, False otherwise." \
)

    type = G_DATA_TYPE(pygobject_get(self));

    status = g_data_type_is_reference(type);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    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_data_type_type(void)
{
    static PyMethodDef py_data_type_methods[] = {
        DATA_TYPE_HASH_WRAPPER,
        DATA_TYPE_DUP_WRAPPER,
        DATA_TYPE_TO_STRING_WRAPPER,
        DATA_TYPE_HANDLE_NAMESPACES_WRAPPER,
        DATA_TYPE_IS_POINTER_WRAPPER,
        DATA_TYPE_DUP_METHOD,
        { NULL }
    };

    static PyGetSetDef py_data_type_getseters[] = {
        DATA_TYPE_HASH_ATTRIB,
        DATA_TYPE_NAMESPACE_ATTRIB,
        DATA_TYPE_QUALIFIERS_ATTRIB,
        DATA_TYPE_NAMESPACES_ATTRIB,
        DATA_TYPE_POINTER_ATTRIB,
        DATA_TYPE_REFERENCE_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_data_type_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.DataType",

        .tp_str         = py_data_type_to_str,

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = DATA_TYPE_DOC,

        .tp_methods     = py_data_type_methods,
        .tp_getset      = py_data_type_getseters,

        .tp_init        = py_data_type_init,
        .tp_new         = py_data_type_new

    };

    return &py_data_type_type;

}


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

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

    type = get_python_data_type_type();

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

        dict = PyModule_GetDict(module);

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

        if (!define_analysis_data_type_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 type de donnée.                        *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_data_type_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 data type");
            break;

        case 1:
            *((GDataType **)dst) = G_DATA_TYPE(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  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 type de donnée ou NULL.                *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    if (arg == Py_None)
    {
        *((GDataType **)dst) = NULL;
        result = 1;
    }

    else
        result = convert_to_data_type(arg, dst);

    return result;

}