DuneUtilities
-------------

Utility functions used by multiple files.

.. cmake:command:: dune_module_to_uppercase

  Convert a module name into an uppercase string.

  .. code-block:: cmake

    dune_module_to_uppercase(<upper> <module>)

  Convert a module name given by ``<module>`` parameter into an uppercase
  string stored in the output variable ``<upper>`` where all dashes ``-``
  are replaced by underscores ``_``.

  Example: ``dune-common -> DUNE_COMMON``


.. cmake:command:: dune_module_to_macro

  Convert a module name into a capitalized string.

  .. code-block:: cmake

    dune_module_to_macro(<macroname> <module>)

  Convert a module name given by ``<module>`` into a string stored in the
  output variable ``<macroname>`` where all dashes ``-`` are removed and the
  first letter and all letters following a dash are capitalized.

  Example: ``dune-grid-howto -> DuneGridHowto``

.. cmake:command:: dune_deprecate_variable

  Writes a deprecation message on a variable read access. This is intended to be
  called by ``variable_watch(....)``.

  .. code-block:: cmake

    variable_watch(<deprecared-variable> dune_deprecate_variable)

  .. dune:internal::

.. cmake:command:: dune_deprecate_ALL_DEPENDENCIES

  Internal helper around :cmake:command:`dune_deprecate_variable()` used for
  the transitional handling of ``ALL_DEPENDENCIES``.

  .. dune:internal::
  .. deprecated:: 2.10
     Internal compatibility helper for deprecated ``ALL_DEPENDENCIES`` usage.

  .. code-block:: cmake

    variable_watch(ALL_DEPENDENCIES dune_deprecate_ALL_DEPENDENCIES)