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-2019 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;
46 class DIMENSION;
47 class DRAWSEGMENT;
48 class EDA_TEXT;
49 class EDGE_MODULE;
50 class TEXTE_MODULE;
51 class TEXTE_PCB;
52 class TRACK;
53 class MODULE;
54 class PCB_TARGET;
55 class VIA;
56 class ZONE_CONTAINER;
57 class MODULE_3D_SETTINGS;
58 struct LAYER;
59 
60 
66 class PCB_PARSER : public PCB_LEXER
67 {
68  typedef std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP;
69  typedef std::unordered_map< std::string, LSET > LSET_MAP;
70 
74  std::set<wxString> m_undefinedLayers;
75  std::vector<int> m_netCodes;
76  bool m_tooRecent;
78 
80 
83  inline int getNetCode( int aNetCode )
84  {
85  if( ( aNetCode >= 0 ) && ( aNetCode < (int) m_netCodes.size() ) )
86  return m_netCodes[aNetCode];
87 
88  return aNetCode;
89  }
90 
98  void pushValueIntoMap( int aIndex, int aValue );
99 
106  void init();
107 
114  void createOldLayerMapping( std::unordered_map< std::string, std::string >& aMap );
115 
121  void skipCurrent();
122 
123  void parseHeader();
124  void parseGeneralSection();
125  void parsePAGE_INFO();
126  void parseTITLE_BLOCK();
127 
128  void parseLayers();
129  void parseLayer( LAYER* aLayer );
130 
131  void parseBoardStackup();
132 
133  void parseSetup();
134  void parseDefaults( BOARD_DESIGN_SETTINGS& aSettings );
135  void parseDefaultTextDims( BOARD_DESIGN_SETTINGS& aSettings, int aLayer );
136  void parseNETINFO_ITEM();
137  void parseNETCLASS();
138 
143  DRAWSEGMENT* parseDRAWSEGMENT( bool aAllowCirclesZeroWidth = false );
146 
151  MODULE* parseMODULE_unchecked( wxArrayString* aInitialComments = 0 );
154  D_PAD* parseD_PAD( MODULE* aParent = NULL );
155  // Parse only the (option ...) inside a pad description
156  bool parseD_PAD_option( D_PAD* aPad );
157  TRACK* parseTRACK();
158  VIA* parseVIA();
161  BOARD* parseBOARD();
162 
168 
169 
180  template<class T, class M>
181  T lookUpLayer( const M& aMap );
182 
192 
202 
214  wxPoint parseXY();
215 
216  void parseXY( int* aX, int* aY );
217 
225  void parseEDA_TEXT( EDA_TEXT* aText );
226 
228 
237  double parseDouble();
238 
239  inline double parseDouble( const char* aExpected )
240  {
241  NeedNUMBER( aExpected );
242  return parseDouble();
243  }
244 
245  inline double parseDouble( PCB_KEYS_T::T aToken )
246  {
247  return parseDouble( GetTokenText( aToken ) );
248  }
249 
250  inline int parseBoardUnits()
251  {
252  // There should be no major rounding issues here, since the values in
253  // the file are in mm and get converted to nano-meters.
254  // See test program tools/test-nm-biu-to-ascii-mm-round-tripping.cpp
255  // to confirm or experiment. Use a similar strategy in both places, here
256  // and in the test program. Make that program with:
257  // $ make test-nm-biu-to-ascii-mm-round-tripping
258  auto retval = parseDouble() * IU_PER_MM;
259 
260  // N.B. we currently represent board units as integers. Any values that are
261  // larger or smaller than those board units represent undefined behavior for
262  // the system. We limit values to the largest that is visible on the screen
263  // This is the diagonal distance of the full screen ~1.5m
264  double int_limit = std::numeric_limits<int>::max() * 0.7071; // 0.7071 = roughly 1/sqrt(2)
265  return KiROUND( Clamp<double>( -int_limit, retval, int_limit ) );
266  }
267 
268  inline int parseBoardUnits( const char* aExpected )
269  {
270  auto retval = parseDouble( aExpected ) * IU_PER_MM;
271 
272  // N.B. we currently represent board units as integers. Any values that are
273  // larger or smaller than those board units represent undefined behavior for
274  // the system. We limit values to the largest that is visible on the screen
275  double int_limit = std::numeric_limits<int>::max() * 0.7071;
276 
277  // Use here KiROUND, not KIROUND (see comments about them)
278  // when having a function as argument, because it will be called twice
279  // with KIROUND
280  return KiROUND( Clamp<double>( -int_limit, retval, int_limit ) );
281  }
282 
283  inline int parseBoardUnits( PCB_KEYS_T::T aToken )
284  {
285  return parseBoardUnits( GetTokenText( aToken ) );
286  }
287 
288  inline int parseInt()
289  {
290  return (int)strtol( CurText(), NULL, 10 );
291  }
292 
293  inline int parseInt( const char* aExpected )
294  {
295  NeedNUMBER( aExpected );
296  return parseInt();
297  }
298 
299  inline long parseHex()
300  {
301  NextTok();
302  return strtol( CurText(), NULL, 16 );
303  }
304 
305  bool parseBool();
306 
311  int parseVersion();
312 
313 public:
314 
315  PCB_PARSER( LINE_READER* aReader = NULL ) :
316  PCB_LEXER( aReader ),
317  m_board( 0 )
318  {
319  init();
320  }
321 
322  // ~PCB_PARSER() {}
323 
331  {
332  LINE_READER* ret = PopReader();
333  PushReader( aReader );
334  return ret;
335  }
336 
337  void SetBoard( BOARD* aBoard )
338  {
339  init();
340  m_board = aBoard;
341  }
342 
343  BOARD_ITEM* Parse();
350  MODULE* parseMODULE( wxArrayString* aInitialComments = 0 );
351 
355  bool IsTooRecent()
356  {
357  return m_tooRecent;
358  }
359 
364  wxString GetRequiredVersion();
365 
366 };
367 
368 
369 #endif // _PCBNEW_PARSER_H_
void parseHeader()
Definition: pcb_parser.cpp:690
int parseVersion()
Parse a format version tag like (version 20160417) return the version.
Definition: pcb_parser.cpp:193
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:57
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
DRAWSEGMENT * parseDRAWSEGMENT(bool aAllowCirclesZeroWidth=false)
Read a DRAWSEGMENT description.
LSET parseBoardItemLayersAsMask()
Function parseBoardItemLayersAsMask parses the layers definition of a BOARD_ITEM object.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
TRACK * parseTRACK()
VIA * parseVIA()
Class PCB_PARSER reads a Pcbnew s-expression formatted LINE_READER object and returns the appropriate...
Definition: pcb_parser.h:66
void parseBoardStackup()
Definition: pcb_parser.cpp:977
wxPoint parseXY()
Function parseXY parses a coordinate pair (xy X Y) in board units (mm).
Definition: pcb_parser.cpp:230
void parseNETINFO_ITEM()
void createOldLayerMapping(std::unordered_map< std::string, std::string > &aMap)
Creates a mapping from the (short-lived) bug where layer names were translated TODO: Remove this once...
BOARD * parseBOARD()
Definition: pcb_parser.cpp:505
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:262
DIMENSION * parseDIMENSION()
bool m_tooRecent
true if version parses as later than supported
Definition: pcb_parser.h:76
void parseTITLE_BLOCK()
Definition: pcb_parser.cpp:828
int parseBoardUnits(PCB_KEYS_T::T aToken)
Definition: pcb_parser.h:283
int parseBoardUnits()
Definition: pcb_parser.h:250
void parseLayers()
std::unordered_map< std::string, LSET > LSET_MAP
Definition: pcb_parser.h:69
std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP
Definition: pcb_parser.h:68
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:109
void parsePAGE_INFO()
Definition: pcb_parser.cpp:772
bool parseBool()
Definition: pcb_parser.cpp:178
void skipCurrent()
Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes ...
Definition: pcb_parser.cpp:115
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:206
Class LSET is a set of PCB_LAYER_IDs.
void SetBoard(BOARD *aBoard)
Definition: pcb_parser.h:337
PCB_PARSER(LINE_READER *aReader=NULL)
Definition: pcb_parser.h:315
MODULE * parseMODULE_unchecked(wxArrayString *aInitialComments=0)
Function parseMODULE_unchecked Parse a module, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERRO...
PCB_TARGET * parsePCB_TARGET()
PCB_LAYER_ID parseBoardItemLayer()
Function parseBoardItemLayer parses the layer definition of a BOARD_ITEM object.
TEXTE_PCB * parseTEXTE_PCB()
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:466
void parseNETCLASS()
bool m_showLegacyZoneWarning
Definition: pcb_parser.h:79
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:330
void parseDefaults(BOARD_DESIGN_SETTINGS &aSettings)
int parseInt(const char *aExpected)
Definition: pcb_parser.h:293
BOARD * parseBOARD_unchecked()
Function parseBOARD_unchecked Parse a module, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERROR...
Definition: pcb_parser.cpp:521
ZONE_CONTAINER * parseZONE_CONTAINER()
void parseLayer(LAYER *aLayer)
Definition: pcb_parser.cpp:936
int m_requiredVersion
set to the KiCad format version this board requires
Definition: pcb_parser.h:77
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:355
void parseDefaultTextDims(BOARD_DESIGN_SETTINGS &aSettings, int aLayer)
EDGE_MODULE * parseEDGE_MODULE()
Board layer functions and definitions.
#define max(a, b)
Definition: auxiliary.h:86
Class LAYER holds information pertinent to a layer of a BOARD.
Definition: class_board.h:80
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
std::vector< int > m_netCodes
net codes mapping for boards being loaded
Definition: pcb_parser.h:75
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:83
BOARD * m_board
Definition: pcb_parser.h:71
void parseGeneralSection()
Definition: pcb_parser.cpp:726
void init()
Function init clears and re-establishes m_layerMap with the default layer names.
Definition: pcb_parser.cpp:57
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:136
double parseDouble(PCB_KEYS_T::T aToken)
Definition: pcb_parser.h:245
The common library.
double parseDouble()
Function parseDouble parses the current token as an ASCII numeric string with possible leading whites...
Definition: pcb_parser.cpp:148
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
LAYER_ID_MAP m_layerIndices
map layer name to it's index
Definition: pcb_parser.h:72
TEXTE_MODULE * parseTEXTE_MODULE()
D_PAD * parseD_PAD(MODULE *aParent=NULL)
MODULE * parseMODULE(wxArrayString *aInitialComments=0)
Function parseMODULE.
long parseHex()
Definition: pcb_parser.h:299
int parseInt()
Definition: pcb_parser.h:288
LSET_MAP m_layerMasks
map layer names to their masks
Definition: pcb_parser.h:73
Class DIMENSION.
void parseSetup()
int parseBoardUnits(const char *aExpected)
Definition: pcb_parser.h:268
T lookUpLayer(const M &aMap)
Function lookUpLayer parses the current token for the layer definition of a BOARD_ITEM object.
std::set< wxString > m_undefinedLayers
set of layers not defined in layers section
Definition: pcb_parser.h:74
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114
double parseDouble(const char *aExpected)
Definition: pcb_parser.h:239
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
MODULE_3D_SETTINGS * parse3DModel()
Definition: pcb_parser.cpp:374