plugins/plugin_python/include/plugin_python.h

Go to the documentation of this file.

/************************************************************************
*            Atrinik, a Multiplayer Online Role Playing Game            *
*                                                                       *
*    Copyright (C) 2009-2011 Alex Tokar and Atrinik Development Team    *
*                                                                       *
* Fork from Daimonin (Massive Multiplayer Online Role Playing Game)     *
* and Crossfire (Multiplayer game for X-windows).                       *
*                                                                       *
* This program 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 2 of the License, or     *
* (at your option) any later version.                                   *
*                                                                       *
* This program 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., 675 Mass Ave, Cambridge, MA 02139, USA.             *
*                                                                       *
* The author can be reached at admin@atrinik.org                        *
************************************************************************/

#ifndef PLUGIN_PYTHON_H
#define PLUGIN_PYTHON_H

#include <Python.h>
#include <plugin.h>
#include <timers.h>

#if PY_MAJOR_VERSION >= 3
#   define IS_PY3K
#else
#   if PY_MINOR_VERSION >= 6
#       define IS_PY26
#   else
#       define IS_PY_LEGACY
#   endif
#   if PY_MINOR_VERSION >= 5
#       define IS_PY25
#   endif
#endif

/* Fake some Python 2.x functions for Python 3.x. */
#ifdef IS_PY3K
#   define PyString_Check PyUnicode_Check
#   define PyString_AsString _PyUnicode_AsString
#   define PyInt_Check PyLong_Check
#   define PyInt_AsLong PyLong_AsLong
    extern PyTypeObject PyIOBase_Type;
#   define PyFile_Check(op) (PyObject_IsInstance((op), (PyObject *) &PyIOBase_Type))
#   define PyString_FromFormat PyUnicode_FromFormat
#else
#   define PyObject_AsFileDescriptor(op) (PyFile_AsFile((op)) ? PyFile_AsFile((op))->fd : -1)
#endif

#define PLUGIN_NAME "Python"

#define PLUGIN_VERSION "Atrinik Python Plugin 1.0"

extern struct plugin_hooklist *hooks;

#define AROUND_ALL 0

#define AROUND_WALL 1

#define AROUND_BLOCKSVIEW 2

#define AROUND_PLAYER_ONLY 4

#define INVENTORY_ONLY 0

#define INVENTORY_CONTAINERS 1

#define INVENTORY_ALL 2

#undef LOG

#define LOG hooks->LOG

#undef FREE_AND_COPY_HASH
#undef FREE_AND_CLEAR_HASH

#define FREE_AND_COPY_HASH(_sv_, _nv_)   \
{                                        \
    if (_sv_)                            \
    {                                    \
        hooks->free_string_shared(_sv_); \
    }                                    \
                                         \
    _sv_ = hooks->add_string(_nv_);      \
}

#define FREE_AND_CLEAR_HASH(_nv_)        \
{                                        \
    if (_nv_)                            \
    {                                    \
        hooks->free_string_shared(_nv_); \
        _nv_ = NULL;                     \
    }                                    \
}

#undef SET_ANIMATION
#define SET_ANIMATION(ob, newanim) ob->face = &(*hooks->new_faces)[(*hooks->animations)[ob->animation_id].faces[newanim]]
#undef NUM_ANIMATIONS
#define NUM_ANIMATIONS(ob) ((*hooks->animations)[ob->animation_id].num_animations)
#undef NUM_FACINGS
#define NUM_FACINGS(ob) ((*hooks->animations)[ob->animation_id].facings)

extern PyObject *AtrinikError;

#define RAISE(msg)                        \
{                                         \
    PyErr_SetString(AtrinikError, (msg)); \
    return NULL;                          \
}

#define INTRAISE(msg)                        \
{                                            \
    PyErr_SetString(PyExc_TypeError, (msg)); \
    return -1;                               \
}

typedef struct _pythoncontext
{
    struct _pythoncontext *down;

    object *activator;

    object *who;

    object *other;

    object *event;

    char *text;

    char *options;

    int returnvalue;

    int parms[4];
} PythonContext;

extern PythonContext *current_context;

typedef struct
{
    const char *name;

    const long value;
} Atrinik_Constant;

typedef enum
{
    FIELDTYPE_SHSTR,
    FIELDTYPE_CSTR,
    FIELDTYPE_CARY,
    FIELDTYPE_UINT8,
    FIELDTYPE_SINT8,
    FIELDTYPE_UINT16,
    FIELDTYPE_SINT16,
    FIELDTYPE_UINT32,
    FIELDTYPE_SINT32,
    FIELDTYPE_UINT64,
    FIELDTYPE_SINT64,
    FIELDTYPE_FLOAT,
    FIELDTYPE_OBJECT,
    FIELDTYPE_OBJECT2,
    FIELDTYPE_MAP,
    FIELDTYPE_OBJECTREF,
    FIELDTYPE_REGION,
    FIELDTYPE_PARTY,
    FIELDTYPE_ARCH,
    FIELDTYPE_PLAYER,
    FIELDTYPE_FACE,
    FIELDTYPE_ANIMATION,
    FIELDTYPE_BOOLEAN,
    FIELDTYPE_LIST,
    FIELDTYPE_KNOWN_SPELLS,
    FIELDTYPE_CMD_PERMISSIONS,
    FIELDTYPE_FACTIONS
} field_type;

