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

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


#include <pygobject.h>


#include <common/fnv1a.h>


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



#define FNV1A_DOC                                           \
    "Python version for Chrysalide of the Fowler-Noll-Vo"   \
    " hash function.\n"                                     \
    "\n"                                                    \
    "There is no constructor for this class: its methods"   \
    " are static methods only."


/* Détermine l'empreinte FNV1a d'une chaîne de caractères. */
static PyObject *py_fnv1a_hash(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = arguments fournis lors de l'appel à la fonction.      *
*                                                                             *
*  Description : Détermine l'empreinte FNV1a d'une chaîne de caractères.      *
*                                                                             *
*  Retour      : Numéro de révision.                                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_fnv1a_hash(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Instance à retourner        */
    const char *str;                        /* Chaîne à traiter.           */
    int ret;                                /* Bilan de lecture des args.  */
    fnv64_t value;                          /* Empreinte calculée          */

#define FNV1A_HASH_METHOD PYTHON_METHOD_DEF                 \
(                                                           \
    hash, "str, /",                                         \
    METH_VARARGS | METH_STATIC, py_fnv1a,                   \
    "Compute the FNV-1a hash from a given string."          \
)

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

    value = fnv_64a_hash(str);

    result = Py_BuildValue("K", (unsigned long long)value);

    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_fnv1a_type(void)
{
    static PyMethodDef py_fnv1a_methods[] = {
        FNV1A_HASH_METHOD,
        { NULL }
    };

    static PyTypeObject py_fnv1a_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

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

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = FNV1A_DOC,

        .tp_methods     = py_fnv1a_methods,

        .tp_new         = no_python_constructor_allowed,

    };

    return &py_fnv1a_type;

}


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

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

    type = get_python_fnv1a_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;

}