clibgen.generateLibraryDefinition

C++ ライブラリの定義ファイルを作成

構文

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,'Libraries',LibraryFiles)

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,'Libraries',LibraryFiles,'SupportingSourceFiles',SupportingSourceFiles)

clibgen.generateLibraryDefinition(InterfaceGenerationFiles)

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,___,Name,Value)

説明

例

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,'Libraries',LibraryFiles) は、InterfaceGenerationFiles および LibraryFiles で定義された C++ ライブラリへの MATLAB^® インターフェイスの生成に使用する MATLAB ライブコード定義ファイルを作成します。clibgen.generateLibraryDefinition の呼び出しの例については、ヒントの「ライブラリに含めるファイル」を参照してください。

定義ファイルの名前は definelibName.mlx です。このファイルの使用方法の詳細については、C++ ライブラリに対する MATLAB インターフェイスの定義を参照してください。既定の設定では、libName は InterfaceGenerationFiles で指定した最初のファイルの名前です。インターフェイス生成ファイルを複数指定する場合は、名前と値のペアの引数 PackageName を使用する必要があります。

インターフェイスを作成するには、build メソッドを使用します。MATLAB でサポートされる C++ コンパイラが必要です。C++ ライブラリのビルドに使用したものと同じコンパイラを使って、インターフェイスライブラリをビルドしなければなりません。ライブラリがソースファイルで完全に定義される場合 (共有ライブラリファイルを使用しない場合)、サポートされている任意の C++ コンパイラを選択してインターフェイスライブラリをビルドできます。

例

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,'Libraries',LibraryFiles,'SupportingSourceFiles',SupportingSourceFiles) は、複数のヘッダーファイル、ソースファイル、および必要な場合は共有ライブラリファイルで定義されるライブラリに対する定義ファイルを作成します。

例

clibgen.generateLibraryDefinition(InterfaceGenerationFiles) は、InterfaceGenerationFiles で完全に定義されるライブラリに対する定義ファイルを作成します。

ライブラリに共有ライブラリファイルが含まれている場合、'Libraries' 引数を指定しなければなりません。

clibgen.generateLibraryDefinition(InterfaceGenerationFiles,___,Name,Value) は、1 つ以上の名前と値のペアの引数を使用してファイルを作成します。このオプションは、前述の構文のすべての入力引数の組み合わせで使用できます。

例

すべて折りたたむ

共有ライブラリの定義ファイルを作成

Windows^® の matrixOperations.hpp ヘッダーファイルからライブラリ定義ファイル definematrixOperations.mlx を生成します。Linux^® の例については、Linux のヘッダーファイルと共有オブジェクトファイルを参照してください。

headerFile = fullfile(matlabroot,"extern","examples","cpp_interface","matrixOperations.hpp");
iPath = fullfile(matlabroot,"extern","examples","cpp_interface");
libFile = fullfile(matlabroot,"extern","examples","cpp_interface",...
    "win64","mingw64","matrixOperations.lib");

clibgen.generateLibraryDefinition(headerFile,"IncludePath", iPath,"Libraries", libFile)

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

ヘッダーファイルと CPP ファイルで定義されるライブラリの定義ファイルを作成

matrixOperations.hpp ファイルと matrixOperations.cpp ファイルからライブラリ定義ファイル definematrixOps.mlx を生成します。

headerFile = fullfile(matlabroot,"extern","examples","cpp_interface","matrixOperations.hpp");
sourceFile = fullfile(matlabroot,"extern","examples","cpp_interface","matrixOperations.cpp");
iPath = fullfile(matlabroot,"extern","examples","cpp_interface");

clibgen.generateLibraryDefinition(headerFile,...
    "SupportingSourceFiles",sourceFile,...
    "IncludePath", iPath,...
    "PackageName","matrixOps")

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

ヘッダーのみのライブラリの定義ファイルを作成

school.hpp ヘッダーファイルからライブラリ定義ファイル defineschool.mlx を生成します。

headerFile = fullfile(matlabroot,"extern","examples","cpp_interface","school.hpp");
clibgen.generateLibraryDefinition(headerFile)

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).

入力引数

すべて折りたたむ

`InterfaceGenerationFiles` — インターフェイス生成ファイル
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

