datahash_util.h

Go to the documentation of this file.

/*
 * datahash_util.h
 *
 * Copyright (c) 2003,2008 Thomas A. Vaughan
 * 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 the <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * Utilities for dealing with datahashes.
 */

#ifndef WAVEPACKET_DATAHASH_UTIL_H__
#define WAVEPACKET_DATAHASH_UTIL_H__

// includes --------------------------------------------------------------------
#include "datahash.h"

#include <sstream>


/// \ingroup datahash
/*@{*/


////////////////////////////////////////////////////////////////////////////////
//
//      Convenient typed accessors.
//
//      NOTE: these *all* assume there is a single value for the given key!
//      If you need support for typed access to multi-valued keys you'll need
//      to write that yourself.
//
////////////////////////////////////////////////////////////////////////////////

enum eDatahash_Flag {
        eDatahash_Required      = 1,            ///< field is required
        eDatahash_Optional      = 2,            ///< optional field

        // must be last!
        eDatahash_Invalid       = 0
};


const char * getString(IN const Datahash * hash, IN const char * key,
                                IN eDatahash_Flag flag = eDatahash_Required);

const char * getOptionalString(IN const Datahash * hash, IN const char * key,
                                IN const char * default_value);

long getLong(IN const Datahash * hash, IN const char * key);

long getOptionalLong(IN const Datahash * hash, IN const char * key,
                                IN long default_value);

double getDouble(IN const Datahash * hash, IN const char * key);

bool getBooleanValueFromString(IN const char * value);

bool getBoolean(IN const Datahash * hash, IN const char * key);

smart_ptr<Datahash> getSubhash(IN const Datahash * hash,
                                IN const char * key_name,
                                IN eDatahash_Flag flag = eDatahash_Required);


// inline accessors (using the above)
static inline short getShort(IN const Datahash * hash, IN const char * key)
{ return (short) getLong(hash, key); }

static inline int getInt(IN const Datahash * hash, IN const char * key)
{ return (int) getLong(hash, key); }

static inline byte_t getByte(IN const Datahash * hash, IN const char * key)
{ return (byte_t) getLong(hash, key); }

static inline float getFloat(IN const Datahash * hash, IN const char * key)
{ return (float) getDouble(hash, key); }


// generic setter (NOTE: clears any old values, and then sets new value)
template <class T>
void
setValue
(
IN Datahash * hash,
IN const char * key_name,
IN const T& t
)
{
        std::ostringstream out;
        out << t;

        hash->remove(key_name);
        hash->insert(key_name, out.str().c_str());
}


void setTimestampAsDateString(IN Datahash * hash,
                        IN const char * key, long timestamp);

long getTimestampFromDateString(IN const Datahash * hash,
                        IN const char * key);


void getStringValues(IN const Datahash * hash,
                        IN const char * key,
                        OUT VecString& vec);


// helper constructors
smart_ptr<Datahash> getHashFromColonString(IN const char * s);


#endif  // WAVEPACKET_DATAHASH_UTIL_H__