clang-uml/docs/test_cases/t00034.md

t00034 - Template metaprogramming type function test case

Config

compilation_database_dir: ..
output_directory: puml
diagrams:
  t00034_class:
    type: class
    glob:
      - ../../tests/t00034/t00034.cc
    using_namespace:
      - clanguml::t00034
    include:
      namespaces:
        - clanguml::t00034
    plantuml:
      after:
        - "@A(R) --> @A(A) : +la"

Source code

File t00034.cc

#include <type_traits>

namespace clanguml {
//
// Based on https://github.com/facebook/folly/blob/master/folly/Unit.h
//
namespace t00034 {

struct Void {
    constexpr bool operator==(const Void & /* unused */) const { return true; }
    constexpr bool operator!=(const Void & /* unused */) const { return false; }
};

constexpr Void void_t{};

template <typename T> struct lift_void {
    using type = T;
};

template <> struct lift_void<void> {
    using type = Void;
};

//
// TODO: This is a shortcoming of libclang which parses the type of lift_void_t
// alias as unexposed, i.e. no actual reference to T can be inferred without
// manually parsing the string 'typename lift_void<T>::type'
// For now, this test validates that the visitor does not crash, the reference
// between R and A has to be provided in the configuration file
//
template <typename T> using lift_void_t = typename lift_void<T>::type;

template <typename T> struct drop_void {
    using type = T;
};

template <> struct drop_void<Void> {
    using type = void;
};

template <typename T> using drop_void_t = typename drop_void<T>::type;

struct A { };

struct R {
    lift_void_t<A> *la;
    lift_void_t<void> *lv;
};

} // namespace t00034
} // namespace clanguml

Generated UML diagrams

Generated JSON models

{
  "diagram_type": "class",
  "elements": [
    {
      "bases": [],
      "display_name": "clanguml::t00034::Void",
      "id": "1704456490210873213",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [
        {
          "access": "public",
          "is_const": true,
          "is_defaulted": false,
          "is_implicit": false,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "operator==",
          "parameters": [
            {
              "name": "",
              "type": "const clanguml::t00034::Void &"
            }
          ],
          "type": "bool"
        },
        {
          "access": "public",
          "is_const": true,
          "is_defaulted": false,
          "is_implicit": false,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "operator!=",
          "parameters": [
            {
              "name": "",
              "type": "const clanguml::t00034::Void &"
            }
          ],
          "type": "bool"
        }
      ],
      "name": "Void",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 9
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::lift_void<T>",
      "id": "867472442996685316",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": true,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "lift_void",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 16
      },
      "template_parameters": [
        {
          "is_variadic": false,
          "kind": "template_type",
          "name": "T",
          "template_parameters": []
        }
      ],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::lift_void<void>",
      "id": "126450862226197239",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": true,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "lift_void",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 20
      },
      "template_parameters": [
        {
          "is_variadic": false,
          "kind": "argument",
          "template_parameters": [],
          "type": "void"
        }
      ],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::drop_void<T>",
      "id": "1578745816100337706",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": true,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "drop_void",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 33
      },
      "template_parameters": [
        {
          "is_variadic": false,
          "kind": "template_type",
          "name": "T",
          "template_parameters": []
        }
      ],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::drop_void<clanguml::t00034::Void>",
      "id": "1849836134504075115",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": true,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "drop_void",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 37
      },
      "template_parameters": [
        {
          "is_variadic": false,
          "kind": "argument",
          "template_parameters": [],
          "type": "clanguml::t00034::Void"
        }
      ],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::A",
      "id": "1383912907884688827",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "A",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 43
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00034::R",
      "id": "1713991735741265309",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": true,
      "is_template": false,
      "is_union": false,
      "members": [
        {
          "access": "public",
          "is_static": false,
          "name": "la",
          "source_location": {
            "file": "../../tests/t00034/t00034.cc",
            "line": 46
          },
          "type": "lift_void_t<clanguml::t00034::A> *"
        },
        {
          "access": "public",
          "is_static": false,
          "name": "lv",
          "source_location": {
            "file": "../../tests/t00034/t00034.cc",
            "line": 47
          },
          "type": "lift_void_t<void> *"
        }
      ],
      "methods": [],
      "name": "R",
      "namespace": "clanguml::t00034",
      "source_location": {
        "file": "../../tests/t00034/t00034.cc",
        "line": 45
      },
      "template_parameters": [],
      "type": "class"
    }
  ],
  "metadata": {
    "clang_uml_version": "0.3.4-21-g665c784",
    "llvm_version": "Ubuntu clang version 15.0.6",
    "schema_version": 1
  },
  "name": "t00034_class",
  "relationships": [
    {
      "access": "public",
      "destination": "867472442996685316",
      "source": "126450862226197239",
      "type": "instantiation"
    },
    {
      "access": "public",
      "destination": "1704456490210873213",
      "source": "1849836134504075115",
      "type": "dependency"
    },
    {
      "access": "public",
      "destination": "1578745816100337706",
      "source": "1849836134504075115",
      "type": "instantiation"
    },
    {
      "access": "public",
      "destination": "1383912907884688827",
      "label": "la",
      "source": "1713991735741265309",
      "type": "association"
    }
  ],
  "using_namespace": "clanguml::t00034"
}