Added separate char* and const char* data types to struct script_data

Used, respectively, by C_STR and C_CONSTSTR

Signed-off-by: Haru <haru@dotalux.com>

3 files changed, 116 insertions, 92 deletions

diff --git a/src/map/atcommand.c b/src/map/atcommand.c
index 963f5c970..78d935ddc 100644
--- a/src/map/atcommand.c
+++ b/src/map/atcommand.c
@@ -8498,30 +8498,34 @@ ACMD(set)
 
 	CREATE(data, struct script_data,1);
 
-	if( is_str ) {// string variable
-		switch( reg[0] ) {
+	if (is_str) {
+		// string variable
+		const char *str = NULL;
+		switch (reg[0]) {
 			case '@':
-				data->u.str = pc->readregstr(sd, script->add_str(reg));
+				str = pc->readregstr(sd, script->add_str(reg));
 				break;
 			case '$':
-				data->u.str = mapreg->readregstr(script->add_str(reg));
+				str = mapreg->readregstr(script->add_str(reg));
 				break;
 			case '#':
-				if( reg[1] == '#' )
-					data->u.str = pc_readaccountreg2str(sd, script->add_str(reg));// global
+				if (reg[1] == '#')
+					str = pc_readaccountreg2str(sd, script->add_str(reg));// global
 				else
-					data->u.str = pc_readaccountregstr(sd, script->add_str(reg));// local
+					str = pc_readaccountregstr(sd, script->add_str(reg));// local
 				break;
 			default:
-				data->u.str = pc_readglobalreg_str(sd, script->add_str(reg));
+				str = pc_readglobalreg_str(sd, script->add_str(reg));
 				break;
 		}
-		if( data->u.str == NULL || data->u.str[0] == '\0' ) {// empty string
+		if (str == NULL || str[0] == '\0') {
+			// empty string
 			data->type = C_CONSTSTR;
 			data->u.str = "";
-		} else {// duplicate string
+		} else {
+			// duplicate string
 			data->type = C_STR;
-			data->u.str = aStrdup(data->u.str);
+			data->u.mutstr = aStrdup(str);
 		}
 	} else {// integer variable
 		data->type = C_INT;
@@ -8549,7 +8553,7 @@ ACMD(set)
 			safesnprintf(atcmd_output, sizeof(atcmd_output),msg_fd(fd,1373),reg,data->u.num); // %s value is now :%d
 			break;
 		case C_STR:
-			safesnprintf(atcmd_output, sizeof(atcmd_output),msg_fd(fd,1374),reg,data->u.str); // %s value is now :%s
+			safesnprintf(atcmd_output, sizeof(atcmd_output),msg_fd(fd,1374),reg,data->u.mutstr); // %s value is now :%s
 			break;
 		case C_CONSTSTR:
 			safesnprintf(atcmd_output, sizeof(atcmd_output),msg_fd(fd,1375),reg); // %s is empty
diff --git a/src/map/script.c b/src/map/script.c
index d2e474fa3..804fdd844 100644
--- a/src/map/script.c
+++ b/src/map/script.c
@@ -2864,43 +2864,46 @@ struct script_data *get_val(struct script_state* st, struct script_data* data) {
 		}
 	}
 
-	if( postfix == '$' ) {// string variable
+	if (postfix == '$') {
+		// string variable
+		const char *str = NULL;
 
-		switch( prefix ) {
+		switch (prefix) {
 			case '@':
-				data->u.str = pc->readregstr(sd, data->u.num);
+				str = pc->readregstr(sd, data->u.num);
 				break;
 			case '$':
-				data->u.str = mapreg->readregstr(data->u.num);
+				str = mapreg->readregstr(data->u.num);
 				break;
 			case '#':
-				if( name[1] == '#' )
-					data->u.str = pc_readaccountreg2str(sd, data->u.num);// global
+				if (name[1] == '#')
+					str = pc_readaccountreg2str(sd, data->u.num);// global
 				else
-					data->u.str = pc_readaccountregstr(sd, data->u.num);// local
+					str = pc_readaccountregstr(sd, data->u.num);// local
 				break;
 			case '.':
 				if (data->ref)
-					data->u.str = script->get_val_ref_str(st, data->ref, data);
+					str = script->get_val_ref_str(st, data->ref, data);
 				else if (name[1] == '@')
-					data->u.str = script->get_val_scope_str(st, &st->stack->scope, data);
+					str = script->get_val_scope_str(st, &st->stack->scope, data);
 				else
-					data->u.str = script->get_val_npc_str(st, &st->script->local, data);
+					str = script->get_val_npc_str(st, &st->script->local, data);
 				break;
 			case '\'':
-				data->u.str = script->get_val_instance_str(st, name, data);
+				str = script->get_val_instance_str(st, name, data);
 				break;
 			default:
-				data->u.str = pc_readglobalreg_str(sd, data->u.num);
+				str = pc_readglobalreg_str(sd, data->u.num);
 				break;
 		}
 
-		if( data->u.str == NULL || data->u.str[0] == '\0' ) {// empty string
+		if (str == NULL || str[0] == '\0') {
+			// empty string
 			data->type = C_CONSTSTR;
 			data->u.str = "";
 		} else {// duplicate string
 			data->type = C_STR;
-			data->u.str = aStrdup(data->u.str);
+			data->u.mutstr = aStrdup(str);
 		}
 
 	} else {// integer variable
@@ -3361,53 +3364,53 @@ void setd_sub(struct script_state *st, struct map_session_data *sd, const char *
 }
 
 /// Converts the data to a string
-const char* conv_str(struct script_state* st, struct script_data* data)
+const char *conv_str(struct script_state *st, struct script_data* data)
 {
-	char* p;
-
 	script->get_val(st, data);
-	if( data_isstring(data) )
-	{// nothing to convert
+	if (data_isstring(data)) {
+		// nothing to convert
+		return data->u.str;
 	}
-	else if( data_isint(data) )
-	{// int -> string
+	if (data_isint(data)) {
+		// int -> string
+		char *p;
 		CREATE(p, char, ITEM_NAME_LENGTH);
 		snprintf(p, ITEM_NAME_LENGTH, "%"PRId64"", data->u.num);
 		p[ITEM_NAME_LENGTH-1] = '\0';
 		data->type = C_STR;
-		data->u.str = p;
+		data->u.mutstr = p;
+		return data->u.mutstr;
 	}
-	else if( data_isreference(data) )
-	{// reference -> string
+	if (data_isreference(data)) {
+		// reference -> string
 		//##TODO when does this happen (check script->get_val) [FlavioJS]
 		data->type = C_CONSTSTR;
 		data->u.str = reference_getname(data);
-	}
-	else
-	{// unsupported data type
-		ShowError("script:conv_str: cannot convert to string, defaulting to \"\"\n");
-		script->reportdata(data);
-		script->reportsrc(st);
-		data->type = C_CONSTSTR;
-		data->u.str = "";
-	}
+		return data->u.str;
+	}
+	// unsupported data type
+	ShowError("script:conv_str: cannot convert to string, defaulting to \"\"\n");
+	script->reportdata(data);
+	script->reportsrc(st);
+	data->type = C_CONSTSTR;
+	data->u.str = "";
 	return data->u.str;
 }
 
 /// Converts the data to an int
-int conv_num(struct script_state* st, struct script_data* data) {
-	char* p;
+int conv_num(struct script_state *st, struct script_data *data)
+{
 	long num;
 
 	script->get_val(st, data);
-	if( data_isint(data) )
-	{// nothing to convert
+	if (data_isint(data)) {
+		// nothing to convert
+		return (int)data->u.num;
 	}
-	else if( data_isstring(data) )
-	{// string -> int
+	if (data_isstring(data)) {
+		// string -> int
 		// the result does not overflow or underflow, it is capped instead
 		// ex: 999999999999 is capped to INT_MAX (2147483647)
-		p = data->u.str;
 		errno = 0;
 		num = strtol(data->u.str, NULL, 10);// change radix to 0 to support octal numbers "o377" and hex numbers "0xFF"
 		if( errno == ERANGE
@@ -3429,22 +3432,21 @@ int conv_num(struct script_state* st, struct script_data* data) {
 			script->reportdata(data);
 			script->reportsrc(st);
 		}
-		if( data->type == C_STR )
-			aFree(p);
+		if (data->type == C_STR)
+			aFree(data->u.mutstr);
 		data->type = C_INT;
 		data->u.num = (int)num;
+		return (int)data->u.num;
 	}
 #if 0
+	// unsupported data type
 	// FIXME this function is being used to retrieve the position of labels and
 	// probably other stuff [FlavioJS]
-	else
-	{// unsupported data type
-		ShowError("script:conv_num: cannot convert to number, defaulting to 0\n");
-		script->reportdata(data);
-		script->reportsrc(st);
-		data->type = C_INT;
-		data->u.num = 0;
-	}
+	ShowError("script:conv_num: cannot convert to number, defaulting to 0\n");
+	script->reportdata(data);
+	script->reportsrc(st);
+	data->type = C_INT;
+	data->u.num = 0;
 #endif
 	return (int)data->u.num;
 }
@@ -3474,11 +3476,23 @@ struct script_data* push_val(struct script_stack* stack, enum c_op type, int64 v
 }
 
 /// Pushes a string into the stack
-struct script_data* push_str(struct script_stack* stack, enum c_op type, char* str)
+struct script_data *push_str(struct script_stack *stack, char *str)
 {
 	if( stack->sp >= stack->sp_max )
 		script->stack_expand(stack);
-	stack->stack_data[stack->sp].type  = type;
+	stack->stack_data[stack->sp].type  = C_STR;
+	stack->stack_data[stack->sp].u.mutstr = str;
+	stack->stack_data[stack->sp].ref   = NULL;
+	stack->sp++;
+	return &stack->stack_data[stack->sp-1];
+}
+
+/// Pushes a constant string into the stack
+struct script_data *push_conststr(struct script_stack *stack, const char *str)
+{
+	if( stack->sp >= stack->sp_max )
+		script->stack_expand(stack);
+	stack->stack_data[stack->sp].type  = C_CONSTSTR;
 	stack->stack_data[stack->sp].u.str = str;
 	stack->stack_data[stack->sp].ref   = NULL;
 	stack->sp++;
@@ -3500,10 +3514,10 @@ struct script_data* push_retinfo(struct script_stack* stack, struct script_retin
 struct script_data* push_copy(struct script_stack* stack, int pos) {
 	switch( stack->stack_data[pos].type ) {
 		case C_CONSTSTR:
-			return script->push_str(stack, C_CONSTSTR, stack->stack_data[pos].u.str);
+			return script->push_conststr(stack, stack->stack_data[pos].u.str);
 			break;
 		case C_STR:
-			return script->push_str(stack, C_STR, aStrdup(stack->stack_data[pos].u.str));
+			return script->push_str(stack, aStrdup(stack->stack_data[pos].u.mutstr));
 			break;
 		case C_RETINFO:
 			ShowFatalError("script:push_copy: can't create copies of C_RETINFO. Exiting...\n");
@@ -3537,8 +3551,8 @@ void pop_stack(struct script_state* st, int start, int end) {
 	for( i = start; i < end; i++ )
 	{
 		data = &stack->stack_data[i];
-		if( data->type == C_STR )
-			aFree(data->u.str);
+		if (data->type == C_STR)
+			aFree(data->u.mutstr);
 		if( data->type == C_RETINFO )
 		{
 			struct script_retinfo* ri = data->u.ri;
@@ -3769,12 +3783,11 @@ void op_3(struct script_state* st, int op)
 	data = script_getdatatop(st, -3);
 	script->get_val(st, data);
 
-	if( data_isstring(data) )
-		flag = data->u.str[0];// "" -> false
-	else if( data_isint(data) )
+	if (data_isstring(data)) {
+		flag = data->u.str[0]; // "" -> false
+	} else if (data_isint(data)) {
 		flag = data->u.num == 0 ? 0 : 1;// 0 -> false
-	else
-	{
+	} else {
 		ShowError("script:op_3: invalid data for the ternary operator test\n");
 		script->reportdata(data);
 		script->reportsrc(st);
@@ -3995,10 +4008,9 @@ void op_2(struct script_state *st, int op)
 		script->op_2str(st, op, left->u.str, right->u.str);
 		script_removetop(st, leftref.type == C_NOP ? -3 : -2, -1);// pop the two values before the top one
 
-		if (leftref.type != C_NOP)
-		{
+		if (leftref.type != C_NOP) {
 			if (left->type == C_STR) // don't free C_CONSTSTR
-				aFree(left->u.str);
+				aFree(left->u.mutstr);
 			*left = leftref;
 		}
 	}
@@ -4396,7 +4408,7 @@ void run_script_main(struct script_state *st) {
 				script->push_val(stack,c,0,NULL);
 				break;
 			case C_STR:
-				script->push_str(stack,C_CONSTSTR,(char*)(st->script->script_buf+st->pos));
+				script->push_conststr(stack, (const char *)(st->script->script_buf+st->pos));
 				while(st->script->script_buf[st->pos++]);
 				break;
 			case C_LSTR:
@@ -4408,7 +4420,7 @@ void run_script_main(struct script_state *st) {
 				st->pos += sizeof(int) + sizeof(uint8);
 
 				if( (!st->rid || !(lsd = map->id2sd(st->rid)) || !lsd->lang_id) && !map->default_lang_id )
-					script->push_str(stack,C_CONSTSTR,script->string_list+string_id);
+					script->push_conststr(stack, script->string_list+string_id);
 				else {
 					uint8 k, wlang_id = lsd ? lsd->lang_id : map->default_lang_id;
 					int offset = st->pos;
@@ -4420,8 +4432,10 @@ void run_script_main(struct script_state *st) {
 							break;
 						offset += sizeof(char*);
 					}
-					script->push_str(stack,C_CONSTSTR,
-							( k == translations ) ? script->string_list+string_id : *(char**)(&st->script->script_buf[offset]) );
+					if (k == translations)
+						script->push_conststr(stack, script->string_list+string_id);
+					else
+						script->push_conststr(stack, *(const char**)(&st->script->script_buf[offset]) );
 				}
 				st->pos += ( ( sizeof(char*) + sizeof(uint8) ) * translations );
 			}
@@ -6341,7 +6355,7 @@ BUILDIN(jobchange)
 BUILDIN(jobname)
 {
 	int class_=script_getnum(st,2);
-	script_pushconststr(st, (char*)pc->job_name(class_));
+	script_pushconststr(st, pc->job_name(class_));
 	return true;
 }
 
@@ -21152,6 +21166,7 @@ void script_defaults(void) {
 	script->get_val_npc_num = get_val_npcscope_num;
 	script->get_val_instance_num = get_val_instance_num;
 	script->push_str = push_str;
+	script->push_conststr = push_conststr;
 	script->push_copy = push_copy;
 	script->pop_stack = pop_stack;
 	script->set_constant = script_set_constant;
diff --git a/src/map/script.h b/src/map/script.h
index b12c84f96..9eb473f03 100644
--- a/src/map/script.h
+++ b/src/map/script.h
@@ -94,11 +94,11 @@ struct item_data;
 /// 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)))
+#define script_pushstr(st,val) (script->push_str((st)->stack, (val)))
 /// Pushes a copy of a string into the stack
-#define script_pushstrcopy(st,val) (script->push_str((st)->stack, C_STR, aStrdup(val)))
+#define script_pushstrcopy(st,val) (script->push_str((st)->stack, 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)))
+#define script_pushconststr(st,val) (script->push_conststr((st)->stack, (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
@@ -380,14 +380,18 @@ struct script_retinfo {
 	int defsp;                  ///< default stack pointer
 };
 
+/**
+ * Represents a variable in the script stack.
+ */
 struct script_data {
-	enum c_op type;
+	enum c_op type;     ///< Data type
 	union script_data_val {
-		int64 num;
-		char *str;
-		struct script_retinfo* ri;
-	} u;
-	struct reg_db *ref;
+		int64 num;                 ///< Numeric data
+		char *mutstr;              ///< Mutable string
+		const char *str;           ///< Constant string
+		struct script_retinfo *ri; ///< Function return information
+	} u;                ///< Data (field depends on `type`)
+	struct reg_db *ref; ///< Reference to the scope's variables
 };
 
 // Moved defsp from script_state to script_stack since
@@ -661,8 +665,9 @@ struct script_interface {
 	int (*get_val_npc_num) (struct script_state* st, struct reg_db *n, struct script_data* data);
 	int (*get_val_instance_num) (struct script_state* st, const char* name, struct script_data* data);
 	const 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);
+	struct script_data *(*push_str) (struct script_stack *stack, char *str);
+	struct script_data *(*push_conststr) (struct script_stack *stack, const 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 is_parameter, bool is_deprecated);
 	void (*set_constant2) (const char *name, int value, bool is_parameter, bool is_deprecated);