---

FileIO.h

Go to the documentation of this file.

/****************** <SNX heading BEGIN do not edit this line> *****************
 *
 * sonix
 *
 * Original Authors:
 *   Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: FileIO.h,v $
 * Date modified: $Date: 2003/12/01 22:25:22 $
 * Version:       $Revision: 1.13 $
 * -----------------------------------------------------------------
 *
 ****************** <SNX heading END do not edit this line> ******************/
/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * 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 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
 * Library General Public License for more details.
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/





//
//                         -=     CFileIO class     =-
//
// Description: "stuff useful for file i/o most handle endian-ness issues.
//
//
//    $Date: 2003/12/01 22:25:22 $
//    $Revision: 1.13 $
//    Copyright (C) 1998, 1999, 2000  Kevin Meinert, KevinMeinert@bigfoot.com
//
//    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 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
//    Library General Public License for more details.
//
//    You should have received a copy of the GNU Library General Public
//    License along with this library; if not, write to the Free
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//

#ifndef CFILEIO_INCLUDED
#define CFILEIO_INCLUDED

#include <string>
#include <vector>
#include <fstream>
#include <stdio.h> // for FILE

#include <snx/Endian.h>

namespace snxFileIO
{
   //: true - 
   bool fileExists( const char* const name );

   int fileSize( const char* const filename );

   void fileLoad( const char* const filename, std::vector<unsigned char>& data );

   enum Endianness
   {
      LITTLE, BIG
   };

   //: Read
   // this function is designed to work with little endian files, such as TGA and BMP.
   // this will return data that is correctly translated for your system architecture.
   // i.e. reading a little endian BMP on a big endian mips system, 
   //      returns (translated) bigendian data
   // i.e. reading a little endian TGA on a little endian intel system, 
   //      returns (untranslated) littleendian data
   template<class typeT>
   inline int ReadData( Endianness fileByteOrdering, FILE* fp, typeT& data )
   {
      int size = ::fread( &data, sizeof(typeT), 1, fp );

      // if we're not on a little endian machine (intel is little endian) then reverse the bytes.
      if (fileByteOrdering == snxFileIO::LITTLE && vpr::System::isBigEndian() ||
         fileByteOrdering == snxFileIO::BIG && vpr::System::isLittleEndian())
      {
         snxEndian::byteReverse( data );
      }

      return size;
   }

   //: Write
   // this function is designed to work with little endian files, such as TGA and BMP.
   template<class typeT>
   inline int WriteData( Endianness fileByteOrdering, FILE* fp, const typeT& data )
   {
      typeT tempData = data;

      // if we're not on a little endian machine (i.e. intel is little endian, mips is big) 
      // then reverse the bytes.
      if (fileByteOrdering == LITTLE && vpr::System::isBigEndian() ||
         fileByteOrdering == BIG && vpr::System::isLittleEndian())
      {
         snxEndian::byteReverse( tempData );
      }
         
      int size = ::fwrite( &tempData, 1, sizeof(typeT), fp );

      return size;
   }

   // Read one byte of data from the file stream
   int ReadByte( FILE *fp, unsigned char& value );

   // Read one short of data from the file stream
   // NOTE: these enhance readability and type checking, try to use them over the generic ReadData function
   int ReadShort( Endianness fileByteOrdering, FILE* fp, unsigned short& value );

   // Read one long of data from the file stream
   // NOTE: these enhance readability and type checking, try to use them over the generic ReadData function
   int ReadLong( Endianness fileByteOrdering, FILE *fp, unsigned long& value );

   // Write one byte of data to the file stream
   int WriteByte( FILE *fp, const unsigned char& value );

   // Write one short of data to the file stream
   // NOTE: these enhance readability and type checking, try to use them over the generic WriteData function
   int WriteShort( Endianness fileByteOrdering, FILE* fp, const unsigned short& value );

   // Write one long of data to the file stream
   // NOTE: these enhance readability and type checking, try to use them over the generic WriteData function
   int WriteLong( Endianness fileByteOrdering, FILE *fp, const unsigned long& value );

   void getLine( std::ifstream& f, std::string& text  );

   void getAll( std::ifstream& f, std::string& buffer );

} //end namespace.

#endif

---