feat: new optional features

massonal · fpistm · commit 0e35d7afe856 · 2022-12-20T14:52:45.000+01:00
- Added a new kind of insight: logic structure
- Added the CORE_CALLBACK overall setting
diff --git a/CI/update/templates/easy_cmake.cmake b/CI/update/templates/easy_cmake.cmake
@@ -51,6 +51,7 @@ overall_settings(
   # OPTIMIZATION "s"
   # BUILD_OPT ./build.opt
   # DISABLE_HAL_MODULES ADC I2C RTC SPI TIM DAC EXTI ETH SD QSPI
+  # CORE_CALLBACK
 )
 
 # STEP 3: configure your sketch
diff --git a/cmake/convert_file.cmake b/cmake/convert_file.cmake
@@ -13,14 +13,14 @@ function(elf2hex ELFTGT)
   set_property(TARGET ${ELFTGT} APPEND PROPERTY ADDITIONAL_CLEAN_FILES "$<TARGET_FILE:${ELFTGT}>.hex")
 endfunction()
 
-function(gv2svg GVFILE)
+function(gv2svg GVFILE ENGINE)
   get_filename_component(ABSGV ${GVFILE} ABSOLUTE BASE_DIR ${CMAKE_CURRENT_BINARY_DIR})
   get_filename_component(GVNAME ${GVFILE} NAME)
 
   # HACK: all this to get the final SVG file as a visible target with the same name as the file
   add_custom_target(${GVNAME}.svg DEPENDS ${ABSGV})
   add_custom_command(TARGET ${GVNAME}.svg POST_BUILD
-    COMMAND ${SFDP} -Tsvg -o ${ABSGV}.svg ${ABSGV}
+    COMMAND ${ENGINE} -Tsvg -o ${ABSGV}.svg ${ABSGV}
   )
   set_property(TARGET ${GVNAME}.svg APPEND PROPERTY ADDITIONAL_CLEAN_FILES ${ABSGV}.svg)
 
diff --git a/cmake/insights.cmake b/cmake/insights.cmake
@@ -22,7 +22,7 @@ macro(find_dependencies TGT DEPTGTS)
 endmacro()
 
 function(insights)
-  set(KEYWORDS "DIRECT_INCLUDES" "TRANSITIVE_INCLUDES" "SYMBOLS" "ARCHIVES")
+  set(KEYWORDS "DIRECT_INCLUDES" "TRANSITIVE_INCLUDES" "SYMBOLS" "ARCHIVES" "LOGIC_STRUCTURE")
   cmake_parse_arguments(PARSE_ARGV 0 INSIGHTS "${KEYWORDS}" "TARGET" "")
 
   if(DEFINED INSIGHTS_UNPARSED_ARGUMENTS OR DEFINED INSIGHTS_KEYWORDS_MISSING_VALUES)
@@ -84,7 +84,7 @@ function(insights)
       COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/includes.py -o ${INSIGHTS_DIRECT_INCLUDES_GVFNAME} ${ALL_LOGS}
       DEPENDS ${ALL_LOGS}
     )
-    gv2svg(${INSIGHTS_DIRECT_INCLUDES_GVFNAME})
+    gv2svg(${INSIGHTS_DIRECT_INCLUDES_GVFNAME} ${SFDP})
   endif()
 
   if (${INSIGHTS_TRANSITIVE_INCLUDES})
@@ -93,7 +93,7 @@ function(insights)
       COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/includes.py -t ${INSIGHTS_TRANSITIVE_INCLUDES_GVFNAME} ${ALL_LOGS}
       DEPENDS ${ALL_LOGS}
     )
-    gv2svg(${INSIGHTS_TRANSITIVE_INCLUDES_GVFNAME})
+    gv2svg(${INSIGHTS_TRANSITIVE_INCLUDES_GVFNAME} ${SFDP})
   endif()
 
   if (${INSIGHTS_SYMBOLS})
@@ -102,7 +102,7 @@ function(insights)
       COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/syms.py -m ${MAPFILE} -f ${INSIGHTS_SYMBOLS_GVFNAME}
       DEPENDS ${MAPFILE}
     )
