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.

***Moved the CMake-related files to /cmake***
-- for clarity with the remainder of the project (when using Arduino IDE)

Author: massonal

Diff for: CMakeLists.txt

@@ -1,16 +1,7 @@
 cmake_minimum_required(VERSION 3.21)
 
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake)
-find_package(ArduinoCtags REQUIRED)
-
-
 project("Arduino_Core_STM32" CXX C ASM)
 
-
-set(BUILD_CORE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cores/arduino")
-set(BUILD_SYSTEM_PATH "${CMAKE_CURRENT_SOURCE_DIR}/system")
-set(BUILD_LIB_PATH "${CMAKE_CURRENT_SOURCE_DIR}/libraries")
-
 add_library(base_config INTERFACE)
 
 # better than an if/else because these may be defined later
@@ -72,17 +63,15 @@ target_include_directories(base_config INTERFACE
 )
 
 add_subdirectory(${BUILD_CORE_PATH})
-add_subdirectory(${BUILD_VARIANT_PATH})
 add_subdirectory(${BUILD_LIB_PATH})
 
-
 add_library(stm32_runtime INTERFACE)
 target_link_libraries(stm32_runtime INTERFACE
   base_config
 
   SrcWrapper
   core
-  variant
+  $<TARGET_NAME_IF_EXISTS:variant>
 
   ${CMSIS_LIB}
   m

Diff for: 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()
 
 # -------------------------------------------------------------------------------

Diff for: cmake/build_sketch.cmake

@@ -1,10 +1,13 @@
 cmake_minimum_required(VERSION 3.21)
 
-set(SCRIPTS_FOLDER ${CMAKE_CURRENT_LIST_DIR}/../scripts)
 include(sketch_preprocess_sources)
 include(convert_file)
 
 function(build_sketch)
+  add_subdirectory(${BUILD_VARIANT_PATH} ./variant)
+  add_subdirectory(${CORE_PATH} ./Arduino_Core_STM32)
+
+
   cmake_parse_arguments(PARSE_ARGV 0 SKBD "" "TARGET" "SOURCES;DEPENDS")
 
   if(DEFINED SKBD_UNPARSED_ARGUMENTS OR DEFINED SKBD_KEYWORDS_MISSING_VALUES)
@@ -20,7 +23,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})

Diff for: 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)

Diff for: cmake/environment.cmake

@@ -0,0 +1,18 @@
+cmake_minimum_required(VERSION 3.21)
+
+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 "${CORE_PATH}/../.Arduino_Core_STM32_downloads" DL_DIR)
+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()

Diff for: 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} ${CORE_PATH}/cmake_libs.py -l ${XLIB_PATH} -d ${XLIB_DEPENDS}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
     )
   endif()

Diff for: 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)

Diff for: 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
 )

Diff for: CI/update/cmake_core.py renamed to cmake/scripts/cmake_core.py

@@ -53,10 +53,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")
 

Diff for: scripts/cmake_easy_setup.py renamed to cmake/scripts/cmake_easy_setup.py

@@ -1,13 +1,11 @@
 #!/usr/bin/env python3
 
 import argparse
-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()
 input_dirs = parser.add_mutually_exclusive_group(required=True)
@@ -17,7 +15,7 @@
 
 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
 )

Diff for: CI/utils/cmake_gen.py renamed to cmake/scripts/cmake_gen.py

@@ -1,20 +1,18 @@
 #!/usr/bin/env python3
 
 import argparse
-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("variantspath", type=Path, help="path to .../variants/")
 
 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
 )

Diff for: CI/update/cmake_libs.py renamed to cmake/scripts/cmake_libs.py

@@ -1,5 +1,4 @@
 cmake_minimum_required(VERSION 3.21)
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
 
 function(set_board BOARD_ID)
   include(updatedb)

Diff for: CI/update/cmake_variant.py renamed to cmake/scripts/cmake_variant.py

@@ -1,7 +1,5 @@
 cmake_minimum_required(VERSION 3.21)
 
