piodevice.h

Go to the documentation of this file.

/*
 *   P::Classes - Portable C++ Application Framework
 *   Copyright (C) 2000-2003  Christian Prochnow <cproch@seculogix.de>
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser 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
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _piodevice_h_
#define _piodevice_h_

#include <pclasses/pconfig.h>
#include <pclasses/pexport.h>
#include <pclasses/pexception.h>
#include <pclasses/ptypes.h>

#ifdef WIN32
  #include <windows.h>
#endif

namespace P {

#ifdef WIN32
  typedef HANDLE io_handle_t;
#else
  typedef int io_handle_t;
  enum { INVALID_HANDLE_VALUE = -1 };
#endif


class PCORE_EXPORT IODevice {
  public:

    enum accessMode_t {
      Read,     
      Write,    
      ReadWrite 
    };
    

    enum shareMode_t {
      AllowNone,      
      AllowRead,      
      AllowWrite,     
      AllowReadWrite  
    };
    
    enum seekMode_t {
      seekSet,     
      seekCurrent, 
      seekEnd      
    };

    IODevice() throw()
    : m_handle(INVALID_HANDLE_VALUE)
    { }


    IODevice(io_handle_t handle) throw(IOError);

    IODevice(const IODevice& dev) throw(IOError);

    virtual ~IODevice() throw();

    virtual void close() throw(IOError);

    virtual size_t write(const char* buffer, size_t count) throw(IOError);

    virtual size_t read(char* buffer, size_t count) throw(IOError);


    virtual size_t peek(char* buffer, size_t count) throw(IOError)
    { throw IOError(0, "peek() is not supported on this type of device", P_SOURCEINFO); }

    virtual void commit() throw(IOError);

    #ifndef HAVE_LARGEFILE64
    virtual off_t seek(off_t offset, seekMode_t mode) throw(IOError);
    #else
    virtual off64_t seek(off64_t offset, seekMode_t mode) throw(IOError);
    #endif

    virtual bool isSeekable() const throw();

    inline bool isValid() const throw()
    { return (m_handle != INVALID_HANDLE_VALUE); }

    IODevice& operator=(const IODevice& dev) throw(IOError);

    inline io_handle_t handle() const throw()
    { return m_handle; }

    static void copy(IODevice& src, IODevice& dst, bool commit = false);
    
  protected:
    inline void setHandle(io_handle_t handle) throw()
    { m_handle = handle; }

  private:
    io_handle_t   m_handle;
};

}

#endif

---