KiCad PCB EDA Suite
pcb_parser.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 CERN
5  * Copyright (C) 2012-2016 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #ifndef _PCBNEW_PARSER_H_
31 #define _PCBNEW_PARSER_H_
32 
33 #include <pcb_lexer.h>
34 #include <hashtables.h>
35 #include <layers_id_colors_and_visibility.h> // PCB_LAYER_ID
36 #include <common.h> // KiROUND
37 #include <convert_to_biu.h> // IU_PER_MM
38 
39 #include <unordered_map>
40 
41 
42 class BOARD;
43 class BOARD_ITEM;
44 class D_PAD;
45 class DIMENSION;
46 class DRAWSEGMENT;
47 class EDA_TEXT;
48 class EDGE_MODULE;
49 class TEXTE_MODULE;
50 class TEXTE_PCB;
51 class TRACK;
52 class MODULE;
53 class PCB_TARGET;
54 class VIA;
55 class ZONE_CONTAINER;
56 class MODULE_3D_SETTINGS;
57 struct LAYER;
58 
59 
65 class PCB_PARSER : public PCB_LEXER
66 {
67  typedef std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP;
68  typedef std::unordered_map< std::string, LSET > LSET_MAP;
69 
71  LAYER_ID_MAP m_layerIndices;
72  LSET_MAP m_layerMasks;
73  std::vector<int> m_netCodes;
74  bool m_tooRecent;
76 
79  inline int getNetCode( int aNetCode )
80  {
81  if( ( aNetCode >= 0 ) && ( aNetCode < (int) m_netCodes.size() ) )
82  return m_netCodes[aNetCode];
83 
84  return aNetCode;
85  }
86 
94  void pushValueIntoMap( int aIndex, int aValue );
95 
102  void init();
103 
104  void parseHeader();
105  void parseGeneralSection();
106  void parsePAGE_INFO();
107  void parseTITLE_BLOCK();
108 
109  void parseLayers();
110  void parseLayer( LAYER* aLayer );
111 
112  void parseSetup();
113  void parseNETINFO_ITEM();
114  void parseNETCLASS();
115 
119 
124  MODULE* parseMODULE_unchecked( wxArrayString* aInitialComments = 0 );
127  D_PAD* parseD_PAD( MODULE* aParent = NULL );
128  // Parse only the (option ...) inside a pad description
129  bool parseD_PAD_option( D_PAD* aPad );
130  TRACK* parseTRACK();
131  VIA* parseVIA();
134  BOARD* parseBOARD();
135 
141 
142 
153  template<class T, class M>
154  T lookUpLayer( const M& aMap );
155 
165 
175 
187  wxPoint parseXY();
188 
189  void parseXY( int* aX, int* aY );
190 
198  void parseEDA_TEXT( EDA_TEXT* aText );
199 
201 
210  double parseDouble();
211 
212  inline double parseDouble( const char* aExpected )
213  {
214  NeedNUMBER( aExpected );
215  return parseDouble();
216  }
217 
218  inline double parseDouble( PCB_KEYS_T::T aToken )
219  {
220  return parseDouble( GetTokenText( aToken ) );
221  }
222 
223  inline int parseBoardUnits()
224  {
225  // There should be no major rounding issues here, since the values in
226  // the file are in mm and get converted to nano-meters.
227  // See test program tools/test-nm-biu-to-ascii-mm-round-tripping.cpp
228  // to confirm or experiment. Use a similar strategy in both places, here
229  // and in the test program. Make that program with:
230  // $ make test-nm-biu-to-ascii-mm-round-tripping
231  return KiROUND( parseDouble() * IU_PER_MM );
232  }
233 
234  inline int parseBoardUnits( const char* aExpected )
235  {
236  // Use here KiROUND, not KIROUND (see comments about them)
237  // when having a function as argument, because it will be called twice
238  // with KIROUND
239  return KiROUND( parseDouble( aExpected ) * IU_PER_MM );
240  }
241 
242  inline int parseBoardUnits( PCB_KEYS_T::T aToken )
243  {
244  return parseBoardUnits( GetTokenText( aToken ) );
245  }
246 
247  inline int parseInt()
248  {
249  return (int)strtol( CurText(), NULL, 10 );
250  }
251 
252  inline int parseInt( const char* aExpected )
253  {
254  NeedNUMBER( aExpected );
255  return parseInt();
256  }
257 
258  inline long parseHex()
259  {
260  NextTok();
261  return strtol( CurText(), NULL, 16 );
262  }
263 
264  bool parseBool();
265 
270  int parseVersion();
271 
272 public:
273 
274  PCB_PARSER( LINE_READER* aReader = NULL ) :
275  PCB_LEXER( aReader ),
276  m_board( 0 )
277  {
278  init();
279  }
280 
281  // ~PCB_PARSER() {}
282 
290  {
291  LINE_READER* ret = PopReader();
292  PushReader( aReader );
293  return ret;
294  }
295 
296  void SetBoard( BOARD* aBoard )
297  {
298  init();
299  m_board = aBoard;
300  }
301 
302  BOARD_ITEM* Parse();
309  MODULE* parseMODULE( wxArrayString* aInitialComments = 0 );
310 
314  bool IsTooRecent()
315  {
316  return m_tooRecent;
317  }
318 
323  wxString GetRequiredVersion();
324 
325 };
326 
327 
328 #endif // _PCBNEW_PARSER_H_
void parseHeader()
Definition: pcb_parser.cpp:567
int parseVersion()
Parse a format version tag like (version 20160417) return the version.
Definition: pcb_parser.cpp:169
PCB_KEYS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
Definition: pcb_lexer.h:308
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:78
int NeedNUMBER(const char *aExpectation)
Function NeedNUMBER calls NextTok() and then verifies that the token read is type DSN_NUMBER...
Definition: dsnlexer.cpp:427
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
void PushReader(LINE_READER *aLineReader)
Function PushReader manages a stack of LINE_READERs in order to handle nested file inclusion...
Definition: dsnlexer.cpp:192
LSET parseBoardItemLayersAsMask()
Function parseBoardItemLayersAsMask parses the layers definition of a BOARD_ITEM object.
Definition: pcb_parser.cpp:991
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:106
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
const char * GetTokenText(int aTok)
Function GetTokenText returns the C string representation of a DSN_T value.
Definition: dsnlexer.cpp:315
T
enum T contains all this lexer's tokens.
TRACK * parseTRACK()
VIA * parseVIA()
Class PCB_PARSER reads a Pcbnew s-expression formatted LINE_READER object and returns the appropriate...
Definition: pcb_parser.h:65
wxPoint parseXY()
Function parseXY parses a coordinate pair (xy X Y) in board units (mm).
Definition: pcb_parser.cpp:206
void parseNETINFO_ITEM()
BOARD * parseBOARD()
Definition: pcb_parser.cpp:461
bool parseD_PAD_option(D_PAD *aPad)
void parseEDA_TEXT(EDA_TEXT *aText)
Function parseEDA_TEXT parses the common settings for any object derived from EDA_TEXT.
Definition: pcb_parser.cpp:238
DIMENSION * parseDIMENSION()
bool m_tooRecent
true if version parses as later than supported
Definition: pcb_parser.h:74
void parseTITLE_BLOCK()
Definition: pcb_parser.cpp:705
int parseBoardUnits(PCB_KEYS_T::T aToken)
Definition: pcb_parser.h:242
int parseBoardUnits()
Definition: pcb_parser.h:223
void parseLayers()
Definition: pcb_parser.cpp:830
std::unordered_map< std::string, LSET > LSET_MAP
Definition: pcb_parser.h:68
std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP
Definition: pcb_parser.h:67
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels...
Definition: eda_text.h:114
void parsePAGE_INFO()
Definition: pcb_parser.cpp:649
Class PCB_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology...
Definition: pcb_lexer.h:244
bool parseBool()
Definition: pcb_parser.cpp:154
LINE_READER * PopReader()
Function PopReader deletes the top most LINE_READER from an internal stack of LINE_READERs and in the...
Definition: dsnlexer.cpp:204
PCB_LAYER_ID
A quick note on layer IDs:
wxString GetRequiredVersion()
Return a string representing the version of kicad required to open this file.
Definition: pcb_parser.cpp:182
Class LSET is a set of PCB_LAYER_IDs.
void SetBoard(BOARD *aBoard)
Definition: pcb_parser.h:296
PCB_PARSER(LINE_READER *aReader=NULL)
Definition: pcb_parser.h:274
MODULE * parseMODULE_unchecked(wxArrayString *aInitialComments=0)
Function parseMODULE_unchecked Parse a module, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERRO...
DRAWSEGMENT * parseDRAWSEGMENT()
PCB_TARGET * parsePCB_TARGET()
PCB_LAYER_ID parseBoardItemLayer()
Function parseBoardItemLayer parses the layer definition of a BOARD_ITEM object.
Definition: pcb_parser.cpp:976
TEXTE_PCB * parseTEXTE_PCB()
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:422
void parseNETCLASS()
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one...
Definition: pcb_parser.h:289
int parseInt(const char *aExpected)
Definition: pcb_parser.h:252
BOARD * parseBOARD_unchecked()
Function parseBOARD_unchecked Parse a module, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERROR...
Definition: pcb_parser.cpp:477
ZONE_CONTAINER * parseZONE_CONTAINER()
void parseLayer(LAYER *aLayer)
Definition: pcb_parser.cpp:788
int m_requiredVersion
set to the KiCad format version this board requires
Definition: pcb_parser.h:75
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:314
T
enum T contains all this lexer's tokens.
Definition: pcb_lexer.h:26
EDGE_MODULE * parseEDGE_MODULE()
Board layer functions and definitions.
Class LAYER holds information pertinent to a layer of a BOARD.
Definition: class_board.h:85
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
std::vector< int > m_netCodes
net codes mapping for boards being loaded
Definition: pcb_parser.h:73
int getNetCode(int aNetCode)
Converts net code using the mapping table if available, otherwise returns unchanged net code if < 0 o...
Definition: pcb_parser.h:79
BOARD * m_board
Definition: pcb_parser.h:70
void parseGeneralSection()
Definition: pcb_parser.cpp:603
void init()
Function init clears and re-establishes m_layerMap with the default layer names.
Definition: pcb_parser.cpp:56
void pushValueIntoMap(int aIndex, int aValue)
function pushValueIntoMap Add aValue value in netcode mapping (m_netCodes) at index aIndex ensure the...
Definition: pcb_parser.cpp:113
double parseDouble(PCB_KEYS_T::T aToken)
Definition: pcb_parser.h:218
The common library.
double parseDouble()
Function parseDouble parses the current token as an ASCII numeric string with possible leading whites...
Definition: pcb_parser.cpp:124
LAYER_ID_MAP m_layerIndices
map layer name to it's index
Definition: pcb_parser.h:71
TEXTE_MODULE * parseTEXTE_MODULE()
D_PAD * parseD_PAD(MODULE *aParent=NULL)
MODULE * parseMODULE(wxArrayString *aInitialComments=0)
Function parseMODULE.
long parseHex()
Definition: pcb_parser.h:258
int parseInt()
Definition: pcb_parser.h:247
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
LSET_MAP m_layerMasks
map layer names to their masks
Definition: pcb_parser.h:72
Class DIMENSION.
void parseSetup()
int parseBoardUnits(const char *aExpected)
Definition: pcb_parser.h:234
T lookUpLayer(const M &aMap)
Function lookUpLayer parses the current token for the layer definition of a BOARD_ITEM object...
Definition: pcb_parser.cpp:943
double parseDouble(const char *aExpected)
Definition: pcb_parser.h:212
MODULE_3D_SETTINGS * parse3DModel()
Definition: pcb_parser.cpp:335