isys::CYAMLEmitter Class Reference

Description

This class serializes test specification objects to YAML format.

See also

isys::IEmitter

#include <CYAMLEmitter.h>

Inheritance diagram for isys::CYAMLEmitter:

Public Types
enum	EObjectType
	This enum defines which type of object will be serialized. More...
enum	EYamlStyle {   EYAML_ANY_STYLE , EYAML_FLOW_STYLE ,   EYAML_BLOCK_STYLE }
	Enumeration of YAML styles. More...

Public Member Functions
	CYAMLEmitter (isys::ICStreamSPtr fileStream)
	This ctor may be called from SWIG wrappers, because it keeps reference to fileStream, so it can not happen for fileStream to be destroyed before this object is destroyed.
void	endDocument (bool implicit) override
	Ends the document. More...
void	endStream () override
	Ends output stream. More...
virtual std::string	escapeSpecialChars (const std::string &data) override
	This method modifies the input string so that it is in proper YAML syntax for scalars. More...
void	flush () override
	Flush the accumulated characters to the output.
virtual std::string	getIndent ()
	Returns indentation string added to each line of output.
virtual int	getLineNumber ()
	This method provides information about current line being written to the file. More...
virtual void	getRow (iconnect::StrVector &row, int rowIndex)
	This method returns row for the given index. More...
virtual void	setIndent (const std::string &indent)
	Sets indentation string added to each line of output.
virtual void	setLineNumber (int lineNumber)
	Can be used to set current line number in cases, where emitter does not start at the beginning of the stream, or to disable line counting by setting 'lineNumber' to LINE_NUM_NOT_SET. More...
void	startDocument (bool implicit) override
	Starts the document. More...
void	startStream () override
	Initializes the output stream object.
void	startStream (const std::string &userData) override
	Initializes the output stream object. More...
void	writeText (const std::string &text) override
	Writes unmodified text to output.

Member Enumeration Documentation

EObjectType

enum isys::IEmitter::EObjectType

inherited

This enum defines which type of object will be serialized.

It is use only by some emitters, because mapping from hierarchical to table structure depends on object being serialized, this enum is used to select the right mapping.

EYamlStyle

enum isys::IEmitter::EYamlStyle

inherited

Enumeration of YAML styles.

Enumerator
EYAML_ANY_STYLE	any style is allowed
EYAML_FLOW_STYLE	uses [] for sequences, {} for maps
EYAML_BLOCK_STYLE	moves to next line

Member Function Documentation

endDocument()

void isys::CYAMLEmitter::endDocument ( bool  implicit )

overridevirtual

Ends the document.

Parameters

implicit

if the document end indicator is implicit. It is considered as a stylistic parameter and may be ignored by the emitter. If true, YAML emitter adds terminating doc sequence: '...'

Implements isys::IEmitter.

endStream()

void isys::CYAMLEmitter::endStream ( )

overridevirtual

Ends output stream.

The output stream is NOT closed. Call this method after emitting is done.

Implements isys::IEmitter.

escapeSpecialChars()

virtual std::string isys::CYAMLEmitter::escapeSpecialChars ( const std::string &  data )

overridevirtual

This method modifies the input string so that it is in proper YAML syntax for scalars.

The string is surrounded with single quotes, all existing single quotes are escaped with a single quote, except the starting and ending one.

Implements isys::IEmitter.

getLineNumber()

virtual int isys::IEmitter::getLineNumber ( )

virtualinherited

This method provides information about current line being written to the file.

Not all emitters may provide this information. If emitter does not keep track of line numbers, this method should return LINE_NUM_NOT_SET. Emitter may return the number of all lines (for example CCSVEmitter).

getRow()

virtual void isys::IEmitter::getRow ( iconnect::StrVector &  row, int  rowIndex  )

virtualinherited

This method returns row for the given index.

Not all emitters may implement this method - an exception is throw in such case.

setLineNumber()

virtual void isys::IEmitter::setLineNumber ( int  lineNumber )

virtualinherited

Can be used to set current line number in cases, where emitter does not start at the beginning of the stream, or to disable line counting by setting 'lineNumber' to LINE_NUM_NOT_SET.

This is also the default value, so to enable line counting, call this method with value >= 0.

startDocument()

void isys::CYAMLEmitter::startDocument ( bool  implicit )

overridevirtual

Starts the document.

This method should be called after startStream().

Parameters

implicit

currently used by YAML emitter only. When true, the document is emitted without the leading '—'.

Implements isys::IEmitter.

startStream()

void isys::CYAMLEmitter::startStream ( const std::string &  userData )

overridevirtual

Initializes the output stream object.

Parameters

userData

text written directly to output stream, bypassing the underlying emitter. This can be used for writing comments or preprocessing instructions.

Implements isys::IEmitter.