HPM: Script.c Completed

Fully Interfaced.
Moved missing vars and declarations of interest into the interface, removed duplicate mentions of script within calls to shorten wherever it made sense to.

Signed-off-by: shennetsind <ind@henn.et>

1 files changed, 325 insertions, 101 deletions

diff --git a/src/map/script.h b/src/map/script.h
index 97f9bdb8c..c00086ef9 100644
--- a/src/map/script.h
+++ b/src/map/script.h
@@ -1,11 +1,16 @@
-// 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_
 
+#include "../common/strlib.h" //StringBuf
 #include "map.h" //EVENT_NAME_LENGTH
 
+#include <setjmp.h>
+#include <errno.h>
+
 /**
  * Declarations
  **/
@@ -17,6 +22,130 @@ struct eri;
  **/
 #define NUM_WHISPER_VAR 10
 
+/// Maximum amount of elements in script arrays (soon getting ducked)
+#define SCRIPT_MAX_ARRAYSIZE 128
+
+#define SCRIPT_BLOCK_SIZE 512
+
+// Using a prime number for SCRIPT_HASH_SIZE should give better distributions
+#define SCRIPT_HASH_SIZE 1021
+
+// Specifies which string hashing method to use
+//#define SCRIPT_HASH_DJB2
+//#define SCRIPT_HASH_SDBM
+#define SCRIPT_HASH_ELF
+
+#define SCRIPT_EQUIP_TABLE_SIZE 14
+
+//#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_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 )
+
+/// Composes the uid of a reference from the id and the index
+#define reference_uid(id,idx) ( (int32)((((uint32)(id)) & 0x00ffffff) | (((uint32)(idx)) << 24)) )
+
+#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] == '$' )
+
+#define BUILDIN(x) bool buildin_ ## x (struct script_state* st)
+#define BUILDIN_A(x) buildin_ ## x
+
+#define script_fetch(st, n, t) \
+	if( script_hasdata(st,n) ) \
+		(t)=script_getnum(st,n);
+
+
 /**
  * Enumerations
  **/
@@ -79,6 +208,88 @@ enum script_parse_options {
 	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
+};
+
 /**
  * Structures
  **/
@@ -209,106 +420,21 @@ struct script_label_entry {
 	int key,pos;
 };
 
-///////////////////////////////////////////////////////////////////////////////
-//## 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 )
-
-/// Composes the uid of a reference from the id and the index
-#define reference_uid(id,idx) ( (int32)((((uint32)(id)) & 0x00ffffff) | (((uint32)(idx)) << 24)) )
-
-#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] == '$' )
-
-#define BUILDIN(x) bool buildin_ ## x (struct script_state* st)
-#define BUILDIN_A(x) buildin_ ## x 
+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
+};
 
-/* script.c interface (incomplete) */
+/**
+ * Interface
+ **/
 struct script_interface {
 	/* */
 	DBMap *st_db;
@@ -332,6 +458,7 @@ struct script_interface {
 	char *str_buf;
 	int 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;
@@ -344,6 +471,32 @@ struct script_interface {
 	/* */
 	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
@@ -405,6 +558,77 @@ struct script_interface {
 	bool (*queue_remove) (int idx, int var);
 	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_error_message2) (const char *mes, const char *pos, int report);
+	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, int num, const char *name, const void *value, struct DBMap **ref);
+	void (*stack_expand) (struct script_stack *stack);
+	struct script_data* (*push_retinfo) (struct script_stack *stack, struct script_retinfo *ri, DBMap **ref);
+	int (*pop_val) (struct script_state *st);
+	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);
+	int32 (*getarraysize) (struct script_state *st, int32 id, int32 idx, int isstring, struct DBMap **ref);
+	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 (*axtoi) (const char *hexStg);
+	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);
 };
 
 struct script_interface *script;