cfpython_map.cpp

Go to the documentation of this file.

/*****************************************************************************/
/* CFPython - A Python module for Crossfire RPG.                             */
/* Version: 2.0beta8 (also known as "Alexander")                             */
/* Contact: yann.chachkoff@myrealbox.com                                     */
/*****************************************************************************/
/* That code is placed under the GNU General Public Licence (GPL)            */
/* (C)2001-2005 by Chachkoff Yann (Feel free to deliver your complaints)     */
/*****************************************************************************/
/*  CrossFire, A Multiplayer game for X-windows                              */
/*                                                                           */
/*  Copyright (C) 2000 Mark Wedel                                            */
/*  Copyright (C) 1992 Frank Tore Johansen                                   */
/*                                                                           */
/*  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.                */
/*                                                                           */
/*****************************************************************************/

#include <cfpython.h>
#include <map>

/* Table for keeping track of which PyObject goes with with Crossfire object */
static std::map<mapstruct *, Crossfire_Map *> map_assoc_table;

static void add_map_assoc(mapstruct *key, Crossfire_Map *value) {
    map_assoc_table[key] = value;
}

static Crossfire_Map *find_assoc_pymap(mapstruct *key) {
    auto f = map_assoc_table.find(key);
    return f == map_assoc_table.end() ? nullptr : f->second;
}

static void free_map_assoc(mapstruct *key) {
    map_assoc_table.erase(key);
}


static void ensure_map_in_memory(Crossfire_Map *map) {
    assert(map->map != NULL);
    if (map->map->in_memory != MAP_IN_MEMORY) {
        char* mapname = map->map->path;
        int is_unique = cf_map_get_int_property(map->map, CFAPI_MAP_PROP_UNIQUE);
        /* If the map is unique the path name will be freed. We need to handle that. */
        if (is_unique) {
            char* tmp = strdup(mapname);
            if (!tmp) {
                /* FIXME: We should fatal() here, but that doesn't exist in plugins. */
                cf_log(llevError, "Out of memory in ensure_map_in_memory()!\n");
                abort();
            }
            mapname = tmp;
        }
        cf_log(llevDebug, "MAP %s AIN'T READY ! Loading it...\n", mapname);
        /* Map pointer may change for player unique maps. */
        /* Also, is the MAP_PLAYER_UNIQUE logic correct? */
        map->map = cf_map_get_map(mapname, is_unique ? MAP_PLAYER_UNIQUE : 0);
        if (is_unique)
            free(mapname);
    }
}

static PyObject *Map_GetDifficulty(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_difficulty(whoptr->map));
}

static PyObject *Map_GetPath(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("s", cf_map_get_sstring_property(whoptr->map, CFAPI_MAP_PROP_PATH));
}

static PyObject *Map_GetTempName(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("s", cf_map_get_sstring_property(whoptr->map, CFAPI_MAP_PROP_TMPNAME));
}

static PyObject *Map_GetName(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("s", cf_map_get_sstring_property(whoptr->map, CFAPI_MAP_PROP_NAME));
}

static PyObject *Map_GetResetTime(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_reset_time(whoptr->map));
}

static PyObject *Map_GetResetTimeout(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_reset_timeout(whoptr->map));
}

static PyObject *Map_GetPlayers(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_players(whoptr->map));
}

static PyObject *Map_GetDarkness(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_darkness(whoptr->map));
}

static PyObject *Map_GetWidth(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_width(whoptr->map));
}

static PyObject *Map_GetHeight(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_height(whoptr->map));
}

static PyObject *Map_GetEnterX(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_enter_x(whoptr->map));
}

static PyObject *Map_GetEnterY(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_enter_y(whoptr->map));
}

static PyObject *Map_GetMessage(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("s", cf_map_get_sstring_property(whoptr->map, CFAPI_MAP_PROP_MESSAGE));
}

static PyObject *Map_GetRegion(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Crossfire_Region_wrap(cf_map_get_region_property(whoptr->map, CFAPI_MAP_PROP_REGION));
}

static int Map_SetPath(Crossfire_Map *whoptr, PyObject *value, void *closure) {
    const char *val;
    (void)closure;

    MAPEXISTCHECK_INT(whoptr);
    if (!PyArg_Parse(value, "s", &val))
        return -1;

    cf_map_set_string_property(whoptr->map, CFAPI_MAP_PROP_PATH, val);
    return 0;

}

static PyObject *Map_GetUnique(Crossfire_Map *whoptr, void *closure) {
    (void)closure;
    MAPEXISTCHECK(whoptr);
    return Py_BuildValue("i", cf_map_get_int_property(whoptr->map, CFAPI_MAP_PROP_UNIQUE));
}

