wefts_coffee_base.h

Go to the documentation of this file.

/*
   wefts_coffee_base.h
   Abstract base class for cooperative file functions enlarged enviroment

   $Id: wefts_coffee_base.h,v 1.3 2004/03/08 20:28:53 jonnymind Exp $
---------------------------------------------
   Begin      : 2003-08-15 16:30
   Author     : Giancarlo Niccolai

   Last modified because:

*/

/**************************************************************************
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU Library General Public License as       *
*   published by the Free Software Foundation; either version 2.1 of the  *
*   License, or (at your option) any later version.                       *
***************************************************************************/


#ifndef WT_COFFEE_BASE_H
#define WT_COFFEE_BASE_H

#include <wefts_cleanup.h>
#include <string>

namespace Wefts {

#if defined(_MSC_VER) || defined(__BORLANDC__) 
typedef unsigned __int64 file_size_t;
#else
typedef long long file_size_t;
#endif

typedef enum {
   /* The file shuold not be locked */
   LM_SHARED,
   /* The file shuold not be locked against writes, but read may occour */
   LM_SHARED_RO,
   /* The file shuold not be locked against both reads & writes */
   LM_EXCLUSIVE,
} LockMode;


typedef enum {
   OM_RO,
   OM_WO,
   OM_RW,
   OM_TRUNC_WO,
   OM_TRUNC_RW,
   OM_APPEND_WO,
   OM_APPEND_RW
} OpenMode;

typedef enum {
   CM_ARCHIVE,
   CM_SYSTEM,
   CM_EXECUTABLE,
   CM_PRIVATE,
   CM_PRIVATE_EX
} CreateMode;


typedef enum {
   CFF_DONE,
   CFF_WAITING,
   CFF_TIMEDOUT,

   CFF_SOFTERROR,

   CFF_HARDERROR,

   CFF_PROGERROR
}CffStatus;

typedef enum {
   SW_FROM_BEGIN=0,
   SW_FROM_CUR=1,
   SW_FROM_CURENT=1,
   SW_FROM_END=2
} SeekWhence;

class OSFileFuncBase {
protected:
   OSFileFuncBase() {
      m_timeout = -1.0;
      m_osError = 0;
      m_status = CFF_DONE;
   }

   double m_timeout;
   CffStatus m_status;
   int m_osError;

public:
   virtual inline CffStatus open(
      std::string filespec,             // the file name
      OpenMode openMode = OM_RO,        // open mode
      LockMode lockMode = LM_SHARED   // the file lock mode
      ) = 0;

   virtual inline CffStatus create(
      std::string filespec,               // the file name
      CreateMode cMode = CM_ARCHIVE,      // system atrribute
      LockMode lockMode = LM_EXCLUSIVE  // the file lock mode
      ) = 0;

   inline virtual void getDescriptor( void *data ) const = 0;

   inline virtual void setDescriptor( void *data ) = 0;


   inline CffStatus status() const { return m_status; }

   inline void status(const CffStatus st ) { m_status = st ; }

   inline int osError() const { return m_osError; }

   inline void osError( const int osError ) { m_osError = osError; }


   inline double timeout() const { return m_timeout; }

   inline void timeout( const double to ) { m_timeout = to; }

   /* Clears the timeout.
     All the operations on this class will be blocking.
   */
   inline void clearTimeout() { timeout( -1.0 ); }

   /* Set all operations on this class to be non-blocking.
     Functions will return immediately if the operation cannot be
     compelted without any wait.
   */
   inline void dontBlock() { timeout( 0.0 ); }

   virtual file_size_t read( void *buffer, const file_size_t len ) = 0;

   virtual file_size_t write( void *buffer, const file_size_t len ) = 0;

   virtual file_size_t seek(
      const file_size_t position,
      const SeekWhence swFrom= SW_FROM_BEGIN
      ) = 0;

   virtual CffStatus close()=0;

   inline virtual void setStdIn() = 0;
   
   inline virtual void setStdOut() = 0;
   
   inline virtual void setStdErr() = 0;

};

} // namespace

#endif

/* end of wefts_coffee_base.h */

---