clibgen.generateLibraryDefinition

Создайте файл определения для библиотеки C++

свернуть все на странице

Синтаксис

clibgen.generateLibraryDefinition(HeaderFiles)
clibgen.generateLibraryDefinition(HeaderFiles,'Libraries',SharedLibrary)
clibgen.generateLibraryDefinition(HeaderFiles,___,Name,Value)

Описание

пример

clibgen.generateLibraryDefinition(HeaderFiles) создает файл определения MATLAB® Live Кода, используемый, чтобы сгенерировать интерфейс MATLAB к библиотеке C++, заданной HeaderFiles.

Имя файла определения является definelibName.mlx. Для получения дополнительной информации об использовании этого файла смотрите, Задают Интерфейс MATLAB для Библиотеки C++. По умолчанию, libName имя файла, заданного в HeaderFiles. Если вы используете больше чем один заголовочный файл, то необходимо задать PackageName аргумент. Если вы используете совместно использованный файл библиотеки, то необходимо задать Libraries аргумент.

Используйте build метод, чтобы создать интерфейс. Вам нужен поддерживаемый MATLAB компилятор C++. Необходимо создать интерфейсную библиотеку с помощью того же компилятора, который использовался, чтобы создать библиотеку C++. Если ваша библиотека только для заголовка (не использует совместно использованный файл библиотеки), то можно выбрать, любой поддержал компилятор C++, чтобы создать интерфейсную библиотеку.

clibgen.generateLibraryDefinition(HeaderFiles,'Libraries',SharedLibrary) создает файл для библиотеки с одним или несколькими совместно использованными файлами библиотеки.

clibgen.generateLibraryDefinition(HeaderFiles,___,Name,Value) создает файл с помощью одного или нескольких аргументов пары "имя-значение". Используйте эту опцию с любыми комбинациями входных аргументов в предыдущих синтаксисах.

Примеры

свернуть все

Скопируйте school.hpp заголовочный файл к перезаписываемой папке.

copyfile(fullfile(matlabroot,"extern","examples","cpp_interface","school.hpp"),".","f")

Сгенерируйте файл определения библиотеки defineschool.mlx.

clibgen.generateLibraryDefinition("school.hpp")
Warning: Only header files specified; assuming this is a header-only
library. If library files also need to be specified, use the 'Libraries' option. 

Using MinGW64 Compiler (C++) compiler.
Generated definition file defineschool.mlx and data file 'schoolData.xml' contain definitions for 
21 constructs supported by MATLAB.
1 construct(s) require(s) additional definition. To include these construct(s) in the interface, 
edit the definitions in defineschool.mlx.
Build using build(defineschool).

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

свернуть все

Один или несколько заголовочных файлов в виде массива строк, вектора символов или массива ячеек из символьных векторов. Поддерживаемыми расширениями файла является .h, .hpp, и .hxx. Заголовочный файл без расширения также поддержан. Если не в текущей папке или на вашем пути MATLAB, то имя включает полный или относительный путь в файл.

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

Если библиотека полностью задана заголовочными файлами (библиотека только для заголовка), то вам не нужен файл библиотеки, и можно проигнорировать предупреждающее сообщение MATLAB.

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

Если вы обеспечиваете одно имя заголовочного файла, то MATLAB ищет библиотеку с тем же именем в той же папке как заголовочный файл. Библиотека должна иметь специфичное для платформы расширение файла. Если библиотека имеет другое имя и/или не находится в той же папке, то используйте Libraries аргумент.

MATLAB записывает интерфейсные файлы в подпапке в текущей папке, если вы не задаете OutputFolder аргумент. Имя подпапки является именем первого заголовочного файла без расширения файла. Например, этот оператор создает интерфейсный файл библиотеки в подпапке myHeader в текущей папке.

clibgen.generateLibraryDefinition('myHeader.hpp')

Пример: "sample.hpp"

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

Одно или несколько имен полного пути к библиотекам в виде массива строк, вектора символов или массива ячеек из символьных векторов. Используйте с 'Libraries' аргумент. Это значение требуется за исключением библиотек только для заголовка, который является библиотекой, заданной полностью ее заголовочными файлами.

Например, этот оператор создает definesample.mlx использование myLib.lib в C:\myLib\ и записи это в текущей папке.

