BuildDictionary

ROOT

Module defining the function build_dictionary() to generate a ROOT dictionary from a selection XML (classes_def.xml).

See also

ROOT Home Page

CetRootCint

Building a ROOT dictionary from a Linkdef.h file.

build_dictionary

Generate and build a ROOT dictionary module from either:

  • a selection XML file (classes_def.xml), optionally checking

versions and checksums for selected classes; or

build_dictionary([<name>] [<options>])

Options

CCV_ENVIRONMENT <var>=<val>...

List of environment settings to pass to checkClassVersion(1).

CLASSES_DEF_XML <filepath>

The name and location of the selection XML file to be used (default: ${CMAKE_CURRENT_SOURCE_DIR}/classes_def.xml).

Deprecated since version 3.23.00: use SOURCE <filepath> instead.

CLASSES_H <filepath>

The name and location of the top-level C++ header file to be read (default: ${CMAKE_CURRENT_SOURCE_DIR}/classes.h).

Deprecated since version 3.23.00: use SOURCE <filepath> instead.

COMPILE_FLAGS <flag>...

Extra compilation options.

DICTIONARY_LIBRARIES <library-dependency>...

Libraries to which to link the dictionary plugin.

DICT_NAME_VAR <var>

Variable in which to store the dictionary’s name (useful when generated).

EXPORT_SET <export-name>

Add the library to the <export-name> export set.

GENERATED_SOURCE_FILENAME <filename>

Use <filename> for the generated source (default <lib-target>.cpp).

LIB_TARGET <target>

The name of the library target intended to contain the object code resulting from the compilation of the generated dictionary source. Defaults to <generated-dictionary-name>_dict if not specified.

See also

<name>.

LIB_TARGET_VAR <var>

Variable in which to store the name of the library target to which the generated dictionary source will be added (useful when generated).

MODULEMAP_INSTALL_DIR

Installation location for the (possibly composite) module.modulemap file if present (default ${CETMODULES_CURRENT_PROJECT_NAME}_INCLUDE_DIR).

NOP

Option / argument disambiguator; no other function.

NO_CHECK_CLASS_VERSION

Do not run checkClassVersion(1) to verify class checksums and version numbers.

NO_EXPORT

Do not export the generated plugin.

NO_INSTALL

Do not install the generated plugin.

NO_LIBRARY

Generate the C++ code, but do not compile it into a shared library (implies NO_CHECK_CLASS_VERSION).

[NO_]RECURSIVE

Specify whether checkClassVersion(1) should check for the presence and validity of class dictionaries recursively (default determined by check_class_version()).

REQUIRED_DICTIONARIES <dictionary-dependency>...

Deprecated since version 3.23.00: remove.

SOURCE <filepath> ...

Pass <filepath> to rootcint. The location of non-absolute sources will be calculated relative to CMAKE_CURRENT_SOURCE_DIR. Valid sources are header files, optionally preceded by precisely one XML selection file (e.g. classes_def.xml).

USE_PRODUCT_NAME

Deprecated since version 2.0: use USE_PROJECT_NAME instead.

USE_PROJECT_NAME

New in version 3.23.00.

The project name will be prepended to the plugin library name, separated by _

VERBOSE

Increase the verbosity of the dictionary generation command; equivalent to VERBOSITY 4.

VERBOSITY <n>

Set the verbosity of the dictionary generation (default 2).

Non-option arguments

<name>

The desired name of the dictionary (will be modified by USE_PROJECT_NAME if present). If not specified, it will be generated from the current source directory’s path relative to the project’s top level directory via cet_package_path().

Notes

See also

cet_make_library(), check_class_version()