include/plugin.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_H
#define PLUGIN_H

#ifndef WIN32
#   include <dlfcn.h>
#endif

#undef MODULEAPI

#ifdef WIN32
#   ifdef PYTHON_PLUGIN_EXPORTS
#       define MODULEAPI __declspec(dllexport)
#   else
#       define MODULEAPI __declspec(dllimport)
#   endif
#else
#   define MODULEAPI
#endif

#include <global.h>

#define PLUGIN_EVENT_NORMAL 1

#define PLUGIN_EVENT_MAP 2

#define PLUGIN_EVENT_GLOBAL 3

#define EVENT_NONE 0

#define EVENT_APPLY 1

#define EVENT_ATTACK 2

#define EVENT_DEATH 3

#define EVENT_DROP 4

#define EVENT_PICKUP 5

#define EVENT_SAY 6

#define EVENT_STOP 7

#define EVENT_TIME 8

#define EVENT_THROW 9

#define EVENT_TRIGGER 10

#define EVENT_CLOSE 11

#define EVENT_TIMER 12

#define EVENT_QUEST 13

#define EVENT_ASK_SHOW 14

#define EVENT_AI 15

#define EVENT_AI_RANDOM_MOVE 1

#define MEVENT_ENTER 1

#define MEVENT_LEAVE 2

#define MEVENT_RESET 3

#define MEVENT_SPELL_CAST 4

#define MEVENT_SKILL_USED 5

#define MEVENT_DROP 6

#define MEVENT_PICK 7

#define MEVENT_PUT 8

#define MEVENT_APPLY 9

#define MEVENT_LOGIN 10

#define MEVENT_CMD_DROP 11

#define MEVENT_CMD_TAKE 12

#define MEVENT_EXAMINE 13

#define GEVENT_BORN 0

#define GEVENT_LOGIN 1

#define GEVENT_LOGOUT 2

#define GEVENT_PLAYER_DEATH 3

#define GEVENT_CACHE_REMOVED 4

#define GEVENT_NUM 5

#define EVENT_FLAG(x) (1U << (x - 1))

#define HAS_EVENT(ob, event) (ob->event_flags & EVENT_FLAG(event))

struct plugin_hooklist
{
    char *(*query_name)(object *, object *);
    const char *(*re_cmp)(const char *, const char *);
    object *(*present_in_ob)(unsigned char, object *);
    int (*players_on_map)(mapstruct *);
    char *(*create_pathname)(const char *);
    char *(*normalize_path)(const char *, const char *, char *);
    void (*LOG)(LogLevel, const char *, ...);
    void (*free_string_shared)(const char *);
    const char *(*add_string)(const char *);
    void (*remove_ob)(object *);
    void (*fix_player)(object *);
    object *(*insert_ob_in_ob)(object *, object *);
    void (*new_info_map)(int, const char *color, mapstruct *, int, int, int, const char *);
    void (*new_info_map_except)(int , const char *color, mapstruct *, int, int, int, object *, object *, const char *);
    void (*spring_trap)(object *, object *);
    int (*cast_spell)(object *, object *, int, int, int, int, const char *);
    void (*update_ob_speed)(object *);
    int (*command_rskill)(object *, char *);
    void (*become_follower)(object *, object *);
    void (*pick_up)(object *, object *, int);
    mapstruct *(*get_map_from_coord)(mapstruct *, int *, int *);
    void (*esrv_send_item)(object *, object *);
    player *(*find_player)(const char *);
    int (*manual_apply)(object *, object *, int);
    int (*command_drop)(object *, char *);
    int (*transfer_ob)(object *, int, int, int, object *, object *);
    int (*kill_object)(object *, int, object *, int);
    void (*do_learn_spell)(object *, int, int);
    void (*do_forget_spell)(object *, int);
    int (*look_up_spell_name)(const char *);
    int (*check_spell_known)(object *, int);
    void (*esrv_send_inventory)(object *, object *);
    object *(*get_archetype)(const char *);
    mapstruct *(*ready_map_name)(const char *, int);
    sint64 (*add_exp)(object *, sint64, int, int);
    const char *(*determine_god)(object *);
    object *(*find_god)(const char *);
    void (*register_global_event)(const char *, int);
    void (*unregister_global_event)(const char *, int);
    object *(*load_object_str)(char *);
    sint64 (*query_cost)(object *, object *, int);
    sint64 (*query_money)(object *);
    int (*pay_for_item)(object *, object *);
    int (*pay_for_amount)(sint64, object *);
    void (*new_draw_info)(int, const char *, object *, const char *);
    void (*communicate)(object *, char *);
    object *(*object_create_clone)(object *);
    object *(*get_object)();
    void (*copy_object)(object *, object *, int);
    void (*enter_exit)(object *, object *);
    void (*play_sound_map)(mapstruct *, int, const char *, int, int, int, int);
    int (*learn_skill)(object *, object *, char *, int, int);
    object *(*find_marked_object)(object *);
    int (*cast_identify)(object *, int, object *, int);
    int (*lookup_skill_by_name)(const char *);
    int (*check_skill_known)(object *, int);
    archetype *(*find_archetype)(const char *);
    object *(*arch_to_object)(archetype *);
    object *(*insert_ob_in_map)(object *, mapstruct *, object *, int);
    char *(*cost_string_from_value)(sint64);
    int (*bank_deposit)(object *, const char *, sint64 *value);
    int (*bank_withdraw)(object *, const char *, sint64 *value);
    sint64 (*bank_get_balance)(object *);
    int (*swap_apartments)(const char *, const char *, int, int, object *);
    int (*player_exists)(char *);
    void (*get_tod)(timeofday_t *);
    const char *(*object_get_value)(const object *, const char *const);
    int (*object_set_value)(object *, const char *, const char *, int);
    void (*drop)(object *, object *, int);
    char *(*query_short_name)(object *, object *);
    object *(*beacon_locate)(const char *);
    char *(*strdup_local)(const char *);
    void (*adjust_player_name)(char *);
    party_struct *(*find_party)(const char *);
    void (*add_party_member)(party_struct *, object *);
    void (*remove_party_member)(party_struct *, object *);
    void (*send_party_message)(party_struct *, const char *, int, object *);
    void (*Write_String_To_Socket)(socket_struct *, char, const char *, int);
    void (*dump_object)(object *, StringBuffer *);
    StringBuffer *(*stringbuffer_new)();
    char *(*stringbuffer_finish)(StringBuffer *);
    char *(*cleanup_chat_string)(char *);
    int (*cftimer_find_free_id)();
    int (*cftimer_create)(int, long, object *, int);
    int (*cftimer_destroy)(int);
    int (*find_face)(char *, int);
    int (*find_animation)(char *);
    void (*play_sound_player_only)(player *, int, const char *, int, int, int, int);
    void (*new_draw_info_format)(int, const char *, object *, char *, ...);
    int (*was_destroyed)(object *, tag_t);
    int (*object_get_gender)(object *);
    int (*change_abil)(object *, object *);
    object *(*decrease_ob_nr)(object *, uint32);
    int (*check_walk_off)(object *, object *, int);
    int (*wall)(mapstruct *, int, int);
    int (*blocked)(object *, mapstruct *, int, int, int);
    int (*get_rangevector)(object *, object *, rv_vector *, int);
    int (*get_rangevector_from_mapcoords)(mapstruct *, int, int, mapstruct *, int, int, rv_vector *, int);
    int (*player_can_carry)(object *, uint32);
    cache_struct *(*cache_find)(shstr *);
    int (*cache_add)(const char *, void *, uint32);
    int (*cache_remove)(shstr *);
    void (*cache_remove_by_flags)(uint32);
    shstr *(*find_string)(const char *);
    int (*command_take)(object *, char *);
    object *(*object_need_esrv_update)(object *);
    void (*object_remove_esrv_update)(object *);
    void (*esrv_update_item)(int, object *, object *);
    int (*execute_newserver_command)(object *, char *);
    treasurelist *(*find_treasurelist)(const char *);
    void (*create_treasure)(treasurelist *, object *, int, int, int, int, int, struct _change_arch *);
    void (*dump_object_rec)(object *, StringBuffer *);
    int (*hit_player)(object *, int, object *, int);
    int (*move_ob)(object *, int, object *);
    int (*move_player)(object *, int);
    mapstruct *(*get_empty_map)(int, int);
    void (*set_map_darkness)(mapstruct *, int);
    int (*find_free_spot)(archetype *, object *, mapstruct *, int, int, int, int);
    void (*send_target_command)(player *);
    void (*examine)(object *, object *);
    void (*push_button)(object *);

