summaryrefslogtreecommitdiff
path: root/plugins/pychrysa/analysis/db/items/comment.c
blob: 1bb286300b56d13b8dfd2fff2c4ce34cd40e50a3 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * comment.c - équivalent Python du fichier "analysis/db/items/comment.c"
 *
 * Copyright (C) 2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA 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.
 *
 *  OpenIDA 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 "comment.h"


#include <pygobject.h>


#include <i18n.h>
#include <analysis/db/items/comment.h>


#include "../item.h"
#include "../../../arch/vmpa.h"



/* Crée un nouvel objet Python de type 'DbComment'. */
static PyObject *py_db_comment_new(PyTypeObject *, PyObject *, PyObject *);

/* Fournit le commentaire associé à un commentaire. */
static PyObject *py_db_comment_get_text(PyObject *, void *);

/* Définit le commentaire associé à un commentaire. */
static int py_db_comment_set_text(PyObject *, PyObject *, void *);



/******************************************************************************
*                                                                             *
*  Paramètres  : type = type de l'objet à instancier.                         *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Crée un nouvel objet Python de type 'DbComment'.             *
*                                                                             *
*  Retour      : Instance Python mise en place.                               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_db_comment_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Instance à retourner        */
    PyObject *py_vmpa;                      /* Localisation version Python */
    char *text;                             /* Texte à associer            */
    int is_volatile;                        /* Conservation en mémoire     */
    int ret;                                /* Bilan de lecture des args.  */
    vmpa2t *addr;                           /* Localisation version C      */
    GDbComment *comment;                    /* Version GLib du commentaire */

    ret = PyArg_ParseTuple(args, "Osp", &py_vmpa, &text, &is_volatile);
    if (!ret) Py_RETURN_NONE;

    addr = get_internal_vmpa(py_vmpa);
    if (py_vmpa == NULL) Py_RETURN_NONE;

    comment = g_db_comment_new(addr, text, is_volatile);

    result = pygobject_new(G_OBJECT(comment));
    g_object_unref(comment);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le commentaire associé à un commentaire.             *
*                                                                             *
*  Retour      : Texte manipulable en Python.                                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_db_comment_get_text(PyObject *self, void *closure)
{
    GDbComment *comment;                    /* Commentaire à consulter     */
    const char *content;                    /* Contenu textuel associé     */

    comment = G_DB_COMMENT(pygobject_get(self));
    content = g_db_comment_get_text(comment);

    return PyUnicode_FromString(content);

}


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

static int py_db_comment_set_text(PyObject *self, PyObject *value, void *closure)
{
    GDbComment *comment;                    /* Commentaire à consulter     */

    if (!PyUnicode_Check(value))
    {
        PyErr_SetString(PyExc_TypeError, _("The attribute value must be a string."));
        return -1;
    }

    comment = G_DB_COMMENT(pygobject_get(self));
    g_db_comment_set_text(comment, PyUnicode_DATA(value));

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_db_comment_type(void)
{
    static PyMethodDef py_db_comment_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_db_comment_getseters[] = {
        {
            "text", py_db_comment_get_text, py_db_comment_set_text,
            "Give access to the content of a given comment.", NULL
        },
        { NULL }
    };

    static PyTypeObject py_db_comment_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.db.items.DbComment",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = "PyChrysalide comment for edited binary",

        .tp_methods     = py_db_comment_methods,
        .tp_getset      = py_db_comment_getseters,
        .tp_new         = (newfunc)py_db_comment_new

    };

    return &py_db_comment_type;

}


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

bool register_python_db_comment(PyObject *module)
{
    PyTypeObject *py_db_comment_type;      /* Type Python 'DbComment'      */
    int ret;                                /* Bilan d'un appel            */
    PyObject *dict;                         /* Dictionnaire du module      */

    py_db_comment_type = get_python_db_comment_type();

    py_db_comment_type->tp_base = get_python_db_item_type();
    py_db_comment_type->tp_basicsize = py_db_comment_type->tp_base->tp_basicsize;

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

    Py_INCREF(py_db_comment_type);
    ret = PyModule_AddObject(module, "DbComment", (PyObject *)py_db_comment_type);
    if (ret != 0) return false;

    dict = PyModule_GetDict(module);
    pygobject_register_class(dict, "DbComment", G_TYPE_DB_COMMENT, py_db_comment_type,
                             Py_BuildValue("(O)", py_db_comment_type->tp_base));

    return true;

}