add vs code launch.json auto generation in waf configure

This commit is contained in:
Huibean 2024-12-16 22:22:13 +08:00 committed by Huibean Luo
parent aec7cc24d1
commit d217a06e3d
3 changed files with 257 additions and 0 deletions

31
.vscode/launch_profile.default.json vendored Normal file
View File

@ -0,0 +1,31 @@
{
"sitl": {
"args": [
"-S",
"--model",
"flightaxis:127.0.0.1",
"--speedup",
"1",
"--slave",
"0",
"--sim-address=127.0.0.1",
"-IO"
],
"postRemoteConnectCommands": [
{
"description": "Set breakpoint at AP_HAL::panic",
"text": "-break-insert AP_HAL::panic",
"ignoreFailures": false
}
],
"variables": {
"CRASH_DUMP": "crash_dump.bin"
}
},
"hardware": {
"variables": {
"CRASH_DUMP": "crash_dump.bin"
},
"miDebuggerArgs": "-nx -ex \"set target-charset ASCII\" -ex \"target remote | ${workspaceFolder}/modules/CrashDebug/bins/lin64/CrashDebug --elf ${workspaceFolder}/${ELF_FILE} --dump ${workspaceFolder}/${CRASH_DUMP}\""
}
}

View File

@ -0,0 +1,209 @@
import os
import json
VS_LAUNCH_DEFAULT_TEMPLATE = {
"version": "0.2.0",
"configurations": []
}
SITL_DEFAULT_ARGS = [
"-S",
"--model",
"+",
"--speedup",
"1",
"--slave",
"0",
"--sim-address=127.0.0.1",
"-IO"
]
H7_DUAL_BANK_LIST = [
"STM32H7A3xx",
"STM32H7A3xxq",
"STM32H7B3xx",
"STM32H7B3xxq",
"STM32H742xx",
"STM32H743xx",
"STM32H745xg",
"STM32H745xx",
"STM32H747xg",
"STM32H747xx",
"STM32H753xx",
"STM32H755xx",
"STM32H755xx",
"STM32H757xx",
] # List of H7 boards with dual bank
CONIFIGURATIONTS = [
{'name': 'ArduCopter', 'target': 'arducopter'},
{'name': 'ArduPlane', 'target': 'arduplane'},
{'name': 'ArduCopter-Heli', 'target': 'arducopter-heli'},
{'name': 'ArduRover', 'target': 'ardurover'},
{'name': 'ArduSub', 'target': 'ardusub'},
{'name': 'AP_Periph', 'target': 'AP_Periph'},
{'name': 'AP_Blimp', 'target': 'blimp'},
{'name': 'AntennaTracker', 'target': 'antennatracker'},
{'name': 'AP_Bootloader', 'target': 'ap_bootloader'},
] #pending to add more targets
def merge_dicts(dict1, dict2):
"""
Recursively merges dict2 into dict1.
"""
for key, value in dict2.items():
if key in dict1 and isinstance(dict1[key], dict) and isinstance(value, dict):
merge_dicts(dict1[key], value)
else:
dict1[key] = value
return dict1
def _load_vscode_launch_profile_json(file_path):
if os.path.exists(file_path):
try:
with open(file_path, 'r') as f:
content = f.read().strip()
if content:
launch_profile_json = json.loads(content)
else:
launch_profile_json = {}
return launch_profile_json
except json.JSONDecodeError:
print(f"\033[91mError: Invalid JSON in {file_path}. \033[0m")
return {}
else:
return {}
def _load_vscode_launch_json(file_path):
if os.path.exists(file_path):
try:
with open(file_path, 'r') as f:
content = f.read().strip()
if content:
launch_json = json.loads(content)
else:
launch_json = VS_LAUNCH_DEFAULT_TEMPLATE
if "configurations" not in launch_json:
launch_json["configurations"] = [] #initialize configurations
if type(launch_json["configurations"]) is not list:
launch_json["configurations"] = [] #overwrite invalid configurations
except json.JSONDecodeError:
print(f"\033[91mError: Invalid JSON in {file_path}. Creating a new launch.json file.\033[0m")
launch_json = VS_LAUNCH_DEFAULT_TEMPLATE
else:
launch_json = VS_LAUNCH_DEFAULT_TEMPLATE
return launch_json
def _create_vscode_launch_json(cfg):
launch_json_path = os.path.join(cfg.srcnode.abspath(), '.vscode', 'launch.json')
launch_profile_json_path = os.path.join(cfg.srcnode.abspath(), '.vscode', 'launch_profile.json')
launch_json = _load_vscode_launch_json(launch_json_path)
launch_profile = _load_vscode_launch_profile_json(launch_profile_json_path)
configurations = [
{'name': 'ArduCopter', 'target': 'arducopter'},
{'name': 'ArduPlane', 'target': 'arduplane'},
{'name': 'ArduCopter-Heli', 'target': 'arducopter-heli'},
{'name': 'ArduRover', 'target': 'ardurover'},
{'name': 'ArduSub', 'target': 'ardusub'},
{'name': 'AP_Periph', 'target': 'AP_Periph'},
{'name': 'AP_Blimp', 'target': 'blimp'},
{'name': 'AntennaTracker', 'target': 'antennatracker'},
{'name': 'AP_Bootloader', 'target': 'ap_bootloader'},
] #pending to add more targets
for configuration in CONIFIGURATIONTS:
if cfg.options.board == 'sitl':
if configuration['name'] == 'AP_Bootloader':
continue
if os.uname().sysname == 'Darwin':
MIMode = "lldb"
else:
MIMode = "gdb"
launch_configuration = {
"name": configuration['name'],
"type": "cppdbg",
"request": "launch",
"program": "${workspaceFolder}/build/sitl/bin/" + configuration['target'],
"args": SITL_DEFAULT_ARGS,
"stopAtEntry": False,
"cwd": "${workspaceFolder}",
"environment": [],
"externalConsole": False,
"MIMode": MIMode,
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": False
}
],
}
if launch_profile.get('sitl'):
merge_dicts(launch_configuration, launch_profile.get('sitl'))
else:
if configuration['name'] == 'AP_Bootloader':
executable_path = "${workspaceFolder}/build/"+ cfg.options.board + "/bootloader/AP_Bootloader"
else:
executable_path = "${workspaceFolder}/build/"+ cfg.options.board + "/bin/" + configuration['target']
launch_configuration = {
"name": configuration['name'],
"cwd": "${workspaceFolder}",
"executable": executable_path,
"variables": {
"ELF_FILE": executable_path,
},
"liveWatch": {
"enabled": True,
"samplesPerSecond": 4
},
"request": "launch",
"type": "cortex-debug",
"servertype": "openocd",
"configFiles": [
"${workspaceFolder}/build/" + cfg.options.board + "/openocd.cfg",
]
}
if launch_profile.get('hardware'):
merge_dicts(launch_configuration, launch_profile.get('hardware'))
configuration_overwrited = False
for index, current_configuration in enumerate(launch_json["configurations"]):
if current_configuration.get('name') == launch_configuration['name']:
launch_json["configurations"][index] = launch_configuration
configuration_overwrited = True
break
if not configuration_overwrited:
launch_json["configurations"].append(launch_configuration)
with open(launch_json_path, 'w') as f:
json.dump(launch_json, f, indent=4)
#create openocd.cfg file
if cfg.options.board != 'sitl':
openocd_cfg_path = os.path.join(cfg.srcnode.abspath(), 'build', cfg.options.board, 'openocd.cfg')
mcu_type = cfg.env.get_flat('APJ_BOARD_TYPE')
openocd_target = ''
if mcu_type.startswith("STM32H7"):
if mcu_type in H7_DUAL_BANK_LIST:
openocd_target = 'stm32h7_dual_bank.cfg'
else:
openocd_target = 'stm32h7x.cfg'
elif mcu_type.startswith("STM32F7"):
openocd_target = 'stm32f7x.cfg'
elif mcu_type.startswith("STM32F4"):
openocd_target = 'stm32f4x.cfg'
elif mcu_type.startswith("STM32F3"):
openocd_target = 'stm32f3x.cfg'
elif mcu_type.startswith("STM32L4"):
openocd_target = 'stm32l4x.cfg'
elif mcu_type.startswith("STM32G4"):
openocd_target = 'stm32g4x.cfg'
with open(openocd_cfg_path, 'w+') as f:
f.write("source [find interface/stlink.cfg]\n")
f.write(f"source [find target/{openocd_target}]\n")
f.write("init\n")
f.write("$_TARGETNAME configure -rtos auto\n")

