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++
35 #include <simgear/compiler.h>
37 #if defined( SG_HAVE_STD_INCLUDES )
39 #elif defined ( __BORLANDC__ )
47 #include <simgear/misc/zfstream.hxx>
50 SG_USING_STD(istream);
54 * An envelope class for gzifstream.
56 class sg_gzifstream : private gzifstream_base, public istream
59 /** Default constructor */
63 * Constructor that attempt to open a file with and without
65 * @param name name of file
66 * @param io_mode file open mode(s) "or'd" together
68 sg_gzifstream( const string& name,
69 ios_openmode io_mode = ios_in | ios_binary );
72 * Constructor that attaches itself to an existing file descriptor.
73 * @param fd file descriptor
74 * @param io_mode file open mode(s) "or'd" together
76 sg_gzifstream( int fd, ios_openmode io_mode = ios_in|ios_binary );
79 * Attempt to open a file with and without ".gz" extension.
80 * @param name name of file
81 * @param io_mode file open mode(s) "or'd" together
83 void open( const string& name,
84 ios_openmode io_mode = ios_in|ios_binary );
87 * Attach to an existing file descriptor.
88 * @param fd file descriptor
89 * @param io_mode file open mode(s) "or'd" together
91 void attach( int fd, ios_openmode io_mode = ios_in|ios_binary );
96 void close() { gzbuf.close(); }
98 /** @return true if the file is successfully opened, false otherwise. */
99 bool is_open() { return gzbuf.is_open(); }
103 sg_gzifstream( const sg_gzifstream& );
104 void operator= ( const sg_gzifstream& );
108 * \relates sg_gzifstream
109 * An istream manipulator that skips to end of line.
110 * @param in input stream
112 istream& skipeol( istream& in );
115 * \relates sg_gzifstream
116 * An istream manipulator that skips over white space.
117 * @param in input stream
119 istream& skipws( istream& in );
122 * \relates sg_gzifstream
123 * An istream manipulator that skips comments and white space.
124 * Ignores comments that start with '#'.
125 * @param in input stream
127 istream& skipcomment( istream& in );
130 #endif /* _SGSTREAM_HXX */