インターフェイスを生成するための 1 つ以上の C++ ファイル。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。現在のフォルダーまたは MATLAB のパスにない場合、名前にはファイルの絶対パスまたは相対パスが含まれます。

InterfaceGenerationFiles およびSupportingSourceFilesを指定するファイルは次のとおりです。

ヘッダーファイル。ファイル拡張子は .h、.hpp、または .hxx です。拡張子のないヘッダーファイルもサポートされます。.h ヘッダーファイルのコードは C++ と互換性のある C コードでなければなりません。
インターフェイス生成ファイルを複数指定する場合は、PackageName 引数を使用する必要があります。
ソースコードファイル。ファイル拡張子は .cpp または .cxx です。
詳細については、ヒントの「What files do you have in your library?」を参照してください。

これらのファイルには、ライブラリによってエクスポートされたすべての関数の宣言を含めなければなりません。これらを C++ 開発環境でコンパイルし、その機能を C++ アプリケーションで使用できなければなりません。ライブラリがヘッダーファイル (ヘッダーのみのライブラリ) で完全に定義される場合、ライブラリファイルは必要ありません。

さまざまなフォルダー内のヘッダーファイルの #include ステートメントがメインヘッダーファイルに含まれている場合は、IncludePath 引数を使用してこれらのパスを指定します。

1 つのヘッダーファイル名を指定した場合、MATLAB は、そのヘッダーファイルと同じフォルダーで同じ名前のライブラリを探します。ライブラリにはプラットフォーム固有のファイル名の拡張子がなければなりません。ライブラリに異なる名前がある場合、または同じフォルダーにない場合、Libraries 引数を使用します。

MATLAB は、インターフェイスファイルを現在のフォルダーのサブフォルダーに書き込みます。ただし、OutputFolder 引数を指定する場合を除きます。このサブフォルダーの名前は、最初のヘッダーファイルの名前からファイル拡張子を除いたものです。たとえば、このステートメントは現在のフォルダーのサブフォルダー myHeader でインターフェイスライブラリファイルを作成します。

clibgen.generateLibraryDefinition("myHeader.hpp")

例: "sample.hpp"

データ型: char | string | cell

`LibraryFiles` — 共有ライブラリファイル名
空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

1 つ以上の共有ライブラリファイル名。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。名前と値のペアの引数 'Libraries' と共に使用します。引数 InterfaceGenerationFiles および名前と値のペアの引数 'SupportingSourceFiles' で指定されたファイルでライブラリが完全に定義される場合を除き、この値は必須です。

ライブラリは次のいずれかです。

Windows プラットフォームの場合:
- 共有ライブラリの場合は .lib インポートライブラリファイルを指定します。
  .lib ファイルを使用できない場合、サポートされている Microsoft^® Visual Studio^® コンパイラでライブラリがコンパイルされていれば、.dll ダイナミックリンクライブラリファイルを指定できます。次に例を示します。
  clibgen.generateLibraryDefinition("A.hpp","Libraries","A.dll")
- スタティックライブラリの場合は .lib ファイルを指定します。次に例を示します。
  clibgen.generateLibraryDefinition("A.hpp","Libraries","A.lib")
Linux プラットフォームの場合、.so 共有オブジェクトファイルを指定します。
macOS プラットフォームの場合、.dylib ダイナミック共有ライブラリファイルを指定します。

たとえば、このステートメントは、myLib.lib を使用して、C:\myLib\ に definesample.mlx を作成し、現在のフォルダーに書き込みます。

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

データ型: char | string | cell

`SupportingSourceFiles` — ソースファイル
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

1 つ以上の C++ ソースファイル。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。名前と値のペアの引数 'SupportingSourceFiles' と共に使用します。サポートされているファイルファイル拡張子は .cpp と .cxx です。現在のフォルダーまたは MATLAB のパスにない場合、名前にはファイルの絶対パスまたは相対パスが含まれます。サポートソースファイルには C++ コードが含まれていなければなりません。

詳細については、ヒントの「What files do you have in your library?」を参照してください。

ライブラリがヘッダーファイルまたは .cpp ソースファイルにより完全に定義されている場合、共有ライブラリファイルは必要ありません。

例: "sample.cpp"

データ型: char | string | cell

名前と値の引数

