emu/debug/debugcmd.cpp: Added support for lowercase hex to printf/logerror. [Patrick Mackinlay]

Also simplified implementation by better leveraging util/strformat.h.

This is from pull request #12124, to get some testing for the
fundamental change before freeze.

Author: cuavas

Diff for: docs/source/conf.py

@@ -63,9 +63,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.263'
+version = '0.264'
 # The full version, including alpha/beta/rc tags.
-release = '0.263'
+release = '0.264'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Diff for: docs/source/debugger/general.rst

@@ -197,6 +197,9 @@ available:
     Prints the corresponding argument as an octal number with optional
     minimum field width and zero fill using lowercase letters.
 %[0][<n>]x
+    Prints the corresponding argument as a hexadecimal number with
+    optional minimum field width and zero fill using lowercase letters.
+%[0][<n>]X
     Prints the corresponding argument as a hexadecimal number with
     optional minimum field width and zero fill using uppercase letters.
 \%%

Diff for: src/emu/debug/debugcmd.cpp

@@ -469,10 +469,14 @@ void debugger_commands::execute_print(const std::vector<std::string_view> &param
     mini_printf - safe printf to a buffer
 -------------------------------------------------*/
 
-bool debugger_commands::mini_printf(std::ostream &stream, std::string_view format, int params, u64 *param)
+bool debugger_commands::mini_printf(std::ostream &stream, const std::vector<std::string_view> &params)
 {
+	std::string_view format(params[0]);
 	auto f = format.begin();
 
+	int param = 1;
+	u64 number;
+
 	// parse the string looking for % signs
 	while (f != format.end())
 	{
@@ -517,68 +521,55 @@ bool debugger_commands::mini_printf(std::ostream &stream, std::string_view forma
 					break;
 
 				case 'X':
+					if (param < params.size() && m_console.validate_number_parameter(params[param++], number))
+						util::stream_format(stream, zerofill ? "%0*X" : "%*X", width, number);
+					else
+					{
+						m_console.printf("Not enough parameters for format!\n");
+						return false;
+					}
+					break;
 				case 'x':
-					if (params == 0)
+					if (param < params.size() && m_console.validate_number_parameter(params[param++], number))
+						util::stream_format(stream, zerofill ? "%0*x" : "%*x", width, number);
+					else
 					{
 						m_console.printf("Not enough parameters for format!\n");
 						return false;
 					}
-					if (u32(*param >> 32) != 0)
-						util::stream_format(stream, zerofill ? "%0*X" : "%*X", (width <= 8) ? 1 : width - 8, u32(*param >> 32));
-					else if (width > 8)
-						util::stream_format(stream, zerofill ? "%0*X" : "%*X", width - 8, 0);
-					util::stream_format(stream, zerofill ? "%0*X" : "%*X", (width < 8) ? width : 8, u32(*param));
-					param++;
-					params--;
 					break;
 
 				case 'O':
 				case 'o':
-					if (params == 0)
+					if (param < params.size() && m_console.validate_number_parameter(params[param++], number))
+						util::stream_format(stream, zerofill ? "%0*o" : "%*o", width, number);
+					else
 					{
 						m_console.printf("Not enough parameters for format!\n");
 						return false;
 					}
-					if (u32(*param >> 60) != 0)
-					{
-						util::stream_format(stream, zerofill ? "%0*o" : "%*o", (width <= 20) ? 1 : width - 20, u32(*param >> 60));
-						util::stream_format(stream, "%0*o", 10, u32(BIT(*param, 30, 30)));
-					}
-					else
-					{
-						if (width > 20)
-							util::stream_format(stream, zerofill ? "%0*o" : "%*o", width - 20, 0);
-						if (u32(BIT(*param, 30, 30)) != 0)
-							util::stream_format(stream, zerofill ? "%0*o" : "%*o", (width <= 10) ? 1 : width - 10, u32(BIT(*param, 30, 30)));
-						else if (width > 10)
-							util::stream_format(stream, zerofill ? "%0*o" : "%*o", width - 10, 0);
-					}
-					util::stream_format(stream, zerofill ? "%0*o" : "%*o", (width < 10) ? width : 10, u32(BIT(*param, 0, 30)));
-					param++;
-					params--;
 					break;
 
 				case 'D':
 				case 'd':
-					if (params == 0)
+					if (param < params.size() && m_console.validate_number_parameter(params[param++], number))
+						util::stream_format(stream, zerofill ? "%0*d" : "%*d", width, number);
+					else
 					{
 						m_console.printf("Not enough parameters for format!\n");
 						return false;
 					}
-					util::stream_format(stream, zerofill ? "%0*d" : "%*d", width, u32(*param));
-					param++;
-					params--;
 					break;
+
 				case 'C':
 				case 'c':
-					if (params == 0)
+					if (param < params.size() && m_console.validate_number_parameter(params[param++], number))
+						stream << char(number);
+					else
 					{
 						m_console.printf("Not enough parameters for format!\n");
 						return false;
 					}
-					stream << char(*param);
-					param++;
-					params--;
 					break;
 
 			}
@@ -630,15 +621,9 @@ void debugger_commands::execute_index_command(std::vector<std::string_view> cons
 
 void debugger_commands::execute_printf(const std::vector<std::string_view> &params)
 {
-	/* validate the other parameters */
-	u64 values[MAX_COMMAND_PARAMS];
-	for (int i = 1; i < params.size(); i++)
-		if (!m_console.validate_number_parameter(params[i], values[i]))
-			return;
-
 	/* then do a printf */
 	std::ostringstream buffer;
-	if (mini_printf(buffer, params[0], params.size() - 1, &values[1]))
+	if (mini_printf(buffer, params))
 		m_console.printf("%s\n", std::move(buffer).str());
 }
 
@@ -649,15 +634,9 @@ void debugger_commands::execute_printf(const std::vector<std::string_view> &para
 
 void debugger_commands::execute_logerror(const std::vector<std::string_view> &params)
 {
-	/* validate the other parameters */
-	u64 values[MAX_COMMAND_PARAMS];
-	for (int i = 1; i < params.size(); i++)
-		if (!m_console.validate_number_parameter(params[i], values[i]))
-			return;
-
 	/* then do a printf */
 	std::ostringstream buffer;
-	if (mini_printf(buffer, params[0], params.size() - 1, &values[1]))
+	if (mini_printf(buffer, params))
 		m_machine.logerror("%s", std::move(buffer).str());
 }
 
@@ -668,15 +647,9 @@ void debugger_commands::execute_logerror(const std::vector<std::string_view> &pa
 
 void debugger_commands::execute_tracelog(const std::vector<std::string_view> &params)
 {
-	/* validate the other parameters */
-	u64 values[MAX_COMMAND_PARAMS];
-	for (int i = 1; i < params.size(); i++)
-		if (!m_console.validate_number_parameter(params[i], values[i]))
-			return;
-
 	/* then do a printf */
 	std::ostringstream buffer;
-	if (mini_printf(buffer, params[0], params.size() - 1, &values[1]))
+	if (mini_printf(buffer, params))
 		m_console.get_visible_cpu()->debug()->trace_printf("%s", std::move(buffer).str());
 }
 
@@ -689,7 +662,6 @@ void debugger_commands::execute_tracesym(const std::vector<std::string_view> &pa
 {
 	// build a format string appropriate for the parameters and validate them
 	std::stringstream format;
-	u64 values[MAX_COMMAND_PARAMS];
 	for (int i = 0; i < params.size(); i++)
 	{
 		// find this symbol
@@ -704,15 +676,15 @@ void debugger_commands::execute_tracesym(const std::vector<std::string_view> &pa
 		util::stream_format(format, "%s=%s ",
 			params[i],
 			sym->format().empty() ? "%16X" : sym->format());
-
-		// validate the parameter
-		if (!m_console.validate_number_parameter(params[i], values[i]))
-			return;
 	}
 
+	// build parameters for printf
+	std::vector<std::string_view> printf_params(params);
+	printf_params.insert(printf_params.begin(), format.str());
+
 	// then do a printf
 	std::ostringstream buffer;
-	if (mini_printf(buffer, format.str(), params.size(), values))
+	if (mini_printf(buffer, printf_params))
 		m_console.get_visible_cpu()->debug()->trace_printf("%s", std::move(buffer).str());
 }
 

Diff for: src/emu/debug/debugcmd.h

@@ -73,7 +73,7 @@ class debugger_commands
 	u64 global_get(global_entry *global);
 	void global_set(global_entry *global, u64 value);
 
-	bool mini_printf(std::ostream &stream, std::string_view format, int params, u64 *param);
+	bool mini_printf(std::ostream &stream, const std::vector<std::string_view> &params);
 	template <typename T>
 	void execute_index_command(std::vector<std::string_view> const &params, T &&apply, char const *unused_message);
 

Diff for: src/emu/debug/debughlp.cpp

@@ -359,11 +359,14 @@ const help_item f_static_help_list[] =
 		"The printf command performs a C-style printf to the debugger console. Only a very limited set of "
 		"formatting options are available:\n"
 		"\n"
-		"  %[0][<n>]d -- prints <item> as a decimal value with optional digit count and zero-fill\n"
-		"  %[0][<n>]x -- prints <item> as a hexadecimal value with optional digit count and zero-fill\n"
+		"  %c         -- 8-bit character\n"
+		"  %[0][<n>]d -- decimal number with optional digit count and zero-fill\n"
+		"  %[0][<n>]o -- octal number with optional digit count and zero-fill\n"
+		"  %[0][<n>]x -- hexadecimal number with optional digit count and zero-fill (lowercase digits)\n"
+		"  %[0][<n>]X -- hexadecimal number with optional digit count and zero-fill (uppercase digits)\n"
 		"\n"
-		"All remaining formatting options are ignored. Use %% together to output a % character. Multiple "
-		"lines can be printed by embedding a \\n in the text.\n"
+		"All remaining formatting options are ignored. Use %% to output a % character. Multiple lines can be "
+		"printed by embedding a \\n in the text.\n"
 		"\n"
 		"Examples:\n"
 		"\n"
@@ -381,11 +384,14 @@ const help_item f_static_help_list[] =
 		"The logerror command performs a C-style printf to the error log. Only a very limited set of "
 		"formatting options are available:\n"
 		"\n"
-		"  %[0][<n>]d -- logs <item> as a decimal value with optional digit count and zero-fill\n"
-		"  %[0][<n>]x -- logs <item> as a hexadecimal value with optional digit count and zero-fill\n"
+		"  %c         -- 8-bit character\n"
+		"  %[0][<n>]d -- decimal number with optional digit count and zero-fill\n"
+		"  %[0][<n>]o -- octal number with optional digit count and zero-fill\n"
+		"  %[0][<n>]x -- hexadecimal number with optional digit count and zero-fill (lowercase digits)\n"
+		"  %[0][<n>]X -- hexadecimal number with optional digit count and zero-fill (uppercase digits)\n"
 		"\n"
-		"All remaining formatting options are ignored. Use %% together to output a % character. Multiple "
-		"lines can be printed by embedding a \\n in the text.\n"
+		"All remaining formatting options are ignored. Use %% to output a % character. Multiple lines can be "
+		"printed by embedding a \\n in the text.\n"
 		"\n"
 		"Examples:\n"
 		"\n"