byte_filer.h

Go to the documentation of this file.

#ifndef BYTE_FILER_CLASS
#define BYTE_FILER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : byte_filer                                                        *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2000-$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 <basis/astring.h>
#include <basis/byte_array.h>
#include <basis/definitions.h>
 
#include "filename.h"
 
namespace filesystem {
 
// forward declarations.
class file_hider;
 
 
class byte_filer
{
public:
  byte_filer();
 
  byte_filer(const basis::astring &fname, const basis::astring &permissions);
 
  byte_filer(const char *fname, const char *permissions);
 
  byte_filer(bool auto_close, void *opened);
 
  ~byte_filer();
 
  static size_t file_size_limit();
 
  bool open(const basis::astring &fname, const basis::astring &permissions);
 
  void close();
 
  const basis::astring &name() const;
 
  bool good();
 
  size_t length();
 
  size_t tell();
 
  void flush();
 
  enum origins {
    FROM_START,    
    FROM_END,      
    FROM_CURRENT   
  };
 
  bool seek(int where, origins origin = FROM_START);
 
  bool eof();
 
  int read(basis::abyte *buffer, int buffer_size);
 
  int write(const basis::abyte *buffer, int buffer_size);
 
  int read(basis::byte_array &buffer, int desired_size);
  int write(const basis::byte_array &buffer);
 
  int read(basis::astring &buffer, int desired_size);
 
  int write(const basis::astring &buffer, bool add_null = false);
 
  int getline(basis::abyte *buffer, int desired_size);
  int getline(basis::byte_array &buffer, int desired_size);
  int getline(basis::astring &buffer, int desired_size);
 
  bool truncate();
 
  void *file_handle();
 
private:
  file_hider *_handle;  
  filename *_filename;  
  bool _auto_close;  
 
  // not to be called.
  byte_filer(const byte_filer &);
  byte_filer &operator =(const byte_filer &);
};
 
} //namespace.
 
#endif