Add CMake modules to generate VSCode Launch and Settings files

.gitignore

@@ -23,9 +23,6 @@ output/
 build_log.txt
 
 # VScode settings
-.vscode/*cortex-debug*
-.vscode/settings.json
-.vscode/*_properties.json
-.vscode/launch.json
+.vscode/
 
 *.jlink

CMakeLists.txt

@@ -19,6 +19,9 @@ set(DEBUG_TOOLSET "PYOCD")
 # THIS OPTION IS ONLY SUPPORTED WITH THE JLINK TOOLSET
 set(ENABLE_SEGGER_RTT false)
 
+set(DEBUG_INTERFACE "swd")
+# set(DEBUG_INTERFACE "jtag")
+
 # MCU Target name as seen in debug toolset
 set(MCU_TARGET LPC5526)
 
@@ -74,7 +77,7 @@ project(${PROJECT_NAME} VERSION 1.0 LANGUAGES C)
 
 # Set the C standard and executable suffix
 set(CMAKE_EXECUTABLE_SUFFIX ".elf")
-set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 
 # Set our executable output path to the 'output/' folder
@@ -162,4 +165,7 @@ add_custom_target(erase ${DEBUG_ERASE_CMD})
 add_custom_target(flash ${DEBUG_FLASH_CMD})
 
 # Add a makefile "target" for running unit tests
-add_custom_target(test cd ../ && ceedling gcov:all utils:gcov)
+add_custom_target(test cd ../ && ceedling gcov:all utils:gcov)
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/vscode_debug.cmake)
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/vscode_intellisense.cmake)

cmake/debug_jlink.cmake

@@ -18,48 +18,4 @@ loadfile ${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.hex
 r
 g
 exit"
-)
-
-write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
-{\n
-    \t\"version\": \"0.2.0\",\n
-    \t\"configurations\": [\n
-    \t{\n
-        \t\t\"name\": \"${MCU_TARGET}\",\n
-        \t\t\"type\": \"cortex-debug\",\n
-        \t\t\"request\": \"launch\",\n
-        \t\t\"servertype\":\"jlink\",\n
-        \t\t\"cwd\": \"${workspaceRoot}\",\n
-        \t\t\"executable\": \"${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.elf\",\n
-        \t\t\"device\": \"${MCU_TARGET}\",\n
-        \t\t\"runToMain\": true,\n
-        \t\t\"v1\": false,\n
-        \t\t\"serverArgs\": [\n
-            \t\t\t\"--target\",\n
-            \t\t\t\"${MCU_TARGET}\"\n
-        \t\t],
-)
-
-if(${ENABLE_SEGGER_RTT})
-
-write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
-\t\t"rttConfig":{\n
-    \t\t\t"enabled":true,\n
-    \t\t\t"address":"auto",\n
-    \t\t\t"decoders":[{\n
-    \t\t\t\t"port":0,\n
-    \t\t\t\t"type":"console"\n
-    \t\t\t}]\n
-\t\t}\n
-\t}]\n
-}
-APPEND)
-
-else()
-
-write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
-\t}]\n
-}
-APPEND)
-
-endif()
+)

cmake/debug_pyocd.cmake

@@ -1,23 +1,2 @@
 set(DEBUG_ERASE_CMD "pyocd" "erase" "-t${MCU_TARGET}" "--chip")
-set(DEBUG_FLASH_CMD "pyocd" "flash" "-t${MCU_TARGET}" "-f20000khz" "${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.elf")
-
-write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
-{\n
-    \t\"version\": \"0.2.0\",\n
-    \t\"configurations\": [\n
-    \t{\n
-        \t\t\"name\": \"${MCU_TARGET}\",\n
-        \t\t\"type\": \"cortex-debug\",\n
-        \t\t\"request\": \"launch\",\n
-        \t\t\"servertype\":\"pyocd\",\n
-        \t\t\"cwd\": \"${workspaceRoot}\",\n
-        \t\t\"executable\": \"${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.elf\",\n
-        \t\t\"device\": \"${MCU_TARGET}\",\n
-        \t\t\"runToMain\": true,\n
-        \t\t\"v1\": false,\n
-        \t\t\"serverArgs\": [\n
-            \t\t\t\"--target\",\n
-            \t\t\t\"${MCU_TARGET}\"\n
-        \t\t]\n
-    \t}]\n
-})
+set(DEBUG_FLASH_CMD "pyocd" "flash" "-t${MCU_TARGET}" "-f20000khz" "${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.elf")

cmake/vscode_debug.cmake

@@ -0,0 +1,46 @@
+# Make sure to create the .vscode directory if it doesn't exist
+file(MAKE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/.vscode)
+
+string(TOLOWER ${DEBUG_TOOLSET} DEBUG_SERVER_TYPE)
+
+# Specify the template for the c_cpp_properties.json file
+write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
+"{
+    \"version\":\"0.2.0\",
+    \"configurations\":[
+    {
+       \"name\":\"${DEBUG_TOOLSET}\",
+       \"type\":\"cortex-debug\",
+       \"request\":\"launch\",
+       \"servertype\":\"${DEBUG_SERVER_TYPE}\",
+       \"cwd\":\"\",
+       \"executable\":\"${EXECUTABLE_OUTPUT_PATH}/${EXECUTABLE_NAME}.elf\",
+       \"device\":\"${MCU_TARGET}\",
+        \"interface\": \"${DEBUG_INTERFACE}\",
+       \"v1\":false,
+       \"serverArgs\":[
+           \"--nogui\"
+       ],"
+)
+
+if(${ENABLE_SEGGER_RTT} AND (${DEBUG_SERVER_TYPE} STREQUAL "jlink"))
+
+write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
+"       \"rttConfig\":{
+            \"enabled\":true,
+            \"address\":\"auto\",
+            \"decoders\":[{
+            \"port\":0,
+            \"type\":\"console\"
+            }]
+        }
+    }]
+}" APPEND)
+
+else()
+
+write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json
+"   }]
+}" APPEND)
+
+endif()

cmake/vscode_intellisense.cmake

@@ -0,0 +1,53 @@
+# Make sure to create the .vscode directory if it doesn't exist
+file(MAKE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/.vscode)
+
+get_target_property(LINKED_LIBRARIES ${EXECUTABLE_NAME} LINK_LIBRARIES)
+
+if(LINKED_LIBRARIES)
+    foreach(lib ${LINKED_LIBRARIES})
+        get_target_property(LIBRARIES_INCLUDE_DIRS ${lib} INCLUDE_DIRECTORIES)
+        if(LIBRARIES_INCLUDE_DIRS)
+            set(INTELLISENSE_INCLUDES ${INTELLISENSE_INCLUDES} ${LIBRARIES_INCLUDE_DIRS})
+        endif()
+    endforeach()
+
+    foreach(lib ${LINKED_LIBRARIES})
+        get_target_property(INTF_LIBRARIES_INCLUDE_DIRS ${lib} INTERFACE_INCLUDE_DIRECTORIES)
+        if(INTF_LIBRARIES_INCLUDE_DIRS)
+            set(INTELLISENSE_INCLUDES ${INTELLISENSE_INCLUDES} ${INTF_LIBRARIES_INCLUDE_DIRS})
+        endif()
+    endforeach()
+endif()
+
+get_target_property(APP_INCLUDE_DIRS ${EXECUTABLE_NAME} INCLUDE_DIRECTORIES)
+
+if(APP_INCLUDE_DIRS)
+    set(INTELLISENSE_INCLUDES ${INTELLISENSE_INCLUDES} ${APP_INCLUDE_DIRS})
+endif()
+
+# Generate the list of include directories as a JSON array
+set(INCLUDE_DIRS_JSON "")
+foreach(INCLUDE_DIR ${INTELLISENSE_INCLUDES})
+    list(APPEND INCLUDE_DIRS_JSON "\"${INCLUDE_DIR}\"")
+endforeach()
+string(JOIN ",\n" INCLUDE_DIRS_JSON ${INCLUDE_DIRS_JSON})
+
+# Specify the template for the c_cpp_properties.json file
+write_file(${CMAKE_CURRENT_SOURCE_DIR}/.vscode/c_cpp_properties.json
+"{
+    \"configurations\": [
+        {
+            \"name\": \"${CMAKE_BUILD_TYPE}\",
+            \"includePath\": [
+                ${INCLUDE_DIRS_JSON}
+            ],
+            \"compileCommands\": \"\$\{workspaceFolder\}/build/compile_command.json\",
+            \"defines\": [\"\"],
+            \"compilerPath\": \"${CMAKE_C_COMPILER}\",
+            \"cStandard\": \"c99\",
+            \"cppStandard\": \"c++17\",
+            \"intelliSenseMode\": \"gcc-arm\"
+        }
+    ],
+    \"version\": 1
+}")