Add simple version logs format that can be enabled from build options (OPTION_BUILD_LOGS_PRETTY).

Author: viferga

CMakeLists.txt

@@ -82,6 +82,7 @@ option(OPTION_BUILD_SCRIPTS		"Build scripts."											ON)
 option(OPTION_BUILD_SERIALS		"Build serials."											ON)
 option(OPTION_BUILD_DETOURS		"Build detours."											ON)
 option(OPTION_BUILD_PORTS		"Build ports."												OFF)
+option(OPTION_BUILD_LOG_PRETTY	"Build logs in a human readable format."					ON)
 option(OPTION_BUILD_PIC			"Build with position independent code."						ON)
 option(OPTION_BUILD_SECURITY	"Build with stack-smashing protection and source fortify."	ON)
 option(OPTION_BUILD_GUIX		"Disable all build system unreproductible operations."		OFF)

cmake/CompileOptions.cmake

@@ -62,7 +62,14 @@ endif()
 # Compile definitions
 #
 
+if(OPTION_BUILD_LOG_PRETTY)
+	set(LOG_POLICY_FORMAT_PRETTY_VALUE 1)
+else()
+	set(LOG_POLICY_FORMAT_PRETTY_VALUE 0)
+endif()
+
 set(DEFAULT_COMPILE_DEFINITIONS
+	LOG_POLICY_FORMAT_PRETTY=${LOG_POLICY_FORMAT_PRETTY_VALUE}
 	SYSTEM_${SYSTEM_NAME_UPPER}
 )
 
@@ -72,7 +79,7 @@ if(WIN32)
 		_SCL_SECURE_NO_WARNINGS	# Calling any one of the potentially unsafe methods in the Standard C++ Library
 		_CRT_SECURE_NO_WARNINGS	# Calling any one of the potentially unsafe methods in the CRT Library
 	)
