refactor: general cleanup, messaging

Important: the changed implemented here _require_ the user
to call `project()` in "step 1", before calling any custom function,
but after defining the toolchain file.

The whole of Arduino_Core_STM32 (variant + core) is now added
automatically when the user calls build_sketch() ; they don't have to
do it themselves anymore.

Also the standard libraries have moved from stm32_runtime to base_config.
Indeed, even the files from the core depend on them.

Also, _all_ the Arduino libraries depend on base_config only (even SrcWrapper).
Additional dependencies were actually not needed.

***Moved the CMake-related files to /cmake***
-- for clarity with the remainder of the project (when using Arduino IDE)
-- Also, this prevents IDEs from building the core "standalone" when seeing a CMakeLists.txt at the root,
--   since that would be meaningless anyway.

Also improve portability by replacing backslashes with forward slashes in paths on Windows.

=======================

Change: moved the download folder away

Having the download folder along the core seemed to
cause malfunctions with some external tools (Arduino plugin on VScode).

Moving it in the user's home folder fixes this issue.

Each core installation nonetheless has its own download subfolder,
to allow different versions with different requirements to coexist.

Author: massonal

cmake/FindArduinoCtags.cmake

@@ -2,8 +2,6 @@ cmake_minimum_required(VERSION 3.21)
 include(FetchContent)
 include(FindPackageHandleStandardArgs)
 
-file(REAL_PATH "${CMAKE_CURRENT_LIST_DIR}/../../.Arduino_Core_STM32_downloads" DL_DIR)
-
 function(get_ctags)
   cmake_host_system_information(
     RESULT HOSTINFO
@@ -65,7 +63,9 @@ function(get_ctags)
     URL_HASH SHA512=${CHECKSUM}
     UPDATE_DISCONNECTED
   )
+  message(STATUS "Downloading Arduino's ctags...")
   FetchContent_MakeAvailable(ctags)
+  message(STATUS "Downloading Arduino's ctags... Done.")
 endfunction()
 
 # -------------------------------------------------------------------------------

cmake/build_sketch.cmake

@@ -1,10 +1,16 @@
 cmake_minimum_required(VERSION 3.21)
 
-set(SCRIPTS_FOLDER ${CMAKE_CURRENT_LIST_DIR}/../scripts)
 include(sketch_preprocess_sources)
 include(convert_file)
 
+include(set_base_arduino_config)
+
 function(build_sketch)
+  add_subdirectory(${BUILD_VARIANT_PATH} ./variant)
+  add_subdirectory(${BUILD_CORE_PATH} ./cores/arduino)
+  add_subdirectory(${BUILD_LIB_PATH} ./libraries)
+
+
   cmake_parse_arguments(PARSE_ARGV 0 SKBD "" "TARGET" "SOURCES;DEPENDS")
 
   if(DEFINED SKBD_UNPARSED_ARGUMENTS OR DEFINED SKBD_KEYWORDS_MISSING_VALUES)
@@ -20,7 +26,7 @@ function(build_sketch)
   endif()
 
   add_executable(${SKBD_TARGET})
