Panini 1.4.0
Header-only library for generating C++, written in C++17
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
panini::StringWriter Class Reference
Writers

Writes output to a string. More...

#include <StringWriter.hpp>

Inheritance diagram for panini::StringWriter:
panini::ConfiguredWriter< StringWriterConfig > panini::Writer

Public Member Functions

 StringWriter (std::string &target, const StringWriterConfig &config=StringWriterConfig())
 
- Public Member Functions inherited from panini::ConfiguredWriter< StringWriterConfig >
 ConfiguredWriter (const StringWriterConfig &config=StringWriterConfig {})
 
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
 
bool OnCommit (bool force) override
 
- Protected Member Functions inherited from panini::ConfiguredWriter< StringWriterConfig >
void WriteNewLine () override
 

Protected Attributes

std::string & m_target
 Target string that will be written to. More...
 
- Protected Attributes inherited from panini::ConfiguredWriter< StringWriterConfig >
StringWriterConfig m_config
 

Detailed Description

Writes output to a string.

See also
StringWriterConfig

Constructor & Destructor Documentation

◆ StringWriter()

panini::StringWriter::StringWriter ( std::string &  target,
const StringWriterConfig &  config = StringWriterConfig() 
)
inlineexplicit

Construct and configure the writer.

Parameters
targetString that output will be written to.
configConfiguration instance.

Member Function Documentation

◆ OnCommit()

bool panini::StringWriter::OnCommit ( bool  force)
inlineoverrideprotectedvirtual

Called when the writer is committed.

Implements panini::Writer.

◆ Write()

void panini::StringWriter::Write ( const std::string &  chunk)
inlineoverrideprotectedvirtual

Writes chunks to the output.

Implements panini::Writer.

Member Data Documentation

◆ m_target

std::string& panini::StringWriter::m_target
protected

Target string that will be written to.

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