filterStream.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _FILTERSTREAM_H_
25#define _FILTERSTREAM_H_
26
27//Includes
28#ifndef _PLATFORM_H_
29#include "platform/platform.h"
30#endif
31#ifndef _STREAM_H_
32#include "core/stream/stream.h"
33#endif
34
35class FilterStream : public Stream
36{
37  public:
38   virtual ~FilterStream();
39
40   virtual bool    attachStream(Stream* io_pSlaveStream) = 0;
41   virtual void    detachStream()                        = 0;
42   virtual Stream* getStream()                           = 0;
43
44   // Mandatory overrides.  By default, these are simply passed to
45   //  whatever is returned from getStream();
46  protected:
47   bool _read(const U32 in_numBytes,  void* out_pBuffer);
48   bool _write(const U32 in_numBytes, const void* in_pBuffer);
49  public:
50   bool hasCapability(const Capability) const;
51
52   U32  getPosition() const;
53   bool setPosition(const U32 in_newPosition);
54   U32  getStreamSize();
55};
56
57#endif //_FILTERSTREAM_H_
58