radiant/file.h

   1 /*
   2    Copyright (c) 2001, Loki software, inc.
   3    All rights reserved.
   4
   5    Redistribution and use in source and binary forms, with or without modification,
   6    are permitted provided that the following conditions are met:
   7
   8    Redistributions of source code must retain the above copyright notice, this list
   9    of conditions and the following disclaimer.
  10
  11    Redistributions in binary form must reproduce the above copyright notice, this
  12    list of conditions and the following disclaimer in the documentation and/or
  13    other materials provided with the distribution.
  14
  15    Neither the name of Loki software nor the names of its contributors may be used
  16    to endorse or promote products derived from this software without specific prior
  17    written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  20    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22    DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
  23    DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 //
  32 //      file.h
  33 ////////////////////////////////////////////////////
  34
  35 #ifndef _FILE_H_
  36 #define _FILE_H_
  37
  38 //#include <stdio.h>
  39
  40 class MemStream : public IDataStream
  41 {
  42 public:
  43 MemStream();
  44 MemStream( unsigned long nLen );
  45 virtual ~MemStream();
  46
  47 int refCount;
  48 void IncRef() { refCount++; }
  49 void DecRef() {
  50         refCount--; if ( refCount <= 0 ) {
  51                 delete this;
  52         }
  53 }
  54
  55 protected:
  56 // MemFile specific:
  57 unsigned long m_nGrowBytes;
  58 unsigned long m_nPosition;
  59 unsigned long m_nBufferSize;
  60 unsigned long m_nFileSize;
  61 unsigned char* m_pBuffer;
  62 bool m_bAutoDelete;
  63 void GrowFile( unsigned long nNewLen );
  64
  65 public:
  66 unsigned long GetPosition() const;
  67 unsigned long Seek( long lOff, int nFrom );
  68 void SetLength( unsigned long nNewLen );
  69 unsigned long GetLength() const;
  70
  71 unsigned char* GetBuffer() const
  72 { return m_pBuffer; }
  73
  74 char* ReadString( char* pBuf, unsigned long nMax );
  75 unsigned long Read( void* pBuf, unsigned long nCount );
  76 unsigned long Write( const void* pBuf, unsigned long nCount );
  77 int GetChar();
  78 int PutChar( int c );
  79
  80 void printf( const char*, ... ); ///< \todo implement on MemStream
  81
  82 void Abort();
  83 void Flush();
  84 void Close();
  85 bool Open( const char *filename, const char *mode );
  86 };
  87
  88 class FileStream : public IDataStream
  89 {
  90 public:
  91 FileStream();
  92 virtual ~FileStream();
  93
  94 int refCount;
  95 void IncRef() { refCount++; }
  96 void DecRef() {
  97         refCount--; if ( refCount <= 0 ) {
  98                 delete this;
  99         }
 100 }
 101
 102 protected:
 103 // DiscFile specific:
 104 FILE* m_hFile;
 105 bool m_bCloseOnDelete;
 106
 107 public:
 108 unsigned long GetPosition() const;
 109 unsigned long Seek( long lOff, int nFrom );
 110 void SetLength( unsigned long nNewLen );
 111 unsigned long GetLength() const;
 112
 113 char* ReadString( char* pBuf, unsigned long nMax );
 114 unsigned long Read( void* pBuf, unsigned long nCount );
 115 unsigned long Write( const void* pBuf, unsigned long nCount );
 116 int GetChar();
 117 int PutChar( int c );
 118
 119 void printf( const char*, ... ); ///< completely matches the usual printf behaviour
 120
 121 void Abort();
 122 void Flush();
 123 void Close();
 124 bool Open( const char *filename, const char *mode );
 125 };
 126
 127 #endif // _FILE_H_