coder.make.ToolchainInfo - Represent custom toolchain - MATLAB (original) (raw)

Namespace: coder.make

Represent custom toolchain

Description

Use coder.make.ToolchainInfo to define and register a new set of software build tools (toolchain) with MathWorks® code generation products.

To get toolchain information about defined toolchains, use coder.make.getDefaultToolchain and coder.make.getToolchainInfoFromRegistry.

A coder.make.ToolchainInfo object contains:

coder.make.BuildTool objects that can describe each build tool
coder.make.BuildConfiguration objects that can apply sets of options to the build tools

Creation

[h](#ref%5Fq28e96aob%5Fsep%5Fshared-h) = coder.make.ToolchainInfo creates a defaultToolchainInfo object and assigns it to a handle, h.

The default ToolchainInfo object includes BuildTool objects and configurations for C, C++, and gmake:

The default value of SupportedLanguages,C/C++, adds BuildTool and BuildConfiguration objects for C and C++ compilers to ToolchainInfo.
The default value of BuildArtifact,gmake, adds a BuildTool object for gmake to ToolchainInfo.BuilderApplication.

You can use the input arguments (name-value pairs) to override these defaults when you create the ToolchainInfo object. Each property is optional. Each property requires a corresponding value. This example overrides the SupportedLanguages or BuildArtifact defaults.

[h](#ref%5Fq28e96aob%5Fsep%5Fshared-h) = coder.make.ToolchainInfo('[SupportedLanguages](#ref%5Fq28e96aob-SupportedLanguages)',[vLanguages](#ref%5Fq28e96aob-vLanguages),'[BuildArtifact](#ref%5Fq28e96aob-BuildArtifact)',[vArtifact](#ref%5Fq28e96aob-vArtifact))

The default property values for SupportedLanguages orBuildArtifact can be overridden only during the creation of the toolchain information object. These properties are read-only after object creation.

Input Arguments

expand all

The property name. For more information, see the Properties description for BuildArtifact.

Values for the BuildArtifact property, specified as a character vector.

The property name. For more information, see the Properties description for Name.

Unique name for the toolchain definition, specified as a character vector. The default value is empty.

The property name. For more information, see the Properties description for Platform.

The supported platform, specified as a character vector. The default value is the current platform.

The property name. For more information, see the Properties description for Revision.

Revision number for ToolchainInfo, specified as a character vector.

The property name. For more information, see the Properties description for SupportedLanguages.

Supported language or languages, specified as a character vector.

The property name. For more information, see the Properties description for SupportedVersion.

Version of software build tools that ToolchainInfo supports, specified as a character vector. The default value is empty

Output Arguments

expand all

A coder.make.ToolchainInfo object, specified using an object handle, such as h. To create h, enter h = coder.make.ToolchainInfo in a MATLAB® Command Window.

Properties

expand all

Custom attributes of the toolchain

Add custom attributes required by the toolchain and specify their default values.

By default, the list of custom attributes is empty.

Attributes returns a coder.make.util.UnorderedList.

For example, the intel_tc.m file from Add Custom Toolchains to MATLAB® Coder™ Build Process, defines the following custom attributes:

tc.addAttribute('TransformPathsWithSpaces'); tc.addAttribute('RequiresCommandFile'); tc.addAttribute('RequiresBatchFile');

To display the Attributes list from that example in a MATLAB Command Window, enter:

h = intel_tc; h.Attributes

ans =

-------------------

"Attributes" List

-------------------

RequiresBatchFile = true RequiresCommandFile = true TransformPathsWithSpaces = true

Use the following methods with Attributes:

Attributes:

GetAccess	public
SetAccess	public

Methods

Version History

Introduced in R2013a