This concrete class implements the Encoder API where the Output destination is a Cpl::Text::String. More...

Detailed Description

This concrete class implements the Encoder API where the Output destination is a Cpl::Text::String.

There is no checking/enforcement of the content of the Frame (e.g. it will accept non-ASCII character) except for the SOF, EOF, and ESC characters.

#include <StringEncoder.h>

Inheritance diagram for Cpl::Text::Frame::StringEncoder:

[legend]

Collaboration diagram for Cpl::Text::Frame::StringEncoder:

[legend]

Public Member Functions
	StringEncoder (Cpl::Text::String &dst, char startOfFrame, char endOfFrame, char escapeChar, bool appendNewline=true, bool appendToDst=false)
	Constructor.

Cpl::Text::String &	getFramedOutput ()
	Returns a reference to the String that holds the encoded frame. The contents of the buffer depends on the state of frame being built.

Public Member Functions inherited from Cpl::Text::Frame::Encoder_
bool	startFrame (void) noexcept
	See Cpl::Text::Frame::Encoder.

bool	output (char src) noexcept
	See Cpl::Text::Frame::Encoder.

bool	output (const char *src) noexcept
	See Cpl::Text::Frame::Encoder.

bool	output (const char *src, size_t numBytes) noexcept
	See Cpl::Text::Frame::Encoder.

bool	endFrame (void) noexcept
	See Cpl::Text::Frame::Encoder.

Public Member Functions inherited from Cpl::Text::Frame::Encoder
virtual	~Encoder ()
	Virtual Destructor.

Protected Member Functions
bool	start (char src) noexcept
	See Cpl::Text::Frame::Encoder_.

bool	start () noexcept
	See Cpl::Text::Frame::Encoder_.

bool	append (char src) noexcept
	See Cpl::Text::Frame::Encoder_.

Protected Member Functions inherited from Cpl::Text::Frame::Encoder_
	Encoder_ (char startOfFrame, char endOfFrame, char escapeChar, bool appendNewline=true)
	Constructor.

virtual char	encodeChar (char charToBeEscaped)
	Returns the encoded/escaped value for the specified special character.

Protected Attributes
Cpl::Text::String &	m_dst
	Output stream.

bool	m_append
	Append flag.

Protected Attributes inherited from Cpl::Text::Frame::Encoder_
bool	m_inFrame
	Output/Frame state.

const char	m_sof
	SOF character.

const char	m_eof
	EOF character.

const char	m_esc
	Escape character.

const bool	m_appendNewline
	Remember my newline option.

Constructor & Destructor Documentation

◆ StringEncoder()

Cpl::Text::Frame::StringEncoder::StringEncoder	(	Cpl::Text::String &	dst,
		char	startOfFrame,
		char	endOfFrame,
		char	escapeChar,
		bool	appendNewline = `true`,
		bool	appendToDst = `false`
	)

Constructor.

The 'appendNewline' argument when set to true will append a newline character to the output stream AFTER the EOF character (this can make for more human readable output stream). The 'appendToDst' flag when true will not clear contents of 'dst' on the start-of-frame - rather it will ALWAYS append all output to 'dst'

NOTES:

o If 'startOfFrame' is '\0', then Encoder will begin the
  frame WITHOUT inserting a SOF character.  This is useful
  when there application desires/has multiple start-of-frame
  characters for a given frame.

o If 'escapeChar' is '\0', then Encoder will NOT escape any
  characters - buyers beware when using this feature!