Added insertion of sketch prototypes to converted sources

Added utility function to escape semicolons in a string and vice-versa
Fixed bug in `list_max_index` utility function

Author: MrPointer

cmake/Platform/Sketches/SketchManager.cmake

@@ -34,7 +34,7 @@ function(add_sketch_to_target _target_name _sketch_file)
         resolve_sketch_libraries(${_target_name} ${_sketch_file} "${sketch_headers}")
         resolve_sketch_prototypes(${_sketch_file} "${sketch_headers}" sketch_prototypes)
 
-        convert_sketch_to_source(${_sketch_file} ${sketch_converted_source_path})
+        convert_sketch_to_source(${_sketch_file} ${sketch_converted_source_path} ${sketch_prototypes})
 
     endif ()
 

cmake/Platform/Sketches/SketchPrototypesResolver.cmake

@@ -22,10 +22,11 @@ function(resolve_sketch_prototypes _sketch_file _sketch_headers _return_var)
         match_function_declaration("${func_def}" "${_sketch_headers}" match)
 
         if (${match} MATCHES "NOTFOUND")
-            # ToDo: Append signature to list of prototypes to create
-            message("Coludn't find a matching declaration for `${func_def}`")
+            list(APPEND prototypes "${func_def}")
         endif ()
 
     endforeach ()
 
+    set(${_return_var} ${prototypes} PARENT_SCOPE)
+
 endfunction()

cmake/Platform/Sketches/SketchSourceConverter.cmake

@@ -1,15 +1,15 @@
 #=============================================================================#
 # Writes the given lines of code belonging to the sketch to the given file path.
-#        _sketch_loc - List of lines-of-code belonging to the sketch.
+#        _sketch_lines - List of lines-of-code belonging to the sketch.
 #        _file_path - Full path to the written source file.
 #=============================================================================#
-function(_write_source_file _sketch_loc _file_path)
+function(_write_source_file _sketch_lines _file_path)
 
     file(WRITE "${_file_path}" "") # Clear previous file's contents
 
-    foreach (loc ${_sketch_loc})
-        string(REGEX REPLACE "^(.+)${ARDUINO_CMAKE_SEMICOLON_REPLACEMENT}(.*)$" "\\1;\\2" original_loc "${loc}")
-        file(APPEND "${_file_path}" "${original_loc}")
+    foreach (line ${_sketch_lines})
+        escape_semicolon_in_string("${line}" original_line REVERSE)
+        file(APPEND "${_file_path}" "${original_line}")
     endforeach ()
 
 endfunction()
@@ -20,12 +20,12 @@ endfunction()
 # best fitted the insertion, however, it might need a bit more optimization. Why?
 # Because above those lines there might be a comment, or a comment block,
 # all of which should be taken into account in order to minimize the effect on code's readability.
-#        _sketch_loc - List of lines-of-code belonging to the sketch.
-#        _active_index - Index that indicates the best-not-optimized loc to insert header to.
+#        _sketch_lines - List of lines-of-code belonging to the sketch.
+#        _active_index - Index that indicates the best-not-optimized line to insert header to.
 #        _return_var - Name of variable in parent-scope holding the return value.
 #        Returns - Best fitted index to insert platform's main header '#include' to.
 #=============================================================================#
-function(_get_matching_header_insertion_index _sketch_loc _active_index _return_var)
+function(_get_matching_header_insertion_index _sketch_lines _active_index _return_var)
 
     if (${_active_index} EQUAL 0) # First line in a file will always result in the 1st index
         set(${_return_var} 0 PARENT_SCOPE)
