Container class representing a vector of objects with keys. 更多...

#include <linkedmap.h>

类 LinkedMap< T, Hash, KeyEqual, Map > 继承关系图:

Public 类型
using	Ptr = std::unique_ptr< T >

using	Vec = std::vector< Ptr >

using	iterator = typename Vec::iterator

using	const_iterator = typename Vec::const_iterator

using	reverse_iterator = typename Vec::reverse_iterator

using	const_reverse_iterator = typename Vec::const_reverse_iterator

Public 成员函数
const T *	find (const std::string &key) const
	Find an object given the key. 更多...

const T *	find (const QCString &key) const
	Find an object given the key. 更多...

const T *	find (const char *key) const
	Find an object given the key. 更多...

T *	find (const char *key)
	A non-const wrapper for find() const 更多...

T *	find (const QCString &key)
	A non-const wrapper for find() const 更多...

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

template<class... Args>
T *	add (const char *k, Args &&... args)
	Adds a new object to the ordered vector if it was not added already. 更多...

template<class... Args>
T *	add (const QCString &k, Args &&... args)

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

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

template<class... Args>
T *	prepend (const char *k, Args &&... args)
	Prepends a new object to the ordered vector if it was not added already. 更多...

template<class... Args>
T *	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 ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

reverse_iterator	rbegin ()

reverse_iterator	rend ()

const_reverse_iterator	rbegin () const

const_reverse_iterator	rend () const

bool	empty () const

size_t	size () const

void	clear ()

Private 属性
Map	m_lookup

Vec	m_entries

详细描述

template<class T, class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>
class LinkedMap< T, Hash, KeyEqual, Map >

Container class representing a vector of objects with keys.

Objects can efficiently be looked up given the key. Objects are owned by the container. When adding objects the order of addition is kept, and used while iterating.

在文件 linkedmap.h 第 35 行定义.

成员类型定义说明

◆ const_iterator

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::const_iterator = typename Vec::const_iterator

在文件 linkedmap.h 第 54 行定义.

◆ const_reverse_iterator

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::const_reverse_iterator = typename Vec::const_reverse_iterator

在文件 linkedmap.h 第 56 行定义.

◆ iterator

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::iterator = typename Vec::iterator

在文件 linkedmap.h 第 53 行定义.

◆ Ptr

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::Ptr = std::unique_ptr<T>

在文件 linkedmap.h 第 51 行定义.

◆ reverse_iterator

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::reverse_iterator = typename Vec::reverse_iterator

在文件 linkedmap.h 第 55 行定义.

◆ Vec

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

using LinkedMap< T, Hash, KeyEqual, Map >::Vec = std::vector<Ptr>

在文件 linkedmap.h 第 52 行定义.

成员函数说明

◆ add() [1/4]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

template<class... Args>

T* LinkedMap< T, Hash, KeyEqual, Map >::add	(	const char *	k,
		Args &&...	args
	)

inline

Adds a new object to the ordered vector if it was not added already.

Return a non-owning pointer to the newly added object, or to the existing object if it was already inserted before under the given key.

