-/** \file sg_file.hxx
- * File I/O routines.
- */
-
+///@file
+/// File I/O routines.
+//
// Written by Curtis Olson, started November 1999.
//
// Copyright (C) 1999 Curtis L. Olson - http://www.flightgear.org/~curt
//
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
//
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// General Public License for more details.
+// Library General Public License for more details.
//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the Free Software
-// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-//
-// $Id$
-
+// You should have received a copy of the GNU Library General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef _SG_FILE_HXX
#define _SG_FILE_HXX
-
-#ifndef __cplusplus
-# error This library requires C++
-#endif
-
#include <simgear/compiler.h>
-
-#include <string>
-
-#include <sys/types.h> // for open(), read(), write(), close()
-#include <sys/stat.h> // for open(), read(), write(), close()
-#include <fcntl.h> // for open(), read(), write(), close()
-#if !defined( _MSC_VER )
-# include <unistd.h> // for open(), read(), write(), close()
-#endif
-
#include "iochannel.hxx"
-using std::string;
-
+#include <string>
/**
* A file I/O class based on SGIOChannel.
*/
class SGFile : public SGIOChannel {
- string file_name;
+ std::string file_name;
int fp;
bool eof_flag;
- bool repeat;
+ // Number of repetitions to play. -1 means loop infinitely.
+ const int repeat;
+ int iteration; // number of current repetition,
+ // starting at 0
public:
* @param file name of file to open
* @param repeat On eof restart at the beginning of the file
*/
- SGFile( const string& file, bool repeat_ = false );
+ SGFile( const std::string& file, int repeat_ = 1 );
+
+ /**
+ * Create an SGFile from an existing, open file-descriptor
+ */
+ SGFile( int existingFd );
/** Destructor */
~SGFile();
bool close();
/** @return the name of the file being manipulated. */
- inline string get_file_name() const { return file_name; }
+ inline std::string get_file_name() const { return file_name; }
/** @return true of eof conditions exists */
- inline bool eof() const { return eof_flag; };
+ virtual bool eof() const { return eof_flag; };
};
-
#endif // _SG_FILE_HXX
-
-