intellisense

Documentation

Index

• func ProcessCCppPropertiesJson(r CCppPropertiesReplacements) error
• func ProcessLaunchJson(r LaunchReplacements) error
• func ProcessSettingsJson(r SettingsReplacements) error
• func ProcessTasksJson() error
• type CCppPropertiesReplacements
• type ConfigurationEntry
• type LaunchReplacements
• type SettingsReplacements

Functions

func ProcessCCppPropertiesJson

func ProcessCCppPropertiesJson(r CCppPropertiesReplacements) error

ProcessCCppPropertiesJson processes 'c_cpp_properties.json' so that it contains values required for VSCode intellisense. If the file doesn't exist, it will be created from the 'c_cpp_properties.persistent.json'.

func ProcessLaunchJson

func ProcessLaunchJson(r LaunchReplacements) error

ProcessLaunchJson processes 'launch.json' so that it contains values required for VSCode intellisense. If the file doesn't exist, it will be created from 'launch.persistent.json'.

func ProcessSettingsJson

func ProcessSettingsJson(r SettingsReplacements) error

ProcessSettingsJson processes 'settings.json' so that it contains values required for VSCode intellisense. If the file doesn't exist, it will be created from 'settings.persistent.json'.

func ProcessTasksJson

func ProcessTasksJson() error

ProcessTasksJson processes 'tasks.json' so that it contains values required for VSCode intellisense. If the file doesn't exist, it will be created from 'tasks.persistent.json'.

Types

type CCppPropertiesReplacements

type CCppPropertiesReplacements struct {
	IncludePath  []string `json:"includePath"`
	Defines      []string `json:"defines"`
	CompilerPath string   `json:"compilerPath"`
}

CCppPropertiesReplacements are JSON entries for 'c_cpp_properties.json' that are generated automatically based on the project configuration.

type ConfigurationEntry

type ConfigurationEntry struct {
	// C is a configuration entry
	C     map[string]any
	Index int
}

ConfigurationEntry is an auxiliary type that stores Configuration taken from JSON file as a map, and its index in the 'configurations' array.

type LaunchReplacements

type LaunchReplacements struct {
	Executable  string   `json:"executable"`
	ConfigFiles []string `json:"configFiles"`
	SvdFile     string   `json:"svdFile"`
}

LaunchReplacements are JSON entries for 'launch.json' that are generated automatically based on the project configuration.

type SettingsReplacements

type SettingsReplacements struct {
	IncludePaths                []string `json:"C_Cpp_Runner.includePaths"`
	CCompilerPath               string   `json:"C_Cpp_Runner.cCompilerPath"`
	CppCompilerPath             string   `json:"C_Cpp_Runner.cppCompilerPath"`
	DebuggerPath                string   `json:"C_Cpp_Runner.debuggerPath"`
	CortexDebugArmToolchainPath string   `json:"cortex-debug.armToolchainPath"`
	CortexDebugOpenocdPath      string   `json:"cortex-debug.openocdPath"`
	CortexDebugGdbPath          string   `json:"cortex-debug.gdbPath"`
}

SettingsReplacements are JSON entries for 'settings.json' that are generated automatically based on the project configuration.