Cmake Add_executable

Contents

  1. Sets the CMAKECXXSTANDARD variable to the value of 14, as we selected when creating the project. Addexecutable(cmaketestapp main.cpp) Adds the cmaketestapp executable target which will be built from main.cpp.
  2. See the cmake-buildsystem(7) manual for more on defining buildsystem properties. Instead other targets created by addlibrary or addexecutable may reference the objects using an expression of the form $ as a source, where objlib is the object library name.

CMake and a compatible build tool for building the project. Compatible build tools include Make, Ninja, and others - see CMake Generators for more information. See Supported Platforms for more information about platforms compatible with GoogleTest. If you don’t already have CMake installed, see the CMake installation guide. To specify an executable target that must be built, we must use the addexecutable CMake function. Addexecutable(myProgram src/main.cpp src/somefile.cpp src/anotherfile.cpp) This will build a target executable called myProgram which is built from 3 source files: src/main.cpp, src/somefile.cpp and src/anotherfile.cpp. Library Targets.

Add a library to the project using the specified source files.

Adds a library target called <name> to be built from the source fileslisted in the command invocation. The <name>corresponds to the logical target name and must be globally unique withina project. The actual file name of the library built is constructed basedon conventions of the native platform (such as lib<name>.a or<name>.lib).

New in version 3.1: Source arguments to add_library may use 'generator expressions' withthe syntax $<..>. See the cmake-generator-expressions(7)manual for available expressions.

New in version 3.11: The source files can be omitted if they are added later usingtarget_sources().

STATIC, SHARED, or MODULE may be given to specify the type oflibrary to be created. STATIC libraries are archives of object filesfor use when linking other targets. SHARED libraries are linkeddynamically and loaded at runtime. MODULE libraries are plugins thatare not linked into other targets but may be loaded dynamically at runtimeusing dlopen-like functionality. If no type is given explicitly thetype is STATIC or SHARED based on whether the current value of thevariable BUILD_SHARED_LIBS is ON. For SHARED andMODULE libraries the POSITION_INDEPENDENT_CODE targetproperty is set to ON automatically.A SHARED library may be marked with the FRAMEWORKtarget property to create an macOS Framework.

New in version 3.8: A STATIC library may be marked with the FRAMEWORKtarget property to create a static Framework.

If a library does not export any symbols, it must not be declared as aSHARED library. For example, a Windows resource DLL or a managed C++/CLIDLL that exports no unmanaged symbols would need to be a MODULE library.This is because CMake expects a SHARED library to always have anassociated import library on Windows.

By default the library file will be created in the build tree directorycorresponding to the source tree directory in which the command wasinvoked. See documentation of the ARCHIVE_OUTPUT_DIRECTORY,LIBRARY_OUTPUT_DIRECTORY, andRUNTIME_OUTPUT_DIRECTORY target properties to change thislocation. See documentation of the OUTPUT_NAME targetproperty to change the <name> part of the final file name.

If EXCLUDE_FROM_ALL is given the corresponding property will be set onthe created target. See documentation of the EXCLUDE_FROM_ALLtarget property for details.

See the cmake-buildsystem(7) manual for more on definingbuildsystem properties.

See also HEADER_FILE_ONLY on what to do if some sources arepre-processed, and you want to have the original sources reachable fromwithin IDE.

Creates an Object Library. An object librarycompiles source files but does not archive or link their object files into alibrary. Instead other targets created by add_library() oradd_executable() may reference the objects using an expression of theform $<TARGET_OBJECTS:objlib> as a source, where objlib is theobject library name. For example:

Bien nacido vineyard map

will include objlib's object files in a library and an executablealong with those compiled from their own sources. Object librariesmay contain only sources that compile, header files, and other filesthat would not affect linking of a normal library (e.g. .txt).They may contain custom commands generating such sources, but notPRE_BUILD, PRE_LINK, or POST_BUILD commands. Some native buildsystems (such as Xcode) may not like targets that have only object files, soconsider adding at least one real source file to any target that references$<TARGET_OBJECTS:objlib>.

