feat: autogenerate the user's CMakeLists.txt

The script uses its location and arduino-cli to write a template
of the sketch's CMakeLists.txt.
* Defines:
  - CORE_PATH
  - USER_LIBS -> for use with `external_library()`
* Includes all user libraries
* Usable on a given sketch or generically (use placeholders)
* Optionally: run CMake (config+build)

Author: massonal

CI/update/templates/easy_cmake.cmake

@@ -0,0 +1,95 @@
+# This file was autogenerated by {{scriptfile}}.
+# Use it in your CMake configuration by `include()`'ing it.
+# You can also copy it in your sketch's folder and edit it to fit your project.
+
+cmake_minimum_required(VERSION 3.13)
+
+# STEP 1: set up bases of environment
+# -----------------------------------------------------------------------------
+
+file(REAL_PATH "{{corepath}}" CORE_PATH EXPAND_TILDE)
+file(TO_CMAKE_PATH "{{"${CORE_PATH}"}}" CORE_PATH)
+
+file(REAL_PATH "{{userlibs}}" USER_LIBS EXPAND_TILDE)
+file(TO_CMAKE_PATH "{{"${USER_LIBS}"}}" USER_LIBS)
+
+set(BOARDNAME "{{boardname or "@board_name_here@"}}")
+
+list(APPEND CMAKE_MODULE_PATH {{"${CORE_PATH}"}}/cmake)
+set(CMAKE_TOOLCHAIN_FILE toolchain)
+
+
+# You may remove this block when using this file as the sketch's CMakeLists.txt
+if (NOT ${CMAKE_PARENT_LIST_FILE} STREQUAL ${CMAKE_CURRENT_LIST_FILE})
+    # When we are imported from the main CMakeLists.txt, we should stop here
+    # not to interfere with the true build config.
+    return()
+endif()
+
+
+
+# STEP 2: configure the build
+# -----------------------------------------------------------------------------
+
+include(set_board)
+set_board("{{"${BOARDNAME}"}}"
+  # SERIAL generic
+  # USB none
+  # XUSB FS
+  # VIRTIO disabled
+)
+
+include(overall_settings)
+overall_settings(
+  # STANDARD_LIBC
+  # PRINTF_FLOAT
+  # SCANF_FLOAT
+  # DEBUG_SYMBOLS
+  # LTO
+  # NO_RELATIVE_MACRO
+  # UNDEF_NDEBUG
+  # OPTIMIZATION "s"
+  # BUILD_OPT ./build.opt
+  # DISABLE_HAL_MODULES ADC I2C RTC SPI TIM DAC EXTI ETH SD QSPI
+)
+
+# 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
+{% for libdir in libs | sort %}
+external_library(PATH "{{"${USER_LIBS}"}}/{{libdir}}")
+{% endfor %}
+
+include(build_sketch)
+build_sketch(TARGET "{{tgtname or "@binary_name_here@"}}"
+  SOURCES
+  {% for file in scrcfiles | sort %}
+  {{file}}
+  {% else %}
+  ./file1.ino
+  ./file2.ino
+  ./file3.cpp
+  ./file4.c
+  ./file5.S
+  {% endfor %}
+
+  # DEPENDS
+  # SD
+  # Wire
+)
+
+# STEP 4: optional features
+# -----------------------------------------------------------------------------
+
+include(insights)
+insights(TARGET "{{tgtname or "@binary_name_here@"}}"
+  # DIRECT_INCLUDES
+  # TRANSITIVE_INCLUDES
+  # SYMBOLS
+  # ARCHIVES
+  # LOGIC_STRUCTURE
+)

