Module scripting

Source

Modules§

block
break
cmake_host_system_information
cmake_language
cmake_minimum_required
cmake_parse_arguments
cmake_path
cmake_policy
configure_file
continue
else
elseif
endblock
endforeach
endfunction
endif
endmacro
endwhile
execute_process
file
find_file
find_library
find_package
find_path
find_program
foreach
function
get_cmake_property
get_directory_property
get_filename_component
get_property
if
include
include_guard
list
macro
mark_as_advanced
math
message
option
return
separate_arguments
set
set_directory_properties
set_property
site_name
string
unset
variable_watch
while

Structs§

Block
Evaluate a group of commands with a dedicated variable and/or policy scope.
Break
Break from an enclosing foreach or while loop.
CMakeHostSystemInformation
Query various host system information.
CMakeMinimumRequired
Require a minimum version of cmake.
ConfigureFile
Copy a file to another location and modify its contents.
Continue
Continue to the top of enclosing foreach or while loop.
Else
Starts the else portion of an if block.
ElseIf
Starts an elseif portion of an if block.
EndBlock
Ends a list of commands in a block() and removes the scopes created by the block() command.
EndForEach
Ends a list of commands in a foreach block.
EndFunction
Ends a list of commands in a function block.
EndIf
Ends a list of commands in an if block.
EndMacro
Ends a list of commands in a macro block.
EndWhile
Ends a list of commands in a while block.
ExecuteProcess
Execute one or more child processes.
Function
Start recording a function for later invocation as a command.
GetCMakeProperty
Get a global property of the CMake instance.
GetDirectoryProperty
Get a property of DIRECTORY scope.
GetFilenameComponent
Get a specific component of a full filename.
GetProperty
Get a property.
If
Conditionally execute a group of commands.
Include
Load and run CMake code from a file or module.
IncludeGuard
Provides an include guard for the file currently being processed by CMake.
Macro
Start recording a macro for later invocation as a command
MarkAsAdvanced
Mark cmake cached variables as advanced.
Math
Evaluate a mathematical expression.
Option
Provide a boolean option that the user can optionally select.
Return
Return from a file, directory or function.
SeparateArguments
Parse command-line arguments into a semicolon-separated list.
SetDirectoryProperties
Set properties of the current directory and subdirectories.
SetProperty
Set a named property in a given scope.
SiteName
Set the given variable to the name of the computer.
Unset
Unset a variable, cache variable, or environment variable.
VariableWatch
Watch the CMake variable for change.
While
Evaluate a group of commands while a condition is true

Enums§

CMakeLanguage
Call meta-operations on CMake commands.
CMakeParseArguments
Parse function or macro arguments.
CMakePath
This command is for the manipulation of paths.
CMakePolicy
Manage CMake Policy settings.
File
File manipulation command.
FindFile
This command is used to find a full path to named file.
FindLibrary
This command is used to find a library.
FindPackage
Find a package
FindPath
This command is used to find a directory containing the named file.
FindProgram
This command is used to find a program.
ForEach
Evaluate a group of commands for each value in a list.
List
List operations.
Message
Log a message.
Set
Set a normal, cache, or environment variable to a given value.
String
String operations.