coder.make.BuildTool class

Пакет: coder.make

Представление инструмента сборки

Описание

Использование coder.make.BuildTool для получения и определения существующего coder.make.BuildTool по умолчанию объект, или создать coder.make.BuildTool объект.

Работа с BuildTool по умолчанию объекты, используйте get и задайте подход из ToolchainInfo свойства:

coder.make.ToolchainInfo.BuildTools
coder.make.ToolchainInfo.PostbuildTools

Примерами, показывающими подход get and define, являются:

Альтернативой подходу get and define является новый подход. Пример, показывающий создание нового подхода, появляется в Create a Non-Default BuildTool.

Рисунок показывает связь между BuildTool по умолчанию объекты и ToolchainInfo. Когда вы исследуете PHONY TARGETS раздел сгенерированного make-файла, различие между BuildTools, PostbuildTools, и PrebuildTools становится яснее.

prebuild - запускает только инструмент prebuild.
build - запускает инструменты сборки после запуска prebuild. The build генерирует PRODUCT сборки.
postbuild - запускает инструмент postbuild после запуска сборки.
all - работает предстрой, сборка и постстрой. Процесс сборки использует это правило для сборки Ctrl + B.
clean - очищает все выходы расширения файлов и производного файла расширения всех инструментов в наборе инструментальных средств.
info - развертывает и печатает все макросы, используемые в make-файле.

Конструкция

h = coder.make.BuildTool(bldtl_name) создает coder.make.BuildTool объект и устанавливает его Name свойство.

Входные параметры

расширить все

`bldtl_name` - Имя инструмента сборки
вектор символов | строковый скаляр

Создайте имя инструмента, заданное как вектор символов или строковый скаляр.

Типы данных: char | string

Выходные аргументы

расширить все

`h` - Указатель на объект
переменная

Указатель на объект для coder.make.BuildTool объект, заданный как переменная.

Пример: tool

Свойства

расширить все

`Command` - Создайте команду инструмента или командный макрос

Представляет команду инструмент с помощью:

Необязательное имя макроса, например: CC.
Системный вызов (команда), который запускает инструмент сборки, такой как: gcc.

Имя макроса и системный вызов появляются вместе в сгенерированном файле make-файла. Для примера: CC = gcc

Присвоение значения этому свойству опционально.

Можно использовать следующие методы с Command:

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`Directives` - Директивы, относящиеся к конкретным инструментам

Определяет любые директивы для конкретного инструмента, такие как -D для предпроцессора задает. Присвоение значения этому свойству опционально.

Можно использовать следующие методы с Directives:

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`FileExtensions` - Расширения файлов для конкретного инструмента

Задает любые расширения файлов для конкретного инструмента. Это значение опционально.

Можно использовать следующие методы с FileExtensions:

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`Name` - Имя инструмента сборки

Определяет имя инструмента сборки.

Можно использовать следующие методы с Name.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`Path` - пути для конкретного инструмента

Задает любые пути для конкретного инструмента. Если команда указана в системном пути, это значение опционально.

Можно использовать следующие методы с Path:

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`SupportedOutputs` - Форматы выхода для конкретного инструмента

Задает любые выходы для конкретного инструмента. Если инструмент поддерживает все доступные форматы, это значение опционально.

Значение по умолчанию {'*'}, что указывает на поддержку всех доступных форматов.

Тип данных - массив ячеек. Содержимое массива ячеек должно быть либо coder.make.BuildOutput значения перечисления, или '*'.

У этого свойства нет связанных методов. Присвойте значение непосредственно SupportedOutputs. Смотрите addPrebuildToolToToolchainInfo.m пример или addPostbuildToolToToolchainInfo.m пример. Допустимые значения перечисления:

`coder.make.BuildOutput.STATIC_LIBRARY`	применяется для инструментов предварительной сборки, инструментов сборки и инструментов пост-сборки
`coder.make.BuildOutput.SHARED_LIBRARY`	применяется для инструментов сборки и инструментов пост-сборки; требует Embedded Coder^® лицензия
`coder.make.BuildOutput.EXECUTABLE`	применяется для инструментов и инструментов пост-сборки сборки

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

Методы