例: clibgen.generateLibraryDefinition(["hfile1.hpp","hfile2.hpp"],"Libraries","hfile1.lib",... "IncludePath","C:\mylib\include","PackageName","mylib","OutputFolder","C:\work",... "DefinedMacros",["mymacro1","mymacro2=0"],"UndefinedMacros","mymacro3");

オプションの Name,Value の引数ペアをコンマ区切りで指定します。Name は引数名で、Value は対応する値です。Name は引用符で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数の名前と値のペアの引数を任意の順序で指定できます。

`IncludePath` — 含まれるヘッダーファイルのフォルダー
空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

含まれるヘッダーファイルの 1 つ以上のフォルダー。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。IncludePath の各値は、ヘッダーファイルのコンパイル中に含めるフォルダーへの絶対パス名でなければなりません。

データ型: char | string | cell

`OutputFolder` — ‎フォルダー名
現在のフォルダー (既定値) | string スカラー | 文字ベクトル

定義ファイルの生成に使用するフォルダー名。string スカラーまたは文字ベクトルとして指定します。関数 build を呼び出す前に、フォルダーが MATLAB パス上にあることを確認します。次のステートメントは definemyHeader.mlx を C:\work に作成します。

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

データ型: char | string | cell

`PackageName` — 生成されたインターフェイスパッケージ名
ヘッダーファイル名 (既定値) | string スカラー | 文字ベクトル

生成されたインターフェイスパッケージ名。string スカラーまたは文字ベクトルとして指定します。詳細については、C++ 共有ライブラリの関数の呼び出しを参照してください。

1 つのヘッダーファイルから作成されたインターフェイスの場合、既定値はヘッダー名です。複数のヘッダーファイルの場合は、パッケージ名を有効な MATLAB 名として指定しなければなりません。たとえば、次のステートメントは現在のフォルダーに definemylib.mlx を作成します。

clibgen.generateLibraryDefinition(["h1.hpp","h2.hpp"],"PackageName","mylib")

データ型: char | string | cell

`Verbose` — 生成メッセージの表示オプション
`false` (既定値) | `true`

生成メッセージの表示オプション。true または false として指定します。Verbose が true の場合、MATLAB は定義ファイルの作成中に生成メッセージをコマンドウィンドウに表示します。このステートメントは defineh1.mlx を作成し、メッセージをコマンドウィンドウに表示します。

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

詳細については、サポートされていない型についてのメッセージを参照してください。

データ型: logical

`TreatObjectPointerAsScalar` — オブジェクトポインターの形状指定子
`false` (既定値) | `true`

オブジェクトポインターの形状指定子。true または false として指定します。TreatObjectPointerAsScalar が true の場合、MATLAB は SHAPE を 1 として指定してライブラリ内のすべてのオブジェクトポインターをスカラーとして扱います。それ以外の場合、オブジェクトポインターの形状は不明です。

R2019b で導入されました。

データ型: logical

`TreatConstCharPointerAsCString` — `const` 文字ポインターの形状と MATLAB 型指定子
`false` (既定値) | `true`

const 文字ポインターの形状と MATLAB 型指定子。true または false として指定します。TreatConstCharPointerAsCString が true の場合、MATLAB は MLTYPE を string、SHAPE を nullTerminated として指定し、ライブラリ内のすべての const 文字ポインターを null で終了する C の文字列として扱います。それ以外の場合、MATLAB 型および const 文字ポインターの形状は不明です。サポートされているポインターの型は次のとおりです。

const char *
const wchar_t *
const char16_t *
const char32_t *

データ型: logical

`DefinedMacros` — マクロ定義のリスト
空 (既定値) | スカラー string | スカラー string の行ベクトル

ヘッダーファイルを解析する際に使用するマクロ定義のリスト。空、スカラー string、またはスカラー string の行ベクトルとして指定します。マクロ名には 1 ～ 9、a ～ z、A ～ Z、および '_' の文字が含まれ、先頭を数字にすることはできません。

データ型: string

`UndefinedMacros` — マクロのキャンセルのリスト
空 (既定値) | スカラー string | スカラー string の行ベクトル

ヘッダーファイルを解析する際に使用するマクロのキャンセルのリスト。空、スカラー string、またはスカラー string の行ベクトルとして指定します。マクロ名には 1 ～ 9、a ～ z、A ～ Z、および '_' の文字が含まれ、先頭を数字にすることはできません。