static PyObject *Map_Message(Crossfire_Map *map, PyObject *args) {
    int color = NDI_BLUE|NDI_UNIQUE;
    char *message;

    if (!PyArg_ParseTuple(args, "s|i", &message, &color))
        return NULL;

    MAPEXISTCHECK(map);

    cf_map_message(map->map, message, color);

    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject *Map_GetFirstObjectAt(Crossfire_Map *map, PyObject *args) {
    int x, y;
    object *val;

    if (!PyArg_ParseTuple(args, "ii", &x, &y))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    val = cf_map_get_object_at(map->map, x, y);
    return Crossfire_Object_wrap(val);
}

static PyObject *Map_CreateObject(Crossfire_Map *map, PyObject *args) {
    char *txt;
    int x, y;
    object *op;

    if (!PyArg_ParseTuple(args, "sii", &txt, &x, &y))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    op = cf_create_object_by_name(txt);

    if (op)
        op = cf_map_insert_object(map->map, op, x, y);
    return Crossfire_Object_wrap(op);
}

static PyObject *Map_Check(Crossfire_Map *map, PyObject *args) {
    char *what;
    int x, y;
    object *foundob;
    int16_t nx, ny;
    int mflags;

    if (!PyArg_ParseTuple(args, "s(ii)", &what, &x, &y))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    mflags = cf_map_get_flags(map->map, &(map->map), (int16_t)x, (int16_t)y, &nx, &ny);
    if (mflags&P_OUT_OF_MAP) {
        Py_INCREF(Py_None);
        return Py_None;
    }
    foundob = cf_map_find_by_archetype_name(what, map->map, nx, ny);
    return Crossfire_Object_wrap(foundob);
}

static PyObject *Map_Next(Crossfire_Map *map, PyObject *args) {
    (void)args;
    MAPEXISTCHECK(map);
    return Crossfire_Map_wrap(cf_map_get_map_property(map->map, CFAPI_MAP_PROP_NEXT));
}

static PyObject *Map_Insert(Crossfire_Map *map, PyObject *args) {
    int x, y;
    Crossfire_Object *what;

    if (!PyArg_ParseTuple(args, "O!ii", &Crossfire_ObjectType, &what, &x, &y))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    return Crossfire_Object_wrap(cf_map_insert_object(map->map, what->obj, x, y));
}

static PyObject *Map_InsertAround(Crossfire_Map *map, PyObject *args) {
    int x, y;
    Crossfire_Object *what;

    if (!PyArg_ParseTuple(args, "O!ii", &Crossfire_ObjectType, &what, &x, &y))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    return Crossfire_Object_wrap(cf_map_insert_object_around(map->map, what->obj, x, y));
}

static PyObject *Map_ChangeLight(Crossfire_Map *map, PyObject *args) {
    int change;

    if (!PyArg_ParseTuple(args, "i", &change))
        return NULL;

    MAPEXISTCHECK(map);

    return Py_BuildValue("i", cf_map_change_light(map->map, change));
}
static PyObject *Map_TriggerConnected(Crossfire_Map *map, PyObject *args) {
    objectlink *ol = NULL;
    int connected;
    int state;
    Crossfire_Object *cause = NULL;
    oblinkpt *olp;

    if (!PyArg_ParseTuple(args, "ii|O!", &connected, &state, &Crossfire_ObjectType, &cause))
        return NULL;

    MAPEXISTCHECK(map);

    /* make sure the map is swapped in */
    ensure_map_in_memory(map);

    /* locate objectlink for this connected value */
    if (!map->map->buttons) {
        cf_log(llevError, "Map %s called for trigger on connected %d but there ain't any button list for that map!\n", cf_map_get_sstring_property(map->map, CFAPI_MAP_PROP_PATH), connected);
        PyErr_SetString(PyExc_ReferenceError, "No objects connected to that ID on this map.");
        return NULL;
    }
    for (olp = map->map->buttons; olp; olp = olp->next) {
        if (olp->value == connected) {
            ol = olp->link;
            break;
        }
    }
    if (ol == NULL) {
        cf_log(llevInfo, "Map %s called for trigger on connected %d but there ain't any button list for that map!\n", cf_map_get_sstring_property(map->map, CFAPI_MAP_PROP_PATH), connected);
        /* FIXME: I'm not sure about this message... */
        PyErr_SetString(PyExc_ReferenceError, "No objects with that connection ID on this map.");
        return NULL;
    }
    /* run the object link */
    cf_map_trigger_connected(ol, cause ? cause->obj : NULL, state);

    Py_INCREF(Py_None);
    return Py_None;
}

static int Map_InternalCompare(Crossfire_Map *left, Crossfire_Map *right) {
    MAPEXISTCHECK_INT(left);
    MAPEXISTCHECK_INT(right);
    return left->map < right->map ? -1 : (left->map == right->map ? 0 : 1);
}

static PyObject *Crossfire_Map_RichCompare(Crossfire_Map *left, Crossfire_Map *right, int op) {
    int result;
    if (!left
        || !right
        || !PyObject_TypeCheck((PyObject*)left, &Crossfire_MapType)
        || !PyObject_TypeCheck((PyObject*)right, &Crossfire_MapType)) {
        Py_INCREF(Py_NotImplemented);
        return Py_NotImplemented;
    }
    result = Map_InternalCompare(left, right);
    /* Handle removed maps. */
    if (result == -1 && PyErr_Occurred())
        return NULL;
    /* Based on how Python 3.0 (GPL compatible) implements it for internal types: */
    switch (op) {
        case Py_EQ:
            result = (result == 0);
            break;
        case Py_NE:
            result = (result != 0);
            break;
        case Py_LE:
            result = (result <= 0);
            break;
        case Py_GE:
            result = (result >= 0);
            break;
        case Py_LT:
            result = (result == -1);
            break;
        case Py_GT:
            result = (result == 1);
            break;
    }
    return PyBool_FromLong(result);
}

/* Legacy code: convert to long so that non-object functions work correctly */
static PyObject *Crossfire_Map_Long(PyObject *obj) {
    MAPEXISTCHECK((Crossfire_Map *)obj);
    return Py_BuildValue("l", ((Crossfire_Map *)obj)->map);
}

static PyObject *Crossfire_Map_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
    Crossfire_Map *self;
    (void)args;
    (void)kwds;

    self = (Crossfire_Map *)type->tp_alloc(type, 0);
    if (self)
        self->map = NULL;

    return (PyObject *)self;
}