clibgen.generateLibraryDefinition("sample.hpp","Libraries","C:\myLib\myLib.lib")

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

Аргументы в виде пар имя-значение

Задайте дополнительные разделенные запятой пары Name,Value аргументы. Name имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: clibgen.generateLibraryDefinition({"hfile1.hpp","hfile2.hpp"},"Libraries","mylib.lib","IncludePath","C:\mylib\include","PackageName","mypackage","OutputFolder","C:\work","DefinedMacros",["mymacro1","mymacro2=0"],"UndefinedMacros","mymacro3");

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

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

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

Имя папки раньше генерировало файл определения в виде строкового скаляра или вектора символов. Проверьте, что папка находится на вашем пути MATLAB прежде, чем вызвать build функция. Этот оператор создает definemyHeader.mlx в C:\work.

clibgen.generateLibraryDefinition("myHeader.hpp","OutputFolder","C:\work")

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

Сгенерированный интерфейсный пакет называет в виде строкового скаляра или вектора символов. Для интерфейсов, созданных из одного заголовочного файла, значением по умолчанию является имя заголовка. Для нескольких заголовочных файлов необходимо задать имя пакета как допустимое имя MATLAB. Например, этот оператор создает definemyPackage.mlx в подпапке myPackage в текущей папке.

clibgen.generateLibraryDefinition({"h1.hpp","h2.hpp"},"PackageName","myPackage")

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

Опция, чтобы отобразить сообщения генерации в виде true или false. Если Verbose true, затем MATLAB отображает сообщения генерации к командному окну при создании файла определения. Этот оператор создает defineh1.mlx и отображения обмениваются сообщениями к командному окну.

clibgen.generateLibraryDefinition("h1.hpp","Verbose",true)

Для получения дополнительной информации см. сообщения О Неподдерживаемых Типах.

Типы данных: логический

Сформируйте спецификатор для объектных указателей в виде true или false. Если TreatObjectPointerAsScalar true, затем MATLAB обрабатывает все объектные указатели в библиотеке как скаляры путем определения SHAPE как 1. В противном случае форма объектного указателя неизвестна.

Типы данных: логический

Форма и MATLAB вводят спецификатор для const символьные указатели в виде true или false. Если TreatConstCharPointerAsCString true, затем MATLAB обрабатывает весь const символьные указатели в библиотеке как отключенные пустым указателем струны до путем определения MLTYPE как string и SHAPE как nullTerminated. В противном случае, тип MATLAB и форма const символьные указатели неизвестны. Поддерживаемые типы указателей:

  • const char *

  • const wchar_t *

  • const char16_t *

  • const char32_t *

Типы данных: логический

Список макроопределений, чтобы использовать при парсинге заголовочных файлов в виде пустого, скалярной строки или вектора-строки из скалярных строк. Макро-имя содержит символы 1–9, a–z, A–Z и '_' и не может начаться с цифры.

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

Список макро-отмен, чтобы использовать при парсинге заголовочных файлов в виде пустого, скалярной строки или вектора-строки из скалярных строк. Макро-имя содержит символы 1–9, a–z, A–Z и '_' и не может начаться с цифры.

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

Сгенерировать ли документацию от заголовочных файлов в виде true или false. Если GenerateDocumentationFromHeaderFiles true, затем MATLAB генерирует документацию из комментариев в заголовочных файлах C++ для отображения с помощью doc MATLAB команда. Если false, затем MATLAB игнорирует комментарии C++ и только генерирует документацию отображений типа MATLAB и C++.

Для получения дополнительной информации смотрите, Публикуют текст Справки для Интерфейса MATLAB к Библиотеке C++.

Типы данных: логический

Возвратить ли массивы необъекта C в виде true или false. Если ReturnCArrays true, затем MATLAB возвращает массивы C (clib.array.*) для массивов необъекта C. Если false, затем MATLAB возвращает числовые массивы MATLAB для массивов необъекта C.

Типы данных: логический

Ограничения

Советы

  • Чтобы воссоздать файл определения библиотеки, сначала удалите definelibName.mlx файл, затем вызовите clibgen.generateLibraryDefinition.

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

| |

Темы

Внешние веб-сайты

Введенный в R2019a

Документация MATLAB
Поддержка
Для просмотра документации необходимо авторизоваться на сайте