FileObject.hh

Go to the documentation of this file.

#ifndef FILETYPE_HH
#define FILETYPE_HH

//---------------------------------------------------------------------------
// Copyright (c) 1995-2005 Ohio Board of Regents and the University of
// Cincinnati.  All Rights Reserved.

// You may modify, distribute, and use the software contained in this package
// under the terms of the "GNU LIBRARY GENERAL PUBLIC LICENSE" version 2,
// June 1991. A copy of this license agreement can be found in the file
// "LGPL", distributed with this archive.
//---------------------------------------------------------------------------

#include "tyvis/ObjectBase.hh"
#include "tyvis/EnumerationLiteral.hh"

#include <fstream>
using std::fstream;
using std::ios;

class AccessObject;
class FileTypeInfo;
class SimulationStream;

class FileObject : public ObjectBase {
public:
  FileObject(const FileTypeInfo &);

  FileObject(const FileObject &);

  FileObject( const FileTypeInfo &,
              const string &fileName,
              const EnumerationLiteral &openMode );

  FileObject( const FileTypeInfo &,
              const Slice &,
              const EnumerationLiteral &openMode );
  
  virtual ~FileObject();

  ObjectBase* getObject() const {
    return NULL;
  }

  virtual void print(ostream& = cout) const;
  
  RValue *clone() const;


  void writeline( LValue &line );
  void readline(  AccessObject &);
  void readline(  AccessObject &, int &numRead );


  void open( const string &fileName, const RValue &openMode );
  void open( const string &fileName, const RValue &openMode, LValue &status );
  void close();
  void read( LValue &readInto );
  void write( const RValue &value );
  UniversalInteger endfile();

  int getHandle() const;
  const EnumerationLiteral &getFileOpenKind();
  void setFileOpenKind(const EnumerationLiteral &);

  RValue &operator=(const RValue &);
  FileObject &operator=(const FileObject &);

  bool operator==( const RValue & ) const;
  bool operator!=( const RValue & ) const;
  bool operator>( const RValue & ) const;
  bool operator>=( const RValue & ) const;
  bool operator<( const RValue & ) const;
  bool operator<=( const RValue & ) const;

  const RValue &readVal() const;
  RValue &readVal();
  void updateVal( const RValue &newValue );

  const FileTypeInfo &getFileTypeInfo() const;

  string nextToken();

private:  
  static fstream &openFile( const string &fileName, 
                            const RValue &openMode );
  
  static fstream &openFile( const Slice &fileName, 
                            const RValue &openMode );

  static ios::openmode getOpenMode( const RValue &mode );

  fstream *fileHandle;
  EnumerationLiteral openKind;
};


int
savantfile_open( VHDLKernel *processPtr,
                 LValue &fileObject,
                 const RValue &openMode );

int
savantfile_open( VHDLKernel *processPtr,
                 LValue &fileOpenStatus,
                 LValue &fileObject,
                 const RValue &fileName,
                 const RValue &openMode );

int
savantfile_close( VHDLKernel *processPtr, LValue &fileObject );

int savantread( VHDLKernel *processPtr, LValue &fileObject, LValue &readValue );

int savantread( VHDLKernel *processPtr, LValue &fileObject, LValue &readValue, LValue &length );

int savantwrite( VHDLKernel *processPtr, LValue &fileObject, const RValue &toWrite );

Value savantendfile( VHDLKernel *processPtr, LValue &fileObject );

#endif

---