From e3df7d8ebda36542c477beba281dfc3f9c737af4 Mon Sep 17 00:00:00 2001
From: gumi <git@gumi.ca>
Date: Wed, 10 Oct 2018 16:23:19 -0400
Subject: bake buildin_prompt into buildin_select and clarify the difference
 between the two

---
 doc/script_commands.txt | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'doc')

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 64468ed49..aa7141951 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -1600,21 +1600,24 @@ perfectly equivalent.
 ---------------------------------------
 
 *select("<option>"{, "<option>", ...})
-*prompt("<option>"{, "<option>", ...})
 
 This function is a handy replacement for 'menu' that doesn't use a complex
-label structure. It will return the number of menu option picked,
-starting with 1. Like 'menu', it will also set the variable @menu to
-contain the option the user picked.
+label structure. It will return the number of the menu option picked,
+starting with 1. If the player presses cancel, the script is terminated.
 
-    if (select("Yes:No") == 1)
+    if (select("Yes", "No") == 1)
         mes("You said yes, I know.");
 
 And like 'menu', the selected option is consistent with grouped options
 and empty options.
 
-'prompt' works almost the same as select, except that when a character
-clicks the Cancel button, this function will return 255 instead.
+---------------------------------------
+
+*prompt("<option>"{, "<option>", ...})
+
+This function behaves exactly like select(), but when a player presses cancel
+it returns 255 and the script is not terminated. You almost always want to use
+select() rather than prompt().
 
 ---------------------------------------
 
-- 
cgit v1.2.3-60-g2f50


From 5c59f230d982a2e0201956a6f9f853253b9f3c5f Mon Sep 17 00:00:00 2001
From: gumi <git@gumi.ca>
Date: Thu, 11 Oct 2018 18:24:20 -0400
Subject: add constants for max menu length and options

---
 doc/script_commands.txt |  6 ++++--
 src/map/clif.c          |  2 +-
 src/map/script.c        | 30 ++++++++++++++++--------------
 src/map/script.h        |  3 +++
 4 files changed, 24 insertions(+), 17 deletions(-)

(limited to 'doc')

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index aa7141951..98bc7b0e5 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -714,6 +714,8 @@ MAX_BANK_ZENY		- Maximum Zeny in the bank
 MAX_BG_MEMBERS		- Maximum BattleGround members
 MAX_CHAT_USERS		- Maximum Chat users
 MAX_REFINE			- Maximum Refine level
+MAX_MENU_OPTIONS    - Maximum NPC menu options
+MAX_MENU_LENGTH     - Maximum NPC menu string length
 
 Send targets and status options are also hard-coded and can be found
 in 'doc/constants.md'.
@@ -1616,8 +1618,8 @@ and empty options.
 *prompt("<option>"{, "<option>", ...})
 
 This function behaves exactly like select(), but when a player presses cancel
-it returns 255 and the script is not terminated. You almost always want to use
-select() rather than prompt().
+it returns MAX_MENU_OPTIONS and the script is not terminated. You almost always
+want to use select() rather than prompt().
 
 ---------------------------------------
 
diff --git a/src/map/clif.c b/src/map/clif.c
index 1e9844f14..8871dda76 100644
--- a/src/map/clif.c
+++ b/src/map/clif.c
@@ -12342,7 +12342,7 @@ static void clif_parse_NpcSelectMenu(int fd, struct map_session_data *sd)
 	int npc_id = RFIFOL(fd,2);
 	uint8 select = RFIFOB(fd,6);
 
