clanguml::common::model::paths_filter Struct Reference

Detailed Description

Match elements based on their source location, whether it matches to a specified file paths.

Definition at line 709 of file diagram_filter.h.

#include <diagram_filter.h>

Public Member Functions
	paths_filter (filter_t type, const std::vector< std::string > &p, const std::filesystem::path &root)
	~paths_filter () override=default
tvl::value_t	match (const diagram &d, const common::model::source_file &r) const override
tvl::value_t	match (const diagram &d, const common::model::source_location &sl) const override
tvl::value_t	match (const diagram &d, const common::model::element &e) 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)
Public Member Functions inherited from clanguml::util::memoized< std::filesystem::path, bool, std::filesystem::path >
auto	memoize (bool is_complete, F &&f, Args... args) const
void	invalidate (Args... args) const

Private Attributes
std::vector< std::filesystem::path >	paths_
std::filesystem::path	root_

Additional Inherited Members
Public Types inherited from clanguml::util::memoized< std::filesystem::path, bool, std::filesystem::path >
using	key_t = std::tuple< Args... >
using	value_t = bool

Constructor & Destructor Documentation

paths_filter()

clanguml::common::model::paths_filter::paths_filter	(	filter_t	type,
		const std::vector< std::string > &	p,
		const std::filesystem::path &	root
	)

Definition at line 1171 of file diagram_filter.cc.

    : filter_visitor{type}
    , root_{root}
{
    for (const auto &path : p) {
        std::filesystem::path absolute_path;
 
        if (path.empty() || path == ".")
            absolute_path = root;
        else if (std::filesystem::path{path}.is_relative())
            absolute_path = root / path;
        else
            absolute_path = path;
 
        bool match_successful{false};
        for (auto &resolved_glob_path :
            glob::glob(absolute_path.string(), true)) {
            try {
                auto resolved_absolute_path = absolute(resolved_glob_path);
                resolved_absolute_path =
                    canonical(resolved_absolute_path.lexically_normal());
 
                resolved_absolute_path.make_preferred();
 
                LOG_DBG("Added path {} to paths_filter",
                    resolved_absolute_path.string());
 
                paths_.emplace_back(std::move(resolved_absolute_path));
 
                match_successful = true;
            }
            catch (std::filesystem::filesystem_error &e) {
                LOG_WARN("Cannot add non-existent path {} to "
                         "paths filter",
                    absolute_path.string());
                continue;
            }
        }
 
        if (!match_successful)
            LOG_WARN("Paths filter pattern '{}' did not match "
                     "any files relative to '{}'",
                path, root_.string());
    }
}

~paths_filter()

clanguml::common::model::paths_filter::~paths_filter ( )

overridedefault

Member Function Documentation

match() [1/3]

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

overridevirtual

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

Definition at line 1296 of file diagram_filter.cc.

{
    return match(d, dynamic_cast<const common::model::source_location &>(e));
}

match() [2/3]

tvl::value_t clanguml::common::model::paths_filter::match ( const diagram &  d, const common::model::source_file &  r  ) const

overridevirtual

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

Definition at line 1218 of file diagram_filter.cc.

{
    if (paths_.empty()) {
        return {};
    }
 
    // Matching source paths doesn't make sense if they are not absolute
    if (!p.is_absolute()) {
        return {};
    }
 
    const auto source_file_path = p.fs_path(root_);
 
    auto res = memoize(
        true,
        [this](const std::filesystem::path &sfp) {
            return std::any_of(
                paths_.begin(), paths_.end(), [&](const auto &path) {
                    return sfp.root_name().string() ==
                        path.root_name().string() &&
                        util::is_relative_to(
                            sfp.relative_path(), path.relative_path());
                });
        },
        source_file_path);
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE("Source file {} [{}] rejected by paths_filter",
            p.full_name(false), source_file_path.string());
    }
 
    if ((type() == filter_t::kInclusive && tvl::is_true(res)) ||
        (type() == filter_t::kExclusive && tvl::is_false(res))) {
        LOG_TRACE("Source file {} [{}] accepted by paths_filter",
            p.full_name(false), source_file_path.string());
    }
 
    return res;
}

match() [3/3]

tvl::value_t clanguml::common::model::paths_filter::match ( const diagram &  d, const common::model::source_location &  sl  ) const

overridevirtual

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

Definition at line 1260 of file diagram_filter.cc.

{
    if (paths_.empty()) {
        return {};
    }
 
    const auto source_location_path = std::filesystem::path{p.file()};
 
    // Matching source paths doesn't make sense if they are not absolute or
    // empty
    if (p.file().empty() || source_location_path.is_relative()) {
        return {};
    }
 
    auto res = memoize(
        true,
        [this](const std::filesystem::path &p) {
            return std::any_of(
                paths_.begin(), paths_.end(), [&](const auto &path) {
                    return p.root_name().string() ==
                        path.root_name().string() &&
                        util::is_relative_to(
                            p.relative_path(), path.relative_path());
                });
        },
        source_location_path);
 
    if ((type() == filter_t::kInclusive && tvl::is_false(res)) ||
        (type() == filter_t::kExclusive && tvl::is_true(res))) {
        LOG_TRACE("Source location {} rejected by paths_filter", p.file());
    }
 
    return res;
}

Member Data Documentation

paths_

std::vector<std::filesystem::path> clanguml::common::model::paths_filter::paths_

private

Definition at line 727 of file diagram_filter.h.

root_

std::filesystem::path clanguml::common::model::paths_filter::root_

private

Definition at line 728 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