addDirective	Добавьте директиву к `Directives`
addFileExtension	Добавьте новую запись расширения файла в `FileExtensions`
getCommand	Получите команду инструмент
getDirective	Получите значение именованной директивы от `Directives`
getFileExtension	Получите расширение файла для именованного типа в `FileExtensions`
getName	Получите имя инструмента сборки
getPath	Получите путь и макрос инструмента сборки в `Path`
информация	Отображение свойств и значений инструмента сборки
setCommand	Установите команду инструмент
setCommandPattern	Установите шаблон команд для инструментов сборки
setCompilerOptionMap	Установите стандарт языка C/C + + и опции компилятора для выбранного инструмента сборки (компилятора)
setDirective	Установите значение директивы в `Directives`
setFileExtension	Установите расширение файла для именованного типа файла в `FileExtensions`
setName	Установите имя инструмента сборки
setPath	Установите путь и макрос инструмента сборки в `Path`
утвердить	Проверьте свойства инструмента сборки

Копировать семантику

Указатель. Чтобы узнать, как классы handle влияют на операции копирования, см. раздел «Копирование объектов».

Пример

Получите инструмент сборки по умолчанию и установите его свойства
Создайте Non-Default BuildTool
Добавьте Prebuild и Инструментов пост-сборки к Toolchain

Получите инструмент сборки по умолчанию и установите его свойства

The intel_tc.m файл из Add Custom Toolchains в MATLAB ® Coder™ Build Process использует следующие линии, чтобы получить инструмент сборки по умолчанию, C Compiler, из ToolchainInfo объект называется tc, а затем устанавливает его свойства.

% ------------------------------
% C Compiler
% ------------------------------
 
tool = tc.getBuildTool('C Compiler');

tool.setName('Intel C Compiler');
tool.setCommand('icl');
tool.setPath('');

tool.setDirective('IncludeSearchPath','-I');
tool.setDirective('PreprocessorDefine','-D');
tool.setDirective('OutputFlag','-Fo');
tool.setDirective('Debug','-Zi');

tool.setFileExtension('Source','.c');
tool.setFileExtension('Header','.h');
tool.setFileExtension('Object','.obj');

tool.setCommandPattern('|>TOOL<| |>TOOL_OPTIONS<| |>OUTPUT_FLAG<||>OUTPUT<|');

Следующие примеры показывают тот же подход «получить и определить» более подробно:

Создайте Non-Default BuildTool

Чтобы создать инструмент сборки, выполните следующие действия.

Создайте файл, который задает BuildTool объект, например createBuildTool_1.m или createBuildTool_2.
Создайте такой файл, как addBuildToolToToolchainInfo.m, что:
- Создает ToolchainInfo объект, или использует существующий.
- Создает BuildTool объект из createBuildTool_1.m или createBuildTool_2.
- Добавляет BuildTool объект для ToolchainInfo объект.
Выполняйте addBuildToolToToolchainInfo.m.

См. следующие примеры addBuildToolToToolchainInfo.m, createBuildTool_1.m, и createBuildTool_2.m.

addBuildToolToToolchainInfo.m

createBuildTool_1.m

function buildToolObj = createBuildTool_1()

toolinfo.Name                       = 'My GNU C Compiler';
toolinfo.Language                   = 'C';

toolinfo.Command.Macro              = 'CC';
toolinfo.Command.Value              = 'gcc';

toolinfo.Path.Macro                 = 'CC_PATH';
toolinfo.Path.Value                 = '';

toolinfo.OptionsRegistry            = {'My C Compiler','MY_CFLAGS'};

% Key name of this directive
toolinfo.Directives(1).Key          = 'IncludeSearchPath';

% Macro of this directive (directives can have empty macros)
toolinfo.Directives(1).Macro        = '';                   

% Value of this directive
toolinfo.Directives(1).Value        = '-I';                 

toolinfo.Directives(2).Key          = 'PreprocessorDefine';
toolinfo.Directives(2).Macro        = '';
toolinfo.Directives(2).Value        = '-D';

toolinfo.Directives(3).Key          = 'Debug';
toolinfo.Directives(3).Macro        = 'CDEBUG';
toolinfo.Directives(3).Value        = '-g';

toolinfo.Directives(4).Key          = 'OutputFlag';
toolinfo.Directives(4).Macro        = 'C_OUTPUT_FLAG';
toolinfo.Directives(4).Value        = '-o';

