KiCad PCB EDA Suite
PCB_PLOT_PARAMS_LEXER Class Reference

Class PCB_PLOT_PARAMS_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology, based on keywords provided by file: /home/kicad/workspace/kicad-doxygen/common/pcb_plot_params.keywords. More...

#include <pcb_plot_params_lexer.h>

Inheritance diagram for PCB_PLOT_PARAMS_LEXER:
DSNLEXER PCB_PLOT_PARAMS_PARSER

Public Member Functions

 PCB_PLOT_PARAMS_LEXER (const std::string &aSExpression, const wxString &aSource=wxEmptyString)
 Constructor ( const std::string&, const wxString& ) More...
 
 PCB_PLOT_PARAMS_LEXER (FILE *aFile, const wxString &aFilename)
 Constructor ( FILE* ) takes aFile already opened for reading and aFilename as parameters. More...
 
 PCB_PLOT_PARAMS_LEXER (LINE_READER *aLineReader)
 Constructor ( LINE_READER* ) intializes a lexer and prepares to read from aLineReader which is assumed ready, and may be in use by other DSNLEXERs also. More...
 
PCBPLOTPARAMS_T::T NextTok () throw ( IO_ERROR )
 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 () throw ( IO_ERROR )
 Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(). More...
 
PCBPLOTPARAMS_T::T NeedSYMBOLorNUMBER () throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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 () throw ( IO_ERROR )
 Function ReadCommentLines checks the next sequence of tokens and reads them into a wxArrayString if they are comments. More...
 
void Expecting (int aTok) throw ( IO_ERROR )
 Function Expecting throws an IO_ERROR exception with an input file specific error message. More...
 
void Expecting (const char *aTokenList) throw ( IO_ERROR )
 Function Expecting throws an IO_ERROR exception with an input file specific error message. More...
 
void Unexpected (int aTok) throw ( IO_ERROR )
 Function Unexpected throws an IO_ERROR exception with an input file specific error message. More...
 
void Unexpected (const char *aToken) throw ( IO_ERROR )
 Function Unexpected throws an IO_ERROR exception with an input file specific error message. More...
 
void Duplicate (int aTok) throw ( IO_ERROR )
 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 () throw ( IO_ERROR )
 Function NeedLEFT calls NextTok() and then verifies that the token read in is a DSN_LEFT. More...
 
void NeedRIGHT () throw ( IO_ERROR )
 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 () throw ( IO_ERROR )
 
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...
 

Static Private Attributes

static const KEYWORD keywords []
 Auto generated lexer keywords table and length: More...
 
static const unsigned keyword_count = unsigned( sizeof( PCB_PLOT_PARAMS_LEXER::keywords )/sizeof( PCB_PLOT_PARAMS_LEXER::keywords[0] ) )
 

Detailed Description

Class PCB_PLOT_PARAMS_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology, based on keywords provided by file: /home/kicad/workspace/kicad-doxygen/common/pcb_plot_params.keywords.

Definition at line 83 of file pcb_plot_params_lexer.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_LEXER::PCB_PLOT_PARAMS_LEXER ( const std::string &  aSExpression,
const wxString &  aSource = wxEmptyString 
)
inline

Constructor ( const std::string&, const wxString& )

Parameters
aSExpressionis (utf8) text possibly from the clipboard that you want to parse.
aSourceis a description of the origin of aSExpression, such as a filename. If left empty, then _("clipboard") is used.

Definition at line 96 of file pcb_plot_params_lexer.h.

96  :
97  DSNLEXER( keywords, keyword_count, aSExpression, aSource )
98  {
99  }
static const unsigned keyword_count
static const KEYWORD keywords[]
Auto generated lexer keywords table and length:
DSNLEXER(const KEYWORD *aKeywordTable, unsigned aKeywordCount, FILE *aFile, const wxString &aFileName)
Constructor ( FILE*, const wxString& ) intializes a DSN lexer and prepares to read from aFile which i...
Definition: dsnlexer.cpp:76
PCB_PLOT_PARAMS_LEXER::PCB_PLOT_PARAMS_LEXER ( FILE *  aFile,
const wxString &  aFilename 
)
inline

