target.BuildTool Class

Namespace: target

Describe build tool

Since R2023a

Description

Use a target.BuildTool object to describe a build tool. For example, a compiler, linker, or archiver.

To create a target.BuildTool object, use the target.create function. Create the object in a single step.

buildToolObject = target.create('BuildTool', ...
                                nameOfBuildToolType, ...
                                buildToolCommandString, ...
                                propertyXName, propertyXValue, ...
                                propertyYName, propertyYValue, ...
                                propertyZName, propertyZValue)

nameOfBuildToolType is the name of the target.BuildToolType object that you want to specify for the BuildToolType property of buildToolObject. For example 'C Compiler'.

buildToolCommandString is the build tool command, which includes required arguments and flags. For example 'gcc'.

Properties

Id — Object identifier

string

Unique ID of object in internal database.

Attributes:

GetAccess	public
SetAccess	private

Name — Build tool name

string

Name of build tool.

Attributes:

GetAccess	public
SetAccess	public

SupportedHardware — Target hardware

target.HardwareComponentSupport object array

Target hardware for the build tool.

Attributes:

GetAccess	public
SetAccess	public

HostOperatingSystemSupport — Operating systems support

target.HostOperatingSystemSupport object

Development computer operating systems supported by the build tool.

Attributes:

GetAccess	public
SetAccess	public

Command — Build tool command

target.Command object

Command that invokes the build tool, which includes standard arguments that the command uses.

Attributes:

GetAccess	public
SetAccess	public

BuildToolType — Build tool type

target.BuildToolType

Type or role of the tool in the toolchain. For example, C Compiler, Assembler, or Linker.

Attributes:

GetAccess	public
SetAccess	public

FileExtensions — File extensions

target.FileExtensionSet object array

The file extensions for each type of input and output file that the tool processes.

Attributes:

GetAccess	public
SetAccess	public

Directives — Tool directives

target.BaseDirective object array

Directives (command-line flags) for the tool.

Attributes:

GetAccess	public
SetAccess	public

FileSep — File separator

string

Preferred file separator for the tool.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

getDirective	Search for directive
getFileExtensionSet	Search for file type
setDirective	Set directive values
setFileExtensions	Set file extensions
showDirectives	Print directives to screen
showFileExtensions	Print file extensions to screen

Examples

Use target.BuildTool to Specify C Compiler

This code snippet shows how you can use a target.BuildTool object to specify a C compiler that uses command files and generates object files with the .obj extension.

cCompiler = target.create('BuildTool', 'C Compiler', 'gcc', ...
    'Name', 'MinGW GCC C Compiler');
cCompiler.setDirective('CommandFile', '@');
cCompiler.setFileExtensions('Object', {'.obj'});

Version History

Introduced in R2023a