Merge pull request #1 from HerculesWS/master

Update from original

1 files changed, 545 insertions, 217 deletions

diff --git a/src/map/script.h b/src/map/script.h
index 3cfcd9de4..48abf1487 100644
--- a/src/map/script.h
+++ b/src/map/script.h
@@ -1,41 +1,177 @@
-// Copyright (c) Athena Dev Teams - Licensed under GNU GPL
-// For more information, see LICENCE in the main folder
+// Copyright (c) Hercules Dev Team, licensed under GNU GPL.
+// See the LICENSE file
+// Portions Copyright (c) Athena Dev Teams
 
-#ifndef _SCRIPT_H_
-#define _SCRIPT_H_
+#ifndef MAP_SCRIPT_H
+#define MAP_SCRIPT_H
+
+#include <errno.h>
+#include <setjmp.h>
 
 #include "map.h" //EVENT_NAME_LENGTH
+#include "../common/cbasetypes.h"
+#include "../common/db.h"
+#include "../common/mmo.h" // struct item
+#include "../common/sql.h" // Sql
+#include "../common/strlib.h" //StringBuf
+
+/**
+ * Declarations
+ **/
+struct eri;
+
+/**
+ * Defines
+ **/
+// TODO: Remove temporary code
+#define ENABLE_CASE_CHECK
+#define get_script_source(source) ((source) ? (source) : "Unknown (Possibly source or variables stored in database")
+#define DeprecationWarning(func, bad, good, file, line) ShowError("%s: use of deprecated keyword '%s' (use '%s' instead) in file '%s', line '%d'.\n", (func), (bad), (good), get_script_source(file), (line));
+#define DeprecationWarning2(func, bad, good, where) ShowError("%s: detected possible use of wrong case in a script. Found '%s', probably meant to be '%s' (in '%s').\n", (func), (bad), (good), get_script_source(where));
+#define disp_deprecation_message(func, good, p) disp_warning_message(func": use of deprecated keyword (use '"good"' instead).", (p));
 
 #define NUM_WHISPER_VAR 10
 
-struct map_session_data;
-struct eri;
+/// Maximum amount of elements in script arrays
+#define SCRIPT_MAX_ARRAYSIZE (UINT_MAX - 1)
 
-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;
+#define SCRIPT_BLOCK_SIZE 512
 
-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;
+// Using a prime number for SCRIPT_HASH_SIZE should give better distributions
+#define SCRIPT_HASH_SIZE 1021
 
-	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;
+// Specifies which string hashing method to use
+//#define SCRIPT_HASH_DJB2
+//#define SCRIPT_HASH_SDBM
+#define SCRIPT_HASH_ELF
 