Constructor ( FILE* ) takes aFile already opened for reading and aFilename as parameters.

The opened file is assumed to be positioned at the beginning of the file for purposes of accurate line number reporting in error messages. The FILE is closed by this instance when its destructor is called.

Parameters
aFileis a FILE already opened for reading.
aFilenameis the name of the opened file, needed for error reporting.

Definition at line 110 of file pcb_plot_params_lexer.h.

110  :
111  DSNLEXER( keywords, keyword_count, aFile, aFilename )
112  {
113  }
static const unsigned keyword_count
static const KEYWORD keywords[]
Auto generated lexer keywords table and length:
DSNLEXER(const KEYWORD *aKeywordTable, unsigned aKeywordCount, FILE *aFile, const wxString &aFileName)
Constructor ( FILE*, const wxString& ) intializes a DSN lexer and prepares to read from aFile which i...
Definition: dsnlexer.cpp:76
PCB_PLOT_PARAMS_LEXER::PCB_PLOT_PARAMS_LEXER ( LINE_READER aLineReader)
inline

Constructor ( LINE_READER* ) intializes a lexer and prepares to read from aLineReader which is assumed ready, and may be in use by other DSNLEXERs also.

No ownership is taken of aLineReader. This enables it to be used by other lexers also. The transition between grammars in such a case, must happen on a text line boundary, not within the same line of text.

Parameters
aLineReaderis any subclassed instance of LINE_READER, such as STRING_LINE_READER or FILE_LINE_READER. No ownership is taken of aLineReader.

Definition at line 126 of file pcb_plot_params_lexer.h.

126  :
127  DSNLEXER( keywords, keyword_count, aLineReader )
128  {
129  }
static const unsigned keyword_count
static const KEYWORD keywords[]
Auto generated lexer keywords table and length:
DSNLEXER(const KEYWORD *aKeywordTable, unsigned aKeywordCount, FILE *aFile, const wxString &aFileName)
Constructor ( FILE*, const wxString& ) intializes a DSN lexer and prepares to read from aFile which i...
Definition: dsnlexer.cpp:76

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 PCB_IO::Load(), DSNLEXER::NextTok(), SYMBOL_LIB_TABLE::Parse(), and FP_LIB_TABLE::Parse().

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 PCB_IO::Load(), DSNLEXER::NextTok(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), and KICAD_NETLIST_PARSER::parseComponent().

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 PCB_IO::Load(), DSNLEXER::NextTok(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), and KICAD_NETLIST_PARSER::parseComponent().

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 PCB_IO::Load(), DSNLEXER::NextTok(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), and KICAD_NETLIST_PARSER::parseComponent().

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.

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

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

Definition at line 182 of file pcb_plot_params_lexer.h.

References DSNLEXER::CurTok().

183  {
185  }
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)
throw (IO_ERROR
)
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 378 of file dsnlexer.cpp.

References Format(), and THROW_PARSE_ERROR.

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

379 {
380  wxString errText = wxString::Format(
381  _("%s is a duplicate"), GetTokenString( aTok ).GetData() );
383 }
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:335
void DSNLEXER::Expecting ( int  aTok)
throw (IO_ERROR
)
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 354 of file dsnlexer.cpp.

References Format(), GetChars(), and THROW_PARSE_ERROR.

Referenced by DSNLEXER::NeedLEFT(), DSNLEXER::NeedRIGHT(), DSNLEXER::NeedSYMBOL(), DSNLEXER::NeedSYMBOLorNUMBER(), SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), LIB_TABLE_ROW::Parse(), PCB_PLOT_PARAMS_PARSER::parseBool(), KICAD_NETLIST_PARSER::parseComponent(), PCB_PLOT_PARAMS_PARSER::parseDouble(), PAGE_LAYOUT_READER_PARSER::parseDouble(), PCB_PLOT_PARAMS_PARSER::parseInt(), PAGE_LAYOUT_READER_PARSER::parseInt(), and KICAD_NETLIST_PARSER::parseLibPartList().

