Added sketch header resolving, updated library resolving to use it

Author: MrPointer

cmake/Platform/Sketches/SketchHeadersResolver.cmake

@@ -1,28 +1,13 @@
 #=============================================================================#
-# Resolves the header files included in a sketch by linking their appropriate library if necessary
-# or by validating they're included by the sketch target.
-#       _target_name - Name of the target to add the sketch file to.
-#       _sketch_file - Path to a sketch file to add to the target.
+# Resolves all headers used by a given sketch file by searching its 'include lines', recursively.
+#       _target_name - Name of the sketch's target created earlier.
+#       _sketch_file - Path to the sketch file which its' headers should be resolved.
 #       _return_var - Name of variable in parent-scope holding the return value.
 #       Returns - List of all unique header files used by the sketch file, recursively.
 #=============================================================================#
 function(resolve_sketch_headers _target_name _sketch_file _return_var)
 
-    _get_source_included_headers("${_sketch_file}" sketch_headers)
-
-    foreach (header ${sketch_headers})
-
-        # Header name without extension (such as '.h') can represent an Arduino/Platform library
-        # So first we should check whether it's a library
-        get_name_without_file_extension("${header}" header_we)
-
-        is_header_discoverable_by_target(${header_we} ${_target_name} known_header)
-
-        if (NOT ${known_header})
-            message(STATUS "The '${header_we}' header used by the '${_sketch_file}' sketch can't be resolved. "
-                    "It's probably a user-header which location is unknown to the framework.")
-        endif ()
-
-    endforeach ()
+    get_target_include_directories(${_target_name} target_include_dirs)
+    get_source_headers("${_sketch_file}" ${target_include_dirs} sketch_headers RECURSIVE)
 
 endfunction()

cmake/Platform/Sketches/SketchLibrariesResolver.cmake

@@ -1,17 +1,15 @@
 #=============================================================================#
-# Resolves the header files included in a sketch by linking their appropriate library if necessary
-# or by validating they're included by the sketch target.
-#       _target_name - Name of the target to add the sketch file to.
-#       _sketch_file - Path to a sketch file to add to the target.
+# Resolves the libraries used by a sketch file. It's possible that not all libraries will be resolved,
+# as the current algorithm relies on the name of the included headers to match a library name.
+#       _target_name - Name of the sketch's target created earlier.
+#       _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.
 #=============================================================================#
-function(resolve_sketch_libraries _target_name _sketch_file)
+function(resolve_sketch_libraries _target_name _sketch_file _sketch_headers)
 
-    _get_source_included_headers("${_sketch_file}" sketch_headers)
-
-    foreach (header ${sketch_headers})
+    foreach (header ${_sketch_headers})
 
         # Header name without extension (such as '.h') can represent an Arduino/Platform library
-        # So first we should check whether it's a library
         get_name_without_file_extension("${header}" header_we)
 
         # Pass the '3RD_PARTY' option to avoid name-conversion

cmake/Platform/Sketches/SketchManager.cmake

@@ -30,7 +30,9 @@ function(add_sketch_to_target _target_name _sketch_file)
     # Only perform conversion if policy is set or if sketch hasn't been converted yet
     if (CONVERT_SKETCHES_IF_CONVERTED_SOURCES_EXISTS OR NOT EXISTS ${sketch_converted_source_path})
 
-        resolve_sketch_libraries(${_target_name} ${_sketch_file})
+        resolve_sketch_headers(${_target_name} ${_sketch_file} sketch_headers)
+
+        resolve_sketch_libraries(${_target_name} ${_sketch_file} "${sketch_headers}")
 
         convert_sketch_to_source(${_sketch_file} ${sketch_converted_source_path})
 

cmake/Platform/Sources/SourceHeadersRetriever.cmake

@@ -36,33 +36,36 @@ endfunction()
 #=============================================================================#
 # Retrieves all headers used by a source file, possibly recursively (Headers used by headers).
 #       _source_file - Path to a source file to get its' used headers.
+#       _search_dirs - List of directories where headers should be searched at.
 #       [RECURSIVE] - Whether to search for headers recursively.
 #       _return_var - Name of variable in parent-scope holding the return value.
 #       Returns - List of full paths to the headers that are used by the given source file.
 #=============================================================================#
-function(get_source_headers _source_file _include_dirs _return_var)
+function(get_source_headers _source_file _search_dirs _return_var)
 
     cmake_parse_arguments(parsed_args "RECURSIVE" "" "" ${ARGN})
 
     _get_source_included_headers(${_source_file} included_headers WE)
 
     foreach (header ${included_headers})
 
-        get_header_file(${header} ${_include_dirs} header_path)
+        get_header_file(${header} ${_search_dirs} header_path)
         if (NOT header_path OR "${header_path}" MATCHES "NOTFOUND")
             continue()
         endif ()
 
         list(APPEND final_included_headers ${header_path})
 
         if (parsed_args_RECURSIVE)
-            get_source_headers(${header_path} ${_include_dirs} recursive_included_headers RECURSIVE)
+            get_source_headers(${header_path} ${_search_dirs} recursive_included_headers RECURSIVE)
             list(APPEND final_included_headers ${recursive_included_headers})
         endif ()
 
     endforeach ()
 
-    list(REMOVE_DUPLICATES final_included_headers)
+    if (final_included_headers)
+        list(REMOVE_DUPLICATES final_included_headers)
+    endif ()
 
     set(${_return_var} ${final_included_headers} PARENT_SCOPE)