-endif ()
+endif()
 
 if(CMAKE_BUILD_TYPE STREQUAL "Debug" OR MAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
 	set(DEFAULT_COMPILE_DEFINITIONS

source/loaders/py_loader/source/py_loader_impl.c

@@ -704,13 +704,15 @@ function_return function_py_interface_invoke(function func, function_impl impl,
 		if (t == NULL)
 		{
 			id = value_type_id((value)args[args_count]);
+
+			log_write("metacall", LOG_LEVEL_DEBUG, "Argument #%u Type: %s", args_count, type_id_name(id));
 		}
 		else
 		{
 			id = type_index(t);
-		}
 
-		log_write("metacall", LOG_LEVEL_DEBUG, "Type (%p): %d", (void *)t, id);
+			log_write("metacall", LOG_LEVEL_DEBUG, "Argument #%u Type (%p): %s", args_count, (void *)t, type_name(t));
+		}
 
 		py_func->values[args_count] = py_loader_impl_value_to_capi(impl, py_impl, id, args[args_count]);
 
@@ -741,13 +743,16 @@ function_return function_py_interface_invoke(function func, function_impl impl,
 		if (ret_type == NULL)
 		{
 			id = py_loader_impl_capi_to_value_type(result);
+
+			log_write("metacall", LOG_LEVEL_DEBUG, "Return Type: %s", type_id_name(id));
 		}
 		else
 		{
 			id = type_index(ret_type);
+
+			log_write("metacall", LOG_LEVEL_DEBUG, "Return Type (%p): %s", (void *)ret_type, type_name(ret_type));
 		}
 
-		log_write("metacall", LOG_LEVEL_DEBUG, "Return type %p, %d", (void *)ret_type, id);
 
 		v = py_loader_impl_capi_to_value(py_func->impl, result, id);
 

source/log/source/log_policy_format_text.c

@@ -22,6 +22,7 @@
 
 #define LOG_POLICY_FORMAT_TEXT_STR_DEBUG "[%.19s] #%" PRIuS " [ %" PRIuS " | %s | %s ] @%s : "
 #define LOG_POLICY_FORMAT_TEXT_STR_RELEASE "[%.19s] #%" PRIuS " @%s : "
+#define LOG_POLICY_FORMAT_TEXT_STR_PRETTY "\x1b[32m%s\x1b[0m: "
 
 /* -- Macros -- */
 
@@ -130,36 +131,57 @@ static size_t log_policy_format_text_size(log_policy policy, const log_record re
 
 static const char * log_policy_format_text_serialize_impl_format(enum log_level_id log_level, unsigned int flags)
 {
-	if (log_level == LOG_LEVEL_DEBUG)
+	#if (LOG_POLICY_FORMAT_PRETTY == 1)
 	{
+		(void)log_level;
+
 		if (flags & LOG_POLICY_FORMAT_TEXT_NEWLINE)
 		{
-			static const char format_debug_newline[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG "%s\n";
+			static const char format_debug_newline[] = LOG_POLICY_FORMAT_TEXT_STR_PRETTY "%s\n";
 
 			return format_debug_newline;
 		}
 		else
 		{
-			static const char format_debug[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG "%s";
+			static const char format_debug[] = LOG_POLICY_FORMAT_TEXT_STR_PRETTY "%s";
 
 			return format_debug;
 		}
 	}
-	else
+	#else
 	{
-		if (flags & LOG_POLICY_FORMAT_TEXT_NEWLINE)
+		if (log_level == LOG_LEVEL_DEBUG)
 		{
-			static const char format_release_newline[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE "%s\n";
-
-			return format_release_newline;
+			if (flags & LOG_POLICY_FORMAT_TEXT_NEWLINE)
+			{
+				static const char format_debug_newline[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG "%s\n";
+
+				return format_debug_newline;
+			}
+			else
+			{
+				static const char format_debug[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG "%s";
+
+				return format_debug;
+			}
 		}
 		else
 		{
-			static const char format_release[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE "%s";
-
-			return format_release;
+			if (flags & LOG_POLICY_FORMAT_TEXT_NEWLINE)
+			{
+				static const char format_release_newline[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE "%s\n";
+
+				return format_release_newline;
+			}
+			else
+			{
+				static const char format_release[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE "%s";
+
+				return format_release;
+			}
 		}
 	}
+	#endif
 }
 
 static size_t log_policy_format_text_serialize_impl(log_policy policy, const log_record record, void * buffer, const size_t size)
@@ -206,37 +228,48 @@ static size_t log_policy_format_text_serialize_impl_va(log_policy policy, const
 {
 	log_policy_format_text_data text_data = log_policy_instance(policy);
 
-	log_aspect aspect = log_policy_aspect(policy);
-
-	log_impl impl = log_aspect_parent(aspect);
-
 	int header_length = 0, body_length = 0;
 
 	void * buffer_body = NULL;
 
 	struct log_record_va_list_type * variable_args;
 
-	if (log_impl_level(impl) == LOG_LEVEL_DEBUG)
+	#if (LOG_POLICY_FORMAT_PRETTY == 1)
 	{
-		static const char header_format[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG;
+		static const char header_format[] = LOG_POLICY_FORMAT_TEXT_STR_PRETTY;
 
 		header_length = snprintf(buffer, size, header_format,
-			ctime(log_record_time(record)),
-			log_record_thread_id(record),
-			log_record_line(record),
-			log_record_func(record),
-			log_record_file(record),
 			log_level_to_string(log_record_level(record)));
 	}
-	else
+	#else
 	{
-		static const char header_format[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE;
+		log_aspect aspect = log_policy_aspect(policy);
 
-		header_length = snprintf(buffer, size, header_format,
-			ctime(log_record_time(record)),
-			log_record_thread_id(record),
-			log_level_to_string(log_record_level(record)));
+		log_impl impl = log_aspect_parent(aspect);
+
+		if (log_impl_level(impl) == LOG_LEVEL_DEBUG)
+		{
+			static const char header_format[] = LOG_POLICY_FORMAT_TEXT_STR_DEBUG;
+
+			header_length = snprintf(buffer, size, header_format,
+				ctime(log_record_time(record)),
+				log_record_thread_id(record),
+				log_record_line(record),
+				log_record_func(record),
+				log_record_file(record),
+				log_level_to_string(log_record_level(record)));
+		}
+		else
+		{
+			static const char header_format[] = LOG_POLICY_FORMAT_TEXT_STR_RELEASE;
+
+			header_length = snprintf(buffer, size, header_format,
+				ctime(log_record_time(record)),
+				log_record_thread_id(record),
+				log_level_to_string(log_record_level(record)));
+		}
 	}
+	#endif
 
 	if (header_length <= 0)
 	{

source/reflect/include/reflect/reflect_type_id.h

@@ -51,6 +51,18 @@ enum type_primitive_id
 
 typedef int type_id;
 
+/**
+*  @brief
+*    Obtain a human readable form of the type id @id
+*
+*  @param[in] id
+*    Type id to be converted into string
+*
+*  @return
+*    String representing a readable name for @id
+*/
+REFLECT_API const char * type_id_name(type_id id);
+
 /**
 *  @brief
 *    Check if type id is boolean value (bool)

source/reflect/source/reflect_type_id.c

@@ -20,6 +20,41 @@
 
 #include <reflect/reflect_type_id.h>
 
+#include <portability/portability_assert.h>
+
+
+static const char * type_id_name_map[] =
+{
+	"Boolean",
+	"Char",
+	"Short",
+	"Int",
+	"Long",
+	"Float",
+	"Double",
+	"String",
+	"Buffer",
+	"Array",
+	"Map",
+	"Pointer",
+	"Future",
+	"Function",
+	"Null"
+};
+
+static_assert((int) sizeof(type_id_name_map) / sizeof(type_id_name_map[0]) == (int) TYPE_SIZE,
+	"Size of type id name map does not match the type size");
+
+const char * type_id_name(type_id id)
+{
+	if (id >= 0 && id < TYPE_SIZE)
+	{
+		return type_id_name_map[id];
+	}
+
+	return "Invalid";
+}
+
 int type_id_boolean(type_id id)
 {
 	return !(id == TYPE_BOOL);

tools/metacall-configure.sh

@@ -117,7 +117,8 @@ sub_options() {
 }
 
 sub_configure() {
-	BUILD_STRING="-DOPTION_BUILD_LOADERS=On \
+	BUILD_STRING="-DOPTION_BUILD_LOG_PRETTY=Off \
+			-DOPTION_BUILD_LOADERS=On \
 			-DOPTION_BUILD_LOADERS_MOCK=On"
 
 	# Scripts