gls_menu_dictionary.h

Go to the documentation of this file.

#if !defined( GLS_MENUDICTIONARY_H )
#    define GLS_MENUDICTIONARY_H

#    include <iomanip>
#    include <string>

#    include "disti_metadata.h"
#    include "gls_menu_data.h"

//============================================================================
//============================================================================
class GlsMenuDictionary
{
public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string Expand(
        const std::string& str,
        const char*        startDelim = "$(",
        const char*        endDelim   = ")" );

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<class T>
    void Attach( const std::string& name, T*& t )
    {
        GlsMenuData_T<T>* data = dynamic_cast<GlsMenuData_T<T>*>( Get( disti::AttributeName( name ) ) );
        if( data )
            data->Attach( t );
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<class T>
    bool Refer( const std::string& name, T& t )
    {
        bool              success( false );
        GlsMenuData_T<T>* data = dynamic_cast<GlsMenuData_T<T>*>( Get( disti::AttributeName( name ) ) );
        if( data )
            success = data->ReferTo( t );
        return success;
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<class T>
    bool ReferCopy( const std::string& name, T& t )
    {
        bool              success( false );
        GlsMenuData_T<T>* data = dynamic_cast<GlsMenuData_T<T>*>( Get( disti::AttributeName( name ) ) );
        if( data )
        {
            T currentVal = data->Value();
            success      = data->ReferTo( t );
            if( success )
            {
                data->Value( currentVal );
            }
        }
        return success;
    }

    // The following types and functions forward to DistiAttribDict, which was formerly the base
    // class of the present class but which was made a non-polymorphic value class in the GLS core
    // for efficiency. These are retained here for backwards compatibility with existing user code.

    typedef disti::DistiAttribDict::const_iterator const_iterator;
    typedef disti::DistiAttribDict::iterator       iterator;

    DISTI_DEPRECATED( "Renamed to CopyCommonValues() to better represent the action taken by this function." )
    GlsMenuDictionary& operator=( const disti::DistiAttribDict& dict )
    {
        CopyCommonValues( dict );
        return *this;
    }

    DISTI_DEPRECATED( "Renamed to CopyCommonValues() to better represent the action taken by this function." )
    GlsMenuDictionary& operator=( const GlsMenuDictionary& dict )
    {
        CopyCommonValues( dict );
        return *this;
    }

    void CopyCommonValues( const disti::DistiAttribDict& dict ) { _attribDict.CopyCommonValues( dict ); }
    void CopyCommonValues( const GlsMenuDictionary& dict ) { _attribDict.CopyCommonValues( dict._attribDict ); }

    bool operator==( const disti::DistiAttribDict& other ) { return _attribDict == other; }
    bool operator==( const GlsMenuDictionary& other ) { return _attribDict == other._attribDict; }

    virtual void Add( disti::DistiAttributeBase* attr ) { _attribDict.Add( attr ); }

    const_iterator Begin() const { return _attribDict.Begin(); }
    const_iterator End() const { return _attribDict.End(); }
    iterator       Begin() { return _attribDict.Begin(); }
    iterator       End() { return _attribDict.End(); }

    int Count() const { return _attribDict.Count(); }

    int Count( const disti::AttributeName& name ) const { return _attribDict.Count( name ); }

    void Clear() { _attribDict.Clear(); }

    virtual void Delete( const disti::AttributeName& name ) { _attribDict.Delete( name ); }

    virtual void ReadStrings( std::istream& instr ) { _attribDict.ReadStrings( instr ); }

    virtual void Write( std::ostream& outstr, bool changedDataOnly = false ) { _attribDict.Write( outstr, changedDataOnly ); }

    virtual bool Read( std::istream& instr ) { return _attribDict.Read( instr ); }

    bool ReadAndCaptureMissing( std::istream& instr, std::stringstream* missingStream ) { return _attribDict.ReadAndCaptureMissing( instr, missingStream ); }

    virtual std::string ValueString( const disti::AttributeName& name ) const { return _attribDict.ValueString( name ); }

    virtual void ValueString( const disti::AttributeName& name, const std::string& val ) { _attribDict.ValueString( name, val ); }

    long ValueInt( const disti::AttributeName& name ) const { return _attribDict.ValueInt( name ); }

    void ValueInt( const disti::AttributeName& name, long val ) { _attribDict.ValueInt( name, val ); }

    virtual std::ostream& WriteValue( const disti::AttributeName& name, std::ostream& outstr ) { return _attribDict.WriteValue( name, outstr ); }

    virtual std::istream& ReadValue( const disti::AttributeName& name, std::istream& instr ) { return _attribDict.ReadValue( name, instr ); }

    virtual disti::DistiAttributeBase* Get( const disti::AttributeName& name ) const { return _attribDict.Get( name ); }

    virtual bool IsEqual( const disti::AttributeName& name, const long val ) const { return _attribDict.IsEqual( name, val ); }

    static void SpacingInc() { disti::DistiAttribDict::SpacingInc(); }

    static void SpacingDec() { disti::DistiAttribDict::SpacingDec(); }

    static void SpacingZero() { disti::DistiAttribDict::SpacingZero(); }

    static std::string SpacingString() { return disti::DistiAttribDict::SpacingString(); }

    static bool ScanToken( std::istream& instr, std::string& result ) { return disti::DistiAttribDict::ScanToken( instr, result ); }

    virtual void Remove( const disti::AttributeName& name ) { _attribDict.Remove( name ); }

private:
    disti::DistiAttribDict _attribDict;
};

#endif // GLS_MENUDICTIONARY_H