355 {
356  wxString errText = wxString::Format(
357  _("Expecting '%s'"), GetChars( GetTokenString( aTok ) ) );
359 }
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:335
void DSNLEXER::Expecting ( const char *  aTokenList)
throw (IO_ERROR
)
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 362 of file dsnlexer.cpp.

References Format(), GetChars(), and THROW_PARSE_ERROR.

363 {
364  wxString errText = wxString::Format(
365  _("Expecting '%s'"), GetChars( wxString::FromUTF8( text ) ) );
367 }
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 261 of file dsnlexer.cpp.

References DSN_SYMBOL, and DSNLEXER::keyword_hash.

Referenced by DSNLEXER::NextTok().

262 {
263  KEYWORD_MAP::const_iterator it = keyword_hash.find( tok.c_str() );
264  if( it != keyword_hash.end() )
265  return it->second;
266 
267  return DSN_SYMBOL; // not a keyword, some arbitrary symbol.
268 }
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 SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), LIB_TABLE_ROW::Parse(), KICAD_NETLIST_PARSER::parseComponent(), 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
wxString DSNLEXER::GetTokenString ( int  aTok)
inherited

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

Definition at line 335 of file dsnlexer.cpp.

References DSNLEXER::GetTokenText().

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

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

Definition at line 316 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().

317 {
318  const char* ret;
319 
320  if( aTok < 0 )
321  {
322  return Syntax( aTok );
323  }
324  else if( (unsigned) aTok < keywordCount )
325  {
326  ret = keywords[aTok].name;
327  }
328  else
329  ret = "token too big";
330 
331  return ret;
332 }
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:272
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 345 of file dsnlexer.cpp.

References DSN_STRING, and DSN_SYMBOL.

Referenced by DSNLEXER::NeedSYMBOL(), and DSNLEXER::NeedSYMBOLorNUMBER().

346 {
347  // This is static and not inline to reduce code space.
348 
349  // if aTok is >= 0, then it is a coincidental match to a keyword.
350  return aTok==DSN_SYMBOL || aTok==DSN_STRING || aTok>=0;
351 }
void DSNLEXER::NeedLEFT ( )
throw (IO_ERROR
)
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 394 of file dsnlexer.cpp.

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

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

395 {
396  int tok = NextTok();
397  if( tok != DSN_LEFT )
398  Expecting( DSN_LEFT );
399 }
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:354
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:541
int DSNLEXER::NeedNUMBER ( const char *  aExpectation)
throw (IO_ERROR
)
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 428 of file dsnlexer.cpp.

References DSN_NUMBER, Format(), and THROW_PARSE_ERROR.

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

429 {
430  int tok = NextTok();
431  if( tok != DSN_NUMBER )
432  {
433  wxString errText = wxString::Format(
434  _("need a NUMBER for '%s'"), wxString::FromUTF8( aExpectation ).GetData() );
436  }
437  return tok;
438 }
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:541
int CurLineNumber()
Function CurLineNumber returns the current line number within my LINE_READER.
Definition: dsnlexer.h:507
void DSNLEXER::NeedRIGHT ( )
throw (IO_ERROR
)
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 402 of file dsnlexer.cpp.

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

Referenced by SYMBOL_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), LIB_TABLE_ROW::Parse(), KICAD_NETLIST_PARSER::Parse(), KICAD_NETLIST_PARSER::parseComponent(), KICAD_NETLIST_PARSER::parseLibPartList(), and KICAD_NETLIST_PARSER::parseNet().

403 {
404  int tok = NextTok();
405  if( tok != DSN_RIGHT )
406  Expecting( DSN_RIGHT );
407 }
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:354
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:541
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NeedSYMBOL ( )
throw (IO_ERROR
)
inline

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 160 of file pcb_plot_params_lexer.h.

References DSNLEXER::NeedSYMBOL().

Referenced by PCB_PLOT_PARAMS_PARSER::parseBool().

