Improved header resolving when converting sketches to sources

Author: MrPointer

cmake/Platform/Sketches/SketchHeadersManager.cmake

@@ -1,3 +1,54 @@
+function(_check_header_existance _header_we _dir_list _return_var)
+
+    foreach (include_dir ${_dir_list})
+        find_header_files("${include_dir}" include_dir_headers RECURSE)
+
+        foreach (included_header ${include_dir_headers})
+            get_name_without_file_extension(${included_header} included_header_we)
+            if ("${included_header_we}" STREQUAL "${_header_we}")
+                set(_return_var TRUE PARENT_SCOPE)
+                return()
+            endif ()
+        endforeach ()
+
+    endforeach ()
+
+    set(_return_var FALSE PARENT_SCOPE)
+
+endfunction()
+
+function(_is_known_header _header_we _target_name _return_var)
+
+    # Get target's direct include dirs
+    get_target_property(target_include_dirs ${_target_name} INCLUDE_DIRECTORIES)
+
+    # Get include dirs of targets linked to the given target
+    get_target_property(target_linked_libs ${_target_name} LINK_LIBRARIES)
+
+    # Explictly add include dirs of all linked libraries (given they're valid cmake targets)
+    foreach (linked_lib ${target_linked_libs})
+
+        if (NOT TARGET ${linked_lib})
+            continue()
+        endif ()
+
+        get_target_property(lib_include_dirs ${linked_lib} INCLUDE_DIRECTORIES)
+        if (NOT "${lib_include_dirs}" MATCHES "NOTFOUND") # Library has include dirs
+            list(APPEND include_dirs ${lib_include_dirs})
+        endif ()
+
+    endforeach ()
+
+    if (NOT "${target_include_dirs}" MATCHES "NOTFOUND") # Target has direct include dirs
+        list(APPEND include_dirs ${target_include_dirs})
+    endif ()
+
+    _check_header_existance(${_header_we} ${include_dirs} header_found)
+
+    set(_return_var ${header_found} PARENT_SCOPE)
+
+endfunction()
+
 #=============================================================================#
 # 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.
@@ -14,32 +65,21 @@ function(resolve_sketch_headers _target_name _sketch_file)
         # So first we should check whether it's a library
         get_name_without_file_extension("${header}" header_we)
 
-        is_platform_library(${header_we} is_header_platform_lib)
+        # Pass the '3RD_PARTY' option to avoid name-conversion
+        find_arduino_library(${header_we}_sketch_lib ${header_we} 3RD_PARTY QUIET)
 
-        if (is_header_platform_lib)
+        if (NOT TARGET ${header_we}_sketch_lib OR "${${header_we}_sketch_lib}" MATCHES "NOTFOUND")
 
-            string(TOLOWER ${header_we} header_we_lower)
+            # The header name doesn't conform to a name of a known library, search individual headers instead
+            _is_known_header(${header_we} ${_target_name} known_header)
 
-            link_platform_library(${_target_name} ${header_we_lower})
-
-        else ()
-
-            # Pass the '3RD_PARTY' option to avoid name-conversion
-            find_arduino_library(${header_we}_sketch_lib ${header_we} 3RD_PARTY QUIET)
-
-            # If library isn't found, display a status since it might be a user library
-            if (NOT TARGET ${header_we}_sketch_lib OR
-                    "${${header_we}_sketch_lib}" MATCHES "NOTFOUND")
-
-                message(STATUS "The header '${header_we}' is used by the '${_sketch_file}' sketch, "
-                        "but it isn't part of an Arduino nor a Platform library.\n\t"
-                        "However, it may be part of a user library but "
-                        "you'd have to check this manually!")
-
-            else ()
-                link_arduino_library(${_target_name} ${header_we}_sketch_lib)
+            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 ()
 
+        else ()
+            link_arduino_library(${_target_name} ${header_we}_sketch_lib)
         endif ()
 
     endforeach ()

cmake/Platform/System/DefaultsManager.cmake

@@ -5,15 +5,20 @@ function(set_internal_search_patterns)
 
     set(ARDUINO_CMAKE_SEMICOLON_REPLACEMENT "!@&#%" CACHE STRING
             "String replacement for the semicolon char, required when treating lists as code")
+
     set(ARDUINO_CMAKE_HEADER_INCLUDE_REGEX_PATTERN "^#include.*[<\"]" CACHE STRING
             "Regex pattern matching header inclusion in a source file")
+
     set(ARDUINO_CMAKE_HEADER_NAME_REGEX_PATTERN
             "${ARDUINO_CMAKE_HEADER_INCLUDE_REGEX_PATTERN}(.+)[>\"]$" CACHE STRING
             "Regex pattern matching a header's name when wrapped in inclusion line")
+
     set(ARDUINO_CMAKE_HEADER_FILE_EXTENSION_REGEX_PATTERN ".+\\.h.*$" CACHE STRING
             "Regex pattern matching all header file extensions")
-    set(ARDUINO_CMAKE_NAME_WE_REGEX_PATTERN "(.+)\\." CACHE STRING
+
+    set(ARDUINO_CMAKE_NAME_WE_REGEX_PATTERN "([^\\/]+)\\." CACHE STRING
             "Regex pattern matching name without file extension")
+
     set(ARDUINO_CMAKE_FUNCTION_REGEX_PATTERN "^([a-z]|[A-Z])+.*\(([a-z]|[A-Z])*\)" CACHE STRING
             "Regex pattern matching a function signature in a source file")
 

cmake/Platform/Utilities/PlatformLibraryUtils.cmake

@@ -7,6 +7,7 @@
 function(is_platform_library _name _return_var)
 
     string(TOLOWER "${_name}" name_lower)
+
     if ("${name_lower}" IN_LIST ARDUINO_CMAKE_PLATFORM_LIBRARIES)
         set(lib_found TRUE)
     else ()

examples/CMakeLists.txt

@@ -2,12 +2,14 @@ cmake_minimum_required(VERSION 3.8.2)
 
 project(Examples LANGUAGES C CXX ASM)
 
-add_subdirectory(hello-world)
+#[[add_subdirectory(hello-world)
 add_subdirectory(arduino-library)
 add_subdirectory(platform-library)
 add_subdirectory(3rd-party-library)
 add_subdirectory(header-only-library)
 add_subdirectory(blink-example)
 add_subdirectory(servo-knob-example)
 add_subdirectory(sketch)
-add_subdirectory(misc)
+add_subdirectory(misc)]]
+
+add_subdirectory(sketch)