summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/glibext/named.c
blob: 4f21064f42cb28ae7bff5d7514bdba0706829512 (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

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


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


#include <glibext/named-int.h>


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



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


/* Procède à l'initialisation de l'interface de génération. */
static void py_named_widget_interface_init(GNamedWidgetIface *, gpointer *);

/* Fournit le désignation associée à un composant nommé. */
static char *py_named_widget_get_name_wrapper(const GNamedWidget *, bool);

/* Fournit le composant associé à un composant nommé. */
static GtkWidget *py_named_widget_get_widget_wrapper(const GNamedWidget *);



/* ------------------------- CONNEXION AVEC L'API DE PYTHON ------------------------- */


/* Fournit le désignation associée à un composant nommé. */
static PyObject *py_named_widget_get_name(PyObject *, void *);

/* Fournit le désignation associée à un composant nommé. */
static PyObject *py_named_widget_get_long_name(PyObject *, void *);

/* Fournit le composant associé à un composant nommé. */
static PyObject *py_named_widget_get_widget(PyObject *, void *);



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


/******************************************************************************
*                                                                             *
*  Paramètres  : iface  = interface GLib à initialiser.                       *
*                unused = adresse non utilisée ici.                           *
*                                                                             *
*  Description : Procède à l'initialisation de l'interface de génération.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_named_widget_interface_init(GNamedWidgetIface *iface, gpointer *unused)
{

#define NAMED_WIDGET_DOC                                                    \
    "NamedWidget is an interface linking GTK widget to short and long"      \
    " descriptions. Such interface is mainly used when inserting widgets"   \
    " into the main window as panels.\n"                                    \
    "\n"                                                                    \
    "A typical class declaration for a new implementation looks like:\n"    \
    "\n"                                                                    \
    "    class NewImplem(GObject.Object, NamedWidget):\n"                   \
    "        ...\n"                                                         \
    "\n"                                                                    \
    "Several items have to be defined as class attributes in the final"     \
    " class:\n"                                                             \
    "* pychrysalide.glibext.NamedWidget._name;\n"                           \
    "* pychrysalide.glibext.NamedWidget._long_name;\n"                      \
    "* pychrysalide.glibext.NamedWidget._widget;\n"

    iface->get_name = py_named_widget_get_name_wrapper;
    iface->get_widget = py_named_widget_get_widget_wrapper;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : widget = composant nommé à consulter.                        *
*                lname  = précise s'il s'agit d'une version longue ou non.    *
*                                                                             *
*  Description : Fournit le désignation associée à un composant nommé.        *
*                                                                             *
*  Retour      : Description courante.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static char *py_named_widget_get_name_wrapper(const GNamedWidget *widget, bool lname)
{
    char *result;                           /* Désignation à retourner     */
    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyname;                       /* Nom en objet Python         */
    int ret;                                /* Bilan d'une conversion      */

#define NAMED_WIDGET_NAME_ATTRIB_WRAPPER PYTHON_GETTER_WRAPPER_DEF      \
(                                                                       \
    _name,                                                              \
    "Provide the short name used to describe a named widget.\n"         \
    "\n"                                                                \
    "The result has to be a string."                                    \
)

#define NAMED_WIDGET_LONG_NAME_ATTRIB_WRAPPER PYTHON_GETTER_WRAPPER_DEF \
(                                                                       \
    _long_name,                                                         \
    "Provide the long name used to describe a named widget.\n"          \
    "\n"                                                                \
    "The result has to be a string."                                    \
)

    result = NULL;

    gstate = PyGILState_Ensure();

    pyobj = pygobject_new(G_OBJECT(widget));

    if (PyObject_HasAttrString(pyobj, lname ? "_name" : "_long_name"))
    {
        pyname = PyObject_GetAttrString(pyobj, lname ? "_name" : "_long_name");

        if (pyname != NULL)
        {
            ret = PyUnicode_Check(pyname);

            if (ret)
                result = strdup(PyUnicode_AsUTF8(pyname));

            Py_DECREF(pyname);

        }

    }

    Py_DECREF(pyobj);

    PyGILState_Release(gstate);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : widget = composant nommé à consulter.                        *
*                                                                             *
*  Description : Fournit le composant associé à un composant nommé.           *
*                                                                             *
*  Retour      : Composant graphique GTK.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GtkWidget *py_named_widget_get_widget_wrapper(const GNamedWidget *widget)
{
    GtkWidget *result;                      /* Composant GTK à renvoyer    */
    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pywidget;                     /* Composant en objet Python   */
    PyObject *gtk_mod;                      /* Module Python Gtk           */
    PyObject *type;                         /* Module "GtkWidget"          */
    int ret;                                /* Bilan d'une conversion      */

#define NAMED_WIDGET_WIDGET_ATTRIB_WRAPPER PYTHON_GETTER_WRAPPER_DEF    \
(                                                                       \
    _widget,                                                            \
    "Provide the internal widget usable for a named widget.\n"          \
    "\n"                                                                \
    "The result has to be a GTK.Widget instance."                       \
)

    result = NULL;

    gstate = PyGILState_Ensure();

    pyobj = pygobject_new(G_OBJECT(widget));

    if (PyObject_HasAttrString(pyobj, "_widget"))
    {
        pywidget = PyObject_GetAttrString(pyobj, "_widget");

        if (pywidget != NULL)
        {
            gtk_mod = PyImport_ImportModule("gi.repository.Gtk");

            if (gtk_mod == NULL)
            {
                PyErr_SetString(PyExc_TypeError, "unable to find the Gtk Python module");
                goto exit;
            }

            type = PyObject_GetAttrString(gtk_mod, "Widget");

            Py_DECREF(gtk_mod);

            ret = PyObject_TypeCheck(pywidget, (PyTypeObject *)type);

            Py_DECREF(type);

            if (ret)
                result = GTK_WIDGET(pygobject_get(pywidget));

            Py_DECREF(pywidget);

        }

    }

 exit:

    Py_DECREF(pyobj);

    PyGILState_Release(gstate);

    return result;

}



/* ---------------------------------------------------------------------------------- */
/*                           CONNEXION AVEC L'API DE PYTHON                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = classe représentant un composant nommé à manipuler.*
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le désignation associée à un composant nommé.        *
*                                                                             *
*  Retour      : Description courante.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_named_widget_get_name(PyObject *self, void *closure)
{
    PyObject *result;                       /* Décompte à retourner        */
    GNamedWidget *widget;                   /* Version native              */
    char *name;                             /* Désignation à convertir     */

#define NAMED_WIDGET_NAME_ATTRIB PYTHON_GET_DEF_FULL    \
(                                                       \
    name, py_named_widget,                              \
    "Short name used to describe a named widget.\n"     \
    "\n"                                                \
    "The result has to be a string."                    \
)

    widget = G_NAMED_WIDGET(pygobject_get(self));

    name = g_named_widget_get_name(widget, false);

    if (name == NULL)
    {
        result = Py_None;
        Py_INCREF(result);
    }
    else
    {
        result = PyUnicode_FromString(name);
        free(name);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = classe représentant un composant nommé à manipuler.*
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le désignation associée à un composant nommé.        *
*                                                                             *
*  Retour      : Description courante.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_named_widget_get_long_name(PyObject *self, void *closure)
{
    PyObject *result;                       /* Décompte à retourner        */
    GNamedWidget *widget;                   /* Version native              */
    char *name;                             /* Désignation à convertir     */

#define NAMED_WIDGET_LONG_NAME_ATTRIB PYTHON_GET_DEF_FULL   \
(                                                           \
    long_name, py_named_widget,                             \
    "Long name used to describe a named widget.\n"          \
    "\n"                                                    \
    "The result has to be a string."                        \
)

    widget = G_NAMED_WIDGET(pygobject_get(self));

    name = g_named_widget_get_name(widget, true);

    if (name == NULL)
    {
        result = Py_None;
        Py_INCREF(result);
    }
    else
    {
        result = PyUnicode_FromString(name);
        free(name);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = classe représentant un composant nommé à manipuler.*
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le composant associé à un composant nommé.           *
*                                                                             *
*  Retour      : Composant graphique GTK.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_named_widget_get_widget(PyObject *self, void *closure)
{
    PyObject *result;                       /* Décompte à retourner        */
    GNamedWidget *widget;                   /* Version native              */
    GtkWidget *instance;                    /* Composant interne natif     */

#define NAMED_WIDGET_WIDGET_ATTRIB PYTHON_GET_DEF_FULL  \
(                                                       \
    widget, py_named_widget,                            \
    "Internal widget usable for a named widget.\n"      \
    "\n"                                                \
    "The result has to be a GTK *widget*."              \
)

    widget = G_NAMED_WIDGET(pygobject_get(self));

    instance = g_named_widget_get_widget(widget);

    result = pygobject_new(G_OBJECT(instance));

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

    static PyGetSetDef py_named_widget_getseters[] = {
        NAMED_WIDGET_NAME_ATTRIB_WRAPPER,
        NAMED_WIDGET_LONG_NAME_ATTRIB_WRAPPER,
        NAMED_WIDGET_WIDGET_ATTRIB_WRAPPER,
        NAMED_WIDGET_NAME_ATTRIB,
        NAMED_WIDGET_LONG_NAME_ATTRIB,
        NAMED_WIDGET_WIDGET_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_named_widget_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.glibext.NamedWidget",
        .tp_basicsize   = sizeof(PyObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = NAMED_WIDGET_DOC,

        .tp_methods     = py_named_widget_methods,
        .tp_getset      = py_named_widget_getseters,

    };

    return &py_named_widget_type;

}


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

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

    static GInterfaceInfo info = {          /* Paramètres d'inscription    */

        .interface_init = (GInterfaceInitFunc)py_named_widget_interface_init,
        .interface_finalize = NULL,
        .interface_data = NULL,

    };

    type = get_python_named_widget_type();

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

        dict = PyModule_GetDict(module);

        if (!register_interface_for_pygobject(dict, G_TYPE_NAMED_WIDGET, type, &info))
            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 composant nommé.                       *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_named_widget_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 named widget");
            break;

        case 1:
            *((GNamedWidget **)dst) = G_NAMED_WIDGET(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}