17
wscript
View File

@ -155,6 +155,11 @@ def options(opt):
action='store_true', action='store_true',
default=False, default=False,
help='Add debug symbolds to build.') help='Add debug symbolds to build.')
g.add_option('--vs-launch',
action='store_true',
default=False,
help='Generate launch.json template for Visual Studio Code.')
g.add_option('--disable-watchdog', g.add_option('--disable-watchdog',
action='store_true', action='store_true',
@ -502,6 +507,7 @@ def configure(cfg):
cfg.env.BOARD = cfg.options.board cfg.env.BOARD = cfg.options.board
cfg.env.DEBUG = cfg.options.debug cfg.env.DEBUG = cfg.options.debug
cfg.env.VS_LAUNCH = cfg.options.vs_launch
cfg.env.DEBUG_SYMBOLS = cfg.options.debug_symbols cfg.env.DEBUG_SYMBOLS = cfg.options.debug_symbols
cfg.env.COVERAGE = cfg.options.coverage cfg.env.COVERAGE = cfg.options.coverage
cfg.env.FORCE32BIT = cfg.options.force_32bit cfg.env.FORCE32BIT = cfg.options.force_32bit
@ -607,6 +613,13 @@ def configure(cfg):
else: else:
cfg.end_msg('disabled', color='YELLOW') cfg.end_msg('disabled', color='YELLOW')
if cfg.env.DEBUG:
cfg.start_msg('VS Code launch')
if cfg.env.VS_LAUNCH:
cfg.end_msg('enabled')
else:
cfg.end_msg('disabled', color='YELLOW')
cfg.start_msg('Coverage build') cfg.start_msg('Coverage build')
if cfg.env.COVERAGE: if cfg.env.COVERAGE:
cfg.end_msg('enabled') cfg.end_msg('enabled')
@ -652,6 +665,10 @@ def configure(cfg):
cfg.remove_target_list() cfg.remove_target_list()
_collect_autoconfig_files(cfg) _collect_autoconfig_files(cfg)
if cfg.env.VS_LAUNCH:
import vscode_helper
vscode_helper._create_vscode_launch_json(cfg)
def collect_dirs_to_recurse(bld, globs, **kw): def collect_dirs_to_recurse(bld, globs, **kw):
dirs = [] dirs = []
globs = Utils.to_list(globs) globs = Utils.to_list(globs)