FileHandler.h

Go to the documentation of this file.

// $Id: FileHandler.h,v 1.1.1.1 2009/07/06 23:57:25 eml Exp $

#ifndef GCP_UTIL_FILEHANDLER_H
#define GCP_UTIL_FILEHANDLER_H

#include <iostream>
#include <unistd.h>
#include <vector>

namespace gcp {
  namespace util {

    class FileHandler {
    public:

      FileHandler();
      FileHandler(std::string path);

      FileHandler(const FileHandler& objToBeCopied);

      FileHandler(FileHandler& objToBeCopied);

      void operator=(const FileHandler& objToBeAssigned);

      void operator=(FileHandler& objToBeAssigned);

      friend std::ostream& operator<<(std::ostream& os, FileHandler& obj);

      virtual ~FileHandler();
      
      void setTo(std::string path);
      virtual void openForRead(bool memMap=false);
      void close();
      void advanceByNbytes(off_t bytes);
      void setToBeginning();
      off_t setToEnd();
      unsigned getFileSizeInBytes();

      int getFd();

      off_t getCurrentOffset();
      void read(void* buf, size_t nByte);

      void memoryMap();
      void loadFile();

    protected:

      std::string path_;
      bool pathIsSet_;

      int fd_;

      off_t currentOffset_;
      size_t sizeInBytes_;

      //------------------------------------------------------------
      // If the file is memory-mapped, memMap_ will be set to true,
      // and mptrHead_ will point to the head of the memory mapped space
      //------------------------------------------------------------

      bool memMap_;
      unsigned char* mptrHead_;

      bool loadFile_;
      std::vector<unsigned char> fbuf_;

      void checkFd();

    }; // End class FileHandler

  } // End namespace util
} // End namespace gcp



#endif // End #ifndef GCP_UTIL_FILEHANDLER_H