Implement an OUTPUTFORMATTER to a memory buffer. More...

#include <richio.h>

Inheritance diagram for STRING_FORMATTER:

Public Member Functions
	STRING_FORMATTER (int aReserve=OUTPUTFMTBUFZ, char aQuoteChar='"' )
	Reserve space in the buffer.

void	Clear ()
	Clear the buffer and empties the internal string.

void	StripUseless ()
	Removes whitespace, '(', and ')' from the string.

const std::string &	GetString ()

virtual const char *	GetQuoteChar (const char *wrapee) const
	Perform quote character need determination.

int PRINTF_FUNC	Print (int nestLevel, const char *fmt,...)
	Format and write text to the output stream.

virtual std::string	Quotes (const std::string &aWrapee) const
	Check aWrapee input string for a need to be quoted (e.g.

std::string	Quotew (const wxString &aWrapee) const

virtual bool	Finish ()
	Performs any cleanup needed at the end of a write.

Protected Member Functions
void	write (const char *aOutBuf, int aCount) override
	Should be coded in the interface implementation (derived) classes.

Static Protected Member Functions
static const char *	GetQuoteChar (const char wrapee, const char quote_char)
	Perform quote character need determination according to the Specctra DSN specification.

Private Member Functions
int	sprint (const char *fmt,...)

int	vprint (const char *fmt, va_list ap)

Private Attributes
std::string	m_mystring

std::vector< char >	m_buffer

char	quoteChar [2]

Detailed Description

Implement an OUTPUTFORMATTER to a memory buffer.

After Print()ing the string is available through GetString()

Definition at line 432 of file richio.h.

Constructor & Destructor Documentation

◆ STRING_FORMATTER()

STRING_FORMATTER::STRING_FORMATTER	(	int	aReserve = `OUTPUTFMTBUFZ`,
		char	aQuoteChar = `'"'`
	)

inline

Reserve space in the buffer.

Definition at line 438 of file richio.h.

Member Function Documentation

◆ Clear()

void STRING_FORMATTER::Clear ( )

inline

Clear the buffer and empties the internal string.

Definition at line 446 of file richio.h.

Referenced by PCB_IO_KICAD_SEXPR::GetStringOutput(), and DSN::ELEM::makeHash().

◆ Finish()

virtual bool OUTPUTFORMATTER::Finish ( )

inlinevirtualinherited

Performs any cleanup needed at the end of a write.

Returns: true if all is well

Reimplemented in PRETTIFIED_FILE_OUTPUTFORMATTER.

Definition at line 415 of file richio.h.

Referenced by PCB_IO_KICAD_SEXPR::SaveBoard().

◆ GetQuoteChar() [1/2]

const char * OUTPUTFORMATTER::GetQuoteChar ( const char * wrapee ) const

virtualinherited

Perform quote character need determination.

It returns the quote character as a single character string for a given input wrapee string. If the wrappee does not need to be quoted, the return value is "" (the null string), such as when there are no delimiters in the input wrapee string. If you want the quote_char to be assuredly not "", then pass in "(" as the wrappee.

Implementations are free to override the default behavior, which is to call the static function of the same name.

Parameters

wrapee A string that might need wrapping on each end.

Returns: the quote_char as a single character string, or "" if the wrapee does not need to be wrapped.

Definition at line 414 of file richio.cpp.

References OUTPUTFORMATTER::GetQuoteChar(), and OUTPUTFORMATTER::quoteChar.

◆ GetQuoteChar() [2/2]

const char * OUTPUTFORMATTER::GetQuoteChar	(	const char *	wrapee,
		const char *	quote_char
	)

staticprotectedinherited

Perform quote character need determination according to the Specctra DSN specification.

Parameters

wrapee	A string that might need wrapping on each end.
quote_char	A single character C string which provides the current quote character, should it be needed by the wrapee.

Returns: the quote_char as a single character string, or "" if the wrapee does not need to be wrapped.

Definition at line 380 of file richio.cpp.

Referenced by DSN::PROPERTY::Format(), DSN::RECTANGLE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::KEEPOUT::Format(), DSN::VIA::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::STRINGPROP::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::PIN::Format(), DSN::IMAGE::Format(), DSN::PADSTACK::Format(), DSN::FROMTO::Format(), DSN::COMP_ORDER::Format(), DSN::NET::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PCB::Format(), DSN::ANCESTOR::Format(), DSN::SUPPLY_PIN::Format(), DSN::NET_OUT::Format(), DSN::SESSION::Format(), DSN::PARSER::FormatContents(), DSN::CLASSES::FormatContents(), DSN::REGION::FormatContents(), DSN::PADSTACK::FormatContents(), DSN::HISTORY::FormatContents(), DSN::PIN_REF::FormatIt(), and OUTPUTFORMATTER::GetQuoteChar().

◆ GetString()

const std::string & STRING_FORMATTER::GetString ( )

inline

Definition at line 456 of file richio.h.

Referenced by NGSPICE::Attach(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDITOR_CONTROL::doCopy(), SCH::generateSchematicNetlist(), PCB_IO_KICAD_SEXPR::GetStringOutput(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), DSN::ELEM::makeHash(), CLIPBOARD_IO::SaveBoard(), CVPCB_MAINFRAME::SaveFootprintAssociation(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SIMULATOR_CONTROL::ShowNetlist(), PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow(), PANEL_SETUP_BOARD_STACKUP::TransferDataFromWindow(), and DS_DATA_MODEL_STRINGIO::~DS_DATA_MODEL_STRINGIO().

◆ Print()

int OUTPUTFORMATTER::Print	(	int	nestLevel,
		const char *	fmt,
			...
	)

inherited

Format and write text to the output stream.

Parameters

nestLevel	The multiple of spaces to precede the output with.
fmt	A printf() style format string.
...	a variable list of parameters that will get blended into the output under control of the format string.

Returns: int - the number of characters output.

Exceptions

IO_ERROR,if there is a problem outputting, such as a full disk.

Definition at line 458 of file richio.cpp.

References NESTWIDTH, OUTPUTFORMATTER::sprint(), and OUTPUTFORMATTER::vprint().

◆ Quotes()

std::string OUTPUTFORMATTER::Quotes ( const std::string & aWrapee ) const

virtualinherited

Check aWrapee input string for a need to be quoted (e.g.

contains a ')' character or a space), and for " double quotes within the string that need to be escaped such that the DSNLEXER will correctly parse the string from a file later.

Parameters

aWrapee is a string that might need wrapping in double quotes, and it might need to have its internal content escaped, or not.

Returns: a std::string- whose c_str() function can be called for passing to printf() style functions that output UTF8 encoded s-expression streams.

Exceptions

IO_ERROR,if there is any kind of problem with the input string.

Definition at line 487 of file richio.cpp.

Referenced by PCB_IO_KICAD_SEXPR::format(), formatNode(), OUTPUTFORMATTER::Quotew(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ Quotew()

std::string OUTPUTFORMATTER::Quotew ( const wxString & aWrapee ) const

inherited

Definition at line 526 of file richio.cpp.

References OUTPUTFORMATTER::Quotes().

Referenced by PCB_IO_KICAD_SEXPR::format(), DS_DATA_MODEL_IO::format(), PCB_CALCULATOR_DATAFILE::Format(), EDA_TEXT::Format(), PAGE_INFO::Format(), TITLE_BLOCK::Format(), COMPONENT_NET::Format(), COMPONENT::Format(), LIB_TABLE_ROW::Format(), TEMPLATE_FIELDNAME::Format(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), XNODE::FormatContents(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatNetInformation(), PCB_IO_KICAD_SEXPR::formatProperties(), PCB_IO_KICAD_SEXPR::formatRenderCache(), SCH_IO_KICAD_SEXPR::saveBusAlias(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveInstances(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), and PCB_CALCULATOR_DATAFILE::WriteHeader().

◆ sprint()

int OUTPUTFORMATTER::sprint	(	const char *	fmt,
			...
	)

privateinherited

Definition at line 446 of file richio.cpp.

References OUTPUTFORMATTER::vprint().

Referenced by OUTPUTFORMATTER::Print().

◆ StripUseless()

void STRING_FORMATTER::StripUseless ( )

Removes whitespace, '(', and ')' from the string.

Definition at line 544 of file richio.cpp.

References copy, and m_mystring.

Referenced by DSN::ELEM::makeHash().

◆ vprint()

int OUTPUTFORMATTER::vprint	(	const char *	fmt,
		va_list	ap
	)

privateinherited

Definition at line 420 of file richio.cpp.

References OUTPUTFORMATTER::m_buffer, and OUTPUTFORMATTER::write().

Referenced by OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::sprint().

◆ write()

void STRING_FORMATTER::write	(	const char *	aOutBuf,
		int	aCount
	)

overrideprotectedvirtual

Should be coded in the interface implementation (derived) classes.

Parameters

aOutBuf	is the start of a byte buffer to write.
aCount	tells how many bytes to write.

Exceptions

IO_ERROR,if there is a problem outputting, such as a full disk.

Implements OUTPUTFORMATTER.

Definition at line 539 of file richio.cpp.

References m_mystring.

Member Data Documentation

◆ m_buffer

std::vector<char> OUTPUTFORMATTER::m_buffer

privateinherited

Definition at line 418 of file richio.h.

Referenced by OUTPUTFORMATTER::vprint().

◆ m_mystring

std::string STRING_FORMATTER::m_mystring

private

Definition at line 465 of file richio.h.

Referenced by StripUseless(), and write().

◆ quoteChar

char OUTPUTFORMATTER::quoteChar[2]

privateinherited

Definition at line 419 of file richio.h.

Referenced by OUTPUTFORMATTER::GetQuoteChar().

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ STRING_FORMATTER()

Member Function Documentation

◆ Clear()

◆ Finish()

◆ GetQuoteChar() [1/2]

◆ GetQuoteChar() [2/2]

◆ GetString()

◆ Print()

◆ Quotes()

◆ Quotew()

◆ sprint()

◆ StripUseless()

◆ vprint()

◆ write()

Member Data Documentation

◆ m_buffer

◆ m_mystring

◆ quoteChar