coder.make. Класс BuildTool

Пакет: coder.make

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

Описание

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

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

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

Примеры, показывающие получать и, задают подход:

Файл определения набора инструментальных средств с комментарием
Учебный пример: Добавление Пользовательского примера по Набору инструментальных средств

Альтернатива тому, чтобы получать и задает подход, создавание нового подхода. Пример, показывающий создавание нового подхода, появляется в, Создают BuildTool Не по умолчанию.

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

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

Конструкция

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

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

развернуть все

Имя инструмента `bldtl_name` — Build
вектор символа | представляет скаляр в виде строки

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

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

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

развернуть все

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

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

Инструмент Пример:

Свойства

развернуть все

Команда инструмента `Command` — Build или макрос команды

Представляет использование команды инструмента сборки:

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

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

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

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

Атрибуты:

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

`Directives` — Специфичные для инструмента директивы

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

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

Атрибуты:

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

`'FileExtensions'` Специфичные для инструмента расширения файла

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

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

Атрибуты:

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

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

Задает имя инструмента сборки.

Можно использовать следующие методы с 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`	запрашивает инструменты сборки и инструменты постсборки; требует Встроенной лицензии ^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 влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Пример

Получите инструмент сборки по умолчанию и набор его свойства
Создайте BuildTool Не по умолчанию
Добавьте предварительную сборку и постсоздайте инструменты к набору инструментальных средств

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

Файл intel_tc.m от Добавления Пользовательского Набора инструментальных средств использует следующие строки, чтобы получить инструмент сборки по умолчанию, 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<|');

Следующие примеры показывают, что то же самое “получает и задает” подход более подробно:

Файл определения набора инструментальных средств с комментарием
Учебный пример: Добавление Пользовательского примера по Набору инструментальных средств

Создайте BuildTool Не по умолчанию

Создать инструмент сборки:

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

Обратитесь к следующим примерам addBuildToolToToolchainInfo.m, createBuildTool_1.m и createBuildTool_2.m 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'

Добавьте предварительную сборку и постсоздайте инструменты к набору инструментальных средств

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

addPrebuildToolToToolchainInfo. m

addPostbuildToolToToolchainInfo. m

Темы

Была ли эта тема полезной?

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

coder.make. Класс BuildTool

Описание

Конструкция

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

Имя инструмента `bldtl_name` — Build
вектор символа | представляет скаляр в виде строки

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

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

Свойства

Команда инструмента `Command` — Build или макрос команды

`Directives` — Специфичные для инструмента директивы

`'FileExtensions'` Специфичные для инструмента расширения файла

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

`Path` Специфичные для инструмента пути

`SupportedOutputs` — Специфичные для инструмента выходные форматы

Методы

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

Пример

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

Создайте BuildTool Не по умолчанию

Добавьте предварительную сборку и постсоздайте инструменты к набору инструментальных средств

Смотрите также

Темы

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

Поддержка

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

coder.make. Класс BuildTool

Описание

Конструкция

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

Имя инструмента bldtl_name — Build вектор символа | представляет скаляр в виде строки

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

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

Свойства

Команда инструмента Command — Build или макрос команды

Directives — Специфичные для инструмента директивы

'FileExtensions' Специфичные для инструмента расширения файла

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

Path Специфичные для инструмента пути

SupportedOutputs — Специфичные для инструмента выходные форматы

Методы

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

Пример

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

Создайте BuildTool Не по умолчанию

Добавьте предварительную сборку и постсоздайте инструменты к набору инструментальных средств

Смотрите также

Темы

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

Поддержка

Имя инструмента `bldtl_name` — Build
вектор символа | представляет скаляр в виде строки

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

Команда инструмента `Command` — Build или макрос команды

`Directives` — Специфичные для инструмента директивы

`'FileExtensions'` Специфичные для инструмента расширения файла

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

`Path` Специфичные для инструмента пути

`SupportedOutputs` — Специфичные для инструмента выходные форматы