KiCad PCB EDA Suite
DSN::PARSER Class Reference

PARSER is simply a configuration record per the SPECCTRA DSN file spec. More...

#include <specctra.h>

Inheritance diagram for DSN::PARSER:
DSN::ELEM

Public Member Functions

 PARSER (ELEM *aParent)
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Function GetUnits returns the units for this section. More...
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetParent (ELEM *aParent)
 

Protected Member Functions

std::string makeHash ()
 Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one. More...
 

Protected Attributes

DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

char string_quote
 
bool space_in_quoted_tokens
 
bool case_sensitive
 
bool wires_include_testpoint
 
bool routes_include_testpoint
 
bool routes_include_guides
 
bool routes_include_image_conductor
 
bool via_rotate_first
 
bool generated_by_freeroute
 
STRINGS constants
 This holds pairs of strings, one pair for each constant definition. More...
 
std::string host_cad
 
std::string host_version
 

Friends

class SPECCTRA_DB
 

Detailed Description

PARSER is simply a configuration record per the SPECCTRA DSN file spec.

It is not actually a parser, but rather corresponds to <parser_descriptor>

Definition at line 366 of file specctra.h.

Constructor & Destructor Documentation

◆ PARSER()

PARSER::PARSER ( ELEM aParent)

Definition at line 3619 of file specctra.cpp.

3619  :
3620  ELEM( T_parser, aParent )
3621 {
3622  string_quote = '"';
3623  space_in_quoted_tokens = false;
3624 
3625  case_sensitive = false;
3626  wires_include_testpoint = false;
3627  routes_include_testpoint = false;
3628  routes_include_guides = false;
3630  via_rotate_first = true;
3631  generated_by_freeroute = false;
3632 
3633  host_cad = "KiCad's Pcbnew";
3634  wxString msg = GetBuildVersion();
3635  host_version = TO_UTF8(msg);
3636 }
bool space_in_quoted_tokens
Definition: specctra.h:371
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
bool via_rotate_first
Definition: specctra.h:377
bool routes_include_testpoint
Definition: specctra.h:374
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
std::string host_version
Definition: specctra.h:384
wxString GetBuildVersion()
Get the full KiCad version string.
bool routes_include_image_conductor
Definition: specctra.h:376
bool case_sensitive
Definition: specctra.h:372
char string_quote
Definition: specctra.h:370
std::string host_cad
Definition: specctra.h:383
bool routes_include_guides
Definition: specctra.h:375
bool wires_include_testpoint
Definition: specctra.h:373
bool generated_by_freeroute
Definition: specctra.h:378

References case_sensitive, generated_by_freeroute, GetBuildVersion(), host_cad, host_version, routes_include_guides, routes_include_image_conductor, routes_include_testpoint, space_in_quoted_tokens, string_quote, TO_UTF8, via_rotate_first, and wires_include_testpoint.

Member Function Documentation

◆ Format()

void DSN::ELEM::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
virtualinherited

Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented in DSN::SESSION, DSN::NET_OUT, DSN::SUPPLY_PIN, DSN::ANCESTOR, DSN::PCB, DSN::WIRE_VIA, DSN::WIRE, DSN::CLASS, DSN::NET, DSN::COMP_ORDER, DSN::FROMTO, DSN::PADSTACK, DSN::IMAGE, DSN::PIN, DSN::SHAPE, DSN::COMPONENT, DSN::PLACE, DSN::GRID, DSN::STRINGPROP, DSN::TOKPROP, DSN::LAYER_NOISE_WEIGHT, DSN::SPECCTRA_LAYER_PAIR, DSN::LAYER, DSN::CONTROL, DSN::VIA, DSN::KEEPOUT, DSN::WINDOW, DSN::QARC, DSN::CIRCLE, DSN::BOUNDARY, DSN::PATH, DSN::LAYER_RULE, DSN::RULE, DSN::RECTANGLE, and DSN::UNIT_RES.

Definition at line 3519 of file specctra.cpp.

3520 {
3521  out->Print( nestLevel, "(%s\n", Name() );
3522 
3523  FormatContents( out, nestLevel+1 );
3524 
3525  out->Print( nestLevel, ")\n" );
3526 }
const char * Name() const
Definition: specctra.cpp:3505
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:263
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References DSN::ELEM::FormatContents(), DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::FormatContents().

◆ FormatContents()

void PARSER::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
overridevirtual

Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

This is the same as Format() except that the outer wrapper is not included.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3639 of file specctra.cpp.