データ型: string

`GenerateDocumentationFromHeaderFiles` — C++ ファイルからドキュメンテーションを生成するかどうか
`true` (既定値) | false

C++ ファイルからドキュメンテーションを生成するかどうか。true または false として指定します。GenerateDocumentationFromHeaderFiles が true の場合、MATLAB は MATLAB doc コマンドを使用して C++ ファイルのコメントから表示用のドキュメンテーションを生成します。false の場合、MATLAB は C++ コメントを無視し、MATLAB のドキュメンテーションおよび C++ 型のマッピングのみを生成します。

詳細については、C++ ライブラリに対する MATLAB インターフェイスのヘルプテキストのパブリッシュを参照してください。

データ型: logical

`ReturnCArrays` — 非オブジェクト C 配列を返すかどうか
`true` (既定値) | false

非オブジェクト C 配列を返すかどうか。true または false として指定します。ReturnCArrays が true の場合、MATLAB は非オブジェクト C 配列の C 配列 (clib.array.*) を返します。false の場合、MATLAB は非オブジェクト C 配列の数値の MATLAB 配列を返します。

データ型: logical

`OverwriteExistingDefinitionFiles` — ライブラリ定義ファイルを上書きするかどうか
`false` (既定値) | `true`

ライブラリ定義ファイルを上書きするかどうか。true または false として指定します。定義ファイルの形式は definelibName.mlx または definelibname.m です。OverwriteExistingDefinitionFiles を true に設定すると、既存のファイルが自動的に上書きされます。このオプションは、定義ファイルを作成および変更する場合に便利です。

このオプションを使用すると、MATLAB により、ファイルがそれらのファイルに対して行った編集も含めて削除されます。

制限

LibraryDefinition オブジェクト definelibName を MAT ファイルに保存することはサポートされていません。
一部のロケール設定では非 ASCII 文字がサポートされていない場合があるため、フォルダー名とファイル名にはこれらの文字を使用しないでください。ロケールの詳細については、国際化に向けたロケール設定の概念を参照してください。

ヒント

ライブラリ定義ファイルを作成し直すには、名前と値の引数 OverwriteExistingDefinitionFiles を true に設定して clibgen.generateLibraryDefinition を呼び出します。このオプションを使用すると、MATLAB により、ファイルがそれらのファイルに対して行った編集も含めて削除されます。
トラブルシューティングの詳細については、Troubleshooting C++ Library Definition Issuesを参照してください。

ライブラリにヘッダーファイル、CPP ソースファイル、および共有ライブラリファイルの組み合わせが含まれる場合があります。次の表に、ライブラリを定義するファイルの種類に応じた clibgen.generateLibraryDefinition の引数の設定方法を示します。