    const char **season_name;
    const char **weekdays;
    const char **month_name;
    const char **periodsofday;
    spell_struct *spells;
    struct shstr_constants *shstr_cons;
    const char **gender_noun;
    const char **gender_subjective;
    const char **gender_subjective_upper;
    const char **gender_objective;
    const char **gender_possessive;
    const char **gender_reflexive;
    const char **object_flag_names;
    int *freearr_x;
    int *freearr_y;
    player **first_player;
    New_Face **new_faces;
    int *nrofpixmaps;
    Animations **animations;
    int *num_animations;
    archetype **first_archetype;
    mapstruct **first_map;
    party_struct **first_party;
    region **first_region;
    FILE **logfile;
};

typedef void *(*f_plug_api) (int *type, ...);
typedef void *(*f_plug_init) (struct plugin_hooklist *hooklist);
typedef void *(*f_plug_pinit) ();

#ifndef WIN32

#   define LIBPTRTYPE void *

#   define plugins_dlopen(fname) dlopen(fname, RTLD_NOW | RTLD_GLOBAL)

#   define plugins_dlclose(lib) dlclose(lib)

#   define plugins_dlsym(lib, name) dlsym(lib, name)

#   define plugins_dlerror() dlerror()
#else
#   define LIBPTRTYPE HMODULE
#   define plugins_dlopen(fname) LoadLibrary(fname)
#   define plugins_dlclose(lib) FreeLibrary(lib)
#   define plugins_dlsym(lib, name) GetProcAddress(lib, name)
#endif

#define FILENAME_IS_PLUGIN(_path) (strstr((_path), "plugin_") && !strcmp((_path) + strlen((_path)) - strlen(PLUGIN_SUFFIX), PLUGIN_SUFFIX))

typedef struct atrinik_plugin
{
    f_plug_api eventfunc;

    f_plug_api propfunc;

    f_plug_pinit closefunc;

    LIBPTRTYPE libptr;

    char id[MAX_BUF];

    char fullname[MAX_BUF];

    sint8 gevent[GEVENT_NUM];

    struct atrinik_plugin *next;
} atrinik_plugin;

extern MODULEAPI void initPlugin(struct plugin_hooklist *hooklist);

extern MODULEAPI void *getPluginProperty(int *type, ...);

extern MODULEAPI void *triggerEvent(int *type, ...);

extern MODULEAPI void postinitPlugin();

extern MODULEAPI void closePlugin();
#endif