/* Chrysalide - Outil d'analyse de fichiers binaires
* helpers.c - simplification des interactions de base avec Python
*
* Copyright (C) 2012-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 Chrysalide. If not, see .
*/
#include "helpers.h"
#include
#include
#include
#include
#include
#include
#include
#include "access.h"
#include "constval.h"
/* ---------------------------- MISE EN PLACE DE MODULES ---------------------------- */
/* Ajoute une classe dans les fonctionnalités globales. */
static bool include_python_type_into_features(PyObject *, PyTypeObject *);
/* ---------------------------------------------------------------------------------- */
/* ACCELERATEURS POUR PYTHON UNIQUEMENT */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : status = bilan de comparaison à traduire. *
* op = type de comparaison menée. *
* *
* Description : Traduit pour Python le bilan d'une comparaison riche. *
* *
* Retour : Objet Python à référencer. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *status_to_rich_cmp_state(int status, int op)
{
PyObject *result; /* Bilan àretourner */
switch (op)
{
case Py_LT:
result = status < 0 ? Py_True : Py_False;
break;
case Py_LE:
result = status <= 0 ? Py_True : Py_False;
break;
case Py_EQ:
result = status == 0 ? Py_True : Py_False;
break;
case Py_NE:
result = status != 0 ? Py_True : Py_False;
break;
case Py_GT:
result = status > 0 ? Py_True : Py_False;
break;
case Py_GE:
result = status >= 0 ? Py_True : Py_False;
break;
default:
result = Py_NotImplemented;
break;
}
return result;
}
/******************************************************************************
* *
* Paramètres : target = propriétaire de la routine visée. *
* method = désignation de la fonction à appeler. *
* *
* Description : Indique si une routine Python existe ou non. *
* *
* Retour : Bilan de l'analyse. *
* *
* Remarques : - *
* *
******************************************************************************/
bool has_python_method(PyObject *module, const char *method)
{
bool result; /* Bilan à retourner */
PyObject *func; /* Fonction visée */
result = (PyObject_HasAttrString(module, method) == 1);
if (result)
{
func = PyObject_GetAttrString(module, method);
assert(func != NULL);
result = PyCallable_Check(func);
Py_DECREF(func);
}
return result;
}
/******************************************************************************
* *
* Paramètres : func = fonction Python à appeler. *
* args = arguments à associer à l'opération. *
* *
* Description : Appelle une routine Python. *
* *
* Retour : Retour obtenu ou NULL si erreur. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *_run_python_method(PyObject *func, PyObject *args)
{
PyObject *result; /* Bilan à retourner */
result = NULL;
if (PyCallable_Check(func))
{
result = PyObject_CallObject(func, args);
if (result == NULL) PyErr_Print();
}
else if (PyErr_Occurred()) PyErr_Print();
return result;
}
/******************************************************************************
* *
* Paramètres : target = propriétaire de la routine visée. *
* method = désignation de la fonction à appeler. *
* args = arguments à associer à l'opération. *
* *
* Description : Appelle une routine Python. *
* *
* Retour : Retour obtenu ou NULL si erreur. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *run_python_method(PyObject *module, const char *method, PyObject *args)
{
PyObject *result; /* Bilan à retourner */
PyObject *func; /* Fonction visée */
result = NULL;
func = PyObject_GetAttrString(module, method);
if (func == NULL) return NULL;
result = _run_python_method(func, args);
Py_DECREF(func);
return result;
}
/******************************************************************************
* *
* Paramètres : dict = dictionnaire à compléter. *
* key = désignation de la constante à intégrer. *
* value = valeur de la constante à intégrer. *
* *
* Description : Ajoute une constante au dictionnaire d'un type Python donné. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool PyDict_AddULongConstant(PyObject *dict, const char *key, unsigned long value)
{
bool result; /* Bilan à retourner */
PyObject *item; /* Nouvel élément à insérer */
int ret; /* Bilan d'un ajout */
item = build_constval_from_c_code(key, value);
ret = PyDict_SetItemString(dict, key, item);
result = (ret != -1);
Py_DECREF(item);
return result;
}
/******************************************************************************
* *
* Paramètres : dict = dictionnaire à compléter. *
* key = désignation de la constante à intégrer. *
* value = valeur de la constante à intégrer. *
* *
* Description : Ajoute une constante au dictionnaire d'un type Python donné. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool PyDict_AddStringConstant(PyObject *dict, const char *key, const char *value)
{
bool result; /* Bilan à retourner */
PyObject *item; /* Nouvel élément à insérer */
int ret; /* Bilan d'un ajout */
item = PyUnicode_FromString(value);
ret = PyDict_SetItemString(dict, key, item);
result = (ret != -1);
Py_DECREF(item);
return result;
}
/* ---------------------------------------------------------------------------------- */
/* MISE EN PLACE DE MODULES */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : super = module dont la définition est à compléter. *
* def = définition du module à créer. *
* *
* Description : Met en place un nouveau module Python. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *build_python_module(PyObject *super, PyModuleDef *def)
{
PyObject *result; /* Création à retourner */
int ret; /* Bilan d'un appel */
char *dot; /* Dernier point de ce chemin */
result = PyModule_Create(def);
if (result == NULL) goto quick_bad_exit;
ret = PyState_AddModule(super, def);
if (ret != 0) goto bad_exit;
ret = _PyImport_FixupBuiltin(result, def->m_name);
if (ret != 0) goto bad_exit;
dot = strrchr(def->m_name, '.');
assert(dot != NULL);
Py_INCREF(result);
ret = PyModule_AddObject(super, dot + 1, result);
if (ret != 0)
{
Py_DECREF(result);
goto bad_exit;
}
register_access_to_python_module(def->m_name, result);
return result;
bad_exit:
Py_DECREF(result);
quick_bad_exit:
assert(false);
return false;
}
/******************************************************************************
* *
* Paramètres : module = module dont la définition est à compléter. *
* defs = définitions de méthodes pour module. *
* *
* Description : Met en place une série de méthodes pour un module Python. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool register_python_module_methods(PyObject *module, PyMethodDef *defs)
{
bool result; /* Bilan à retourner */
int ret; /* Bilan d'un appel */
PyMethodDef *iter; /* Boucle de parcours */
PyObject *features; /* Module à recompléter */
PyObject *features_dict; /* Dictionnaire à compléter */
PyObject *mod_dict; /* Dictionnaire à consulter */
PyObject *item; /* Nouvel élément à exporter */
ret = PyModule_AddFunctions(module, defs);
result = (ret == 0);
if (result)
{
features = get_access_to_python_module("pychrysalide.features");
features_dict = PyModule_GetDict(features);
mod_dict = PyModule_GetDict(module);
for (iter = defs; iter->ml_name != NULL && result; iter++)
{
item = PyDict_GetItemString(mod_dict, iter->ml_name);
result = (item != NULL);
assert(result);
if (result)
{
ret = PyDict_SetItemString(features_dict, iter->ml_name, item);
result = (ret == 0);
assert(result);
}
}
}
return result;
}
/******************************************************************************
* *
* Paramètres : dict = dictionnaire où conserver une référence au type créé. *
* type = type dans sa version Python. *
* *
* Description : Ajoute une classe dans les fonctionnalités globales. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool include_python_type_into_features(PyObject *dict, PyTypeObject *type)
{
bool result; /* Bilan à retourner */
PyObject *features; /* Module à recompléter */
PyObject *features_dict; /* Dictionnaire à compléter */
char *name; /* Désignation de la classe */
PyObject *item; /* Nouvel élément à exporter */
int ret; /* Bilan d'une insertion */
features = get_access_to_python_module("pychrysalide.features");
features_dict = PyModule_GetDict(features);
name = strrchr(type->tp_name, '.');
assert(name != NULL);
name++;
item = PyDict_GetItemString(dict, name);
result = (item != NULL);
assert(result);
ret = PyDict_SetItemString(features_dict, name, item);
result = (ret == 0);
assert(result);
return result;
}
/******************************************************************************
* *
* Paramètres : module = module dont la définition est à compléter. *
* type = type à intégrer dans sa version Python. *
* *
* Description : Met en place un objet au sein d'un module Python. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool register_python_module_object(PyObject *module, PyTypeObject *type)
{
bool result; /* Bilan à retourner */
char *name; /* Désignation de la classe */
int ret; /* Bilan d'un appel */
PyObject *dict; /* Dictionnaire du module */
name = strrchr(type->tp_name, '.');
assert(name != NULL);
name++;
Py_INCREF(type);
ret = PyModule_AddObject(module, name, (PyObject *)type);
result = (ret == 0);
if (!result)
Py_DECREF(type);
else
{
dict = PyModule_GetDict(module);
result = include_python_type_into_features(dict, type);
}
return result;
}
/* ---------------------------------------------------------------------------------- */
/* CONFORTS CIBLANT PYGOBJECT */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : self = objet quelconque dont le code Python hérite. *
* args = série d'arguments si présents. *
* *
* Description : Marque l'absence d'implémentation pour une méthode donnée. *
* *
* Retour : NULL pour la levée d'exception. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *not_yet_implemented_method(PyObject *self, PyObject *args)
{
PyObject *result; /* Exception à retourner */
result = NULL;
PyErr_SetString(PyExc_NotImplementedError, _("Implementated method is missing"));
return result;
}
/******************************************************************************
* *
* Paramètres : spec = définition à mettre en place dynamiquement. *
* *
* Description : Définit dans le tas de Python un nouveau type. *
* *
* Retour : Nouveau type prêt à emploi. *
* *
* Remarques : - *
* *
******************************************************************************/
PyTypeObject *define_python_dynamic_type(const PyTypeObject *spec)
{
PyTypeObject *result; /* Définition créée à renvoyer */
PyTypeObject *type; /* Type de tous les types */
size_t size; /* Taille de la définition */
char *s; /* Marqueur de début de chaîne */
PyHeapTypeObject *hobj; /* Version réelle du type créé */
/**
* Le cahier des charges est ici d'éviter les erreurs suivantes :
*
* TypeError: type 'XXX' is not dynamically allocated but its base type 'YYY' is dynamically allocated
* Fatal Python error: unexpected exception during garbage collection
*
* L'allocation dynamique est marquée par le fanion Py_TPFLAGS_HEAPTYPE.
*
* Une des rares fonctions qui appliquent ce fanion est PyType_FromSpecWithBases(),
* mais elle appelle ensuite PyType_Ready(), ce qui est incompatible avec des modifications
* utltérieures avant un appel à pygobject_register_class().
*
* Le code suivant s'inspire fortement des méthodes originales de Python,
* dont les mécanismes employés par PyType_GenericAlloc().
*/
type = &PyType_Type;
size = _PyObject_SIZE(type);
if (PyType_IS_GC(type))
result = (PyTypeObject *)_PyObject_GC_Malloc(size);
else
result = (PyTypeObject *)PyObject_MALLOC(size);
if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Py_INCREF(type);
/* Définitions sommaires */
memset(result, 0, sizeof(PyHeapTypeObject));
memcpy(result, spec, sizeof(PyTypeObject));
result->tp_flags |= Py_TPFLAGS_HEAPTYPE;
/* Définitions des noms */
/**
* Pour un type dynamique, les désignations ne s'appuient pas sur la partie réservée
* au type, mais sur les données suivantes (cf. type_name() et type_qualname()).
*
* Les deux fonctions désignées sont par ailleurs facilement accessibles :
*
* #0 0x0000555555689bf0 in type_qualname (...) at Objects/typeobject.c:393
* #1 0x000055555568b3b4 in type_repr (...) at Objects/typeobject.c:855
* #2 0x0000555555693574 in object_str (...) at Objects/typeobject.c:3511
* #3 0x0000555555670d02 in PyObject_Str (...) at Objects/object.c:535
* ...
*
* On s'inspire donc du contenu de PyType_FromSpecWithBases() pour éviter tout
* plantage du fait de données non initialisées.
*/
hobj = (PyHeapTypeObject *)result;
s = strrchr(spec->tp_name, '.');
if (s == NULL)
s = (char *)spec->tp_name;
else
s++;
hobj->ht_name = PyUnicode_FromString(s);
assert(hobj->ht_name != NULL);
hobj->ht_qualname = hobj->ht_name;
Py_INCREF(hobj->ht_qualname);
result->tp_as_async = &hobj->as_async;
result->tp_as_number = &hobj->as_number;
result->tp_as_sequence = &hobj->as_sequence;
result->tp_as_mapping = &hobj->as_mapping;
result->tp_as_buffer = &hobj->as_buffer;
hobj->ht_cached_keys = _PyDict_NewKeysForClass();
#if 0
if (type->tp_itemsize == 0)
(void)PyObject_INIT(result, type);
else
(void) PyObject_INIT_VAR((PyVarObject *)result, type, 0);
if (PyType_IS_GC(type))
_PyObject_GC_TRACK(result);
#endif
return result;
}
/******************************************************************************
* *
* Paramètres : dict = dictionnaire où conserver une référence au type créé.*
* gtype = type dans sa version GLib. *
* type = type dans sa version Python. *
* base = type de base de l'objet. *
* *
* Description : Enregistre correctement une surcouche de conversion GObject. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool _register_class_for_pygobject(PyObject *dict, GType gtype, PyTypeObject *type, PyTypeObject *base, ...)
{
bool result; /* Bilan à retourner */
Py_ssize_t size; /* Taille de liste actuelle */
PyObject *static_bases; /* Base(s) de l'objet */
va_list ap; /* Parcours des arguments */
PyTypeObject *static_base; /* Base à rajouter à la liste */
/**
* pygobject_register_class() définit type->tp_base à partir des arguments fournis,
* puis fait appel à PyType_Ready().
*
* PyType_Ready() complète la définition via inherit_special() :
*
* type->tp_basicsize = type->tp_base->tp_basicsize
*
* Cependant, il y a un appel à mro_internal() avant, qui mène à solid_base()
* puis à extra_ivars(). Et là :
*
* size_t t_size = type->tp_basicsize;
* size_t b_size = base->tp_basicsize;
*
* assert(t_size >= b_size);
*
* Si le type de base est spécifié, une taille doit être indiquée.
*
* Et quelqu'un doit se coller à la tâche. PyGObject ne fait rien, donc...
*/
if (type->tp_basicsize < base->tp_basicsize)
{
assert(type->tp_basicsize == 0);
type->tp_basicsize = base->tp_basicsize;
}
size = 1;
static_bases = PyTuple_New(size);
Py_INCREF(base);
PyTuple_SetItem(static_bases, 0, (PyObject *)base);
va_start(ap, base);
while (1)
{
static_base = va_arg(ap, PyTypeObject *);
if (static_base == NULL) break;
_PyTuple_Resize(&static_bases, ++size);
Py_INCREF(static_base);
PyTuple_SetItem(static_bases, size - 1, (PyObject *)static_base);
}
va_end(ap);
/**
* les renseignements suivants ne semblent pas nécessaires...
*/
/*
type->tp_weaklistoffset = offsetof(PyGObject, weakreflist);
type->tp_dictoffset = offsetof(PyGObject, inst_dict);
*/
pygobject_register_class(dict, NULL, gtype, type, static_bases);
if (PyErr_Occurred() == NULL)
result = true;
else
{
PyErr_Print();
result = false;
}
assert(PyErr_Occurred() == NULL);
/**
* Création d'un dictionnaire complet pour la simulation d'un "import *".
*/
if (result && startswith(type->tp_name, "pychrysalide."))
result = include_python_type_into_features(dict, type);
return result;
}
/******************************************************************************
* *
* Paramètres : dict = dictionnaire où conserver une référence au type créé.*
* gtype = type dans sa version GLib. *
* type = type dans sa version Python. *
* base = type de base de l'objet. *
* *
* Description : Enregistre un type Python dérivant d'un type GLib dynamique. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool register_class_for_dynamic_pygobject(GType gtype, PyTypeObject *type, PyTypeObject *base)
{
bool result; /* Bilan à retourner */
PyTypeObject *legacy_parent; /* Type parent d'origine */
PyObject *sys_mod_dict; /* Dictionnaire des modules */
PyObject *modname; /* Nom du module du type */
PyObject *module; /* Module à recompléter */
PyObject *dict; /* Dictionnaire dudit module */
/**
* Lors de l'appel à pygobject_register_class(), PyGObject remplace systématiquement
* le type Python fourni par :
*
* Py_TYPE(type) = PyGObject_MetaType;
*
* Ce nouveau type est le suivant (cf. gi/types.py) :
*
* class _GObjectMetaBase(type):
* """Metaclass for automatically registering GObject classes."""
*
* D'une part, comme les enregistrements sont gérés manuellement dans le cas de
* types dérivés dynamiquement d'objets natifs, ce changement est inutile.
*
* D'autre part, il semble avoir un soucis de références (cf. testGarbageCollecting()
* du fichier de test plugins/plugin.py) :
*
* python3dm: ../Modules/gcmodule.c:379: visit_decref: Assertion `_PyGCHead_REFS(gc) != 0' failed.
*
* #3 __GI___assert_fail ()
* #4 visit_decref ()
* #5 subtype_traverse ()
* #6 subtract_refs ()
* #7 collect ()
* #8 collect_with_callback ()
* #9 gc_collect ()
*
* On restaure donc le type d'origine de l'objet Python créé dynamquement pour éviter
* ce genre de soucis.
*/
legacy_parent = Py_TYPE(type);
sys_mod_dict = PyImport_GetModuleDict();
modname = PyDict_GetItemString(type->tp_dict, "__module__");
module = PyObject_GetItem(sys_mod_dict, modname);
dict = PyModule_GetDict(module);
result = _register_class_for_pygobject(dict, gtype, type, &PyGObject_Type, base, NULL);
Py_TYPE(type) = legacy_parent;
return result;
}