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


#include <pygobject.h>


#include <i18n.h>
#include <glibext/objhole-int.h>


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



CREATE_DYN_CONSTRUCTOR(thick_object, G_TYPE_THICK_OBJECT);


/* Initialise une instance sur la base du dérivé de GObject. */
static int py_thick_object_init(PyObject *, PyObject *, PyObject *);

/* Indique le nombre de bits accaparés par la GLib. */
static PyObject *py_thick_object_get__GOBJECT_RESERVED_EXTRA_BITS(PyObject *, void *);

/* Fournit la valeur courante de la zone de stockage d'un objet. */
static PyObject *py_thick_object_get_extra(PyObject *, void *);

/* Définit la valeur courante de la zone de stockage d'un objet. */
static int py_thick_object_set_extra(PyObject *, PyObject *, void *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet à initialiser (théoriquement).                  *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Initialise une instance sur la base du dérivé de GObject.    *
*                                                                             *
*  Retour      : 0.                                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_thick_object_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    int ret;                                /* Bilan de lecture des args.  */

#define THICK_OBJECT_DOC                                                    \
    "The ThickObject class is an alternative version of the GObject class." \
    " It provides an access to a 32-bit wide memory hole inside the native" \
    " GObject structure in order to exploit the area as various values"     \
    " storage.\n"                                                           \
    "\n"                                                                    \
    "Instances can be created using the following constructor:\n"           \
    "\n"                                                                    \
    "    ThickObject()"

    /* Initialisation d'un objet GLib */

    ret = forward_pygobjet_init(self);
    if (ret == -1) return -1;

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique le nombre de bits accaparés par la GLib.             *
*                                                                             *
*  Retour      : Nombre de bits, à priori inférieur à 32.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_thick_object_get__GOBJECT_RESERVED_EXTRA_BITS(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */

#define THICK_OBJECT__GOBJECT_RESERVED_EXTRA_BITS_ATTRIB PYTHON_GET_DEF_FULL    \
(                                                                               \
    _GOBJECT_RESERVED_EXTRA_BITS, py_thick_object,                              \
    "Quantity of lower bits used by the GLib inside the memory hole.\n"         \
    "\n"                                                                        \
    "The returned value should be less then 32 and is provided for"             \
    " pychrysalide.glibext.ThickObject subclass implementation."                \
)

    result = PyLong_FromUnsignedLong(GOBJECT_RESERVED_EXTRA_BITS);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la valeur courante de la zone de stockage d'un objet.*
*                                                                             *
*  Retour      : Valeur de 32 lues et expurgées des bits GLib.                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_thick_object_get_extra(PyObject *self, void *closure)
{
    PyObject *result;                       /* Résultat à retourner        */
    GThickObject *obj;                      /* Version GLib de l'instance  */
    guint extra;                            /* Valeur à transmettre        */

#define THICK_OBJECT_EXTRA_ATTRIB PYTHON_GETSET_DEF_FULL            \
(                                                                   \
    extra, py_thick_object,                                         \
    "Data stored inside the structure memory hole of all GObject"   \
    " native instances.\n"                                          \
    "\n"                                                            \
    "Less than 32 bits are available for storing arbitrary values." \
)

    obj = G_THICK_OBJECT(pygobject_get(self));

    extra = g_thick_object_get_extra(obj);

    result = PyLong_FromUnsignedLong(extra);

    return result;

}


/******************************************************************************
*                                                                             *
*  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 la valeur courante de la zone de stockage d'un objet.*
*                                                                             *
*  Retour      : 0.                                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_thick_object_set_extra(PyObject *self, PyObject *value, void *closure)
{
    unsigned long extra;                    /* Valeur à inscrire           */
    GThickObject *obj;                      /* Version GLib de l'instance  */

    if (!PyLong_Check(value))
    {
        PyErr_SetString(PyExc_TypeError, _("Invalid integer value"));
        return -1;
    }

    extra = PyLong_AsUnsignedLong(value);

    obj = G_THICK_OBJECT(pygobject_get(self));

    g_thick_object_set_extra(obj, extra);

    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_thick_object_type(void)
{
    static PyMethodDef py_thick_object_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_thick_object_getseters[] = {
        THICK_OBJECT__GOBJECT_RESERVED_EXTRA_BITS_ATTRIB,
        THICK_OBJECT_EXTRA_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_thick_object_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.glibext.ThickObject",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = THICK_OBJECT_DOC,

        .tp_methods     = py_thick_object_methods,
        .tp_getset      = py_thick_object_getseters,

        .tp_init        = py_thick_object_init,
        .tp_new         = py_thick_object_new,

    };

    return &py_thick_object_type;

}


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

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

    type = get_python_thick_object_type();

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

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_THICK_OBJECT, type))
            return false;

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : arg = argument quelconque à tenter de convertir.             *
*                dst = destination des valeurs récupérées en cas de succès.   *
*                                                                             *
*  Description : Tente de convertir en objet dense.                           *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_thick_object(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */

    result = PyObject_IsInstance(arg, (PyObject *)get_python_thick_object_type());

    switch (result)
    {
        case -1:
            /* L'exception est déjà fixée par Python */
            result = 0;
            break;

        case 0:
            PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to thick object");
            break;

        case 1:
            *((GThickObject **)dst) = G_THICK_OBJECT(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}