VariableContext Class Reference

#include <src/scopedtypevariant.h>

Public Types
using	Scope = std::unordered_map<std::string,ScopedTypeVariant>

Public Member Functions
void	pushScope ()
void	popScope ()
void	clear ()
void	clearExceptGlobal ()
void	addVariable (const QCString &name, ScopedTypeVariant stv)
const ScopedTypeVariant *	findVariable (const QCString &name)
bool	atGlobalScope () const

Private Attributes
Scope	m_globalScope
std::vector< Scope >	m_scopes

Detailed Description

Represents a stack of variable to class mappings as found in the code. Each scope is enclosed in pushScope() and popScope() calls. Variables are added by calling addVariables() and one can search for variable using findVariable().

Definition at line 74 of file scopedtypevariant.h.

Member Typedef Documentation

Scope

using VariableContext::Scope = std::unordered_map<std::string,ScopedTypeVariant>

Definition at line 77 of file scopedtypevariant.h.

Member Function Documentation

addVariable()

void VariableContext::addVariable ( const QCString & name, ScopedTypeVariant stv )

inline

Definition at line 99 of file scopedtypevariant.h.

    {
      Scope *scope = m_scopes.empty() ? &m_globalScope : &m_scopes.back();
      scope->emplace(name.str(),std::move(stv)); // add it to a list
    }

References m_globalScope, m_scopes, and QCString::str().

atGlobalScope()

bool VariableContext::atGlobalScope ( ) const

inline

Definition at line 129 of file scopedtypevariant.h.

{ return m_scopes.empty(); }

References m_scopes.

clear()

void VariableContext::clear ( )

inline

Definition at line 90 of file scopedtypevariant.h.

    {
      m_scopes.clear();
      m_globalScope.clear();
    }

References m_globalScope, and m_scopes.

clearExceptGlobal()

void VariableContext::clearExceptGlobal ( )

inline

Definition at line 95 of file scopedtypevariant.h.

    {
      m_scopes.clear();
    }

References m_scopes.

findVariable()

const ScopedTypeVariant * VariableContext::findVariable ( const QCString & name )

inline

Definition at line 104 of file scopedtypevariant.h.

    {
      const ScopedTypeVariant *result = nullptr;
      if (name.isEmpty()) return result;
 
      // search from inner to outer scope
      auto it = std::rbegin(m_scopes);
      while (it != std::rend(m_scopes))
      {
        auto it2 = it->find(name.str());
        if (it2 != std::end(*it))
        {
          result = &it2->second;
          return result;
        }
        ++it;
      }
      // nothing found -> also try the global scope
      auto it2 = m_globalScope.find(name.str());
      if (it2 != m_globalScope.end())
      {
        result = &it2->second;
      }
      return result;
    }

References QCString::isEmpty(), m_globalScope, m_scopes, and QCString::str().

popScope()

void VariableContext::popScope ( )

inline

Definition at line 83 of file scopedtypevariant.h.

    {
      if (!m_scopes.empty())
      {
        m_scopes.pop_back();
      }
    }

References m_scopes.

pushScope()

void VariableContext::pushScope ( )

inline

Definition at line 79 of file scopedtypevariant.h.

    {
      m_scopes.emplace_back();
    }

References m_scopes.

Member Data Documentation

m_globalScope

Scope VariableContext::m_globalScope

private

Definition at line 132 of file scopedtypevariant.h.

Referenced by addVariable(), clear(), and findVariable().

m_scopes

std::vector<Scope> VariableContext::m_scopes

private

Definition at line 133 of file scopedtypevariant.h.

Referenced by addVariable(), atGlobalScope(), clear(), clearExceptGlobal(), findVariable(), popScope(), and pushScope().

---

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

• src/scopedtypevariant.h