static void Crossfire_Map_dealloc(PyObject *obj) {
    Crossfire_Map *self;

    self = (Crossfire_Map *)obj;
    if (self) {
        if (self->map && self->valid) {
            free_map_assoc(self->map);
        }
        Py_TYPE(self)->tp_free(obj);
    }
}

void Handle_Map_Unload_Hook(Crossfire_Map *map) {
    map->valid = 0;
    free_map_assoc(map->map);
}

PyObject *Crossfire_Map_wrap(mapstruct *what) {
    Crossfire_Map *wrapper;

    /* return None if no object was to be wrapped */
    if (what == NULL) {
        Py_INCREF(Py_None);
        return Py_None;
    }

    wrapper = find_assoc_pymap(what);
    if (!wrapper) {
        wrapper = PyObject_NEW(Crossfire_Map, &Crossfire_MapType);
        if (wrapper != NULL) {
            wrapper->map = what;
            wrapper->valid = 1;
            add_map_assoc(what, wrapper);
        }
    } else {
        Py_INCREF(wrapper);
    }

    return (PyObject *)wrapper;
}

/* Python binding */
static PyGetSetDef Map_getseters[] = {
    { "Difficulty",      (getter)Map_GetDifficulty,  NULL, NULL, NULL },
    { "Path",            (getter)Map_GetPath,        (setter)Map_SetPath, NULL, NULL },
    { "TempName",        (getter)Map_GetTempName,    NULL, NULL, NULL },
    { "Name",            (getter)Map_GetName,        NULL, NULL, NULL },
    { "ResetTime",       (getter)Map_GetResetTime,   NULL, NULL, NULL },
    { "ResetTimeout",    (getter)Map_GetResetTimeout, NULL, NULL, NULL },
    { "Players",         (getter)Map_GetPlayers,     NULL, NULL, NULL },
    { "Light",           (getter)Map_GetDarkness,    NULL, NULL, NULL },
    { "Darkness",        (getter)Map_GetDarkness,    NULL, NULL, NULL },
    { "Width",           (getter)Map_GetWidth,       NULL, NULL, NULL },
    { "Height",          (getter)Map_GetHeight,      NULL, NULL, NULL },
    { "EnterX",          (getter)Map_GetEnterX,      NULL, NULL, NULL },
    { "EnterY",          (getter)Map_GetEnterY,      NULL, NULL, NULL },
    { "Message",         (getter)Map_GetMessage,     NULL, NULL, NULL },
    { "Region",          (getter)Map_GetRegion,      NULL, NULL, NULL },
    { "Unique",          (getter)Map_GetUnique,      NULL, NULL, NULL },
    {  NULL, NULL, NULL, NULL, NULL }
};

static PyMethodDef MapMethods[] = {
    { "Print",            (PyCFunction)Map_Message,          METH_VARARGS, NULL },
    { "ObjectAt",         (PyCFunction)Map_GetFirstObjectAt, METH_VARARGS, NULL },
    { "CreateObject",     (PyCFunction)Map_CreateObject,     METH_VARARGS, NULL },
    { "Check",            (PyCFunction)Map_Check,            METH_VARARGS, NULL },
    { "Next",             (PyCFunction)Map_Next,             METH_NOARGS,  NULL },
    { "Insert",           (PyCFunction)Map_Insert,           METH_VARARGS, NULL },
    { "InsertAround",     (PyCFunction)Map_InsertAround,     METH_VARARGS, NULL },
    { "ChangeLight",      (PyCFunction)Map_ChangeLight,      METH_VARARGS, NULL },
    { "TriggerConnected", (PyCFunction)Map_TriggerConnected, METH_VARARGS, NULL },
    { NULL, NULL, 0, NULL }
};

CF_PYTHON_NUMBER_METHODS(Map, Crossfire_Map_Long);

/* Our actual Python MapType */
CF_PYTHON_OBJECT(Map,
                 Crossfire_Map_dealloc,
                 &MapConvert,
                 PyObject_HashNotImplemented,
                 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
                 "Crossfire maps",
                 (richcmpfunc) Crossfire_Map_RichCompare,
                 MapMethods,
                 Map_getseters,
                 NULL,
                 Crossfire_Map_new
                 );