This concrete class defines an interface a Text "Decoder" that accepts a null terminated string as its input source. More...

Detailed Description

This concrete class defines an interface a Text "Decoder" that accepts a null terminated string as its input source.

See Cpl::Text::Frame::Decoder for details on what is a decoder.

#include <StringDecoder.h>

Inheritance diagram for Cpl::Text::Frame::StringDecoder:

[legend]

Collaboration diagram for Cpl::Text::Frame::StringDecoder:

[legend]

Public Member Functions
	StringDecoder (char startOfFrame, char endOfFrame, char escapeChar, const char *inputSourceAsNullTerminatedString=0)
	Constructor.

virtual void	setInput (const char *inputSourceAsNullTerminatedString) noexcept
	This method allows the Application/consumer to change/Set the Input source.

virtual void	setInput (const char *inputSoruce, int sizeInBytesOfSource) noexcept
	This method allows the Application/consumer to change/Set the Input source.

virtual const char *	getRemainder () const noexcept
	This method return a pointer to the next character AFTER the LAST character decoded.

bool	scan (size_t maxSizeOfFrame, char *frame, size_t &frameSize) noexcept
	See Cpl::Text::Frame::Decoder.

Public Member Functions inherited from Cpl::Text::Frame::Decoder_
	Decoder_ (char rawInputBuffer[], size_t sizeOfRawInputBuffer)
	Constructor.

bool	scan (size_t maxSizeOfFrame, char *frame, size_t &frameSize, bool &isEof) noexcept
	See Cpl::Text::Frame::Decoder.

bool	oobRead (void *buffer, int numBytes, int &bytesRead) noexcept
	See Cpl::Text::Frame::Decoder.

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

Protected Member Functions
bool	isStartOfFrame () noexcept
	See Cpl::Text::Frame::Decoder_.

bool	isEofOfFrame () noexcept
	See Cpl::Text::Frame::Decoder_.

bool	isEscapeChar () noexcept
	See Cpl::Text::Frame::Decoder_.

bool	isLegalCharacter () noexcept
	See Cpl::Text::Frame::Decoder_.

bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Text::Frame::Decoder_.

Protected Member Functions inherited from Cpl::Text::Frame::Decoder_
virtual char	decodeEscapedChar (char escapedChar)
	Returns the un-encoded value for the specified escaped character.

virtual void	initializeFrame () noexcept
	Helper method to initialize frame processing.

Protected Attributes
const char *	m_startPtr
	From the last scan: start of the data being scanned.

const char *	m_endPtr
	From the last scan: pointer to the next character AFTER the LAST character decoded.

const char *	m_srcPtr
	Input source.

int	m_srcLen
	Input source length.

const char	m_sof
	SOF character.

const char	m_eof
	EOF character.

const char	m_esc
	Escape character.

Protected Attributes inherited from Cpl::Text::Frame::Decoder_
int	m_dataLen
	Current number of characters remaining in my raw input buffer.

char *	m_dataPtr
	Pointer to the next unprocessed character in my raw input buffer.

char *	m_buffer
	Raw input buffer for reading characters in 'chunks' from my Input stream (i.e. minimize the calls to read())

size_t	m_bufSize
	Size of my raw input buffer.

bool	m_inFrame
	Flag: I am currently in a Frame.

bool	m_escaping
	Flag: the next character is an escape character.

char *	m_framePtr
	Pointer to the next decoded frame character.

size_t	m_frameSize
	Number of bytes current decoded for the frame.

Constructor & Destructor Documentation

◆ StringDecoder()

Cpl::Text::Frame::StringDecoder::StringDecoder	(	char	startOfFrame,
		char	endOfFrame,
		char	escapeChar,
		const char *	inputSourceAsNullTerminatedString = `0`
	)

Constructor.

The optional 'inputSource' argument points to the raw frame data to be decoded. If 'inputSource' is not set at construction time, it MUST be set BEFORE scan() is called or a fatal error will be generated.

NOTE: Once scan() has be called the 'inputSouce' is considered to be consumed and the Application must make a call to setInput() before calling scan() again (if not, the scan() call will fail

i.e. return false - with an end-of-input error).

Member Function Documentation

◆ getRemainder()

virtual const char * Cpl::Text::Frame::StringDecoder::getRemainder ( ) const

virtualnoexcept

This method return a pointer to the next character AFTER the LAST character decoded.

The value returned from this method is ONLY valid after a call to scan() and BEFORE a subsequent call to scan(), oobRead(), or setInput().

◆ isEofOfFrame()

bool Cpl::Text::Frame::StringDecoder::isEofOfFrame ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

◆ isEscapeChar()

bool Cpl::Text::Frame::StringDecoder::isEscapeChar ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

◆ isLegalCharacter()

bool Cpl::Text::Frame::StringDecoder::isLegalCharacter ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

◆ isStartOfFrame()

bool Cpl::Text::Frame::StringDecoder::isStartOfFrame ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

◆ read()

bool Cpl::Text::Frame::StringDecoder::read	(	void *	buffer,
		int	numBytes,
		int &	bytesRead
	)

protectedvirtual

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

◆ scan()

bool Cpl::Text::Frame::StringDecoder::scan	(	size_t	maxSizeOfFrame,
		char *	frame,
		size_t &	frameSize
	)

virtualnoexcept

See Cpl::Text::Frame::Decoder.

Reimplemented from Cpl::Text::Frame::Decoder_.

◆ setInput() [1/2]

virtual void Cpl::Text::Frame::StringDecoder::setInput	(	const char *	inputSoruce,
		int	sizeInBytesOfSource
	)

virtualnoexcept

This method allows the Application/consumer to change/Set the Input source.

Note: 'sizeInBytesOfSource' does NOT include the/a null terminator

◆ setInput() [2/2]

virtual void Cpl::Text::Frame::StringDecoder::setInput ( const char * inputSourceAsNullTerminatedString )

virtualnoexcept

This method allows the Application/consumer to change/Set the Input source.

Member Data Documentation

◆ m_endPtr

const char* Cpl::Text::Frame::StringDecoder::m_endPtr

protected

From the last scan: pointer to the next character AFTER the LAST character decoded.

◆ m_eof

const char Cpl::Text::Frame::StringDecoder::m_eof

protected

EOF character.

◆ m_esc

const char Cpl::Text::Frame::StringDecoder::m_esc

protected

Escape character.

◆ m_sof

const char Cpl::Text::Frame::StringDecoder::m_sof

protected

SOF character.

◆ m_srcLen

int Cpl::Text::Frame::StringDecoder::m_srcLen

protected

Input source length.

◆ m_srcPtr

const char* Cpl::Text::Frame::StringDecoder::m_srcPtr

protected

Input source.

◆ m_startPtr

const char* Cpl::Text::Frame::StringDecoder::m_startPtr

protected

From the last scan: start of the data being scanned.

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

Cpl/Text/Frame/StringDecoder.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ StringDecoder()

Member Function Documentation

◆ getRemainder()

◆ isEofOfFrame()

◆ isEscapeChar()

◆ isLegalCharacter()

◆ isStartOfFrame()

◆ read()

◆ scan()

◆ setInput() [1/2]

◆ setInput() [2/2]

Member Data Documentation

◆ m_endPtr

◆ m_eof

◆ m_esc

◆ m_sof

◆ m_srcLen

◆ m_srcPtr

◆ m_startPtr