summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/glibext/buffercache.c
blob: 0cf3342a60f9b950ca313f4b6d388bbbe3168ed1 (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
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276

/* Chrysalide - Outil d'analyse de fichiers binaires
 * buffercache.c - équivalent Python du fichier "glibext/buffercache.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 "buffercache.h"


#include <pygobject.h>


#include <glibext/buffercache-int.h>
#include <plugins/dt.h>


#include "constants.h"
#include "bufferline.h"
#include "linegen.h"
#include "../access.h"
#include "../helpers.h"
#include "../analysis/content.h"



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


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

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



/* -------------------------- TAMPON POUR CODE DESASSEMBLE -------------------------- */


/* Met à disposition un encadrement des accès aux lignes. */
static PyObject *py_buffer_cache_lock(PyObject *, PyObject *);

/* Met à disposition un encadrement des accès aux lignes. */
static PyObject *py_buffer_cache_unlock(PyObject *, PyObject *);

/* Insère un générateur dans des lignes à une position donnée. */
static PyObject *py_buffer_cache_insert_at(PyObject *, PyObject *);

/* Retire une ligne du tampon. */
static PyObject *py_buffer_cache_delete_at(PyObject *, PyObject *);

/* Retire un type de générateur de lignes. */
static PyObject *py_buffer_cache_delete_type_at(PyObject *, PyObject *);

/* Ajoute en fin de tampon un générateur de lignes. */
static PyObject *py_buffer_cache_append(PyObject *, PyObject *);

/* Etend un tampon avec un générateur de lignes unique. */
static PyObject *py_buffer_cache_extend_with(PyObject *, PyObject *);

/* Réduit le tampon à une quantité de lignes précise. */
static PyObject *py_buffer_cache_truncate(PyObject *, PyObject *);

/* Ajoute une propriété particulière à une ligne. */
static PyObject *py_buffer_cache_add_line_flag(PyObject *, PyObject *);

/* Détermine l'ensemble des propriétés attachées à une ligne. */
static PyObject *py_buffer_cache_get_line_flags(PyObject *, PyObject *);

/* Retire une propriété particulière attachée à une ligne. */
static PyObject *py_buffer_cache_remove_line_flag(PyObject *, PyObject *);

/* Retrouve une ligne au sein d'un tampon avec un indice. */
static PyObject *py_buffer_cache_find_line_by_index(PyObject *, PyObject *);

/* Avance autant que possible vers une ligne idéale. */
static PyObject *py_buffer_cache_look_for_flag(PyObject *, PyObject *);

/* Indique l'éventuel contenu binaire associé au cache. */
static PyObject *py_buffer_cache_get_content(PyObject *, void *);

/* Fournit la hauteur d'impression d'une ligne visualisée. */
static PyObject *py_buffer_cache_get_line_height(PyObject *, void *);

/* Fournit la taille réservée pour la marge gauche. */
static PyObject *py_buffer_cache_get_left_margin(PyObject *, void *);

/* Fournit la position de départ pour l'impression de texte. */
static PyObject *py_buffer_cache_get_text_position(PyObject *, void *);

/* Compte le nombre de lignes rassemblées dans un tampon. */
static PyObject *py_buffer_cache_get_lines_count(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_buffer_cache_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_buffer_cache_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_BUFFER_CACHE, type->tp_name, NULL, 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  : 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_buffer_cache_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    GBinContent *content;                   /* Instance GLib du contenu    */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Version GLib du tampon      */

#define BUFFER_CACHE_DOC                                                    \
    "The BufferCache object manages a group of lines intended to get"       \
    " printed onto the screen or into a file.\n"                            \
    "\n"                                                                    \
    "These lines are cached and rebuilt when needed.\n"                     \
    "\n"                                                                    \
    "Instances can be created using the following constructor:\n"           \
    "\n"                                                                    \
    "    BufferCache(content=None)"                                         \
    "\n"                                                                    \
    "Where content is a pychrysalide.analysis.BinContent instance, if"      \
    " defined. This content is provided to lines as argument when the"      \
    " lines get printed, so it may not be always useful and thus can be"    \
    " discarded when creating a new buffer cache."                          \

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

    content = NULL;

    ret = PyArg_ParseTuple(args, "|O&", convert_to_binary_content_or_none, &content);
    if (!ret) return -1;

    /* Initialisation d'un objet GLib */

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

    /* Eléments de base */

    cache = G_BUFFER_CACHE(pygobject_get(self));

    if (content != NULL)
    {
        cache->content = content;
        g_object_ref(G_OBJECT(content));
    }

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                            TAMPON POUR CODE DESASSEMBLE                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Met à disposition un encadrement des accès aux lignes.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_lock(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    int write;                              /* Type de verrou à poser      */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_LOCK_METHOD PYTHON_METHOD_DEF                  \
(                                                                   \
    lock, "$self, /, write=False",                                  \
    METH_VARARGS, py_buffer_cache,                                  \
    "Lock for access the content of a buffer cache instance.\n"     \
    "\n"                                                            \
    "The *write* parameter is a boolean value which has to be set"  \
    " if the access to perform will modify the buffer cache.\n"     \
    "\n"                                                            \
    "Each call of this method has to followed by a call to"         \
    " pychrysalide.glibext.BufferCache.unlock(), with the same"     \
    " *write* parameter."                                           \
)

    write = 0;

    ret = PyArg_ParseTuple(args, "|p", &write);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_lock_unlock(cache, write, true);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Met à disposition un encadrement des accès aux lignes.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_unlock(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    int write;                              /* Type de verrou à poser      */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_UNLOCK_METHOD PYTHON_METHOD_DEF                \
(                                                                   \
    unlock, "$self, /, write=False",                                \
    METH_VARARGS, py_buffer_cache,                                  \
    "Unlock the content of a buffer cache instance.\n"              \
    "\n"                                                            \
    "The *write* parameter is a boolean value which has to be set"  \
    " if the performed access has modified the buffer cache.\n"     \
)

    write = 0;

    ret = PyArg_ParseTuple(args, "|p", &write);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_lock_unlock(cache, write, false);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Insère un générateur dans des lignes à une position donnée.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_insert_at(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de ligne à supprimer */
    GLineGenerator *generator;              /* Générateur à associer       */
    BufferLineFlags flags;                  /* Particularités nominales    */
    int before;                             /* Insertion avant ?           */
    int after;                              /* Insertion après ?           */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_INSERT_AT_METHOD PYTHON_METHOD_DEF             \
(                                                                   \
    insert_at, "$self, index, generator, /, flags="                 \
    "pychrysalide.glibext.BufferLine.BufferLineFlags.NONE,"         \
    " before=False, after=False",                                   \
    METH_VARARGS, py_buffer_cache,                                  \
    "Add an extra content generator to a given line.\n"             \
    "\n"                                                            \
    "The new content generator for the line at, before or after"    \
    " the provided index is a pychrysalide.glibext.LineGenerator"   \
    " instance. Nominal properties can be set for this line as"     \
    " extra pychrysalide.glibext.BufferLine.BufferLineFlags"        \
    " values.\n"                                                    \
    "\n"                                                            \
    "An write access lock has to be held for the cache; see the"    \
    " pychrysalide.glibext.BufferCache.lock() function."            \
)

    flags = BLF_NONE;
    before = 0;
    after = 0;

    ret = PyArg_ParseTuple(args, "nO&|O&pp", &index, convert_to_line_generator, &generator,
                           convert_to_buffer_line_flags, &flags, &before, &after);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_insert_at(cache, index, generator, flags, before, after);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Retire une ligne du tampon.                                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_delete_at(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de ligne à supprimer */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_DELETE_AT_METHOD PYTHON_METHOD_DEF                 \
(                                                                       \
    delete_at, "$self, index, /",                                       \
    METH_VARARGS, py_buffer_cache,                                      \
    "Delete the line at the *index* position from a buffer cache.\n"    \
    "\n"                                                                \
    "An write access lock has to be held for the cache; see the"        \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "n", &index);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_delete_at(cache, index);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Retire un type de générateur de lignes.                      *
*                                                                             *
*  Retour      : Générateur éventuellement trouvé ou NULL si aucun.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_delete_type_at(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de ligne à supprimer */
    PyObject *py_gtype;                     /* Version Python d'un GType   */
    int before;                             /* Insertion avant ?           */
    int after;                              /* Insertion après ?           */
    int ret;                                /* Bilan de lecture des args.  */
    GType gtype;                            /* Type de générateur visé     */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    GLineGenerator *generator;              /* Générateur retiré ou NULL   */

#define BUFFER_CACHE_DELETE_TYPE_AT_METHOD PYTHON_METHOD_DEF                \
(                                                                           \
    delete_type_at, "$self, index, gtype, /, before=False, after=False",    \
    METH_VARARGS, py_buffer_cache,                                          \
    "Delete the first generator of a given type found inside a line of a"   \
    " buffer cache.\n"                                                      \
    "\n"                                                                    \
    "The target type has to be a gobject.GType, usually provided by the"    \
    " *__gtype__* attribute of a generator interface. The generator is"     \
    " deleted from the line at, before or after the provided index.\n"      \
    "\n"                                                                    \
    "The function returns the deleted generator as a"                       \
    " pychrysalide.glibext.LineGenerator instance, or None if none found.\n"\
    "\n"                                                                    \
    "An write access lock has to be held for the cache; see the"            \
    " pychrysalide.glibext.BufferCache.lock() function."                    \
)

    before = 0;
    after = 0;

    ret = PyArg_ParseTuple(args, "nO|pp", &index, &py_gtype, &before, &after);
    if (!ret) return NULL;

    gtype = pyg_type_from_object(py_gtype);
    if (gtype == 0) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    generator = g_buffer_cache_delete_type_at(cache, index, gtype, before, after);

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

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Ajoute en fin de tampon un générateur de lignes.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_append(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GLineGenerator *generator;              /* Générateur à associer       */
    BufferLineFlags flags;                  /* Particularités nominales    */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_APPEND_METHOD PYTHON_METHOD_DEF                \
(                                                                   \
    append, "$self, generator, /, flags="                           \
    "pychrysalide.glibext.BufferLine.BufferLineFlags.NONE",         \
    METH_VARARGS, py_buffer_cache,                                  \
    "Append a new line at the end of a buffer cache.\n"             \
    "\n"                                                            \
    "The content generator for this new line is a"                  \
    " pychrysalide.glibext.LineGenerator instance. Nominal"         \
    " properties can be set for the line as extra"                  \
    " pychrysalide.glibext.BufferLine.BufferLineFlags values.\n"    \
    "\n"                                                            \
    "An write access lock has to be held for the cache; see the"    \
    " pychrysalide.glibext.BufferCache.lock() function."            \
)

    flags = BLF_NONE;

    ret = PyArg_ParseTuple(args, "O&|O&", convert_to_line_generator, &generator,
                           convert_to_buffer_line_flags, &flags);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_append(cache, generator, flags);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Etend un tampon avec un générateur de lignes unique.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_extend_with(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t count;                           /* Quantité de lignes à créer  */
    GLineGenerator *generator;              /* Générateur à associer       */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_EXTEND_WITH_METHOD PYTHON_METHOD_DEF           \
(                                                                   \
    extend_with, "$self, count, generator, /",                      \
    METH_VARARGS, py_buffer_cache,                                  \
    "Extend the buffer cache so it will contain *count* lines.\n"   \
    "\n"                                                            \
    "The *count* number should be greater than the current line"    \
    " quantity, otherwise the call makes no sense. The generator"   \
    " is a pychrysalide.glibext.LineGenerator instance used to"     \
    " produce the extra new lines on demand."                       \
    "\n"                                                            \
    "An write access lock has to be held for the cache; see the"    \
    " pychrysalide.glibext.BufferCache.lock() function."            \
)

    ret = PyArg_ParseTuple(args, "nO&", &count, convert_to_line_generator, &generator);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_extend_with(cache, count, generator);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Réduit le tampon à une quantité de lignes précise.           *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_truncate(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t max;                             /* Nombre de lignes au maximum */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_TRUNCATE_METHOD PYTHON_METHOD_DEF                  \
(                                                                       \
    truncate, "$self, max, /",                                          \
    METH_VARARGS, py_buffer_cache,                                      \
    "Shrink the buffer cache so it will contain at most *max* lines.\n" \
    "\n"                                                                \
    "The *max* number should be lesser than the current line quantity," \
    " otherwise no effect will happen."                                 \
    "\n"                                                                \
    "An write access lock has to be held for the cache; see the"        \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "n", &max);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_truncate(cache, max);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = tampon de lignes à venir consulter.                   *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Ajoute une propriété particulière à une ligne.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_add_line_flag(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de la ligne visée    */
    BufferLineFlags flag;                   /* Drapeau à considérer        */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_ADD_LINE_FLAG_METHOD PYTHON_METHOD_DEF         \
(                                                                   \
    add_line_flag, "$self, index, flag, /",                         \
    METH_VARARGS, py_buffer_cache,                                  \
    "Add one optional flag to those assigned to a given buffer"     \
    " line. The line is located using the *index* argument.\n"      \
    "\n"                                                            \
    "The *index* has to be a simple integer, and the *flag* a"      \
    " pychrysalide.glibext.BufferLine.BufferLineFlags value.\n"     \
    "\n"                                                            \
    "An write access lock has to be held for the cache; see the"    \
    " pychrysalide.glibext.BufferCache.lock() function."            \
)

    ret = PyArg_ParseTuple(args, "nO&", &index, convert_to_buffer_line_flags, &flag);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_add_line_flag(cache, index, flag);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Détermine l'ensemble des propriétés attachées à une ligne.   *
*                                                                             *
*  Retour      : Somme de toutes les propriétés enregistrées.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_line_flags(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de la ligne visée    */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    BufferLineFlags flags;                  /* Fanions conservés           */

#define BUFFER_CACHE_GET_LINE_FLAGS_METHOD PYTHON_METHOD_DEF            \
(                                                                       \
    get_line_flags, "$self, index, /",                                  \
    METH_VARARGS, py_buffer_cache,                                      \
    "Provide the optional flags assigned to a given buffer line. The"   \
    " line is located using the *index* argument.\n"                    \
    "\n"                                                                \
    "The result is a pychrysalide.glibext.BufferLine.BufferLineFlags"   \
    " value.\n"                                                         \
    "\n"                                                                \
    "An read access lock has to be held for the cache; see the"         \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "n", &index);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    flags = g_buffer_cache_get_line_flags(cache, index);

    result = cast_with_constants_group_from_type(get_python_buffer_line_type(), "BufferLineFlags", flags);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = tampon de lignes à venir consulter.                   *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Retire une propriété particulière attachée à une ligne.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_remove_line_flag(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de la ligne visée    */
    BufferLineFlags flag;                   /* Drapeau à considérer        */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */

#define BUFFER_CACHE_REMOVE_LINE_FLAG_METHOD PYTHON_METHOD_DEF          \
(                                                                       \
    remove_line_flag, "$self, index, flag, /",                          \
    METH_VARARGS, py_buffer_cache,                                      \
    "Remove one optional flag from those assigned to a given buffer"    \
    " line. The line is located using the *index* argument.\n"          \
    "\n"                                                                \
    "The *index* has to be a simple integer, and the *flag* a"          \
    " pychrysalide.glibext.BufferLine.BufferLineFlags value.\n"         \
    "\n"                                                                \
    "An write access lock has to be held for the cache; see the"        \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "nO&", &index, convert_to_buffer_line_flags, &flag);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    g_buffer_cache_remove_line_flag(cache, index, flag);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Retrouve une ligne au sein d'un tampon avec un indice.       *
*                                                                             *
*  Retour      : Line retrouvée ou None en cas d'échec.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_find_line_by_index(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de la ligne visée    */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    GBufferLine *line;                      /* Ligne trouvée ?             */

#define BUFFER_CACHE_FIND_LINE_BY_INDEX_METHOD PYTHON_METHOD_DEF        \
(                                                                       \
    find_line_by_index, "$self, index, /",                              \
    METH_VARARGS, py_buffer_cache,                                      \
    "Retrieve the line contained in a buffer cache at a given index.\n" \
    "\n"                                                                \
    "The result is a pychrysalide.glibext.BufferLine instance or"       \
    " None.\n"                                                          \
    "\n"                                                                \
    "An read access lock has to be held for the cache; see the"         \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "n", &index);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    line = g_buffer_cache_find_line_by_index(cache, index);

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

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un tampon de code.                *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Avance autant que possible vers une ligne idéale.            *
*                                                                             *
*  Retour      : Indice de la ligne recherchée, si elle existe.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_look_for_flag(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    size_t index;                           /* Indice de la ligne visée    */
    BufferLineFlags flag;                   /* Particularité à retrouver   */
    int ret;                                /* Bilan de lecture des args.  */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    size_t found;                           /* Indice de la ligne trouvée  */

#define BUFFER_CACHE_LOOK_FOR_FLAG_METHOD PYTHON_METHOD_DEF             \
(                                                                       \
    look_for_flag, "$self, index, flag, /",                             \
    METH_VARARGS, py_buffer_cache,                                      \
    "Iterate the buffer cache lines from a starting index until a"      \
    " line with flags matching the provided flag is met.\n"             \
    "\n"                                                                \
    "The *flag* argument has to be a"                                   \
    " pychrysalide.glibext.BufferLine.BufferLineFlags value.\n"         \
    "\n"                                                                \
    "The result is an index equal or greater than the starting index"   \
    " or, if no match is found, the number of lines in the buffer"      \
    " cache.\n"                                                         \
    "\n"                                                                \
    "An read access lock has to be held for the cache; see the"         \
    " pychrysalide.glibext.BufferCache.lock() function."                \
)

    ret = PyArg_ParseTuple(args, "nO&", &index, convert_to_buffer_line_flags, &flag);
    if (!ret) return NULL;

    cache = G_BUFFER_CACHE(pygobject_get(self));

    found = g_buffer_cache_look_for_flag(cache, index, flag);

    result = PyLong_FromSize_t(found);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique l'éventuel contenu binaire associé au cache.         *
*                                                                             *
*  Retour      : Eventuel contenu renseigné ou None.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_content(PyObject *self, void *closure)
{
    PyObject *result;                       /* Contenu binaire à retourner */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    GBinContent *content;                   /* Contenu éventuel à renvoyer */

#define BUFFER_CACHE_CONTENT_ATTRIB PYTHON_GET_DEF_FULL     \
(                                                           \
    content, py_buffer_cache,                               \
    "Binary content linked to the buffer cache, as a"       \
    " pychrysalide.analysis.BinContent instance, or None."  \
)

    cache = G_BUFFER_CACHE(pygobject_get(self));

    content = g_buffer_cache_get_content(cache);

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

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la hauteur d'impression d'une ligne visualisée.      *
*                                                                             *
*  Retour      : Hauteur de ligne en pixels.                                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_line_height(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    gint height;                            /* Valeur obtenue du cache     */

#define BUFFER_CACHE_LINE_HEIGHT_ATTRIB PYTHON_GET_DEF_FULL \
(                                                           \
    line_height, py_buffer_cache,                           \
    "Height of a line printed from the buffer cache."       \
)

    cache = G_BUFFER_CACHE(pygobject_get(self));

    height = g_buffer_cache_get_line_height(cache);

    result = PyLong_FromLong(height);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la taille réservée pour la marge gauche.             *
*                                                                             *
*  Retour      : Largeur en pixels.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_left_margin(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    gint width;                             /* Valeur obtenue du cache     */

#define BUFFER_CACHE_LEFT_MARGIN_ATTRIB PYTHON_GET_DEF_FULL     \
(                                                               \
    left_margin, py_buffer_cache,                               \
    "Width of the left margin inside of a buffer cache output." \
)

    cache = G_BUFFER_CACHE(pygobject_get(self));

    width = g_buffer_cache_get_left_margin(cache);

    result = PyLong_FromLong(width);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la position de départ pour l'impression de texte.    *
*                                                                             *
*  Retour      : Position en pixels.                                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_text_position(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    gint pos;                               /* Valeur obtenue du cache     */

#define BUFFER_CACHE_TEXT_POSITION_ATTRIB PYTHON_GET_DEF_FULL               \
(                                                                           \
    text_position, py_buffer_cache,                                         \
    "Starting position of the text on the left of a buffer cache output."   \
)

    cache = G_BUFFER_CACHE(pygobject_get(self));

    pos = g_buffer_cache_get_text_position(cache);

    result = PyLong_FromLong(pos);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Compte le nombre de lignes rassemblées dans un tampon.       *
*                                                                             *
*  Retour      : Nombre de lignes constituant le tampon.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_buffer_cache_get_lines_count(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GBufferCache *cache;                    /* Tampon natif à consulter    */
    size_t count;                           /* Décompte de première main   */

#define BUFFER_CACHE_LINES_COUNT_ATTRIB PYTHON_GET_DEF_FULL     \
(                                                               \
    lines_count, py_buffer_cache,                               \
    "Count the number of lines contained in a buffer cache.\n"  \
    "\n"                                                        \
    "An read access lock has to be held for the cache; see the" \
    " pychrysalide.glibext.BufferCache.lock() function."        \
)

    cache = G_BUFFER_CACHE(pygobject_get(self));

    count = g_buffer_cache_count_lines(cache);

    result = PyLong_FromSize_t(count);

    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_buffer_cache_type(void)
{
    static PyMethodDef py_buffer_cache_methods[] = {
        BUFFER_CACHE_LOCK_METHOD,
        BUFFER_CACHE_UNLOCK_METHOD,
        BUFFER_CACHE_INSERT_AT_METHOD,
        BUFFER_CACHE_DELETE_AT_METHOD,
        BUFFER_CACHE_DELETE_TYPE_AT_METHOD,
        BUFFER_CACHE_APPEND_METHOD,
        BUFFER_CACHE_EXTEND_WITH_METHOD,
        BUFFER_CACHE_TRUNCATE_METHOD,
        BUFFER_CACHE_ADD_LINE_FLAG_METHOD,
        BUFFER_CACHE_GET_LINE_FLAGS_METHOD,
        BUFFER_CACHE_REMOVE_LINE_FLAG_METHOD,
        BUFFER_CACHE_FIND_LINE_BY_INDEX_METHOD,
        BUFFER_CACHE_LOOK_FOR_FLAG_METHOD,
        { NULL }
    };

    static PyGetSetDef py_buffer_cache_getseters[] = {
        BUFFER_CACHE_CONTENT_ATTRIB,
        BUFFER_CACHE_LINE_HEIGHT_ATTRIB,
        BUFFER_CACHE_LEFT_MARGIN_ATTRIB,
        BUFFER_CACHE_TEXT_POSITION_ATTRIB,
        BUFFER_CACHE_LINES_COUNT_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_buffer_cache_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.glibext.BufferCache",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = BUFFER_CACHE_DOC,

        .tp_methods     = py_buffer_cache_methods,
        .tp_getset      = py_buffer_cache_getseters,

        .tp_init        = py_buffer_cache_init,
        .tp_new         = py_buffer_cache_new

    };

    return &py_buffer_cache_type;

}


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

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

    type = get_python_buffer_cache_type();

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

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_BUFFER_CACHE, type, &PyGObject_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 tampon de lignes.                      *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_buffer_cache_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 buffer cache");
            break;

        case 1:
            *((GBufferCache **)dst) = G_BUFFER_CACHE(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}