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>
36 #if defined( SG_HAVE_STD_INCLUDES )
38 #elif defined ( __BORLANDC__ )
46 #include <simgear/misc/zfstream.hxx>
49 * An envelope class for gzifstream.
51 class sg_gzifstream : private gzifstream_base, public std::istream
54 /** Default constructor */
58 * Constructor that attempt to open a file with and without
60 * @param name name of file
61 * @param io_mode file open mode(s) "or'd" together
63 sg_gzifstream( const std::string& name,
64 ios_openmode io_mode = ios_in | ios_binary );
67 * Constructor that attaches itself to an existing file descriptor.
68 * @param fd file descriptor
69 * @param io_mode file open mode(s) "or'd" together
71 sg_gzifstream( int fd, ios_openmode io_mode = ios_in|ios_binary );
74 * Attempt to open a file with and without ".gz" extension.
75 * @param name name of file
76 * @param io_mode file open mode(s) "or'd" together
78 void open( const std::string& name,
79 ios_openmode io_mode = ios_in|ios_binary );
82 * Attach to an existing file descriptor.
83 * @param fd file descriptor
84 * @param io_mode file open mode(s) "or'd" together
86 void attach( int fd, ios_openmode io_mode = ios_in|ios_binary );
91 void close() { gzbuf.close(); }
93 /** @return true if the file is successfully opened, false otherwise. */
94 bool is_open() { return gzbuf.is_open(); }
98 sg_gzifstream( const sg_gzifstream& );
99 void operator= ( const sg_gzifstream& );
103 * \relates sg_gzifstream
104 * An istream manipulator that skips to end of line.
105 * @param in input stream
107 std::istream& skipeol( std::istream& in );
110 * \relates sg_gzifstream
111 * An istream manipulator that skips over white space.
112 * @param in input stream
114 std::istream& skipws( std::istream& in );
117 * \relates sg_gzifstream
118 * An istream manipulator that skips comments and white space.
119 * Ignores comments that start with '#'.
120 * @param in input stream
122 std::istream& skipcomment( std::istream& in );
125 #endif /* _SGSTREAM_HXX */