Diagram path. More...

Detailed Description

Diagram path.

This class stores a diagram path, such as a namespace or directory structure.

Definition at line 48 of file path.h.

#include <path.h>

Public Types
using	container_type = std::vector< std::string >

Public Member Functions
	path (path_type pt=path_type::kNamespace)

	path (const std::string &ns, path_type pt=path_type::kNamespace)

virtual	~path ()=default

	path (container_type::const_iterator begin, container_type::const_iterator end, path_type pt=path_type::kNamespace)

	path (const path &right)=default

path &	operator= (const path &right)

	path (path &&right) noexcept=default

path &	operator= (path &&right) noexcept=default

	path (std::initializer_list< std::string > ns, path_type pt=path_type::kNamespace)

	path (const std::vector< std::string > &ns, path_type pt=path_type::kNamespace)

std::string	to_string () const

bool	is_empty () const

bool	is_root () const

void	is_root (bool r)

size_t	size () const

path	operator\| (const path &right) const

void	operator\|= (const path &right)

path	operator\| (const std::string &right) const

void	operator\|= (const std::string &right)

std::string &	operator[] (const unsigned int index)

const std::string &	operator[] (const unsigned int index) const

void	append (const std::string &name)

void	append (const path &ns)

void	pop_back ()

std::optional< path >	parent () const

bool	starts_with (const path &prefix) const

bool	ends_with (const path &suffix) const

path	common_path (const path &right) const
	Returns the common prefix of 2 paths.

path	relative_to (const path &right) const

std::string	relative (const std::string &ns) const

std::string	name () const

path::container_type::iterator	begin ()

path::container_type::iterator	end ()

path::container_type::const_iterator	cbegin () const

path::container_type::const_iterator	cend () const

path::container_type::const_iterator	begin () const

path::container_type::const_iterator	end () const

path_type	type () const

const container_type &	tokens () const

Static Public Member Functions
static container_type	split (const std::string &ns, path_type pt=path_type::kNamespace)

Private Member Functions
const char *	separator () const

Static Private Member Functions
static const char *	separator (path_type pt)

Private Attributes
path_type	path_type_

container_type	path_

bool	is_root_ {false}

Friends
bool	operator== (const path &left, const path &right)

bool	operator< (const path &left, const path &right)

Member Typedef Documentation

◆ container_type

using clanguml::common::model::path::container_type = std::vector<std::string>

Definition at line 81 of file path.h.

Constructor & Destructor Documentation

◆ path() [1/7]

clanguml::common::model::path::path ( path_type pt = path_type::kNamespace )

inline

Definition at line 105 of file path.h.

        : path_type_{pt}
    {
    }

◆ path() [2/7]

clanguml::common::model::path::path	(	const std::string &	ns,
		path_type	pt = `path_type::kNamespace`
	)

inline

Definition at line 110 of file path.h.

        : path_type_{pt}
    {
        if (ns.empty())
            return;
 
        path_ = split(ns, pt);
    }

◆ ~path()

virtual clanguml::common::model::path::~path ( )

virtualdefault

◆ path() [3/7]

clanguml::common::model::path::path	(	container_type::const_iterator	begin,
		container_type::const_iterator	end,
		path_type	pt = `path_type::kNamespace`
	)

inline

Definition at line 121 of file path.h.

        : path(pt)
    {
        if (begin == end)
            return;
 
        std::copy(begin, end, std::back_inserter(path_));
    }

◆ path() [4/7]

clanguml::common::model::path::path ( const path & right )

default

◆ path() [5/7]

clanguml::common::model::path::path ( path && right )

defaultnoexcept

◆ path() [6/7]

clanguml::common::model::path::path	(	std::initializer_list< std::string >	ns,
		path_type	pt = `path_type::kNamespace`
	)

inline

Definition at line 153 of file path.h.

        : path(pt)
    {
        if ((ns.size() == 1) &&
            util::contains(*ns.begin(), std::string{separator()})) {
            path_ = util::split(*ns.begin(), separator());
        }
        else if ((ns.size() == 1) && ns.begin()->empty()) {
        }
        else
            path_ = ns;
    }