3640 {
3641  out->Print( nestLevel, "(string_quote %c)\n", string_quote );
3642  out->Print( nestLevel, "(space_in_quoted_tokens %s)\n", space_in_quoted_tokens ? "on" : "off" );
3643  out->Print( nestLevel, "(host_cad \"%s\")\n", host_cad.c_str() );
3644  out->Print( nestLevel, "(host_version \"%s\")\n", host_version.c_str() );
3645 
3646  for( STRINGS::iterator i=constants.begin(); i!=constants.end(); )
3647  {
3648  const std::string& s1 = *i++;
3649  const std::string& s2 = *i++;
3650 
3651  const char* q1 = out->GetQuoteChar( s1.c_str() );
3652  const char* q2 = out->GetQuoteChar( s2.c_str() );
3653  out->Print( nestLevel, "(constant %s%s%s %s%s%s)\n",
3654  q1, s1.c_str(), q1,
3655  q2, s2.c_str(), q2 );
3656  }
3657 
3659  {
3660  out->Print( nestLevel, "(routes_include%s%s%s)\n",
3661  routes_include_testpoint ? " testpoint" : "",
3662  routes_include_guides ? " guides" : "",
3663  routes_include_image_conductor ? " image_conductor" : "" );
3664  }
3665 
3667  out->Print( nestLevel, "(wires_include testpoint)\n" );
3668 
3669  if( !via_rotate_first )
3670  out->Print( nestLevel, "(via_rotate_first off)\n" );
3671 
3672  if( case_sensitive )
3673  out->Print( nestLevel, "(case_sensitive %s)\n", case_sensitive ? "on" : "off" );
3674 }
bool space_in_quoted_tokens
Definition: specctra.h:371
bool via_rotate_first
Definition: specctra.h:377
bool routes_include_testpoint
Definition: specctra.h:374
std::string host_version
Definition: specctra.h:384
bool routes_include_image_conductor
Definition: specctra.h:376
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Perform quote character need determination according to the Specctra DSN specification.
Definition: richio.cpp:331
bool case_sensitive
Definition: specctra.h:372
STRINGS constants
This holds pairs of strings, one pair for each constant definition.
Definition: specctra.h:381
char string_quote
Definition: specctra.h:370
std::string host_cad
Definition: specctra.h:383
bool routes_include_guides
Definition: specctra.h:375
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
bool wires_include_testpoint
Definition: specctra.h:373

References case_sensitive, constants, OUTPUTFORMATTER::GetQuoteChar(), host_cad, host_version, OUTPUTFORMATTER::Print(), routes_include_guides, routes_include_image_conductor, routes_include_testpoint, space_in_quoted_tokens, string_quote, via_rotate_first, and wires_include_testpoint.

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const
virtualinherited

Function GetUnits returns the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
UNIT_RES* - from a local or parent scope

Reimplemented in DSN::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3510 of file specctra.cpp.

3511 {
3512  if( parent )
3513  return parent->GetUnits();
3514 
3515  return &UNIT_RES::Default;
3516 }
ELEM * parent
Definition: specctra.h:199
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:413
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

References DSN::UNIT_RES::Default, DSN::ELEM::GetUnits(), and DSN::ELEM::parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::ELEM::GetUnits(), DSN::STRUCTURE::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::IMAGE::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::WIRING::GetUnits(), DSN::PCB::GetUnits(), and DSN::ROUTE::GetUnits().

◆ makeHash()

std::string DSN::ELEM::makeHash ( )
inlineprotectedinherited

Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one.

It is not useable for all derived classes, only those which plan for it by implementing a FormatContents() function that captures all info which will be used in the subsequent string compare. THIS SHOULD NORMALLY EXCLUDE THE TYPENAME, AND INSTANCE NAME OR ID AS WELL.

Definition at line 211 of file specctra.h.

212  {
213  sf.Clear();
214  FormatContents( &sf, 0 );
215  sf.StripUseless();
216 
217  return sf.GetString();
218  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:263
const std::string & GetString()
Definition: richio.h:435
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:494
static STRING_FORMATTER sf
Definition: specctra.h:221
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:425

References STRING_FORMATTER::Clear(), DSN::ELEM::FormatContents(), STRING_FORMATTER::GetString(), DSN::ELEM::sf, and STRING_FORMATTER::StripUseless().

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 368 of file specctra.h.

Member Data Documentation

◆ case_sensitive

bool DSN::PARSER::case_sensitive
private

Definition at line 372 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ constants

STRINGS DSN::PARSER::constants
private

This holds pairs of strings, one pair for each constant definition.

Definition at line 381 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), and FormatContents().

◆ generated_by_freeroute

bool DSN::PARSER::generated_by_freeroute
private

Definition at line 378 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), and PARSER().

◆ host_cad

std::string DSN::PARSER::host_cad
private

Definition at line 383 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ host_version

std::string DSN::PARSER::host_version
private

Definition at line 384 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::GetUnits(), and DSN::ELEM::SetParent().

◆ routes_include_guides

bool DSN::PARSER::routes_include_guides
private

Definition at line 375 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ routes_include_image_conductor

bool DSN::PARSER::routes_include_image_conductor
private

Definition at line 376 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ routes_include_testpoint

bool DSN::PARSER::routes_include_testpoint
private

Definition at line 374 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ space_in_quoted_tokens

bool DSN::PARSER::space_in_quoted_tokens
private

◆ string_quote

char DSN::PARSER::string_quote
private

Definition at line 370 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 198 of file specctra.h.

Referenced by DSN::UNIT_RES::Format(), DSN::ELEM::Name(), and DSN::ELEM::Type().

◆ via_rotate_first

bool DSN::PARSER::via_rotate_first
private

Definition at line 377 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPARSER(), FormatContents(), and PARSER().

◆ wires_include_testpoint

bool DSN::PARSER::wires_include_testpoint
private

Definition at line 373 of file specctra.h.

Referenced by FormatContents(), and PARSER().


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