#define FIELDFLAG_READONLY 1

#define FIELDFLAG_PLAYER_READONLY 2

#define FIELDFLAG_PLAYER_FIX 4

PyTypeObject Atrinik_ObjectType;
PyObject *wrap_object(object *what);
int Atrinik_Object_init(PyObject *module);

#define OBJ_ITER_TYPE_NONE 0

#define OBJ_ITER_TYPE_BELOW 1

#define OBJ_ITER_TYPE_ABOVE 2

#define OBJ_ITER_TYPE_ONE 3

typedef struct Atrinik_Object
{
    PyObject_HEAD

    object *obj;

    struct Atrinik_Object *iter;

    uint8 iter_type;

    tag_t count;
} Atrinik_Object;

PyTypeObject Atrinik_MapType;
PyObject *wrap_map(mapstruct *map);
int Atrinik_Map_init(PyObject *module);

typedef struct
{
    PyObject_HEAD
    mapstruct *map;
} Atrinik_Map;

PyTypeObject Atrinik_PartyType;
PyObject *wrap_party(party_struct *party);
int Atrinik_Party_init(PyObject *module);

typedef struct
{
    PyObject_HEAD
    party_struct *party;
} Atrinik_Party;

PyTypeObject Atrinik_RegionType;
PyObject *wrap_region(region *region);
int Atrinik_Region_init(PyObject *module);

typedef struct
{
    PyObject_HEAD
    region *region;
} Atrinik_Region;

PyTypeObject Atrinik_PlayerType;
PyObject *wrap_player(player *pl);
int Atrinik_Player_init(PyObject *module);

typedef struct
{
    PyObject_HEAD
    player *pl;
} Atrinik_Player;

PyTypeObject Atrinik_ArchetypeType;
PyObject *wrap_archetype(archetype *at);
int Atrinik_Archetype_init(PyObject *module);

typedef struct
{
    PyObject_HEAD
    archetype *at;
} Atrinik_Archetype;

PyTypeObject Atrinik_AttrListType;
PyObject *wrap_attr_list(void *ptr, size_t offset, field_type field);
int Atrinik_AttrList_init(PyObject *module);

typedef struct
{
    PyObject_HEAD

    void *ptr;

    size_t offset;

    field_type field;

    unsigned PY_LONG_LONG iter;
} Atrinik_AttrList;

typedef struct PythonCmdStruct
{
    char *name;

    char *script;

    double speed;
} PythonCmd;

typedef struct
{
    char *name;

    field_type type;

    size_t offset;

    uint32 flags;

    uint32 extra_data;
} fields_struct;

#define NUM_FIELDS (sizeof(fields) / sizeof(fields[0]))

#define NR_CUSTOM_CMD 1024

#define OBJEXISTCHECK_INT(ob) \
{ \
    if (!(ob) || !(ob)->obj || (ob)->obj->count != (ob)->count || OBJECT_FREE((ob)->obj)) \
    { \
        PyErr_SetString(PyExc_ReferenceError, "Atrinik object no longer exists."); \
        return -1; \
    } \
}

#define OBJEXISTCHECK(ob) \
{ \
    if (!(ob) || !(ob)->obj || (ob)->obj->count != (ob)->count || OBJECT_FREE((ob)->obj)) \
    { \
        PyErr_SetString(PyExc_ReferenceError, "Atrinik object no longer exists."); \
        return NULL; \
    } \
}

#define SQUARES_AROUND_ADD(_m, _x, _y) \
{ \
    PyObject *tuple = PyTuple_New(3); \
\
    PyTuple_SET_ITEM(tuple, 0, wrap_map((_m))); \
    PyTuple_SET_ITEM(tuple, 1, Py_BuildValue("i", (_x))); \
    PyTuple_SET_ITEM(tuple, 2, Py_BuildValue("i", (_y))); \
    PyList_Append(list, tuple); \
}

#define Py_ReturnBoolean(val) \
{ \
    if ((val)) \
    { \
        Py_INCREF(Py_True); \
        return Py_True; \
    } \
    else \
    { \
        Py_INCREF(Py_False); \
        return Py_False; \
    } \
}

int generic_field_setter(fields_struct *field, void *ptr, PyObject *value);
PyObject *generic_field_getter(fields_struct *field, void *ptr);
PyObject *generic_rich_compare(int op, int result);
int python_call_int(PyObject *callable, PyObject *arglist);

#endif