New in version 3.12: Object libraries can be linked to with target_link_libraries().

Creates an Interface Library.An INTERFACE library target does not compile sources and doesnot produce a library artifact on disk. However, it may haveproperties set on it and it may be installed and exported.Typically, INTERFACE_* properties are populated on an interfacetarget using the commands:

  • set_property(),

  • target_link_libraries(INTERFACE),

  • target_link_options(INTERFACE),

  • target_include_directories(INTERFACE),

  • target_compile_options(INTERFACE),

  • target_compile_definitions(INTERFACE), and

  • target_sources(INTERFACE),

Cmake Add_executable Depends

and then it is used as an argument to target_link_libraries()like any other target.

An interface library created with the above signature has no source filesitself and is not included as a target in the generated buildsystem.

New in version 3.15: An interface library can have PUBLIC_HEADER andPRIVATE_HEADER properties. The headers specified by thoseproperties can be installed using the install(TARGETS) command.

New in version 3.19: An interface library target may be created with source files:

Source files may be listed directly in the add_library call or addedlater by calls to target_sources() with the PRIVATE orPUBLIC keywords.

If an interface library has source files (i.e. the SOURCEStarget property is set), it will appear in the generated buildsystemas a build target much like a target defined by theadd_custom_target() command. It does not compile any sources,but does contain build rules for custom commands created by theadd_custom_command() command.

Note

Cmake Add_executable All Files

In most command signatures where the INTERFACE keyword appears,the items listed after it only become part of that target's usagerequirements and are not part of the target's own settings. However,in this signature of add_library, the INTERFACE keyword refersto the library type only. Sources listed after it in the add_librarycall are PRIVATE to the interface library and do not appear in itsINTERFACE_SOURCES target property.

Creates an IMPORTED library target called <name>.No rules are generated to build it, and the IMPORTED targetproperty is True. The target name has scope in the directory in whichit is created and below, but the GLOBAL option extends visibility.It may be referenced like any target built within the project.IMPORTED libraries are useful for convenient reference from commandslike target_link_libraries(). Details about the imported libraryare specified by setting properties whose names begin in IMPORTED_ andINTERFACE_.

The <type> must be one of:

Cmake add_executable static
STATIC, SHARED, MODULE, UNKNOWN