% Key name of this file extension
toolinfo.FileExtensions(1).Key      = 'Source';  

% Macro of this file extension
toolinfo.FileExtensions(1).Macro    = 'C_EXT';   

% Value of this file extension
toolinfo.FileExtensions(1).Value    = '.c';      

toolinfo.FileExtensions(2).Key      = 'Header';
toolinfo.FileExtensions(2).Macro    = 'H_EXT';
toolinfo.FileExtensions(2).Value    = '.h';

toolinfo.FileExtensions(3).Key      = 'Object';
toolinfo.FileExtensions(3).Macro    = 'OBJ_EXT';
toolinfo.FileExtensions(3).Value    = '.obj';

toolinfo.DerivedFileExtensions      = {'$(OBJ_EXT)'};
% '*' means all outputs are supported
toolinfo.SupportedOutputs           = {'*'}; 


% put actual extension (e.g. '.c') or keyname if already registered
% under 'FileExtensions'
toolinfo.InputFileExtensions        = {'Source'}; 
toolinfo.OutputFileExtensions       = {'Object'}; 

% Create a build tool object and populate it with the above data
buildToolObj = createAndpopulateBuildTool(toolinfo);

function buildToolObj = createAndpopulateBuildTool(toolinfo)

% -------------------------
% Construct a BuildTool
% -------------------------
buildToolObj = coder.make.BuildTool();

% -------------------------
% Set general properties
% -------------------------
buildToolObj.Name              = toolinfo.Name;
buildToolObj.Language          = toolinfo.Language;
buildToolObj.Command           = coder.make.BuildItem ...
    (toolinfo.Command.Macro,toolinfo.Command.Value);
buildToolObj.Path              = coder.make.BuildItem ...
    (toolinfo.Path.Macro,toolinfo.Path.Value);
buildToolObj.OptionsRegistry   = toolinfo.OptionsRegistry;
buildToolObj.SupportedOutputs  = toolinfo.SupportedOutputs;

% -------------------------
% Directives
% -------------------------
for i = 1:numel(toolinfo.Directives)
    directiveBuildItem = coder.make.BuildItem(...
        toolinfo.Directives(i).Macro,toolinfo.Directives(i).Value);
    buildToolObj.addDirective(toolinfo.Directives(i).Key,directiveBuildItem);
end

% -------------------------
% File extensions
% -------------------------
for i = 1:numel(toolinfo.FileExtensions)
    fileExtBuildItem = coder.make.BuildItem(...
        toolinfo.FileExtensions(i).Macro,toolinfo.FileExtensions(i).Value);
    buildToolObj.addFileExtension(toolinfo.FileExtensions(i).Key,fileExtBuildItem);
end

% -------------------------
% Derived file extensions
% -------------------------
for i = 1:numel(toolinfo.DerivedFileExtensions)
    if buildToolObj.FileExtensions.isKey(toolinfo.DerivedFileExtensions{i})
        buildToolObj.DerivedFileExtensions{end+1} = ...
        ['$(' buildToolObj.getFileExtension
        (toolinfo.DerivedFileExtensions{i}) ')'];
    else
        buildToolObj.DerivedFileExtensions{end+1} = toolinfo.DerivedFileExtensions{i};
    end
end

% -------------------------
% Command pattern
% -------------------------
if isfield(toolinfo,'CommandPattern')
    buildToolObj.CommandPattern = toolinfo.CommandPattern;
end

% --------------------------------
% [Input/Output]FileExtensions
% --------------------------------
if isfield(toolinfo,'InputFileExtensions')
    buildToolObj.InputFileExtensions = toolinfo.InputFileExtensions;
end
if isfield(toolinfo,'OutputFileExtensions')
    buildToolObj.OutputFileExtensions = toolinfo.OutputFileExtensions;
end

createBuildTool_2.m

function buildToolObj = createBuildTool_2()

% -------------------------
% Construct a BuildTool
% -------------------------
buildToolObj = coder.make.BuildTool();

% -------------------------
% Set general properties
% -------------------------
buildToolObj.Name               = 'My GNU C Compiler';
buildToolObj.Language           = 'C';
buildToolObj.Command            = coder.make.BuildItem('CC','gcc');
buildToolObj.Path               = coder.make.BuildItem('CC_PATH','');
buildToolObj.OptionsRegistry    = {'My C Compiler','MY_CFLAGS'};
buildToolObj.SupportedOutputs   = {'*'}; % '*' means all outputs are supported