◆ path() [7/7]

clanguml::common::model::path::path	(	const std::vector< std::string > &	ns,
		path_type	pt = `path_type::kNamespace`
	)

inlineexplicit

Definition at line 167 of file path.h.

        : path(pt)
    {
        if ((ns.size() == 1) &&
            util::contains(*ns.begin(), std::string{separator()})) {
            path_ = util::split(*ns.begin(), separator());
        }
        else if ((ns.size() == 1) && ns.begin()->empty()) {
        }
        else
            path_ = ns;
    }

Member Function Documentation

◆ append() [1/2]

void clanguml::common::model::path::append ( const path & ns )

inline

Append path to current path.

Parameters

ns	Path to append.

Definition at line 291 of file path.h.

    {
        for (const auto &n : ns) {
            append(n);
        }
    }

◆ append() [2/2]

void clanguml::common::model::path::append ( const std::string & name )

inline

Append path element to path.

Returns: New path.

Definition at line 284 of file path.h.

284{ path_.push_back(name); }

◆ begin() [1/2]

path::container_type::iterator clanguml::common::model::path::begin ( )

inline

Definition at line 424 of file path.h.

424{ return path_.begin(); }

◆ begin() [2/2]

path::container_type::const_iterator clanguml::common::model::path::begin ( ) const

inline

Definition at line 433 of file path.h.

433{ return path_.begin(); }

◆ cbegin()

path::container_type::const_iterator clanguml::common::model::path::cbegin ( ) const

inline

Definition at line 427 of file path.h.

    {
        return path_.cbegin();
    }

◆ cend()

path::container_type::const_iterator clanguml::common::model::path::cend ( ) const

inline

Definition at line 431 of file path.h.

431{ return path_.cend(); }

◆ common_path()

path clanguml::common::model::path::common_path ( const path & right ) const

inline

Returns the common prefix of 2 paths.

If no common prefix exists between 2 paths, the result is an empty path.

Parameters

right Path to compare

Returns: Common path prefix

Definition at line 352 of file path.h.

    {
        path res{};
        for (auto i = 0U; i < std::min(size(), right.size()); i++) {
            if (path_[i] == right[i])
                res |= path_[i];
            else
                break;
        }
        return res;
    }

◆ end() [1/2]

path::container_type::iterator clanguml::common::model::path::end ( )

inline

Definition at line 425 of file path.h.

425{ return path_.end(); }

◆ end() [2/2]

path::container_type::const_iterator clanguml::common::model::path::end ( ) const

inline

Definition at line 434 of file path.h.

434{ return path_.end(); }

◆ ends_with()

bool clanguml::common::model::path::ends_with ( const path & suffix ) const

inline

Returns true if path ends with suffix

Parameters

suffix Path suffix to check

Returns

Definition at line 339 of file path.h.

    {
        return util::ends_with(path_, suffix.path_);
    }

◆ is_empty()

bool clanguml::common::model::path::is_empty ( ) const

inline

Whether the path is empty.

Returns

Definition at line 214 of file path.h.

214{ return path_.empty(); }

◆ is_root() [1/2]

bool clanguml::common::model::path::is_root ( ) const

inline

Definition at line 216 of file path.h.

216{ return is_root_; }

◆ is_root() [2/2]

void clanguml::common::model::path::is_root ( bool r )

inline

Definition at line 218 of file path.h.

    {
        if (type() != path_type::kNamespace)
            return;
        is_root_ = r;
    }

◆ name()

std::string clanguml::common::model::path::name ( ) const

inline

Return the name of the last element in the path.

Returns: Name of the last element in the path.

Definition at line 417 of file path.h.

    {
        assert(size() > 0);
 
        return path_.back();
    }

◆ operator=() [1/2]

path & clanguml::common::model::path::operator= ( const path & right )

inline

