summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/core/formats.c
blob: f11bb46b3afe46640ed31a221e0425194dcbde38 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * formats.c - équivalent Python du fichier "core/formats.c"
 *
 * Copyright (C) 2015-2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Chrysalide is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "formats.h"


#include <pygobject.h>


#include <core/formats.h>


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



/* Fournit le nom humain du format binaire visé. */
static PyObject *py_formats_get_binary_format_name(PyObject *, PyObject *);

/* Définit les constantes pour les paramètres. */
static bool py_formats_define_constants(PyTypeObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Fournit le nom humain du format binaire visé.                *
*                                                                             *
*  Retour      : Désignation humaine trouvée ou None.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_formats_get_binary_format_name(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Désignation à retourner     */
    const char *key;                        /* Nom court du format         */
    int ret;                                /* Bilan de lecture des args.  */
    const char *name;                       /* Désignation humaine         */

    ret = PyArg_ParseTuple(args, "s", &key);
    if (!ret) return NULL;

    name = get_binary_format_name(key);

    if (name != NULL)
        result = PyUnicode_FromString(name);

    else
    {
        result = Py_None;
        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_formats_type(void)
{
    static PyMethodDef py_formats_methods[] = {

        { "get_binary_format_name", py_formats_get_binary_format_name,
          METH_VARARGS | METH_STATIC,
          "get_binary_format_name(key, /)\n--\n\nGive access to the main configuration of Chrysalide."
        },
        { NULL }

    };

    static PyTypeObject py_formats_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name = "pychrysalide.core.formats",
        .tp_basicsize = sizeof(PyObject),

        .tp_flags = Py_TPFLAGS_DEFAULT,

        .tp_doc = "Access to the code formats",

        .tp_methods = py_formats_methods

    };

    return &py_formats_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : obj_type = type dont le dictionnaire est à compléter.        *
*                                                                             *
*  Description : Définit les constantes pour les paramètres.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_formats_define_constants(PyTypeObject *obj_type)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    result &= PyDict_AddIntMacro(obj_type, FMS_MATCHED);
    result &= PyDict_AddIntMacro(obj_type, FMS_FORWARDED);
    result &= PyDict_AddIntMacro(obj_type, FMS_UNKNOWN);

    result &= PyDict_AddIntMacro(obj_type, FMS_COUNT);

    return result;

}


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

bool ensure_python_formats_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python pour 'formats'  */
    PyObject *module;                       /* Module à recompléter        */
    int ret;                                /* Bilan d'un appel            */

    type = get_python_formats_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        type->tp_new = PyType_GenericNew;

        if (PyType_Ready(type) != 0)
            return false;

        if (!py_formats_define_constants(type))
            return false;

        module = get_access_to_python_module("pychrysalide.core");

        Py_INCREF(type);
        ret = PyModule_AddObject(module, "formats", (PyObject *)type);

        if (ret != 0)
            return false;

    }

    return true;

}