@@ -34,14 +34,14 @@ function(_get_matching_header_insertion_index _sketch_loc _active_index _return_
         decrement_integer(_active_index 1)
     endif ()
 
-    list(GET _sketch_loc ${_active_index} previous_loc)
+    list(GET _sketch_lines ${_active_index} previous_loc)
 
     if ("${previous_loc}" MATCHES "^//") # Simple one-line comment
         set(matching_index ${_active_index})
     elseif ("${previous_loc}" MATCHES "\\*/$") # End of multi-line comment
 
         foreach (index RANGE ${_active_index} 0)
-            list(GET _sketch_loc ${index} multi_comment_line)
+            list(GET _sketch_lines ${index} multi_comment_line)
 
             if ("${multi_comment_line}" MATCHES "^\\/\\*") # Start of multi-line comment
                 set(matching_index ${index})
@@ -63,63 +63,86 @@ endfunction()
 #        _sketch_lines - List of code lines read from the converted sketch file.
 #        _insertion_line_index - Index of a code line at which the header should be inserted
 #=============================================================================#
-macro(_insert_platform_header_include_line _sketch_lines _insertion_line_index)
+macro(_insert_line _inserted_line _sketch_lines _insertion_line_index)
 
     _get_matching_header_insertion_index("${_sketch_lines}" ${_insertion_line_index} header_index)
 
     if (${header_index} LESS ${_insertion_line_index})
-        set(formatted_include_line ${ARDUINO_CMAKE_PLATFORM_HEADER_INCLUDE_LINE} "\n\n")
+        set(formatted_include_line ${_inserted_line} "\n\n")
     elseif (${header_index} EQUAL 0)
-        set(formatted_include_line ${ARDUINO_CMAKE_PLATFORM_HEADER_INCLUDE_LINE} "\n")
+        set(formatted_include_line ${_inserted_line} "\n")
     else ()
-        set(formatted_include_line "\n" ${ARDUINO_CMAKE_PLATFORM_HEADER_INCLUDE_LINE})
+        set(formatted_include_line "\n" ${_inserted_line})
 
         if (${header_index} GREATER_EQUAL ${_insertion_line_index})
             decrement_integer(header_index 1)
             string(APPEND formatted_include_line "\n")
         endif ()
     endif ()
 
-    list(INSERT refined_sketch ${header_index} ${formatted_include_line})
+    list(INSERT converted_source ${header_index} ${formatted_include_line})
+
+endmacro()
+
+macro(_insert_prototypes _prototypes _sketch_lines _insertion_line_index)
+
+    foreach (prototype ${_prototypes})
+        # Add semicolon ';' to make it a declaration
+        escape_semicolon_in_string("${prototype};" formatted_prototype)
+
+        _insert_line("${formatted_prototype}" "${sketch_lines}" ${line_index})
+        increment_integer(_insertion_line_index 1)
+    endforeach ()
 
 endmacro()
 
 #=============================================================================#
 # Converts the given sketch file into a valid 'cpp' source file under the project's working dir.
 # During the conversion process the platform's main header file is inserted to the source file
 # since it's critical for it to include it - Something that doesn't happen in "Standard" sketches.
-#        _sketch_file - Full path to the original sketch file (Read from).
-#        _converted_source_path - Full path to the converted target source file (Written to).
+#       _sketch_file - Full path to the original sketch file (Read from).
+#       _converted_source_path - Full path to the converted target source file (Written to).
+#       _sketch_prototypes - List of prototypes to genereate, i.e. function definitions without a declaration.
 #=============================================================================#
-function(convert_sketch_to_source _sketch_file _converted_source_path)
+function(convert_sketch_to_source _sketch_file _converted_source_path _sketch_prototypes)
 
-    file(STRINGS "${_sketch_file}" sketch_loc)
+    file(STRINGS "${_sketch_file}" sketch_lines)
 
+    set(function_prototype_pattern
+            "${ARDUINO_CMAKE_FUNCTION_DECLARATION_REGEX_PATTERN}|${ARDUINO_CMAKE_FUNCTION_DEFINITION_REGEX_PATTERN}")
     set(header_insert_pattern
-            "${ARDUINO_CMAKE_HEADER_INCLUDE_REGEX_PATTERN}|${ARDUINO_CMAKE_FUNCTION_DEFINITION_REGEX_PATTERN}")
+            "${ARDUINO_CMAKE_HEADER_INCLUDE_REGEX_PATTERN}|${function_prototype_pattern}")
+
     set(header_inserted FALSE)
+    set(prototypes_inserted FALSE)
 
-    list(LENGTH sketch_loc num_of_loc)
-    decrement_integer(num_of_loc 1)
+    list_max_index("${sketch_lines}" lines_count)
+    #[[list(LENGTH sketch_lines lines_count)
+    decrement_integer(lines_count 1)]]
 
-    foreach (loc_index RANGE 0 ${num_of_loc})
+    foreach (line_index RANGE ${lines_count})
 
-        list(GET sketch_loc ${loc_index} loc)
+        list(GET sketch_lines ${line_index} line)
 