Definition at line 134 of file path.h.

    {
        if (&right == this)
            return *this;
 
        if (path_type_ != right.path_type_)
            throw std::runtime_error(
                "Cannot assign a path to a path with another path type.");
 
        path_type_ = right.path_type_;
        path_ = right.path_;
 
        return *this;
    }

◆ operator=() [2/2]

path & clanguml::common::model::path::operator= ( path && right )

defaultnoexcept

◆ operator[]() [1/2]

std::string & clanguml::common::model::path::operator[] ( const unsigned int index )

inline

Definition at line 272 of file path.h.

272{ return path_[index]; }

◆ operator[]() [2/2]

const std::string & clanguml::common::model::path::operator[] ( const unsigned int index ) const

inline

Definition at line 274 of file path.h.

    {
        return path_[index];
    }

◆ operator|() [1/2]

path clanguml::common::model::path::operator| ( const path & right ) const

inline

Append path to path.

Parameters

right Path to append at the end.

Returns: New merged path.

Definition at line 238 of file path.h.

    {
        path res{*this};
        res.path_type_ = right.path_type_;
        res.append(right);
        return res;
    }

◆ operator|() [2/2]

path clanguml::common::model::path::operator| ( const std::string & right ) const

inline

Append path element to path.

Returns: New path.

Definition at line 258 of file path.h.

    {
        path res{*this};
        res.append(right);
        return res;
    }

◆ operator|=() [1/2]

void clanguml::common::model::path::operator|= ( const path & right )

inline

Append path to the current path.

Parameters

right

Definition at line 251 of file path.h.

251{ append(right); }

◆ operator|=() [2/2]

void clanguml::common::model::path::operator|= ( const std::string & right )

inline

Append path element to the current path.

Parameters

right Path element to append.

Definition at line 270 of file path.h.

270{ append(right); }

◆ parent()

std::optional< path > clanguml::common::model::path::parent ( ) const

inline

Get the parent of the last element in the path.

Returns: Path to the parent of the last element, or nullopt.

Definition at line 313 of file path.h.

    {
        if (size() <= 1) {
            return {};
        }
 
        path res{*this};
        res.pop_back();
        return {std::move(res)};
    }

◆ pop_back()

void clanguml::common::model::path::pop_back ( )

inline

Drop the last element of the path.

Definition at line 301 of file path.h.

    {
        if (!path_.empty()) {
            path_.pop_back();
        }
    }

◆ relative()

std::string clanguml::common::model::path::relative ( const std::string & ns ) const

inline

Make path represented as a string relative to the current path.

Parameters

ns	Path to make relative against *this.

Returns: Relative path.

Definition at line 391 of file path.h.

    {
        if (is_empty())
            return ns;
 
        if (ns == to_string())
            return ns;
 
        auto res = ns;
        auto ns_prefix = to_string() + std::string{separator()};
 
        auto it = res.find(ns_prefix);
 
        while (it != std::string::npos) {
            res.erase(it, ns_prefix.size());
            it = res.find(ns_prefix);
        }
 
        return res;
    }

◆ relative_to()

path clanguml::common::model::path::relative_to ( const path & right ) const

inline

Make the current path relative to the other path, if possible.

If not, return the original path.

Parameters

right Parent path

Returns: Path relative to right

Definition at line 372 of file path.h.

    {
        path res{*this};
        res.is_root(true);
 
        if (res.starts_with(right)) {
            util::remove_prefix(res.path_, right.path_);
            res.is_root(false);
        }
 
        return res;
    }

◆ separator() [1/2]

const char * clanguml::common::model::path::separator ( ) const

inlineprivate

Returns the path separator based on the type of the instance path.

Returns: Path separator

Definition at line 78 of file path.h.

78{ return separator(path_type_); }

◆ separator() [2/2]

static const char * clanguml::common::model::path::separator ( path_type pt )

inlinestaticprivate

Returns the path separator based on the path type.

Returns: Path separator

