Added utility function to get list's max/largest index

Author: MrPointer

cmake/Platform/Sketches/SketchPrototypesResolver.cmake

@@ -1,15 +1,25 @@
-function(resolve_sketch_prototypes _sketch_file _resolved_sketch_headers _return_var)
+#=============================================================================#
+# Resolves the given sketch file's prototypes, which are just function declarations, 
+# by matching all function definitions with their declaration. If a declaration can't be found, 
+# the definition is added to a list of prototypes to generate, which is then returned.
+#       _sketch_file - Path to the sketch file which its' libraries should be resolved.
+#       _sketch_headers - List of headers files used by the sketch, directly or indirectly.
+#       _return_var - Name of variable in parent-scope holding the return value.
+#       Returns - List of prototypes to generate, i.e. function definitions without a matching declaration.
+#=============================================================================#
+function(resolve_sketch_prototypes _sketch_file _sketch_headers _return_var)
 
     get_source_function_definitions(${_sketch_file} sketch_func_defines)
     if (NOT sketch_func_defines) # Source has no function definitions at all
         return()
     endif ()
 
-    list(APPEND _resolved_sketch_headers "${_sketch_file}")
+    # Add the current file to the list of headers to search in as well - It's the functions' containing file
+    list(APPEND _sketch_headers "${_sketch_file}")
 
     foreach (func_def ${sketch_func_defines})
 
-        match_function_declaration("${func_def}" "${_resolved_sketch_headers}" match)
+        match_function_declaration("${func_def}" "${_sketch_headers}" match)
 
         if (${match} MATCHES "NOTFOUND")
             # ToDo: Append signature to list of prototypes to create

cmake/Platform/Sources/FunctionDeclarationMatcher.cmake

@@ -1,15 +1,19 @@
-
+#=============================================================================#
+# Attempts to match a given function definition signature to its' declaration, searching in all given headers.
+# These headers are usually a list of all headers included by the function's file, recursively.
+# Given a match, the declaration is returned, otherwise - "NOTFOUND" string.
+#       _definition_signature - String representing a full function signature, e.g. 'int main(int argc, char **argv)'
+#       _included_headers - List of headers to search the declaration in.
+#                           Should include the function's containing file itself.
+#       _return_var - Name of variable in parent-scope holding the return value.
+#       Returns - Function's declaration signature if exists, otherwise "NOTFOUND".
+#=============================================================================#
 function(match_function_declaration _definition_signature _included_headers _return_var)
 
     # Get function name and list of argument-types
     strip_function_signature("${_definition_signature}" original_stripped_function)
-
-    # ToDo: Consider writing a utility function
-    list(LENGTH original_stripped_function orig_func_list_len)
-    set(original_function_args_length ${orig_func_list_len})
-    decrement_integer(original_function_args_length 1)
-
     list(GET original_stripped_function 0 original_function_name)
+    list_max_index("${original_stripped_function}" original_function_args_length)
 
     foreach (included_header ${_included_headers})
 
@@ -22,13 +26,8 @@ function(match_function_declaration _definition_signature _included_headers _ret
 
                 # Get function name and list of argument-types
                 strip_function_signature("${line}" iterated_stripped_function)
-
-                # ToDo: Consider writing a utility function
-                list(LENGTH iterated_stripped_function iter_func_list_len)
-                set(iterated_function_args_length ${iter_func_list_len})
-                decrement_integer(iterated_function_args_length 1)
-
                 list(GET iterated_stripped_function 0 iterated_function_name)
+                list_max_index("${iterated_stripped_function}" iterated_function_args_length)
 
                 if ("${original_function_name}" STREQUAL "${iterated_function_name}")
                     if (${orig_func_list_len} EQUAL ${iter_func_list_len})

cmake/Platform/Utilities/ListUtils.cmake

@@ -7,7 +7,6 @@
 macro(list_replace _list _index _new_element)
 
     list(REMOVE_AT ${_list} ${_index})
-
     list(INSERT ${_list} ${_index} "${_new_element}")
 
 endmacro()
@@ -25,3 +24,23 @@ macro(initialize_list _list)
     endif ()
 
 endmacro()
+
+#=============================================================================#
+# Gets the maximal index a given list can relate to, i.e. the largest index, zero-counted.
+# Usually it's just `length - 1`, but there are edge cases where special treatment must be applied.
+#       _list - List to get its maximal index.
+#       _return_var - Name of variable in parent-scope holding the return value.
+#       Returns - Maximal index the list can relate to (usually `length - 1`).
+#=============================================================================#
+function(list_max_index _list _return_var)
+
+    list(LENGTH _list list_length)
+
+    set(index ${list_length})
+    if (${index} GREATER 0)
+        decrement_integer(${index} 1)
+    endif ()
+
+    set(${_return_var} ${index} PARENT_SCOPE)
+
+endfunction()