SymbolMap< T > Class Template Reference

Class implementing a symbol map that maps symbol names to objects. More...

#include <src/symbolmap.h>

Inheritance diagram for SymbolMap< T >:

Public Types
using	Ptr = T *
using	VectorPtr = std::vector<Ptr>
using	Map = std::unordered_map<std::string,VectorPtr>
using	iterator = typename Map::iterator
using	const_iterator = typename Map::const_iterator

Public Member Functions
void	add (const QCString &name, Ptr def)
	Add a symbol def into the map under key name.
void	remove (const QCString &name, Ptr def)
	Remove a symbol def from the map that was stored under key name.
const VectorPtr &	find (const QCString &name)
	Find the list of symbols stored under key name Returns a pair of iterators pointing to the start and end of the range of matching symbols.
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
bool	empty () const

Private Attributes
Map	m_map
VectorPtr	m_noMatch

Detailed Description

template<class T>
class SymbolMap< T >

Class implementing a symbol map that maps symbol names to objects.

Symbol names do not have to be unique. Supports adding symbols with add(), removing symbols with remove(), and finding symbols with find().

Definition at line 31 of file symbolmap.h.

Member Typedef Documentation

const_iterator

template<class T >

using SymbolMap< T >::const_iterator = typename Map::const_iterator

Definition at line 38 of file symbolmap.h.

iterator

template<class T >

using SymbolMap< T >::iterator = typename Map::iterator

Definition at line 37 of file symbolmap.h.

Map

template<class T >

using SymbolMap< T >::Map = std::unordered_map<std::string,VectorPtr>

Definition at line 36 of file symbolmap.h.

Ptr

template<class T >

using SymbolMap< T >::Ptr = T *

Definition at line 34 of file symbolmap.h.

VectorPtr

template<class T >

using SymbolMap< T >::VectorPtr = std::vector<Ptr>

Definition at line 35 of file symbolmap.h.

Member Function Documentation

add()

template<class T >

void SymbolMap< T >::add ( const QCString & name, Ptr def )

inline

Add a symbol def into the map under key name.

Definition at line 41 of file symbolmap.h.

    {
      auto it = m_map.find(name.str());
      if (it!=m_map.end())
      {
        it->second.push_back(def);
      }
      else
      {
        m_map.emplace(name.str(),VectorPtr({def}));
      }
    }

References m_map, and QCString::str().

Referenced by addToMap().

begin() [1/2]

template<class T >

iterator SymbolMap< T >::begin ( )

inline

Definition at line 82 of file symbolmap.h.

{ return m_map.begin();  }

References m_map.

begin() [2/2]

template<class T >

const_iterator SymbolMap< T >::begin ( ) const

inline

Definition at line 84 of file symbolmap.h.

{ return m_map.cbegin(); }

References m_map.

empty()

template<class T >

bool SymbolMap< T >::empty ( ) const

inline

Definition at line 86 of file symbolmap.h.

{ return m_map.empty();  }

References m_map.

end() [1/2]

template<class T >

iterator SymbolMap< T >::end ( )

inline

Definition at line 83 of file symbolmap.h.

{ return m_map.end();    }

References m_map.

end() [2/2]

template<class T >

const_iterator SymbolMap< T >::end ( ) const

inline

Definition at line 85 of file symbolmap.h.

{ return m_map.cend();   }

References m_map.

find()

template<class T >

const VectorPtr & SymbolMap< T >::find ( const QCString & name )

inline

Find the list of symbols stored under key name Returns a pair of iterators pointing to the start and end of the range of matching symbols.

Definition at line 75 of file symbolmap.h.

    {
      assert(m_noMatch.empty());
      auto it = m_map.find(name.str());
      return it==m_map.end() ? m_noMatch : it->second;
    }

References m_map, m_noMatch, and QCString::str().

Referenced by SymbolResolver::Private::followPath(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedTypeRec(), and SymbolResolver::Private::substTypedef().

remove()

template<class T >

void SymbolMap< T >::remove ( const QCString & name, Ptr def )

inline

Remove a symbol def from the map that was stored under key name.

Definition at line 55 of file symbolmap.h.

    {
      auto it1 = m_map.find(name.str());
      if (it1!=m_map.end())
      {
        VectorPtr &v = it1->second;
        auto it2 = std::find(v.begin(),v.end(),def);
        if (it2!=v.end())
        {
          v.erase(it2);
          if (v.empty())
          {
            m_map.erase(it1);
          }
        }
      }
    }

References m_map, and QCString::str().

Referenced by removeFromMap().

Member Data Documentation

m_map

template<class T >

Map SymbolMap< T >::m_map

private

Definition at line 89 of file symbolmap.h.

Referenced by add(), begin(), begin(), empty(), end(), end(), find(), and remove().

m_noMatch

template<class T >

VectorPtr SymbolMap< T >::m_noMatch

private

Definition at line 90 of file symbolmap.h.

Referenced by find().

---

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

• src/symbolmap.h