matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
bf29ceb2dffd1129dce05a109a68601c2cb53917
clang-uml/docs/test_cases/t00018.md
Bartek Kryza bf29ceb2df Updated test cases documentation
2023-09-10 12:22:27 +02:00

15 KiB
Raw Blame History

t00018 - Pimpl pattern

Config

compilation_database_dir: ..
output_directory: diagrams
diagrams:
  t00018_class:
    type: class
    glob:
      - ../../tests/t00018/**.cc
    using_namespace:
      - clanguml::t00018
    include:
      namespaces:
        - clanguml::t00018

Source code

File t00018.h

#pragma once

#ifndef _MSC_VER
#include <experimental/propagate_const>
#endif
#include <iostream>
#include <memory>

namespace clanguml {
namespace t00018 {

namespace impl {
class widget;
}

// Pimpl example based on https://en.cppreference.com/w/cpp/language/pimpl
class widget {
    std::unique_ptr<impl::widget> pImpl;

public:
    void draw() const;
    void draw();
    bool shown() const { return true; }
    widget(int);
    ~widget();

    widget(widget &&);

    widget(const widget &) = delete;
    widget &operator=(widget &&);
    widget &operator=(const widget &) = delete;
};
}
}

File t00018_impl.h

#pragma once

#include "t00018.h"

namespace clanguml {
namespace t00018 {
namespace impl {

class widget {
    int n;

public:
    void draw(const clanguml::t00018::widget &w) const;
    void draw(const clanguml::t00018::widget &w);
    widget(int n);
};
}
}
}

File t00018.cc

#include "t00018.h"
#include "t00018_impl.h"

namespace clanguml {
namespace t00018 {

void widget::draw() const { pImpl->draw(*this); }

void widget::draw() { pImpl->draw(*this); }

widget::widget(int n)
    : pImpl{std::make_unique<impl::widget>(n)}
{
}

widget::widget(widget &&) = default;

widget::~widget() = default;

widget &widget::operator=(widget &&) = default;
} // namespace t00018
} // namespace clanguml

File t00018_impl.cc

#include "t00018_impl.h"
#include "t00018.h"

namespace clanguml {
namespace t00018 {
namespace impl {

widget::widget(int n)
    : n(n)
{
}

void widget::draw(const clanguml::t00018::widget &w) const
{
    if (w.shown())
        std::cout << "drawing a const widget " << n << '\n';
}

void widget::draw(const clanguml::t00018::widget &w)
{
    if (w.shown())
        std::cout << "drawing a non-const widget " << n << '\n';
}
} // namespace impl
} // namespace t00018
} // namespace clanguml

Generated PlantUML diagrams

t00018_class

Generated Mermaid diagrams

t00018_class

Generated JSON models

{
  "diagram_type": "class",
  "elements": [
    {
      "bases": [],
      "display_name": "clanguml::t00018::impl::widget",
      "id": "130502639682787993",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [
        {
          "access": "private",
          "is_static": false,
          "name": "n",
          "source_location": {
            "column": 9,
            "file": "../../tests/t00018/t00018_impl.h",
            "line": 10,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "int"
        }
      ],
      "methods": [
        {
          "access": "public",
          "is_const": true,
          "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": "draw",
          "parameters": [
            {
              "name": "w",
              "type": "const clanguml::t00018::widget &"
            }
          ],
          "source_location": {
            "column": 10,
            "file": "../../tests/t00018/t00018_impl.h",
            "line": 13,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "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": "draw",
          "parameters": [
            {
              "name": "w",
              "type": "const clanguml::t00018::widget &"
            }
          ],
          "source_location": {
            "column": 10,
            "file": "../../tests/t00018/t00018_impl.h",
            "line": 14,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": true,
          "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": "widget",
          "parameters": [
            {
              "name": "n",
              "type": "int"
            }
          ],
          "source_location": {
            "column": 5,
            "file": "../../tests/t00018/t00018_impl.h",
            "line": 15,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        }
      ],
      "name": "widget",
      "namespace": "clanguml::t00018::impl",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00018/t00018_impl.h",
        "line": 9,
        "translation_unit": "../../tests/t00018/t00018.cc"
      },
      "template_parameters": [],
      "type": "class"
    },
    {
      "bases": [],
      "display_name": "clanguml::t00018::widget",
      "id": "1005661284373854088",
      "is_abstract": false,
      "is_nested": false,
      "is_struct": false,
      "is_template": false,
      "is_union": false,
      "members": [
        {
          "access": "private",
          "is_static": false,
          "name": "pImpl",
          "source_location": {
            "column": 35,
            "file": "../../tests/t00018/t00018.h",
            "line": 18,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "std::unique_ptr<impl::widget>"
        }
      ],
      "methods": [
        {
          "access": "public",
          "is_const": true,
          "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": "draw",
          "parameters": [],
          "source_location": {
            "column": 10,
            "file": "../../tests/t00018/t00018.h",
            "line": 21,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "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": "draw",
          "parameters": [],
          "source_location": {
            "column": 10,
            "file": "../../tests/t00018/t00018.h",
            "line": 22,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "access": "public",
          "is_const": true,
          "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": "shown",
          "parameters": [],
          "source_location": {
            "column": 10,
            "file": "../../tests/t00018/t00018.h",
            "line": 23,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "bool"
        },
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": true,
          "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": "widget",
          "parameters": [
            {
              "name": "",
              "type": "int"
            }
          ],
          "source_location": {
            "column": 5,
            "file": "../../tests/t00018/t00018.h",
            "line": 24,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "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": "~widget",
          "parameters": [],
          "source_location": {
            "column": 5,
            "file": "../../tests/t00018/t00018.h",
            "line": 25,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": true,
          "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": "widget",
          "parameters": [
            {
              "name": "",
              "type": "widget &&"
            }
          ],
          "source_location": {
            "column": 5,
            "file": "../../tests/t00018/t00018.h",
            "line": 27,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": true,
          "is_copy_assignment": false,
          "is_defaulted": false,
          "is_deleted": true,
          "is_move_assignment": false,
          "is_noexcept": false,
          "is_operator": false,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "widget",
          "parameters": [
            {
              "name": "",
              "type": "const widget &"
            }
          ],
          "source_location": {
            "column": 5,
            "file": "../../tests/t00018/t00018.h",
            "line": 29,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "void"
        },
        {
          "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": true,
          "is_noexcept": false,
          "is_operator": true,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "operator=",
          "parameters": [
            {
              "name": "",
              "type": "widget &&"
            }
          ],
          "source_location": {
            "column": 13,
            "file": "../../tests/t00018/t00018.h",
            "line": 30,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "widget &"
        },
        {
          "access": "public",
          "is_const": false,
          "is_consteval": false,
          "is_constexpr": false,
          "is_constructor": false,
          "is_copy_assignment": true,
          "is_defaulted": false,
          "is_deleted": true,
          "is_move_assignment": false,
          "is_noexcept": false,
          "is_operator": true,
          "is_pure_virtual": false,
          "is_static": false,
          "is_virtual": false,
          "name": "operator=",
          "parameters": [
            {
              "name": "",
              "type": "const widget &"
            }
          ],
          "source_location": {
            "column": 13,
            "file": "../../tests/t00018/t00018.h",
            "line": 31,
            "translation_unit": "../../tests/t00018/t00018.cc"
          },
          "type": "widget &"
        }
      ],
      "name": "widget",
      "namespace": "clanguml::t00018",
      "source_location": {
        "column": 7,
        "file": "../../tests/t00018/t00018.h",
        "line": 17,
        "translation_unit": "../../tests/t00018/t00018.cc"
      },
      "template_parameters": [],
      "type": "class"
    }
  ],
  "metadata": {
    "clang_uml_version": "0.3.9-11-g4a19c8b",
    "llvm_version": "Ubuntu clang version 16.0.1 (++20230328073357+42d1b276f779-1~exp1~20230328073502.65)",
    "schema_version": 1
  },
  "name": "t00018_class",
  "relationships": [
    {
      "access": "public",
      "destination": "1005661284373854088",
      "source": "130502639682787993",
      "type": "dependency"
    },
    {
      "access": "private",
      "destination": "130502639682787993",
      "label": "pImpl",
      "source": "1005661284373854088",
      "type": "aggregation"
    }
  ],
  "using_namespace": "clanguml::t00018"
}
Reference in New Issue View Git Blame Copy Permalink