VTK
9.0.1
|
Functions | |
macro | _vtk_module_parse_module_args (name_output) |
Parse vtk.module file contents More... | |
macro | _vtk_module_parse_kit_args (name_output) |
Parse vtk.kit file contents More... | |
function | _vtk_module_verify_enable_value (var) |
Verify enable values More... | |
function | _vtk_module_target_function (prefix) |
Generate arguments for target function wrappers More... | |
function | _vtk_module_standard_includes () |
Add "standard" include directories to a module More... | |
function | _vtk_module_default_export_macro_prefix (varname) |
Determine the default export macro for a module More... | |
function | _vtk_module_write_wrap_hierarchy () |
Generate the hierarchy for a module More... | |
function | _vtk_module_add_header_tests () |
Add header tests for a module More... | |
function | _vtk_module_mark_third_party (target) |
Mark a module as being third party More... | |
function | _vtk_module_graphviz_module_node (var, module) |
Output a node in the graph More... | |
macro | _vtk_json_bool (output, name, cond) |
Output a boolean to JSON More... | |
macro | _vtk_json_string_list (output, name, var) |
Output a string list to JSON More... | |
function | _vtk_module_wrap_java_sources (module, sources, java_sources) |
Generate sources for using a module's classes from Java More... | |
function | _vtk_module_wrap_java_library (name) |
Generate a JNI library for a set of modules More... | |
function | _vtk_module_wrap_python_sources (module, sources, classes) |
Generate sources for using a module's classes from Python More... | |
function | _vtk_module_wrap_python_library (name) |
Generate a CPython library for a set of modules More... | |
macro _vtk_module_parse_module_args | ( | name_output | ) |
Parse vtk.module
file contents
This macro places all vtk.module
keyword "arguments" into the caller's scope prefixed with the value of name_output
which is set to the NAME
of the module.
For example, this vtk.module
file:
called with _vtk_module_parse_module_args(name ...)
will set the following variables in the calling scope:
name
: Namespace::Target
Namespace::Target_LIBRARY_NAME
: nsTarget
With namespace support for module names, the variable should instead be referenced via ${${name}_LIBRARY_NAME}
instead.
Definition at line 251 of file vtkModule.cmake.
macro _vtk_module_parse_kit_args | ( | name_output | ) |
Parse vtk.kit
file contents
Just like _vtk_module_parse_module_args, but for kits.
Definition at line 332 of file vtkModule.cmake.
function _vtk_module_verify_enable_value | ( | var | ) |
Verify enable values
Verifies that the variable named as the first parameter is a valid enable status
value.
Definition at line 411 of file vtkModule.cmake.
function _vtk_module_target_function | ( | prefix | ) |
Generate arguments for target function wrappers
Create the INTERFACE
, PUBLIC
, and PRIVATE
arguments for a function wrapping CMake's target_
functions to call the wrapped function.
This is necessary because not all of the functions support empty lists given a keyword.
Definition at line 1335 of file vtkModule.cmake.
function _vtk_module_standard_includes | ( | ) |
Add "standard" include directories to a module
Add the "standard" includes for a module to its interface. These are the source and build directories for the module itself. They are always either PUBLIC
or INTERFACE
(depending on the module's target type).
Definition at line 2684 of file vtkModule.cmake.
function _vtk_module_default_export_macro_prefix | ( | varname | ) |
Determine the default export macro for a module
Determines the export macro to be used for a module from its metadata. Assumes it is called from within a vtk_module_build call.
Definition at line 2741 of file vtkModule.cmake.
function _vtk_module_write_wrap_hierarchy | ( | ) |
Generate the hierarchy for a module
Write wrap hierarchy files for the module currently being built. This also installs the hierarchy file for use by dependent projects if INSTALL_HEADERS
is set.
Definition at line 2980 of file vtkModule.cmake.
function _vtk_module_add_header_tests | ( | ) |
Add header tests for a module
vtkModuleTesting.cmake
. Each module would then need to manually call this function. It currently assumes it is in VTK itself.Definition at line 3660 of file vtkModule.cmake.
function _vtk_module_mark_third_party | ( | target | ) |
Mark a module as being third party
Mark a module as being a third party module.
Definition at line 4593 of file vtkModule.cmake.
function _vtk_module_graphviz_module_node | ( | var | , |
module | |||
) |
Output a node in the graph
Queries the properties for modules and generates the node for it in the graph and its outgoing dependency edges.
Definition at line 8 of file vtkModuleGraphviz.cmake.
macro _vtk_json_bool | ( | output | , |
name | , | ||
cond | |||
) |
Output a boolean to JSON
Appends a condition as a JSON boolean with the given dictionary key name to the given string variable.
Definition at line 12 of file vtkModuleJson.cmake.
macro _vtk_json_string_list | ( | output | , |
name | , | ||
var | |||
) |
Output a string list to JSON
Appends a variable as a JSON list of strings with the given dictionary key name to the given string variable.
Definition at line 33 of file vtkModuleJson.cmake.
function _vtk_module_wrap_java_sources | ( | module | , |
sources | , | ||
java_sources | |||
) |
Generate sources for using a module's classes from Java
This function generates the wrapped sources for a module. It places the list of generated source files and Java source files in variables named in the second and third arguments, respectively.
Definition at line 22 of file vtkModuleWrapJava.cmake.
function _vtk_module_wrap_java_library | ( | name | ) |
Generate a JNI library for a set of modules
A single JNI library may consist of the Java wrappings of multiple modules. This is useful for kit-based builds where the modules part of the same kit belong to the same JNI library as well.
The first argument is the name of the JNI library. The remaining arguments are modules to include in the JNI library.
The remaining information it uses is assumed to be provided by the vtk_module_wrap_java function.
Definition at line 188 of file vtkModuleWrapJava.cmake.
function _vtk_module_wrap_python_sources | ( | module | , |
sources | , | ||
classes | |||
) |
Generate sources for using a module's classes from Python
This function generates the wrapped sources for a module. It places the list of generated source files and classes in variables named in the second and third arguments, respectively.
Definition at line 105 of file vtkModuleWrapPython.cmake.
function _vtk_module_wrap_python_library | ( | name | ) |
Generate a CPython library for a set of modules
A Python module library may consist of the Python wrappings of multiple modules. This is useful for kit-based builds where the modules part of the same kit belong to the same Python module as well.
The first argument is the name of the Python module. The remaining arguments are modules to include in the Python module.
The remaining information it uses is assumed to be provided by the vtk_module_wrap_python function.
Definition at line 237 of file vtkModuleWrapPython.cmake.