KiCad PCB EDA Suite
DSN::PARSER Class Reference

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
 Write 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
 Return the units for this section. More...
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 Write 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 ()
 Return a string which uniquely represents this ELEM among 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

A configuration record per the SPECCTRA DSN file spec.

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

Definition at line 369 of file specctra.h.

Constructor & Destructor Documentation

◆ PARSER()

PARSER::PARSER ( ELEM aParent)

Definition at line 3866 of file specctra.cpp.

3866  :
3867  ELEM( T_parser, aParent )
3868 {
3869  string_quote = '"';
3870  space_in_quoted_tokens = false;
3871 
3872  case_sensitive = false;
3873  wires_include_testpoint = false;
3874  routes_include_testpoint = false;
3875  routes_include_guides = false;
3877  via_rotate_first = true;
3878  generated_by_freeroute = false;
3879 
3880  host_cad = "KiCad's Pcbnew";
3881  wxString msg = GetBuildVersion();
3882  host_version = TO_UTF8(msg);
3883 }
bool space_in_quoted_tokens
Definition: specctra.h:381
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
bool via_rotate_first
Definition: specctra.h:387
bool routes_include_testpoint
Definition: specctra.h:384
#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:394
wxString GetBuildVersion()
Get the full KiCad version string.
bool routes_include_image_conductor
Definition: specctra.h:386
bool case_sensitive
Definition: specctra.h:382
char string_quote
Definition: specctra.h:380
std::string host_cad
Definition: specctra.h:393
bool routes_include_guides
Definition: specctra.h:385
bool wires_include_testpoint
Definition: specctra.h:383
bool generated_by_freeroute
Definition: specctra.h:388

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

Write 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 precede 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 3774 of file specctra.cpp.

3775 {
3776  out->Print( nestLevel, "(%s\n", Name() );
3777 
3778  FormatContents( out, nestLevel+1 );
3779 
3780  out->Print( nestLevel, ")\n" );
3781 }
const char * Name() const
Definition: specctra.cpp:3760
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

Write 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 precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3886 of file specctra.cpp.

3887 {
3888  out->Print( nestLevel, "(string_quote %c)\n", string_quote );
3889  out->Print( nestLevel, "(space_in_quoted_tokens %s)\n", space_in_quoted_tokens ? "on" : "off" );
3890  out->Print( nestLevel, "(host_cad \"%s\")\n", host_cad.c_str() );
3891  out->Print( nestLevel, "(host_version \"%s\")\n", host_version.c_str() );
3892 
3893  for( STRINGS::iterator i = constants.begin(); i != constants.end(); )
3894  {
3895  const std::string& s1 = *i++;
3896  const std::string& s2 = *i++;
3897 
3898  const char* q1 = out->GetQuoteChar( s1.c_str() );
3899  const char* q2 = out->GetQuoteChar( s2.c_str() );
3900  out->Print( nestLevel, "(constant %s%s%s %s%s%s)\n",
3901  q1, s1.c_str(), q1, q2, s2.c_str(), q2 );
3902  }
3903 
3905  {
3906  out->Print( nestLevel, "(routes_include%s%s%s)\n",
3907  routes_include_testpoint ? " testpoint" : "",
3908  routes_include_guides ? " guides" : "",
3909  routes_include_image_conductor ? " image_conductor" : "" );
3910  }
3911 
3913  out->Print( nestLevel, "(wires_include testpoint)\n" );
3914 
3915  if( !via_rotate_first )
3916  out->Print( nestLevel, "(via_rotate_first off)\n" );
3917 
3918  if( case_sensitive )
3919  out->Print( nestLevel, "(case_sensitive %s)\n", case_sensitive ? "on" : "off" );
3920 }
bool space_in_quoted_tokens
Definition: specctra.h:381
bool via_rotate_first
Definition: specctra.h:387
bool routes_include_testpoint
Definition: specctra.h:384
std::string host_version
Definition: specctra.h:394
bool routes_include_image_conductor
Definition: specctra.h:386
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:348
bool case_sensitive
Definition: specctra.h:382
STRINGS constants
This holds pairs of strings, one pair for each constant definition.
Definition: specctra.h:391
char string_quote
Definition: specctra.h:380
std::string host_cad
Definition: specctra.h:393
bool routes_include_guides
Definition: specctra.h:385
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
bool wires_include_testpoint
Definition: specctra.h:383

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

Return the units for this section.

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

Returns
an element 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 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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

Return a string which uniquely represents this ELEM among other ELEMs of the same derived class as "this" one.

It is not usable 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 263 of file specctra.h.

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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 378 of file specctra.h.

Member Data Documentation

◆ case_sensitive

bool DSN::PARSER::case_sensitive
private

Definition at line 382 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 391 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 388 of file specctra.h.

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

◆ host_cad

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

Definition at line 393 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 394 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 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 385 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 386 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 384 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 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 380 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 275 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 387 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 383 of file specctra.h.

Referenced by FormatContents(), and PARSER().


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