References a library file located outside the project. TheIMPORTED_LOCATION target property (or its per-configurationvariant '>IMPORTED_LOCATION_<CONFIG>) specifies thelocation of the main library file on disk:

  • For a SHARED library on most non-Windows platforms, the main libraryfile is the .so or .dylib file used by both linkers and dynamicloaders. If the referenced library file has a SONAME (or on macOS,has a LC_ID_DYLIB starting in @rpath/), the value of that fieldshould be set in the IMPORTED_SONAME target property.If the referenced library file does not have a SONAME, but theplatform supports it, then the IMPORTED_NO_SONAME targetproperty should be set.

  • For a SHARED library on Windows, the IMPORTED_IMPLIBtarget property (or its per-configuration variant'>IMPORTED_IMPLIB_<CONFIG>) specifies the location of theDLL import library file (.lib or .dll.a) on disk, and theIMPORTED_LOCATION is the location of the .dll runtimelibrary (and is optional).

Additional usage requirements may be specified in INTERFACE_* properties.

CmakeCmake add source file

An UNKNOWN library type is typically only used in the implementation ofFind Modules. It allows the path to an imported library (often foundusing the find_library() command) to be used without having to knowwhat type of library it is. This is especially useful on Windows where astatic library and a DLL's import library both have the same file extension.

OBJECT

References a set of object files located outside the project.The IMPORTED_OBJECTS target property (or its per-configurationvariant '>IMPORTED_OBJECTS_<CONFIG>) specifies the locations ofobject files on disk.Additional usage requirements may be specified in INTERFACE_* properties.

INTERFACE

Does not reference any library or object files on disk, but mayspecify usage requirements in INTERFACE_* properties.

Cmake add dependency

See documentation of the IMPORTED_* and INTERFACE_* propertiesfor more information.

Creates an Alias Target, such that <name> can beused to refer to <target> in subsequent commands. The <name> doesnot appear in the generated buildsystem as a make target. The <target>may not be an ALIAS.

New in version 3.11: An ALIAS can target a GLOBALImported Target

New in version 3.18: An ALIAS can target a non-GLOBAL Imported Target. Such alias isscoped to the directory in which it is created and below.The ALIAS_GLOBAL target property can be used to check if thealias is global or not.

ALIAS targets can be used as linkable targets and as targets toread properties from. They can also be tested for existence with theregular if(TARGET) subcommand. The <name> may not be usedto modify properties of <target>, that is, it may not be used as theoperand of set_property(), set_target_properties(),target_link_libraries() etc. An ALIAS target may not beinstalled or exported.

Contents

Cmake

Add an executable to the project using the specified source files.

Cmake Add_executable Vs Add_library

Adds an executable target called <name> to be built from the sourcefiles listed in the command invocation. The<name> corresponds to the logical target name and must be globallyunique within a project. The actual file name of the executable built isconstructed based on conventions of the native platform (such as<name>.exe or just <name>).

New in version 3.1: Source arguments to add_executable may use 'generator expressions' withthe syntax $<..>. See the cmake-generator-expressions(7)manual for available expressions.

New in version 3.11: The source files can be omitted if they are added later usingtarget_sources().

By default the executable file will be created in the build treedirectory corresponding to the source tree directory in which thecommand was invoked. See documentation of theRUNTIME_OUTPUT_DIRECTORY target property to change thislocation. See documentation of the OUTPUT_NAME target propertyto change the <name> part of the final file name.

If WIN32 is given the property WIN32_EXECUTABLE will beset on the target created. See documentation of that target property fordetails.

If MACOSX_BUNDLE is given the corresponding property will be set onthe created target. See documentation of the MACOSX_BUNDLEtarget property for details.

If EXCLUDE_FROM_ALL is given the corresponding property will be set onthe created target. See documentation of the EXCLUDE_FROM_ALLtarget property for details.

See the cmake-buildsystem(7) manual for more on definingbuildsystem properties.

See also HEADER_FILE_ONLY on what to do if some sources arepre-processed, and you want to have the original sources reachable fromwithin IDE.

An IMPORTED executable target references anexecutable file located outside the project. No rules are generated tobuild it, and the IMPORTED target property is True. Thetarget name has scope in the directory in which it is created and below, butthe GLOBAL option extends visibility. It may be referenced like anytarget built within the project. IMPORTED executables are usefulfor convenient reference from commands like add_custom_command().Details about the imported executable are specified by setting propertieswhose names begin in IMPORTED_. The most important such property isIMPORTED_LOCATION (and its per-configuration version'>IMPORTED_LOCATION_<CONFIG>) which specifies the location ofthe main executable file on disk. See documentation of the IMPORTED_*properties for more information.

Creates an Alias Target, such that <name> canbe used to refer to <target> in subsequent commands. The <name>does not appear in the generated buildsystem as a make target. The<target> may not be an ALIAS.

Cmake Add_executable Library

New in version 3.11: An ALIAS can target a GLOBALImported Target

New in version 3.18: An ALIAS can target a non-GLOBAL Imported Target. Such alias isscoped to the directory in which it is created and subdirectories.The ALIAS_GLOBAL target property can be used to check if thealias is global or not.

ALIAS targets can be used as targets to read propertiesfrom, executables for custom commands and custom targets. They can also betested for existence with the regular if(TARGET) subcommand.The <name> may not be used to modify properties of <target>, thatis, it may not be used as the operand of set_property(),set_target_properties(), target_link_libraries() etc.An ALIAS target may not be installed or exported.