-	const char* ontouch_name;
-	const char* ontouch2_name;
-} script_config;
+#define SCRIPT_EQUIP_TABLE_SIZE 20
+
+//#define SCRIPT_DEBUG_DISP
+//#define SCRIPT_DEBUG_DISASM
+//#define SCRIPT_DEBUG_HASH
+//#define SCRIPT_DEBUG_DUMP_STACK
+
+///////////////////////////////////////////////////////////////////////////////
+//## 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) (script->push_val((st)->stack, C_INT, (val),NULL))
+/// Pushes a string into the stack (script engine frees it automatically)
+#define script_pushstr(st,val) (script->push_str((st)->stack, C_STR, (val)))
+/// Pushes a copy of a string into the stack
+#define script_pushstrcopy(st,val) (script->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) (script->push_str((st)->stack, C_CONSTSTR, (val)))
+/// Pushes a nil into the stack
+#define script_pushnil(st) (script->push_val((st)->stack, C_NOP, 0,NULL))
+/// Pushes a copy of the data in the target index
+#define script_pushcopy(st,i) (script->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_isstringtype(st,i) data_isstring(script->get_val((st), script_getdata((st),(i))))
+#define script_isinttype(st,i) data_isint(script->get_val((st), script_getdata((st),(i))))
+
+#define script_getnum(st,val) (script->conv_num((st), script_getdata((st),(val))))
+#define script_getstr(st,val) (script->conv_str((st), script_getdata((st),(val))))
+#define script_getref(st,val) ( script_getdata((st),(val))->ref )
+
+// 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) script->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) ( script->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) ( script->str_data[reference_getid(data)].type == C_INT )
+/// Returns if this a reference to a param
+#define reference_toparam(data) ( script->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) ( script->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) ( script->str_buf + script->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) ( script->str_data[reference_getid(data)].val )
+/// Returns the type of param
+#define reference_getparamtype(data) ( script->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 BUILDIN(x) bool buildin_ ## x (struct script_state* st)
+
+#define script_fetch(st, n, t) do { \
+	if( script_hasdata((st),(n)) ) \
+		(t)=script_getnum((st),(n)); \
+	else \
+		(t) = 0; \
+} while(0)
+
+
+/**
+ * Enumerations
+ **/
 typedef enum c_op {
 	C_NOP, // end of script/no value (nil)
 	C_POS,
@@ -51,7 +187,7 @@ typedef enum c_op {
 	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
@@ -75,57 +211,189 @@ typedef enum c_op {
 	C_NOT, // ~ a
 	C_R_SHIFT, // a >> b
 	C_L_SHIFT, // a << b
-	C_ADD_PP, // ++a
-	C_SUB_PP, // --a
+	C_ADD_POST, // a++
+	C_SUB_POST, // a--
+	C_ADD_PRE, // ++a
+	C_SUB_PRE, // --a
+#ifdef PCRE_SUPPORT
+	C_RE_EQ, // ~=
+	C_RE_NE, // ~!
+#endif // PCRE_SUPPORT
 } c_op;
 
+enum hQueueOpt {
+	HQO_NONE,
+	HQO_onLogOut,
+	HQO_OnDeath,
+	HQO_OnMapChange,
+	HQO_MAX,
+};
+
+enum e_script_state { RUN,STOP,END,RERUNLINE,GOTO,RETFUNC,CLOSE };
+
+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 { LABEL_NEXTLINE=1,LABEL_START };
+
+// for advanced scripting support ( nested if, switch, while, for, do-while, function, etc )
+// [Eoe / jA 1080, 1081, 1094, 1164]
+enum curly_type {
+	TYPE_NULL = 0,
+	TYPE_IF,
+	TYPE_SWITCH,
+	TYPE_WHILE,
+	TYPE_FOR,
+	TYPE_DO,
+	TYPE_USERFUNC,
+	TYPE_ARGLIST // function argument list
+};
+
+enum e_arglist {
+	ARGLIST_UNDEFINED = 0,
+	ARGLIST_NO_PAREN  = 1,
+	ARGLIST_PAREN     = 2,
+};
+
+/*==========================================
+ * (Only those needed) local declaration prototype
+ * - those could be used server-wide so that the scans are done once during processing and never again,
+ * - doing so would also improve map zone processing and storage [Ind]
+ *------------------------------------------*/
+
+enum {
+	MF_NOMEMO,	//0
+	MF_NOTELEPORT,
+	MF_NOSAVE,
+	MF_NOBRANCH,
+	MF_NOPENALTY,
+	MF_NOZENYPENALTY,
+	MF_PVP,
+	MF_PVP_NOPARTY,
+	MF_PVP_NOGUILD,
+	MF_GVG,
+	MF_GVG_NOPARTY,	//10
+	MF_NOTRADE,
+	MF_NOSKILL,
+	MF_NOWARP,
+	MF_PARTYLOCK,
+	MF_NOICEWALL,
+	MF_SNOW,
+	MF_FOG,
+	MF_SAKURA,
+	MF_LEAVES,
+	/* 21 - 22 free */
+	MF_CLOUDS = 23,
+	MF_CLOUDS2,
+	MF_FIREWORKS,
+	MF_GVG_CASTLE,
+	MF_GVG_DUNGEON,
+	MF_NIGHTENABLED,
+	MF_NOBASEEXP,
+	MF_NOJOBEXP,	//30
+	MF_NOMOBLOOT,
+	MF_NOMVPLOOT,
+	MF_NORETURN,
+	MF_NOWARPTO,
+	MF_NIGHTMAREDROP,
+	MF_ZONE,
+	MF_NOCOMMAND,
+	MF_NODROP,
+	MF_JEXP,
+	MF_BEXP,	//40
+	MF_NOVENDING,
+	MF_LOADEVENT,
+	MF_NOCHAT,
+	MF_NOEXPPENALTY,
+	MF_GUILDLOCK,
+	MF_TOWN,
+	MF_AUTOTRADE,
+	MF_ALLOWKS,
+	MF_MONSTER_NOTELEPORT,
+	MF_PVP_NOCALCRANK,	//50
+	MF_BATTLEGROUND,
+	MF_RESET,
+	MF_NOTOMB,
+	MF_NOCASHSHOP
+};
+
+/**
+ * Structures
+ **/
+
+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;
+
+	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* ontouch_name;
+	const char* ontouch2_name;
+};
+
+/**
+ * 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 DBMap* var_function;// scope variables
-	struct script_code* script;// script code
-	int pos;// script location
-	int nargs;// argument count
-	int defsp;// default stack pointer
+	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 {
-		int num;
+		int64 num;
 		char *str;
 		struct script_retinfo* ri;
 	} u;
-	struct DBMap** ref;
+	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 DBMap* script_vars;
+	unsigned char *script_buf;
+	struct reg_db local; ///< Local (npc) vars
+	unsigned short instances;
 };
 
 struct script_stack {
-	int sp;// number of entries in the stack
-	int sp_max;// capacity of the 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 DBMap* var_function;// scope variables
-};
-
-enum hQueueOpt {
-	HQO_NONE,
-	HQO_onLogOut,
-	HQO_OnDeath,
-	HQO_OnMapChange,
-	HQO_MAX,
+	struct script_data *stack_data; ///< stack
+	struct reg_db scope;            ///< scope variables
 };
 
 /* [Ind/Hercules] */
 struct hQueue {
 	int id;
 	int *item;
-	int items;
+	int items;/* how many actual items are in the array */
+	int size;/* size of the *item array, not the current amount of items in it since it can have empty slots */
 	/* events */
 	char onLogOut[EVENT_NAME_LENGTH];
 	char onDeath[EVENT_NAME_LENGTH];
@@ -138,18 +406,15 @@ struct hQueueIterator {
 	int pos;
 };
 
-//
-// Script state
-//
-enum e_script_state { RUN,STOP,END,RERUNLINE,GOTO,RETFUNC,CLOSE };
-
 struct script_state {
 	struct script_stack* stack;
+	struct reg_db **pending_refs; ///< References to .vars returned by sub-functions, pending deletion.
+	int pending_ref_count;        ///< Amount of pending_refs currently stored.
 	int start,end;
 	int pos;
 	enum e_script_state state;
 	int rid,oid;
-	struct script_code *script, *scriptroot;
+	struct script_code *script;
 	struct sleep_data {
 		int tick,timer,charid;
 	} sleep;
@@ -164,58 +429,6 @@ struct script_state {
 	unsigned int id;
 };
 
-struct script_reg {
-	int index;
-	int data;
-};
-
-struct script_regstr {
-	int index;
-	char* data;
-};
-
-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
-};
-
-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);
-
-struct script_code* parse_script(const char* src,const char* file,int line,int options);
-void run_script_sub(struct script_code *rootscript,int pos,int rid,int oid, char* file, int lineno);
-void run_script(struct script_code*,int,int,int);
-
-int set_var(struct map_session_data *sd, char *name, void *val);
-int run_script_timer(int tid, unsigned int tick, int id, intptr_t data);
-void run_script_main(struct script_state *st);
-
-void script_stop_instances(int id);
-struct linkdb_node* script_erase_sleepdb(struct linkdb_node *n);
-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,int id, int pos);
-
-bool script_get_constant(const char* name, int* value);
-void script_set_constant(const char* name, int value, bool isparameter);
-
-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, uint8 idx, void* value, int* refcache);
-
-int script_config_read(char *cfgName);
-int add_str(const char* p);
-const char* get_str(int id);
-int script_reload(void);
-
-// @commands (script based)
-void setd_sub(struct script_state *st, struct map_session_data *sd, const char *varname, int elem, void *value, struct DBMap **ref);
-
 struct script_function {
 	bool (*func)(struct script_state *st);
 	char *name;
@@ -234,106 +447,44 @@ struct str_data_struct {
 	int next;
 };
 
-///////////////////////////////////////////////////////////////////////////////
-//## 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) script->push_val((st)->stack, C_INT, (val),NULL)
-/// Pushes a string into the stack (script engine frees it automatically)
-#define script_pushstr(st,val) script->push_str((st)->stack, C_STR, (val))
-/// Pushes a copy of a string into the stack
-#define script_pushstrcopy(st,val) script->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) script->push_str((st)->stack, C_CONSTSTR, (val))
-/// Pushes a nil into the stack
-#define script_pushnil(st) script->push_val((st)->stack, C_NOP, 0,NULL)
-/// Pushes a copy of the data in the target index
-#define script_pushcopy(st,i) script->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) script->conv_num(st, script_getdata(st,val))
-#define script_getstr(st,val) script->conv_str(st, script_getdata(st,val))
-#define script_getref(st,val) ( script_getdata(st,val)->ref )
-
-// 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) script->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) ( script->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) ( script->str_data[reference_getid(data)].type == C_INT )
-/// Returns if this a reference to a param
-#define reference_toparam(data) ( script->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) ( script->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)(reference_getuid(data) & 0x00ffffff) )
-/// Returns the array index of the reference
-#define reference_getindex(data) ( (int32)(((uint32)(reference_getuid(data) & 0xff000000)) >> 24) )
-/// Returns the name of the reference
-#define reference_getname(data) ( script->str_buf + script->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) ( script->str_data[reference_getid(data)].val )
-/// Returns the type of param
-#define reference_getparamtype(data) ( script->str_data[reference_getid(data)].val )
+struct script_label_entry {
+	int key,pos;
+};
 
-/// Composes the uid of a reference from the id and the index
-#define reference_uid(id,idx) ( (int32)((((uint32)(id)) & 0x00ffffff) | (((uint32)(idx)) << 24)) )
+struct script_syntax_data {
+	struct {
+		enum curly_type type;
+		int index;
+		int count;
+		int flag;
+		struct linkdb_node *case_label;
+	} curly[256];		// Information right parenthesis
+	int curly_count;	// The number of right brackets
+	int index;			// Number of the syntax used in the script
+};
 
-#define not_server_variable(prefix) ( (prefix) != '$' && (prefix) != '.' && (prefix) != '\'')
-#define not_array_variable(prefix) ( (prefix) != '$' && (prefix) != '@' && (prefix) != '.' && (prefix) != '\'' )
-#define is_string_variable(name) ( (name)[strlen(name) - 1] == '$' )
+struct casecheck_data {
+	struct str_data_struct *str_data;
+	int str_data_size; // size of the data
+	int str_num; // next id to be assigned
+	// str_buf holds the strings themselves
+	char *str_buf;
+	int str_size; // size of the buffer
+	int str_pos; // next position to be assigned
+	int str_hash[SCRIPT_HASH_SIZE];
+	const char *(*add_str) (const char* p);
+	void (*clear) (void);
+};
 
-#define BUILDIN(x) bool buildin_ ## x (struct script_state* st)
-#define BUILDIN_A(x) buildin_ ## x 
+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 */
+};
 
