1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCORESTREAM_H
#define ROCKETCORESTREAM_H
#include "Header.h"
#include "ReferenceCountable.h"
#include "Types.h"
#include "URL.h"
#include <list>
namespace Rocket {
namespace Core {
class StreamListener;
/**
Abstract class for a media-independent byte stream.
@author Lloyd Weehuizen
*/
class ROCKETCORE_API Stream : public ReferenceCountable
{
public:
// Stream modes.
enum StreamMode
{
MODE_WRITE = 1 << 0,
MODE_APPEND = 1 << 1,
MODE_READ = 1 << 2,
MODE_ASYNC = 1 << 3,
MODE_MASK = MODE_WRITE | MODE_APPEND | MODE_READ
};
Stream();
virtual ~Stream();
/// Closes the stream.
virtual void Close();
/// Returns the mode the stream was opened in.
int GetStreamMode() const;
/// Obtain the source url of this stream (if available)
const URL& GetSourceURL() const;
/// Are we at the end of the stream
virtual bool IsEOS() const;
/// Returns the size of this stream (in bytes).
virtual size_t Length() const = 0;
/// Returns the position of the stream pointer (in bytes).
virtual size_t Tell() const = 0;
/// Sets the stream position (in bytes).
virtual bool Seek(long offset, int origin) const = 0;
/// Read from the stream.
virtual size_t Read(void* buffer, size_t bytes) const = 0;
/// Read from the stream into another stream.
virtual size_t Read(Stream* stream, size_t bytes) const;
/// Read from the stream and append to the string buffer
virtual size_t Read(String& buffer, size_t bytes) const;
/// Read from the stream, without increasing the stream offset.
virtual size_t Peek(void* buffer, size_t bytes) const;
/// Write to the stream at the current position.
virtual size_t Write(const void* buffer, size_t bytes) = 0;
/// Write to this stream from another stream.
virtual size_t Write(const Stream* stream, size_t bytes);
/// Write a character array to the stream.
virtual size_t Write(const char* string);
/// Write a string to the stream
virtual size_t Write(const String& string);
/// Truncate the stream to the specified length.
virtual size_t Truncate(size_t bytes) = 0;
/// Push onto the front of the stream.
virtual size_t PushFront(const void* buffer, size_t bytes);
/// Push onto the back of the stream.
virtual size_t PushBack(const void* buffer, size_t bytes);
/// Pop from the front of the stream.
virtual size_t PopFront(size_t bytes);
/// Pop from the back of the stream.
virtual size_t PopBack(size_t bytes);
/// Returns true if the stream is ready for reading, false otherwise.
/// This is usually only implemented on streams supporting asynchronous
/// operations.
virtual bool IsReadReady() = 0;
/// Returns true if the stream is ready for writing, false otherwise.
/// This is usually only implemented on streams supporting asynchronous
/// operations.
virtual bool IsWriteReady() = 0;
protected:
/// Sets the mode on the stream; should be called by a stream when it is opened.
void SetStreamDetails(const URL& url, int stream_mode);
/// Deletes the stream.
virtual void OnReferenceDeactivate();
private:
URL url;
int stream_mode;
};
}
}
#endif
|
