setDirective

Class: target.BuildTool
Namespace: target

Set directive values

Since R2023a

Syntax

myBuildTool.setDirective(directiveName,directiveValue)
myBuildTool.setDirective(pairedDirectiveName,startValue,endValue)


Description

myBuildTool.setDirective(directiveName,directiveValue) sets the named directive to the specified value.

myBuildTool.setDirective(pairedDirectiveName,startValue,endValue) sets the start and end values of the named directive.

If the Directives property does not contain the directive, the method appends a new object of the appropriate subclass of target.BaseDirective.

If the directive name is not supported by the build tool type specified by the target.BuildToolType object, the method produces an error.

Input Arguments

directiveName — Directive name

character vector | string

Name of directive. This table provides a list of supported directives.

Build Tool Type	Directive Name (Command-Line Flag)	Optional or Required	Directive Purpose	Example Value
'Assembler'	'Debug'	Required	Generate debugging information.	'-g'
	'IncludeSearchPath'	Required	Prefix header file include path specification.	'-I'
	'OutputFlag'	Required	Prefix name of tool output (object file).	'-o'
	'PreprocessorDefine'	Required	Prefix preprocessor macro definitions.	'-D'
	'GenerateDependencyFiles'	Optional	Generate file that describes header file dependencies.	'-MMD'
'C Compiler' or 'C++ Compiler'	'CompileFlag'	Required	Compile source file to produce object file.	'-c'
	'Debug'	Required	Generate debugging information.	'-g'
	'DisableOptimization'	Required	Disable compiler optimizations.	'-O0'
	'EnableOptimization'	Required	Enable compiler optimizations.	'-O3'
	'IncludeSearchPath'	Required	Prefix header file include path specification.	'-I'
	'OutputFlag'	Required	Prefix name of tool output (object file).	'-o'
	'PreprocessFile'	Required	Output preprocessed source instead of completing compilation.	'-E'
	'PreprocessorDefine'	Required	Prefix preprocessor macro definitions.	'-D'
	'CommandFile'	Optional	Specify command, subcommand, or response file to circumvent command interpreter line length limitations.	'@'
	'GenerateDependencyFiles'	Optional	Generate file describing header file dependencies.	'-MMD'
	'Preinclude'	Optional	Prefix name of header file to include (as if source code is included using #include).	'-include'
	'PreprocessorUndefine'	Optional	Prefix undefinition of a previously defined preprocessor macro.	'-U'
'Archiver'	'Debug'	Required	Generate debugging information.	''
	'LibrarySearchPath'	Required	Prefix library search path specification.	'-L'
	'OutputFlag'	Required	Prefix name of tool output (static library).	'-o '
	'CommandFile'	Optional	Specify command, subcommand, or response file to circumvent command interpreter line length limitations.	'@'
	'Input'	Optional	Prefix name of input object files.	'-input=file.obj'
'Linker' or 'C++ Linker'	'Debug'	Required	Generate debugging information.	'-g'
	'Library'	Required	Prefix “system library”.	'-l'
	'LibrarySearchPath'	Required	Prefix library search path specification.	'-L'
	'OutputFlag'	Required	Prefix name of tool output (executable file or shared library).	'-o'
	'CommandFile'	Optional	Specify command, subcommand, or response file to circumvent command interpreter line length limitations.	'@'
	'DefFile'	Optional	Prefix name of module definition file containing information about symbols export (for shared library generation).	'-def:'
	'Input'	Optional	Prefix name of input object files when using a command, subcommand, or response file.	'-input=file.obj'
	'LibraryGroup'	Optional	Encapsulate group of input libraries or object files to indicate multiple linker passes to resolve circular or out-of-order dependencies.	'-Wl,--start-group | -Wl,--end-group'
	'LibraryLinkObj'	Optional	Prefix name of input library files.	'-library=file.lib'
	'LibrarySearchPathRuntime'	Optional	Prefix run-time library search path specification.	'-rpath'
	'Shared'	Optional	Indicate that shared library (instead of standalone executable file) must be generated.	'-shared -Wl,--no-undefined'
'Make Tool'	'File'	Required	Prefix name of make file to process.	'-f'

Example: cCompiler.setDirective('CommandFile', '@');

directiveValue — Directive value

character vector | string

New value for named directive.

Example: cCompiler.setDirective('CommandFile', '@');

pairedDirectiveName — Paired directive name

character vector | string

Name of directive that contains a pair of command-line flags.

Example: cLinker.setDirective('LibraryGroup', '-Wl,--start-group', '-Wl,--end-group');

startValue — Start value

character vector | string

New start value for paired directive.

Example: cLinker.setDirective('LibraryGroup', '-Wl,--start-group', '-Wl,--end-group');

endValue — End value

character vector | string

New end value for paired directive.

Example: cLinker.setDirective('LibraryGroup', '-Wl,--start-group', '-Wl,--end-group');

Examples

Use setDirective to Specify Compiler Command Files

This code snippet shows how you can use the setDirective method to state that the C compiler uses the @ symbol as the prefix to specify a command, subcommand, or response file (to circumvent command interpreter line length limitations).

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

Version History

Introduced in R2023a