clanguml::common::model::element_filter Struct Reference

Detailed Description

Match element's name to a set of names or regex patterns.

Definition at line 267 of file diagram_filter.h.

#include <diagram_filter.h>

Public Member Functions
	element_filter (filter_t type, std::vector< config::element_filter_t > elements)
	~element_filter () override=default
tvl::value_t	match (const diagram &d, const element &e) const override
tvl::value_t	match (const diagram &d, const class_diagram::model::class_method &m) const override
tvl::value_t	match (const diagram &d, const class_diagram::model::class_member &m) const override
tvl::value_t	match (const diagram &d, const class_diagram::model::objc_method &m) const override
tvl::value_t	match (const diagram &d, const class_diagram::model::objc_member &m) const override
tvl::value_t	match (const diagram &d, const sequence_diagram::model::participant &p) const override
Public Member Functions inherited from clanguml::common::model::filter_visitor
	filter_visitor (filter_t type)
virtual	~filter_visitor ()=default
virtual tvl::value_t	match (const diagram &d, const common::model::element &e) const
virtual tvl::value_t	match (const diagram &d, const common::model::relationship &r) const
virtual tvl::value_t	match (const diagram &d, const common::model::relationship_t &r) const
virtual tvl::value_t	match (const diagram &d, const common::model::access_t &a) const
virtual tvl::value_t	match (const diagram &d, const common::model::namespace_ &ns) const
virtual tvl::value_t	match (const diagram &d, const common::model::source_file &f) const
virtual tvl::value_t	match (const diagram &d, const common::model::source_location &f) const
virtual tvl::value_t	match (const diagram &d, const class_diagram::model::class_method &m) const
virtual tvl::value_t	match (const diagram &d, const class_diagram::model::class_member &m) const
virtual tvl::value_t	match (const diagram &d, const class_diagram::model::objc_method &m) const
virtual tvl::value_t	match (const diagram &d, const class_diagram::model::objc_member &m) const
virtual tvl::value_t	match (const diagram &d, const sequence_diagram::model::participant &p) const
bool	is_inclusive () const
bool	is_exclusive () const
filter_t	type () const
filter_mode_t	mode () const
void	set_mode (filter_mode_t mode)

Private Attributes
std::vector< config::element_filter_t >	elements_

Constructor & Destructor Documentation

element_filter()

clanguml::common::model::element_filter::element_filter	(	filter_t	type,
		std::vector< config::element_filter_t >	elements
	)

Definition at line 480 of file diagram_filter.cc.

    : filter_visitor{type}
    , elements_{std::move(elements)}
{
}

~element_filter()

clanguml::common::model::element_filter::~element_filter ( )

overridedefault

Member Function Documentation

