singleton class that owns the list of all sections More...

#include <src/section.h>

Inheritance diagram for SectionManager:

Collaboration diagram for SectionManager:

Public Member Functions
SectionInfo *	add (const SectionInfo &si)
	Add a new section given the data of an existing section.

SectionInfo *	add (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
	Add a new section Return a non-owning pointer to the newly added section.

SectionInfo *	replace (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
	Replace an existing section with a new one Return a non-owning pointer to the newly added section.

Public Member Functions inherited from LinkedMap< SectionInfo >
const SectionInfo *	find (const std::string &key) const
	Find an object given the key.

const SectionInfo *	find (const QCString &key) const
	Find an object given the key.

const SectionInfo *	find (const char *key) const
	Find an object given the key.

SectionInfo *	find (const char *key)
	A non-const wrapper for find() const.

SectionInfo *	find (const QCString &key)
	A non-const wrapper for find() const.

SectionInfo *	find (const std::string &key)
	A non-const wrapper for find() const.

SectionInfo *	add (const char *k, Args &&... args)
	Adds a new object to the ordered vector if it was not added already.

SectionInfo *	add (const QCString &k, Args &&... args)

SectionInfo *	add (const char *k, Ptr &&ptr)
	Adds an existing object to the ordered vector (unless another object was already added under the same key).

SectionInfo *	add (const QCString &k, Ptr &&ptr)

SectionInfo *	prepend (const char *k, Args &&... args)
	Prepends a new object to the ordered vector if it was not added already.

SectionInfo *	prepend (const QCString &key, Args &&... args)

bool	del (const QCString &key)
	Removes an object from the container and deletes it.

Ptr &	operator[] (size_t pos)

const Ptr &	operator[] (size_t pos) const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

bool	empty () const

size_t	size () const

void	clear ()

Static Public Member Functions
static SectionManager &	instance ()
	returns a reference to the singleton

Private Member Functions
	SectionManager ()=default

	~SectionManager ()=default

Additional Inherited Members
Public Types inherited from LinkedMap< SectionInfo >
using	Ptr

using	Vec

using	iterator

using	const_iterator

using	reverse_iterator

using	const_reverse_iterator

Detailed Description

singleton class that owns the list of all sections

Definition at line 133 of file section.h.

Constructor & Destructor Documentation

◆ SectionManager()

SectionManager::SectionManager ( )

privatedefault

Referenced by instance(), and ~SectionManager().

◆ ~SectionManager()

SectionManager::~SectionManager ( )

privatedefault

References SectionManager().

Member Function Documentation

◆ add() [1/2]

SectionInfo * SectionManager::add	(	const QCString &	label,
		const QCString &	fileName,
		int	lineNr,
		const QCString &	title,
		SectionType	type,
		int	level,
		const QCString &	ref = QCString() )

inline

Add a new section Return a non-owning pointer to the newly added section.

Definition at line 146 of file section.h.

    {
      return LinkedMap<SectionInfo>::add(label.data(),fileName,lineNr,title,type,level,ref);
    }

References LinkedMap< T, Hash, KeyEqual, Map >::add(), and QCString::data().

◆ add() [2/2]

SectionInfo * SectionManager::add ( const SectionInfo & si )

inline

Add a new section given the data of an existing section.

Returns a non-owning pointer to the newly added section.

Definition at line 138 of file section.h.

    {
      return LinkedMap<SectionInfo>::add(si.label(),si.fileName(),
                      si.lineNr(),si.title(),si.type(),si.level(),si.ref());
    }

References LinkedMap< T, Hash, KeyEqual, Map >::add(), SectionInfo::fileName(), SectionInfo::label(), SectionInfo::level(), SectionInfo::lineNr(), SectionInfo::ref(), SectionInfo::title(), and SectionInfo::type().

Referenced by addAnchor(), anonymous_namespace{tagreader.cpp}::TagFileParser::addDocAnchors(), addRelatedPage(), addSection(), DefinitionImpl::addSectionsToDefinition(), addXRefItem(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), and findMainPage().

◆ instance()

static SectionManager & SectionManager::instance ( )

inlinestatic

returns a reference to the singleton

Definition at line 175 of file section.h.

    {
      static SectionManager sm;
      return sm;
    }

References SectionManager().

Referenced by addAnchor(), anonymous_namespace{tagreader.cpp}::TagFileParser::addDocAnchors(), addRelatedPage(), addSection(), DefinitionImpl::addSectionsToDefinition(), addXRefItem(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), cleanUpDoxygen(), clearAll(), createJavaScriptSearchIndex(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), findMainPage(), PerlModGenerator::generatePerlModForPage(), generateSqlite3ForPage(), generateXMLForPage(), DocRoot::parse(), DocSecRefItem::parse(), DocSection::parse(), printSectionsTree(), processSection(), resolveLink(), resolveUserReferences(), PageDefImpl::writeDocumentation(), writeGroupTreeNode(), GroupDefImpl::writePageDocumentation(), and PageDefImpl::writePageDocumentation().

◆ replace()

SectionInfo * SectionManager::replace	(	const QCString &	label,
		const QCString &	fileName,
		int	lineNr,
		const QCString &	title,
		SectionType	type,
		int	level,
		const QCString &	ref = QCString() )

inline

Replace an existing section with a new one Return a non-owning pointer to the newly added section.

Definition at line 154 of file section.h.

    {
      SectionInfo *si = LinkedMap<SectionInfo>::find(label.data());
      if (si)
      {
        si->setFileName(fileName);
        si->setLineNr(lineNr);
        si->setTitle(title);
        si->setType(type);
        si->setLevel(level);
        si->setReference(ref);
        return si;
      }
      else
      {
        return LinkedMap<SectionInfo>::add(label.data(),fileName,lineNr,title,type,level,ref);
      }
    }

References LinkedMap< T, Hash, KeyEqual, Map >::add(), QCString::data(), LinkedMap< T, Hash, KeyEqual, Map >::find(), SectionInfo::setFileName(), SectionInfo::setLevel(), SectionInfo::setLineNr(), SectionInfo::setReference(), SectionInfo::setTitle(), and SectionInfo::setType().

Referenced by addAnchor(), anonymous_namespace{tagreader.cpp}::TagFileParser::addDocAnchors(), addRelatedPage(), addSection(), addXRefItem(), and findMainPage().

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

src/section.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SectionManager()

◆ ~SectionManager()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ instance()

◆ replace()