Definition at line 55 of file path.h.

    {
        switch (pt) {
        case path_type::kNamespace:
            return "::";
        case path_type::kModule:
            return ".";
        case path_type::kFilesystem:
#ifdef _WIN32
            return "\\";
#else
            return "/";
#endif
        }
 
        return "::";
    }

◆ size()

size_t clanguml::common::model::path::size ( ) const

inline

Return the number of elements in the path.

Returns: Size of path.

Definition at line 230 of file path.h.

230{ return path_.size(); }

◆ split()

static container_type clanguml::common::model::path::split	(	const std::string &	ns,
		path_type	pt = `path_type::kNamespace`
	)

inlinestatic

Definition at line 83 of file path.h.

    {
        container_type result;
        if (pt == path_type::kModule) {
            auto path_toks = util::split(ns, separator(pt));
            for (const auto &pt : path_toks) {
                const auto subtoks = util::split(pt, ":");
                if (subtoks.size() == 2) {
                    result.push_back(subtoks.at(0));
                    result.push_back(fmt::format(":{}", subtoks.at(1)));
                }
                else
                    result.push_back(subtoks.at(0));
            }
        }
        else
            result = util::split(ns, separator(pt));
 
        return result;
    }

◆ starts_with()

bool clanguml::common::model::path::starts_with ( const path & prefix ) const

inline

Returns true if path starts with specified prefix.

Parameters

prefix Path prefix to check.

Returns

Definition at line 329 of file path.h.

    {
        return util::starts_with(path_, prefix.path_);
    }

◆ to_string()

std::string clanguml::common::model::path::to_string ( ) const

inline

Render the path as string.

Returns: String representation of the path.

Definition at line 197 of file path.h.

    {
        auto result =
            fmt::format("{}", fmt::join(path_, std::string{separator()}));
 
        if (path_type_ == path_type::kModule) {
            util::replace_all(result, ".:", ":");
        }
 
        return result;
    }

◆ tokens()

const container_type & clanguml::common::model::path::tokens ( ) const

inline

Definition at line 443 of file path.h.

443{ return path_; }

◆ type()

path_type clanguml::common::model::path::type ( ) const

inline

Get path type.

Returns: Path type.

Definition at line 441 of file path.h.

441{ return path_type_; }

Friends And Related Symbol Documentation

◆ operator<

bool operator<	(	const path &	left,
		const path &	right
	)

friend

Definition at line 187 of file path.h.

    {
        return left.to_string() < right.to_string();
    }

◆ operator==

bool operator==	(	const path &	left,
		const path &	right
	)

friend

Definition at line 181 of file path.h.

    {
        return (left.is_root() == right.is_root()) &&
            (left.path_ == right.path_);
    }

Member Data Documentation

◆ is_root_

bool clanguml::common::model::path::is_root_ {false}

private

Definition at line 448 of file path.h.

◆ path_

container_type clanguml::common::model::path::path_

private

Definition at line 447 of file path.h.

◆ path_type_

path_type clanguml::common::model::path::path_type_

private

Definition at line 446 of file path.h.

The documentation for this class was generated from the following file:

src/common/model/path.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Member Typedef Documentation

◆ container_type

Constructor & Destructor Documentation

◆ path() [1/7]

◆ path() [2/7]

◆ ~path()

◆ path() [3/7]

◆ path() [4/7]

◆ path() [5/7]

◆ path() [6/7]

◆ path() [7/7]

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ common_path()

◆ end() [1/2]

◆ end() [2/2]

◆ ends_with()

◆ is_empty()

◆ is_root() [1/2]

◆ is_root() [2/2]

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator|() [1/2]

◆ operator|() [2/2]

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ parent()

◆ pop_back()

◆ relative()

◆ relative_to()

◆ separator() [1/2]

◆ separator() [2/2]

◆ size()

◆ split()

◆ starts_with()

◆ to_string()

◆ tokens()

◆ type()

Friends And Related Symbol Documentation

◆ operator<

◆ operator==

Member Data Documentation

◆ is_root_

◆ path_

◆ path_type_