FILE_OUTPUTFORMATTER Class Reference

Used for text file output. More...

#include <richio.h>

Inheritance diagram for FILE_OUTPUTFORMATTER:

Public Member Functions
	FILE_OUTPUTFORMATTER (const wxString &aFileName, const wxChar *aMode=wxT("wt"), char aQuoteChar='"' )
	~FILE_OUTPUTFORMATTER ()
virtual const char *	GetQuoteChar (const char *wrapee) const
	Perform quote character need determination.
int PRINTF_FUNC_N	Print (int nestLevel, const char *fmt,...)
	Format and write text to the output stream.
int PRINTF_FUNC	Print (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.

Protected Attributes
FILE *	m_fp
	takes ownership
wxString	m_filename

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

Private Attributes
std::vector< char >	m_buffer
char	quoteChar [2]

Detailed Description

Used for text file output.

It is about 8 times faster than STREAM_OUTPUTFORMATTER for file streams.

Definition at line 490 of file richio.h.

Constructor & Destructor Documentation

FILE_OUTPUTFORMATTER()

FILE_OUTPUTFORMATTER::FILE_OUTPUTFORMATTER	(	const wxString &	aFileName,
		const wxChar *	aMode = wxT( "wt" ),
		char	aQuoteChar = '"'
	)

Parameters

aFileName	is the full filename to open and save to as a text file.
aMode	is what you would pass to wxFopen()'s mode, defaults to wxT( "wt" ) for text files that are to be created here and now.
aQuoteChar	is a char used for quoting problematic strings (with whitespace or special characters in them).

Exceptions

IO_ERROR

if the file cannot be opened.

Definition at line 583 of file richio.cpp.

References m_fp, and THROW_IO_ERROR.

~FILE_OUTPUTFORMATTER()

FILE_OUTPUTFORMATTER::~FILE_OUTPUTFORMATTER

(

)

Definition at line 595 of file richio.cpp.

References m_fp.

Member Function Documentation

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 431 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 419 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 385 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().

Print() [1/2]

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

inherited

Format and write text to the output stream.

Parameters

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 492 of file richio.cpp.

References OUTPUTFORMATTER::vprint().

Print() [2/2]

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 463 of file richio.cpp.

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

Referenced by PCB_IO_KICAD_SEXPR::format(), NETLIST::Format(), DS_DATA_MODEL_IO::format(), DS_DATA_MODEL_IO::Format(), PAGE_INFO::Format(), TITLE_BLOCK::Format(), PCB_PLOT_PARAMS::Format(), EDA_TEXT::Format(), PCB_CALCULATOR_DATAFILE::Format(), COMPONENT_NET::Format(), COMPONENT::Format(), SYMBOL_LIB_TABLE::Format(), DESIGN_BLOCK_LIB_TABLE::Format(), FP_LIB_TABLE::Format(), TEMPLATE_FIELDNAME::Format(), TEMPLATES::Format(), STROKE_PARAMS::Format(), XNODE::Format(), DSN::ELEM::Format(), LIB_TABLE_ROW::Format(), DSN::POINT::Format(), DSN::PROPERTY::Format(), DSN::UNIT_RES::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::TOKPROP::Format(), DSN::STRINGPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::SHAPE::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(), SCH_IO_KICAD_LEGACY::Format(), SCH_IO_KICAD_SEXPR::Format(), formatArc(), formatBezier(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), KICAD_FORMAT::FormatBool(), formatCircle(), XNODE::FormatContents(), DSN::PARSER::FormatContents(), DSN::CLASSES::FormatContents(), DSN::REGION::FormatContents(), DSN::PLACEMENT::FormatContents(), DSN::IMAGE::FormatContents(), DSN::PADSTACK::FormatContents(), DSN::HISTORY::FormatContents(), DSN::ROUTE::FormatContents(), DSN::WAS_IS::FormatContents(), DS_DATA_MODEL_IO::formatCoordinate(), formatFill(), PCB_IO_KICAD_SEXPR::formatGeneral(), DSN::PIN_REF::FormatIt(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatNetInformation(), formatNode(), KICAD_FORMAT::FormatOptBool(), DS_DATA_MODEL_IO::formatOptions(), formatPoly(), PCB_IO_KICAD_SEXPR::formatPolyPts(), PCB_IO_KICAD_SEXPR::formatProperties(), formatRect(), PCB_IO_KICAD_SEXPR::formatRenderCache(), DS_DATA_MODEL_IO::formatRepeatParameters(), PCB_IO_KICAD_SEXPR::formatSetup(), KICAD_FORMAT::FormatStreamData(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), GENDRILL_WRITER_BASE::GenDrillReportFile(), GENDRILL_WRITER_BASE::printToolSummary(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveBezier(), SCH_IO_KICAD_LEGACY::saveBitmap(), SCH_IO_KICAD_SEXPR::saveBitmap(), CLIPBOARD_IO::SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), SCH_IO_KICAD_LEGACY::saveBusAlias(), SCH_IO_KICAD_SEXPR::saveBusAlias(), SCH_IO_KICAD_LEGACY::saveBusEntry(), SCH_IO_KICAD_SEXPR::saveBusEntry(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveCircle(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveDocFile(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveGroup(), SCH_IO_KICAD_SEXPR::saveInstances(), SCH_IO_KICAD_LEGACY::saveJunction(), SCH_IO_KICAD_SEXPR::saveJunction(), SCH_IO_KICAD_LEGACY::saveLine(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_LEGACY::saveNoConnect(), SCH_IO_KICAD_SEXPR::saveNoConnect(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePin(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveRectangle(), SCH_IO_KICAD_SEXPR::saveRuleArea(), CLIPBOARD_IO::SaveSelection(), SCH_IO_KICAD_LEGACY::saveSheet(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveTable(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), PANEL_REGULATOR::WriteDataFile(), SPICE_CIRCUIT_MODEL::WriteDirectives(), NETLIST_EXPORTER_SPICE::WriteDirectives(), EMBEDDED_FILES::WriteEmbeddedFiles(), NETLIST_EXPORTER_SPICE::WriteHead(), NETLIST_EXPORTER_SPICE_MODEL::WriteHead(), PCB_CALCULATOR_DATAFILE::WriteHeader(), NETLIST_EXPORTER_SPICE::writeInclude(), NETLIST_EXPORTER_SPICE::writeItems(), NETLIST_EXPORTER_SPICE::writeModels(), NETLIST_EXPORTER_SPICE::WriteTail(), and NETLIST_EXPORTER_SPICE_MODEL::WriteTail().

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 509 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 548 of file richio.cpp.

References OUTPUTFORMATTER::Quotes().

Referenced by PCB_IO_KICAD_SEXPR::format(), DS_DATA_MODEL_IO::format(), DS_DATA_MODEL_IO::Format(), PAGE_INFO::Format(), TITLE_BLOCK::Format(), PCB_PLOT_PARAMS::Format(), EDA_TEXT::Format(), PCB_CALCULATOR_DATAFILE::Format(), COMPONENT_NET::Format(), COMPONENT::Format(), TEMPLATE_FIELDNAME::Format(), LIB_TABLE_ROW::Format(), SCH_IO_KICAD_SEXPR::Format(), formatArc(), formatBezier(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), formatCircle(), XNODE::FormatContents(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatNetInformation(), formatPoly(), PCB_IO_KICAD_SEXPR::formatProperties(), formatRect(), PCB_IO_KICAD_SEXPR::formatRenderCache(), KICAD_FORMAT::FormatUuid(), CLIPBOARD_IO::SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), SCH_IO_KICAD_SEXPR::saveBusAlias(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveGroup(), SCH_IO_KICAD_SEXPR::saveInstances(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), 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(), EMBEDDED_FILES::WriteEmbeddedFiles(), and PCB_CALCULATOR_DATAFILE::WriteHeader().

sprint()

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

privateinherited

Definition at line 451 of file richio.cpp.

References OUTPUTFORMATTER::vprint().

Referenced by OUTPUTFORMATTER::Print().

vprint()

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

privateinherited

Definition at line 425 of file richio.cpp.

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

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

write()

void FILE_OUTPUTFORMATTER::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 602 of file richio.cpp.

References m_fp, and THROW_IO_ERROR.

Member Data Documentation

m_buffer

std::vector<char> OUTPUTFORMATTER::m_buffer

privateinherited

Definition at line 434 of file richio.h.

Referenced by OUTPUTFORMATTER::vprint().

m_filename

wxString FILE_OUTPUTFORMATTER::m_filename

protected

Definition at line 511 of file richio.h.

m_fp

FILE* FILE_OUTPUTFORMATTER::m_fp

protected

takes ownership

Definition at line 510 of file richio.h.

Referenced by FILE_OUTPUTFORMATTER(), write(), and ~FILE_OUTPUTFORMATTER().

quoteChar

char OUTPUTFORMATTER::quoteChar[2]

privateinherited

Definition at line 435 of file richio.h.

Referenced by OUTPUTFORMATTER::GetQuoteChar().

---

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

• richio.h
• richio.cpp