]> git.mxchange.org Git - simgear.git/blob - simgear/io/sg_file.hxx
Display a warning message for Irix users.
[simgear.git] / simgear / io / sg_file.hxx
1 /** \file sg_file.hxx
2  * File I/O routines.
3  */
4
5 // Written by Curtis Olson, started November 1999.
6 //
7 // Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
8 //
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.
13 //
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.
18 //
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.
22 //
23 // $Id$
24
25
26 #ifndef _SG_FILE_HXX
27 #define _SG_FILE_HXX
28
29
30 #ifndef __cplusplus
31 # error This library requires C++
32 #endif
33
34 #include <simgear/compiler.h>
35
36 #include <string>
37
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()
43 #endif
44
45 #include "iochannel.hxx"
46
47 SG_USING_STD(string);
48
49
50 /**
51  * A file I/O class based on SGIOChannel.
52  */
53 class SGFile : public SGIOChannel {
54
55     string file_name;
56     int fp;
57
58 public:
59
60     /**
61      * Create an instance of SGFile.
62      * When calling the constructor you need to provide a file
63      * name. This file is not opened immediately, but instead will be
64      * opened when the open() method is called.
65      * @param file name of file to open
66      */
67     SGFile( const string& file );
68
69     /** Destructor */
70     ~SGFile();
71
72     // open the file based on specified direction
73     bool open( const SGProtocolDir dir );
74
75     // read a block of data of specified size
76     int read( char *buf, int length );
77
78     // read a line of data, length is max size of input buffer
79     int readline( char *buf, int length );
80
81     // write data to a file
82     int write( const char *buf, const int length );
83
84     // write null terminated string to a file
85     int writestring( const char *str );
86
87     // close file
88     bool close();
89
90     /** @return the name of the file being manipulated. */
91     inline string get_file_name() const { return file_name; }
92 };
93
94
95 #endif // _SG_FILE_HXX
96
97