The base class to a family of classes that decode various kinds of encoded byte streams. More...

#include "stringDecoder.h"

Inheritance diagram for StringDecoder:

Public Member Functions
	StringDecoder (const std::string &input)

virtual char32_t	get_next_character ()
	Returns the next character in sequence. More...

bool	is_eof ()
	Returns true if the decoder has returned the last character in the string, false if there are more to go. More...

Static Public Member Functions
static std::ostream *	get_notify_ptr ()
	Returns the ostream that is used to write error messages to. More...

static void	set_notify_ptr (std::ostream *ptr)
	Sets the ostream that is used to write error messages to. More...

Detailed Description

The base class to a family of classes that decode various kinds of encoded byte streams.

Give it a string, then ask it to pull the characters out one at a time. This also serves as the plain old byte-at-a-time decoder.

Definition at line 24 of file stringDecoder.h.

Member Function Documentation

◆ get_next_character()

char32_t StringDecoder::get_next_character ( )

virtual

Returns the next character in sequence.

Reimplemented in StringUtf16Decoder, and StringUtf8Decoder.

Definition at line 30 of file stringDecoder.cxx.

◆ get_notify_ptr()

std::ostream * StringDecoder::get_notify_ptr ( )

static

Returns the ostream that is used to write error messages to.

See set_notify_ptr().

Definition at line 53 of file stringDecoder.cxx.

◆ is_eof()

bool StringDecoder::is_eof ( )

inline

Returns true if the decoder has returned the last character in the string, false if there are more to go.

Definition at line 28 of file stringDecoder.I.

◆ set_notify_ptr()

void StringDecoder::set_notify_ptr ( std::ostream * notify_ptr )

static

Sets the ostream that is used to write error messages to.

This is necessary because of the low-level placement of this class, before the definition of the NotifyCategory class, so it cannot specify its own notify.

Definition at line 44 of file stringDecoder.cxx.

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

dtool/src/dtoolutil/stringDecoder.h
dtool/src/dtoolutil/stringDecoder.cxx
dtool/src/dtoolutil/stringDecoder.I