% -------------------------
% Directives
% -------------------------

directiveBuildItem = coder.make.BuildItem('','-I');
buildToolObj.addDirective('IncludeSearchPath',directiveBuildItem);

directiveBuildItem = coder.make.BuildItem('','-D');
buildToolObj.addDirective('PreprocessorDefine',directiveBuildItem);

directiveBuildItem = coder.make.BuildItem('CDEBUG','-g');
buildToolObj.addDirective('Debug',directiveBuildItem);

directiveBuildItem = coder.make.BuildItem('C_OUTPUT_FLAG','-o');
buildToolObj.addDirective('OutputFlag',directiveBuildItem);

% -------------------------
% File Extensions
% -------------------------

fileExtBuildItem = coder.make.BuildItem('C_EXT','.c');
buildToolObj.addFileExtension('Source',fileExtBuildItem);

fileExtBuildItem = coder.make.BuildItem('H_EXT','.h');
buildToolObj.addFileExtension('Header',fileExtBuildItem);

fileExtBuildItem = coder.make.BuildItem('OBJ_EXT','.obj');
buildToolObj.addFileExtension('Object',fileExtBuildItem);

% -------------------------
% Others
% -------------------------

buildToolObj.DerivedFileExtensions  = {'$(OBJ_EXT)'};
buildToolObj.InputFileExtensions    = {'Source'};
% put actual extension (e.g. '.c')
% or keyname if already registered under 'FileExtensions'
buildToolObj.OutputFileExtensions   = {'Object'};
% put actual extension (e.g. '.c')
% or keyname if already registered under 'FileExtensions'

Добавьте Prebuild и Инструментов пост-сборки к Toolchain

Код в addPrebuildToolToToolchainInfo.m и addPostbuildToolToToolchainInfo.m примеры показа, как добавить prebuild и инструментов пост-сборки к набору инструментальных средств.

addPrebuildToolToToolchainInfo.m

addPostbuildToolToToolchainInfo.m

См. также

Документация

coder.make.BuildTool class

Описание

Конструкция

Входные параметры

`bldtl_name` - Имя инструмента сборки
вектор символов | строковый скаляр

Выходные аргументы

`h` - Указатель на объект
переменная

Свойства

`Command` - Создайте команду инструмента или командный макрос

`Directives` - Директивы, относящиеся к конкретным инструментам

`FileExtensions` - Расширения файлов для конкретного инструмента

`Name` - Имя инструмента сборки

`Path` - пути для конкретного инструмента

`SupportedOutputs` - Форматы выхода для конкретного инструмента

Методы

Копировать семантику

Пример

Получите инструмент сборки по умолчанию и установите его свойства

Создайте Non-Default BuildTool

Добавьте Prebuild и Инструментов пост-сборки к Toolchain

См. также

Темы

Документация MATLAB Coder

Поддержка

Документация

coder.make.BuildTool class

Описание

Конструкция

Входные параметры

bldtl_name - Имя инструмента сборки вектор символов | строковый скаляр

Выходные аргументы

h - Указатель на объект переменная

Свойства

Command - Создайте команду инструмента или командный макрос

Directives - Директивы, относящиеся к конкретным инструментам

FileExtensions - Расширения файлов для конкретного инструмента

Name - Имя инструмента сборки

Path - пути для конкретного инструмента

SupportedOutputs - Форматы выхода для конкретного инструмента

Методы

Копировать семантику

Пример

Получите инструмент сборки по умолчанию и установите его свойства

Создайте Non-Default BuildTool

Добавьте Prebuild и Инструментов пост-сборки к Toolchain

См. также

Темы

Документация MATLAB Coder

Поддержка

`bldtl_name` - Имя инструмента сборки
вектор символов | строковый скаляр

`h` - Указатель на объект
переменная

`Command` - Создайте команду инструмента или командный макрос

`Directives` - Директивы, относящиеся к конкретным инструментам

`FileExtensions` - Расширения файлов для конкретного инструмента

`Name` - Имя инструмента сборки

`Path` - пути для конкретного инструмента

`SupportedOutputs` - Форматы выхода для конкретного инструмента