panini::ConsoleWriter Class Reference

Writes output to the console. More...

#include <ConsoleWriter.hpp>

Inheritance diagram for panini::ConsoleWriter:

Public Member Functions
	ConsoleWriter (const ConsoleWriterConfig &config=ConsoleWriterConfig())
	ConsoleWriter (std::ostream &outputStream, const ConsoleWriterConfig &config=ConsoleWriterConfig())
Public Member Functions inherited from panini::ConfiguredWriter< ConsoleWriterConfig >
	ConfiguredWriter (const ConsoleWriterConfig &config=ConsoleWriterConfig {})
virtual	~ConfiguredWriter ()=default
const WriterConfig &	GetConfig () const override
BraceBreakingStyle	GetBraceBreakingStyle () const override
IncludeStyle	GetIncludeStyle () const override
bool	IsOnNewLine () const override
Writer &	operator<< (const std::string &chunk) override
Writer &	operator<< (const char *chunkString) override
Writer &	operator<< (const NextLine &command) override
Writer &	operator<< (const IndentPush &command) override
Writer &	operator<< (const IndentPop &command) override
Writer &	operator<< (Command &&command) override
void	SetIsInCommentBlock (bool value) override
virtual bool	IsChanged () const override
bool	Commit (bool force=false) override
Public Member Functions inherited from panini::Writer
virtual	~Writer ()=default

Protected Member Functions
void	Write (const std::string &chunk) override
void	WriteNewLine () override
bool	OnCommit (bool force) override
Protected Member Functions inherited from panini::ConfiguredWriter< ConsoleWriterConfig >
void	WriteNewLine () override

Protected Attributes
std::ostream &	m_outputStream
Protected Attributes inherited from panini::ConfiguredWriter< ConsoleWriterConfig >
ConsoleWriterConfig	m_config

Detailed Description

Writes output to the console.

The ConsoleWriter will write to std::cout by default, which is the default output stream for console programs. You can write to a different stream by supplying it as the first argument to the constructor.

See also

ConsoleWriterConfig

Constructor & Destructor Documentation

ConsoleWriter() [1/2]

panini::ConsoleWriter::ConsoleWriter ( const ConsoleWriterConfig &  config = ConsoleWriterConfig() )

inlineexplicit

Write to the default output stream for console programs.

Parameters

config

Configuration instance

ConsoleWriter() [2/2]

panini::ConsoleWriter::ConsoleWriter ( std::ostream &  outputStream, const ConsoleWriterConfig &  config = ConsoleWriterConfig()  )

inlineexplicit

Configure the output stream to use for the writer.

Parameters

outputStream	Stream used for writing
config	Configuration instance

Member Function Documentation

OnCommit()

bool panini::ConsoleWriter::OnCommit ( bool  force )

inlineoverrideprotectedvirtual

Checks if the writer should commit its output to the target.

Implements panini::Writer.

Write()

void panini::ConsoleWriter::Write ( const std::string &  chunk )

inlineoverrideprotectedvirtual

Writes the chunk to the console stream.

Implements panini::Writer.

WriteNewLine()

void panini::ConsoleWriter::WriteNewLine ( )

inlineoverrideprotectedvirtual

Writes a new line chunk to the output.

Implements panini::Writer.

Member Data Documentation

m_outputStream

std::ostream& panini::ConsoleWriter::m_outputStream

protected

---

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

• include/writers/ConsoleWriter.hpp