clang-uml/docs/test_cases/t00045.md

t00045 - Test case for root namespace handling

Config

compilation_database_dir: ..
output_directory: puml
diagrams:
  t00045_class:
    type: class
    glob:
      - ../../tests/t00045/t00045.cc
    exclude:
      namespaces:
        - std

Source code

File t00045.cc

class A { };

class AA { };

class AAA { };

template <typename T> class AAAA {
    T t;
};

namespace ns1 {

class A { };

namespace ns2 {

class A { };

class B : public A { };

class C : public ns1::A { };

class D : public ns1::ns2::A { };

class E : public ::A { };

class AAA { };

class R {
public:
    A *a;
    ns1::A *ns1_a;
    ns1::ns2::A *ns1_ns2_a;
    ::A *root_a;

    friend ::AAA;
    // TODO:
    // template<typename T> friend class ::AAAA;

    void foo(::AA &aa) { (void)aa; }
};
} // namespace ns2
} // namespace ns1

Generated UML diagrams

Generated JSON models

{
  "diagram_type": "class",
  "elements": [
    {
      "bases": [],
      "display_name": "A",
      "id": "864916647665253425",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "A",
      "namespace": "",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 1,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "AA",
      "id": "386872828559902182",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "AA",
      "namespace": "",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 3,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "AAA",
      "id": "54164402597771463",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "AAA",
      "namespace": "",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 5,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "AAAA<T>",
      "id": "375905626569465019",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": true,
      "is_union": false,
      "members": [
        {
          "access": "private",
          "is_static": false,
          "name": "t",
          "source_location": {
            "column": 7,
            "file": "../../tests/t00045/t00045.cc",
            "line": 8,
            "translation_unit": "../../tests/t00045/t00045.cc"
          },
          "type": "T"
        }
      ],
      "methods": [],
      "name": "AAAA",
      "namespace": "",
      "source_location": {
        "column": 29,
        "file": "../../tests/t00045/t00045.cc",
        "line": 7,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [
        {
          "is_variadic": false,
          "kind": "template_type",
          "name": "T",
          "template_parameters": []
        }
      ],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "ns1::A",
      "id": "619642232943663499",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "A",
      "namespace": "ns1",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 13,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "ns1::ns2::A",
      "id": "2207007194029669343",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "A",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 17,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [
        {
          "access": "public",
          "id": "2207007194029669343",
          "is_virtual": false,
          "name": "ns1::ns2::A"
        }
      ],
      "display_name": "ns1::ns2::B",
      "id": "204051985124373077",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "B",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 19,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [
        {
          "access": "public",
          "id": "619642232943663499",
          "is_virtual": false,
          "name": "ns1::A"
        }
      ],
      "display_name": "ns1::ns2::C",
      "id": "1837009554564742531",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "C",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 21,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [
        {
          "access": "public",
          "id": "2207007194029669343",
          "is_virtual": false,
          "name": "ns1::ns2::A"
        }
      ],
      "display_name": "ns1::ns2::D",
      "id": "2029929560931799980",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "D",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 23,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [
        {
          "access": "public",
          "id": "864916647665253425",
          "is_virtual": false,
          "name": "A"
        }
      ],
      "display_name": "ns1::ns2::E",
      "id": "2305358535757579772",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "E",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 25,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "ns1::ns2::AAA",
      "id": "1731264248793686366",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [],
      "methods": [],
      "name": "AAA",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 27,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "ns1::ns2::R",
      "id": "974430595320588991",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [
        {
          "access": "public",
          "is_static": false,
          "name": "a",
          "source_location": {
            "column": 8,
            "file": "../../tests/t00045/t00045.cc",
            "line": 31,
            "translation_unit": "../../tests/t00045/t00045.cc"
          },
          "type": "A *"
        },
        {
          "access": "public",
          "is_static": false,
          "name": "ns1_a",
          "source_location": {
            "column": 13,
            "file": "../../tests/t00045/t00045.cc",
            "line": 32,
            "translation_unit": "../../tests/t00045/t00045.cc"
          },
          "type": "ns1::A *"
        },
        {
          "access": "public",
          "is_static": false,
          "name": "ns1_ns2_a",
          "source_location": {
            "column": 18,
            "file": "../../tests/t00045/t00045.cc",
            "line": 33,
            "translation_unit": "../../tests/t00045/t00045.cc"
          },
          "type": "ns1::ns2::A *"
        },
        {
          "access": "public",
          "is_static": false,
          "name": "root_a",
          "source_location": {
            "column": 10,
            "file": "../../tests/t00045/t00045.cc",
            "line": 34,
            "translation_unit": "../../tests/t00045/t00045.cc"
          },
          "type": "::A *"
        }
      ],
      "methods": [
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": false,
          "is_copy_assignment": false,
          "is_defaulted": false,
          "is_deleted": false,
          "is_move_assignment": false,
          "is_noexcept": false,
          "is_operator": false,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "foo",
          "parameters": [
            {
              "name": "aa",
              "type": "::AA &"
            }
          ],
          "type": "void"
        }
      ],
      "name": "R",
      "namespace": "ns1::ns2",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00045/t00045.cc",
        "line": 29,
        "translation_unit": "../../tests/t00045/t00045.cc"
      },
      "template_parameters": [],
      "type": "class"
    }
  ],
  "metadata": {
    "clang_uml_version": "0.3.7-4-g43cc5cb",
    "llvm_version": "Ubuntu clang version 16.0.1 (++20230328073357+42d1b276f779-1~exp1~20230328073502.65)",
    "schema_version": 1
  },
  "name": "t00045_class",
  "relationships": [
    {
      "access": "public",
      "destination": "2207007194029669343",
      "source": "204051985124373077",
      "type": "extension"
    },
    {
      "access": "public",
      "destination": "619642232943663499",
      "source": "1837009554564742531",
      "type": "extension"
    },
    {
      "access": "public",
      "destination": "2207007194029669343",
      "source": "2029929560931799980",
      "type": "extension"
    },
    {
      "access": "public",
      "destination": "864916647665253425",
      "source": "2305358535757579772",
      "type": "extension"
    },
    {
      "access": "public",
      "destination": "386872828559902182",
      "source": "974430595320588991",
      "type": "dependency"
    },
    {
      "access": "public",
      "destination": "2207007194029669343",
      "label": "a",
      "source": "974430595320588991",
      "type": "association"
    },
    {
      "access": "public",
      "destination": "619642232943663499",
      "label": "ns1_a",
      "source": "974430595320588991",
      "type": "association"
    },
    {
      "access": "public",
      "destination": "2207007194029669343",
      "label": "ns1_ns2_a",
      "source": "974430595320588991",
      "type": "association"
    },
    {
      "access": "public",
      "destination": "864916647665253425",
      "label": "root_a",
      "source": "974430595320588991",
      "type": "association"
    },
    {
      "access": "public",
      "destination": "54164402597771463",
      "label": "<<friend>>",
      "source": "974430595320588991",
      "type": "friendship"
    }
  ]
}