-set(SCRIPTS_FOLDER ${CMAKE_CURRENT_LIST_DIR}/../scripts)
-
 function(sketch_preprocess_sources)
   cmake_parse_arguments(PARSE_ARGV 0 SPC "" "OUTPUT_VARIABLE" "SOURCES")
   set(SRCLIST "")

Diff for: scripts/generate_header.py renamed to cmake/scripts/generate_header.py

@@ -26,7 +26,7 @@ if (NOT ${CMAKE_PARENT_LIST_FILE} STREQUAL ${CMAKE_CURRENT_LIST_FILE})
     return()
 endif()
 
-
+project("{{tgtname+"_project" if tgtname else "@project_name_here@"}}")
 
 # STEP 2: configure the build
 # -----------------------------------------------------------------------------
@@ -56,8 +56,6 @@ overall_settings(
 
 # STEP 3: configure your sketch
 # -----------------------------------------------------------------------------
-project("{{tgtname+"_project" if tgtname else "@project_name_here@"}}")
-
 include(external_library)
 # I cannot tell the dependencies of the library ahead-of-time
 # Please write them in using the DEPENDS ... clause

Diff for: scripts/includes.py renamed to cmake/scripts/includes.py

@@ -1,5 +1,9 @@
 cmake_minimum_required(VERSION 3.21)
 
+include("${CMAKE_CURRENT_LIST_DIR}/environment.cmake")
+
+find_package(ArduinoCtags REQUIRED)
+
 find_package(
         Python3 3.9 REQUIRED
         COMPONENTS Interpreter

Diff for: scripts/parse_boards.py renamed to cmake/scripts/parse_boards.py

@@ -1,22 +1,24 @@
 cmake_minimum_required(VERSION 3.21)
-set(CORE_PATH ${CMAKE_CURRENT_LIST_DIR}/..)
-set(SCRIPTS_FOLDER ${CORE_PATH}/scripts)
 
 function(updatedb)
-  set(BOARDS_TXT ${CORE_PATH}/boards.txt)
-  set(PLATFORM_TXT ${CORE_PATH}/platform.txt)
-  set(TEMPLATE ${CORE_PATH}/CI/update/templates/boards_db.cmake)
-  set(DB ${CORE_PATH}/cmake/boards_db.cmake)
-
-  set_directory_properties(PROPERTIES
-    CMAKE_CONFIGURE_DEPENDS "${BOARDS_TXT};${PLATFORM_TXT};${TEMPLATE}"
+  set_property(DIRECTORY APPEND
+    PROPERTY CMAKE_CONFIGURE_DEPENDS
+    "${BOARDSTXT_PATH}" "${PLATFORMTXT_PATH}" "${CMAKE_BOARDS_DB_TEMPLATE_PATH}"
   )
 
-  if(${BOARDS_TXT} IS_NEWER_THAN ${DB} OR ${TEMPLATE} IS_NEWER_THAN ${DB})
+  if(
+    ${BOARDSTXT_PATH} IS_NEWER_THAN ${CMAKE_BOARDS_DB_PATH}
+    OR ${PLATFORMTXT_PATH} IS_NEWER_THAN ${CMAKE_BOARDS_DB_PATH}
+    OR ${CMAKE_BOARDS_DB_TEMPLATE_PATH} IS_NEWER_THAN ${CMAKE_BOARDS_DB_PATH}
+  )
     execute_process(
       COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/parse_boards.py
-      -b ${BOARDS_TXT} -p ${PLATFORM_TXT} -t ${TEMPLATE} -o ${DB}
-      # COMMAND_ERROR_IS_FATAL ANY # requires VERSION 3.19
+      -b ${BOARDSTXT_PATH}
+      -p ${PLATFORMTXT_PATH}
+      -t ${CMAKE_BOARDS_DB_TEMPLATE_PATH}
+      -o ${CMAKE_BOARDS_DB_PATH}
+
+      COMMAND_ERROR_IS_FATAL ANY
     )
   endif()
 endfunction()