ICU 56.1: bytestream.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

bytestream.h
Go to the documentation of this file.
1 // Copyright (C) 2009-2012, International Business Machines
2 // Corporation and others. All Rights Reserved.
3 //
4 // Copyright 2007 Google Inc. All Rights Reserved.
5 // Author: sanjay@google.com (Sanjay Ghemawat)
6 //
7 // Abstract interface that consumes a sequence of bytes (ByteSink).
8 //
9 // Used so that we can write a single piece of code that can operate
10 // on a variety of output string types.
11 //
12 // Various implementations of this interface are provided:
13 // ByteSink:
14 // CheckedArrayByteSink Write to a flat array, with bounds checking
15 // StringByteSink Write to an STL string
16
17 // This code is a contribution of Google code, and the style used here is
18 // a compromise between the original Google code and the ICU coding guidelines.
19 // For example, data types are ICU-ified (size_t,int->int32_t),
20 // and API comments doxygen-ified, but function names and behavior are
21 // as in the original, if possible.
22 // Assertion-style error handling, not available in ICU, was changed to
23 // parameter "pinning" similar to UnicodeString.
24 //
25 // In addition, this is only a partial port of the original Google code,
26 // limited to what was needed so far. The (nearly) complete original code
27 // is in the ICU svn repository at icuhtml/trunk/design/strings/contrib
28 // (see ICU ticket 6765, r25517).
29
30 #ifndef __BYTESTREAM_H__
31 #define __BYTESTREAM_H__
32
38 #include "unicode/utypes.h"
39 #include "unicode/uobject.h"
40 #include "unicode/std_string.h"
41
42 U_NAMESPACE_BEGIN
43
48 class U_COMMON_API ByteSink : public UMemory {
49 public:
54 ByteSink() { }
59 virtual ~ByteSink();
60
67 virtual void Append(const char* bytes, int32_t n) = 0;
68
111 virtual char* GetAppendBuffer(int32_t min_capacity,
112 int32_t desired_capacity_hint,
113 char* scratch, int32_t scratch_capacity,
114 int32_t* result_capacity);
115
124 virtual void Flush();
125
126 private:
127 ByteSink(const ByteSink &); // copy constructor not implemented
128 ByteSink &operator=(const ByteSink &); // assignment operator not implemented
129 };
130
131 // -------------------------------------------------------------
132 // Some standard implementations
133
143 class U_COMMON_API CheckedArrayByteSink : public ByteSink {
144 public:
151 CheckedArrayByteSink(char* outbuf, int32_t capacity);
156 virtual ~CheckedArrayByteSink();
165 virtual CheckedArrayByteSink& Reset();
172 virtual void Append(const char* bytes, int32_t n);
187 virtual char* GetAppendBuffer(int32_t min_capacity,
188 int32_t desired_capacity_hint,
189 char* scratch, int32_t scratch_capacity,
190 int32_t* result_capacity);
196 int32_t NumberOfBytesWritten() const { return size_; }
203 UBool Overflowed() const { return overflowed_; }
211 int32_t NumberOfBytesAppended() const { return appended_; }
212 private:
213 char* outbuf_;
214 const int32_t capacity_;
215 int32_t size_;
216 int32_t appended_;
217 UBool overflowed_;
218 CheckedArrayByteSink();
219 CheckedArrayByteSink(const CheckedArrayByteSink &);
220 CheckedArrayByteSink &operator=(const CheckedArrayByteSink &);
221 };
222
223 #if U_HAVE_STD_STRING
224
230 template<typename StringClass>
231 class StringByteSink : public ByteSink {
232 public:
238 StringByteSink(StringClass* dest) : dest_(dest) { }
245 virtual void Append(const char* data, int32_t n) { dest_->append(data, n); }
246 private:
247 StringClass* dest_;
248 StringByteSink();
249 StringByteSink(const StringByteSink &);
250 StringByteSink &operator=(const StringByteSink &);
251 };
252
253 #endif
254
255 U_NAMESPACE_END
256
257 #endif // __BYTESTREAM_H__
icu::ByteSink::GetAppendBuffer
virtual char * GetAppendBuffer(int32_t min_capacity, int32_t desired_capacity_hint, char *scratch, int32_t scratch_capacity, int32_t *result_capacity)
Returns a writable buffer for appending and writes the buffer's capacity to *result_capacity.
icu::StringByteSink::StringByteSink
StringByteSink(StringClass *dest)
Constructs a ByteSink that will append bytes to the dest string.
Definition: bytestream.h:238
icu::CheckedArrayByteSink::NumberOfBytesWritten
int32_t NumberOfBytesWritten() const
Returns the number of bytes actually written to the sink.
Definition: bytestream.h:196
icu::StringByteSink::Append
virtual void Append(const char *data, int32_t n)
Append "bytes[0,n-1]" to this.
Definition: bytestream.h:245
icu::CheckedArrayByteSink::Overflowed
UBool Overflowed() const
Returns true if any bytes were discarded, i.e., if there was an attempt to write more than 'capacity'...
Definition: bytestream.h:203
icu::ByteSink::ByteSink
ByteSink()
Default constructor.
Definition: bytestream.h:54
icu::ByteSink
A ByteSink can be filled with bytes.
Definition: bytestream.h:48
icu::ByteSink::Append
virtual void Append(const char *bytes, int32_t n)=0
Append "bytes[0,n-1]" to this.
icu::CheckedArrayByteSink
Implementation of ByteSink that writes to a flat byte array, with bounds-checking: This sink will not...
Definition: bytestream.h:143
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
std_string.h
C++ API: Central ICU header for including the C++ standard header and for related definition...
uobject.h
C++ API: Common ICU base class UObject.
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
icu::CheckedArrayByteSink::NumberOfBytesAppended
int32_t NumberOfBytesAppended() const
Returns the number of bytes appended to the sink.
Definition: bytestream.h:211
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
icu::StringByteSink
Implementation of ByteSink that writes to a "string".
Definition: bytestream.h:231
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:357
icu::UMemory
UMemory is the common ICU base class.
Definition: uobject.h:110
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234