VariableResolver.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : VariableResolver
 * Package    : Zeus.ZeusBase.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef VariableResolverH
#define VariableResolverH

#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/StringMap.hpp>
#include <zeusbase/System/Set.hpp>
#include <zeusbase/System/Interfaces/IVariableResolver.hpp>

BEGIN_NAMESPACE_Zeus

/****************************************************************************/
/****************************************************************************/
zeusbase_class TVariableResolver : public TZObject, public IVariableResolver
{
  public:
    TVariableResolver();

    //Methods of IVariableResolver
    virtual void MQUALIFIER clearVariables();
    virtual void MQUALIFIER addVariable(const IString& rName, const IString& rValue);
    virtual void MQUALIFIER removeVariable(const IString& rName);
    virtual Retval MQUALIFIER resolve(const IString& rData, IString& rOut, bool bRecursive);

    //Methods of IZUnknown
    MEMORY_MANAGER_DECL

    void addVariables(const TStringMap<TString>& rVariables);
    void addVariable(const TString& rName, const TString& rValue);

    void removeVariables(const TStringMap<TString>& rVariables);
    void removeVariables(const TSet<TString>& rVariables);
    void removeVariable(const TString& rName);

    Retval resolve(const TString& rData, IString& rOut, bool bRecursive);

    void resolveDependancies(const IString& rData, TSet<TString>& rDependancies, bool bRecusrive = false);
    void resolveDependancies(const TString& rData, TSet<TString>& rDependancies, bool bRecusrive = false);

  protected:
    virtual ~TVariableResolver();

    virtual Retval resolveVariable(const TString& rName, TString& rValue);
    virtual Retval resolve_internal(const IString& rData, IString& rOut, bool bRecursive, TSet<TString>& rReplacedVars);

  private:
    TStringMap<TString> m_mapVariables;

};

/****************************************************************************/
/****************************************************************************/
inline void MQUALIFIER TVariableResolver::addVariable(const IString& rName, const IString& rValue)
{
  m_mapVariables.setItem(rName, rValue);
}

/****************************************************************************/
/****************************************************************************/
inline void MQUALIFIER TVariableResolver::clearVariables()
{
  m_mapVariables.clear();
}

/****************************************************************************/
/****************************************************************************/
inline void MQUALIFIER TVariableResolver::removeVariable(const IString& rName)
{
  m_mapVariables.deleteItem(rName);
}

/****************************************************************************/
/****************************************************************************/
inline Retval MQUALIFIER TVariableResolver::resolve(const IString& rData, IString& rOut, bool bRecursive)
{
  TSet<TString> setVars;
  return resolve_internal(rData, rOut, bRecursive, setVars);
}

/****************************************************************************/
/****************************************************************************/
inline void TVariableResolver::addVariable(const TString& rName, const TString& rValue)
{
  m_mapVariables.setItem((const IString&)rName, (const IString&)rValue);
}

/****************************************************************************/
/****************************************************************************/
inline void TVariableResolver::removeVariable(const TString& rName)
{
  m_mapVariables.deleteItem((const IString&)rName);
}

/****************************************************************************/
/****************************************************************************/
inline Retval TVariableResolver::resolve(const TString& rData, IString& rOut, bool bRecursive)
{
  TSet<TString> setVars;
  return resolve_internal(rData, rOut, bRecursive, setVars);
}

/****************************************************************************/
/****************************************************************************/
inline void TVariableResolver::resolveDependancies(const TString& rData, TSet<TString>& rDependancies, bool bRecusrive /*= false*/)
{
  resolveDependancies((const IString&)rData, rDependancies, bRecusrive);
}

END_NAMESPACE_Zeus

#endif