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 General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
31 # error This library requires C++
34 #include <simgear/compiler.h>
40 #include <simgear/misc/zfstream.hxx>
43 * An envelope class for gzifstream.
45 class sg_gzifstream : private gzifstream_base, public std::istream
48 /** Default constructor */
52 * Constructor that attempt to open a file with and without
54 * @param name name of file
55 * @param io_mode file open mode(s) "or'd" together
57 sg_gzifstream( const std::string& name,
58 ios_openmode io_mode = ios_in | ios_binary );
61 * Constructor that attaches itself to an existing file descriptor.
62 * @param fd file descriptor
63 * @param io_mode file open mode(s) "or'd" together
65 sg_gzifstream( int fd, ios_openmode io_mode = ios_in|ios_binary );
68 * Attempt to open a file with and without ".gz" extension.
69 * @param name name of file
70 * @param io_mode file open mode(s) "or'd" together
72 void open( const std::string& name,
73 ios_openmode io_mode = ios_in|ios_binary );
76 * Attach to an existing file descriptor.
77 * @param fd file descriptor
78 * @param io_mode file open mode(s) "or'd" together
80 void attach( int fd, ios_openmode io_mode = ios_in|ios_binary );
85 void close() { gzbuf.close(); }
87 /** @return true if the file is successfully opened, false otherwise. */
88 bool is_open() { return gzbuf.is_open(); }
92 sg_gzifstream( const sg_gzifstream& );
93 void operator= ( const sg_gzifstream& );
97 * \relates sg_gzifstream
98 * An istream manipulator that skips to end of line.
99 * @param in input stream
101 std::istream& skipeol( std::istream& in );
104 * \relates sg_gzifstream
105 * An istream manipulator that skips over white space.
106 * @param in input stream
108 std::istream& skipws( std::istream& in );
111 * \relates sg_gzifstream
112 * An istream manipulator that skips comments and white space.
113 * Ignores comments that start with '#'.
114 * @param in input stream
116 std::istream& skipcomment( std::istream& in );
119 #endif /* _SGSTREAM_HXX */