LinkedRefMap< T, Hash, KeyEqual, Map > 模板类 参考

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

#include <linkedmap.h>

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

Public 类型
using	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)
	non-const wrapper for find() const 更多...
T *	find (const QCString &key)
T *	find (const std::string &key)
	non-const wrapper for find() const 更多...
bool	add (const char *k, T *obj)
	Adds an object reference to the ordered vector if it was not added already. 更多...
bool	add (const QCString &k, T *obj)
bool	prepend (const char *k, T *obj)
	Prepends an object reference to the ordered vector if it was not added already. 更多...
bool	prepend (const QCString &key, T *obj)
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 LinkedRefMap< T, Hash, KeyEqual, Map >

Container class representing a vector of objects with keys.

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

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

成员类型定义说明

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 LinkedRefMap< T, Hash, KeyEqual, Map >::const_iterator = typename Vec::const_iterator

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

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 LinkedRefMap< T, Hash, KeyEqual, Map >::const_reverse_iterator = typename Vec::const_reverse_iterator

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

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 LinkedRefMap< T, Hash, KeyEqual, Map >::iterator = typename Vec::iterator

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

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 LinkedRefMap< T, Hash, KeyEqual, Map >::Ptr = T*

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

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 LinkedRefMap< T, Hash, KeyEqual, Map >::reverse_iterator = typename Vec::reverse_iterator

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

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 LinkedRefMap< T, Hash, KeyEqual, Map >::Vec = std::vector<Ptr>

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

成员函数说明

add() [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 >>

bool LinkedRefMap< T, Hash, KeyEqual, Map >::add ( const char *  k, T *  obj  )

inline

Adds an object reference to the ordered vector if it was not added already.

Return true if the reference was added, and false if an object with the same key was already added before

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

    {
      if (find(k)==nullptr) // new element
      {
        std::string key(k ? k : "");
        m_lookup.insert({key,obj});
        m_entries.push_back(obj);
        return true;
      }
      else // already existing, don't add
      {
        return false;
      }
    }

被这些函数引用 GroupDefImpl::addClass(), GroupDefImpl::addConcept(), GroupDefImpl::addExample(), PageDefImpl::addInnerCompound(), NamespaceDefImpl::addInnerCompound(), ClassDefImpl::addInnerCompound(), GroupDefImpl::addNamespace(), GroupDefImpl::addPage(), NamespaceDefImpl::addUsingDeclaration(), FileDefImpl::addUsingDeclaration(), NamespaceDefImpl::addUsingDirective(), FileDefImpl::addUsingDirective(), NamespaceDefImpl::insertClass(), FileDefImpl::insertClass(), NamespaceDefImpl::insertConcept(), FileDefImpl::insertConcept(), NamespaceDefImpl::insertMember(), NamespaceDefImpl::insertNamespace() , 以及 FileDefImpl::insertNamespace().

add() [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 >>

bool LinkedRefMap< T, Hash, KeyEqual, Map >::add ( const QCString &  k, T *  obj  )

inline

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

    {
      std::string key = k.str();
      if (find(key)==nullptr) // new element
      {
        m_lookup.insert({key,obj});
        m_entries.push_back(obj);
        return true;
      }
      else // already existing, don't add
      {
        return false;
      }
    }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::begin ( )

inline

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

{ return m_entries.begin();   }

被这些函数引用 NamespaceDefImpl::sortMemberLists(), GroupDefImpl::sortMemberLists(), FileDefImpl::sortMemberLists() , 以及 ClassDefImpl::sortMemberLists().

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 LinkedRefMap< T, Hash, KeyEqual, Map >::begin ( ) const

inline

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

{ return m_entries.cbegin();  }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::clear ( )

inline

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

    {
      m_entries.clear();
      m_lookup.clear();
    }

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 LinkedRefMap< 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 第 348 行定义.

    {
      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);
          return true;
        }
      }
      return false;
    }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::empty ( ) const

inline

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

{ return m_entries.empty();   }

被这些函数引用 NestingNodeContext::Private::addNamespaces(), NestingNodeContext::Private::addPages(), NamespaceDefImpl::findInnerCompound(), findScopeFromQualifiedName(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), SymbolResolver::Private::getResolvedClassRec(), PageDefImpl::hasSubPages(), processTagLessClasses() , 以及 writeGroupTreeNode().

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 LinkedRefMap< T, Hash, KeyEqual, Map >::end ( )

inline

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

{ return m_entries.end();     }

被这些函数引用 NamespaceDefImpl::sortMemberLists(), GroupDefImpl::sortMemberLists(), FileDefImpl::sortMemberLists() , 以及 ClassDefImpl::sortMemberLists().

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 LinkedRefMap< T, Hash, KeyEqual, Map >::end ( ) const

inline

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

{ return m_entries.cend();    }

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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const char *  key )

inline

