summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/gui/panel.c
blob: d9a2bc554a5a929ca87a27786eaaa87985353895 (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

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


#include <pygobject.h>


#include <i18n.h>
#include <core/params.h>
#include <gui/panel-int.h>
#include <gui/core/panels.h>
#include <plugins/dt.h>


#include "constants.h"
#include "item.h"
#include "../access.h"
#include "../helpers.h"
#include "../glibext/named.h"
#include "../gtkext/dockable.h"



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


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

/* Initialise la classe des panneaux pour l'interface graphique. */
static void py_panel_item_init_gclass(GPanelItemClass *, gpointer);

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



/* -------------------------- FONCTIONNALITES D'UN PANNEAU -------------------------- */


/* Place un panneau dans l'ensemble affiché. */
static PyObject *py_panel_item_dock(PyObject *, PyObject *);

/* Supprime un panneau de l'ensemble affiché. */
static PyObject *py_panel_item_undock(PyObject *, PyObject *);

/* Fournit le chemin d'accès à utiliser pour les encapsulations. */
static PyObject *py_panel_item_get_named_widget(PyObject *, void *);

/* Fournit une indication sur la personnalité du panneau. */
static PyObject *py_panel_item_get_personality(PyObject *, void *);

/* Fournit le chemin d'accès à utiliser pour les encapsulations. */
static PyObject *py_panel_item_get_path(PyObject *, void *);

/* Définit le chemin d'accès à utiliser pour les encapsulations. */
static int py_panel_item_set_path(PyObject *, PyObject *, void *);

/* Indique si le composant repose sur un support de l'éditeur. */
static PyObject *py_panel_item_get_docked(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_panel_item_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_panel_item_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_PANEL_ITEM, type->tp_name,
                               (GClassInitFunc)py_panel_item_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 panneaux pour l'interface graphique.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_panel_item_init_gclass(GPanelItemClass *class, gpointer unused)
{
    py_editor_item_init_gclass(G_EDITOR_ITEM_CLASS(class), NULL);

}


/******************************************************************************
*                                                                             *
*  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_panel_item_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    PanelItemPersonality personality;       /* Nature du panneau           */
    GNamedWidget *widget;                   /* Composant visuel du panneau */
    int startup;                            /* Recommandation au démarrage */
    const char *path;                       /* Placement à l'affichage     */
    int ret;                                /* Bilan de lecture des args.  */
    GPanelItem *panel;                      /* Panneau à manipuler         */

    static char *kwlist[] = { "personality", "widget", "dock", "path", NULL };

#define PANEL_ITEM_DOC                                                          \
    "PanelItem is an abstract class for panels available in the main GUI"       \
    " interface.\n"                                                             \
    "\n"                                                                        \
    "Instances can be created using the following constructor:\n"               \
    "\n"                                                                        \
    "    PanelItem(personality, widget, dock, path)"                            \
    "\n"                                                                        \
    "Where:\n"                                                                  \
    "* personality defines how many instances of the panels can be created"     \
    " at the same time.\n"                                                      \
    "* widget is an implementation of the pychrysalide.glibext.NamedWidget"     \
    " interface (see pychrysalide.gtkext.BuiltNamedWidget for a ready-to-use"   \
    " helper).\n"                                                               \
    "* dock defines if the panel is docked by default.\n"                       \
    "* path states the location of the panel inside the main GUI.\n"            \
    "\n"                                                                        \
    "The easiest way to pass all this information is probably to use a"         \
    " transitional dictionary inside the panel *__init__()* constructor:\n"     \
    "\n"                                                                        \
    "    params = {\n"                                                          \
    "        'personality' : PanelItemPersonality.PIP_SINGLETON,\n"             \
    "        'widget' : my_named_widget_instance,\n"                            \
    "        'dock' : True,\n"                                                  \
    "        'path' : 'MES'\n"                                                  \
    "    }\n"                                                                   \
    "    super(MyPanel, self).__init__(**params)\n"                             \
    "\n"                                                                        \
    "The PanelItem definition handles internally the supply of the *_widget*"   \
    " attribute for pychrysalide.gui.EditorItem.\n"                             \
    "\n"                                                                        \
    "For more details about the panel path, please refer to"                    \
    " pychrysalide.gtkext.GtkDockable."

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

    ret = PyArg_ParseTupleAndKeywords(args, kwds, "O&O&ps", kwlist,
                                      convert_to_panel_item_personality, &personality,
                                      convert_to_named_widget, &widget,
                                      &startup, &path);
    if (!ret) return -1;

    /* Initialisation d'un objet GLib */

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

    /* Eléments de base */

    panel = G_PANEL_ITEM(pygobject_get(self));

    panel->personality = personality;

    /**
     * Si Python ne voit plus la variable représentant le panneau utilisée,
     * il va la supprimer, ce qui va supprimer le composant GTK.
     *
     * On sera donc en situation de Use-After-Free, dont les conséquences
     * arrivent très vite.
     */
    panel->widget = widget;
    g_object_ref(G_OBJECT(widget));

    panel->dock_at_startup = startup;
    panel->path = strdup(path);

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                            FONCTIONNALITES D'UN PANNEAU                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un binaire.                       *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Place un panneau dans l'ensemble affiché.                    *
*                                                                             *
*  Retour      : Py_None.                                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_dock(PyObject *self, PyObject *args)
{
    GPanelItem *item;                       /* Panneau à manipuler         */

#define PANEL_ITEM_DOCK_METHOD PYTHON_METHOD_DEF    \
(                                                   \
    dock, "$self, /",                               \
    METH_NOARGS, py_panel_item,                     \
    "Display the panel item in the right place."    \
)

    item = G_PANEL_ITEM(pygobject_get(self));

    g_panel_item_dock(item);

    Py_RETURN_NONE;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un binaire.                       *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Supprime un panneau de l'ensemble affiché.                   *
*                                                                             *
*  Retour      : Py_None.                                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_undock(PyObject *self, PyObject *args)
{
    GPanelItem *item;                       /* Panneau à manipuler         */

#define PANEL_ITEM_UNDOCK_METHOD PYTHON_METHOD_DEF  \
(                                                   \
    undock, "$self, /",                             \
    METH_NOARGS, py_panel_item,                     \
    "Hide the panel item from the main interface."  \
)

    item = G_PANEL_ITEM(pygobject_get(self));

    g_panel_item_undock(item);

    Py_RETURN_NONE;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le chemin d'accès à utiliser pour les encapsulations.*
*                                                                             *
*  Retour      : Chemin d'accès défini.                                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_get_named_widget(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GPanelItem *item;                       /* Panneau à consulter         */
    GNamedWidget *widget;                   /* Composant nommé à transférer*/

#define PANEL_ITEM_NAMED_WIDGET_ATTRIB PYTHON_GET_DEF_FULL  \
(                                                           \
    named_widget, py_panel_item,                            \
    "Named widget as core component of the panel item."     \
)

    item = G_PANEL_ITEM(pygobject_get(self));
    widget = gtk_panel_item_get_named_widget(item);

    result = pygobject_new(G_OBJECT(widget));

    g_object_unref(G_OBJECT(widget));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit une indication sur la personnalité du panneau.       *
*                                                                             *
*  Retour      : Identifiant lié à la nature du panneau.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_get_personality(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GPanelItem *item;                       /* Panneau à consulter         */
    PanelItemPersonality personality;       /* Valeur native à convertir   */

#define PANEL_ITEM_PERSONALITY_ATTRIB PYTHON_GET_DEF_FULL       \
(                                                               \
    personality, py_panel_item,                                 \
    "Rule for handling panel creations, as a"                   \
    " pychrysalide.gui.PanelItem.PanelItemPersonality value."   \
)

    item = G_PANEL_ITEM(pygobject_get(self));
    personality = gtk_panel_item_get_personality(item);

    result = cast_with_constants_group_from_type(get_python_panel_item_type(), "PanelItemPersonality", personality);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le chemin d'accès à utiliser pour les encapsulations.*
*                                                                             *
*  Retour      : Chemin d'accès défini.                                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_get_path(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GPanelItem *item;                       /* Panneau à consulter         */
    const char *path;                       /* Chemin d'accès courant      */

#define PANEL_ITEM_PATH_ATTRIB PYTHON_GETSET_DEF_FULL       \
(                                                           \
    path, py_panel_item,                                    \
    "Get or define the current path of the panel item."     \
)

    item = G_PANEL_ITEM(pygobject_get(self));
    path = gtk_panel_item_get_path(item);

    result = PyUnicode_FromString(path);

    return result;

}


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

static int py_panel_item_set_path(PyObject *self, PyObject *value, void *closure)
{
    GPanelItem *item;                       /* Panneau à manipuler         */
    const char *path;                       /* Nouveau chemin d'accès      */

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

    item = G_PANEL_ITEM(pygobject_get(self));

    path = PyUnicode_DATA(value);

    gtk_panel_item_set_path(item, path);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si le composant repose sur un support de l'éditeur.  *
*                                                                             *
*  Retour      : True si le composant est bien incrusté quelque part.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_panel_item_get_docked(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GPanelItem *item;                       /* Panneau à consulter         */
    bool docked;                            /* Statut de l'ancrage         */

#define PANEL_ITEM_DOCKED_ATTRIB PYTHON_GET_DEF_FULL    \
(                                                       \
    docked, py_panel_item,                              \
    "Dock status of the panel item."                    \
)

    item = G_PANEL_ITEM(pygobject_get(self));
    docked = g_panel_item_is_docked(item);

    result = docked ? 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_panel_item_type(void)
{
    static PyMethodDef py_panel_item_methods[] = {
        PANEL_ITEM_DOCK_METHOD,
        PANEL_ITEM_UNDOCK_METHOD,
        { NULL }
    };

    static PyGetSetDef py_panel_item_getseters[] = {
        PANEL_ITEM_NAMED_WIDGET_ATTRIB,
        PANEL_ITEM_PERSONALITY_ATTRIB,
        PANEL_ITEM_PATH_ATTRIB,
        PANEL_ITEM_DOCKED_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_panel_item_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.gui.PanelItem",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = PANEL_ITEM_DOC,

        .tp_methods     = py_panel_item_methods,
        .tp_getset      = py_panel_item_getseters,

        .tp_init        = py_panel_item_init,
        .tp_new         = py_panel_item_new,

    };

    return &py_panel_item_type;

}


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

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

    type = get_python_panel_item_type();

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

        dict = PyModule_GetDict(module);

        if (!ensure_python_editor_item_is_registered())
            return false;

        if (!ensure_python_dockable_is_registered())
            return false;

        if (!_register_class_for_pygobject(dict, G_TYPE_PANEL_ITEM, type,
                                           get_python_editor_item_type(), get_python_dockable_type(), NULL))
            return false;

        if (!define_panel_item_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 panneau pour GUI.                      *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_panel_item_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 executable format");
            break;

        case 1:
            *((GPanelItem **)dst) = G_PANEL_ITEM(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}