AutoUTFOutputStream< CharType, OutputByteStream >

Output stream wrapper with dynamically bound encoding and automatic encoding detection. More...

#include <encodedstream.h>

Collaboration diagram for AutoUTFOutputStream< CharType, OutputByteStream >:

Public Types
typedef CharType	Ch

Public Member Functions
	AutoUTFOutputStream (OutputByteStream &os, UTFType type, bool putBOM)
	Constructor. More...
UTFType	GetType () const
void	Put (Ch c)
void	Flush ()
Ch	Peek () const
Ch	Take ()
size_t	Tell () const
Ch *	PutBegin ()
size_t	PutEnd (Ch *)

Private Types
typedef void(*	PutFunc) (OutputByteStream &, Ch)

Private Member Functions
	RAPIDJSON_STATIC_ASSERT (sizeof(typename OutputByteStream::Ch)==1)
	AutoUTFOutputStream (const AutoUTFOutputStream &)
AutoUTFOutputStream &	operator= (const AutoUTFOutputStream &)
void	PutBOM ()

Private Attributes
OutputByteStream *	os_
UTFType	type_
PutFunc	putFunc_

Detailed Description

template<typename CharType, typename OutputByteStream>
class AutoUTFOutputStream< CharType, OutputByteStream >

Output stream wrapper with dynamically bound encoding and automatic encoding detection.

Template Parameters

CharType	Type of character for writing.
OutputByteStream	type of output byte stream to be wrapped.

Definition at line 233 of file encodedstream.h.

Member Typedef Documentation

Ch

typedef CharType Ch

Definition at line 236 of file encodedstream.h.

PutFunc

typedef void(* PutFunc) (OutputByteStream &, Ch)

private

Definition at line 280 of file encodedstream.h.

Constructor & Destructor Documentation

AutoUTFOutputStream() [1/2]

AutoUTFOutputStream ( OutputByteStream &  os, UTFType  type, bool  putBOM  )

inline

Constructor.

Parameters

os	output stream to be wrapped.
type	UTF encoding type.
putBOM	Whether to write BOM at the beginning of the stream.

Definition at line 244 of file encodedstream.h.

                                                                         : os_(&os), type_(type) {
        RAPIDJSON_ASSERT(type >= kUTF8 && type <= kUTF32BE);

        // Runtime check whether the size of character type is sufficient. It only perform checks with assertion.
        if (type_ == kUTF16LE || type_ == kUTF16BE) RAPIDJSON_ASSERT(sizeof(Ch) >= 2);
        if (type_ == kUTF32LE || type_ == kUTF32BE) RAPIDJSON_ASSERT(sizeof(Ch) >= 4);

        static const PutFunc f[] = { RAPIDJSON_ENCODINGS_FUNC(Put) };
        putFunc_ = f[type_];

        if (putBOM)
            PutBOM();
    }

Here is the call graph for this function:

AutoUTFOutputStream() [2/2]

AutoUTFOutputStream ( const AutoUTFOutputStream< CharType, OutputByteStream > &  )

private

Member Function Documentation

Flush()

void Flush ( )

inline

Definition at line 261 of file encodedstream.h.

{ os_->Flush(); } 

GetType()

UTFType GetType ( ) const

inline

Definition at line 258 of file encodedstream.h.

{ return type_; }

operator=()

AutoUTFOutputStream& operator= ( const AutoUTFOutputStream< CharType, OutputByteStream > &  )

private

Peek()

Ch Peek ( ) const

inline

Definition at line 264 of file encodedstream.h.

{ RAPIDJSON_ASSERT(false); return 0;}

Put()

void Put ( Ch  c )

inline

Definition at line 260 of file encodedstream.h.

{ putFunc_(*os_, c); }

PutBegin()

Ch* PutBegin ( )

inline

Definition at line 267 of file encodedstream.h.

{ RAPIDJSON_ASSERT(false); return 0; }

PutBOM()

void PutBOM ( )

inlineprivate

Definition at line 274 of file encodedstream.h.

                  { 
        typedef void (*PutBOMFunc)(OutputByteStream&);
        static const PutBOMFunc f[] = { RAPIDJSON_ENCODINGS_FUNC(PutBOM) };
        f[type_](*os_);
    }

PutEnd()

size_t PutEnd ( Ch *  )

inline

Definition at line 268 of file encodedstream.h.

{ RAPIDJSON_ASSERT(false); return 0; }

Here is the call graph for this function:

RAPIDJSON_STATIC_ASSERT()

RAPIDJSON_STATIC_ASSERT ( sizeof(typename OutputByteStream::Ch)  = =1 )

private

Take()

Ch Take ( )

inline

Definition at line 265 of file encodedstream.h.

{ RAPIDJSON_ASSERT(false); return 0;}

Tell()

size_t Tell ( ) const

inline

Definition at line 266 of file encodedstream.h.

{ RAPIDJSON_ASSERT(false); return 0; }

Member Data Documentation

os_

OutputByteStream* os_

private

Definition at line 282 of file encodedstream.h.

putFunc_

PutFunc putFunc_

private

Definition at line 284 of file encodedstream.h.

type_

UTFType type_

private

Definition at line 283 of file encodedstream.h.

---

The documentation for this class was generated from the following file:

• rapidjson/encodedstream.h