src/Network/fg_file.hxx

   1 // fg_file.hxx -- File I/O routines
   2 //
   3 // Written by Curtis Olson, started November 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_FILE_HXX
  25 #define _FG_FILE_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include <simgear/compiler.h>
  33
  34 #include <string>
  35
  36 #include <sys/types.h>          // for open(), read(), write(), close()
  37 #include <sys/stat.h>           // for open(), read(), write(), close()
  38 #include <fcntl.h>              // for open(), read(), write(), close()
  39 #if !defined( _MSC_VER )
  40 #  include <unistd.h>           // for open(), read(), write(), close()
  41 #endif
  42
  43 #include "iochannel.hxx"
  44 #include "protocol.hxx"
  45
  46 FG_USING_STD(string);
  47
  48
  49 class FGFile : public FGIOChannel {
  50
  51     string file_name;
  52     int fp;
  53
  54 public:
  55
  56     FGFile();
  57     ~FGFile();
  58
  59     // open the file based on specified direction
  60     bool open( FGProtocol::fgProtocolDir dir );
  61
  62     // read a block of data of specified size
  63     int read( char *buf, int length );
  64
  65     // read a line of data, length is max size of input buffer
  66     int readline( char *buf, int length );
  67
  68     // write data to a file
  69     int write( char *buf, int length );
  70
  71     // write null terminated string to a file
  72     int writestring( char *str );
  73
  74     // close file
  75     bool close();
  76
  77     inline string get_file_name() const { return file_name; }
  78     inline void set_file_name( const string& fn ) { file_name = fn; }
  79 };
  80
  81
  82 #endif // _FG_FILE_HXX
  83
  84