-    gv2svg(${INSIGHTS_SYMBOLS_GVFNAME})
+    gv2svg(${INSIGHTS_SYMBOLS_GVFNAME} ${SFDP})
   endif()
 
   if (${INSIGHTS_ARCHIVES})
@@ -111,6 +111,16 @@ function(insights)
       COMMAND ${Python3_EXECUTABLE} ${SCRIPTS_FOLDER}/syms.py -m ${MAPFILE} -s ${INSIGHTS_ARCHIVES_GVFNAME}
       DEPENDS ${MAPFILE}
     )
-    gv2svg(${INSIGHTS_ARCHIVES_GVFNAME})
+    gv2svg(${INSIGHTS_ARCHIVES_GVFNAME} ${SFDP})
+  endif()
+
+  if(${INSIGHTS_LOGIC_STRUCTURE})
+    file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/gv)
+    add_custom_command(OUTPUT ${OUTDIR}/logicstructure.gv
+      COMMAND ${CMAKE_COMMAND} --graphviz=${CMAKE_CURRENT_BINARY_DIR}/gv/project.gv ${CMAKE_BINARY_DIR}
+      COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_BINARY_DIR}/gv/project.gv.${INSIGHTS_TARGET} ${OUTDIR}/logicstructure.gv
+      BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/gv/project.gv.${INSIGHTS_TARGET}
+    )
+    gv2svg(${OUTDIR}/logicstructure.gv ${DOT})
   endif()
 endfunction()
diff --git a/cmake/overall_settings.cmake b/cmake/overall_settings.cmake
@@ -2,7 +2,14 @@ cmake_minimum_required(VERSION 3.21)
 add_library(user_settings INTERFACE)
 
 function(overall_settings)
-  set(KEYWORDS0 STANDARD_LIBC PRINTF_FLOAT SCANF_FLOAT DEBUG_SYMBOLS LTO NO_RELATIVE_MACRO UNDEF_NDEBUG)
+  if(TARGET user_settings)
+    message(SEND_ERROR "overall_settings() was called twice. This is not allowed as it could result in conflicting settings.")
+    return()
+  endif()
+
+  add_library(user_settings INTERFACE)
+
+  set(KEYWORDS0 STANDARD_LIBC PRINTF_FLOAT SCANF_FLOAT DEBUG_SYMBOLS LTO NO_RELATIVE_MACRO UNDEF_NDEBUG CORE_CALLBACK)
   set(KEYWORDS1 OPTIMIZATION BUILD_OPT)
   set(KEYWORDSN DISABLE_HAL_MODULES)
   cmake_parse_arguments(PARSE_ARGV 0 WANT "${KEYWORDS0}" "${KEYWORDS1}" "${KEYWORDSN}")
@@ -11,6 +18,12 @@ function(overall_settings)
     message(SEND_ERROR "Invalid call to overall_settings(); some arguments went unparsed")
   endif()
 
+  if(${WANT_CORE_CALLBACK})
+    target_compile_options(user_settings INTERFACE
+      CORE_CALLBACK
+    )
+  endif()
+
   if(NOT ${WANT_NO_RELATIVE_MACRO})
     # $<TARGET_PROPERTY:SOURCE_DIR> is evaluated by the final consumer, not user_settings
     target_compile_options(user_settings INTERFACE
diff --git a/cmake/toolchain.cmake b/cmake/toolchain.cmake
@@ -29,9 +29,9 @@ else()
   set(PYTHON_HAS_JINJA ON)
 endif()
 
-
-
-find_program(SFDP "sfdp") # graphviz layout engine -- you may change the engine, use dot or whatever
+# graphviz layout engines
+find_program(SFDP "sfdp")
+find_program(DOT "dot")
 
 include("${CMAKE_CURRENT_LIST_DIR}/ensure_core_deps.cmake")
 ensure_core_deps()

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ overall_settings(`
`51`	`51`	`# OPTIMIZATION "s"`
`52`	`52`	`# BUILD_OPT ./build.opt`
`53`	`53`	`# DISABLE_HAL_MODULES ADC I2C RTC SPI TIM DAC EXTI ETH SD QSPI`
	`54`	`+ # CORE_CALLBACK`
`54`	`55`	`)`
`55`	`56`
`56`	`57`	`# STEP 3: configure your sketch`