BA / Mbed OS BaBoRo1
Embed: (wiki syntax)

« Back to documentation index

CCES Class Reference

CCES Class Reference

Inherits tools::export::exporters::Exporter.

Public Member Functions

def is_target_supported
def flags
def format_path
def format_inc_path
def format_src_path
def clean_flags
def parse_flags
def convert_common_options
def convert_assembler_options
def convert_compiler_options
def convert_linker_options
def get_cces_path
def get_project_create_command
def get_project_build_command
def generate
def clean
def build
def get_toolchain
def add_config
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

mbed exporter for Analog Devices' CrossCore Embedded Studio(TM)

Definition at line 41 of file export/cces/__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 
)
Build the generated CCES project using headless builder.

Reimplemented from Exporter.

Definition at line 418 of file export/cces/__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 Exporter.

Definition at line 413 of file export/cces/__init__.py.

def clean_flags (   container,
  flags 
)
Some flags are handled by CCES already, so there's no need
to include them twice.

Definition at line 111 of file export/cces/__init__.py.

def convert_assembler_options (   flags )
Converts the assembler flags into CCES options and removes them
from the flags list

Definition at line 154 of file export/cces/__init__.py.

def convert_common_options (   prefix,
  options,
  flags 
)
Converts the common flags into CCES options and removes them
from the flags list

Definition at line 134 of file export/cces/__init__.py.

def convert_compiler_options (   flags )
Converts the compiler flags into CCES options and removes them
from the flags list

Definition at line 176 of file export/cces/__init__.py.

def convert_linker_options (   flags )
Converts the linker flags into CCES options and removes them
from the flags list

Definition at line 222 of file export/cces/__init__.py.

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

Definition at line 263 of file exporters.py.

def flags (   self )
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

Skip macros because headless tools handles them separately

Reimplemented from Exporter.

Definition at line 61 of file export/cces/__init__.py.

def format_inc_path (   path )
Formats the given include path relative to the project directory

Definition at line 97 of file export/cces/__init__.py.

def format_path (   path,
  prefix 
)
Formats the given source path relative to the project directory
using the prefix

Definition at line 86 of file export/cces/__init__.py.

def format_src_path (   path )
Formats the given source path relative to the project directory

Definition at line 104 of file export/cces/__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 the CCES project files using headless builder.

Reimplemented from Exporter.

Definition at line 294 of file export/cces/__init__.py.

def get_cces_path (   root )
Returns the path to the CCES executable

Definition at line 240 of file export/cces/__init__.py.

def get_project_build_command (   cces_path,
  workspace,
  project_name 
)
Generate the headless tools build command string
with the given parameters

Definition at line 277 of file export/cces/__init__.py.

def get_project_create_command (   cces_path,
  workspace,
  project_name 
)
Generate the headless tools projectcreate command string
with the given parameters

Definition at line 259 of file export/cces/__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 
)
Query support for a particular target

Positional Arguments:
target_name - the name of the target.

Reimplemented from Exporter.

Definition at line 49 of file export/cces/__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.

def parse_flags (   flags,
  options,
  booleans 
)
Parse the values in `booleans`, insert them into the
`options` dictionary and remove them from `flags`

Definition at line 121 of file export/cces/__init__.py.