summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/mangling/demangler.c
blob: 577969339f6bcb7b715e5b5269d8f6b43da8aaf5 (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

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


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


#include <mangling/demangler.h>


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



#define COMPILER_DEMANGLER_DOC                                  \
    "CompDemangler is an abstract class for demangling names."



/* Fournit la désignation interne du décodeur de désignations. */
static PyObject *py_compiler_demangler_get_key(PyObject *, void *);

/* Tente de décoder une chaîne de caractères donnée en type. */
static PyObject *py_compiler_demangler_decode_type(PyObject *, PyObject *);

/* Tente de décoder une chaîne de caractères donnée en routine. */
static PyObject *py_compiler_demangler_decode_routine(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la désignation interne du décodeur de désignations.  *
*                                                                             *
*  Retour      : Simple chaîne de caractères.                                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_compiler_demangler_get_key(PyObject *self, void *closure)
{
    PyObject *result;                       /* Instance Python à retourner */
    GCompDemangler *demangler;              /* Version GLib de l'opérande  */
    char *key;                              /* Désignation du décodeur     */

#define COMPILER_DEMANGLER_KEY_ATTRIB PYTHON_GET_DEF_FULL       \
(                                                               \
    key, py_compiler_demangler,                                 \
    "Provide the small name used to identify the demangler,"    \
    " as a code string."                                        \
)

    demangler = G_COMP_DEMANGLER(pygobject_get(self));
    assert(demangler != NULL);

    key = g_compiler_demangler_get_key(demangler);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = décodeur à solliciter pour l'opération.               *
*                args = chaîne de caractères à décoder.                       *
*                                                                             *
*  Description : Tente de décoder une chaîne de caractères donnée en type.    *
*                                                                             *
*  Retour      : Instance obtenue ou None en cas d'échec.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_compiler_demangler_decode_type(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Désignation à retourner     */
    const char *desc;                       /* Description à traiter       */
    int ret;                                /* Bilan de lecture des args.  */
    GCompDemangler *demangler;              /* Décodeur mis en place       */
    GDataType *type;                        /* Type de données obtenu      */

#define COMPILER_DEMANGLER_DECODED_TYPE_METHOD PYTHON_METHOD_DEF        \
(                                                                       \
    decode_type, "$self, desc, /",                                      \
    METH_VARARGS, py_compiler_demangler,                                \
    "Demangle a type definition from its string mangled description.\n" \
    "\n"                                                                \
    "The result is an instance of type pychrysalide.analysis.DataType"  \
    " on success, None otherwise."                                      \
)

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

    demangler = G_COMP_DEMANGLER(pygobject_get(self));

    type = g_compiler_demangler_decode_type(demangler, desc);

    if (type != NULL)
    {
        result = pygobject_new(G_OBJECT(type));
        Py_INCREF(result);

        g_object_unref(G_OBJECT(type));

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = décodeur à solliciter pour l'opération.               *
*                args = chaîne de caractères à décoder.                       *
*                                                                             *
*  Description : Tente de décoder une chaîne de caractères donnée en routine. *
*                                                                             *
*  Retour      : Instance obtenue ou None en cas d'échec.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_compiler_demangler_decode_routine(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Désignation à retourner     */
    const char *desc;                       /* Description à traiter       */
    int ret;                                /* Bilan de lecture des args.  */
    GCompDemangler *demangler;              /* Décodeur mis en place       */
    GBinRoutine *routine;                   /* Routine obtenue             */

#define COMPILER_DEMANGLER_DECODED_ROUTINE_METHOD PYTHON_METHOD_DEF         \
(                                                                           \
    decode_routine, "$self, desc, /",                                       \
    METH_VARARGS, py_compiler_demangler,                                    \
    "Demangle a routine definition from its string mangled description.\n"  \
    "\n"                                                                    \
    "The result is an instance of type pychrysalide.analysis.BinRoutine"    \
    " on success, None otherwise."                                          \
)

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

    demangler = G_COMP_DEMANGLER(pygobject_get(self));

    routine = g_compiler_demangler_decode_routine(demangler, desc);

    if (routine != NULL)
    {
        result = pygobject_new(G_OBJECT(routine));
        Py_INCREF(result);

        g_object_unref(G_OBJECT(routine));

    }
    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_compiler_demangler_type(void)
{
    static PyMethodDef py_comp_demangler_methods[] = {
        COMPILER_DEMANGLER_DECODED_TYPE_METHOD,
        COMPILER_DEMANGLER_DECODED_ROUTINE_METHOD,
        { NULL }
    };

    static PyGetSetDef py_comp_demangler_getseters[] = {
        COMPILER_DEMANGLER_KEY_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_comp_demangler_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.mangling.CompDemangler",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = COMPILER_DEMANGLER_DOC,

        .tp_methods     = py_comp_demangler_methods,
        .tp_getset      = py_comp_demangler_getseters,

    };

    return &py_comp_demangler_type;

}


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

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

    type = get_python_compiler_demangler_type();

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

        dict = PyModule_GetDict(module);

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

    }

    return true;

}