TokenMap.h

Go to the documentation of this file.

//-*****************************************************************************
//
// Copyright (c) 2009-2015,
//  Sony Pictures Imageworks Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Industrial Light & Magic nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************
 
//-*****************************************************************************
//-*****************************************************************************
#ifndef Alembic_Util_TokenMap_h
#define Alembic_Util_TokenMap_h
 
#include <Alembic/Util/Export.h>
#include <Alembic/Util/Exception.h>
#include <Alembic/Util/Foundation.h>
 
namespace Alembic {
namespace Util {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
// TOKEN MAP
//
//-*****************************************************************************
 
class ALEMBIC_EXPORT TokenMap
{
public:
    //-*************************************************************************
    // TYPEDEFS
    //-*************************************************************************
    typedef std::map<std::string,std::string> map_type;

    typedef map_type::key_type key_type;

    // CJH: Not defined? typedef map_type::data_type data_type;
    typedef std::string data_type;

    typedef map_type::value_type value_type;

    typedef map_type::iterator iterator;

    typedef map_type::const_iterator const_iterator;

    typedef map_type::reverse_iterator reverse_iterator;

    typedef map_type::const_reverse_iterator const_reverse_iterator;

    typedef map_type::reference reference;

    typedef map_type::const_reference const_reference;
 
    //-*************************************************************************
    // CONSTRUCTORS
    //-*************************************************************************
    TokenMap() {}
 
    //-*************************************************************************
    explicit TokenMap( const std::string &config,
                       char pairSeparator = ';',
                       char assignSeparator = '=',
                       bool unique = false,
                       bool quiet = true )
    {
        if ( unique )
        {
            setUnique( config, pairSeparator, assignSeparator, quiet );
        }
        else
        {
            set( config, pairSeparator, assignSeparator );
        }
    }
 
    //-*************************************************************************
 
    //-*************************************************************************
 
    //-*************************************************************************
    // SET
    void set( const std::string &config,
              char pairSeparator = ';',
              char assignSeparator = '=' );
 
    //-*************************************************************************
    // SET UNIQUE
    void setUnique( const std::string &config,
                    char pairSeparator = ';',
                    char assignSeparator = '=',
                    bool quiet = true );
 
 
    //-*************************************************************************
    // GET
    std::string get( char pairSeparator = ';',
                     char assignSeparator = '=',
                     bool check = false ) const;
 
    //-*************************************************************************
    // CLEAR THE MAP
    //-*************************************************************************
    void clear() { m_map.clear(); }
 
    //-*************************************************************************
    // INDIVIDUAL TOKEN ACCESS
    //-*************************************************************************

    size_t size() const { return m_map.size(); }

    bool tokenExists( const std::string &token ) const
    {
        return ( m_map.count( token ) > 0 );
    }

    std::string value( const std::string &token ) const
    {
        const_iterator fiter = m_map.find( token );
        if ( fiter != m_map.end() )
        {
            return (*fiter).second;
        }
        else
        {
            return "";
        }
    }

    std::string operator[]( const std::string &token ) const
    {
        return value( token );
    }

    void setValue( const std::string &keyStr,
                   const std::string &valueStr )
    {
        m_map[keyStr] = valueStr;
    }
 
    //-*************************************************************************
    // ITERATION
    //-*************************************************************************

    iterator begin() { return m_map.begin(); }

    const_iterator begin() const { return m_map.begin(); }

    iterator end() { return m_map.end(); }

    const_iterator end() const { return m_map.end(); }
 
    //-*************************************************************************
    // REVERSE ITERATION
    //-*************************************************************************

    reverse_iterator rbegin() { return m_map.rbegin(); }

    const_reverse_iterator rbegin() const { return m_map.rbegin(); }

    reverse_iterator rend() { return m_map.rend(); }

    const_reverse_iterator rend() const { return m_map.rend(); }
 
    //-*************************************************************************
    // COMPARISON
    //-*************************************************************************

    bool exactMatch( const TokenMap &iOther ) const
    {
        return m_map == iOther.m_map;
    }
 
protected:
    map_type m_map;
};
 
//-*****************************************************************************
inline bool operator==( const TokenMap &iA, const TokenMap &iB )
{
    return iA.exactMatch( iB );
}
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace Util
} // End namespace Alembic
 
#endif