3 * zlib input file stream wrapper.
6 // Written by Bernie Bright, 1998
8 // Copyright (C) 1998 Bernie Bright - bbright@c031.aone.net.au
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Library General Public
12 // License as published by the Free Software Foundation; either
13 // version 2 of the License, or (at your option) any later version.
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Library General Public License for more details.
20 // You should have received a copy of the GNU Library General Public
21 // License along with this library; if not, write to the
22 // Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 // Boston, MA 02111-1307, USA.
32 # error This library requires C++
39 #include <simgear/compiler.h>
41 #if defined( SG_HAVE_STD_INCLUDES )
43 #elif defined ( SG_HAVE_NATIVE_SGI_COMPILERS )
44 # include <CC/stream.h>
45 #elif defined ( __BORLANDC__ )
53 #include <simgear/misc/zfstream.hxx>
57 #ifndef SG_HAVE_NATIVE_SGI_COMPILERS
58 SG_USING_STD(istream);
63 * An envelope class for gzifstream.
65 class sg_gzifstream : private gzifstream_base, public istream
68 /** Default constructor */
72 * Constructor that attempt to open a file with and without
74 * @param name name of file
75 * @param io_mode file open mode(s) "or'd" together
77 sg_gzifstream( const string& name,
78 ios_openmode io_mode = ios_in | ios_binary );
81 * Constructor that attaches itself to an existing file descriptor.
82 * @param fd file descriptor
83 * @param io_mode file open mode(s) "or'd" together
85 sg_gzifstream( int fd, ios_openmode io_mode = ios_in|ios_binary );
88 * Attempt to open a file with and without ".gz" extension.
89 * @param name name of file
90 * @param io_mode file open mode(s) "or'd" together
92 void open( const string& name,
93 ios_openmode io_mode = ios_in|ios_binary );
96 * Attach to an existing file descriptor.
97 * @param fd file descriptor
98 * @param io_mode file open mode(s) "or'd" together
100 void attach( int fd, ios_openmode io_mode = ios_in|ios_binary );
105 void close() { gzbuf.close(); }
107 /** @return true if the file is successfully opened, false otherwise. */
108 bool is_open() { return gzbuf.is_open(); }
112 sg_gzifstream( const sg_gzifstream& );
113 void operator= ( const sg_gzifstream& );
117 * \relates sg_gzifstream
118 * An istream manipulator that skips to end of line.
119 * @param in input stream
121 istream& skipeol( istream& in );
124 * \relates sg_gzifstream
125 * An istream manipulator that skips over white space.
126 * @param in input stream
128 istream& skipws( istream& in );
131 * \relates sg_gzifstream
132 * An istream manipulator that skips comments and white space.
133 * Ignores comments that start with '#'.
134 * @param in input stream
136 istream& skipcomment( istream& in );
139 #endif /* _SGSTREAM_HXX */