KiCad PCB EDA Suite
PCB_PLOT_PARAMS_PARSER Class Reference

Class PCB_PLOT_PARAMS_PARSER is the parser class for PCB_PLOT_PARAMS. More...

#include <pcb_plot_params_parser.h>

Inheritance diagram for PCB_PLOT_PARAMS_PARSER:
PCB_PLOT_PARAMS_LEXER DSNLEXER

Public Member Functions

 PCB_PLOT_PARAMS_PARSER (LINE_READER *aReader)
 
 PCB_PLOT_PARAMS_PARSER (char *aLine, const wxString &aSource)
 
LINE_READERGetReader ()
 
void Parse (PCB_PLOT_PARAMS *aPcbPlotParams)
 
PCBPLOTPARAMS_T::T NextTok ()
 Function NextTok returns the next token found in the input file or T_EOF when reaching the end of file. More...
 
PCBPLOTPARAMS_T::T NeedSYMBOL ()
 Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(). More...
 
PCBPLOTPARAMS_T::T NeedSYMBOLorNUMBER ()
 Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool IsSymbol() or tok==T_NUMBER. More...
 
PCBPLOTPARAMS_T::T CurTok ()
 Function CurTok returns whatever NextTok() returned the last time it was called. More...
 
PCBPLOTPARAMS_T::T PrevTok ()
 Function PrevTok returns whatever NextTok() returned the 2nd to last time it was called. More...
 
bool SyncLineReaderWith (DSNLEXER &aLexer)
 Useable only for DSN lexers which share the same LINE_READER Synchronizes the pointers handling the data read by the LINE_READER Allows 2 DNSLEXER to share the same current line, when switching from a DNSLEXER to an other DNSLEXER. More...
 
void SetSpecctraMode (bool aMode)
 Function SetSpecctraMode changes the behavior of this lexer into or out of "specctra mode". More...
 
void PushReader (LINE_READER *aLineReader)
 Function PushReader manages a stack of LINE_READERs in order to handle nested file inclusion. More...
 
LINE_READERPopReader ()
 Function PopReader deletes the top most LINE_READER from an internal stack of LINE_READERs and in the case of FILE_LINE_READER this means the associated FILE is closed. More...
 
int NeedNUMBER (const char *aExpectation)
 Function NeedNUMBER calls NextTok() and then verifies that the token read is type DSN_NUMBER. More...
 
char SetStringDelimiter (char aStringDelimiter)
 Function SetStringDelimiter changes the string delimiter from the default " to some other character and returns the old value. More...
 
bool SetSpaceInQuotedTokens (bool val)
 Function SetSpaceInQuotedTokens changes the setting controlling whether a space in a quoted string is a terminator. More...
 
bool SetCommentsAreTokens (bool val)
 Function SetCommentsAreTokens changes the handling of comments. More...
 
wxArrayString * ReadCommentLines ()
 Function ReadCommentLines checks the next sequence of tokens and reads them into a wxArrayString if they are comments. More...
 
void Expecting (int aTok)
 Function Expecting throws an IO_ERROR exception with an input file specific error message. More...
 
void Expecting (const char *aTokenList)
 Function Expecting throws an IO_ERROR exception with an input file specific error message. More...
 
void Unexpected (int aTok)
 Function Unexpected throws an IO_ERROR exception with an input file specific error message. More...
 
void Unexpected (const char *aToken)
 Function Unexpected throws an IO_ERROR exception with an input file specific error message. More...
 
void Duplicate (int aTok)
 Function Duplicate throws an IO_ERROR exception with a message saying specifically that aTok is a duplicate of one already seen in current context. More...
 
void NeedLEFT ()
 Function NeedLEFT calls NextTok() and then verifies that the token read in is a DSN_LEFT. More...
 
void NeedRIGHT ()
 Function NeedRIGHT calls NextTok() and then verifies that the token read in is a DSN_RIGHT. More...
 
const char * GetTokenText (int aTok)
 Function GetTokenText returns the C string representation of a DSN_T value. More...
 
wxString GetTokenString (int aTok)
 Function GetTokenString returns a quote wrapped wxString representation of a token value. More...
 
const char * CurText ()
 Function CurText returns a pointer to the current token's text. More...
 
const std::string & CurStr ()
 Function CurStr returns a reference to current token in std::string form. More...
 
wxString FromUTF8 ()
 Function FromUTF8 returns the current token text as a wxString, assuming that the input byte stream is UTF8 encoded. More...
 
int CurLineNumber ()
 Function CurLineNumber returns the current line number within my LINE_READER. More...
 
const char * CurLine ()
 Function CurLine returns the current line of text, from which the CurText() would return its token. More...
 
const wxString & CurSource ()
 Function CurFilename returns the current LINE_READER source. More...
 
int CurOffset ()
 Function CurOffset returns the byte offset within the current line, using a 1 based index. More...
 

Static Public Member Functions

static const char * TokenName (PCBPLOTPARAMS_T::T aTok)
 Function TokenName returns the name of the token in ASCII form. More...
 
static bool IsSymbol (int aTok)
 Function IsSymbol tests a token to see if it is a symbol. More...
 
static const char * Syntax (int aTok)
 

Protected Types

typedef std::vector< LINE_READER * > READER_STACK
 

Protected Member Functions

void init ()
 
int readLine ()
 
int findToken (const std::string &aToken)
 Function findToken takes aToken string and looks up the string in the keywords table. More...
 
bool isStringTerminator (char cc)
 

Protected Attributes

bool iOwnReaders
 on readerStack, should I delete them? More...
 
const char * start
 
const char * next
 
const char * limit
 
char dummy [1]
 when there is no reader. More...
 
READER_STACK readerStack
 all the LINE_READERs by pointer. More...
 
LINE_READERreader
 no ownership. ownership is via readerStack, maybe, if iOwnReaders More...
 
bool specctraMode
 if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_in_quoted_tokens is functional else not. More...
 
char stringDelimiter
 
bool space_in_quoted_tokens
 blank spaces within quoted strings More...
 
bool commentsAreTokens
 true if should return comments as tokens More...
 
int prevTok
 curTok from previous NextTok() call. More...
 
int curOffset
 offset within current line of the current token More...
 
int curTok
 the current token obtained on last NextTok() More...
 
std::string curText
 the text of the current token More...
 
unsigned keywordCount
 count of keywords table More...
 
KEYWORD_MAP keyword_hash
 fast, specialized "C string" hashtable More...
 

Private Member Functions

bool parseBool ()
 
int parseInt (int aMin, int aMax)
 Function parseInt parses an integer and constrains it between two values. More...
 
double parseDouble ()
 Function parseDouble parses a double. More...
 
void skipCurrent ()
 Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes the current description. More...
 

Detailed Description

Class PCB_PLOT_PARAMS_PARSER is the parser class for PCB_PLOT_PARAMS.

Definition at line 36 of file pcb_plot_params_parser.h.

Member Typedef Documentation

typedef std::vector<LINE_READER*> DSNLEXER::READER_STACK
protectedinherited

Definition at line 89 of file dsnlexer.h.

Constructor & Destructor Documentation

PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER ( LINE_READER aReader)

Definition at line 321 of file pcb_plot_params.cpp.

321  :
322  PCB_PLOT_PARAMS_LEXER( aReader )
323 {
324 }
PCB_PLOT_PARAMS_LEXER(const std::string &aSExpression, const wxString &aSource=wxEmptyString)
Constructor ( const std::string&, const wxString& )
PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER ( char *  aLine,
const wxString &  aSource 
)

Definition at line 327 of file pcb_plot_params.cpp.

327  :
328  PCB_PLOT_PARAMS_LEXER( aLine, aSource )
329 {
330 }
PCB_PLOT_PARAMS_LEXER(const std::string &aSExpression, const wxString &aSource=wxEmptyString)
Constructor ( const std::string&, const wxString& )

Member Function Documentation

const char* DSNLEXER::CurLine ( )
inlineinherited

Function CurLine returns the current line of text, from which the CurText() would return its token.

Definition at line 517 of file dsnlexer.h.

Referenced by DSNLEXER::Duplicate(), DSNLEXER::Expecting(), CLIPBOARD_IO::Load(), PCB_IO::Load(), DSNLEXER::NeedNUMBER(), DSNLEXER::NextTok(), and DSNLEXER::Unexpected().

518  {
519  return (const char*)(*reader);
520  }
int DSNLEXER::CurLineNumber ( )
inlineinherited

Function CurLineNumber returns the current line number within my LINE_READER.

Definition at line 507 of file dsnlexer.h.

References LINE_READER::LineNumber().

Referenced by DSNLEXER::Duplicate(), DSNLEXER::Expecting(), CLIPBOARD_IO::Load(), PCB_IO::Load(), DSNLEXER::NeedNUMBER(), DSNLEXER::NextTok(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), KICAD_NETLIST_PARSER::parseComponent(), and DSNLEXER::Unexpected().

508  {
509  return reader->LineNumber();
510  }
virtual unsigned LineNumber() const
Function Line Number returns the line number of the last line read from this LINE_READER.
Definition: richio.h:159
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
int DSNLEXER::CurOffset ( )
inlineinherited

