This private partially concrete class implements the basic/common logic for a frame decoder. More...

Detailed Description

This private partially concrete class implements the basic/common logic for a frame decoder.

A specialized subclass is required to supplied the details of the decoder.

#include <Decoder_.h>

Inheritance diagram for Cpl::Text::Frame::Decoder_:

Collaboration diagram for Cpl::Text::Frame::Decoder_:

Public Member Functions
	Decoder_ (char rawInputBuffer[], size_t sizeOfRawInputBuffer)
	Constructor.

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

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
virtual bool	isStartOfFrame () noexcept=0
	Returns true if at start-of-frame.

virtual bool	isEofOfFrame () noexcept=0
	Returns true if at end-of-frame.

virtual bool	isEscapeChar () noexcept=0
	Returns true if the start of the start of a escape sequence has been detected.

virtual bool	isLegalCharacter () noexcept=0
	Returns true if the current character is a legal/valid within a frame.

virtual bool	read (void *buffer, int numBytes, int &bytesRead)=0
	Attempts to read the specified number of bytes from the "input source" in the supplied buffer.

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
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

◆ Decoder_()

Cpl::Text::Frame::Decoder_::Decoder_	(	char	rawInputBuffer[],
		size_t	sizeOfRawInputBuffer
	)

Constructor.

The size of the rawInputBuffer determines how big of 'chunks' data is read from the "input source", i.e. it is a working buffer and does NOT have to be the size of the maximum possible input frame.

Member Function Documentation

◆ decodeEscapedChar()

virtual char Cpl::Text::Frame::Decoder_::decodeEscapedChar ( char escapedChar )

protectedvirtual

Returns the un-encoded value for the specified escaped character.

The default implementation simply returns 'escapedChar'

◆ initializeFrame()

virtual void Cpl::Text::Frame::Decoder_::initializeFrame ( )

protectedvirtualnoexcept

Helper method to initialize frame processing.

◆ isEofOfFrame()

virtual bool Cpl::Text::Frame::Decoder_::isEofOfFrame ( )

protectedpure virtualnoexcept

Returns true if at end-of-frame.

Implemented in Cpl::Text::Frame::AsciiDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE >, Cpl::Text::Frame::StringDecoder, and Driver::TPipe::Maker.

◆ isEscapeChar()

virtual bool Cpl::Text::Frame::Decoder_::isEscapeChar ( )

protectedpure virtualnoexcept

Returns true if the start of the start of a escape sequence has been detected.

Implemented in Cpl::Text::Frame::AsciiDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE >, Cpl::Text::Frame::StringDecoder, and Driver::TPipe::Maker.

◆ isLegalCharacter()

virtual bool Cpl::Text::Frame::Decoder_::isLegalCharacter ( )

protectedpure virtualnoexcept

Returns true if the current character is a legal/valid within a frame.

Implemented in Cpl::Text::Frame::AsciiDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE >, Cpl::Text::Frame::StringDecoder, and Driver::TPipe::Maker.

◆ isStartOfFrame()

virtual bool Cpl::Text::Frame::Decoder_::isStartOfFrame ( )

protectedpure virtualnoexcept

Returns true if at start-of-frame.

Implemented in Cpl::Text::Frame::AsciiDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< BUFSIZE >, Cpl::Text::Frame::LineDecoder< OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE >, Cpl::Text::Frame::StringDecoder, and Driver::TPipe::Maker.

◆ oobRead()

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

virtualnoexcept

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

Implements Cpl::Text::Frame::Decoder.

◆ read()

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

protectedpure virtual

Attempts to read the specified number of bytes from the "input source" in the supplied buffer.

The actual number of bytes read is returned via 'bytesRead'. Returns true if successful, or false if End-of-Input was encountered.

Implemented in Cpl::Text::Frame::StreamDecoder, and Cpl::Text::Frame::StringDecoder.

◆ scan() [1/2]

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

virtualnoexcept

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

Implements Cpl::Text::Frame::Decoder.

Reimplemented in Cpl::Text::Frame::StringDecoder.

◆ scan() [2/2]

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

virtualnoexcept

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

Implements Cpl::Text::Frame::Decoder.

Member Data Documentation

◆ m_buffer

char* Cpl::Text::Frame::Decoder_::m_buffer

protected

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

◆ m_bufSize

size_t Cpl::Text::Frame::Decoder_::m_bufSize

protected

Size of my raw input buffer.

◆ m_dataLen

int Cpl::Text::Frame::Decoder_::m_dataLen

protected

Current number of characters remaining in my raw input buffer.

◆ m_dataPtr

char* Cpl::Text::Frame::Decoder_::m_dataPtr

protected

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

◆ m_escaping

bool Cpl::Text::Frame::Decoder_::m_escaping

protected

Flag: the next character is an escape character.

◆ m_framePtr

char* Cpl::Text::Frame::Decoder_::m_framePtr

protected

Pointer to the next decoded frame character.

◆ m_frameSize

size_t Cpl::Text::Frame::Decoder_::m_frameSize

protected

Number of bytes current decoded for the frame.

◆ m_inFrame

bool Cpl::Text::Frame::Decoder_::m_inFrame

protected

Flag: I am currently in a Frame.

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

Cpl/Text/Frame/Decoder_.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Decoder_()

Member Function Documentation

◆ decodeEscapedChar()

◆ initializeFrame()

◆ isEofOfFrame()

◆ isEscapeChar()

◆ isLegalCharacter()

◆ isStartOfFrame()

◆ oobRead()

◆ read()

◆ scan() [1/2]

◆ scan() [2/2]

Member Data Documentation

◆ m_buffer

◆ m_bufSize

◆ m_dataLen

◆ m_dataPtr

◆ m_escaping

◆ m_framePtr

◆ m_frameSize

◆ m_inFrame