// Copyright (c) Athena Dev Teams - Licensed under GNU GPL // For more information, see LICENCE in the main folder #ifndef _SCRIPT_H_ #define _SCRIPT_H_ #include "../common/cbasetypes.h" #include "map.h" #define NUM_WHISPER_VAR 10 /////////////////////////////////////////////////////////////////////////////// //## TODO possible enhancements: [FlavioJS] // - 'callfunc' supporting labels in the current npc "::LabelName" // - 'callfunc' supporting labels in other npcs "NpcName::LabelName" // - 'function FuncName;' function declarations reverting to global functions // if local label isn't found // - join callfunc and callsub's functionality // - remove dynamic allocation in add_word() // - remove GETVALUE / SETVALUE // - clean up the set_reg / set_val / setd_sub mess // - detect invalid label references at parse-time // // struct script_state* st; // /// Returns the script_data at the target index #define script_getdata(st,i) ( &((st)->stack->stack_data[(st)->start + (i)]) ) /// Returns if the stack contains data at the target index #define script_hasdata(st,i) ( (st)->end > (st)->start + (i) ) /// Returns the index of the last data in the stack #define script_lastdata(st) ( (st)->end - (st)->start - 1 ) /// Pushes an int into the stack #define script_pushint(st,val) push_val((st)->stack, C_INT, (val)) /// Pushes a string into the stack (script engine frees it automatically) #define script_pushstr(st,val) push_str((st)->stack, C_STR, (val)) /// Pushes a copy of a string into the stack #define script_pushstrcopy(st,val) push_str((st)->stack, C_STR, aStrdup(val)) /// Pushes a constant string into the stack (must never change or be freed) #define script_pushconststr(st,val) push_str((st)->stack, C_CONSTSTR, (val)) /// Pushes a nil into the stack #define script_pushnil(st) push_val((st)->stack, C_NOP, 0) /// Pushes a copy of the data in the target index #define script_pushcopy(st,i) push_copy((st)->stack, (st)->start + (i)) #define script_isstring(st,i) data_isstring(script_getdata(st,i)) #define script_isint(st,i) data_isint(script_getdata(st,i)) #define script_getnum(st,val) conv_num(st, script_getdata(st,val)) #define script_getstr(st,val) conv_str(st, script_getdata(st,val)) #define script_getref(st,val) ( script_getdata(st,val)->ref ) // Returns name of currently running function #define script_getfuncname(st) ( st->funcname ) // Note: "top" functions/defines use indexes relative to the top of the stack // -1 is the index of the data at the top /// Returns the script_data at the target index relative to the top of the stack #define script_getdatatop(st,i) ( &((st)->stack->stack_data[(st)->stack->sp + (i)]) ) /// Pushes a copy of the data in the target index relative to the top of the stack #define script_pushcopytop(st,i) push_copy((st)->stack, (st)->stack->sp + (i)) /// Removes the range of values [start,end[ relative to the top of the stack #define script_removetop(st,start,end) ( pop_stack((st), ((st)->stack->sp + (start)), (st)->stack->sp + (end)) ) // // struct script_data* data; // /// Returns if the script data is a string #define data_isstring(data) ( (data)->type == C_STR || (data)->type == C_CONSTSTR ) /// Returns if the script data is an int #define data_isint(data) ( (data)->type == C_INT ) /// Returns if the script data is a reference #define data_isreference(data) ( (data)->type == C_NAME ) /// Returns if the script data is a label #define data_islabel(data) ( (data)->type == C_POS ) /// Returns if the script data is an internal script function label #define data_isfunclabel(data) ( (data)->type == C_USERFUNC_POS ) /// Returns if this is a reference to a constant #define reference_toconstant(data) ( str_data[reference_getid(data)].type == C_INT ) /// Returns if this a reference to a param #define reference_toparam(data) ( str_data[reference_getid(data)].type == C_PARAM ) /// Returns if this a reference to a variable //##TODO confirm it's C_NAME [FlavioJS] #define reference_tovariable(data) ( str_data[reference_getid(data)].type == C_NAME ) /// Returns the unique id of the reference (id and index) #define reference_getuid(data) ( (data)->u.num ) /// Returns the id of the reference #define reference_getid(data) ( (int32)(int64)(reference_getuid(data) & 0xffffffff) ) /// Returns the array index of the reference #define reference_getindex(data) ( (uint32)(int64)((reference_getuid(data) >> 32) & 0xffffffff) ) /// Returns the name of the reference #define reference_getname(data) ( str_buf + str_data[reference_getid(data)].str ) /// Returns the linked list of uid-value pairs of the reference (can be NULL) #define reference_getref(data) ( (data)->ref ) /// Returns the value of the constant #define reference_getconstant(data) ( str_data[reference_getid(data)].val ) /// Returns the type of param #define reference_getparamtype(data) ( str_data[reference_getid(data)].val ) /// Composes the uid of a reference from the id and the index #define reference_uid(id,idx) ( (int64) ((uint64)(id) & 0xFFFFFFFF) | ((uint64)(idx) << 32) ) /// Checks whether two references point to the same variable (or array) #define is_same_reference(data1, data2) \ ( reference_getid(data1) == reference_getid(data2) \ && ( (data1->ref == data2->ref && data1->ref == NULL) \ || (data1->ref != NULL && data2->ref != NULL && data1->ref->vars == data2->ref->vars \ ) ) ) #define script_getvarid(var) ( (int32)(int64)(var & 0xFFFFFFFF) ) #define script_getvaridx(var) ( (uint32)(int64)((var >> 32) & 0xFFFFFFFF) ) #define not_server_variable(prefix) ( (prefix) != '$' && (prefix) != '.' && (prefix) != '\'') #define is_string_variable(name) ( (name)[strlen(name) - 1] == '$' ) #define FETCH(n, t) \ if( script_hasdata(st,n) ) \ (t)=script_getnum(st,n); /// Maximum amount of elements in script arrays #define SCRIPT_MAX_ARRAYSIZE (UINT_MAX - 1) enum script_cmd_result { SCRIPT_CMD_SUCCESS = 0, ///when a buildin cmd was correctly done SCRIPT_CMD_FAILURE = 1, ///when an errors appear in cmd, show_debug will follow }; #define SCRIPT_BLOCK_SIZE 512 enum { LABEL_NEXTLINE = 1, LABEL_START }; struct map_session_data; struct eri; extern int potion_flag; //For use on Alchemist improved potions/Potion Pitcher. [Skotlex] extern int potion_hp, potion_per_hp, potion_sp, potion_per_sp; extern int potion_target; extern unsigned int *generic_ui_array; extern unsigned int generic_ui_array_size; extern struct Script_Config { unsigned warn_func_mismatch_argtypes : 1; unsigned warn_func_mismatch_paramnum : 1; int check_cmdcount; int check_gotocount; int input_min_value; int input_max_value; // PC related const char *die_event_name; const char *kill_pc_event_name; const char *kill_mob_event_name; const char *login_event_name; const char *logout_event_name; const char *loadmap_event_name; const char *baselvup_event_name; const char *joblvup_event_name; const char *stat_calc_event_name; // NPC related const char* ontouch_event_name; const char* ontouch2_event_name; const char* ontouchnpc_event_name; const char* onwhisper_event_name; const char* oncommand_event_name; // Init related const char* init_event_name; const char* inter_init_event_name; const char* inter_init_once_event_name; // Guild related const char* guild_break_event_name; const char* agit_start_event_name; const char* agit_init_event_name; const char* agit_end_event_name; const char* agit_start2_event_name; const char* agit_init2_event_name; const char* agit_end2_event_name; const char* agit_start3_event_name; const char* agit_init3_event_name; const char* agit_end3_event_name; // Timer related const char* timer_event_name; const char* timer_minute_event_name; const char* timer_hour_event_name; const char* timer_clock_event_name; const char* timer_day_event_name; const char* timer_sunday_event_name; const char* timer_monday_event_name; const char* timer_tuesday_event_name; const char* timer_wednesday_event_name; const char* timer_thursday_event_name; const char* timer_friday_event_name; const char* timer_saturday_event_name; // Instance related const char* instance_init_event_name; const char* instance_destroy_event_name; } script_config; typedef enum c_op { C_NOP, // end of script/no value (nil) C_POS, C_INT, // number C_PARAM, // parameter variable (see pc_readparam/pc_setparam) C_FUNC, // buildin function call C_STR, // string (free'd automatically) C_CONSTSTR, // string (not free'd) C_ARG, // start of argument list C_NAME, C_EOL, // end of line (extra stack values are cleared) C_RETINFO, C_USERFUNC, // internal script function C_USERFUNC_POS, // internal script function label C_REF, // the next call to c_op2 should push back a ref to the left operand // operators C_OP3, // a ? b : c C_LOR, // a || b C_LAND, // a && b C_LE, // a <= b C_LT, // a < b C_GE, // a >= b C_GT, // a > b C_EQ, // a == b C_NE, // a != b C_XOR, // a ^ b C_OR, // a | b C_AND, // a & b C_ADD, // a + b C_SUB, // a - b C_MUL, // a * b C_DIV, // a / b C_MOD, // a % b C_NEG, // - a C_LNOT, // ! a C_NOT, // ~ a C_R_SHIFT, // a >> b C_L_SHIFT, // a << b C_ADD_POST, // a++ C_SUB_POST, // a-- C_ADD_PRE, // ++a C_SUB_PRE, // --a } c_op; /** * Generic reg database abstraction to be used with various types of regs/script variables. */ struct reg_db { struct DBMap *vars; struct DBMap *arrays; }; struct script_retinfo { struct reg_db scope; ///< scope variables struct script_code* script; ///< script code int pos; ///< script location int nargs; ///< argument count int defsp; ///< default stack pointer }; struct script_data { enum c_op type; union script_data_val { int64 num; char *str; struct script_retinfo* ri; } u; struct reg_db *ref; }; // Moved defsp from script_state to script_stack since // it must be saved when script state is RERUNLINE. [Eoe / jA 1094] struct script_code { int script_size; unsigned char* script_buf; struct reg_db local; unsigned short instances; }; struct script_stack { int sp; ///< number of entries in the stack int sp_max; ///< capacity of the stack int defsp; struct script_data *stack_data; ///< stack struct reg_db scope; ///< scope variables }; // // Script state // enum e_script_state { RUN,STOP,END,RERUNLINE,GOTO,RETFUNC,CLOSE }; struct script_state { struct script_stack* stack; int start,end; int pos; enum e_script_state state; int rid,oid; struct script_code *script; struct sleep_data { int tick,timer,charid; } sleep; //For backing up purposes struct script_state *bk_st; int bk_npcid; unsigned freeloop : 1;// used by buildin_freeloop unsigned op2ref : 1;// used by op_2 unsigned npc_item_flag : 1; unsigned mes_active : 1; // Store if invoking character has a NPC dialog box open. char* funcname; // Stores the current running function name unsigned int id; }; struct script_reg { int64 index; int data; }; struct script_regstr { int64 index; char* data; }; struct script_array { unsigned int id; ///< the first 32b of the 64b uid, aka the id unsigned int size; ///< how many members unsigned int *members; ///< member list }; enum script_parse_options { SCRIPT_USE_LABEL_DB = 0x1,// records labels in scriptlabel_db SCRIPT_IGNORE_EXTERNAL_BRACKETS = 0x2,// ignores the check for {} brackets around the script SCRIPT_RETURN_EMPTY_SCRIPT = 0x4// returns the script object instead of NULL for empty scripts }; enum monsterinfo_types { MOB_NAME = 0, MOB_LV, MOB_MAXHP, MOB_BASEEXP, MOB_JOBEXP, MOB_ATK1, MOB_ATK2, MOB_DEF, MOB_MDEF, MOB_STR, MOB_AGI, MOB_VIT, MOB_INT, MOB_DEX, MOB_LUK, MOB_RANGE, MOB_RANGE2, MOB_RANGE3, MOB_SIZE, MOB_RACE, MOB_ELEMENT, MOB_MODE, MOB_MVPEXP }; enum petinfo_types { PETINFO_ID = 0, PETINFO_CLASS, PETINFO_NAME, PETINFO_INTIMATE, PETINFO_HUNGRY, PETINFO_RENAMED, PETINFO_LEVEL, PETINFO_BLOCKID }; enum questinfo_types { QTYPE_QUEST = 0, QTYPE_QUEST2, QTYPE_JOB, QTYPE_JOB2, QTYPE_EVENT, QTYPE_EVENT2, QTYPE_WARG, // 7 = free QTYPE_WARG2 = 8, // 9 - 9998 = free QTYPE_NONE = 9999 }; #ifndef WIN32 // These are declared in wingdi.h /* Font Weights */ #define FW_DONTCARE 0 #define FW_THIN 100 #define FW_EXTRALIGHT 200 #define FW_LIGHT 300 #define FW_NORMAL 400 #define FW_MEDIUM 500 #define FW_SEMIBOLD 600 #define FW_BOLD 700 #define FW_EXTRABOLD 800 #define FW_HEAVY 900 #endif enum getmapxy_types { UNITTYPE_PC = 0, UNITTYPE_NPC, UNITTYPE_PET, UNITTYPE_MOB, UNITTYPE_HOM, UNITTYPE_MER, UNITTYPE_ELEM, }; enum unitdata_mobtypes { UMOB_SIZE = 0, UMOB_LEVEL, UMOB_HP, UMOB_MAXHP, UMOB_MASTERAID, UMOB_MAPID, UMOB_X, UMOB_Y, UMOB_SPEED, UMOB_MODE, UMOB_AI, UMOB_SCOPTION, UMOB_SEX, UMOB_CLASS, UMOB_HAIRSTYLE, UMOB_HAIRCOLOR, UMOB_HEADBOTTOM, UMOB_HEADMIDDLE, UMOB_HEADTOP, UMOB_CLOTHCOLOR, UMOB_SHIELD, UMOB_WEAPON, UMOB_LOOKDIR, UMOB_CANMOVETICK, UMOB_STR, UMOB_AGI, UMOB_VIT, UMOB_INT, UMOB_DEX, UMOB_LUK, UMOB_SLAVECPYMSTRMD, UMOB_DMGIMMUNE, UMOB_ATKRANGE, UMOB_ATKMIN, UMOB_ATKMAX, UMOB_MATKMIN, UMOB_MATKMAX, UMOB_DEF, UMOB_MDEF, UMOB_HIT, UMOB_FLEE, UMOB_PDODGE, UMOB_CRIT, UMOB_RACE, UMOB_ELETYPE, UMOB_ELELEVEL, UMOB_AMOTION, UMOB_ADELAY, UMOB_DMOTION, }; enum unitdata_homuntypes { UHOM_SIZE = 0, UHOM_LEVEL, UHOM_HP, UHOM_MAXHP, UHOM_SP, UHOM_MAXSP, UHOM_MASTERCID, UHOM_MAPID, UHOM_X, UHOM_Y, UHOM_HUNGER, UHOM_INTIMACY, UHOM_SPEED, UHOM_LOOKDIR, UHOM_CANMOVETICK, UHOM_STR, UHOM_AGI, UHOM_VIT, UHOM_INT, UHOM_DEX, UHOM_LUK, UHOM_DMGIMMUNE, UHOM_ATKRANGE, UHOM_ATKMIN, UHOM_ATKMAX, UHOM_MATKMIN, UHOM_MATKMAX, UHOM_DEF, UHOM_MDEF, UHOM_HIT, UHOM_FLEE, UHOM_PDODGE, UHOM_CRIT, UHOM_RACE, UHOM_ELETYPE, UHOM_ELELEVEL, UHOM_AMOTION, UHOM_ADELAY, UHOM_DMOTION, }; enum unitdata_pettypes { UPET_SIZE = 0, UPET_LEVEL, UPET_HP, UPET_MAXHP, UPET_MASTERAID, UPET_MAPID, UPET_X, UPET_Y, UPET_HUNGER, UPET_INTIMACY, UPET_SPEED, UPET_LOOKDIR, UPET_CANMOVETICK, UPET_STR, UPET_AGI, UPET_VIT, UPET_INT, UPET_DEX, UPET_LUK, UPET_DMGIMMUNE, UPET_ATKRANGE, UPET_ATKMIN, UPET_ATKMAX, UPET_MATKMIN, UPET_MATKMAX, UPET_DEF, UPET_MDEF, UPET_HIT, UPET_FLEE, UPET_PDODGE, UPET_CRIT, UPET_RACE, UPET_ELETYPE, UPET_ELELEVEL, UPET_AMOTION, UPET_ADELAY, UPET_DMOTION, }; enum unitdata_merctypes { UMER_SIZE = 0, UMER_HP, UMER_MAXHP, UMER_MASTERCID, UMER_MAPID, UMER_X, UMER_Y, UMER_KILLCOUNT, UMER_LIFETIME, UMER_SPEED, UMER_LOOKDIR, UMER_CANMOVETICK, UMER_STR, UMER_AGI, UMER_VIT, UMER_INT, UMER_DEX, UMER_LUK, UMER_DMGIMMUNE, UMER_ATKRANGE, UMER_ATKMIN, UMER_ATKMAX, UMER_MATKMIN, UMER_MATKMAX, UMER_DEF, UMER_MDEF, UMER_HIT, UMER_FLEE, UMER_PDODGE, UMER_CRIT, UMER_RACE, UMER_ELETYPE, UMER_ELELEVEL, UMER_AMOTION, UMER_ADELAY, UMER_DMOTION, }; enum unitdata_elemtypes { UELE_SIZE = 0, UELE_HP, UELE_MAXHP, UELE_SP, UELE_MAXSP, UELE_MASTERCID, UELE_MAPID, UELE_X, UELE_Y, UELE_LIFETIME, UELE_MODE, UELE_SPEED, UELE_LOOKDIR, UELE_CANMOVETICK, UELE_STR, UELE_AGI, UELE_VIT, UELE_INT, UELE_DEX, UELE_LUK, UELE_DMGIMMUNE, UELE_ATKRANGE, UELE_ATKMIN, UELE_ATKMAX, UELE_MATKMIN, UELE_MATKMAX, UELE_DEF, UELE_MDEF, UELE_HIT, UELE_FLEE, UELE_PDODGE, UELE_CRIT, UELE_RACE, UELE_ELETYPE, UELE_ELELEVEL, UELE_AMOTION, UELE_ADELAY, UELE_DMOTION, }; enum unitdata_npctypes { UNPC_DISPLAY = 0, UNPC_LEVEL, UNPC_HP, UNPC_MAXHP, UNPC_MAPID, UNPC_X, UNPC_Y, UNPC_LOOKDIR, UNPC_STR, UNPC_AGI, UNPC_VIT, UNPC_INT, UNPC_DEX, UNPC_LUK, UNPC_PLUSALLSTAT, UNPC_DMGIMMUNE, UNPC_ATKRANGE, UNPC_ATKMIN, UNPC_ATKMAX, UNPC_MATKMIN, UNPC_MATKMAX, UNPC_DEF, UNPC_MDEF, UNPC_HIT, UNPC_FLEE, UNPC_PDODGE, UNPC_CRIT, UNPC_RACE, UNPC_ELETYPE, UNPC_ELELEVEL, UNPC_AMOTION, UNPC_ADELAY, UNPC_DMOTION, }; enum navigation_service { NAV_NONE = 0, ///< 0 NAV_AIRSHIP_ONLY = 1, ///< 1 (actually 1-9) NAV_SCROLL_ONLY = 10, ///< 10 NAV_AIRSHIP_AND_SCROLL = NAV_AIRSHIP_ONLY + NAV_SCROLL_ONLY, ///< 11 (actually 11-99) NAV_KAFRA_ONLY = 100, ///< 100 NAV_KAFRA_AND_AIRSHIP = NAV_KAFRA_ONLY + NAV_AIRSHIP_ONLY, ///< 101 (actually 101-109) NAV_KAFRA_AND_SCROLL = NAV_KAFRA_ONLY + NAV_SCROLL_ONLY, ///< 110 NAV_ALL = NAV_AIRSHIP_ONLY + NAV_SCROLL_ONLY + NAV_KAFRA_ONLY ///< 111 (actually 111-255) }; enum random_option_attribute { ROA_ID = 0, ROA_VALUE, ROA_PARAM, }; enum instance_info_type { IIT_ID, IIT_TIME_LIMIT, IIT_IDLE_TIMEOUT, IIT_ENTER_MAP, IIT_ENTER_X, IIT_ENTER_Y, IIT_MAPCOUNT, IIT_MAP }; enum vip_status_type { VIP_STATUS_ACTIVE = 1, VIP_STATUS_EXPIRE, VIP_STATUS_REMAINING }; /** * used to generate quick script_array entries **/ struct eri *array_ers; DBMap *st_db; unsigned int active_scripts; unsigned int next_id; struct eri *st_ers; struct eri *stack_ers; const char* skip_space(const char* p); void script_error(const char* src, const char* file, int start_line, const char* error_msg, const char* error_pos); void script_warning(const char* src, const char* file, int start_line, const char* error_msg, const char* error_pos); struct script_code* parse_script(const char* src,const char* file,int line,int options); void run_script(struct script_code *rootscript,int pos,int rid,int oid); int set_reg(struct script_state* st, TBL_PC* sd, int64 num, const char* name, const void* value, struct reg_db *ref); int set_var(struct map_session_data *sd, char *name, void *val); int conv_num(struct script_state *st,struct script_data *data); const char* conv_str(struct script_state *st,struct script_data *data); void pop_stack(struct script_state* st, int start, int end); int run_script_timer(int tid, unsigned int tick, int id, intptr_t data); void script_stop_sleeptimers(int id); struct linkdb_node *script_erase_sleepdb(struct linkdb_node *n); void run_script_main(struct script_state *st); void script_stop_instances(struct script_code *code); void script_free_code(struct script_code* code); void script_free_vars(struct DBMap *storage); struct script_state* script_alloc_state(struct script_code* rootscript, int pos, int rid, int oid); void script_free_state(struct script_state* st); struct DBMap* script_get_label_db(void); struct DBMap* script_get_userfunc_db(void); void script_run_autobonus(const char *autobonus, struct map_session_data *sd, unsigned int pos); bool script_get_constant(const char* name, int* value); void script_set_constant(const char* name, int value, bool isparameter, bool deprecated); void script_hardcoded_constants(void); void script_cleararray_pc(struct map_session_data* sd, const char* varname, void* value); void script_setarray_pc(struct map_session_data* sd, const char* varname, uint32 idx, void* value, int* refcache); int script_config_read(char *cfgName); void do_init_script(void); void do_final_script(void); int add_str(const char* p); const char* get_str(int id); void script_reload(void); // @commands (script based) void setd_sub(struct script_state *st, TBL_PC *sd, const char *varname, int elem, void *value, struct reg_db *ref); /** * Array Handling **/ struct reg_db *script_array_src(struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref); void script_array_update(struct reg_db *src, int64 num, bool empty); void script_array_delete(struct reg_db *src, struct script_array *sa); void script_array_remove_member(struct reg_db *src, struct script_array *sa, unsigned int idx); void script_array_add_member(struct script_array *sa, unsigned int idx); unsigned int script_array_size(struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref); unsigned int script_array_highest_key(struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref); void script_array_ensure_zero(struct script_state *st, struct map_session_data *sd, int64 uid, struct reg_db *ref); int script_free_array_db(DBKey key, DBData *data, va_list ap); /* */ void script_reg_destroy_single(struct map_session_data *sd, int64 reg, struct script_reg_state *data); int script_reg_destroy(DBKey key, DBData *data, va_list ap); /* */ void script_generic_ui_array_expand(unsigned int plus); unsigned int *script_array_cpy_list(struct script_array *sa); #ifdef BETA_THREAD_TEST void queryThread_log(char * entry, int length); #endif #endif /* _SCRIPT_H_ */