在文件 linkedmap.h 第 103 行定义.

     {
       std::string key = k.str();
       T *result = find(key);
       if (result==nullptr)
       {
         Ptr ptr = std::make_unique<T>(k,std::forward<Args>(args)...);
         result = ptr.get();
         m_lookup.insert({key,result});
         m_entries.push_back(std::move(ptr));
       }

被这些函数引用 SectionManager::add(), addEnumValuesToEnums(), UsedDir::addFileDep(), addInstance(), HtmlHelpIndex::addItem(), addLocalObjCMethod(), ClassDefImpl::addMembersToTemplateInstance(), addRelatedPage(), DirDefImpl::addUsesDependency(), addVariableToClass(), addVariableToFile(), buildDefineList(), buildExampleList(), buildGroupListFiltered(), TagFileParser::buildLists(), buildNamespaceList(), DirDefImpl::createNewDir(), findDefineDocumentation(), findEnums(), findMember(), findUsingDeclImports(), NamespaceDefImpl::insertMember(), GroupDefImpl::insertMember(), ClassDefImpl::internalInsertMember(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembers(), readDir(), readFileOrDirectory(), SectionManager::replace() , 以及 resolveClassNestingRelations().

◆ add() [2/4]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

T* LinkedMap< T, Hash, KeyEqual, Map >::add	(	const char *	k,
		Ptr &&	ptr
	)

inline

Adds an existing object to the ordered vector (unless another object was already added under the same key).

Ownership is transferred. Return a non-owning pointer to the newly added object, or to the existing object if it was already inserted before under the given key.

在文件 linkedmap.h 第 136 行定义.

     {
       std::string key = k.str();
       T *result = find(key);
       if (result==nullptr)
       {
         result = ptr.get();
         m_lookup.insert({key,result});
         m_entries.push_back(std::move(ptr));
       }
       return result;
     }

◆ add() [3/4]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

template<class... Args>

T* LinkedMap< T, Hash, KeyEqual, Map >::add	(	const QCString &	k,
		Args &&...	args
	)

inline

在文件 linkedmap.h 第 118 行定义.

     {
       T *result = find(k);
       if (result==nullptr)
       {
         std::string key(k ? k : "");
         result = ptr.get();
         m_lookup.insert({key,result});

◆ add() [4/4]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

T* LinkedMap< T, Hash, KeyEqual, Map >::add	(	const QCString &	k,
		Ptr &&	ptr
	)

inline

在文件 linkedmap.h 第 149 行定义.

     {
       T *result = find(k);
       if (result==nullptr)
       {
         std::string key(k ? k : "");
         Ptr ptr = std::make_unique<T>(key.c_str(),std::forward<Args>(args)...);
         result = ptr.get();

◆ begin() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

iterator LinkedMap< T, Hash, KeyEqual, Map >::begin ( )

inline

在文件 linkedmap.h 第 214 行定义.

218 :

219

被这些函数引用 computeCommonDirPrefix(), DirDefImpl::computeDependencies(), UsedDir::sort() , 以及 ClassDefImpl::sortAllMembersList().

◆ begin() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const_iterator LinkedMap< T, Hash, KeyEqual, Map >::begin ( ) const

inline

在文件 linkedmap.h 第 216 行定义.

218 :

219

◆ clear()

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

void LinkedMap< T, Hash, KeyEqual, Map >::clear ( )

inline

在文件 linkedmap.h 第 225 行定义.

被这些函数引用 cleanUpDoxygen() , 以及 clearAll().

◆ del()

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

bool LinkedMap< T, Hash, KeyEqual, Map >::del ( const QCString & key )

inline

Removes an object from the container and deletes it.

Returns true if the object was deleted or false it is was not found.

在文件 linkedmap.h 第 196 行定义.

                                             { return m_entries[pos];      }
     const Ptr &operator[](size_t pos) const { return m_entries[pos];      }
     iterator begin()                        { return m_entries.begin();   }
     iterator end()                          { return m_entries.end();     }
     const_iterator begin() const            { return m_entries.cbegin();  }
     const_iterator end() const              { return m_entries.cend();    }
     reverse_iterator rbegin()               { return m_entries.rbegin();  }
     reverse_iterator rend()                 { return m_entries.rend();    }
     const_reverse_iterator rbegin() const   { return m_entries.crbegin(); }
     const_reverse_iterator rend() const     { return m_entries.crend();   }
     bool empty() const                      { return m_entries.empty();   }
     size_t size() const                     { return m_entries.size();    }

被这些函数引用 GroupDefImpl::removeMember().

◆ empty()

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

bool LinkedMap< T, Hash, KeyEqual, Map >::empty ( ) const

inline

在文件 linkedmap.h 第 222 行定义.

被这些函数引用 DirDefImpl::depGraphIsTrivial(), quickLinkVisible(), ClassDefImpl::writeMemberList() , 以及 ClassDefImpl::writeSummaryLinks().

◆ end() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

iterator LinkedMap< T, Hash, KeyEqual, Map >::end ( )

inline

在文件 linkedmap.h 第 215 行定义.

218 :

219

被这些函数引用 DirDefImpl::computeDependencies(), UsedDir::sort() , 以及 ClassDefImpl::sortAllMembersList().

◆ end() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const_iterator LinkedMap< T, Hash, KeyEqual, Map >::end ( ) const

inline

在文件 linkedmap.h 第 217 行定义.

218 :

219

◆ find() [1/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const char * key )

inline

A non-const wrapper for find() const

在文件 linkedmap.h 第 82 行定义.

     {
       return const_cast<T*>(static_cast<const LinkedMap&>(*this).find(key));
     }
  

◆ find() [2/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const char * key ) const

inline

Find an object given the key.

Returns a pointer to the element if found or nullptr if it is not found.

在文件 linkedmap.h 第 76 行定义.

     {
       return const_cast<T*>(static_cast<const LinkedMap&>(*this).find(key));
     }
  

◆ find() [3/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const QCString & key )

inline

A non-const wrapper for find() const

在文件 linkedmap.h 第 88 行定义.

91 {

◆ find() [4/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const QCString & key ) const

inline

Find an object given the key.

Returns a pointer to the element if found or nullptr if it is not found.

在文件 linkedmap.h 第 68 行定义.

     {
       return const_cast<T*>(static_cast<const LinkedMap&>(*this).find(key));
     }

◆ find() [5/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const std::string & key )

inline

A non-const wrapper for find() const

在文件 linkedmap.h 第 94 行定义.

       {
         std::string key(k ? k : "");
         Ptr ptr = std::make_unique<T>(QCString(k),std::forward<Args>(args)...);
         result = ptr.get();

◆ find() [6/6]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const T* LinkedMap< T, Hash, KeyEqual, Map >::find ( const std::string & key ) const

inline

Find an object given the key.

Returns a pointer to the element if found or nullptr if it is not found.

在文件 linkedmap.h 第 60 行定义.

64 {

被这些函数引用 LinkedMap< DirDef >::add(), addClassToGroups(), addConceptToGroups(), addDirToGroups(), addEnumValuesToEnums(), addExampleToGroups(), addGroupToGroups(), TagFileParser::addIncludes(), addMemberFunction(), addMemberToGroups(), addNamespaceToGroups(), addRelatedPage(), DefinitionImpl::addSectionsToDefinition(), DirDefImpl::addUsesDependency(), addVariableToClass(), addVariableToFile(), buildDirectories(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), buildScopeFromQualifiedName(), computePageRelations(), DirDefImpl::createNewDir(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), LinkedMap< DirDef >::find(), findDefineDocumentation(), DocParser::findDocsForMemberOrCompound(), findEnumDocumentation(), UsedDir::findFilePair(), findGlobalMember(), findMainPage(), findMember(), findUsedClassesForClass(), findUsingDeclImports(), findUsingDirectives(), PerlModGenerator::generatePerlModForPage(), generateXMLForPage(), VhdlDocGen::getClass(), getClass(), getConcept(), getDefs(), ClassDefImpl::getMemberByName(), getResolvedNamespace(), getTemplateArgumentsFromName(), ClassDefImpl::insertTemplateInstance(), isVarWithConstructor(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembers(), DocXRefItem::parse(), DocSection::parse(), DocSecRefItem::parse(), DocRoot::parse(), LinkedMap< DirDef >::prepend(), GroupDefImpl::removeMember(), SectionManager::replace(), resolveLink(), resolveRef(), resolveTypeDef(), resolveUserReferences(), showFileDefMatches(), PageDefImpl::writeDocumentation(), writeGroupTreeNode() , 以及 GroupDefImpl::writePageDocumentation().

◆ operator[]() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

Ptr& LinkedMap< T, Hash, KeyEqual, Map >::operator[] ( size_t pos )

inline

在文件 linkedmap.h 第 212 行定义.

213 {

◆ operator[]() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const Ptr& LinkedMap< T, Hash, KeyEqual, Map >::operator[] ( size_t pos ) const

inline

在文件 linkedmap.h 第 213 行定义.

213 {

◆ prepend() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

template<class... Args>

T* LinkedMap< T, Hash, KeyEqual, Map >::prepend	(	const char *	k,
		Args &&...	args
	)

inline

Prepends a new object to the ordered vector if it was not added already.

Return a non-owning pointer to the newly added object, or to the existing object if it was already inserted before under the given key.

在文件 linkedmap.h 第 166 行定义.

     {
       T *result = find(key);
       if (result==nullptr)
       {
         Ptr ptr = std::make_unique<T>(key,std::forward<Args>(args)...);
         result = ptr.get();
         m_lookup.insert({key.str(),result});
         m_entries.push_front(std::move(ptr));
       }
       return result;

◆ prepend() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

template<class... Args>

T* LinkedMap< T, Hash, KeyEqual, Map >::prepend	(	const QCString &	key,
		Args &&...	args
	)

inline

在文件 linkedmap.h 第 181 行定义.

     {
       auto it = m_lookup.find(key.str());
       if (it!=m_lookup.end())
       {
         auto vecit = std::find_if(m_entries.begin(),m_entries.end(),[obj=it->second](auto &el) { return el.get()==obj; });
         if (vecit!=m_entries.end()) // should always be true
         {
           m_entries.erase(vecit);
           m_lookup.erase(it);

◆ rbegin() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

reverse_iterator LinkedMap< T, Hash, KeyEqual, Map >::rbegin ( )

inline

在文件 linkedmap.h 第 218 行定义.

218 :

219

◆ rbegin() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const_reverse_iterator LinkedMap< T, Hash, KeyEqual, Map >::rbegin ( ) const

inline

在文件 linkedmap.h 第 220 行定义.

◆ rend() [1/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

reverse_iterator LinkedMap< T, Hash, KeyEqual, Map >::rend ( )

inline

在文件 linkedmap.h 第 219 行定义.

◆ rend() [2/2]

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

const_reverse_iterator LinkedMap< T, Hash, KeyEqual, Map >::rend ( ) const

inline

在文件 linkedmap.h 第 221 行定义.

◆ size()

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

size_t LinkedMap< T, Hash, KeyEqual, Map >::size ( ) const

inline

在文件 linkedmap.h 第 223 行定义.

被这些函数引用 computeClassRelations() , 以及 HtmlHelpIndex::size().

类成员变量说明

◆ m_entries

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

Vec LinkedMap< T, Hash, KeyEqual, Map >::m_entries

private

在文件 linkedmap.h 第 234 行定义.

被这些函数引用 LinkedMap< DirDef >::add(), LinkedMap< DirDef >::find() , 以及 LinkedMap< DirDef >::prepend().

◆ m_lookup

template<class T , class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>

Map LinkedMap< T, Hash, KeyEqual, Map >::m_lookup

private

在文件 linkedmap.h 第 233 行定义.

被这些函数引用 LinkedMap< DirDef >::add(), LinkedMap< DirDef >::find() , 以及 LinkedMap< DirDef >::prepend().

该类的文档由以下文件生成:

src/linkedmap.h

Public 类型

Public 成员函数

Private 属性

详细描述

template<class T, class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >> class LinkedMap< T, Hash, KeyEqual, Map >

成员类型定义说明

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ Ptr

◆ reverse_iterator

◆ Vec

成员函数说明

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ del()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ find() [1/6]

◆ find() [2/6]

◆ find() [3/6]

◆ find() [4/6]

◆ find() [5/6]

◆ find() [6/6]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ prepend() [1/2]

◆ prepend() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size()

类成员变量说明

◆ m_entries

◆ m_lookup

template<class T, class Hash = std::hash<std::string>, class KeyEqual = std::equal_to<std::string>, class Map = std::unordered_map<std::string,T*,Hash,KeyEqual >>
class LinkedMap< T, Hash, KeyEqual, Map >