(svn r295) -Fix: Rewrite and fix of console stuff, including marking (XXX) of areas that require further investigation (Tron)

-Note: booby trapped some suspicous assignments (Tron)

console.h

@@ -1,17 +1,10 @@
 #ifndef CONSOLE_H
 #define CONSOLE_H
 
-// ** console ** //
-
-enum {
-	ICONSOLE_OPENED=0,
-	ICONSOLE_CLOSED,
-} _iconsole_modes;
-
 // ** console parser ** //
 
-enum {
+typedef enum _iconsole_var_types {
-	ICONSOLE_VAR_NONE=0,
+	ICONSOLE_VAR_NONE,
 	ICONSOLE_VAR_BOOLEAN,
 	ICONSOLE_VAR_BYTE,
 	ICONSOLE_VAR_UINT16,
@@ -21,43 +14,61 @@ enum {
 	ICONSOLE_VAR_STRING,
 	ICONSOLE_VAR_POINTER,
 	ICONSOLE_VAR_REFERENCE,
-	ICONSOLE_VAR_UNKNOWN,
+	ICONSOLE_VAR_UNKNOWN
 } _iconsole_var_types;
 
-enum {
+typedef enum _iconsole_hook_types {
 	ICONSOLE_HOOK_ACCESS,
 	ICONSOLE_HOOK_BEFORE_CHANGE,
 	ICONSOLE_HOOK_BEFORE_EXEC,
 	ICONSOLE_HOOK_AFTER_CHANGE,
-	ICONSOLE_HOOK_AFTER_EXEC,
+	ICONSOLE_HOOK_AFTER_EXEC
 } _iconsole_hook_types;
 
-typedef struct {
+struct _iconsole_var;
-	// -------------- //
+typedef bool (*iconsole_var_hook)(struct _iconsole_var* hook_var);
+
+typedef struct _iconsole_var {
+	// --------------- //
+	union {
 		void*   addr;
-	byte * name;
+		bool*   bool_;
+		byte*   byte_;
+		uint16* uint16_;
+		uint32* uint32_;
+		int16*  int16_;
+		int32*  int32_;
+		char*   string_;
+		struct _iconsole_var* reference_;
+	} data;
+	char* name;
+	_iconsole_var_types type;
 	// -------------- //
-	void * hook_access;
+	iconsole_var_hook hook_access;
-	void * hook_before_exec;
+	iconsole_var_hook hook_before_change;
-	void * hook_after_exec;
+	iconsole_var_hook hook_after_change;
+	// -------------- //
+	struct _iconsole_var* _next;
+	bool _malloc;
+} _iconsole_var;
+
+struct _iconsole_cmd;
+typedef bool (*iconsole_cmd_hook)(struct _iconsole_cmd* hook_cmd);
+
+typedef _iconsole_var* (*_iconsole_cmd_addr)(byte argc, char* argv[], byte argt[]);
+
+typedef struct _iconsole_cmd {
+	// -------------- //
+	_iconsole_cmd_addr addr;
+	char* name;
+	// -------------- //
+	iconsole_cmd_hook hook_access;
+	iconsole_cmd_hook hook_before_exec;
+	iconsole_cmd_hook hook_after_exec;
 	// -------------- //
 	void* _next;
 } _iconsole_cmd;
 
-typedef struct {
-	// --------------- //
-	void * addr;
-	const byte * name;
-	byte type;
-	// -------------- //
-	void * hook_access;
-	void * hook_before_change;
-	void * hook_after_change;
-	// -------------- //
-	void * _next;
-	bool _malloc;
-	} _iconsole_var;
-
 // ** console parser ** //
 
 _iconsole_cmd* _iconsole_cmds; // list of registred commands
@@ -76,54 +87,53 @@ void SetDebugString(const char *s);
 
 // ** console functions ** //
 
-void IConsoleClearCommand();
+void IConsoleInit(void);
-void IConsoleInit();
+void IConsoleClear(void);
-void IConsoleClear();
+void IConsoleFree(void);
-void IConsoleFree();
+void IConsoleResize(void);
-void IConsoleResize();
+void IConsoleSwitch(void);
-void IConsoleSwitch();
+void IConsoleClose(void);
-void IConsoleClose();
+void IConsoleOpen(void);
-void IConsoleOpen();
 
 // ** console cmd buffer ** //
-void IConsoleCmdBufferAdd(const byte *cmd);
+void IConsoleCmdBufferAdd(const char* cmd);
 void IConsoleCmdBufferNavigate(signed char direction);
 
 // ** console output ** //
-void IConsolePrint(byte color_code, const byte* string);
+void IConsolePrint(byte color_code, const char* string);
 void CDECL IConsolePrintF(byte color_code, const char* s, ...);
-void IConsoleDebug(byte* string);
+void IConsoleDebug(const char* string);
-void IConsoleError(const byte* string);
+void IConsoleError(const char* string);
-void IConsoleWarning(const byte* string);
+void IConsoleWarning(const char* string);
 
 // *** Commands *** //
 
-void IConsoleCmdRegister(const byte * name, void * addr);
+void IConsoleCmdRegister(const char* name, _iconsole_cmd_addr addr);
-_iconsole_cmd * IConsoleCmdGet(const byte * name);
+_iconsole_cmd* IConsoleCmdGet(const char* name);
 
 // *** Variables *** //
 
-void IConsoleVarRegister(const byte * name, void * addr, byte type);
+void IConsoleVarRegister(const char* name, void* addr, _iconsole_var_types type);
-void IConsoleVarMemRegister(const byte * name, byte type);
+void IConsoleVarMemRegister(const char* name, _iconsole_var_types type);
-void IConsoleVarInsert(_iconsole_var * var, const byte * name);
+void IConsoleVarInsert(_iconsole_var* var, const char* name);
-_iconsole_var * IConsoleVarGet(const byte * name);
+_iconsole_var* IConsoleVarGet(const char* name);
-_iconsole_var * IConsoleVarAlloc(byte type);
+_iconsole_var* IConsoleVarAlloc(_iconsole_var_types type);
 void IConsoleVarFree(_iconsole_var* var);
-void IConsoleVarSetString(_iconsole_var * var, const byte * string);
+void IConsoleVarSetString(_iconsole_var* var, const char* string);
 void IConsoleVarSetValue(_iconsole_var* var, int value);
-void IConsoleVarDump(_iconsole_var * var, const byte * dump_desc);
+void IConsoleVarDump(const _iconsole_var* var, const char* dump_desc);
 
 // *** Parser *** //
 
-void IConsoleCmdExec(const byte* cmdstr);
+void IConsoleCmdExec(const char* cmdstr);
 
 // ** console std lib ** //
-void IConsoleStdLibRegister();
+void IConsoleStdLibRegister(void);
 
 // ** hook code ** //
-void IConsoleVarHook(const byte * name, byte type, void * proc);
+void IConsoleVarHook(const char* name, _iconsole_hook_types type, iconsole_var_hook proc);
-void IConsoleCmdHook(const byte * name, byte type, void * proc);
+void IConsoleCmdHook(const char* name, _iconsole_hook_types type, iconsole_cmd_hook proc);
-bool IConsoleVarHookHandle(_iconsole_var * hook_var, byte type);
+bool IConsoleVarHookHandle(_iconsole_var* hook_var, _iconsole_hook_types type);
-bool IConsoleCmdHookHandle(_iconsole_cmd * hook_cmd, byte type);
+bool IConsoleCmdHookHandle(_iconsole_cmd* hook_cmd, _iconsole_hook_types type);
 
 #endif /* CONSOLE_H */

console_cmds.c

@@ -17,20 +17,20 @@ static bool _script_running;
 
 // ** console command / variable defines ** //
 
-#define DEF_CONSOLE_CMD(yyyy) static _iconsole_var * yyyy(byte argc, byte* argv[], byte argt[])
+#define DEF_CONSOLE_CMD(yyyy) static _iconsole_var * yyyy(byte argc, char* argv[], byte argt[])
 #define DEF_CONSOLE_CMD_HOOK(yyyy) static bool yyyy(_iconsole_cmd * hookcmd)
 #define DEF_CONSOLE_VAR_HOOK(yyyy) static bool yyyy(_iconsole_var * hookvar)
 
 
 // ** supporting functions ** //
 
-static int32 GetArgumentInteger(byte *arg)
+static uint32 GetArgumentInteger(const char* arg)
 {
-	int32 result;
+	uint32 result;
-	sscanf((char *)arg, "%u", &result);
+	sscanf(arg, "%u", &result);
 
 	if (result == 0 && arg[0] == '0' && arg[1] == 'x')
-		sscanf((char *)arg, "%x", &result);
+		sscanf(arg, "%x", &result);
 
 	return result;
 }
@@ -78,6 +78,7 @@ DEF_CONSOLE_CMD(ConResetEngines)
 	return 0;
 }
 
+#ifdef _DEBUG
 DEF_CONSOLE_CMD(ConResetTile)
 {
 	if (argc == 2) {
@@ -87,6 +88,7 @@ DEF_CONSOLE_CMD(ConResetTile)
 
 	return 0;
 }
+#endif
 
 DEF_CONSOLE_CMD(ConScrollToTile)
 {
@@ -105,9 +107,9 @@ DEF_CONSOLE_CMD(ConScrollToTile)
 
 DEF_CONSOLE_CMD(ConNetworkConnect)
 {
-	byte * ip;
+	char* ip;
-	const byte *port = NULL;
+	const char *port = NULL;
-	const byte *player = NULL;
+	const char *player = NULL;
 	uint16 rport;
 
 	if (argc<2) return NULL;
@@ -157,11 +159,8 @@ DEF_CONSOLE_CMD(ConExec)
 	_script_running = true;
 
 	while (!feof(_script_file) && _script_running) {
-
+		fgets(cmd, sizeof(cmd), _script_file);
-		fgets((char *)&cmd, 1024, _script_file);
+		IConsoleCmdExec(cmd);
-
-		IConsoleCmdExec((byte *) &cmd);
-
 	}
 
 	_script_running = false;
@@ -187,7 +186,8 @@ DEF_CONSOLE_CMD(ConScript)
 		fclose(_iconsole_output_file);
 	} else {
 		if (argc < 2) return NULL;
-		IConsolePrintF(_iconsole_color_default,"file output started to: %s",argv[1]);
+		IConsolePrintF(_iconsole_color_default, "file output started to: %s",
+			argv[1]);
 		_iconsole_output_file = fopen(argv[1], "ab");
 		if (_iconsole_output_file == NULL) IConsoleError("could not open file");
 	}
@@ -212,14 +212,14 @@ DEF_CONSOLE_CMD(ConEchoC)
 DEF_CONSOLE_CMD(ConPrintF)
 {
 	if (argc < 3) return NULL;
-	IConsolePrintF(_iconsole_color_default, argv[1] ,argv[2],argv[3],argv[4],argv[5],argv[6],argv[7],argv[8],argv[9],argv[10],argv[11],argv[12],argv[13],argv[14],argv[15],argv[16],argv[17],argv[18],argv[19]);
+	IConsolePrintF(_iconsole_color_default, argv[1] , argv[2], argv[3], argv[4], argv[5], argv[6], argv[7], argv[8], argv[9], argv[10], argv[11], argv[12], argv[13], argv[14], argv[15], argv[16], argv[17], argv[18], argv[19]); /* XXX ugh... */
 	return NULL;
 }
 
 DEF_CONSOLE_CMD(ConPrintFC)
 {
 	if (argc < 3) return NULL;
-	IConsolePrintF(atoi(argv[1]), argv[2] ,argv[3],argv[4],argv[5],argv[6],argv[7],argv[8],argv[9],argv[10],argv[11],argv[12],argv[13],argv[14],argv[15],argv[16],argv[17],argv[18],argv[19]);
+	IConsolePrintF(atoi(argv[1]), argv[2] , argv[3], argv[4], argv[5], argv[6], argv[7], argv[8], argv[9], argv[10], argv[11], argv[12], argv[13], argv[14], argv[15], argv[16], argv[17], argv[18], argv[19]); /* XXX ugh... */
 	return NULL;
 }
 
@@ -228,9 +228,8 @@ DEF_CONSOLE_CMD(ConScreenShot)
 	if (argc < 2) {
 		_make_screenshot = 1;
 	} else {
-		if (strcmp(argv[1],"big")==0) {
+		if (strcmp(argv[1], "big") == 0)
 			_make_screenshot=2;
-			}
 		if (strcmp(argv[1], "no_con") == 0) {
 			IConsoleClose();
 			_make_screenshot = 1;
@@ -249,9 +248,11 @@ DEF_CONSOLE_CMD(ConInfoVar)
 		item = (_iconsole_var*)argv[1];
 		IConsolePrintF(_iconsole_color_default, "var_name: %s", item->name);
 		IConsolePrintF(_iconsole_color_default, "var_type: %i", item->type);
-		IConsolePrintF(_iconsole_color_default,"var_addr: %i",item->addr);
+		IConsolePrintF(_iconsole_color_default, "var_addr: %i", item->data.addr);
-		if (item->_malloc) IConsolePrintF(_iconsole_color_default,"var_malloc: internal");
+		if (item->_malloc)
-			else IConsolePrintF(_iconsole_color_default, "var_malloc: external");
+			IConsolePrintF(_iconsole_color_default, "var_malloc: internal");
+		else
+			IConsolePrintF(_iconsole_color_default, "var_malloc: external");
 		if (item->hook_access) IConsoleWarning("var_access hooked");
 		if (item->hook_before_change) IConsoleWarning("var_before_change hooked");
 		if (item->hook_after_change) IConsoleWarning("var_after_change hooked");
@@ -313,6 +314,7 @@ DEF_CONSOLE_CMD(ConHelp)
 
 DEF_CONSOLE_CMD(ConRandom)
 {
+	/* XXX memory leak */
 	_iconsole_var* result;
 	result = IConsoleVarAlloc(ICONSOLE_VAR_UINT16);
 	IConsoleVarSetValue(result, rand());
@@ -321,76 +323,43 @@ DEF_CONSOLE_CMD(ConRandom)
 
 DEF_CONSOLE_CMD(ConListCommands)
 {
-	_iconsole_cmd * item;
+	const _iconsole_cmd* item;
-	int l = 0;
+	size_t l = 0;
 
-	if (argv[1]!=NULL) l = strlen((char *) argv[1]);
+	if (argv[1] != NULL) l = strlen(argv[1]);
 
-	item = _iconsole_cmds;
+	for (item = _iconsole_cmds; item != NULL; item = item->_next)
-	while (item != NULL) {
+		if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
-		if (argv[1]!=NULL) {
-
-			if (memcmp((void *) item->name, (void *) argv[1],l)==0)
 			IConsolePrintF(_iconsole_color_default, "%s", item->name);
 
-			} else {
-
-			IConsolePrintF(_iconsole_color_default,"%s",item->name);
-
-			}
-		item = item->_next;
-		}
-
 	return NULL;
 }
 
 DEF_CONSOLE_CMD(ConListVariables)
 {
-	_iconsole_var * item;
+	const _iconsole_var* item;
-	int l = 0;
+	size_t l = 0;
 
-	if (argv[1]!=NULL) l = strlen((char *) argv[1]);
+	if (argv[1] != NULL) l = strlen(argv[1]);
 
-	item = _iconsole_vars;
+	for (item = _iconsole_vars; item != NULL; item = item->_next)
-	while (item != NULL) {
+		if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
-		if (argv[1]!=NULL) {
-
-			if (memcmp(item->name, argv[1],l)==0)
 			IConsolePrintF(_iconsole_color_default, "%s", item->name);
 
-			} else {
-
-			IConsolePrintF(_iconsole_color_default,"%s",item->name);
-
-			}
-		item = item->_next;
-		}
-
 	return NULL;
 }
 
 DEF_CONSOLE_CMD(ConListDumpVariables)
 {
-	_iconsole_var * item;
+	const _iconsole_var* item;
-	int l = 0;
+	size_t l = 0;
 
-	if (argv[1]!=NULL) l = strlen((char *) argv[1]);
+	if (argv[1] != NULL) l = strlen(argv[1]);
 
-	item = _iconsole_vars;
+	for (item = _iconsole_vars; item != NULL; item = item->_next)
-	while (item != NULL) {
+		if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
-		if (argv[1]!=NULL) {
-
-			if (memcmp(item->name, argv[1],l)==0)
 			IConsoleVarDump(item, NULL);
 
-			} else {
-
-			IConsoleVarDump(item,NULL);
-
-			}
-		item = item->_next;
-		}
-
 	return NULL;
 }
 
@@ -402,9 +371,9 @@ DEF_CONSOLE_CMD(ConListDumpVariables)
 void IConsoleDebugLibRegister()
 {
 	// stdlib
-	extern bool _stdlib_con_developer;
+	extern bool _stdlib_con_developer; /* XXX extern in .c */
 
-	IConsoleVarRegister("con_developer",(void *) &_stdlib_con_developer,ICONSOLE_VAR_BOOLEAN);
+	IConsoleVarRegister("con_developer", &_stdlib_con_developer, ICONSOLE_VAR_BOOLEAN);
 	IConsoleVarMemRegister("temp_bool", ICONSOLE_VAR_BOOLEAN);
 	IConsoleVarMemRegister("temp_int16", ICONSOLE_VAR_INT16);
 	IConsoleVarMemRegister("temp_int32", ICONSOLE_VAR_INT32);
@@ -425,15 +394,13 @@ void IConsoleDebugLibRegister()
 void IConsoleStdLibRegister()
 {
 	// stdlib
-	extern byte _stdlib_developer;
+	extern byte _stdlib_developer; /* XXX extern in .c */
 
 #ifdef _DEBUG
 	IConsoleDebugLibRegister();
-#else
-	(void)ConResetTile; // Silence warning, this is only used in _DEBUG
 #endif
 
-	// functions [please add them alphabeticaly]
+	// functions [please add them alphabetically]
 #ifdef ENABLE_NETWORK
 	IConsoleCmdRegister("connect", ConNetworkConnect);
 	IConsoleCmdHook("connect", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetwork);
@@ -461,7 +428,7 @@ void IConsoleStdLibRegister()
 	IConsoleCmdRegister("scrollto",   ConScrollToTile);
 
 	// variables [please add them alphabeticaly]
-	IConsoleVarRegister("developer",(void *) &_stdlib_developer,ICONSOLE_VAR_BYTE);
+	IConsoleVarRegister("developer", &_stdlib_developer, ICONSOLE_VAR_BYTE);
 #ifdef ENABLE_NETWORK
 	IConsoleVarRegister("net_client_timeout", &_network_client_timeout, ICONSOLE_VAR_UINT16);
 	IConsoleVarHook("*net_client_timeout", ICONSOLE_HOOK_ACCESS, ConVarHookNoNetClient);
@@ -472,4 +439,4 @@ void IConsoleStdLibRegister()
 
 
 }
-/* -------------------- dont cross this line --------------------- */
+/* -------------------- don't cross this line --------------------- */

stdafx.h

@@ -62,6 +62,7 @@
 #	define CDECL _cdecl
 # define NOT_REACHED() _assume(0)
 # define snprintf _snprintf
+# define vsnprintf _vsnprintf
 # undef TTD_ALIGNMENT_4
 # undef TTD_ALIGNMENT_2
 # define GCC_PACK