non-const wrapper for find() const

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

    {
      return const_cast<T*>(static_cast<const LinkedRefMap&>(*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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const char *  key ) const

inline

find an object given the key.

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

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

    {
      return find(std::string(key ? 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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const QCString &  key )

inline

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

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

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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const QCString &  key ) const

inline

find an object given the key.

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

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

    {
      auto it = m_lookup.find(key.str());
      return it!=m_lookup.end() ? it->second : nullptr;
    }

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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const std::string &  key )

inline

non-const wrapper for find() const

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

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

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* LinkedRefMap< T, Hash, KeyEqual, Map >::find ( const std::string &  key ) const

inline

find an object given the key.

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

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

    {
      auto it = m_lookup.find(key);
      return it!=m_lookup.end() ? it->second : nullptr;
    }

被这些函数引用 LinkedRefMap< const ConceptDef >::add(), GroupDefImpl::addClass(), GroupDefImpl::addConcept(), ClassDefImpl::addMembersToTemplateInstance(), GroupDefImpl::addNamespace(), LinkedRefMap< const ConceptDef >::find(), findGlobalMember(), NamespaceDefImpl::findInnerCompound(), ClassDefImpl::findInnerCompound(), NamespaceDefImpl::getMemberByName() , 以及 LinkedRefMap< const ConceptDef >::prepend().

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& LinkedRefMap< T, Hash, KeyEqual, Map >::operator[] ( size_t  pos )

inline

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

{ return m_entries[pos];      }

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& LinkedRefMap< T, Hash, KeyEqual, Map >::operator[] ( size_t  pos ) const

inline

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

{ return m_entries[pos];      }

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 >>

bool LinkedRefMap< T, Hash, KeyEqual, Map >::prepend ( const char *  k, T *  obj  )

inline

Prepends an object reference to the ordered vector if it was not added already.

Return true if the reference was added, and false if an object with the same key was already added before

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

    {
      if (find(k)==nullptr) // new element
      {
        std::string key(k ? k : "");
        m_lookup.insert({key,obj});
        m_entries.insert(m_entries.begin(),obj);
        return true;
      }
      else // already existing, don't add
      {
        return false;
      }
    }

被这些函数引用 FileDefImpl::addIncludedUsingDirectives().

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 >>

bool LinkedRefMap< T, Hash, KeyEqual, Map >::prepend ( const QCString &  key, T *  obj  )

inline

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

    {
      if (find(key)==nullptr) // new element
      {
        m_lookup.insert({key.str(),obj});
        m_entries.insert(m_entries.begin(),obj);
        return true;
      }
      else // already existing, don't add
      {
        return false;
      }
    }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::rbegin ( )

inline

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

{ return m_entries.rbegin();  }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::rbegin ( ) const

inline

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

{ return m_entries.crbegin(); }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::rend ( )

inline

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

{ return m_entries.rend();    }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::rend ( ) const

inline

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

{ return m_entries.crend();   }

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 LinkedRefMap< T, Hash, KeyEqual, Map >::size ( ) const

inline

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

{ return m_entries.size();    }

被这些函数引用 ClassContext::Private::createClasses(), NamespaceContext::Private::createClasses(), FileContext::Private::createClasses(), ModuleContext::Private::createClasses(), NamespaceContext::Private::createConstantgroups(), FileContext::Private::createConstantgroups(), ModuleContext::Private::createConstantgroups(), ModuleContext::Private::createExamples(), NamespaceContext::Private::createInlineClasses(), FileContext::Private::createInlineClasses(), ClassContext::Private::createInnerClasses(), NamespaceContext::Private::createNamespaces(), FileContext::Private::createNamespaces(), ModuleContext::Private::createNamespaces(), ModuleContext::Private::createPages(), GroupDefImpl::hasDetailedDescription(), NamespaceDefImpl::numDocMembers(), GroupDefImpl::numDocMembers(), GroupDefImpl::writeDetailedDescription() , 以及 writeGroupTreeNode().

类成员变量说明

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 LinkedRefMap< T, Hash, KeyEqual, Map >::m_entries

private

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

被这些函数引用 LinkedRefMap< const ConceptDef >::add(), LinkedRefMap< const ConceptDef >::begin(), LinkedRefMap< const ConceptDef >::clear(), LinkedRefMap< const ConceptDef >::del(), LinkedRefMap< const ConceptDef >::empty(), LinkedRefMap< const ConceptDef >::end(), LinkedRefMap< const ConceptDef >::operator[](), LinkedRefMap< const ConceptDef >::prepend(), LinkedRefMap< const ConceptDef >::rbegin(), LinkedRefMap< const ConceptDef >::rend() , 以及 LinkedRefMap< const ConceptDef >::size().

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 LinkedRefMap< T, Hash, KeyEqual, Map >::m_lookup

private

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

被这些函数引用 LinkedRefMap< const ConceptDef >::add(), LinkedRefMap< const ConceptDef >::clear(), LinkedRefMap< const ConceptDef >::del(), LinkedRefMap< const ConceptDef >::find() , 以及 LinkedRefMap< const ConceptDef >::prepend().

---

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

• src/linkedmap.h