hxbufdataf.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:7k
源码类别:

Symbian

开发平台:

Visual C++

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