Function CurOffset returns the byte offset within the current line, using a 1 based index.

Returns
int - a one based index into the current line.

Definition at line 538 of file dsnlexer.h.

Referenced by DSNLEXER::Duplicate(), DSNLEXER::Expecting(), CLIPBOARD_IO::Load(), PCB_IO::Load(), DSNLEXER::NeedNUMBER(), DSNLEXER::NextTok(), KICAD_NETLIST_PARSER::parseComponent(), and DSNLEXER::Unexpected().

539  {
540  return curOffset + 1;
541  }
int curOffset
offset within current line of the current token
Definition: dsnlexer.h:106
const wxString& DSNLEXER::CurSource ( )
inlineinherited

Function CurFilename returns the current LINE_READER source.

Returns
const wxString& - the source of the lines of text, e.g. a filename or "clipboard".

Definition at line 528 of file dsnlexer.h.

References LINE_READER::GetSource().

Referenced by DSNLEXER::Duplicate(), DSNLEXER::Expecting(), CLIPBOARD_IO::Load(), PCB_IO::Load(), DSNLEXER::NeedNUMBER(), DSNLEXER::NextTok(), KICAD_NETLIST_PARSER::parseComponent(), and DSNLEXER::Unexpected().

529  {
530  return reader->GetSource();
531  }
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
virtual const wxString & GetSource() const
Function GetSource returns the name of the source of the lines in an abstract sense.
Definition: richio.h:130
const std::string& DSNLEXER::CurStr ( )
inlineinherited

Function CurStr returns a reference to current token in std::string form.

Definition at line 488 of file dsnlexer.h.

References DSNLEXER::curText.

Referenced by Parse(), and PAGE_LAYOUT_READER_PARSER::readPngdata().

489  {
490  return curText;
491  }
std::string curText
the text of the current token
Definition: dsnlexer.h:109
const char* DSNLEXER::CurText ( )
inlineinherited

Function CurText returns a pointer to the current token's text.

