5 // Written by Curtis Olson, started November 1999.
7 // Copyright (C) 1999 Curtis L. Olson - http://www.flightgear.org/~curt
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU General Public License as
11 // published by the Free Software Foundation; either version 2 of the
12 // License, or (at your option) any later version.
14 // This program is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 # error This library requires C++
34 #include <simgear/compiler.h>
38 #include <sys/types.h> // for open(), read(), write(), close()
39 #include <sys/stat.h> // for open(), read(), write(), close()
40 #include <fcntl.h> // for open(), read(), write(), close()
41 #if !defined( _MSC_VER )
42 # include <unistd.h> // for open(), read(), write(), close()
45 #include "iochannel.hxx"
51 * A file I/O class based on SGIOChannel.
53 class SGFile : public SGIOChannel {
62 * Create an instance of SGFile.
63 * When calling the constructor you need to provide a file
64 * name. This file is not opened immediately, but instead will be
65 * opened when the open() method is called.
66 * @param file name of file to open
68 SGFile( const string& file );
73 // open the file based on specified direction
74 bool open( const SGProtocolDir dir );
76 // read a block of data of specified size
77 int read( char *buf, int length );
79 // read a line of data, length is max size of input buffer
80 int readline( char *buf, int length );
82 // write data to a file
83 int write( const char *buf, const int length );
85 // write null terminated string to a file
86 int writestring( const char *str );
91 /** @return the name of the file being manipulated. */
92 inline string get_file_name() const { return file_name; }
94 /** @return true of eof conditions exists */
95 inline bool eof() const { return eof_flag; };
99 #endif // _SG_FILE_HXX