flightgear, especially when this occurs in a simgear .hxx file. This is now expressly forbidden, and will cause problems anyways because we now changed the name to <simgear_config.h> which isn't installed, so you can't include it in an installed header file.
137 lines
3.5 KiB
C++
137 lines
3.5 KiB
C++
/**
|
|
* \file sgstream.hxx
|
|
* zlib input file stream wrapper.
|
|
*/
|
|
|
|
// Written by Bernie Bright, 1998
|
|
//
|
|
// Copyright (C) 1998 Bernie Bright - bbright@c031.aone.net.au
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Library General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Library General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Library General Public
|
|
// License along with this library; if not, write to the
|
|
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
// Boston, MA 02111-1307, USA.
|
|
//
|
|
// $Id$
|
|
|
|
|
|
#ifndef _SGSTREAM_HXX
|
|
#define _SGSTREAM_HXX
|
|
|
|
#ifndef __cplusplus
|
|
# error This library requires C++
|
|
#endif
|
|
|
|
#include <simgear/compiler.h>
|
|
|
|
#if defined( SG_HAVE_STD_INCLUDES )
|
|
# include <istream>
|
|
#elif defined ( SG_HAVE_NATIVE_SGI_COMPILERS )
|
|
# include <CC/stream.h>
|
|
#elif defined ( __BORLANDC__ )
|
|
# include <iostream>
|
|
#else
|
|
# include <istream.h>
|
|
#endif
|
|
|
|
#include STL_STRING
|
|
|
|
#include <simgear/misc/zfstream.hxx>
|
|
|
|
SG_USING_STD(string);
|
|
|
|
#ifndef SG_HAVE_NATIVE_SGI_COMPILERS
|
|
SG_USING_STD(istream);
|
|
#endif
|
|
|
|
|
|
/**
|
|
* An envelope class for gzifstream.
|
|
*/
|
|
class sg_gzifstream : private gzifstream_base, public istream
|
|
{
|
|
public:
|
|
/** Default constructor */
|
|
sg_gzifstream();
|
|
|
|
/**
|
|
* Constructor that attempt to open a file with and without
|
|
* ".gz" extension.
|
|
* @param name name of file
|
|
* @param io_mode file open mode(s) "or'd" together
|
|
*/
|
|
sg_gzifstream( const string& name,
|
|
ios_openmode io_mode = ios_in | ios_binary );
|
|
|
|
/**
|
|
* Constructor that attaches itself to an existing file descriptor.
|
|
* @param fd file descriptor
|
|
* @param io_mode file open mode(s) "or'd" together
|
|
*/
|
|
sg_gzifstream( int fd, ios_openmode io_mode = ios_in|ios_binary );
|
|
|
|
/**
|
|
* Attempt to open a file with and without ".gz" extension.
|
|
* @param name name of file
|
|
* @param io_mode file open mode(s) "or'd" together
|
|
*/
|
|
void open( const string& name,
|
|
ios_openmode io_mode = ios_in|ios_binary );
|
|
|
|
/**
|
|
* Attach to an existing file descriptor.
|
|
* @param fd file descriptor
|
|
* @param io_mode file open mode(s) "or'd" together
|
|
*/
|
|
void attach( int fd, ios_openmode io_mode = ios_in|ios_binary );
|
|
|
|
/**
|
|
* Close the stream.
|
|
*/
|
|
void close() { gzbuf.close(); }
|
|
|
|
/** @return true if the file is successfully opened, false otherwise. */
|
|
bool is_open() { return gzbuf.is_open(); }
|
|
|
|
private:
|
|
// Not defined!
|
|
sg_gzifstream( const sg_gzifstream& );
|
|
void operator= ( const sg_gzifstream& );
|
|
};
|
|
|
|
/**
|
|
* \relates sg_gzifstream
|
|
* An istream manipulator that skips to end of line.
|
|
* @param in input stream
|
|
*/
|
|
istream& skipeol( istream& in );
|
|
|
|
/**
|
|
* \relates sg_gzifstream
|
|
* An istream manipulator that skips over white space.
|
|
* @param in input stream
|
|
*/
|
|
istream& skipws( istream& in );
|
|
|
|
/**
|
|
* \relates sg_gzifstream
|
|
* An istream manipulator that skips comments and white space.
|
|
* Ignores comments that start with '#'.
|
|
* @param in input stream
|
|
*/
|
|
istream& skipcomment( istream& in );
|
|
|
|
|
|
#endif /* _SGSTREAM_HXX */
|
|
|