-/* script.c interface (incomplete) */
+/**
+ * Interface
+ **/
 struct script_interface {
 	/* */
 	DBMap *st_db;
@@ -345,46 +496,223 @@ struct script_interface {
 	struct hQueue *hq;
 	struct hQueueIterator *hqi;
 	int hqs, hqis;
-	int hqe[HQO_MAX];
 	/*  */
 	char **buildin;
 	unsigned int buildin_count;
+	/**
+	 * used to generate quick script_array entries
+	 **/
+	struct eri *array_ers;
 	/* */
 	struct str_data_struct *str_data;
 	int str_data_size; // size of the data
 	int str_num; // next id to be assigned
 	// str_buf holds the strings themselves
 	char *str_buf;
-	int str_size; // size of the buffer
+	size_t str_size; // size of the buffer
 	int str_pos; // next position to be assigned
-	//
+	int str_hash[SCRIPT_HASH_SIZE];
+	/* */
 	char *word_buf;
-	int word_size;
+	size_t word_size;
 	/*  */
-	void (*init) (void);
-	void (*final) (void);
+	unsigned short current_item_id;
+	/* */
+	struct script_label_entry *labels;
+	int label_count;
+	int labels_size;
+	/* */
+	struct Script_Config config;
+	/* */
+	/// temporary buffer for passing around compiled bytecode
+	/// @see add_scriptb, set_label, parse_script
+	unsigned char* buf;
+	int pos, size;
+	/* */
+	struct script_syntax_data syntax;
+	/* */
+	int parse_options;
+	// important buildin function references for usage in scripts
+	int buildin_set_ref;
+	int buildin_callsub_ref;
+	int buildin_callfunc_ref;
+	int buildin_getelementofarray_ref;
+	/* */
+	jmp_buf     error_jump;
+	char*       error_msg;
+	const char* error_pos;
+	int         error_report; // if the error should produce output
+	// Used by disp_warning_message
+	const char* parser_current_src;
+	const char* parser_current_file;
+	int         parser_current_line;
+	int parse_syntax_for_flag;
+	// aegis->athena slot position conversion table
+	unsigned int equip[SCRIPT_EQUIP_TABLE_SIZE];
+	/* */
+	/* Caches compiled autoscript item code. */
+	/* Note: This is not cleared when reloading itemdb. */
+	DBMap* autobonus_db; // char* script -> char* bytecode
+	DBMap* userfunc_db; // const char* func_name -> struct script_code*
+	/* */
+	int potion_flag; //For use on Alchemist improved potions/Potion Pitcher. [Skotlex]
+	int potion_hp, potion_per_hp, potion_sp, potion_per_sp;
+	int potion_target;
+	/* */
+	unsigned int *generic_ui_array;
+	unsigned int generic_ui_array_size;
 	/*  */
+	void (*init) (bool minimal);
+	void (*final) (void);
+	int  (*reload) (void);
+	/* parse */
+	struct script_code* (*parse) (const char* src,const char* file,int line,int options, int *retval);
+	bool (*add_builtin) (const struct script_function *buildin, bool override);
 	void (*parse_builtin) (void);
+	const char* (*parse_subexpr) (const char* p,int limit);
+	const char* (*skip_space) (const char* p);
+	void (*error) (const char* src, const char* file, int start_line, const char* error_msg, const char* error_pos);
+	void (*warning) (const char* src, const char* file, int start_line, const char* error_msg, const char* error_pos);
+	/* */
 	bool (*addScript) (char *name, char *args, bool (*func)(struct script_state *st));
 	int (*conv_num) (struct script_state *st,struct script_data *data);
 	const char* (*conv_str) (struct script_state *st,struct script_data *data);
 	TBL_PC *(*rid2sd) (struct script_state *st);
 	void (*detach_rid) (struct script_state* st);
-	struct script_data* (*push_val)(struct script_stack* stack, enum c_op type, int val, struct DBMap** ref);
-	void (*get_val) (struct script_state* st, struct script_data* data);
-	void* (*get_val2) (struct script_state* st, int uid, struct DBMap** ref);
+	struct script_data* (*push_val)(struct script_stack* stack, enum c_op type, int64 val, struct reg_db *ref);
+	struct script_data *(*get_val) (struct script_state* st, struct script_data* data);
+	void* (*get_val2) (struct script_state* st, int64 uid, struct reg_db *ref);
 	struct script_data* (*push_str) (struct script_stack* stack, enum c_op type, char* str);
 	struct script_data* (*push_copy) (struct script_stack* stack, int pos);
 	void (*pop_stack) (struct script_state* st, int start, int end);
+	void (*set_constant) (const char* name, int value, bool isparameter);
+	void (*set_constant2) (const char *name, int value, bool isparameter);
+	bool (*get_constant) (const char* name, int* value);
+	void (*label_add)(int key, int pos);
+	void (*run) (struct script_code *rootscript,int pos,int rid,int oid);
+	void (*run_main) (struct script_state *st);
+	int (*run_timer) (int tid, int64 tick, int id, intptr_t data);
+	int (*set_var) (struct map_session_data *sd, char *name, void *val);
+	void (*stop_instances) (struct script_code *code);
+	void (*free_code) (struct script_code* code);
+	void (*free_vars) (struct DBMap *var_storage);
+	struct script_state* (*alloc_state) (struct script_code* rootscript, int pos, int rid, int oid);
+	void (*free_state) (struct script_state* st);
+	void (*add_pending_ref) (struct script_state *st, struct reg_db *ref);
+	void (*run_autobonus) (const char *autobonus,int id, int pos);
+	void (*cleararray_pc) (struct map_session_data* sd, const char* varname, void* value);
+	void (*setarray_pc) (struct map_session_data* sd, const char* varname, uint32 idx, void* value, int* refcache);
+	int (*config_read) (char *cfgName);
+	int (*add_str) (const char* p);
+	const char* (*get_str) (int id);
+	int (*search_str) (const char* p);
+	void (*setd_sub) (struct script_state *st, struct map_session_data *sd, const char *varname, int elem, void *value, struct reg_db *ref);
+	void (*attach_state) (struct script_state* st);
 	/* */
 	struct hQueue *(*queue) (int idx);
 	bool (*queue_add) (int idx, int var);
 	bool (*queue_del) (int idx);
 	bool (*queue_remove) (int idx, int var);
-} script_s;
+	int (*queue_create) (void);
+	void (*queue_clear) (int idx);
+	/* */
+	const char * (*parse_curly_close) (const char *p);
+	const char * (*parse_syntax_close) (const char *p);
+	const char * (*parse_syntax_close_sub) (const char *p, int *flag);
+	const char * (*parse_syntax) (const char *p);
+	c_op (*get_com) (unsigned char *scriptbuf, int *pos);
+	int (*get_num) (unsigned char *scriptbuf, int *pos);
+	const char* (*op2name) (int op);
+	void (*reportsrc) (struct script_state *st);
+	void (*reportdata) (struct script_data *data);
+	void (*reportfunc) (struct script_state *st);
+	void (*disp_warning_message) (const char *mes, const char *pos);
+	void (*check_event) (struct script_state *st, const char *evt);
+	unsigned int (*calc_hash) (const char *p);
+	void (*addb) (int a);
+	void (*addc) (int a);
+	void (*addi) (int a);
+	void (*addl) (int l);
+	void (*set_label) (int l, int pos, const char *script_pos);
+	const char* (*skip_word) (const char *p);
+	int (*add_word) (const char *p);
+	const char* (*parse_callfunc) (const char *p, int require_paren, int is_custom);
+	void (*parse_nextline) (bool first, const char *p);
+	const char* (*parse_variable) (const char *p);
+	const char* (*parse_simpleexpr) (const char *p);
+	const char* (*parse_expr) (const char *p);
+	const char* (*parse_line) (const char *p);
+	void (*read_constdb) (void);
+	const char* (*print_line) (StringBuf *buf, const char *p, const char *mark, int line);
+	void (*errorwarning_sub) (StringBuf *buf, const char *src, const char *file, int start_line, const char *error_msg, const char *error_pos);
+	int (*set_reg) (struct script_state *st, TBL_PC *sd, int64 num, const char *name, const void *value, struct reg_db *ref);
+	void (*stack_expand) (struct script_stack *stack);
+	struct script_data* (*push_retinfo) (struct script_stack *stack, struct script_retinfo *ri, struct reg_db *ref);
+	void (*op_3) (struct script_state *st, int op);
+	void (*op_2str) (struct script_state *st, int op, const char *s1, const char *s2);
+	void (*op_2num) (struct script_state *st, int op, int i1, int i2);
+	void (*op_2) (struct script_state *st, int op);
+	void (*op_1) (struct script_state *st, int op);
+	void (*check_buildin_argtype) (struct script_state *st, int func);
+	void (*detach_state) (struct script_state *st, bool dequeue_event);
+	int (*db_free_code_sub) (DBKey key, DBData *data, va_list ap);
+	void (*add_autobonus) (const char *autobonus);
+	int (*menu_countoptions) (const char *str, int max_count, int *total);
+	int (*buildin_areawarp_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_areapercentheal_sub) (struct block_list *bl, va_list ap);
+	void (*buildin_delitem_delete) (struct map_session_data *sd, int idx, int *amount, bool delete_items);
+	bool (*buildin_delitem_search) (struct map_session_data *sd, struct item *it, bool exact_match);
+	int (*buildin_killmonster_sub_strip) (struct block_list *bl, va_list ap);
+	int (*buildin_killmonster_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_killmonsterall_sub_strip) (struct block_list *bl, va_list ap);
+	int (*buildin_killmonsterall_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_announce_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_getareausers_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_getareadropitem_sub) (struct block_list *bl, va_list ap);
+	int (*mapflag_pvp_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_pvpoff_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_maprespawnguildid_sub_pc) (struct map_session_data *sd, va_list ap);
+	int (*buildin_maprespawnguildid_sub_mob) (struct block_list *bl, va_list ap);
+	int (*buildin_mobcount_sub) (struct block_list *bl, va_list ap);
+	int (*playbgm_sub) (struct block_list *bl, va_list ap);
+	int (*playbgm_foreachpc_sub) (struct map_session_data *sd, va_list args);
+	int (*soundeffect_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_query_sql_sub) (struct script_state *st, Sql *handle);
+	int (*buildin_instance_warpall_sub) (struct block_list *bl, va_list ap);
+	int (*buildin_mobuseskill_sub) (struct block_list *bl, va_list ap);
+	int (*cleanfloor_sub) (struct block_list *bl, va_list ap);
+	int (*run_func) (struct script_state *st);
+	const char *(*getfuncname) (struct script_state *st);
+	// for ENABLE_CASE_CHECK
+	unsigned int (*calc_hash_ci) (const char *p);
+	struct casecheck_data local_casecheck;
+	struct casecheck_data global_casecheck;
+	// end ENABLE_CASE_CHECK
+	/**
+	 * Array Handling
+	 **/
+	struct reg_db *(*array_src) (struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref);
+	void (*array_update) (struct reg_db *src, int64 num, bool empty);
+	void (*array_delete) (struct reg_db *src, struct script_array *sa);
+	void (*array_remove_member) (struct reg_db *src, struct script_array *sa, unsigned int idx);
+	void (*array_add_member) (struct script_array *sa, unsigned int idx);
+	unsigned int (*array_size) (struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref);
+	unsigned int (*array_highest_key) (struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref);
+	int (*array_free_db) (DBKey key, DBData *data, va_list ap);
+	void (*array_ensure_zero) (struct script_state *st, struct map_session_data *sd, int64 uid, struct reg_db *ref);
+	/* */
+	void (*reg_destroy_single) (struct map_session_data *sd, int64 reg, struct script_reg_state *data);
+	int (*reg_destroy) (DBKey key, DBData *data, va_list ap);
+	/* */
+	void (*generic_ui_array_expand) (unsigned int plus);
+	unsigned int *(*array_cpy_list) (struct script_array *sa);
+	/* */
+	void (*hardcoded_constants) (void);
+	unsigned short (*mapindexname2id) (struct script_state *st, const char* name);
+};
 
 struct script_interface *script;
 
 void script_defaults(void);
 
-#endif /* _SCRIPT_H_ */
+#endif /* MAP_SCRIPT_H */