mi32/genericrw.h

Go to the documentation of this file.

#ifndef  INC_MI32_GENERICRW_H
#define  INC_MI32_GENERICRW_H

#ifndef  INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

//===================================================================================================================

// This class is exported from DLL.
// Adding virtual methods will require complete rebuild of all dependent DLLs and EXEs.
class CLASSLIBEXPORT GENERICRW {
   public:

      enum SEEKFROM {
         SEEKFROM_Beginning = 0,
         SEEKFROM_Current,
         SEEKFROM_End
         };

      enum CAPABILITIES {
         CAPABILITY_None =          0x0000,
         CAPABILITY_Read =          0x0001,
         CAPABILITY_Write =         0x0002,
         CAPABILITY_Seek =          0x0004,
         CAPABILITY_Resize =        0x0008,
         CAPABILITY_Accept =        0x0010,     
         CAPABILITY_Bind   =        0x0020,     
         CAPABILITY_NonBlocking  =  0x0040,     
         CAPABILITY_Size   =        0x0080,     
         CAPABILITIES_All =         0x00FF
         };

      virtual ~GENERICRW ();
         
      CAPABILITIES GetCapabilities (
         ) const;

      INT64 GetSize (
         ) const;

      INT64 GetSizeLimit (
         ) const;

      void* GetMappedMemory (
         INT64& size,                  
         INT64 offset = 0              
         );

      INT32 Read (
         void* buffer,                       
         INT32 numbytes,                     
         bool AllowPartial = false           
         );

      ERRVALUE ReadAll (
         SIMPLE_ARRAY<UINT8>& buffer         
         );

      ERRVALUE Resize (
         INT64 newsize                       
         );

      INT64 Seek (
         INT64 offset,                       
         SEEKFROM from = SEEKFROM_Beginning  
         );

      ERRVALUE SeekAndRead (
         INT64 offset,                       
         void* buffer,                       
         INT32 numbytes                      
         );

      ERRVALUE SeekAndWrite (
         INT64 offset,                       
         const void* buffer,                 
         INT32 numbytes                      
         );

      INT64 Tell (
         ) const;

      ERRVALUE Write (
         const void* buffer,                 
         INT32 numbytes                      
         );

   private:
      // Overridables.

      virtual CAPABILITIES v_GetCapabilities () const = 0;

      virtual void* v_GetMappedMemory (INT64& size, INT64 offset);

      virtual INT64 v_GetSize () const = 0;

      virtual INT64 v_GetSizeLimit () const = 0;

      virtual INT32 v_Read (void* buffer, INT32 numbytes, bool AllowPartial) = 0;

      virtual ERRVALUE v_Resize (INT64 newsize) = 0;

      virtual INT64 v_Seek (INT64 offset, SEEKFROM from) = 0;

      virtual INT64 v_Tell () const = 0;

      virtual ERRVALUE v_Write (const void* buffer, INT32 numbytes) = 0;
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(GENERICRW::CAPABILITIES)
#endif

//===================================================================================================================

#undef   CLASSLIBEXPORT

#endif   // INC_MI32_GENERICRW_H

---