compiler.build.cppSharedLibrary
Syntax
Description
compiler.build.cppSharedLibrary(
creates a C++ shared library using the MATLAB® files specified by FunctionFiles
)FunctionFiles
. Install a supported
C++ compiler before using this function.
compiler.build.cppSharedLibrary(
creates a C++ shared library with options specified using one or more name-value arguments.
Options include the interface API, library name, and output directory.FunctionFiles
,Name,Value
)
compiler.build.cppSharedLibrary(
creates
a C++ shared library with options specified using a
opts
)compiler.build.CppSharedLibraryOptions
object opts
.
You cannot specify any other options using name-value arguments.
Examples
Create C++ Library
Create a C++ shared library using a function file that adds two matrices.
In MATLAB, locate the MATLAB function that you want to deploy as a C++ library. For this example, use
the file addmatrix.m
located in
.matlabroot
\extern\examples\compilersdk\c_cpp\matrix
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
Build a C++ library using the compiler.build.cppSharedLibrary
command.
compiler.build.cppSharedLibrary(appFile);
The build function generates the following files within a folder named
addmatrixcppSharedLibrary
in your current working directory:
GettingStarted.html
— HTML file that contains information on integrating your shared library.includedSupportPackages.txt
— Text file that lists all support files included in the library.mccExcludedFiles.log
— Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see MATLAB Compiler Limitations.readme.txt
— Readme file that contains information on deployment prerequisites and the list of files to package for deployment.requiredMCRProducts.txt
— Text file that contains product IDs of products required by MATLAB Runtime to run the application.unresolvedSymbols.txt
— Text file that contains information on unresolved symbols.v2\generic_interface\readme.txt
— Readme file that contains information on deployment prerequisites and the list of files to package for deployment.v2\generic_interface\magicsquare.ctf
— Component technology file that contains the deployable archive.
To implement your shared library, see Implement C++ MATLAB Data API Shared Library with Sample Application.
Customize C++ Library
Create a C++ library and customize it using name-value arguments.
For this example, use the file addmatrix.m
located in
.matlabroot
\extern\examples\compilersdk\c_cpp\matrix
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
Save the following code in a sample file named
addmatrixSample1.m
:
a1 = [1 4 7; 2 5 8; 3 6 9]; a2 = a1; a = addmatrix(a1, a2);
Build a C++ library using the compiler.build.cppSharedLibrary
command. Use name-value arguments to specify the library name, add a sample file, and
use the mwArray
interface.
compiler.build.cppSharedLibrary(appFile,'LibraryName','mwa_addmatrix', ... 'SampleGenerationFiles','addmatrixSample1.m', ... 'Interface','mwarray');
The build function creates the following files within a folder named
mwa_addmatrixcppSharedLibrary
in your current working directory:
samples\addmatrixSample1_mwarray.cpp
— C++ sample application.GettingStarted.html
— File that contains information on integrating your shared library.includedSupportPackages.txt
— Text file that lists all support files included in the library.mwa_addmatrix.cpp
— C++ source code file.mwa_addmatrix.def
— Module-definition file that provides the linker with module information.mwa_addmatrix.dll
— Dynamic-link library file.mwa_addmatrix.exports
— Exports file that contains all nonstatic function names.mwa_addmatrix.h
— C++ header file.mwa_addmatrix.lib
— Import library file.mccExcludedFiles.log
— Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see MATLAB Compiler Limitations.readme.txt
— Readme file that contains information on deployment prerequisites and the list of files to package for deployment.requiredMCRProducts.txt
— Text file that contains product IDs of products required by MATLAB Runtime to run the application.unresolvedSymbols.txt
— Text file that contains information on unresolved symbols.
To implement your shared library, see Implement C++ mwArray API Shared Library with C++ Sample Application.
Create Multiple Libraries Using Options Object
Create multiple C++ libraries using a compiler.build.CppSharedLibraryOptions
object.
For this example, use the file addmatrix.m
located in
.matlabroot
\extern\examples\compilersdk\c_cpp\matrix
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
Create a CppSharedLibraryOptions
object using
appFile
. Use name-value arguments to specify a common output
directory, enable debug symbols, and enable verbose output.
opts = compiler.build.CppSharedLibraryOptions(appFile, ... 'OutputDir','D:\Documents\MATLAB\work\CppLibraryBatch', ... 'DebugBuild','on','Verbose','on')
opts =
CppSharedLibraryOptions with properties:
Interface: 'matlab-data'
LibraryVersion: '1.0.0.0'
SampleGenerationFiles: {}
FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compilersdk\c_cpp\addmatrix.m'}
DebugBuild: on
LibraryName: 'magicsquare'
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\CppLibraryBatch'
Build the C++ shared library using the CppSharedLibraryOptions
object.
compiler.build.cppSharedLibrary(opts);
To create a new library using the function file subtractmatrix.m
with the same options, use dot notation to modify the FunctionFiles
argument of the existing CppSharedLibrary
object before running the
build function again.
opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m'); compiler.build.cppSharedLibrary(opts);
By modifying the FunctionFiles
argument and recompiling, you can
compile multiple libraries using the same options object.
Get Build Information from C++ Library
Create a C++ library and save information about the build type, compiled
files, support packages, and build options to a compiler.build.Results
object.
Compile using the file magicsquare.m
.
results = compiler.build.cppSharedLibrary('magicsquare.m')
results = Results with properties: BuildType: 'cppSharedLibrary' Files: {2×1 cell} IncludedSupportPackages: {} Options: [1×1 compiler.build.CppSharedLibraryOptions]
The Files
property contains the paths to the v2
folder and GettingStarted.html
.
Input Arguments
FunctionFiles
— Files implementing MATLAB functions
character vector | string scalar | cell array of character vectors | string array
Files implementing MATLAB functions, specified as a character vector, a string scalar, a string
array, or a cell array of character vectors. File paths can be relative to the current
working directory or absolute. Files must have one of the following extensions: .m
, .p
, .mlx
, or .mexa64
.
Example: ["myfunc1.m","myfunc2.m"]
Data Types: char
| string
| cell
opts
— C++ library build options
compiler.build.CppSharedLibraryOptions
object
C++ library build options, specified as a compiler.build.CppSharedLibraryOptions
object.
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: 'Verbose','on'
AdditionalFiles
— Additional files
character vector | string scalar | cell array of character vectors | string array
Additional files and folders to include in the C++ shared library, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.
Example: 'AdditionalFiles',["myvars.mat","data.txt"]
Data Types: char
| string
| cell
AutoDetectDataFiles
— Flag to automatically include data files
'on'
(default) | on/off logical value
Flag to automatically include data files, specified as 'on'
or 'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to
true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a
logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then data files that you provide as inputs to certain functions (such asload
andfopen
) are automatically included in the shared library.If you set this property to
'off'
, then you must add data files to the shared library using theAdditionalFiles
property.
Example: 'AutoDetectDataFiles','off'
Data Types: logical
DebugBuild
— Flag to enable debug symbols
'off'
(default) | on/off logical value
Flag to enable debug symbols, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to
true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a
logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then debugging symbol information is included in the compiled artifact. This option also causesmbuild
to pass appropriate debugging flags to the system compiler. The debug option lets you back trace up to the point where you can identify if the failure occurred in the initialization of MATLAB Runtime, the function call, or the termination routine. This option does not let you debug your MATLAB files with an external debugger.If you set this property to
'off'
, then debug symbols are not included. This is the default option.
Example: 'DebugBuild','on'
Data Types: logical
ExternalEncryptionKey
— Paths to encryption key and loader files
scalar struct
Since R2024b
Paths to the external AES encryption key and MEX key loader files, specified
as a scalar struct with exactly two row char vector or string scalar fields
named EncryptionKeyFile
and
RuntimeKeyLoaderFile
, respectively. File paths can be
relative to the current working directory or absolute.
For C++ shared libraries, as an alternative to specifying both key and MEX
loader at compile time, you can specify only the encryption key and set
RuntimeKeyLoaderFile
as an empty string. You then provide
the hex encoded 64 byte decryption key at runtime in your C++ application as an
argument for the initMATLABLibrary
function using the MATLAB Data API or the <library>InitializeWithKey
function using the MWArray
API.
For example, specify the encryption key as encrypt.key
and
loader file as loader.mexw64
using struct
keyValueStruct
.
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
The encryption key file must be in one of the following supported formats:
Binary 256-bit AES key, with a 32 byte file size
Hex encoded AES key, with a 64 byte file size
The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:
prhs[0]
— Input, char array specified as the static value'get'
prhs[1]
— Input, char array specified as the CTF component UUIDplhs[0]
— Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format
Avoid sharing the same key across multiple CTFs.
Example: 'ExternalEncryptionKey',keyValueStruct
Data Types: struct
Interface
— Interface API
'matlab-data'
(default) | 'mwarray'
Interface API, specified as one of the following options:
'matlab-data'
— Generate shared libraries using the MATLAB Data API.'mwarray'
— Generate shared libraries using themwArray
API.
For more information, see API Selection for C++ Shared Library.
Example: 'Interface','mwarray'
LibraryName
— Name of C++ shared library
character vector | string scalar
Name of the C++ shared library, specified as a character vector or a string
scalar. The default name of the generated library is the first entry of the
FunctionFiles
argument.
Example: 'LibraryName','mymagic'
Data Types: char
| string
ObfuscateArchive
— Flag to obfuscate deployable archive
'off'
(default) | on/off logical value
Flag to obfuscate the deployable archive, specified as 'on'
or 'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to
true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a
logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all.m
files are converted to P-code files before packaging. This option is equivalent to usingmcc
with-j
and-s
specified.If you set this property to
'off'
, then the deployable archive is not obfuscated. This is the default behavior.
Example: 'ObfuscateArchive','on'
Data Types: logical
OutputDir
— Path to output directory
character vector | string scalar
Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
The default name of the build folder is the library name appended with
cppSharedLibrary
.
Example: 'OutputDir','D:\Documents\MATLAB\work\mymagiccppSharedLibrary'
Data Types: char
| string
SampleGenerationFiles
— MATLAB sample files
character vector | string scalar | cell array of character vectors | string array
MATLAB sample files used to generate sample C++ library files for
functions included within the library, specified as a character vector, a string
scalar, a string array, or a cell array of character vectors. Paths can be
relative to the current working directory or absolute. Files must have a
.m
extension. For more information and limitations, see
Sample Driver File Creation.
Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]
Data Types: char
| string
| cell
SecretsManifest
— Path to JSON manifest file
character vector | string scalar
Since R2024b
Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
If your MATLAB code calls the getSecret
, getSecretMetadata
, or isSecret
function, you must specify the secret keys to embed in
the deployable archive in a JSON secret manifest file. If your code calls
getSecret
and you do not specify the
SecretsManifest
option, MATLAB
Compiler™ issues a warning and generates a template JSON file in the output
folder named
.
Modify this file by specifying the secret key names in the Embedded field.<component_name>
_secrets_manifest.json
The setSecret
function is not deployable. To embed secret keys in a
deployable archive, you must call setSecret
in MATLAB before you build the archive.
For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.
Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
Data Types: char
| string
SupportPackages
— Support packages
'autodetect'
(default) | 'none'
| string scalar | cell array of character vectors | string array
Support packages to include, specified as one of the following options:
'autodetect'
(default) — The dependency analysis process detects and includes the required support packages automatically.'none'
— No support packages are included. Using this option can cause runtime errors.A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see
compiler.codetools.deployableSupportPackages
.
Example: 'SupportPackages',{'Deep Learning Toolbox Converter for
TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet
Network'}
Data Types: char
| string
| cell
Verbose
— Flag to control build verbosity
'off'
(default) | on/off logical value
Flag to control build verbosity, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to
true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a
logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then the MATLAB command window displays progress information indicating compiler output during the build process.If you set this property to
'off'
, then the command window does not display progress information.
Example: 'Verbose','on'
Data Types: logical
Output Arguments
results
— Build results
compiler.build.Results
object
Build results, returned as a compiler.build.Results
object. The Results
object contains:
The build type, which is
'cppSharedLibrary'
Paths to the following:
GettingStarted.html
v2
folder (matlab-data
interface only)
(LibraryName
.dllmwArray
interface only)
(LibraryName
.libmwArray
interface only)
(LibraryName
.hmwArray
interface only)
A list of included support packages
Build options, specified as a
CppSharedLibraryOptions
object
Version History
Introduced in R2021a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)