summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/common/pathname.c
blob: c83c27dbb35bb5cb61e690fbdee3af8b2c528605 (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

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


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


#include <i18n.h>


#include <common/pathname.h>


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



#define PYTHON_PATHNAME_DOC                                 \
    "Path manipulations in Python for Chrysalide.\n"        \
    "\n"                                                    \
    "There is no constructor for this class: its methods"   \
    " are static methods only."


/* Calcule le chemin relatif entre deux fichiers donnés. */
static PyObject *py_build_relative_filename(PyObject *, PyObject *);

/* Calcule le chemin absolu d'un fichier par rapport à un autre. */
static PyObject *py_build_absolute_filename(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = arguments fournis lors de l'appel à la fonction.      *
*                                                                             *
*  Description : Calcule le chemin relatif entre deux fichiers donnés.        *
*                                                                             *
*  Retour      : Chemin relatif obtenu.                                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_build_relative_filename(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Instance à retourner        */
    const char *ref;                        /* Fichier de référence        */
    const char *target;                     /* Fichier à cibler            */
    int ret;                                /* Bilan de lecture des args.  */
    char *relative;                         /* Chemin d'accès construit    */

#define BUILD_RELATIVE_FILENAME_METHOD PYTHON_METHOD_DEF    \
(                                                           \
    build_relative_filename, "ref, target",                 \
    METH_VARARGS | METH_STATIC, py,                         \
    "Compute the relative path between two files.\n"        \
    "\n"                                                    \
    "Both arguments must be strings."                       \
)

    ret = PyArg_ParseTuple(args, "ss", &ref, &target);
    if (!ret) return NULL;

    relative = build_relative_filename(ref, target);

    result = PyUnicode_FromString(relative);

    free(relative);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = arguments fournis lors de l'appel à la fonction.      *
*                                                                             *
*  Description : Calcule le chemin absolu d'un fichier par rapport à un autre.*
*                                                                             *
*  Retour      : Chemin absolu obtenu.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_build_absolute_filename(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Instance à retourner        */
    const char *ref;                        /* Fichier de référence        */
    const char *target;                     /* Fichier à cibler            */
    int ret;                                /* Bilan de lecture des args.  */
    char *relative;                         /* Chemin d'accès construit    */

#define BUILD_ABSOLUTE_FILENAME_METHOD PYTHON_METHOD_DEF    \
(                                                           \
    build_absolute_filename, "ref, target",                 \
    METH_VARARGS | METH_STATIC, py,                         \
    "Compute the absolute path for a file.\n"               \
    "\n"                                                    \
    "Both arguments must be strings."                       \
)

    ret = PyArg_ParseTuple(args, "ss", &ref, &target);
    if (!ret) return NULL;

    relative = build_absolute_filename(ref, target);

    if (relative == NULL)
    {
        PyErr_SetString(PyExc_ValueError, _("Relative path is too deep."));
        result = NULL;
    }
    else
    {
        result = PyUnicode_FromString(relative);
        free(relative);
    }

    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_pathname_type(void)
{
    static PyMethodDef py_pathname_methods[] = {
        BUILD_RELATIVE_FILENAME_METHOD,
        BUILD_ABSOLUTE_FILENAME_METHOD,
        { NULL }
    };

    static PyTypeObject py_pathname_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.common.pathname",
        .tp_basicsize   = sizeof(PyObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = PYTHON_PATHNAME_DOC,

        .tp_methods     =  py_pathname_methods,

        .tp_new         = no_python_constructor_allowed,

    };

    return &py_pathname_type;

}


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

bool ensure_python_pathname_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python pour 'pathname' */
    PyObject *module;                       /* Module à recompléter        */

    type = get_python_pathname_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        if (PyType_Ready(type) != 0)
            return false;

        module = get_access_to_python_module("pychrysalide.common");

        if (!register_python_module_object(module, type))
            return false;

    }

    return true;

}