Class representing an include diagram model. More...

Detailed Description

Class representing an include diagram model.

Definition at line 42 of file diagram.h.

#include <diagram.h>

Public Member Functions
	diagram ()=default

	diagram (const diagram &)=delete

	diagram (diagram &&)=default

diagram &	operator= (const diagram &)=delete

diagram &	operator= (diagram &&)=default

common::model::diagram_t	type () const override
	Get the diagram model type - in this case include.

opt_ref< diagram_element >	get (const std::string &full_name) const override
	Search for element in the diagram by fully qualified name.

opt_ref< diagram_element >	get (eid_t id) const override
	Search for element in the diagram by id.

void	add_file (std::unique_ptr< common::model::source_file > &&f)
	Add include diagram element, an include file.

template<typename ElementT >
opt_ref< ElementT >	find (const std::string &name) const
	Find an element in the diagram by name.

template<typename ElementT >
opt_ref< ElementT >	find (eid_t id) const
	Find an element in the diagram by id.

const common::reference_vector< source_file > &	files () const
	Get list of references to files in the diagram model.

opt_ref< diagram_element >	get_with_namespace (const std::string &name, const common::model::namespace_ &ns) const override
	Find diagram element with a specified name and path.

inja::json	context () const override

bool	is_empty () const override
	Check whether the diagram is empty.

void	apply_filter () override

Public Member Functions inherited from clanguml::common::model::diagram
	diagram ()

	diagram (const diagram &)=delete

	diagram (diagram &&) noexcept

diagram &	operator= (const diagram &)=delete

diagram &	operator= (diagram &&) noexcept

virtual	~diagram ()

virtual diagram_t	type () const =0
	Return type of the diagram.

virtual opt_ref< clanguml::common::model::diagram_element >	get (const std::string &full_name) const =0

virtual common::optional_ref< clanguml::common::model::diagram_element >	get (eid_t id) const =0

virtual common::optional_ref< clanguml::common::model::diagram_element >	get_with_namespace (const std::string &name, const namespace_ &ns) const

void	set_name (const std::string &name)

std::string	name () const

void	set_filter (std::unique_ptr< diagram_filter > filter)

const diagram_filter &	filter () const

void	set_complete (bool complete)
	Set diagram in a complete state.

bool	complete () const
	Whether the diagram is complete.

virtual void	finalize ()
	Once the diagram is complete, run any final processing.

bool	should_include (const element &e) const

bool	should_include (const namespace_ &ns) const

bool	should_include (const source_file &path) const

bool	should_include (relationship r) const

bool	should_include (relationship_t r) const

bool	should_include (access_t s) const

bool	should_include (const std::string &s) const =delete

virtual bool	has_element (const eid_t) const

virtual bool	should_include (const namespace_ &ns, const std::string &name) const

virtual inja::json	context () const =0

virtual bool	is_empty () const =0
	Check whether the diagram is empty.

virtual void	apply_filter ()

Public Member Functions inherited from clanguml::common::model::element_view< source_file >
void	add (std::reference_wrapper< source_file > element)
	Add reference to diagram element.

const reference_vector< source_file > &	view () const
	Get collection of reference to diagram elements.

reference_vector< source_file > &	view ()
	Get collection of reference to diagram elements.

common::optional_ref< source_file >	get (eid_t id) const
	Get typed diagram element by id.

bool	is_empty () const
	Check whether the element view is empty.

void	remove (const std::set< eid_t > &element_ids)

Public Member Functions inherited from clanguml::common::model::nested_trait< T, Path >
	nested_trait ()=default

	nested_trait (const nested_trait &)=delete

	nested_trait (nested_trait &&) noexcept=default

nested_trait &	operator= (const nested_trait &)=delete

nested_trait &	operator= (nested_trait &&) noexcept=default

virtual	~nested_trait ()=default

template<typename V = T>
bool	add_element (std::unique_ptr< V > p)

template<typename V = T>
bool	add_element (const Path &path, std::unique_ptr< V > p)

template<typename V = T>
auto	get_element (const Path &path) const

template<typename V = T>
auto	get_element (const std::string &name) const

bool	has_element (const std::string &name) const