match() [1/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const class_diagram::model::class_member &  m  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 535 of file diagram_filter.cc.

{
    auto res = tvl::any_of(elements_.begin(), elements_.end(),
        [&m](const auto &ef) -> tvl::value_t {
            // Apply this filter only if it had `member` type, do not apply
            // `any` filters to methods for backward compatibility
            if (ef.type != config::element_filter_t::filtered_type::member)
                return {};
 
            return ef.name == m.qualified_name();
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE(
            "Class member {} rejected by element_filter", m.qualified_name());
    }
 
    return res;
}

match() [2/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const class_diagram::model::class_method &  m  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 513 of file diagram_filter.cc.

{
    auto res = tvl::any_of(elements_.begin(), elements_.end(),
        [&m](const auto &ef) -> tvl::value_t {
            // Apply this filter only if it had `method` type, do not apply
            // `any` filters to methods for backward compatibility
            if (ef.type != config::element_filter_t::filtered_type::method)
                return {};
 
            return ef.name == m.qualified_name();
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE(
            "Class method {} rejected by element_filter", m.display_name());
    }
 
    return res;
}

match() [3/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const class_diagram::model::objc_member &  m  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 579 of file diagram_filter.cc.

{
    auto res = tvl::any_of(elements_.begin(), elements_.end(),
        [&m](const auto &ef) -> tvl::value_t {
            // Apply this filter only if it had `method` type, do not apply
            // `any` filters to methods for backward compatibility
            if (ef.type != config::element_filter_t::filtered_type::objc_member)
                return {};
 
            return ef.name == m.qualified_name();
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE(
            "ObjC member {} rejected by element_filter", m.qualified_name());
    }
 
    return res;
}

match() [4/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const class_diagram::model::objc_method &  m  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 557 of file diagram_filter.cc.

{
    auto res = tvl::any_of(elements_.begin(), elements_.end(),
        [&m](const auto &ef) -> tvl::value_t {
            // Apply this filter only if it had `objc_method` type, do not apply
            // `any` filters to methods for backward compatibility
            if (ef.type != config::element_filter_t::filtered_type::objc_method)
                return {};
 
            return ef.name == m.qualified_name();
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE(
            "ObjC method {} rejected by element_filter", m.qualified_name());
    }
 
    return res;
}

match() [5/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const element &  e  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 487 of file diagram_filter.cc.

{
    // Do not apply element filter to packages in class diagrams
    if (d.type() == diagram_t::kClass && e.type_name() == "package")
        return std::nullopt;
 
    auto res =
        tvl::any_of(elements_.begin(), elements_.end(), [&e](const auto &el) {
            // First check if elements type matches the filter
            if ((el.type != config::element_filter_t::filtered_type::any) &&
                (config::to_string(el.type) != e.type_name())) {
                return false;
            }
 
            return ((el.name == e.full_name(false)) ||
                (el.name == fmt::format("::{}", e.full_name(false))));
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE("Element {} rejected by element_filter", e.full_name(false));
    }
 
    return res;
}

match() [6/6]

tvl::value_t clanguml::common::model::element_filter::match ( const diagram &  d, const sequence_diagram::model::participant &  p  ) const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 601 of file diagram_filter.cc.

{
    using sequence_diagram::model::method;
    using sequence_diagram::model::participant;
 
    if (d.type() != diagram_t::kSequence)
        return {};
 
    const auto &sequence_model =
        dynamic_cast<const sequence_diagram::model::diagram &>(d);
    auto res = tvl::any_of(elements_.begin(), elements_.end(),
        [&sequence_model, &p](const auto &el) {
            // First check if elements type matches the filter
            if (el.type != config::element_filter_t::filtered_type::any &&
                config::to_string(el.type) != p.type_name()) {
                return false;
            }
 
            if (p.type_name() == "method") {
                const auto &m = dynamic_cast<const method &>(p);
                const auto class_id = m.class_id();
                const auto &class_participant =
                    sequence_model.get_participant<participant>(class_id)
                        .value();
 
                return (el.name == p.name_and_ns()) ||
                    (el.name == p.full_name(false)) ||
                    (el.name == class_participant.full_name(false));
            }
 
            if (p.type_name() == "objc_method") {
                const auto &m =
                    dynamic_cast<const sequence_diagram::model::objc_method &>(
                        p);
                const auto class_id = m.class_id();
                const auto &class_participant =
                    sequence_model.get_participant<participant>(class_id)
                        .value();
 
                return (el.name == p.name_and_ns()) ||
                    (el.name == p.full_name(false)) ||
                    (el.name == class_participant.full_name(false));
            }
 
            return el.name == p.full_name(false);
        });
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE(
            "Participant {} rejected by element_filter", p.full_name(false));
    }
 
    return res;
}

Member Data Documentation

elements_

std::vector<config::element_filter_t> clanguml::common::model::element_filter::elements_

private

Definition at line 291 of file diagram_filter.h.

---

The documentation for this struct was generated from the following files:

• src/common/model/filters/diagram_filter.h
• src/common/model/filters/diagram_filter.cc