Main Content

compiler.build.CppSharedLibraryOptions

Options for building C++ shared libraries

Since R2021a

collapse all in page

    Syntax

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles)
    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles,Name,Value)

    Description

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles) creates a C++ shared library options object using the MATLAB® files FunctionFiles. Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function.

    example

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles,Name,Value) creates a CppSharedLibraryOptions object with options specified using one or more name-value arguments. Options include the library name, output directory, and additional files to include.

    example

    Examples

    collapse all

    Create a CppSharedLibraryOptions object using file input.

    For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

    appFile = which('magicsquare.m');
opts = compiler.build.CppSharedLibraryOptions(appFile)
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
           LibraryVersion: ''
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquarecppSharedLibrary'

    You can modify the property values of an existing CppSharedLibraryOptions object using dot notation. For example, enable verbose output.

    opts.Verbose = 'on';

    Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function to build a C++ shared library.

    buildResults = compiler.build.cppSharedLibrary(opts);

    Create a CppSharedLibraryOptions object and customize it using name-value arguments.

    For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler. Use name-value arguments to specify the output directory and disable automatic detection of data files.

    appFile = which('magicsquare.m');
opts = compiler.build.CppSharedLibraryOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\MagicSquareLib', ...
'AutoDetectDataFiles','off')
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
           LibraryVersion: ''
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

    You can modify the property values of an existing CppSharedLibraryOptions object using dot notation. For example, enable verbose output.

    opts.Verbose = 'on';

    Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function to build a C++ shared library.

    buildResults = compiler.build.cppSharedLibrary(opts);

    Input Arguments

    collapse all

    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

    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'

    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

    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 as load and fopen) 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 the AdditionalFiles property.

    Example: 'AutoDetectDataFiles','off'

    Data Types: logical

    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 causes mbuild 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

    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 UUID

    • plhs[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 API, specified as one of the following options:

    • 'matlab-data' — Generate shared libraries using the MATLAB Data API.

    • 'mwarray' — Generate shared libraries using the mwArray API.

    For more information, see API Selection for C++ Shared Library.

    Example: 'Interface','mwarray'

    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

    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 using mcc 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

    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

    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

    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 <component_name>_secrets_manifest.json. Modify this file by specifying the secret key names in the Embedded field.

    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

    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

    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

    collapse all

    C++ library build options, returned as a CppSharedLibraryOptions object.

    Version History

    Introduced in R2021a

    See Also