scripts/cmake_easy_setup.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+
+import argparse
+import subprocess
+import shutil
+import tempfile
+import os
+import pathlib
+import json
+from jinja2 import Environment, FileSystemLoader
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--cli", "-x", type=pathlib.Path, required=False, default=shutil.which("arduino-cli"), help="path to arduino-cli")
+parser.add_argument("--board", "-b", type=str, default="", help="board name")
+parser.add_argument("--fire", action="store_true", default=False, help="launch the build immediately (use with caution!)")
+output_args = parser.add_mutually_exclusive_group(required=True)
+output_args.add_argument("--output", "-o", type=pathlib.Path, help="output file (CMake) with placeholders")
+output_args.add_argument("--sketch", "-s", type=pathlib.Path, help="output file (CMake) filled given a sketch folder")
+
+shargs = parser.parse_args()
+
+if shargs.sketch and not shargs.board :
+    print("""
+    Warning: you did not specify which board you were targeting;
+    please review the generated CMakeLists.txt to remove the placeholder value before calling `cmake`.
+    """)
+
+if shargs.cli is None :
+    print("""
+    Error: `arduino-cli` not found in $PATH.
+    Please install arduino-cli and make it available from your system $PATH,
+    or give its location through the `--cli` argument.
+    """)
+    exit(-1)
+
+def arduino(*args) :
+    # return (out.stdout, logfile)
+    # raises an exception if the command fails
+    handle, logfile = tempfile.mkstemp()
+    os.close(handle)
+    out = subprocess.run(
+        (shargs.cli, "--log-file", logfile, "--log-format", "json", *args),
+        capture_output=True,
+        encoding="utf-8",
+        check=True,
+    ).stdout
+    return (out, logfile)
+
+def get_log(fname) :
+    with open(fname) as file :
+        for line in file :
+            yield json.loads(line)
+
+
+_, logf = arduino("lib", "list")
+
+libpaths = dict()
+for line in get_log(logf) :
+    if line["msg"] == "Adding libraries dir" :
+        libpaths[line["location"]] = pathlib.Path(line["dir"])
+
+# 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()
+
+j2_env = Environment(
+    loader=FileSystemLoader(str(corepath/"CI"/"update"/"templates")), trim_blocks=True, lstrip_blocks=True
+)
+cmake_template = j2_env.get_template("easy_cmake.cmake")
+
+
+userhome = pathlib.Path.home()
+if userlibs.is_relative_to(userhome) :
+    userlibs = "~/" + str(userlibs.relative_to(userhome))
+if corepath.is_relative_to(userhome) :
+    corepath = "~/" + str(corepath.relative_to(userhome))
+
+if shargs.sketch :
+    SOURCEFILE_EXTS = (".c", ".cpp", ".S", ".ino")
+    sources = {
+        file.relative_to(shargs.sketch)
+        for file in shargs.sketch.glob("*")
+        if file.is_file() and file.suffix in SOURCEFILE_EXTS
+    }
+    sources |= {
+        file.relative_to(shargs.sketch)
+        for file in shargs.sketch.rglob("src/*")
+        if file.is_file() and file.suffix in SOURCEFILE_EXTS
+    }
+    tgtname = shargs.sketch.resolve().name
+else :
+    tgtname = ""
+    sources = set()
+
+scriptname = pathlib.Path(__file__)
+if scriptname.is_relative_to(userhome) :
+    scriptname = "~/" + str(scriptname.relative_to(userhome))
+
+with open(shargs.output or shargs.sketch/"CMakeLists.txt", "w") as out :
+    out.write(cmake_template.render(
+        corepath=str(corepath).replace("\\", "\\\\"), # escape backslashes for CMake
+        userlibs=str(userlibs).replace("\\", "\\\\"),
+        libs=libs,
+        scriptfile=scriptname,
+        tgtname=tgtname,
+        scrcfiles=sources,
+        boardname=shargs.board,
+    ))
+
+
+if shargs.fire :
+    if not (shargs.sketch and shargs.board) :
+        print("There remains some placeholder in the output file; I won't build _that_.")
+        exit(1)
+    subprocess.run(("cmake", "-S", shargs.sketch, "-B", shargs.sketch/"build"))
+    subprocess.run(("cmake", "--build", shargs.sketch/"build"))