token_stream.h

Go to the documentation of this file.
00001 /*
00002  * token_stream.h
00003  *
00004  * Copyright (c) 2003,2008 Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Declares an interface for a stream of "tokens".
00032  */
00033 
00034 #ifndef WAVEPACKET_TOKEN_STREAM_H__
00035 #define WAVEPACKET_TOKEN_STREAM_H__
00036 
00037 
00038 // includes --------------------------------------------------------------------
00039 #include "common/common.h"
00040 
00041 
00042 /// \ingroup util
00043 /*@{*/
00044 
00045 ////////////////////////////////////////////////////////////////////////////////
00046 //
00047 //      Token-reading APIs on top of input streams
00048 //
00049 ////////////////////////////////////////////////////////////////////////////////
00050 
00051 void getNextToken(IO std::istream& stream, OUT std::string& token,
00052                         IN bool respect_quotes = true, IN bool * eof = NULL);
00053 
00054 void expectToken(IO std::istream& stream, IN const char * expected);
00055 
00056 float readFloat(IN std::istream& stream,
00057                         IO std::string& token);
00058 
00059 int readInteger(IN std::istream& stream,
00060                         IO std::string& token);
00061 
00062 short readShort(IN std::istream& stream,
00063                         IO std::string& token);
00064 
00065 long readLong(IN std::istream& stream,
00066                         IO std::string& token);
00067 
00068 
00069 #endif  // WAVEPACKET_TOKEN_STREAM_H__
00070