161  {
163  }
int NeedSYMBOL()
Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(...
Definition: dsnlexer.cpp:410
T
enum T contains all this lexer's tokens.
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NeedSYMBOLorNUMBER ( )
throw (IO_ERROR
)
inline

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 173 of file pcb_plot_params_lexer.h.

References DSNLEXER::NeedSYMBOLorNUMBER().

174  {
176  }
int NeedSYMBOLorNUMBER()
Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool I...
Definition: dsnlexer.cpp:419
T
enum T contains all this lexer's tokens.
PCBPLOTPARAMS_T::T PCB_PLOT_PARAMS_LEXER::NextTok ( )
throw (IO_ERROR
)
inline

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 147 of file pcb_plot_params_lexer.h.

References DSNLEXER::NextTok().

Referenced by PCB_PLOT_PARAMS_PARSER::parseDouble(), PCB_PLOT_PARAMS_PARSER::parseInt(), and PCB_PLOT_PARAMS_PARSER::skipCurrent().

148  {
150  }
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:541
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 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  limit = dummy;
228  }
229  }
230  return ret;
231 }
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 ( )
inline

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

Definition at line 191 of file pcb_plot_params_lexer.h.

References DSNLEXER::PrevTok().

192  {
194  }
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(), 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 ( )
throw (IO_ERROR
)
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 812 of file dsnlexer.cpp.

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

813 {
814  wxArrayString* ret = 0;
815  bool cmt_setting = SetCommentsAreTokens( true );
816  int tok = NextTok();
817 
818  if( tok == DSN_COMMENT )
819  {
820  ret = new wxArrayString();
821 
822  do
823  {
824  ret->Add( FromUTF8() );
825  }
826  while( ( tok = NextTok() ) == DSN_COMMENT );
827  }
828 
829  SetCommentsAreTokens( cmt_setting );
830 
831  return ret;
832 }
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:541
int DSNLEXER::readLine ( )
throw (IO_ERROR
)
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.

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.

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
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 272 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(), TokenName(), CMP_LIBRARY_LEXER::TokenName(), NETLIST_LEXER::TokenName(), PAGE_LAYOUT_READER_LEXER::TokenName(), PCB_LEXER::TokenName(), and SPECCTRA_LEXER::TokenName().

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

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

Definition at line 52 of file pcb_plot_params_keywords.cpp.

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

Referenced by getTokenName().

53 {
54  const char* ret;
55 
56  if( aTok < 0 )
57  ret = DSNLEXER::Syntax( aTok );
58  else if( (unsigned) aTok < keyword_count )
59  ret = keywords[aTok].name;
60  else
61  ret = "token too big";
62 
63  return ret;
64 }
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:272
void DSNLEXER::Unexpected ( int  aTok)
throw (IO_ERROR
)
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 370 of file dsnlexer.cpp.

References Format(), GetChars(), and THROW_PARSE_ERROR.

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

371 {
372  wxString errText = wxString::Format(
373  _("Unexpected '%s'"), GetChars( GetTokenString( aTok ) ) );
375 }
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:335
void DSNLEXER::Unexpected ( const char *  aToken)
throw (IO_ERROR
)
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 386 of file dsnlexer.cpp.

References Format(), GetChars(), and THROW_PARSE_ERROR.

387 {
388  wxString errText = wxString::Format(
389  _("Unexpected '%s'"), GetChars( wxString::FromUTF8( text ) ) );
391 }
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().

const unsigned PCB_PLOT_PARAMS_LEXER::keyword_count = unsigned( sizeof( PCB_PLOT_PARAMS_LEXER::keywords )/sizeof( PCB_PLOT_PARAMS_LEXER::keywords[0] ) )
staticprivate

Definition at line 87 of file pcb_plot_params_lexer.h.

Referenced by TokenName().

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 KEYWORD PCB_PLOT_PARAMS_LEXER::keywords
staticprivate

Auto generated lexer keywords table and length:

Definition at line 86 of file pcb_plot_params_lexer.h.

Referenced by TokenName().

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 PCB_PLOT_PARAMS_PARSER::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: