STRING_FORMATTER Class Reference

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. More...
void	Clear ()
	Clear the buffer and empties the internal string. More...
void	StripUseless ()
	Removes whitespace, '(', and ')' from the string. More...
const std::string &	GetString ()
virtual const char *	GetQuoteChar (const char *wrapee) const
	Perform quote character need determination. More...
int PRINTF_FUNC	Print (int nestLevel, const char *fmt,...)
	Format and write text to the output stream. More...
virtual std::string	Quotes (const std::string &aWrapee) const
	Check aWrapee input string for a need to be quoted (e.g. More...
std::string	Quotew (const wxString &aWrapee) const

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

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. More...

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 414 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 420 of file richio.h.

 :
 OUTPUTFORMATTER( aReserve, aQuoteChar )
 {
 }

Member Function Documentation

Clear()

void STRING_FORMATTER::Clear ( )

inline

Clear the buffer and empties the internal string.

Definition at line 428 of file richio.h.

 {
 m_mystring.clear();
 }

References m_mystring.

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

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

{
 return GetQuoteChar( wrapee, quoteChar );
}

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

{
 // Include '#' so a symbol is not confused with a comment. We intend
 // to wrap any symbol starting with a '#'.
 // Our LEXER class handles comments, and comments appear to be an extension
 // to the SPECCTRA DSN specification.
 if( *wrapee == '#' )
 return quote_char;
 
 if( strlen( wrapee ) == 0 )
 return quote_char;
 
 bool isFirst = true;
 
 for( ; *wrapee; ++wrapee, isFirst = false )
 {
 static const char quoteThese[] = "\t ()"
 "%" // per Alfons of freerouting.net, he does not like this unquoted as of 1-Feb-2008
 "{}" // guessing that these are problems too
 ;
 
 // if the string to be wrapped (wrapee) has a delimiter in it,
 // return the quote_char so caller wraps the wrapee.
 if( strchr( quoteThese, *wrapee ) )
 return quote_char;
 
 if( !isFirst && '-' == *wrapee )
 return quote_char;
 }
 
 return ""; // caller does not need to wrap, can use an unwrapped string.
}

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 438 of file richio.h.

 {
 return m_mystring;
 }

References m_mystring.

Referenced by NGSPICE::Attach(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDITOR_CONTROL::doCopy(), SCH::generateSchematicNetlist(), PCB_PLUGIN::GetStringOutput(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), DSN::ELEM::makeHash(), SIM_PLOT_FRAME::onShowNetlist(), CLIPBOARD_IO::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), 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 431 of file richio.cpp.

{
#define NESTWIDTH 2 
 
 va_list args;
 
 va_start( args, fmt );
 
 int result = 0;
 int total = 0;
 
 for( int i = 0; i < nestLevel; ++i )
 {
 // no error checking needed, an exception indicates an error.
 result = sprint( "%*c", NESTWIDTH, ' ' );
 
 total += result;
 }
 
 // no error checking needed, an exception indicates an error.
 result = vprint( fmt, args );
 
 va_end( args );
 
 total += result;
 return total;
}

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

Referenced by PANEL_SYM_LIB_TABLE::convertLibrary(), PCB_PLUGIN::format(), NETLIST::Format(), DS_DATA_MODEL_IO::format(), DS_DATA_MODEL_IO::Format(), PCB_CALCULATOR_DATAFILE::Format(), PCB_PLOT_PARAMS::Format(), EDA_TEXT::Format(), PAGE_INFO::Format(), TITLE_BLOCK::Format(), COMPONENT_NET::Format(), COMPONENT::Format(), SYMBOL_LIB_TABLE::Format(), FP_LIB_TABLE::Format(), STROKE_PARAMS::Format(), XNODE::Format(), DSN::ELEM::Format(), LIB_TABLE_ROW::Format(), TEMPLATE_FIELDNAME::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(), TEMPLATES::Format(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), formatArc(), formatBezier(), PCB_PLUGIN::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), 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_PLUGIN::formatGeneral(), DSN::PIN_REF::FormatIt(), PCB_PLUGIN::formatLayer(), PCB_PLUGIN::formatLayers(), PCB_PLUGIN::formatNetInformation(), formatNode(), DS_DATA_MODEL_IO::formatOptions(), formatPoly(), PCB_PLUGIN::formatPolyPts(), PCB_PLUGIN::formatProperties(), formatRect(), PCB_PLUGIN::formatRenderCache(), DS_DATA_MODEL_IO::formatRepeatParameters(), PCB_PLUGIN::formatSetup(), GENDRILL_WRITER_BASE::GenDrillReportFile(), GENDRILL_WRITER_BASE::printToolSummary(), CLIPBOARD_IO::Save(), PCB_PLUGIN::Save(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_LEGACY_PLUGIN::saveBusAlias(), SCH_SEXPR_PLUGIN::saveBusAlias(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveDocFile(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveInstances(), SCH_LEGACY_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveNoConnect(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), PANEL_REGULATOR::WriteDataFile(), NETLIST_EXPORTER_SPICE::WriteDirectives(), NGSPICE_CIRCUIT_MODEL::WriteDirectives(), 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 460 of file richio.cpp.

{
 std::string ret;
 
 ret.reserve( aWrapee.size() * 2 + 2 );
 
 ret += '"';
 
 for( std::string::const_iterator it = aWrapee.begin(); it != aWrapee.end(); ++it )
 {
 switch( *it )
 {
 case '\n':
 ret += '\\';
 ret += 'n';
 break;
 case '\r':
 ret += '\\';
 ret += 'r';
 break;
 case '\\':
 ret += '\\';
 ret += '\\';
 break;
 case '"':
 ret += '\\';
 ret += '"';
 break;
 default:
 ret += *it;
 }
 }
 
 ret += '"';
 
 return ret;
}

Referenced by PCB_PLUGIN::format(), formatNode(), OUTPUTFORMATTER::Quotew(), and SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

Quotew()

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

inherited

Definition at line 499 of file richio.cpp.

{
 // wxStrings are always encoded as UTF-8 as we convert to a byte sequence.
 // The non-virtual function calls the virtual workhorse function, and if
 // a different quoting or escaping strategy is desired from the standard,
 // a derived class can overload Quotes() above, but
 // should never be a reason to overload this Quotew() here.
 return Quotes( (const char*) aWrapee.utf8_str() );
}

References OUTPUTFORMATTER::Quotes().

Referenced by PCB_PLUGIN::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_PLUGIN::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), XNODE::FormatContents(), PCB_PLUGIN::formatLayer(), PCB_PLUGIN::formatLayers(), PCB_PLUGIN::formatNetInformation(), PCB_PLUGIN::formatProperties(), PCB_PLUGIN::formatRenderCache(), SCH_SEXPR_PLUGIN::saveBusAlias(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveInstances(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), and PCB_CALCULATOR_DATAFILE::WriteHeader().

sprint()

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

privateinherited

Definition at line 419 of file richio.cpp.

{
 va_list args;
 
 va_start( args, fmt );
 int ret = vprint( fmt, args);
 va_end( args );
 
 return ret;
}

References OUTPUTFORMATTER::vprint().

Referenced by OUTPUTFORMATTER::Print().

StripUseless()

void STRING_FORMATTER::StripUseless

(

)

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

Definition at line 517 of file richio.cpp.

{
 std::string copy = m_mystring;
 
 m_mystring.clear();
 
 for( std::string::iterator i = copy.begin(); i != copy.end(); ++i )
 {
 if( !isspace( *i ) && *i != ')' && *i != '(' && *i != '"' )
 {
 m_mystring += *i;
 }
 }
}

References copy, and m_mystring.

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

vprint()

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

privateinherited

Definition at line 393 of file richio.cpp.

{
 // This function can call vsnprintf twice.
 // But internally, vsnprintf retrieves arguments from the va_list identified by arg as if
 // va_arg was used on it, and thus the state of the va_list is likely to be altered by the call.
 // see: www.cplusplus.com/reference/cstdio/vsnprintf
 // we make a copy of va_list ap for the second call, if happens
 va_list tmp;
 va_copy( tmp, ap );
 int ret = vsnprintf( &m_buffer[0], m_buffer.size(), fmt, ap );
 
 if( ret >= (int) m_buffer.size() )
 {
 m_buffer.resize( ret + 1000 );
 ret = vsnprintf( &m_buffer[0], m_buffer.size(), fmt, tmp );
 }
 
 va_end( tmp ); // Release the temporary va_list, initialised from ap
 
 if( ret > 0 )
 write( &m_buffer[0], ret );
 
 return ret;
}

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

{
 m_mystring.append( aOutBuf, aCount );
}

References m_mystring.

Member Data Documentation

m_buffer

std::vector<char> OUTPUTFORMATTER::m_buffer

privateinherited

Definition at line 400 of file richio.h.

Referenced by OUTPUTFORMATTER::vprint().

m_mystring

std::string STRING_FORMATTER::m_mystring

private

Definition at line 447 of file richio.h.

Referenced by Clear(), GetString(), StripUseless(), and write().

quoteChar

char OUTPUTFORMATTER::quoteChar[2]

privateinherited

Definition at line 401 of file richio.h.

Referenced by OUTPUTFORMATTER::GetQuoteChar(), and OUTPUTFORMATTER::OUTPUTFORMATTER().

---

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

• richio.h
• richio.cpp