dhgdh

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by joey shelton

Embed: (wiki syntax)

« Back to documentation index

Exporter Class Reference

Exporter Class Reference

Inherited by GccArm, IAREmbeddedWorkbench, Uvision4, and Uvision5.

Public Member Functions

def __init__
def get_toolchain
def flags
def get_source_paths
def progen_get_project_data
def progen_gen_file
def progen_build
def check_supported
def gen_file

Detailed Description

Exporter base class

This class is meant to be extended by individual exporters, and provides a
few helper methods for implementing an exporter with either jinja2 or
progen.

Definition at line 41 of file exporters.py.


Constructor & Destructor Documentation

def __init__ (   self,
  target,
  export_dir,
  project_name,
  toolchain,
  extra_symbols = None,
  resources = None 
)
Initialize an instance of class exporter
Positional arguments:
target        - the target mcu/board for this project
export_dir    - the directory of the exported project files
project_name  - the name of the project
toolchain     - an instance of class toolchain

Keyword arguments:
extra_symbols - a list of extra macros for the toolchain
resources     - an instance of class Resources

Definition at line 54 of file exporters.py.


Member Function Documentation

def check_supported (   self,
  ide 
)
Indicated if this combination of IDE and MCU is supported

Definition at line 197 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

Definition at line 82 of file exporters.py.

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

Definition at line 207 of file exporters.py.

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

Definition at line 107 of file exporters.py.

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

Reimplemented in Uvision4, and Uvision5.

Definition at line 77 of file exporters.py.

def progen_build (   self )
Build a project that was already generated by progen

Definition at line 187 of file exporters.py.

def progen_gen_file (   self,
  project_data 
)
Generate project using ProGen Project API
Positional arguments:
tool_name    - the tool for which to generate project files
project_data - a dict whose base key, values are specified in
       progen_get_project_data, the items will have been
       modified by Exporter subclasses

Keyword arguments:
progen_build - A boolean that determines if the tool will build the
       project

Definition at line 164 of file exporters.py.

def progen_get_project_data (   self )
Get ProGen project data  

Definition at line 116 of file exporters.py.