template<typename F >
bool	all_of (F &&f) const

bool	is_empty () const

auto	begin ()

auto	end ()

auto	cbegin () const

auto	cend () const

auto	begin () const

auto	end () const

void	print_tree (const int level)

void	remove (const std::set< eid_t > &element_ids)

Constructor & Destructor Documentation

◆ diagram() [1/3]

clanguml::include_diagram::model::diagram::diagram ( )

default

◆ diagram() [2/3]

clanguml::include_diagram::model::diagram::diagram ( const diagram & )

delete

◆ diagram() [3/3]

clanguml::include_diagram::model::diagram::diagram ( diagram && )

default

Member Function Documentation

◆ add_file()

void clanguml::include_diagram::model::diagram::add_file ( std::unique_ptr< common::model::source_file > && f )

Add include diagram element, an include file.

Parameters

f	Include diagram element

Definition at line 44 of file diagram.cc.

{
    // Don't add the same file more than once
    if (find<source_file>(f->id()))
        return;
 
    LOG_DBG("Adding source file: {}, {}", f->name(), f->fs_path().string());
 
    auto &ff = *f;
 
    assert(!ff.name().empty());
    assert(ff.id().value() != 0);
 
    auto p = ff.path();
 
    if (!f->path().is_empty()) {
        // If the parent path is not empty, ensure relative parent directories
        // of this source_file are in the diagram
        common::model::filesystem_path parent_path_so_far{
            common::model::path_type::kFilesystem};
        for (const auto &directory : f->path()) {
            auto source_file_path = parent_path_so_far | directory;
            if (parent_path_so_far.is_empty())
                source_file_path = {directory};
 
            auto dir = std::make_unique<common::model::source_file>(
                std::filesystem::path{source_file_path.to_string()});
            dir->set_type(common::model::source_file_t::kDirectory);
 
            assert(!dir->name().empty());
 
            if (!get_element(source_file_path).has_value()) {
                add_file(std::move(dir));
 
                LOG_DBG("Added directory '{}' at path '{}'", directory,
                    parent_path_so_far.to_string());
            }
 
            parent_path_so_far.append(directory);
        }
    }
 
    assert(p.type() == common::model::path_type::kFilesystem);
 
    if (add_element(p, std::move(f)))
        element_view<source_file>::add(ff);
}

◆ apply_filter()

void clanguml::include_diagram::model::diagram::apply_filter ( )

overridevirtual

Reimplemented from clanguml::common::model::diagram.

Definition at line 136 of file diagram.cc.

{
    // First find all element ids which should be removed
    std::set<eid_t> to_remove;
 
    for (auto &f : element_view<source_file>::view())
        if (f.get().type() != common::model::source_file_t::kDirectory &&
            !filter().should_include(f.get())) {
            to_remove.emplace(f.get().id());
        }
 
    for (auto &sf : element_view<source_file>::view())
        sf.get().apply_filter(filter(), to_remove);
 
    element_view<source_file>::remove(to_remove);
 
    nested_trait_fspath::remove(to_remove);
}

◆ context()

inja::json clanguml::include_diagram::model::diagram::context ( ) const

overridevirtual

Return diagrams JSON context for inja templates.

Returns: JSON context.

Implements clanguml::common::model::diagram.

Definition at line 118 of file diagram.cc.

{
    inja::json ctx;
    ctx["name"] = name();
    ctx["type"] = "include";
 
    inja::json::array_t elements{};
 
    // Add files and directories
    for (const auto &f : files()) {
        elements.emplace_back(f.get().context());
    }
 
    ctx["elements"] = elements;
 
    return ctx;
}

◆ files()

const common::reference_vector< common::model::source_file > & clanguml::include_diagram::model::diagram::files ( ) const

Get list of references to files in the diagram model.

Returns: List of references to concepts in the diagram model.

Definition at line 93 of file diagram.cc.

{
    return element_view<source_file>::view();
}

◆ find() [1/2]

template<typename ElementT >

opt_ref< ElementT > clanguml::include_diagram::model::diagram::find ( const std::string & name ) const

Find an element in the diagram by name.

This method allows for typed search, where the type of searched for element is determined from ElementT.

