simgear/io/sg_file.hxx

   1 // sg_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 _SG_FILE_HXX
  25 #define _SG_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
  45 SG_USING_STD(string);
  46
  47
  48 class SGFile : public SGIOChannel {
  49
  50     string file_name;
  51     int fp;
  52
  53 public:
  54
  55     SGFile( const string& file );
  56     ~SGFile();
  57
  58     // open the file based on specified direction
  59     bool open( const SGProtocolDir dir );
  60
  61     // read a block of data of specified size
  62     int read( char *buf, int length );
  63
  64     // read a line of data, length is max size of input buffer
  65     int readline( char *buf, int length );
  66
  67     // write data to a file
  68     int write( const char *buf, const int length );
  69
  70     // write null terminated string to a file
  71     int writestring( const char *str );
  72
  73     // close file
  74     bool close();
  75
  76     inline string get_file_name() const { return file_name; }
  77 };
  78
  79
  80 #endif // _SG_FILE_HXX
  81
  82