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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/***************************************************************************
buffer.h - description
-------------------
begin : Thu Jun 6 2002
Copyright (c) 2002 by Tom Linsky <twl6@po.cwru.edu>
Copyright (c) 2003-2004 by Matt Rogers <mattr@kde.org>
Kopete (c) 2002-2004 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef BUFFER_H
#define BUFFER_H
#include "oscartypes.h"
#include <qvaluelist.h>
#include <qcstring.h>
class QString;
using namespace Oscar;
/**
* @brief A data buffer
*/
class Buffer
{
public:
/** Default constructor */
Buffer();
Buffer( const Buffer& other );
/**
* \brief Create a prefilled buffer
*
* Constructor that creates a prefilled buffer of @p len length
* that contains the data from @p b.
*/
Buffer(const char *b, Q_ULONG len);
/**
* \brief Create a prefilled buffer
*
* Constructor that creates a prefilled buffer from the QByteArray \p data
*/
Buffer( const QByteArray& data );
/** Default destructor */
~Buffer();
/**
* returns the raw buffer
*/
char *buffer() const;
/**
* Returns the remaining length of the buffer past the current read
* position.
*/
int length() const;
/**
* adds the given string to the buffer (make sure it's NULL-terminated)
*/
int addString(QByteArray);
int addString(QByteArray, DWORD);
int addString(const char*, DWORD);
int addString(const unsigned char*, DWORD);
/**
* Little-endian version of addString
*/
int addLEString(const char *, const DWORD);
/**
* adds the given string to the buffer with the length in front of it
* (make sure it's NULL-terminated)
*/
int addLNTS(const char * s);
/**
* Little-endian version of addLNTS
*/
int addLELNTS(const char * s);
/**
* adds the given DWord to the buffer
*/
int addDWord(const DWORD);
/**
* adds the given word to the buffer
*/
int addWord(const WORD);
/**
* adds the given word to the buffer in
* little-endian format as needed by old icq server
*/
int addLEWord(const WORD w);
/**
* adds the given DWord to the buffer in
* little-endian format as needed by old icq server
*/
int addLEDWord(const DWORD dw);
/**
* adds the given byte to the buffer
*/
int addByte(const BYTE);
int addLEByte(const BYTE);
/**
* empties the current buffer.
*/
void clear();
/**
* Adds a TLV to the buffer
*/
int addTLV( const TLV& t );
/**
* Adds a TLV with the given type and data
*/
int addTLV(WORD, WORD, const char *);
/**
* Adds a little-endian TLV with the given type and data
*/
int addLETLV(WORD, WORD, const char *);
/**
* Returns a QString representation of the buffer
*/
QString toString() const;
/**
* gets a DWord out of the buffer
*/
DWORD getDWord();
/**
* Gets a word out of the buffer
*/
WORD getWord();
/**
* Gets a byte out of the buffer
* It's not a constant method. It advances the buffer
* to the next BYTE after returning one.
*/
BYTE getByte();
/**
* Skip \p bytesToSkip number of bytes in the buffer
* Like getByte() the buffer is advanced when skipping
*/
void skipBytes( int bytesToSkip );
/**
* Same as above but returns little-endian
*/
WORD getLEWord();
DWORD getLEDWord();
BYTE getLEByte();
/**
* Set the buffer to the given values.
*/
void setBuf(char *, const WORD);
/**
* Allocates memory for and gets a block of buffer bytes
*/
QByteArray getBlock(WORD len);
QByteArray getBBlock(WORD len);
/**
* Allocates memory for and gets a block of buffer words
*/
WORD *getWordBlock(WORD len);
/**
* Same as above but returning little-endian
*/
QCString getLEBlock(WORD len);
/**
* Convenience function that gets a LNTS (long null terminated string)
* from the buffer. Otherwise you'd need a getWord() + getBlock() call :)
*/
QCString getLNTS();
QCString getLELNTS();
/**
* adds a 16-bit long TLV
*/
int addTLV16(const WORD type, const WORD data);
/**
* adds a 16-bit long little-endian TLV
*/
int addLETLV16(const WORD type, const WORD data);
/**
* adds the given byte to a TLV
*/
int addTLV8(const WORD type, const BYTE data);
/**
* adds the given byte to a little-endian TLV
*/
int addLETLV8(const WORD type, const BYTE data);
/**
* Gets a TLV, storing it in a struct and returning it
*/
TLV getTLV();
/**
* Gets a list of TLV's
*/
QValueList<TLV> getTLVList();
/**
* Creates a chat data segment for a tlv and calls addTLV with that data
*/
int addChatTLV(const WORD, const WORD, const QString &, const WORD);
/**
* Similar to the LNTS functions but string is NOT null-terminated
*/
int addBSTR(const char * s);
QByteArray getBSTR();
QString peekBSTR();
int addBUIN(const char * s);
QByteArray getBUIN();
QString peekBUIN();
operator QByteArray() const;
private:
/**
* Make the buffer bigger by @p inc bytes
*/
void expandBuffer(unsigned int inc);
private:
QByteArray mBuffer;
unsigned int mReadPos;
};
#endif
// kate: tab-width 4; indent-mode csands;
// vim: set noet ts=4 sts=4 sw=4:
|
