clanguml::decorators::decorator Struct Reference

Base class for clang-uml comment tags. More...

Detailed Description

Base class for clang-uml comment tags.

This class provides basic interface for clang-uml comment tags, called decorators. All decorators are added to the code using uml Doxygen-style tag.

Definition at line 43 of file decorators.h.

#include <decorators.h>

Public Member Functions
virtual	~decorator ()=default
bool	applies_to_diagram (const std::string &name)
	Check if decorator applies to a specific diagram.

Static Public Member Functions
static std::shared_ptr< decorator >	from_string (std::string_view c)
	Create decorator of specific type based on it's string representation.

Public Attributes
std::vector< std::string >	diagrams

Protected Member Functions
decorator_toks	tokenize (const std::string &label, std::string_view c)

Constructor & Destructor Documentation

~decorator()

virtual clanguml::decorators::decorator::~decorator ( )

virtualdefault

Member Function Documentation

applies_to_diagram()

bool clanguml::decorators::decorator::applies_to_diagram

(

const std::string &

name

)

Check if decorator applies to a specific diagram.

Parameters

name	Name of the diagram

Returns

True, if this decorator applies to diagram name

Definition at line 57 of file decorators.cc.

{
    return diagrams.empty() ||
        (std::find(diagrams.begin(), diagrams.end(), name) != diagrams.end());
}

from_string()

std::shared_ptr< decorator > clanguml::decorators::decorator::from_string ( std::string_view  c )

static

Create decorator of specific type based on it's string representation.

Parameters

c	Decorator string representation extracted from the comment

Returns

Decorator instance

Definition at line 27 of file decorators.cc.

{
    if (c.find(note::label) == 0) {
        return note::from_string(c);
    }
    if (c.find(skip_relationship::label) == 0) {
        return skip_relationship::from_string(c);
    }
    if (c.find(skip::label) == 0) {
        return skip::from_string(c);
    }
    if (c.find(style::label) == 0) {
        return style::from_string(c);
    }
    if (c.find(aggregation::label) == 0) {
        return aggregation::from_string(c);
    }
    if (c.find(composition::label) == 0) {
        return composition::from_string(c);
    }
    if (c.find(association::label) == 0) {
        return association::from_string(c);
    }
    if (c.find(call::label) == 0) {
        return call::from_string(c);
    }
 
    return {};
}

tokenize()

decorator_toks clanguml::decorators::decorator::tokenize ( const std::string &  label, std::string_view  c  )

protected

Definition at line 63 of file decorators.cc.

{
    decorator_toks res;
    res.label = label;
    size_t pos{};
    std::string_view::const_iterator it = c.begin();
    std::advance(it, label.size());
 
    if (*it == ':') {
        std::advance(it, 1);
 
        pos = std::distance(c.begin(), it);
        // If the diagram list is provided after ':', [] is mandatory
        // even if empty
        auto d = c.substr(pos, c.find('[', pos) - pos);
        if (!d.empty()) {
            std::string d_str{d};
            d_str.erase(std::remove_if(d_str.begin(), d_str.end(),
                            static_cast<int (*)(int)>(std::isspace)),
                d_str.end());
            res.diagrams = util::split(d_str, ",");
        }
 
        std::advance(it, d.size());
    }
 
    if (*it == '[') {
        std::advance(it, 1);
 
        pos = std::distance(c.begin(), it);
        res.param = c.substr(pos, c.find(']', pos) - pos);
 
        std::advance(it, res.param.size() + 1);
    }
    else if (std::isspace(*it) != 0) {
        std::advance(it, 1);
    }
 
    pos = std::distance(c.begin(), it);
    res.text = c.substr(pos, c.find('}', pos) - pos);
    res.text = util::trim(res.text);
    res.param = util::trim(res.param);
 
    return res;
}

Member Data Documentation

diagrams

std::vector<std::string> clanguml::decorators::decorator::diagrams

List of diagram names to which a given decorator applies

Definition at line 45 of file decorators.h.

---

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

• src/decorators/decorators.h
• src/decorators/decorators.cc