Embed: (wiki syntax)

« Back to documentation index

VSCode Class Reference

VSCode Class Reference

Inherits tools::export::makefile::Makefile.

Inherited by VSCodeArmc5, VSCodeGcc, and VSCodeIAR.

Public Member Functions

def generate
def clean
def is_target_supported
def format_flags
def build
def get_toolchain
def add_config
def flags
def get_source_paths
def gen_file_dest
def gen_file
def gen_file_nonoverwrite
def make_key
def group_project_files
def filter_dot

Detailed Description

Generic VSCode project. Intended to be subclassed by classes that
specify a type of Makefile.

Definition at line 25 of file export/vscode/__init__.py.


Member Function Documentation

def add_config (   self ) [inherited]
Add the containgin directory of mbed_config.h to include dirs

Definition at line 88 of file exporters.py.

def build (   project_name,
  log_name = "build_log.txt",
  cleanup = True 
) [inherited]
Build Make project 

Reimplemented from Exporter.

Definition at line 168 of file export/makefile/__init__.py.

def clean (   project_name )
Clean a previously exported project
This method is assumed to be executed at the same level as exporter
project files and project source code.
See uvision/__init__.py, iar/__init__.py, and makefile/__init__.py for
example implemenation.

Positional Arguments:
project_name - the name of the project to build; often required by
exporter's build command.

Returns nothing. May raise exceptions

Reimplemented from Makefile.

Definition at line 90 of file export/vscode/__init__.py.

def filter_dot (   str ) [inherited]
Remove the './' or '.\\' prefix, if present.

Definition at line 263 of file exporters.py.

def flags (   self ) [inherited]
Returns a dictionary of toolchain flags.
Keys of the dictionary are:
cxx_flags    - c++ flags
c_flags      - c flags
ld_flags     - linker flags
asm_flags    - assembler flags
common_flags - common options

Reimplemented in CCES.

Definition at line 97 of file exporters.py.

def format_flags (   self ) [inherited]
Format toolchain flags for Makefile

Definition at line 147 of file export/makefile/__init__.py.

def gen_file (   self,
  template_file,
  data,
  target_file,
  kwargs 
) [inherited]
Generates a project file from a template using jinja

Definition at line 138 of file exporters.py.

def gen_file_dest (   self,
  target_file 
) [inherited]
Generate the project file location in an exported project

Definition at line 134 of file exporters.py.

def gen_file_nonoverwrite (   self,
  template_file,
  data,
  target_file,
  kwargs 
) [inherited]
Generates a project file from a template using jinja

Definition at line 146 of file exporters.py.

def generate (   self )
Generate Makefile and VSCode launch and task files

Reimplemented from Makefile.

Definition at line 29 of file export/vscode/__init__.py.

def get_source_paths (   self ) [inherited]
Returns a list of the directories where source files are contained

Definition at line 125 of file exporters.py.

def get_toolchain (   self ) [inherited]
A helper getter function that we should probably eliminate

Definition at line 84 of file exporters.py.

def group_project_files (   self,
  sources 
) [inherited]
Group the source files by their encompassing directory
Positional Arguments:
sources - array of source locations

Returns a dictionary of {group name: list of source locations}

Definition at line 191 of file exporters.py.

def is_target_supported (   cls,
  target_name 
) [inherited]
Query support for a particular target

NOTE: override this method if your exporter does not provide a static list of targets

Positional Arguments:
target_name - the name of the target.

Reimplemented from Exporter.

Definition at line 51 of file export/makefile/__init__.py.

def make_key (   self,
  src 
) [inherited]
From a source file, extract group name
Positional Arguments:
src - the src's location

Definition at line 177 of file exporters.py.