datahash_text.h

Go to the documentation of this file.

/*
 * datahash_text.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.
 *
 *
 * Methods for reading a recursive data hash from text streams.
 */

#ifndef WAVEPACKET_DATAHASH_TEXT_H__
#define WAVEPACKET_DATAHASH_TEXT_H__


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

#include <iostream>


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


// read operations
smart_ptr<Datahash>
readHashFromStream(IN const char * key,
                        IO std::istream& stream);

smart_ptr<Datahash>
readHashFromTextFile(IN const char * filename);


// helper
smart_ptr<Datahash> readHashFromString(IN const char * string);


// write operations
void writeHashToStream(IN const Datahash * hash,
                        IO std::ostream& stream);


/// writes to file atomically
void writeHashToTextFile(IN const Datahash * hash,
                        IN const char * filename,
                        IN const char * comment_at_top = NULL);


// debug
void dumpHash(IN const char * title,
                        IN const Datahash * hash);


#endif  // WAVEPACKET_DATAHASH_TEXT_H__