evFile.h

Go to the documentation of this file.

/*
 *
 * EVITA: Efficient Visualization of Terascale Datasets
 * Copyright (C) 2000-2016  Team Evita
 * 
 * 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., 675 Mass Ave, Cambridge,
 * MA 02139, USA.
 *
 */


#ifndef __evFile_h
#define __evFile_h


#include "evVersion.h"
#include "evAddress.h"
#include "evVector.h"


#define EVFILE_INPUT 0
#define EVFILE_OUTPUT 1

#define EVFILE_FULLBUFFERING 0
#define EVFILE_LINEBUFFERING 1
#define EVFILE_UNBUFFERED 2


typedef long evFilePosition;


class evFile : public evDataObject
{
public:
  evFile(void);
  virtual ~evFile(void);
  
  virtual const evString GetClassName(void) const
  {
    return(evString("evFile"));
  }
  
  evString GetFilename(void);
  evVersion GetFileVersion(void);
  int GetMode(void);
  FILE *GetFilePointer(void);

  int IsOpen(void);

  int Open(const evString &filename, const char *mode);
  virtual int Close(void);

  virtual int Flush(void);
  virtual int SetBufferMode(const int mode);

  int GetPosition(evFilePosition &file_position);
  int Seek(const evFilePosition file_position);

  int SkipWhiteSpace(void);

  int ReadChar(char &value);
  int WriteChar(const char value);

  int ReadToken(const evString &token);
  int ReadToken(const evString &token, int &token_value);
  int ReadToken(const evString &token, evAddress &token_value);
  int ReadToken(const evString &token, double &token_value);
  int ReadToken(const evString &token, evVector &token_value);
  int ReadToken(const evString &token, evString &token_value);
  int ReadToken(const evString &token, evVersion &token_value);
  int WriteToken(const evString &token);
  int WriteToken(const evString &token, const int token_value);
  int WriteToken(const evString &token, const evAddress &token_value);
  int WriteToken(const evString &token, const double token_value);
  int WriteToken(const evString &token, const evVector &token_value);
  int WriteToken(const evString &token, const evString &token_value);
  int WriteToken(const evString &token, const evVersion &token_value);
  
  int ReadHeader(evString &class_name);
  int WriteHeader(const evString &class_name);

protected:
  FILE *FilePointer;
  int Mode;

  int ReadTokenLabel(const evString &token);
  int WriteTokenLabel(const evString &token);
  int ReadTokenEndOfLine(void);
  int WriteTokenEndOfLine(void);

private:
  evString Filename;
  evVersion FileVersion;

};


inline evString evFile::GetFilename(void)
{
  return(this->Filename);
}


inline evVersion evFile::GetFileVersion(void)
{
  return(this->FileVersion);
}


inline int evFile::GetMode(void)
{
  return(this->Mode);
}


inline FILE *evFile::GetFilePointer(void)
{
  return(this->FilePointer);
}


inline int evFile::IsOpen(void)
{
  return(this->FilePointer != NULL);
}


#endif