-        if (NOT ${header_inserted} AND "${loc}" MATCHES "${header_insert_pattern}")
-            _insert_platform_header_include_line("${sketch_loc}" ${loc_index})
-            set(header_inserted TRUE)
+        if (NOT ${header_inserted})
+            if ("${line}" MATCHES "${header_insert_pattern}")
+                _insert_line("${ARDUINO_CMAKE_PLATFORM_HEADER_INCLUDE_LINE}" "${sketch_lines}" ${line_index})
+                set(header_inserted TRUE)
+            endif ()
+        elseif (NOT ${prototypes_inserted} AND "${line}" MATCHES "${function_prototype_pattern}")
+            _insert_prototypes("${_sketch_prototypes}" "${sketch_lines}" ${line_index})
+            set(prototypes_inserted TRUE)
         endif ()
 
-        if ("${loc}" STREQUAL "")
-            list(APPEND refined_sketch "\n")
+        if ("${line}" STREQUAL "")
+            list(APPEND converted_source "\n")
         else ()
-            string(REGEX REPLACE "^(.+);(.*)$" "\\1${ARDUINO_CMAKE_SEMICOLON_REPLACEMENT}\\2" refined_loc "${loc}")
-            list(APPEND refined_sketch "${refined_loc}\n")
+            escape_semicolon_in_string("${line}" formatted_line)
+            list(APPEND converted_source "${formatted_line}\n")
         endif ()
 
     endforeach ()
 
-    _write_source_file("${refined_sketch}" "${_converted_source_path}")
+    _write_source_file("${converted_source}" "${_converted_source_path}")
 
 endfunction()

cmake/Platform/Utilities/ListUtils.cmake

@@ -37,8 +37,8 @@ function(list_max_index _list _return_var)
     list(LENGTH _list list_length)
 
     set(index ${list_length})
-    if (${index} GREATER 0)
-        decrement_integer(${index} 1)
+    if (${list_length} GREATER 0)
+        decrement_integer(index 1)
     endif ()
 
     set(${_return_var} ${index} PARENT_SCOPE)

cmake/Platform/Utilities/StringUtils.cmake

@@ -74,7 +74,7 @@ endfunction()
 #=============================================================================#
 # Extracts a name symbol without possible file extension (marked usually by a dot ('.').
 #       _input_string - String containing name symbol and possibly file extension.
-#       _return_var - Name of a CMake variable that will hold the extraction result.
+#       _return_var - Name of a CMake variable that will hold the return value.
 #       Returns - String containing input name without possible file extension.
 #=============================================================================#
 function(get_name_without_file_extension _input_string _return_var)
@@ -89,7 +89,7 @@ endfunction()
 # Converts a given string to a PascalCase string, converting 1st letter to upper
 # and remaining to lower.
 #       _input_string - String to convert.
-#       _return_var - Name of a CMake variable that will hold the extraction result.
+#       _return_var - Name of a CMake variable that will hold the return value.
 #       Returns - PascalCase converted string.
 #=============================================================================#
 function(convert_string_to_pascal_case _input_string _return_var)
@@ -108,3 +108,26 @@ function(convert_string_to_pascal_case _input_string _return_var)
     set(${_return_var} ${combined_string} PARENT_SCOPE)
 
 endfunction()
+
+#=============================================================================#
+# Escapes a semicolon in a given string by replacing it with a "magic" string instead, 
+# which isn't parsed as a list separator by CMake.
+# This function can also reverse an escaped semicolon by replacing it back with a semicolon.
+#       _string - String to escape/re-escape.
+#       [REVERSE] - Optional flag indicating whether to reverse an already-escaped string back to its original form.
+#       _return_var - Name of a CMake variable that will hold the return value.
+#       Returns - Original string if [REVERSE] provided, Semicolon-escaped string otherwise.
+#=============================================================================#
+function(escape_semicolon_in_string _string _return_var)
+
+    cmake_parse_arguments(parsed_args "REVERSE" "" "" ${ARGN})
+
+    if (parsed_args_REVERSE)
+        string(REGEX REPLACE "^(.+)${ARDUINO_CMAKE_SEMICOLON_REPLACEMENT}(.*)$" "\\1;\\2" escaped_line "${_string}")
+    else ()
+        string(REGEX REPLACE "^(.+);(.*)$" "\\1${ARDUINO_CMAKE_SEMICOLON_REPLACEMENT}\\2" escaped_line "${_string}")
+    endif ()
+
+    set(${_return_var} ${escaped_line} PARENT_SCOPE)
+
+endfunction()