-  target_include_directories(base_config INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
+  target_include_directories(base_config BEFORE INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
 
   foreach(SRCS IN LISTS SKBD_SOURCES)
     sketch_preprocess_sources(OUTPUT_VARIABLE SRCS SOURCES ${SRCS})

cmake/ensure_core_deps.cmake

@@ -1,10 +1,6 @@
 cmake_minimum_required(VERSION 3.21)
 include(FetchContent)
 
-file(REAL_PATH "${CMAKE_CURRENT_LIST_DIR}/../platform.txt" PLATFORMTXT_PATH)
-file(REAL_PATH "${CMAKE_CURRENT_LIST_DIR}/../../.Arduino_Core_STM32_downloads" DL_DIR)
-set(JSONCONFIG_URL "https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/dev/package_stmicroelectronics_index.json")
-
 function(get_core_version OUTVAR)
   file(READ ${PLATFORMTXT_PATH} PLATFORMTXT)
   string(REGEX MATCH "version=.+\n" LINE "${PLATFORMTXT}")
@@ -147,8 +143,12 @@ function(ensure_core_deps)
   if(NOT EXISTS ${DL_DIR}/dist/CMSIS5 OR NOT EXISTS ${DL_DIR}/dist/xpack)
     get_core_version(COREVER)
     declare_deps(${COREVER})
+    message(STATUS "Downloading the CMSIS...")
     FetchContent_MakeAvailable(CMSIS5)
+    message(STATUS "Downloading the CMSIS... Done.")
+    message(STATUS "Downloading the compiler toolchain...")
     FetchContent_MakeAvailable(xpack)
+    message(STATUS "Downloading the compiler toolchain... Done.")
   endif()
 
   set(CMSIS5_PATH ${DL_DIR}/dist/CMSIS5 PARENT_SCOPE)

cmake/environment.cmake

@@ -0,0 +1,20 @@
+cmake_minimum_required(VERSION 3.21)
+
+string(MD5 PATH_HASH "${CMAKE_CURRENT_LIST_FILE}")
+
+file(REAL_PATH "${CMAKE_CURRENT_LIST_DIR}/.." CORE_PATH)
+file(REAL_PATH "${CORE_PATH}/cores/arduino" BUILD_CORE_PATH)
+file(REAL_PATH "${CORE_PATH}/system" BUILD_SYSTEM_PATH)
+file(REAL_PATH "${CORE_PATH}/libraries" BUILD_LIB_PATH)
+file(REAL_PATH "~/.Arduino_Core_STM32_dl/${PATH_HASH}" DL_DIR EXPAND_TILDE)
+file(REAL_PATH "${CORE_PATH}/platform.txt" PLATFORMTXT_PATH)
+file(REAL_PATH "${CORE_PATH}/boards.txt" BOARDSTXT_PATH)
+file(REAL_PATH "${CORE_PATH}/cmake/scripts" SCRIPTS_FOLDER)
+file(REAL_PATH "${CORE_PATH}/cmake/templates/boards_db.cmake" CMAKE_BOARDS_DB_TEMPLATE_PATH)
+file(REAL_PATH "${CORE_PATH}/cmake/boards_db.cmake" CMAKE_BOARDS_DB_PATH)
+
+set(JSONCONFIG_URL "https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/dev/package_stmicroelectronics_index.json")
+
+if(NOT "${CMAKE_CURRENT_LIST_DIR}" IN_LIST CMAKE_MODULE_PATH)
+  list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}")
+endif()

cmake/external_library.cmake

@@ -1,5 +1,4 @@
 cmake_minimum_required(VERSION 3.21)
-set(CI_FOLDER ${CMAKE_CURRENT_LIST_DIR}/../CI)
 
 function(external_library)
   cmake_parse_arguments(PARSE_ARGV 0 XLIB "FORCE" "PATH" "DEPENDS")
@@ -15,7 +14,7 @@ function(external_library)
 
   if(NOT EXISTS ${XLIB_PATH}/CMakeLists.txt OR ${XLIB_FORCE})
     execute_process(
-      COMMAND ${Python3_EXECUTABLE} ${CI_FOLDER}/update/cmake_libs.py -l ${XLIB_PATH} -d ${XLIB_DEPENDS}
+      COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/cmake_libs.py -l ${XLIB_PATH} -d ${XLIB_DEPENDS}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
     )
   endif()

cmake/overall_settings.cmake

@@ -1,5 +1,4 @@
 cmake_minimum_required(VERSION 3.21)
-add_library(user_settings INTERFACE)
 
 function(overall_settings)
   if(TARGET user_settings)

scripts/ccwrapper.py renamed to cmake/scripts/ccwrapper.py

@@ -4,17 +4,16 @@
 import sys
 from pathlib import Path
 from jinja2 import Environment, FileSystemLoader
+from cmake_gen import *
 
 script_path = Path(__file__).parent.resolve()
-sys.path.append(str(script_path.parent))
-from utils.cmake_gen import *
 
 parser = argparse.ArgumentParser()
 parser.add_argument("corepath", type=Path, help="path to .../cores/arduino")
 
 shargs = parser.parse_args()
 
-templates_dir = script_path / "templates"
+templates_dir = script_path / ".." / "templates"
 j2_env = Environment(
 loader=FileSystemLoader(str(templates_dir)), trim_blocks=True, lstrip_blocks=True
 )

CI/update/cmake_core.py renamed to cmake/scripts/cmake_core.py

@@ -62,10 +62,10 @@ def get_log(fname) :
 # platform lib path is already known, obviously, since that's where this script resides
 userlibs = pathlib.Path(libpaths["user"]).resolve()
 libs = [u.name for u in userlibs.iterdir() if u.is_dir()]
-corepath = pathlib.Path(__file__).parent.parent.resolve()
+corepath = pathlib.Path(__file__).parent.parent.parent.resolve()
 
 j2_env = Environment(
-    loader=FileSystemLoader(str(corepath/"CI"/"update"/"templates")), trim_blocks=True, lstrip_blocks=True
+    loader=FileSystemLoader(str(corepath/"cmake"/"templates")), trim_blocks=True, lstrip_blocks=True
 )
 cmake_template = j2_env.get_template("easy_cmake.cmake")
 

scripts/cmake_easy_setup.py renamed to cmake/scripts/cmake_easy_setup.py

@@ -44,7 +44,7 @@ def get_sources(dir, recursive=False, relative_to=None) :
         walker = type(dir).glob
 
     return {
-        file.relative_to(relative_to)
+        str(file.relative_to(relative_to)).replace("\\", "/")
         for file in walker(dir, "*")
         if file.is_file() and file.suffix in SOURCEFILE_EXTS
     }