Add var_dump()

Author: aedart

cmake/rsp/debug.cmake

@@ -7,6 +7,8 @@ include_guard(GLOBAL)
 # Debug
 message(VERBOSE "rsp/debug module included")
 
+include("rsp/helpers")
+
 if (NOT COMMAND "dump")
 
     #! dump : Outputs given variables' name and value
@@ -37,4 +39,114 @@ if (NOT COMMAND "dd")
         # Output as fatal error to ensure that build stops.
         message(FATAL_ERROR "   ${CMAKE_CURRENT_FUNCTION}() called from ${CMAKE_CURRENT_LIST_FILE}")
     endfunction()
-endif ()
+endif ()
+
+if (NOT COMMAND "var_dump")
+
+    #! var_dump : Output human readable information about given properties
+    #
+    #
+    # @param [OUTPUT <variable>]           Optional - If specified, information is assigned to output variable
+    #                                      instead of being printed to stderr.
+    # @param [WITHOUT_NAMES]      Option, if given then property names are omitted from the output
+    # @param [PROPERTIES <variable>...]    One or more variables to dump information about.
+    #
+    # @return
+    #       [OUTPUT]                       The resulting output variable, if OUTPUT was specified.
+    #
+    function(var_dump)
+        set(options WITHOUT_NAMES)
+        set(oneValueArgs OUTPUT)
+        set(multiValueArgs PROPERTIES)
+
+        cmake_parse_arguments(INPUT "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+        requires_arguments("PROPERTIES" INPUT)
+
+        # ---------------------------------------------------------------------------------------------- #
+
+        set(buffer "")
+
+        foreach (key IN LISTS INPUT_PROPERTIES)
+            # Attempt to resolve value and it's datatype
+            set(value "${${key}}")
+            get_type(key type)
+
+            # If  key is defined as an environment variable, the value
+            # must be obtained via ENV{}.
+            if (DEFINED ENV{${key}})
+                set(value "$ENV{${key}}")
+                get_type("${value}" type)
+            elseif (NOT DEFINED ${key} AND type STREQUAL "string")
+                # We ONLY deal with variables, meaning that if key isn't
+                # defined, and the type is determined to be a string,
+                # then we must assume that it's an undefined property!
+
+                set(type "${COLOR_RED}${TEXT_ITALIC}undefined${TEXT_ITALIC_RESTORE}${COLOR_DEFAULT}")
+            endif ()
+
+            # Format the value...
+            if (type STREQUAL "string")
+                string(LENGTH "${value}" str_length)
+                set(type "${type} ${str_length}")
+                set(value "${COLOR_GREEN}\"${value}\"${RESTORE}")
+            elseif (type STREQUAL "int" OR type STREQUAL "float")
+                set(value "${COLOR_BRIGHT_BLUE}${value}${RESTORE}")
+            elseif (type STREQUAL "bool")
+                set(value "${COLOR_CYAN}${value}${RESTORE}")
+            elseif (type STREQUAL "command")
+                set(value "${COLOR_BLUE}${key}()${RESTORE}")
+            elseif (type STREQUAL "list")
+                list(LENGTH value lst_length)
+                set(type "${type} ${lst_length}")
+                set(list_buffer "")
+
+                set(i 0) # index counter
+                foreach (item IN LISTS value)
+                    # Get property information about the "item", but without key name.
+                    var_dump(OUTPUT list_item WITHOUT_NAMES PROPERTIES item)
+
+                    # Append to list buffer and increment the "index" counter.
+                    list(APPEND list_buffer "${COLOR_MAGENTA}${i}:${RESTORE} ${list_item}")
+                    math(EXPR i "${i}+1" OUTPUT_FORMAT DECIMAL)
+                endforeach ()
+
+                string(REPLACE ";" "\n   " list_buffer "${list_buffer}")
+                set(value "[ \n   ${list_buffer}\n]")
+            endif ()
+
+            # Mark the key as cached, if needed...
+            if(DEFINED CACHE{${key}})
+                set(type "${type}, ${TEXT_ITALIC}${TEXT_BOLD}cached${TEXT_BOLD_RESTORE}${TEXT_ITALIC_RESTORE}")
+            endif ()
+
+            # Mark the key an environment variable, if needed...
+            if(DEFINED ENV{${key}})
+                set(type "${type}, ${TEXT_ITALIC}${TEXT_BOLD}ENV${TEXT_BOLD_RESTORE}${TEXT_ITALIC_RESTORE}")
+            endif ()
+
+            # The output format: <key> = (<type>) <value>
+            # Unless key is omitted.
+            set(formatted_key "${COLOR_BRIGHT_MAGENTA}${key}${RESTORE} = ")
+            if (INPUT_WITHOUT_NAMES)
+                set(formatted_key "")
+            endif ()
+
+            list(APPEND buffer "${formatted_key}${COLOR_WHITE}(${type}${COLOR_WHITE})${RESTORE} ${value}")
+        endforeach ()
+
+        string(REPLACE ";" "\n" buffer "${buffer}")
+
+        # ---------------------------------------------------------------------------------------------- #
+
+        # Assign to output variable, if requested and stop any further processing.
+        if (DEFINED INPUT_OUTPUT)
+            set("${INPUT_OUTPUT}" "${buffer}")
+            return(PROPAGATE "${INPUT_OUTPUT}")
+        endif ()
+
+        # ---------------------------------------------------------------------------------------------- #
+
+        message(NOTICE "${buffer}")
+
+    endfunction()
+endif ()