hkStreamReader.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:4k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
  6.  * 
  7.  */
  8. #ifndef HKBASE_HKSTREAMREADER_H
  9. #define HKBASE_HKSTREAMREADER_H
  10. /// A generic interface to reading a stream of bytes.
  11. /// The reader may optionally support mark/rewind or may be
  12. /// wrapped as a child stream of an hkBufferedStreamReader.
  13. /// Derived classes need only override isOk() and read(). Usually
  14. /// readers which do not support buffering are wrapped in an
  15. /// hkBufferedStreamReader.
  16. class hkStreamReader : public hkReferencedObject
  17. {
  18. public:
  19. HK_DECLARE_CLASS_ALLOCATOR(HK_MEMORY_CLASS_STREAM);
  20. hkStreamReader() {}
  21. /// Return false after we have tried to read past the end of file or some other error.
  22. /// Otherwise return true.
  23. virtual hkBool isOk() const = 0;
  24. /// Read 'nbytes' into the buffer 'buf'.
  25. /// Return the number of characters read or zero for error.
  26. virtual int read(void* buf, int nbytes) = 0;
  27. /// Skip nbytes bytes of input.
  28. /// Return the actual number of bytes skipped.
  29. virtual int skip(int nbytes);
  30. /// Read a single char. Return the character or -1 on error.
  31. int readChar();
  32. /// Return true if marks may be set. By default marks are not supported.
  33. /// Derived classes may override this and setMark, rewindToMark.
  34. /// You can make any class support the mark interface by wrapping it
  35. /// in a hkBufferedStreamReader.
  36. virtual hkBool markSupported() const;
  37. /// Remember a point in the input stream. Rewind to it using rewindToMark().
  38. /// At most marklimit characters are stored. If more than marklimit
  39. /// characters are read before a call to rewindToMark() is made or
  40. /// seek is called then the mark is discarded.
  41. /// Calling setMark() overwrites the previous mark if it exists. 
  42. /// This may fail if markLimit is larger than the buffer size.
  43. virtual hkResult setMark(int markLimit);
  44. /// Rewind to a position marked with setMark().
  45. /// If a mark is set and no more than marklimit characters have been
  46. /// read, rewind the stream and return HK_SUCCESS. It is permitted to
  47. /// call rewindToMark() more than once.
  48. /// If more than marklimit characters have been read, the stream is not
  49. /// rewound and HK_FAILURE is returned.
  50. virtual hkResult rewindToMark();
  51. /// Return true if seeking is supported on this stream. By default not supported.
  52. virtual hkBool seekTellSupported() const;
  53. /// Parameter for seek method.
  54. enum SeekWhence { STREAM_SET=0, STREAM_CUR=1, STREAM_END=2 };
  55. /// Seek to offset from whence.
  56. virtual hkResult seek(int offset, SeekWhence whence);
  57. /// Get the current file offset if supported or -1 on error.
  58. virtual int tell() const;
  59. };
  60. #endif //HKBASE_HKSTREAMREADER_H
  61. /*
  62. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  63. * Confidential Information of Havok.  (C) Copyright 1999-2009
  64. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  65. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  66. * rights, and intellectual property rights in the Havok software remain in
  67. * Havok and/or its suppliers.
  68. * Use of this software for evaluation purposes is subject to and indicates
  69. * acceptance of the End User licence Agreement for this product. A copy of
  70. * the license is included with this software and is also available at www.havok.com/tryhavok.
  71. */