clanguml::decorators Namespace Reference

Classes
struct	aggregation
	Make a member an aggregation relationship. More...
struct	association
	Make a member an association relationship. More...
struct	call
	Represents a call message in sequence diagram. More...
struct	composition
	Make a member a composition relationship. More...
struct	decorator
	Base class for clang-uml comment tags. More...
struct	decorator_toks
struct	note
	Represents a note diagram element. More...
struct	relationship
	Base class for decorators overriding default relationship types. More...
struct	skip
	Whether a decorated element should be skipped from a diagram. More...
struct	skip_relationship
	Whether a decorated relationships should be skipped from a diagram. More...
struct	style
	Apply specific style to a decorated diagram element. More...

Functions
std::pair< std::vector< std::shared_ptr< decorator > >, std::string >	parse (std::string documentation_block, const std::string &clanguml_tag="uml")
	Parse a documentation block and extract all clang-uml decorators.

Function Documentation

parse()

std::pair< std::vector< std::shared_ptr< decorator > >, std::string > clanguml::decorators::parse	(	std::string	documentation_block,
		const std::string &	clanguml_tag = "uml"
	)

Parse a documentation block and extract all clang-uml decorators.

Parameters

documentation_block	Documentation block extracted from source code
clanguml_tag	Name of the clanguml tag (default uml)

Returns

Pair of: a list of clang-uml decorators extracted from comment and a comment stripped of any uml directives

Definition at line 190 of file decorators.cc.

{
    std::vector<std::shared_ptr<decorator>> res;
    std::string stripped_comment;
 
    const std::string begin_tag{"@" + clanguml_tag};
    const auto begin_tag_size = begin_tag.size();
 
    // First replace all \uml occurences with @uml
    util::replace_all(
        documentation_block, "\\" + clanguml_tag, "@" + clanguml_tag);
    documentation_block = util::trim(documentation_block);
 
    const std::string_view block_view{documentation_block};
 
    auto pos = block_view.find("@" + clanguml_tag + "{");
 
    if (pos == std::string::npos) {
        // This comment had no uml directives
        return {{}, util::trim(documentation_block)};
    }
 
    size_t last_end_pos{0};
    while (pos < documentation_block.size()) {
        auto c_begin = pos + begin_tag_size;
        auto c_end = block_view.find('}', c_begin);
 
        if (c_end == std::string::npos) {
            return {res, util::trim(stripped_comment)};
        }
 
        auto com =
            decorator::from_string(block_view.substr(c_begin + 1, c_end - 2));
 
        if (com)
            res.emplace_back(std::move(com));
 
        const auto in_between_length = pos - last_end_pos;
        stripped_comment += block_view.substr(last_end_pos, in_between_length);
 
        last_end_pos = pos + (c_end - c_begin + begin_tag_size + 1);
 
        pos = block_view.find("@" + clanguml_tag + "{", c_end);
    }
 
    return {res, util::trim(stripped_comment)};
};