Template Parameters

ElementT Type of element (e.g. source_file)

Parameters

name	Fully qualified name of the element

Returns: Optional reference to a diagram element

Definition at line 138 of file diagram.h.

{
    // Convert the name to the OS preferred path
    std::filesystem::path namePath{name};
    namePath.make_preferred();
 
    for (const auto &element : element_view<ElementT>::view()) {
        const auto full_name = element.get().full_name(false);
 
        if (full_name == namePath.string()) {
            return {element};
        }
    }
 
    return {};
}

◆ find() [2/2]

template<typename ElementT >

opt_ref< ElementT > clanguml::include_diagram::model::diagram::find ( eid_t id ) const

Find an element in the diagram by id.

This method allows for typed search, where the type of searched for element is determined from ElementT.

Template Parameters

ElementT Type of element (e.g. source_file)

Parameters

id	Id of the element

Returns: Optional reference to a diagram element

Definition at line 155 of file diagram.h.

{
    for (const auto &element : element_view<ElementT>::view()) {
        if (element.get().id() == id) {
            return {element};
        }
    }
 
    return {};
}

◆ get() [1/2]

common::optional_ref< common::model::diagram_element > clanguml::include_diagram::model::diagram::get ( const std::string & full_name ) const

overridevirtual

Search for element in the diagram by fully qualified name.

Parameters

full_name Fully qualified element name.

Returns: Optional reference to a diagram element.

Implements clanguml::common::model::diagram.

Definition at line 32 of file diagram.cc.

{
    return find<source_file>(full_name);
}

◆ get() [2/2]

common::optional_ref< common::model::diagram_element > clanguml::include_diagram::model::diagram::get ( eid_t id ) const

overridevirtual

Search for element in the diagram by id.

Parameters

id	Element id.

Returns: Optional reference to a diagram element.

Implements clanguml::common::model::diagram.

Definition at line 38 of file diagram.cc.

{
    return find<source_file>(id);
}

◆ get_with_namespace()

common::optional_ref< clanguml::common::model::diagram_element > clanguml::include_diagram::model::diagram::get_with_namespace	(	const std::string &	name,
		const common::model::namespace_ &	ns
	)		const

overridevirtual

Find diagram element with a specified name and path.

Parameters

name	Name of the element
ns	Path relative to the diagram

Returns: Optional reference to diagram element, if found.

Reimplemented from clanguml::common::model::diagram.

Definition at line 99 of file diagram.cc.

{
    // Convert to preferred OS path
    std::filesystem::path namePath{name};
    auto namePreferred = namePath.make_preferred().string();
 
    auto element_opt = get(namePreferred);
 
    if (!element_opt) {
        // If no element matches, try to prepend the 'using_namespace'
        // value to the element and search again
        auto fully_qualified_name = ns | namePreferred;
        element_opt = get(fully_qualified_name.to_string());
    }
 
    return element_opt;
}

◆ is_empty()

bool clanguml::include_diagram::model::diagram::is_empty ( ) const

overridevirtual

Check whether the diagram is empty.

Returns: True, if diagram is empty

Implements clanguml::common::model::diagram.

Definition at line 155 of file diagram.cc.

155{ return element_view<source_file>::is_empty(); }

◆ operator=() [1/2]

diagram & clanguml::include_diagram::model::diagram::operator= ( const diagram & )

delete

◆ operator=() [2/2]

diagram & clanguml::include_diagram::model::diagram::operator= ( diagram && )

default

◆ type()

common::model::diagram_t clanguml::include_diagram::model::diagram::type ( ) const

overridevirtual

Get the diagram model type - in this case include.

Returns: Type of include diagram.

Implements clanguml::common::model::diagram.

Definition at line 27 of file diagram.cc.

{
    return common::model::diagram_t::kInclude;
}

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

src/include_diagram/model/diagram.h
src/include_diagram/model/diagram.cc

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ diagram() [1/3]

◆ diagram() [2/3]

◆ diagram() [3/3]

Member Function Documentation

◆ add_file()

◆ apply_filter()

◆ context()

◆ files()

◆ find() [1/2]

◆ find() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ get_with_namespace()

◆ is_empty()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ type()