huge_file.h

Go to the documentation of this file.

#ifndef HUGE_FILE_CLASS
#define HUGE_FILE_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : huge_file                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2007-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include "byte_filer.h"
 
#include <basis/astring.h>
#include <basis/outcome.h>
#include <basis/common_outcomes.h>
#include <basis/enhance_cpp.h>
 
namespace filesystem {
 
 
class huge_file
{
public:
  huge_file(const basis::astring &filename, const basis::astring &permissions);
 
  virtual ~huge_file();
 
  DEFINE_CLASS_NAME("huge_file");
 
  enum outcomes {
    OKAY = basis::common::OKAY,
    FAILURE = basis::common::FAILURE,
    ACCESS_DENIED = basis::common::ACCESS_DENIED,
    BAD_INPUT = basis::common::BAD_INPUT
  };
 
  const basis::astring &name() const;
 
  bool good() const;
 
  bool eof() const;
 
  double length();
 
  double file_pointer() const { return _file_pointer; }
 
  basis::outcome seek(double new_position,
          byte_filer::origins origin = byte_filer::FROM_CURRENT);
 
  basis::outcome move_to(double absolute_posn);
 
  basis::outcome read(basis::byte_array &to_fill, int desired_size, int &size_read);
 
  basis::outcome write(const basis::byte_array &to_write, int &size_written);
 
  bool truncate();
 
  basis::outcome touch();
    //<! creates the file if it doesn't exist, or updates the time on the file.
 
  void flush();
 
private:
  byte_filer *_real_file;  
  double _file_pointer;  
};
 
} //namespace.
 
#endif