Module Support CMake APIs

Functions
function	vtk_module_graphviz ()
	Generate graphviz output for a module dependency graph. More...
function	vtk_module_json ()
	JSON metadata representation of modules. More...

Detailed Description

Function Documentation

vtk_module_graphviz()

function vtk_module_graphviz

(

)

Generate graphviz output for a module dependency graph.

Information about the modules built and/or available may be dumped to a Graphviz .dot file.

vtk_module_graphviz(
  MODULES   <module>...
  OUTPUT    <path>
 
  [PRIVATE_DEPENDENCIES <ON|OFF>]
  [KIT_CLUSTERS <ON|OFF>])

• MODULES: (Required) The modules to output information for.
• OUTPUT: (Required) A Graphviz file describing the modules built will be output to this path. Relative paths are rooted to CMAKE_BINARY_DIR.
• PRIVATE_DEPENDENCIES: (Default ON) Whether to draw private dependency edges or not..
• KIT_CLUSTERS: (Default OFF) Whether to draw modules as part of a kit as a cluster or not.

Definition at line 132 of file vtkModuleGraphviz.cmake.

vtk_module_json()

function vtk_module_json

(

)

JSON metadata representation of modules.

Information about the modules built and/or available may be dumped to a JSON file.

vtk_module_json(
  MODULES   <module>...
  OUTPUT    <path>)

• MODULES: (Required) The modules to output information for.
• OUTPUT: (Required) A JSON file describing the modules built will be output to this path. Relative paths are rooted to CMAKE_BINARY_DIR.

Example output:

{
  "modules": [
    {
      "name": "...",
      "library_name": "...",
      "enabled": <bool>,
      "implementable": <bool>,
      "third_party": <bool>,
      "wrap_exclude": <bool>,
      "kit": "...",
      "depends": [
        "..."
      ],
      "optional_depends": [
        "..."
      ],
      "private_depends": [
        "..."
      ],
      "implements": [
        "..."
      ],
      "headers": [
        "..."
      ]
    }
  ],
  "kits": [
    {
      "name": "...",
      "enabled": <bool>,
      "modules": [
      ]
    }
  ]
}

Definition at line 103 of file vtkModuleJson.cmake.