ライブラリに含めるファイル	引数 `InterfaceGenerationFiles`	名前と値の引数 `"Libraries"`	名前と値の引数 `"SupportingSourceFiles"`
Windows の単一のヘッダーファイルとインポートライブラリファイル。 `A.hpp` フォルダー `C:\Documents\MATLAB\` にある `A.lib` インポートライブラリファイル例: Header File and Import Library File on Windows	`"A.hpp"`	`"C:\Documents\MATLAB\A.lib"`
Linux のヘッダーファイルと共有オブジェクトファイル。 `A.hpp` フォルダー `~/MATLAB/` にある `A.so` 例: Linux のヘッダーファイルと共有オブジェクトファイル	`"A.hpp"`	`"~/MATLAB/A.so"`
macOS のヘッダーファイルとダイナミック共有ライブラリファイル。 `A.hpp` フォルダー `$home/Documents/MATLAB` にある `A.dylib`	`"A.hpp"`	`"$home/Documents/MATLAB/A.dylib"`
ヘッダーファイルと `.cpp` ソースファイルで完全に定義。ライブラリファイルなし。ヘッダーファイル `A.hpp` ソースファイル `A.cpp` 例: ヘッダーと CPP のソースファイル	`"A.hpp"`		`"A.cpp"`
複数のヘッダーファイルとソースファイルおよび共有ライブラリファイル。`A` という名前のインターフェイスを作成。ヘッダーファイル `A.hpp` および `B.hpp` ソースファイル `A.cpp` `C:\Documents\MATLAB\` にある共有ライブラリファイル `B.lib`	`["A.hpp","B.hpp"]` ^a	`"C:\Documents\MATLAB\B.lib"`	`"A.cpp"`
ヘッダーのみのライブラリ。ライブラリがヘッダーファイルで完全に定義され、共有ライブラリファイルがない。 `A.hpp` 例: ヘッダー専用の HPP ファイル	`"A.hpp"`
ライブラリが `.CPP` ファイルで完全に定義され、共有ライブラリファイルがない。 `A.cpp`	`"A.cpp"`
^a Because you have multiple header files, you must set the `"PackageName"` name-value argument. For example, use the name `"A"`. Then when you call library function `functionname` from MATLAB, the syntax is `clib.A.functionname.`

バージョン履歴

R2019a で導入

参考

build | clibgen.buildInterface | doc

トピック

外部の Web サイト

サポートされるコンパイラ

clibgen.generateLibraryDefinition

構文

説明

例

共有ライブラリの定義ファイルを作成

ヘッダー ファイルと CPP ファイルで定義されるライブラリの定義ファイルを作成

ヘッダーのみのライブラリの定義ファイルを作成

入力引数

InterfaceGenerationFiles — インターフェイス生成ファイル string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

LibraryFiles — 共有ライブラリ ファイル名 空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

SupportingSourceFiles — ソース ファイル string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

名前と値の引数

IncludePath — 含まれるヘッダー ファイルのフォルダー 空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

OutputFolder — ‎フォルダー名 現在のフォルダー (既定値) | string スカラー | 文字ベクトル

PackageName — 生成されたインターフェイス パッケージ名 ヘッダー ファイル名 (既定値) | string スカラー | 文字ベクトル

Verbose — 生成メッセージの表示オプション false (既定値) | true

TreatObjectPointerAsScalar — オブジェクト ポインターの形状指定子 false (既定値) | true

TreatConstCharPointerAsCString — const 文字ポインターの形状と MATLAB 型指定子 false (既定値) | true

DefinedMacros — マクロ定義のリスト 空 (既定値) | スカラー string | スカラー string の行ベクトル

UndefinedMacros — マクロのキャンセルのリスト 空 (既定値) | スカラー string | スカラー string の行ベクトル

GenerateDocumentationFromHeaderFiles — C++ ファイルからドキュメンテーションを生成するかどうか true (既定値) | false

ReturnCArrays — 非オブジェクト C 配列を返すかどうか true (既定値) | false

OverwriteExistingDefinitionFiles — ライブラリ定義ファイルを上書きするかどうか false (既定値) | true

制限

ヒント

バージョン履歴

参考

トピック

外部の Web サイト

ヘッダーファイルと CPP ファイルで定義されるライブラリの定義ファイルを作成

`InterfaceGenerationFiles` — インターフェイス生成ファイル
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`LibraryFiles` — 共有ライブラリファイル名
空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`SupportingSourceFiles` — ソースファイル
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`IncludePath` — 含まれるヘッダーファイルのフォルダー
空 (既定値) | string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`OutputFolder` — ‎フォルダー名
現在のフォルダー (既定値) | string スカラー | 文字ベクトル

`PackageName` — 生成されたインターフェイスパッケージ名
ヘッダーファイル名 (既定値) | string スカラー | 文字ベクトル

`Verbose` — 生成メッセージの表示オプション
`false` (既定値) | `true`

`TreatObjectPointerAsScalar` — オブジェクトポインターの形状指定子
`false` (既定値) | `true`

`TreatConstCharPointerAsCString` — `const` 文字ポインターの形状と MATLAB 型指定子
`false` (既定値) | `true`

`DefinedMacros` — マクロ定義のリスト
空 (既定値) | スカラー string | スカラー string の行ベクトル

`UndefinedMacros` — マクロのキャンセルのリスト
空 (既定値) | スカラー string | スカラー string の行ベクトル

`GenerateDocumentationFromHeaderFiles` — C++ ファイルからドキュメンテーションを生成するかどうか
`true` (既定値) | false

`ReturnCArrays` — 非オブジェクト C 配列を返すかどうか
`true` (既定値) | false

`OverwriteExistingDefinitionFiles` — ライブラリ定義ファイルを上書きするかどうか
`false` (既定値) | `true`