-	if( (select > sd->npc_menu && select != 0xff) || select == 0 ) {
+	if( (select > sd->npc_menu && select != MAX_MENU_OPTIONS) || select == 0 ) {
 #ifdef SECURE_NPCTIMEOUT
 		if( sd->npc_idle_timer != INVALID_TIMER ) {
 #endif
diff --git a/src/map/script.c b/src/map/script.c
index 9682fea40..235cd08a0 100644
--- a/src/map/script.c
+++ b/src/map/script.c
@@ -6099,11 +6099,11 @@ static BUILDIN(menu)
 		sd->state.menu_or_input = 1;
 
 		/* menus beyond this length crash the client (see bugreport:6402) */
-		if( StrBuf->Length(&buf) >= 2047 ) {
+		if( StrBuf->Length(&buf) >= MAX_MENU_LENGTH - 1 ) {
 			struct npc_data * nd = map->id2nd(st->oid);
 			char* menu;
-			CREATE(menu, char, 2048);
-			safestrncpy(menu, StrBuf->Value(&buf), 2047);
+			CREATE(menu, char, MAX_MENU_LENGTH);
+			safestrncpy(menu, StrBuf->Value(&buf), MAX_MENU_LENGTH - 1);
 			ShowWarning("NPC Menu too long! (source:%s / length:%d)\n",nd?nd->name:"Unknown",StrBuf->Length(&buf));
 			clif->scriptmenu(sd, st->oid, menu);
 			aFree(menu);
@@ -6112,13 +6112,13 @@ static BUILDIN(menu)
 
 		StrBuf->Destroy(&buf);
 
-		if( sd->npc_menu >= 0xff )
+		if( sd->npc_menu >= MAX_MENU_OPTIONS )
 		{// client supports only up to 254 entries; 0 is not used and 255 is reserved for cancel; excess entries are displayed but cause 'uint8' overflow
-			ShowWarning("buildin_menu: Too many options specified (current=%d, max=254).\n", sd->npc_menu);
+			ShowWarning("buildin_menu: Too many options specified (current=%d, max=%d).\n", sd->npc_menu, MAX_MENU_OPTIONS - 1);
 			script->reportsrc(st);
 		}
 	}
-	else if( sd->npc_menu == 0xff )
+	else if( sd->npc_menu == MAX_MENU_OPTIONS )
 	{// Cancel was pressed
 		sd->state.menu_or_input = 0;
 		st->state = END;
@@ -6200,11 +6200,11 @@ static BUILDIN(select)
 		sd->state.menu_or_input = 1;
 
 		/* menus beyond this length crash the client (see bugreport:6402) */
-		if( StrBuf->Length(&buf) >= 2047 ) {
+		if( StrBuf->Length(&buf) >= MAX_MENU_LENGTH - 1 ) {
 			struct npc_data * nd = map->id2nd(st->oid);
 			char* menu;
-			CREATE(menu, char, 2048);
-			safestrncpy(menu, StrBuf->Value(&buf), 2047);
+			CREATE(menu, char, MAX_MENU_LENGTH);
+			safestrncpy(menu, StrBuf->Value(&buf), MAX_MENU_LENGTH - 1);
 			ShowWarning("NPC Menu too long! (source:%s / length:%d)\n",nd?nd->name:"Unknown",StrBuf->Length(&buf));
 			clif->scriptmenu(sd, st->oid, menu);
 			aFree(menu);
@@ -6212,16 +6212,16 @@ static BUILDIN(select)
 			clif->scriptmenu(sd, st->oid, StrBuf->Value(&buf));
 		StrBuf->Destroy(&buf);
 
-		if( sd->npc_menu >= 0xff ) {
-			ShowWarning("buildin_select: Too many options specified (current=%d, max=254).\n", sd->npc_menu);
+		if( sd->npc_menu >= MAX_MENU_OPTIONS ) {
+			ShowWarning("buildin_select: Too many options specified (current=%d, max=%d).\n", sd->npc_menu, MAX_MENU_OPTIONS - 1);
 			script->reportsrc(st);
 		}
-	} else if(sd->npc_menu == 0xff) { // Cancel was pressed
+	} else if(sd->npc_menu == MAX_MENU_OPTIONS) { // Cancel was pressed
 		sd->state.menu_or_input = 0;
 
 		if (strncmp(get_buildin_name(st), "prompt", 6) == 0) {
-			pc->setreg(sd, script->add_variable("@menu"), 0xff);
-			script_pushint(st, 0xff);
+			pc->setreg(sd, script->add_variable("@menu"), MAX_MENU_OPTIONS);
+			script_pushint(st, MAX_MENU_OPTIONS); // XXX: we should really be pushing -1 instead
 			st->state = RUN;
 		} else {
 			st->state = END;
@@ -25514,6 +25514,8 @@ static void script_hardcoded_constants(void)
 	script->set_constant("MAX_BG_MEMBERS",MAX_BG_MEMBERS,false, false);
 	script->set_constant("MAX_CHAT_USERS",MAX_CHAT_USERS,false, false);
 	script->set_constant("MAX_REFINE",MAX_REFINE,false, false);
+	script->set_constant("MAX_MENU_OPTIONS", MAX_MENU_OPTIONS, false, false);
+	script->set_constant("MAX_MENU_LENGTH", MAX_MENU_LENGTH, false, false);
 
 	script->constdb_comment("status options");
 	script->set_constant("Option_Nothing",OPTION_NOTHING,false, false);
diff --git a/src/map/script.h b/src/map/script.h
index f05eb802c..e4570ff97 100644
--- a/src/map/script.h
+++ b/src/map/script.h
@@ -64,6 +64,9 @@ struct item_data;
 
 #define SCRIPT_EQUIP_TABLE_SIZE 20
 
+#define MAX_MENU_OPTIONS 0xFF
+#define MAX_MENU_LENGTH 0x800
+
 //#define SCRIPT_DEBUG_DISP
 //#define SCRIPT_DEBUG_DISASM
 //#define SCRIPT_DEBUG_HASH
-- 
cgit v1.2.3-60-g2f50