panini::Writer Class Reference

Pure virtual interface for writers. More...

#include <Writer.hpp>

Inheritance diagram for panini::Writer:

Public Member Functions
virtual	~Writer ()=default
virtual const WriterConfig &	GetConfig () const =0
virtual BraceBreakingStyle	GetBraceBreakingStyle () const =0
virtual IncludeStyle	GetIncludeStyle () const =0
virtual bool	IsOnNewLine () const =0
virtual Writer &	operator<< (const std::string &chunk)=0
virtual Writer &	operator<< (const char *chunkString)=0
virtual Writer &	operator<< (const NextLine &command)=0
virtual Writer &	operator<< (const IndentPush &command)=0
virtual Writer &	operator<< (const IndentPop &command)=0
virtual Writer &	operator<< (Command &&command)=0
virtual void	SetIsInCommentBlock (bool value)=0
virtual bool	IsChanged () const =0
virtual bool	Commit (bool force)=0

Protected Member Functions
virtual void	Write (const std::string &chunk)=0
virtual void	WriteNewLine ()=0
virtual bool	OnCommit (bool force=false)=0

Detailed Description

Pure virtual interface for writers.

Writers take chunks and commands as input and process them to a target. They are configured with a Config instance that is passed to their constructor.

Writers commit their output to a target automatically when they are destroyed.

Constructor & Destructor Documentation

~Writer()

virtual panini::Writer::~Writer ( )

virtualdefault

Member Function Documentation

Commit()

virtual bool panini::Writer::Commit ( bool  force )

pure virtual

Commits the generated output to the target of a writer if the output was changed.

Parameters

force

Force writing the file even if the output was not changed.

Returns

Returns true if the commit was successful.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

GetBraceBreakingStyle()

virtual BraceBreakingStyle panini::Writer::GetBraceBreakingStyle ( ) const

pure virtual

Get the default brace breaking style.

Returns

Brace breaking style.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

GetConfig()

virtual const WriterConfig & panini::Writer::GetConfig ( ) const

pure virtual

Get a reference to the active Config for this writer.

Returns

Config object.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

GetIncludeStyle()

virtual IncludeStyle panini::Writer::GetIncludeStyle ( ) const

pure virtual

Get the default include style.

Returns

Include style.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

IsChanged()

virtual bool panini::Writer::IsChanged ( ) const

pure virtual

Check if the output was changed compared to what the implementation has seen before.

Implemented in panini::CompareWriter, panini::DebugWriter, panini::FileWriter, panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

IsOnNewLine()

virtual bool panini::Writer::IsOnNewLine ( ) const

pure virtual

Check whether the writer is on a new line and waiting for new chunks.

Returns

True if the writer is on a new line

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

OnCommit()

virtual bool panini::Writer::OnCommit ( bool  force = false )

protectedpure virtual

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

Implemented in panini::ConsoleWriter, panini::FileWriter, panini::StringWriter, panini::CompareWriter, and panini::DebugWriter.

operator<<() [1/6]

virtual Writer & panini::Writer::operator<< ( Command &&  command )

pure virtual

Visit a command.

Warning

Commands are moved instead of copied!

Commands are used to output chunks and modify the writer's state.

Returns

Reference to itself to allow for chaining

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

operator<<() [2/6]

virtual Writer & panini::Writer::operator<< ( const char *  chunkString )

pure virtual

Write a C-style string chunk to the output.

Will add indentation if the writer is on a new line.

Returns

Reference to itself to allow for chaining.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

operator<<() [3/6]

virtual Writer & panini::Writer::operator<< ( const IndentPop &  command )

pure virtual

Decrement the level of indentation.

Indentation is applied when the writer is on a new line. The level of indentation cannot go negative.

Returns

Reference to itself to allow for chaining.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

operator<<() [4/6]

virtual Writer & panini::Writer::operator<< ( const IndentPush &  command )

pure virtual

Increment the level of indentation.

Indentation is applied only when the writer is on a new line.

Returns

Reference to itself to allow for chaining.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

operator<<() [5/6]

virtual Writer & panini::Writer::operator<< ( const NextLine &  command )

pure virtual

Write a new line chunk to the output.

New line chunks can be configured with the Config.

Returns

Reference to itself to allow for chaining.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

operator<<() [6/6]

virtual Writer & panini::Writer::operator<< ( const std::string &  chunk )

pure virtual

Write an std::string chunk to the output.

Will add indentation if the writer is on a new line.

Returns

Reference to itself to allow for chaining.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

SetIsInCommentBlock()

virtual void panini::Writer::SetIsInCommentBlock ( bool  value )

pure virtual

Set the writer to be inside a comment block, which will add " * " after the indentation of a new line.

Implemented in panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

Write()

virtual void panini::Writer::Write ( const std::string &  chunk )

protectedpure virtual

Writes chunks to the output.

Implemented in panini::CompareWriter, panini::ConsoleWriter, panini::DebugWriter, panini::FileWriter, and panini::StringWriter.

WriteNewLine()

virtual void panini::Writer::WriteNewLine ( )

protectedpure virtual

Writes a new line chunk to the output.

Implemented in panini::ConsoleWriter, panini::DebugWriter, panini::ConfiguredWriter< TConfig >, panini::ConfiguredWriter< CompareWriterConfig >, panini::ConfiguredWriter< ConsoleWriterConfig >, panini::ConfiguredWriter< DebugWriterConfig >, panini::ConfiguredWriter< FileWriterConfig >, and panini::ConfiguredWriter< StringWriterConfig >.

---

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

• include/writers/Writer.hpp