hxbufdataf.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:6k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _HX_BUFFERED_DATA_FILE_H_
  36. #define _HX_BUFFERED_DATA_FILE_H_
  37. #include "hxtypes.h"
  38. #include "hxcom.h"
  39. #include "hxdataf.h"
  40. class HXBufferedDataFile : public IHXDataFile {
  41. public:
  42. HXBufferedDataFile();
  43.     virtual ~HXBufferedDataFile();
  44.     /*
  45.      *  IUnknown methods
  46.      */
  47.     STDMETHOD(QueryInterface) (THIS_
  48. REFIID riid,
  49. void** ppvObj);
  50.     
  51.     STDMETHOD_(ULONG32, AddRef) (THIS);
  52.     
  53.     STDMETHOD_(ULONG32, Release) (THIS);
  54.     
  55.     /*
  56.      *  IHXDataFile methods
  57.      */
  58.     /* Bind DataFile Object with FileName */
  59.     STDMETHOD_(void, Bind) (THIS_
  60. const char* FileName);
  61.     /* Creates a datafile using the specified mode
  62.      * uOpenMode --- File Open mode - HX_FILE_READ/HX_FILE_WRITE/HX_FILE_BINARY
  63.      */
  64.     STDMETHOD(Create) (THIS_
  65. UINT16 uOpenMode);
  66.     /* Open will open a file with the specified mode
  67.      */
  68.     STDMETHOD(Open) (THIS_
  69. UINT16 uOpenMode);
  70.     /* Close closes a file 
  71.      * If the reference count on the IHXDataFile object is greater than 1, 
  72.      * then the underlying file cannot be safely closed, so Close() becomes 
  73.      * a noop in that case. Close it only when the object is destroyed. 
  74.      * This would be safe, but could lead to a file descriptor leak.
  75.      */
  76.     STDMETHOD(Close) (THIS);
  77.     /* Name returns the currently bound file name in FileName.
  78.      * and returns TRUE, if the a name has been bound.  Otherwise
  79.      * FALSE is returned.
  80.      */
  81.     STDMETHOD_(BOOL, Name) (THIS_
  82. REF(IHXBuffer*) pFileName);
  83.     /*
  84.      * IsOpen returns TRUE if file is open.  Otherwise FALSE.
  85.      */
  86.     STDMETHOD_(BOOL, IsOpen) (THIS);
  87.     /* Seek moves the current file position to the offset from the
  88.      * fromWhere specifier returns current position of file or -1 on
  89.      * error.
  90.      */
  91.     STDMETHOD(Seek) (THIS_
  92. ULONG32 offset, UINT16 fromWhere);
  93.     /* Tell returns the current file position in the file */
  94.     STDMETHOD_(ULONG32, Tell) (THIS);
  95.     /* Read reads up to count bytes of data into buf.
  96.      * returns the number of bytes read, EOF, or -1 if the read failed 
  97.      */
  98.     STDMETHOD_(ULONG32, Read) (THIS_
  99. REF(IHXBuffer*) pBuf, 
  100. ULONG32 count);
  101.     /* Write writes up to count bytes of data from buf.
  102.      * returns the number of bytes written, or -1 if the write failed 
  103.      */
  104.     STDMETHOD_(ULONG32, Write) (THIS_
  105. REF(IHXBuffer*) pBuf); 
  106.     /* Flush out the data in case of buffered I/O
  107.      */
  108.     STDMETHOD(Flush) (THIS);
  109.     /*
  110.      * Return info about the data file such as permissions, time of creation
  111.      * size in bytes, etc.
  112.      */
  113.     STDMETHOD(Stat) (THIS_
  114. struct stat* buffer);
  115.     /* Return the file descriptor */
  116.     STDMETHOD_(INT16, GetFd) (THIS);
  117.     /* GetLastError returns the platform specific file error */
  118.     STDMETHOD(GetLastError) (THIS);
  119.     /* GetLastError returns the platform specific file error in
  120.      * string form.
  121.      */
  122.     STDMETHOD_(void, GetLastError) (THIS_
  123. REF(IHXBuffer*) err);
  124. protected:
  125.     INT32 NewBuf(); // grab a new buffer
  126.     INT32 FillBuf(); // fill buffer around current position
  127.     INT32 FlushBuf(); // flush buffer
  128.     void AllocBuf(); // allocate buffer
  129.     void FreeBuf(); // free buffer
  130. // read data at given position
  131.     INT32 Pread(void* buf, INT32 nbytes, ULONG32 off);
  132. // write data at given position
  133.     INT32 Pwrite(const void* buf, INT32 nbytes, ULONG32 off);
  134.     ULONG32 FlushSize(); // return flushed file size
  135.     ULONG32 LogicalSize(); // return file size including unflushed data
  136.     INT32 GetFileStat(struct stat* buf) const; // get file stat
  137.     INT32 GetPageSize() const; // get page size from system
  138. private:
  139. // don't implement these
  140.     HXBufferedDataFile(const HXBufferedDataFile&);
  141.     HXBufferedDataFile& operator=(const HXBufferedDataFile&);
  142.     LONG32 m_lRefCount; // reference count
  143.     UINT32 m_LastError; // error from last operation
  144.     IHXBuffer* m_pFileName; // file name
  145.     int m_Fd; // file descriptor
  146.     UINT16 m_Flags; // open flags
  147.     ULONG32 m_Begin; // beginning of buffer
  148.     UINT32 m_BufSize; // buffer size
  149.     UINT32 m_BufFill; // bytes in buffer from last fill
  150.     ULONG32 m_Offset; // current seek offset
  151.     ULONG32 m_FileOffset; // current seek offset in file
  152.     ULONG32 m_FlushSize; // current flushed size of file
  153.     char* m_pBuf; // buffer
  154.     UINT32 m_Dirty; // buffer has been written over
  155. };
  156. #endif /* _HX_BUFFERED_DATA_FILE_H_ */