Definition at line 479 of file dsnlexer.h.

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), DSN::SPECCTRA_DB::doCIRCLE(), DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::doCLASSES(), DSN::SPECCTRA_DB::doCOMP_ORDER(), DSN::SPECCTRA_DB::doCOMPONENT(), DSN::SPECCTRA_DB::doCONNECT(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doFROMTO(), DSN::SPECCTRA_DB::doGRID(), DSN::SPECCTRA_DB::doHISTORY(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doKEEPOUT(), DSN::SPECCTRA_DB::doLAYER(), DSN::SPECCTRA_DB::doLAYER_RULE(), DSN::SPECCTRA_DB::doLIBRARY(), DSN::SPECCTRA_DB::doNET(), DSN::SPECCTRA_DB::doNET_OUT(), DSN::SPECCTRA_DB::doNETWORK(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doPARSER(), DSN::SPECCTRA_DB::doPATH(), DSN::SPECCTRA_DB::doPCB(), DSN::SPECCTRA_DB::doPIN(), DSN::SPECCTRA_DB::doPLACE(), DSN::SPECCTRA_DB::doPROPERTIES(), DSN::SPECCTRA_DB::doQARC(), DSN::SPECCTRA_DB::doRECTANGLE(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doRESOLUTION(), DSN::SPECCTRA_DB::doROUTE(), DSN::SPECCTRA_DB::doRULE(), DSN::SPECCTRA_DB::doSESSION(), DSN::SPECCTRA_DB::doSHAPE(), DSN::SPECCTRA_DB::doSPECCTRA_LAYER_PAIR(), DSN::SPECCTRA_DB::doSTRINGPROP(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::doSTRUCTURE_OUT(), DSN::SPECCTRA_DB::doSUPPLY_PIN(), DSN::SPECCTRA_DB::doTOKPROP(), DSN::SPECCTRA_DB::doTOPOLOGY(), DSN::SPECCTRA_DB::doVIA(), DSN::SPECCTRA_DB::doWAS_IS(), DSN::SPECCTRA_DB::doWINDOW(), DSN::SPECCTRA_DB::doWIRE(), DSN::SPECCTRA_DB::doWIRE_VIA(), DSN::SPECCTRA_DB::doWIRING(), PCAD2KICAD::LoadInputFile(), Parse(), PAGE_LAYOUT_READER_PARSER::Parse(), TEMPLATE_FIELDNAME::Parse(), TEMPLATES::Parse(), PAGE_LAYOUT_READER_PARSER::parseBitmap(), KICAD_NETLIST_PARSER::parseComponent(), PAGE_LAYOUT_READER_PARSER::parseCoordinate(), parseDouble(), PAGE_LAYOUT_READER_PARSER::parseDouble(), PAGE_LAYOUT_READER_PARSER::parseGraphic(), PCB_PARSER::parseHex(), parseInt(), PAGE_LAYOUT_READER_PARSER::parseInt(), PCB_PARSER::parseInt(), KICAD_NETLIST_PARSER::parseLibPartList(), KICAD_NETLIST_PARSER::parseNet(), BOM_CFG_READER_PARSER::parsePlugin(), PAGE_LAYOUT_READER_PARSER::parsePolygon(), PAGE_LAYOUT_READER_PARSER::parsePolyOutline(), PAGE_LAYOUT_READER_PARSER::parseSetup(), PAGE_LAYOUT_READER_PARSER::parseText(), DSN::SPECCTRA_DB::readCOMPnPIN(), PAGE_LAYOUT_READER_PARSER::readOption(), PAGE_LAYOUT_READER_PARSER::readPngdata(), DSN::SPECCTRA_DB::readTIME(), scanAtom(), and scanList().

480  {
481  return curText.c_str();
482  }
std::string curText
the text of the current token
Definition: dsnlexer.h:109
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::CurTok ( )
inlineinherited

Function CurTok returns whatever NextTok() returned the last time it was called.

Definition at line 183 of file pcb_plot_params_lexer.h.

References DSNLEXER::CurTok().

184  {
186  }
int CurTok()
Function CurTok returns whatever NextTok() returned the last time it was called.
Definition: dsnlexer.h:320
T
enum T contains all this lexer's tokens.
void DSNLEXER::Duplicate ( int  aTok)
inherited

Function Duplicate throws an IO_ERROR exception with a message saying specifically that aTok is a duplicate of one already seen in current context.

Parameters
aTokis the token/keyword type which was not expected at the current input location.
Exceptions
IO_ERRORwith the location within the input file of the problem.

Definition at line 377 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), Format(), DSNLEXER::GetTokenString(), and THROW_PARSE_ERROR.

Referenced by SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), and LIB_TABLE_ROW::Parse().

378 {
379  wxString errText = wxString::Format(
380  _("%s is a duplicate"), GetTokenString( aTok ).GetData() );
382 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
wxString GetTokenString(int aTok)
Function GetTokenString returns a quote wrapped wxString representation of a token value...
Definition: dsnlexer.cpp:334
void DSNLEXER::Expecting ( int  aTok)
inherited

Function Expecting throws an IO_ERROR exception with an input file specific error message.

Parameters
aTokis the token/keyword type which was expected at the current input location.
Exceptions
IO_ERRORwith the location within the input file of the problem.

Definition at line 353 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), Format(), GetChars(), DSNLEXER::GetTokenString(), and THROW_PARSE_ERROR.

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), DSN::SPECCTRA_DB::doBOUNDARY(), DSN::SPECCTRA_DB::doCIRCLE(), DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::SPECCTRA_DB::doCLASSES(), DSN::SPECCTRA_DB::doCOMP_ORDER(), DSN::SPECCTRA_DB::doCOMPONENT(), DSN::SPECCTRA_DB::doCONNECT(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doFROMTO(), DSN::SPECCTRA_DB::doGRID(), DSN::SPECCTRA_DB::doHISTORY(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doKEEPOUT(), DSN::SPECCTRA_DB::doLAYER(), DSN::SPECCTRA_DB::doLAYER_NOISE_WEIGHT(), DSN::SPECCTRA_DB::doLAYER_RULE(), DSN::SPECCTRA_DB::doLIBRARY(), DSN::SPECCTRA_DB::doNET(), DSN::SPECCTRA_DB::doNET_OUT(), DSN::SPECCTRA_DB::doNETWORK(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doPARSER(), DSN::SPECCTRA_DB::doPATH(), DSN::SPECCTRA_DB::doPCB(), DSN::SPECCTRA_DB::doPIN(), DSN::SPECCTRA_DB::doPLACE(), DSN::SPECCTRA_DB::doPLACEMENT(), DSN::SPECCTRA_DB::doPROPERTIES(), DSN::SPECCTRA_DB::doQARC(), DSN::SPECCTRA_DB::doRECTANGLE(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doRESOLUTION(), DSN::SPECCTRA_DB::doROUTE(), DSN::SPECCTRA_DB::doSESSION(), DSN::SPECCTRA_DB::doSHAPE(), DSN::SPECCTRA_DB::doSPECCTRA_LAYER_PAIR(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::doSTRUCTURE_OUT(), DSN::SPECCTRA_DB::doSUPPLY_PIN(), DSN::SPECCTRA_DB::doTOPOLOGY(), DSN::SPECCTRA_DB::doUNIT(), DSN::SPECCTRA_DB::doVIA(), DSN::SPECCTRA_DB::doWAS_IS(), DSN::SPECCTRA_DB::doWINDOW(), DSN::SPECCTRA_DB::doWIRE(), DSN::SPECCTRA_DB::doWIRE_VIA(), DSN::SPECCTRA_DB::doWIRING(), DSN::SPECCTRA_DB::LoadPCB(), DSN::SPECCTRA_DB::LoadSESSION(), DSNLEXER::NeedLEFT(), DSNLEXER::NeedRIGHT(), DSNLEXER::NeedSYMBOL(), DSNLEXER::NeedSYMBOLorNUMBER(), Parse(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), TEMPLATE_FIELDNAME::Parse(), LIB_TABLE_ROW::Parse(), parseBool(), KICAD_NETLIST_PARSER::parseComponent(), parseDouble(), PAGE_LAYOUT_READER_PARSER::parseDouble(), parseInt(), PAGE_LAYOUT_READER_PARSER::parseInt(), KICAD_NETLIST_PARSER::parseLibPartList(), DSN::SPECCTRA_DB::readCOMPnPIN(), and DSN::SPECCTRA_DB::readTIME().

354 {
355  wxString errText = wxString::Format(
356  _("Expecting '%s'"), GetChars( GetTokenString( aTok ) ) );
358 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
wxString GetTokenString(int aTok)
Function GetTokenString returns a quote wrapped wxString representation of a token value...
Definition: dsnlexer.cpp:334
void DSNLEXER::Expecting ( const char *  aTokenList)
inherited

Function Expecting throws an IO_ERROR exception with an input file specific error message.

Parameters
aTokenListis the token/keyword type which was expected at the current input location, e.g. "pin|graphic|property"
Exceptions
IO_ERRORwith the location within the input file of the problem.

Definition at line 361 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), Format(), GetChars(), and THROW_PARSE_ERROR.

362 {
363  wxString errText = wxString::Format(
364  _("Expecting '%s'"), GetChars( wxString::FromUTF8( text ) ) );
366 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
int DSNLEXER::findToken ( const std::string &  aToken)
inlineprotectedinherited

Function findToken takes aToken string and looks up the string in the keywords table.

Parameters
aTokenis a string to lookup in the keywords table.
Returns
int - with a value from the enum DSN_T matching the keyword text, or DSN_SYMBOL if aToken is not in the kewords table.

Definition at line 260 of file dsnlexer.cpp.

References DSN_SYMBOL, and DSNLEXER::keyword_hash.

Referenced by DSNLEXER::NextTok().

261 {
262  KEYWORD_MAP::const_iterator it = keyword_hash.find( tok.c_str() );
263  if( it != keyword_hash.end() )
264  return it->second;
265 
266  return DSN_SYMBOL; // not a keyword, some arbitrary symbol.
267 }
KEYWORD_MAP keyword_hash
fast, specialized "C string" hashtable
Definition: dsnlexer.h:113
wxString DSNLEXER::FromUTF8 ( )
inlineinherited

Function FromUTF8 returns the current token text as a wxString, assuming that the input byte stream is UTF8 encoded.

Definition at line 498 of file dsnlexer.h.

Referenced by PAGE_LAYOUT_READER_PARSER::Parse(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), LIB_TABLE_ROW::Parse(), PAGE_LAYOUT_READER_PARSER::parseBitmap(), KICAD_NETLIST_PARSER::parseComponent(), PAGE_LAYOUT_READER_PARSER::parseGraphic(), BOM_CFG_READER_PARSER::parsePlugin(), PAGE_LAYOUT_READER_PARSER::parsePolygon(), PAGE_LAYOUT_READER_PARSER::parseText(), and DSNLEXER::ReadCommentLines().

499  {
500  return wxString::FromUTF8( curText.c_str() );
501  }
std::string curText
the text of the current token
Definition: dsnlexer.h:109
LINE_READER* PCB_PLOT_PARAMS_PARSER::GetReader ( )
inline

Definition at line 42 of file pcb_plot_params_parser.h.

References DSNLEXER::reader.

42 { return reader; };
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
wxString DSNLEXER::GetTokenString ( int  aTok)
inherited

Function GetTokenString returns a quote wrapped wxString representation of a token value.

Definition at line 334 of file dsnlexer.cpp.

References DSNLEXER::GetTokenText().

Referenced by DSNLEXER::Duplicate(), DSNLEXER::Expecting(), DSN::SPECCTRA_DB::makeVIA(), and DSNLEXER::Unexpected().

335 {
336  wxString ret;
337 
338  ret << wxT("'") << wxString::FromUTF8( GetTokenText(aTok) ) << wxT("'");
339 
340  return ret;
341 }
const char * GetTokenText(int aTok)
Function GetTokenText returns the C string representation of a DSN_T value.
Definition: dsnlexer.cpp:315
const char * DSNLEXER::GetTokenText ( int  aTok)
inherited

Function GetTokenText returns the C string representation of a DSN_T value.

Definition at line 315 of file dsnlexer.cpp.

References DSNLEXER::keywordCount, DSNLEXER::keywords, KEYWORD::name, and DSNLEXER::Syntax().

Referenced by DSNLEXER::GetTokenString(), PCB_PARSER::parseBoardUnits(), and PCB_PARSER::parseDouble().

316 {
317  const char* ret;
318 
319  if( aTok < 0 )
320  {
321  return Syntax( aTok );
322  }
323  else if( (unsigned) aTok < keywordCount )
324  {
325  ret = keywords[aTok].name;
326  }
327  else
328  ret = "token too big";
329 
330  return ret;
331 }
const KEYWORD * keywords
table sorted by CMake for bsearch()
Definition: dsnlexer.h:111
const char * name
unique keyword.
Definition: dsnlexer.h:42
unsigned keywordCount
count of keywords table
Definition: dsnlexer.h:112
static const char * Syntax(int aTok)
Definition: dsnlexer.cpp:271
void DSNLEXER::init ( )
protectedinherited

Definition at line 44 of file dsnlexer.cpp.

References DSNLEXER::commentsAreTokens, DSNLEXER::curOffset, DSNLEXER::curTok, DSN_NONE, DSNLEXER::keyword_hash, DSNLEXER::keywordCount, DSNLEXER::keywords, KEYWORD::name, DSNLEXER::prevTok, DSNLEXER::space_in_quoted_tokens, DSNLEXER::specctraMode, DSNLEXER::stringDelimiter, and KEYWORD::token.

Referenced by DSNLEXER::DSNLEXER().

45 {
46  curTok = DSN_NONE;
47  prevTok = DSN_NONE;
48 
49  stringDelimiter = '"';
50 
51  specctraMode = false;
52  space_in_quoted_tokens = false;
53  commentsAreTokens = false;
54 
55  curOffset = 0;
56 
57 #if 1
58  if( keywordCount > 11 )
59  {
60  // resize the hashtable bucket count
61  keyword_hash.reserve( keywordCount );
62  }
63 
64  // fill the specialized "C string" hashtable from keywords[]
65  const KEYWORD* it = keywords;
66  const KEYWORD* end = it + keywordCount;
67 
68  for( ; it < end; ++it )
69  {
70  keyword_hash[it->name] = it->token;
71  }
72 #endif
73 }
int curOffset
offset within current line of the current token
Definition: dsnlexer.h:106
bool commentsAreTokens
true if should return comments as tokens
Definition: dsnlexer.h:103
const KEYWORD * keywords
table sorted by CMake for bsearch()
Definition: dsnlexer.h:111
const char * name
unique keyword.
Definition: dsnlexer.h:42
KEYWORD_MAP keyword_hash
fast, specialized "C string" hashtable
Definition: dsnlexer.h:113
bool space_in_quoted_tokens
blank spaces within quoted strings
Definition: dsnlexer.h:101
bool specctraMode
if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_...
Definition: dsnlexer.h:94
int prevTok
curTok from previous NextTok() call.
Definition: dsnlexer.h:105
unsigned keywordCount
count of keywords table
Definition: dsnlexer.h:112
int curTok
the current token obtained on last NextTok()
Definition: dsnlexer.h:108
Struct KEYWORD holds a keyword string and its unique integer token.
Definition: dsnlexer.h:40
char stringDelimiter
Definition: dsnlexer.h:100
int token
a zero based index into an array of KEYWORDs
Definition: dsnlexer.h:43
bool DSNLEXER::isStringTerminator ( char  cc)
inlineprotectedinherited

Definition at line 147 of file dsnlexer.h.

Referenced by DSNLEXER::NextTok().

148  {
149  if( !space_in_quoted_tokens && cc==' ' )
150  return true;
151 
152  if( cc == stringDelimiter )
153  return true;
154 
155  return false;
156  }
bool space_in_quoted_tokens
blank spaces within quoted strings
Definition: dsnlexer.h:101
char stringDelimiter
Definition: dsnlexer.h:100
bool DSNLEXER::IsSymbol ( int  aTok)
staticinherited

Function IsSymbol tests a token to see if it is a symbol.

This means it cannot be a special delimiter character such as DSN_LEFT, DSN_RIGHT, DSN_QUOTE, etc. It may however, coincidentally match a keyword and still be a symbol.

Definition at line 344 of file dsnlexer.cpp.

References DSN_STRING, and DSN_SYMBOL.

Referenced by DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::doCLASSES(), DSN::SPECCTRA_DB::doCOMP_ORDER(), DSN::SPECCTRA_DB::doCOMPONENT(), DSN::SPECCTRA_DB::doFROMTO(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doKEEPOUT(), DSN::SPECCTRA_DB::doLAYER(), DSN::SPECCTRA_DB::doLAYER_RULE(), DSN::SPECCTRA_DB::doNET(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doPATH(), DSN::SPECCTRA_DB::doPIN(), DSN::SPECCTRA_DB::doPLACE(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doSUPPLY_PIN(), DSN::SPECCTRA_DB::doVIA(), DSN::SPECCTRA_DB::doWIRE_VIA(), DSNLEXER::NeedSYMBOL(), DSNLEXER::NeedSYMBOLorNUMBER(), and DSN::SPECCTRA_DB::readCOMPnPIN().

345 {
346  // This is static and not inline to reduce code space.
347 
348  // if aTok is >= 0, then it is a coincidental match to a keyword.
349  return aTok==DSN_SYMBOL || aTok==DSN_STRING || aTok>=0;
350 }
void DSNLEXER::NeedLEFT ( )
inherited

Function NeedLEFT calls NextTok() and then verifies that the token read in is a DSN_LEFT.

If it is not, an IO_ERROR is thrown.

Exceptions
IO_ERROR,ifthe next token is not a DSN_LEFT

Definition at line 393 of file dsnlexer.cpp.

References DSN_LEFT, DSNLEXER::Expecting(), and DSNLEXER::NextTok().

Referenced by SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), TEMPLATE_FIELDNAME::Parse(), and LIB_TABLE_ROW::Parse().

394 {
395  int tok = NextTok();
396  if( tok != DSN_LEFT )
397  Expecting( DSN_LEFT );
398 }
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
int NextTok()
Function NextTok returns the next token found in the input file or DSN_EOF when reaching the end of f...
Definition: dsnlexer.cpp:540
int DSNLEXER::NeedNUMBER ( const char *  aExpectation)
inherited

Function NeedNUMBER calls NextTok() and then verifies that the token read is type DSN_NUMBER.

If not, and IO_ERROR is thrown using text from aExpectation.

Returns
int - the actual token read in.
Exceptions
IO_ERROR,ifthe next token does not satisfy the above test

Definition at line 427 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), DSN_NUMBER, Format(), DSNLEXER::NextTok(), and THROW_PARSE_ERROR.

Referenced by PCB_PARSER::parseDouble(), and PCB_PARSER::parseInt().

428 {
429  int tok = NextTok();
430  if( tok != DSN_NUMBER )
431  {
432  wxString errText = wxString::Format(
433  _("need a NUMBER for '%s'"), wxString::FromUTF8( aExpectation ).GetData() );
435  }
436  return tok;
437 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int NextTok()
Function NextTok returns the next token found in the input file or DSN_EOF when reaching the end of f...
Definition: dsnlexer.cpp:540
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
void DSNLEXER::NeedRIGHT ( )
inherited

Function NeedRIGHT calls NextTok() and then verifies that the token read in is a DSN_RIGHT.

If it is not, an IO_ERROR is thrown.

Exceptions
IO_ERROR,ifthe next token is not a DSN_RIGHT

Definition at line 401 of file dsnlexer.cpp.

References DSN_RIGHT, DSNLEXER::Expecting(), and DSNLEXER::NextTok().

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), DSN::SPECCTRA_DB::doBOUNDARY(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doFROMTO(), DSN::SPECCTRA_DB::doHISTORY(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doKEEPOUT(), DSN::SPECCTRA_DB::doLAYER_RULE(), DSN::SPECCTRA_DB::doNET(), DSN::SPECCTRA_DB::doNET_OUT(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doPARSER(), DSN::SPECCTRA_DB::doPATH(), DSN::SPECCTRA_DB::doPIN(), DSN::SPECCTRA_DB::doPLACE(), DSN::SPECCTRA_DB::doPLACEMENT(), DSN::SPECCTRA_DB::doPROPERTIES(), DSN::SPECCTRA_DB::doQARC(), DSN::SPECCTRA_DB::doRECTANGLE(), DSN::SPECCTRA_DB::doRESOLUTION(), DSN::SPECCTRA_DB::doSESSION(), DSN::SPECCTRA_DB::doSHAPE(), DSN::SPECCTRA_DB::doSPECCTRA_LAYER_PAIR(), DSN::SPECCTRA_DB::doSTRINGPROP(), DSN::SPECCTRA_DB::doSUPPLY_PIN(), DSN::SPECCTRA_DB::doTOKPROP(), DSN::SPECCTRA_DB::doUNIT(), DSN::SPECCTRA_DB::doWAS_IS(), DSN::SPECCTRA_DB::doWIRE(), DSN::SPECCTRA_DB::doWIRE_VIA(), Parse(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), TEMPLATE_FIELDNAME::Parse(), LIB_TABLE_ROW::Parse(), KICAD_NETLIST_PARSER::Parse(), PAGE_LAYOUT_READER_PARSER::parseBitmap(), KICAD_NETLIST_PARSER::parseComponent(), PAGE_LAYOUT_READER_PARSER::parseGraphic(), KICAD_NETLIST_PARSER::parseLibPartList(), KICAD_NETLIST_PARSER::parseNet(), BOM_CFG_READER_PARSER::parsePlugin(), PAGE_LAYOUT_READER_PARSER::parsePolygon(), PAGE_LAYOUT_READER_PARSER::parsePolyOutline(), PAGE_LAYOUT_READER_PARSER::parseSetup(), PAGE_LAYOUT_READER_PARSER::parseText(), and PAGE_LAYOUT_READER_PARSER::readPngdata().

402 {
403  int tok = NextTok();
404  if( tok != DSN_RIGHT )
405  Expecting( DSN_RIGHT );
406 }
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
int NextTok()
Function NextTok returns the next token found in the input file or DSN_EOF when reaching the end of f...
Definition: dsnlexer.cpp:540
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NeedSYMBOL ( )
inlineinherited

Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol().

If not, an IO_ERROR is thrown.

Returns
int - the actual token read in.
Exceptions
IO_ERROR,ifthe next token does not satisfy IsSymbol()

Definition at line 161 of file pcb_plot_params_lexer.h.

References DSNLEXER::NeedSYMBOL().

Referenced by Parse(), and parseBool().

162  {
164  }
int NeedSYMBOL()
Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(...
Definition: dsnlexer.cpp:409
T
enum T contains all this lexer's tokens.
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NeedSYMBOLorNUMBER ( )
inlineinherited

Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool IsSymbol() or tok==T_NUMBER.

If not, an IO_ERROR is thrown.

Returns
int - the actual token read in.
Exceptions
IO_ERROR,ifthe next token does not satisfy the above test

Definition at line 174 of file pcb_plot_params_lexer.h.

References DSNLEXER::NeedSYMBOLorNUMBER().

Referenced by Parse().

175  {
177  }
int NeedSYMBOLorNUMBER()
Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool I...
Definition: dsnlexer.cpp:418
T
enum T contains all this lexer's tokens.
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NextTok ( )
inlineinherited

Function NextTok returns the next token found in the input file or T_EOF when reaching the end of file.

Users should wrap this function to return an enum to aid in grammar debugging while running under a debugger, but leave this lower level function returning an int (so the enum does not collide with another usage).

Returns
PCBPLOTPARAMS_T::T - the type of token found next.
Exceptions
IO_ERROR- only if the LINE_READER throws it.

Definition at line 148 of file pcb_plot_params_lexer.h.

References DSNLEXER::NextTok().

Referenced by Parse(), parseDouble(), parseInt(), and skipCurrent().

149  {
151  }
T
enum T contains all this lexer's tokens.
int NextTok()
Function NextTok returns the next token found in the input file or DSN_EOF when reaching the end of f...
Definition: dsnlexer.cpp:540
void PCB_PLOT_PARAMS_PARSER::Parse ( PCB_PLOT_PARAMS aPcbPlotParams)

Definition at line 333 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_SilkS, DSNLEXER::CurStr(), DSNLEXER::CurText(), DSNLEXER::Expecting(), F_SilkS, FILLED, FROM_UTF8(), gbrDefaultPrecision, HPGL_PEN_DIAMETER_MAX, HPGL_PEN_DIAMETER_MIN, HPGL_PEN_NUMBER_MAX, HPGL_PEN_NUMBER_MIN, HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, KiROUND(), PCB_PLOT_PARAMS::m_A4Output, PCB_PLOT_PARAMS::m_createGerberJobFile, PCB_PLOT_PARAMS::m_drillMarks, PCB_PLOT_PARAMS::m_excludeEdgeLayer, PCB_PLOT_PARAMS::m_format, PCB_PLOT_PARAMS::m_gerberPrecision, PCB_PLOT_PARAMS::m_HPGLPenDiam, PCB_PLOT_PARAMS::m_HPGLPenNum, PCB_PLOT_PARAMS::m_HPGLPenSpeed, PCB_PLOT_PARAMS::m_includeGerberNetlistInfo, PCB_PLOT_PARAMS::m_layerSelection, PCB_PLOT_PARAMS::m_mirror, PCB_PLOT_PARAMS::m_negative, PCB_PLOT_PARAMS::m_outputDirectory, PCB_PLOT_PARAMS::m_plotFrameRef, PCB_PLOT_PARAMS::m_plotInvisibleText, PCB_PLOT_PARAMS::m_plotPadsOnSilkLayer, PCB_PLOT_PARAMS::m_plotReference, PCB_PLOT_PARAMS::m_plotValue, PCB_PLOT_PARAMS::m_plotViaOnMaskLayer, PCB_PLOT_PARAMS::m_scaleSelection, PCB_PLOT_PARAMS::m_subtractMaskFromSilk, PCB_PLOT_PARAMS::m_useAuxOrigin, PCB_PLOT_PARAMS::m_useGerberAttributes, PCB_PLOT_PARAMS::m_useGerberProtelExtensions, DSNLEXER::NeedRIGHT(), PCB_PLOT_PARAMS_LEXER::NeedSYMBOL(), PCB_PLOT_PARAMS_LEXER::NeedSYMBOLorNUMBER(), PCB_PLOT_PARAMS_LEXER::NextTok(), parseBool(), parseDouble(), LSET::ParseHex(), parseInt(), PLOT_FIRST_FORMAT, PLOT_LAST_FORMAT, PLOT_LINEWIDTH_DEFAULT, PCB_PLOT_PARAMS::SetLineWidth(), PCB_PLOT_PARAMS::SetPlotMode(), SKETCH, skipCurrent(), PCBPLOTPARAMS_T::T_creategerberjobfile, PCBPLOTPARAMS_T::T_drillshape, DSN::T_EOF, PCBPLOTPARAMS_T::T_excludeedgelayer, PCBPLOTPARAMS_T::T_gerberprecision, PCBPLOTPARAMS_T::T_hpglpendiameter, PCBPLOTPARAMS_T::T_hpglpennumber, PCBPLOTPARAMS_T::T_hpglpenoverlay, PCBPLOTPARAMS_T::T_hpglpenspeed, PCBPLOTPARAMS_T::T_layerselection, DSN::T_LEFT, TB_READER_T::T_linewidth, DSN::T_mirror, PCB_KEYS_T::T_mode, DSN::T_NUMBER, PCBPLOTPARAMS_T::T_outputdirectory, PCBPLOTPARAMS_T::T_outputformat, PCBPLOTPARAMS_T::T_padsonsilk, PCB_KEYS_T::T_pcbplotparams, PCBPLOTPARAMS_T::T_plotframeref, PCBPLOTPARAMS_T::T_plotinvisibletext, PCBPLOTPARAMS_T::T_plotreference, PCBPLOTPARAMS_T::T_plotvalue, PCBPLOTPARAMS_T::T_psa4output, PCBPLOTPARAMS_T::T_pscolor, PCBPLOTPARAMS_T::T_psnegative, DSN::T_RIGHT, PCBPLOTPARAMS_T::T_scaleselection, PCBPLOTPARAMS_T::T_subtractmaskfromsilk, PCBPLOTPARAMS_T::T_useauxorigin, PCBPLOTPARAMS_T::T_usegerberadvancedattributes, PCBPLOTPARAMS_T::T_usegerberattributes, PCBPLOTPARAMS_T::T_usegerberextensions, PCBPLOTPARAMS_T::T_viasonmask, and DSNLEXER::Unexpected().

Referenced by PCB_PLOT_PARAMS::Parse().

334 {
335  T token;
336 
337  while( ( token = NextTok() ) != T_RIGHT )
338  {
339  if( token == T_EOF)
340  Unexpected( T_EOF );
341 
342  if( token == T_LEFT )
343  token = NextTok();
344 
345  if( token == T_pcbplotparams )
346  continue;
347 
348  bool skip_right = false;
349 
350  switch( token )
351  {
352  case T_layerselection:
353  {
354  token = NeedSYMBOLorNUMBER();
355 
356  const std::string& cur = CurStr();
357 
358  if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
359  {
360  // unsigned legacy_mask = atol( cur.c_str() );
361 
362  /* It's not possible to convert a legacy Cu layer number to a new
363  Cu layer number without knowing the number or total Cu layers
364  in the legacy board. We do not have that information here.
365  So simply set all layers ON. User can turn them off in the UI.
366  This is one of the superiorities of the new Cu sequence.
367  aPcbPlotParams->m_layerSelection = LEGACY_PLUGIN::leg_mask2new( cu_count, legacy_mask );
368  */
369 
370  // sorry, use the UI once to fix:
371  aPcbPlotParams->m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
372  }
373  else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
374  {
375  // skip the leading 2 0x bytes.
376  aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str()+2, cur.size()-2 );
377  }
378  else
379  Expecting( "integer or hex layerSelection" );
380  }
381  break;
382 
384  aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
385  break;
386 
388  aPcbPlotParams->m_useGerberAttributes = parseBool();
389  break;
390 
392  aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
393  break;
394 
396  aPcbPlotParams->m_createGerberJobFile = parseBool();
397  break;
398 
399  case T_gerberprecision:
400  aPcbPlotParams->m_gerberPrecision =
402  break;
403 
404  case T_psa4output:
405  aPcbPlotParams->m_A4Output = parseBool();
406  break;
407 
408  case T_excludeedgelayer:
409  aPcbPlotParams->m_excludeEdgeLayer = parseBool();
410  break;
411 
412  case T_linewidth:
413  {
414  // Due to a bug, this (minor) parameter was saved in biu
415  // and now is saved in mm
416  // If the read value is outside bounds, force a default value
417  double tmp = parseDouble();
418  if( !aPcbPlotParams->SetLineWidth( KiROUND( tmp * IU_PER_MM ) ) )
419  aPcbPlotParams->SetLineWidth( PLOT_LINEWIDTH_DEFAULT );
420  }
421  break;
422 
423  case T_plotframeref:
424  aPcbPlotParams->m_plotFrameRef = parseBool();
425  break;
426 
427  case T_viasonmask:
428  aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
429  break;
430 
431  case T_mode:
432  aPcbPlotParams->SetPlotMode( parseInt( 0, 2 ) > 1 ? SKETCH : FILLED );
433  break;
434 
435  case T_useauxorigin:
436  aPcbPlotParams->m_useAuxOrigin = parseBool();
437  break;
438 
439  case T_hpglpennumber:
440  aPcbPlotParams->m_HPGLPenNum = parseInt( HPGL_PEN_NUMBER_MIN,
442  break;
443 
444  case T_hpglpenspeed:
445  aPcbPlotParams->m_HPGLPenSpeed = parseInt( HPGL_PEN_SPEED_MIN,
447  break;
448 
449  case T_hpglpendiameter:
450  aPcbPlotParams->m_HPGLPenDiam = parseInt( HPGL_PEN_DIAMETER_MIN,
452  break;
453 
454  case T_hpglpenoverlay:
455  // No more used. juste here for compatibility with old versions
457  break;
458 
459  case T_pscolor:
460  NeedSYMBOL(); // This actually was never used...
461  break;
462 
463  case T_psnegative:
464  aPcbPlotParams->m_negative = parseBool();
465  break;
466 
467  case T_plotreference:
468  aPcbPlotParams->m_plotReference = parseBool();
469  break;
470 
471  case T_plotvalue:
472  aPcbPlotParams->m_plotValue = parseBool();
473  break;
474 
475  case T_plotinvisibletext:
476  aPcbPlotParams->m_plotInvisibleText = parseBool();
477  break;
478 
479  case T_padsonsilk:
480  aPcbPlotParams->m_plotPadsOnSilkLayer= parseBool();
481  break;
482 
484  aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
485  break;
486 
487  case T_outputformat:
488  aPcbPlotParams->m_format = static_cast<PlotFormat>(
490  break;
491 
492  case T_mirror:
493  aPcbPlotParams->m_mirror = parseBool();
494  break;
495 
496  case T_drillshape:
497  aPcbPlotParams->m_drillMarks = static_cast<PCB_PLOT_PARAMS::DrillMarksType>
498  ( parseInt( 0, 2 ) );
499  break;
500 
501  case T_scaleselection:
502  aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
503  break;
504 
505  case T_outputdirectory:
506  NeedSYMBOL();
507  aPcbPlotParams->m_outputDirectory = FROM_UTF8( CurText() );
508  break;
509 
510  default:
511  skipCurrent(); // skip unknown or outdated plot parameter
512  skip_right = true; // the closing right token is already read.
513  break;
514  }
515 
516  if( ! skip_right )
517  NeedRIGHT();
518  }
519 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:646
#define HPGL_PEN_NUMBER_MAX
PCBPLOTPARAMS_T::T NeedSYMBOLorNUMBER()
Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool I...
bool m_plotValue
Enable plotting of part values.
#define HPGL_PEN_SPEED_MAX
double parseDouble()
Function parseDouble parses a double.
#define PLOT_LINEWIDTH_DEFAULT
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
bool m_mirror
Mirror the plot around the X axis.
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plot_common.h:49
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
void Unexpected(int aTok)
Function Unexpected throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:369
static const int gbrDefaultPrecision
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
const std::string & CurStr()
Function CurStr returns a reference to current token in std::string form.
Definition: dsnlexer.h:488
bool m_plotReference
Enable plotting of part references.
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int m_scaleSelection
Scale ratio index (UI only)
PCBPLOTPARAMS_T::T NeedSYMBOL()
Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(...
bool m_negative
Plot in negative color (supported only by some drivers)
bool m_plotFrameRef
True to plot/print frame references.
bool SetLineWidth(int aValue)
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
bool m_useGerberAttributes
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
bool m_plotInvisibleText
Force plotting of fields marked invisible.
PCBPLOTPARAMS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
Class LSET is a set of PCB_LAYER_IDs.
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
#define HPGL_PEN_DIAMETER_MAX
#define HPGL_PEN_DIAMETER_MIN
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
void SetPlotMode(EDA_DRAW_MODE_T aPlotMode)
T
enum T contains all this lexer's tokens.
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
LSET m_layerSelection
Set of layers to plot.
void skipCurrent()
Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes ...
#define HPGL_PEN_NUMBER_MIN
#define HPGL_PEN_SPEED_MIN
void NeedRIGHT()
Function NeedRIGHT calls NextTok() and then verifies that the token read in is a DSN_RIGHT.
Definition: dsnlexer.cpp:401
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
int parseInt(int aMin, int aMax)
Function parseInt parses an integer and constrains it between two values.
int ParseHex(const char *aStart, int aCount)
Function ParseHex understands the output of FmtHex() and replaces this set's values with those given ...
Definition: lset.cpp:285
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
PlotFormat m_format
Plot format type (chooses the driver to be used)
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
bool PCB_PLOT_PARAMS_PARSER::parseBool ( )
private

Definition at line 522 of file pcb_plot_params.cpp.

References DSNLEXER::Expecting(), PCB_PLOT_PARAMS_LEXER::NeedSYMBOL(), PCBPLOTPARAMS_T::T_false, and PCBPLOTPARAMS_T::T_true.

Referenced by Parse().

523 {
524  T token = NeedSYMBOL();
525 
526  if( token != T_false && token != T_true )
527  Expecting( "true|false" );
528 
529  return token == T_true;
530 }
PCBPLOTPARAMS_T::T NeedSYMBOL()
Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(...
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
T
enum T contains all this lexer's tokens.
double PCB_PLOT_PARAMS_PARSER::parseDouble ( )
private

Function parseDouble parses a double.

Returns
double - the parsed double.

Definition at line 551 of file pcb_plot_params.cpp.

References DSNLEXER::CurText(), DSNLEXER::Expecting(), PCB_PLOT_PARAMS_LEXER::NextTok(), and DSN::T_NUMBER.

Referenced by Parse().

552 {
553  T token = NextTok();
554 
555  if( token != T_NUMBER )
556  Expecting( T_NUMBER );
557 
558  double val = strtod( CurText(), NULL );
559 
560  return val;
561 }
PCBPLOTPARAMS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
T
enum T contains all this lexer's tokens.
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
int PCB_PLOT_PARAMS_PARSER::parseInt ( int  aMin,
int  aMax 
)
private

Function parseInt parses an integer and constrains it between two values.

Parameters
aMinis the smallest return value.
aMaxis the largest return value.
Returns
int - the parsed integer.

Definition at line 533 of file pcb_plot_params.cpp.

References DSNLEXER::CurText(), DSNLEXER::Expecting(), PCB_PLOT_PARAMS_LEXER::NextTok(), and DSN::T_NUMBER.

Referenced by Parse().

534 {
535  T token = NextTok();
536 
537  if( token != T_NUMBER )
538  Expecting( T_NUMBER );
539 
540  int val = atoi( CurText() );
541 
542  if( val < aMin )
543  val = aMin;
544  else if( val > aMax )
545  val = aMax;
546 
547  return val;
548 }
PCBPLOTPARAMS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
T
enum T contains all this lexer's tokens.
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
LINE_READER * DSNLEXER::PopReader ( )
inherited

Function PopReader deletes the top most LINE_READER from an internal stack of LINE_READERs and in the case of FILE_LINE_READER this means the associated FILE is closed.

The most recently used former LINE_READER on the stack becomes the current LINE_READER and its previous position in its input stream and the its latest line number should pertain. PopReader always starts reading from a new line upon returning to the previous LINE_READER. A pop is only possible if there are at least 2 LINE_READERs on the stack, since popping the last one is not supported.

Returns
LINE_READER* - is the one that was in use before the pop, or NULL if there was not at least two readers on the stack and therefore the pop failed.

Definition at line 204 of file dsnlexer.cpp.

References DSNLEXER::dummy, DSNLEXER::limit, LINE_READER::Line(), DSNLEXER::next, DSNLEXER::reader, DSNLEXER::readerStack, and DSNLEXER::start.

Referenced by DSN::SPECCTRA_DB::LoadPCB(), DSN::SPECCTRA_DB::LoadSESSION(), and PCB_PARSER::SetLineReader().

205 {
206  LINE_READER* ret = 0;
207 
208  if( readerStack.size() )
209  {
210  ret = reader;
211  readerStack.pop_back();
212 
213  if( readerStack.size() )
214  {
215  reader = readerStack.back();
216  start = reader->Line();
217 
218  // force a new readLine() as first thing.
219  limit = start;
220  next = start;
221  }
222  else
223  {
224  reader = 0;
225  start = dummy;
226  limit = dummy;
227  }
228  }
229  return ret;
230 }
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
const char * next
Definition: dsnlexer.h:85
const char * limit
Definition: dsnlexer.h:86
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
READER_STACK readerStack
all the LINE_READERs by pointer.
Definition: dsnlexer.h:91
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
const char * start
Definition: dsnlexer.h:84
char dummy[1]
when there is no reader.
Definition: dsnlexer.h:87
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::PrevTok ( )
inlineinherited

Function PrevTok returns whatever NextTok() returned the 2nd to last time it was called.

Definition at line 192 of file pcb_plot_params_lexer.h.

References DSNLEXER::PrevTok().

193  {
195  }
int PrevTok()
Function PrevTok returns whatever NextTok() returned the 2nd to last time it was called.
Definition: dsnlexer.h:329
T
enum T contains all this lexer's tokens.
void DSNLEXER::PushReader ( LINE_READER aLineReader)
inherited

Function PushReader manages a stack of LINE_READERs in order to handle nested file inclusion.

This function pushes aLineReader onto the top of a stack of LINE_READERs and makes it the current LINE_READER with its own GetSource(), line number and line text. A grammar must be designed such that the "include" token (whatever its various names), and any of its parameters are not followed by anything on that same line, because PopReader always starts reading from a new line upon returning to the original LINE_READER.

Definition at line 192 of file dsnlexer.cpp.

References DSNLEXER::limit, DSNLEXER::next, DSNLEXER::reader, DSNLEXER::readerStack, and DSNLEXER::start.

Referenced by DSNLEXER::DSNLEXER(), DSN::SPECCTRA_DB::LoadPCB(), DSN::SPECCTRA_DB::LoadSESSION(), and PCB_PARSER::SetLineReader().

193 {
194  readerStack.push_back( aLineReader );
195  reader = aLineReader;
196  start = (const char*) (*reader);
197 
198  // force a new readLine() as first thing.
199  limit = start;
200  next = start;
201 }
const char * next
Definition: dsnlexer.h:85
const char * limit
Definition: dsnlexer.h:86
READER_STACK readerStack
all the LINE_READERs by pointer.
Definition: dsnlexer.h:91
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
const char * start
Definition: dsnlexer.h:84
wxArrayString * DSNLEXER::ReadCommentLines ( )
inherited

Function ReadCommentLines checks the next sequence of tokens and reads them into a wxArrayString if they are comments.

Reading continues until a non-comment token is encountered, and such last read token remains as CurTok() and as CurText(). No push back or "un get" mechanism is used for this support. Upon return you simply avoid calling NextTok() for the next token, but rather CurTok().

Returns
wxArrayString* - heap allocated block of comments, or NULL if none; caller owns the allocation and must delete if not NULL.

Definition at line 811 of file dsnlexer.cpp.

References DSN_COMMENT, DSNLEXER::FromUTF8(), DSNLEXER::NextTok(), and DSNLEXER::SetCommentsAreTokens().

812 {
813  wxArrayString* ret = 0;
814  bool cmt_setting = SetCommentsAreTokens( true );
815  int tok = NextTok();
816 
817  if( tok == DSN_COMMENT )
818  {
819  ret = new wxArrayString();
820 
821  do
822  {
823  ret->Add( FromUTF8() );
824  }
825  while( ( tok = NextTok() ) == DSN_COMMENT );
826  }
827 
828  SetCommentsAreTokens( cmt_setting );
829 
830  return ret;
831 }
bool SetCommentsAreTokens(bool val)
Function SetCommentsAreTokens changes the handling of comments.
Definition: dsnlexer.h:372
wxString FromUTF8()
Function FromUTF8 returns the current token text as a wxString, assuming that the input byte stream i...
Definition: dsnlexer.h:498
int NextTok()
Function NextTok returns the next token found in the input file or DSN_EOF when reaching the end of f...
Definition: dsnlexer.cpp:540
int DSNLEXER::readLine ( )
inlineprotectedinherited

Definition at line 117 of file dsnlexer.h.

References LINE_READER::Length(), LINE_READER::Line(), LINE_READER::ReadLine(), and DSNLEXER::start.

Referenced by DSNLEXER::NextTok().

118  {
119  if( reader )
120  {
121  reader->ReadLine();
122 
123  unsigned len = reader->Length();
124 
125  // start may have changed in ReadLine(), which can resize and
126  // relocate reader's line buffer.
127  start = reader->Line();
128 
129  next = start;
130  limit = next + len;
131 
132  return len;
133  }
134  return 0;
135  }
const char * next
Definition: dsnlexer.h:85
const char * limit
Definition: dsnlexer.h:86
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
unsigned Length() const
Function Length returns the number of bytes in the last line read from this LINE_READER.
Definition: richio.h:168
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
const char * start
Definition: dsnlexer.h:84
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter...
bool DSNLEXER::SetCommentsAreTokens ( bool  val)
inlineinherited

Function SetCommentsAreTokens changes the handling of comments.

If set true, comments are returns as single line strings with a terminating newline, else they are consumed by the lexer and not returned.

Definition at line 372 of file dsnlexer.h.

References DSNLEXER::commentsAreTokens.

Referenced by DSNLEXER::ReadCommentLines().

373  {
374  bool old = commentsAreTokens;
375  commentsAreTokens = val;
376  return old;
377  }
bool commentsAreTokens
true if should return comments as tokens
Definition: dsnlexer.h:103
bool DSNLEXER::SetSpaceInQuotedTokens ( bool  val)
inlineinherited

Function SetSpaceInQuotedTokens changes the setting controlling whether a space in a quoted string is a terminator.

Parameters
valIf true, means

Definition at line 358 of file dsnlexer.h.

References DSNLEXER::space_in_quoted_tokens.

Referenced by DSN::SPECCTRA_DB::doPARSER().

359  {
360  bool old = space_in_quoted_tokens;
361  if( specctraMode )
363  return old;
364  }
bool space_in_quoted_tokens
blank spaces within quoted strings
Definition: dsnlexer.h:101
bool specctraMode
if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_...
Definition: dsnlexer.h:94
void DSNLEXER::SetSpecctraMode ( bool  aMode)
inherited

Function SetSpecctraMode changes the behavior of this lexer into or out of "specctra mode".

If specctra mode, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_in_quoted_tokens is functional else none of the above are true. The default mode is non-specctra mode, meaning: 1) stringDelimiter cannot be changed 2) Kicad quoting protocol is in effect 3) space_in_quoted_tokens is not functional

Definition at line 153 of file dsnlexer.cpp.

References DSNLEXER::space_in_quoted_tokens, DSNLEXER::specctraMode, and DSNLEXER::stringDelimiter.

Referenced by DSN::SPECCTRA_DB::SPECCTRA_DB().

154 {
155  specctraMode = aMode;
156  if( aMode )
157  {
158  // specctra mode defaults, some of which can still be changed in this mode.
159  space_in_quoted_tokens = true;
160  }
161  else
162  {
163  space_in_quoted_tokens = false;
164  stringDelimiter = '"';
165  }
166 }
bool space_in_quoted_tokens
blank spaces within quoted strings
Definition: dsnlexer.h:101
bool specctraMode
if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_...
Definition: dsnlexer.h:94
char stringDelimiter
Definition: dsnlexer.h:100
char DSNLEXER::SetStringDelimiter ( char  aStringDelimiter)
inlineinherited

Function SetStringDelimiter changes the string delimiter from the default " to some other character and returns the old value.

Parameters
aStringDelimiterThe character in lowest 8 bits.
Returns
int - The old delimiter in the lowest 8 bits.

Definition at line 344 of file dsnlexer.h.

References DSNLEXER::stringDelimiter.

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

345  {
346  int old = stringDelimiter;
347  if( specctraMode )
348  stringDelimiter = aStringDelimiter;
349  return old;
350  }
bool specctraMode
if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_...
Definition: dsnlexer.h:94
char stringDelimiter
Definition: dsnlexer.h:100
void PCB_PLOT_PARAMS_PARSER::skipCurrent ( )
private

Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes the current description.

Definition at line 564 of file pcb_plot_params.cpp.

References PCB_PLOT_PARAMS_LEXER::NextTok(), DSN::T_EOF, DSN::T_LEFT, and DSN::T_RIGHT.

Referenced by Parse().

565 {
566  int curr_level = 0;
567  T token;
568 
569  while( ( token = NextTok() ) != T_EOF )
570  {
571  if( token == T_LEFT )
572  curr_level--;
573 
574  if( token == T_RIGHT )
575  {
576  curr_level++;
577 
578  if( curr_level > 0 )
579  return;
580  }
581  }
582 }
PCBPLOTPARAMS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
T
enum T contains all this lexer's tokens.
bool DSNLEXER::SyncLineReaderWith ( DSNLEXER aLexer)
inherited

Useable only for DSN lexers which share the same LINE_READER Synchronizes the pointers handling the data read by the LINE_READER Allows 2 DNSLEXER to share the same current line, when switching from a DNSLEXER to an other DNSLEXER.

Parameters
aLexer= the model
Returns
true if the sync can be made ( at least the same line reader )

Definition at line 169 of file dsnlexer.cpp.

References DSNLEXER::curOffset, DSNLEXER::curText, DSNLEXER::limit, DSNLEXER::next, DSNLEXER::reader, and DSNLEXER::start.

Referenced by PCB_PARSER::parseSetup().

170 {
171  // Synchronize the pointers handling the data read by the LINE_READER
172  // only if aLexer shares the same LINE_READER, because only in this case
173  // the char buffer is be common
174 
175  if( reader != aLexer.reader )
176  return false;
177 
178  // We can synchronize the pointers which handle the data currently read
179  start = aLexer.start;
180  next = aLexer.next;
181  limit = aLexer.limit;
182 
183  // Sync these parameters is not mandatory, but could help
184  // for instance in debug
185  curText = aLexer.curText;
186  curOffset = aLexer.curOffset;
187 
188  return true;
189 }
int curOffset
offset within current line of the current token
Definition: dsnlexer.h:106
const char * next
Definition: dsnlexer.h:85
const char * limit
Definition: dsnlexer.h:86
LINE_READER * reader
no ownership. ownership is via readerStack, maybe, if iOwnReaders
Definition: dsnlexer.h:92
const char * start
Definition: dsnlexer.h:84
std::string curText
the text of the current token
Definition: dsnlexer.h:109
const char * DSNLEXER::Syntax ( int  aTok)
staticinherited

Definition at line 271 of file dsnlexer.cpp.

References DSN_DASH, DSN_EOF, DSN_LEFT, DSN_NONE, DSN_NUMBER, DSN_QUOTE_DEF, DSN_RIGHT, DSN_STRING, DSN_STRING_QUOTE, and DSN_SYMBOL.

Referenced by DSNLEXER::GetTokenText(), DIALOG_BOM_CFG_LEXER::TokenName(), TEMPLATE_FIELDNAMES_LEXER::TokenName(), FP_LIB_TABLE_LEXER::TokenName(), LIB_TABLE_LEXER::TokenName(), PCB_PLOT_PARAMS_LEXER::TokenName(), CMP_LIBRARY_LEXER::TokenName(), NETLIST_LEXER::TokenName(), PAGE_LAYOUT_READER_LEXER::TokenName(), PCB_LEXER::TokenName(), and SPECCTRA_LEXER::TokenName().

272 {
273  const char* ret;
274 
275  switch( aTok )
276  {
277  case DSN_NONE:
278  ret = "NONE";
279  break;
280  case DSN_STRING_QUOTE:
281  ret = "string_quote"; // a special DSN syntax token, see specctra spec.
282  break;
283  case DSN_QUOTE_DEF:
284  ret = "quoted text delimiter";
285  break;
286  case DSN_DASH:
287  ret = "-";
288  break;
289  case DSN_SYMBOL:
290  ret = "symbol";
291  break;
292  case DSN_NUMBER:
293  ret = "number";
294  break;
295  case DSN_RIGHT:
296  ret = ")";
297  break;
298  case DSN_LEFT:
299  ret = "(";
300  break;
301  case DSN_STRING:
302  ret = "quoted string";
303  break;
304  case DSN_EOF:
305  ret = "end of input";
306  break;
307  default:
308  ret = "???";
309  }
310 
311  return ret;
312 }
const char * PCB_PLOT_PARAMS_LEXER::TokenName ( PCBPLOTPARAMS_T::T  aTok)
staticinherited

Function TokenName returns the name of the token in ASCII form.

Definition at line 53 of file pcb_plot_params_keywords.cpp.

References PCB_PLOT_PARAMS_LEXER::keyword_count, PCB_PLOT_PARAMS_LEXER::keywords, KEYWORD::name, and DSNLEXER::Syntax().

Referenced by getTokenName().

54 {
55  const char* ret;
56 
57  if( aTok < 0 )
58  ret = DSNLEXER::Syntax( aTok );
59  else if( (unsigned) aTok < keyword_count )
60  ret = keywords[aTok].name;
61  else
62  ret = "token too big";
63 
64  return ret;
65 }
const char * name
unique keyword.
Definition: dsnlexer.h:42
static const unsigned keyword_count
static const KEYWORD keywords[]
Auto generated lexer keywords table and length:
static const char * Syntax(int aTok)
Definition: dsnlexer.cpp:271
void DSNLEXER::Unexpected ( int  aTok)
inherited

Function Unexpected throws an IO_ERROR exception with an input file specific error message.

Parameters
aTokis the token/keyword type which was not expected at the current input location.
Exceptions
IO_ERRORwith the location within the input file of the problem.

Definition at line 369 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), Format(), GetChars(), DSNLEXER::GetTokenString(), and THROW_PARSE_ERROR.

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), DSN::SPECCTRA_DB::doBOUNDARY(), DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::SPECCTRA_DB::doCOMPONENT(), DSN::SPECCTRA_DB::doCONNECT(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doFROMTO(), DSN::SPECCTRA_DB::doGRID(), DSN::SPECCTRA_DB::doHISTORY(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doKEEPOUT(), DSN::SPECCTRA_DB::doLAYER(), DSN::SPECCTRA_DB::doLIBRARY(), DSN::SPECCTRA_DB::doNET(), DSN::SPECCTRA_DB::doNET_OUT(), DSN::SPECCTRA_DB::doNETWORK(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doPARSER(), DSN::SPECCTRA_DB::doPCB(), DSN::SPECCTRA_DB::doPLACE(), DSN::SPECCTRA_DB::doPLACEMENT(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doROUTE(), DSN::SPECCTRA_DB::doRULE(), DSN::SPECCTRA_DB::doSESSION(), DSN::SPECCTRA_DB::doSHAPE(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::doSTRUCTURE_OUT(), DSN::SPECCTRA_DB::doSUPPLY_PIN(), DSN::SPECCTRA_DB::doTOKPROP(), DSN::SPECCTRA_DB::doTOPOLOGY(), DSN::SPECCTRA_DB::doVIA(), DSN::SPECCTRA_DB::doWAS_IS(), DSN::SPECCTRA_DB::doWINDOW(), DSN::SPECCTRA_DB::doWIRE(), DSN::SPECCTRA_DB::doWIRE_VIA(), DSN::SPECCTRA_DB::doWIRING(), Parse(), PAGE_LAYOUT_READER_PARSER::Parse(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), TEMPLATES::Parse(), LIB_TABLE_ROW::Parse(), PAGE_LAYOUT_READER_PARSER::parseBitmap(), PAGE_LAYOUT_READER_PARSER::parseCoordinate(), PAGE_LAYOUT_READER_PARSER::parseGraphic(), BOM_CFG_READER_PARSER::parsePlugin(), PAGE_LAYOUT_READER_PARSER::parsePolygon(), PAGE_LAYOUT_READER_PARSER::parsePolyOutline(), PAGE_LAYOUT_READER_PARSER::parseSetup(), PAGE_LAYOUT_READER_PARSER::parseText(), PAGE_LAYOUT_READER_PARSER::readOption(), PAGE_LAYOUT_READER_PARSER::readPngdata(), Scan(), and scanList().

370 {
371  wxString errText = wxString::Format(
372  _("Unexpected '%s'"), GetChars( GetTokenString( aTok ) ) );
374 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
wxString GetTokenString(int aTok)
Function GetTokenString returns a quote wrapped wxString representation of a token value...
Definition: dsnlexer.cpp:334
void DSNLEXER::Unexpected ( const char *  aToken)
inherited

Function Unexpected throws an IO_ERROR exception with an input file specific error message.

Parameters
aTokenis the token which was not expected at the current input location.
Exceptions
IO_ERRORwith the location within the input file of the problem.

Definition at line 385 of file dsnlexer.cpp.

References DSNLEXER::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), Format(), GetChars(), and THROW_PARSE_ERROR.

386 {
387  wxString errText = wxString::Format(
388  _("Unexpected '%s'"), GetChars( wxString::FromUTF8( text ) ) );
390 }
const wxString & CurSource()
Function CurFilename returns the current LINE_READER source.
Definition: dsnlexer.h:528
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
int CurOffset()
Function CurOffset returns the byte offset within the current line, using a 1 based index...
Definition: dsnlexer.h:538
const char * CurLine()
Function CurLine returns the current line of text, from which the CurText() would return its token...
Definition: dsnlexer.h:517
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507

Member Data Documentation

bool DSNLEXER::commentsAreTokens
protectedinherited

true if should return comments as tokens

Definition at line 103 of file dsnlexer.h.

Referenced by DSNLEXER::init(), DSNLEXER::NextTok(), and DSNLEXER::SetCommentsAreTokens().

int DSNLEXER::curOffset
protectedinherited

offset within current line of the current token

Definition at line 106 of file dsnlexer.h.

Referenced by DSNLEXER::init(), DSNLEXER::NextTok(), and DSNLEXER::SyncLineReaderWith().

std::string DSNLEXER::curText
protectedinherited

the text of the current token

Definition at line 109 of file dsnlexer.h.

Referenced by DSNLEXER::CurStr(), DSNLEXER::NextTok(), and DSNLEXER::SyncLineReaderWith().

int DSNLEXER::curTok
protectedinherited

the current token obtained on last NextTok()

Definition at line 108 of file dsnlexer.h.

Referenced by DSNLEXER::CurTok(), DSNLEXER::init(), and DSNLEXER::NextTok().

char DSNLEXER::dummy[1]
protectedinherited

when there is no reader.

Definition at line 87 of file dsnlexer.h.

Referenced by DSNLEXER::PopReader().

bool DSNLEXER::iOwnReaders
protectedinherited

on readerStack, should I delete them?

Definition at line 83 of file dsnlexer.h.

Referenced by DSN::SPECCTRA_DB::SPECCTRA_DB(), and DSNLEXER::~DSNLEXER().

KEYWORD_MAP DSNLEXER::keyword_hash
protectedinherited

fast, specialized "C string" hashtable

Definition at line 113 of file dsnlexer.h.

Referenced by DSNLEXER::findToken(), and DSNLEXER::init().

unsigned DSNLEXER::keywordCount
protectedinherited

count of keywords table

Definition at line 112 of file dsnlexer.h.

Referenced by DSNLEXER::GetTokenText(), and DSNLEXER::init().

const char* DSNLEXER::limit
protectedinherited
const char* DSNLEXER::next
protectedinherited
int DSNLEXER::prevTok
protectedinherited

curTok from previous NextTok() call.

Definition at line 105 of file dsnlexer.h.

Referenced by DSNLEXER::init(), DSNLEXER::NextTok(), and DSNLEXER::PrevTok().

LINE_READER* DSNLEXER::reader
protectedinherited

no ownership. ownership is via readerStack, maybe, if iOwnReaders

Definition at line 92 of file dsnlexer.h.

Referenced by GetReader(), DSNLEXER::PopReader(), DSNLEXER::PushReader(), and DSNLEXER::SyncLineReaderWith().

READER_STACK DSNLEXER::readerStack
protectedinherited

all the LINE_READERs by pointer.

Definition at line 91 of file dsnlexer.h.

Referenced by DSNLEXER::PopReader(), DSNLEXER::PushReader(), and DSNLEXER::~DSNLEXER().

bool DSNLEXER::space_in_quoted_tokens
protectedinherited

blank spaces within quoted strings

Definition at line 101 of file dsnlexer.h.

Referenced by DSNLEXER::init(), DSNLEXER::SetSpaceInQuotedTokens(), and DSNLEXER::SetSpecctraMode().

bool DSNLEXER::specctraMode
protectedinherited

if true, then: 1) stringDelimiter can be changed 2) Kicad quoting protocol is not in effect 3) space_in_quoted_tokens is functional else not.

Definition at line 94 of file dsnlexer.h.

Referenced by DSNLEXER::init(), DSNLEXER::NextTok(), and DSNLEXER::SetSpecctraMode().

const char* DSNLEXER::start
protectedinherited
char DSNLEXER::stringDelimiter
protectedinherited

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