KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_kicad_sexpr_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-2023 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 <core/wx_stl_compat.h>
34#include <hashtables.h>
35#include <layer_ids.h> // PCB_LAYER_ID
36#include <pcb_lexer.h>
37#include <kiid.h>
38#include <math/box2.h>
39#include <string_any_map.h>
40
41#include <chrono>
42#include <unordered_map>
43
44
45class PCB_ARC;
46class BOARD;
47class BOARD_ITEM;
49class PAD;
52class PCB_SHAPE;
54class EDA_TEXT;
55class PCB_TEXT;
56class PCB_TRACK;
57class PCB_TABLE;
58class PCB_TABLECELL;
59class FOOTPRINT;
60class PCB_GROUP;
61class PCB_TARGET;
62class PCB_VIA;
63class ZONE;
64class FP_3DMODEL;
66struct LAYER;
69
70
75class PCB_IO_KICAD_SEXPR_PARSER : public PCB_LEXER
76{
77public:
79 std::function<bool( wxString, int, wxString, wxString )> aQueryUserCallback,
80 PROGRESS_REPORTER* aProgressReporter = nullptr, unsigned aLineCount = 0 ) :
81 PCB_LEXER( aReader ),
82 m_board( aAppendToMe ),
83 m_appendToExisting( aAppendToMe != nullptr ),
84 m_progressReporter( aProgressReporter ),
85 m_lastProgressTime( std::chrono::steady_clock::now() ),
86 m_lineCount( aLineCount ),
87 m_queryUserCallback( std::move( aQueryUserCallback ) )
88 {
89 init();
90 }
91
92 // ~PCB_IO_KICAD_SEXPR_PARSER() {}
93
95
102 FOOTPRINT* parseFOOTPRINT( wxArrayString* aInitialComments = nullptr );
103
108 {
109 return m_tooRecent;
110 }
111
116 wxString GetRequiredVersion();
117
122 bool IsValidBoardHeader();
123
124private:
125
126 // Group membership info refers to other Uuids in the file.
127 // We don't want to rely on group declarations being last in the file, so
128 // we store info about the group declarations here during parsing and then resolve
129 // them into BOARD_ITEM* after we've parsed the rest of the file.
131 {
132 virtual ~GROUP_INFO() = default; // Make polymorphic
133
135 wxString name;
136 bool locked;
138 std::vector<KIID> memberUuids;
139 };
140
142 {
144 wxString genType;
146 };
147
150 inline int getNetCode( int aNetCode )
151 {
152 if( ( aNetCode >= 0 ) && ( aNetCode < (int) m_netCodes.size() ) )
153 return m_netCodes[aNetCode];
154
155 return aNetCode;
156 }
157
166 void pushValueIntoMap( int aIndex, int aValue );
167
174 void init();
175
176 void checkpoint();
177
185 void createOldLayerMapping( std::unordered_map< std::string, std::string >& aMap );
186
191 void skipCurrent();
192
193 void parseHeader();
194 void parseGeneralSection();
195 void parsePAGE_INFO();
196 void parseTITLE_BLOCK();
197
198 void parseLayers();
199 void parseLayer( LAYER* aLayer );
200
201 void parseBoardStackup();
202
203 void parseSetup();
204 void parseDefaults( BOARD_DESIGN_SETTINGS& aSettings );
205 void parseDefaultTextDims( BOARD_DESIGN_SETTINGS& aSettings, int aLayer );
206 void parseNETINFO_ITEM();
207 void parseNETCLASS();
208
210
211 void parseTextBoxContent( PCB_TEXTBOX* aTextBox );
212
214 PCB_TEXT* parsePCB_TEXT( BOARD_ITEM* aParent );
215 void parsePCB_TEXT_effects( PCB_TEXT* aText );
221
222 // Parse a footprint, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERROR automatically.
223 FOOTPRINT* parseFOOTPRINT_unchecked( wxArrayString* aInitialComments = nullptr );
224
225 PAD* parsePAD( FOOTPRINT* aParent = nullptr );
226
227 // Parse only the (option ...) inside a pad description
228 bool parsePAD_option( PAD* aPad );
229
230 PCB_ARC* parseARC();
235 BOARD* parseBOARD();
236 void parseGROUP_members( GROUP_INFO& aGroupInfo );
237 void parseGROUP( BOARD_ITEM* aParent );
238 void parseGENERATOR( BOARD_ITEM* aParent );
239
240 // Parse a board, but do not replace PARSE_ERROR with FUTURE_FORMAT_ERROR automatically.
242
251 template<class T, class M>
252 T lookUpLayer( const M& aMap );
253
262
271
283
284 void parseXY( int* aX, int* aY );
285
286 void parseMargins( int& aLeft, int& aTop, int& aRight, int& aBottom );
287
288 std::pair<wxString, wxString> parseBoardProperty();
289
298
305 void parseEDA_TEXT( EDA_TEXT* aText );
306
314
316
325 int parseBoardUnits();
326
327 int parseBoardUnits( const char* aExpected );
328
329 inline int parseBoardUnits( PCB_KEYS_T::T aToken )
330 {
331 return parseBoardUnits( GetTokenText( aToken ) );
332 }
333
334 inline int parseInt()
335 {
336 return (int)strtol( CurText(), nullptr, 10 );
337 }
338
339 inline int parseInt( const char* aExpected )
340 {
341 NeedNUMBER( aExpected );
342 return parseInt();
343 }
344
345 inline long parseHex()
346 {
347 NextTok();
348 return strtol( CurText(), nullptr, 16 );
349 }
350
351 bool parseBool();
352
363 bool parseMaybeAbsentBool( bool aDefaultValue );
364
365 /*
366 * @return if m_appendToExisting, returns new KIID(), otherwise returns CurStr() as KIID.
367 */
369
374 void resolveGroups( BOARD_ITEM* aParent );
375
376 typedef std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP;
377 typedef std::unordered_map< std::string, LSET > LSET_MAP;
378 typedef std::unordered_map< wxString, KIID > KIID_MAP;
379
381 using TIMEOUT = std::chrono::milliseconds;
382
384 using CLOCK = std::chrono::steady_clock;
385
387 using TIME_PT = std::chrono::time_point<CLOCK>;
388
392 std::set<wxString> m_undefinedLayers;
393 std::vector<int> m_netCodes;
398
401
404
407 unsigned m_lineCount;
408
409 std::vector<GROUP_INFO> m_groupInfos;
410 std::vector<GENERATOR_INFO> m_generatorInfos;
411
412 std::function<bool( wxString aTitle, int aIcon, wxString aMsg, wxString aAction )> m_queryUserCallback;
413};
414
415
416#endif // _PCBNEW_PARSER_H_
Container for design settings for a BOARD object.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:282
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:83
Definition: kiid.h:49
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:576
Definition: pad.h:53
Abstract dimension API.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object...
wxString m_generatorVersion
Set to the generator version this board requires.
PCB_TABLECELL * parsePCB_TABLECELL(BOARD_ITEM *aParent)
std::unordered_map< std::string, PCB_LAYER_ID > LAYER_ID_MAP
std::vector< int > m_netCodes
net codes mapping for boards being loaded
void parseOutlinePoints(SHAPE_LINE_CHAIN &aPoly)
Parses possible outline points and stores them into aPoly.
std::set< wxString > m_undefinedLayers
set of layers not defined in layers section
PROGRESS_REPORTER * m_progressReporter
optional; may be nullptr
void createOldLayerMapping(std::unordered_map< std::string, std::string > &aMap)
Create a mapping from the (short-lived) bug where layer names were translated.
std::unordered_map< std::string, LSET > LSET_MAP
void parseEDA_TEXT(EDA_TEXT *aText)
Parse the common settings for any object derived from EDA_TEXT.
int parseInt(const char *aExpected)
bool m_tooRecent
true if version parses as later than supported
void parsePCB_TEXT_effects(PCB_TEXT *aText)
PCB_REFERENCE_IMAGE * parsePCB_REFERENCE_IMAGE(BOARD_ITEM *aParent)
LAYER_ID_MAP m_layerIndices
map layer name to it's index
void parseTextBoxContent(PCB_TEXTBOX *aTextBox)
FOOTPRINT * parseFOOTPRINT(wxArrayString *aInitialComments=nullptr)
void pushValueIntoMap(int aIndex, int aValue)
Add aValue value in netcode mapping (m_netCodes) at aIndex.
std::chrono::steady_clock CLOCK
The type of the time stamps.
void init()
Clear and re-establish m_layerMap with the default layer names.
void parseGROUP(BOARD_ITEM *aParent)
void skipCurrent()
Skip the current token level, i.e search for the RIGHT parenthesis which closes the current descripti...
void parseMargins(int &aLeft, int &aTop, int &aRight, int &aBottom)
PCB_LAYER_ID parseBoardItemLayer()
Parse the layer definition of a BOARD_ITEM object.
void parseGENERATOR(BOARD_ITEM *aParent)
T lookUpLayer(const M &aMap)
Parse the current token for the layer definition of a BOARD_ITEM object.
std::chrono::milliseconds TIMEOUT
The clock used for the timestamp (guaranteed to be monotonic).
LSET parseBoardItemLayersAsMask()
Parse the layers definition of a BOARD_ITEM object.
void resolveGroups(BOARD_ITEM *aParent)
Called after parsing a footprint definition or board to build the group membership lists.
void parseDefaultTextDims(BOARD_DESIGN_SETTINGS &aSettings, int aLayer)
std::vector< GROUP_INFO > m_groupInfos
ZONE * parseZONE(BOARD_ITEM_CONTAINER *aParent)
PCB_TABLE * parsePCB_TABLE(BOARD_ITEM *aParent)
std::vector< GENERATOR_INFO > m_generatorInfos
int parseBoardUnits(PCB_KEYS_T::T aToken)
PCB_TEXTBOX * parsePCB_TEXTBOX(BOARD_ITEM *aParent)
PCB_TEXT * parsePCB_TEXT(BOARD_ITEM *aParent)
std::chrono::time_point< CLOCK > TIME_PT
unsigned m_lineCount
for progress reporting
VECTOR2I parseXY()
Parse a coordinate pair (xy X Y) in board units (mm).
void parseTEARDROP_PARAMETERS(TEARDROP_PARAMETERS *tdParams)
int m_requiredVersion
set to the KiCad format version this board requires
PAD * parsePAD(FOOTPRINT *aParent=nullptr)
std::function< bool(wxString aTitle, int aIcon, wxString aMsg, wxString aAction)> m_queryUserCallback
FOOTPRINT * parseFOOTPRINT_unchecked(wxArrayString *aInitialComments=nullptr)
void parseRenderCache(EDA_TEXT *text)
Parse the render cache for any object derived from EDA_TEXT.
TIME_PT m_lastProgressTime
for progress reporting
void parseGROUP_members(GROUP_INFO &aGroupInfo)
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
bool IsValidBoardHeader()
Partially parse the input and check if it matches expected header.
std::pair< wxString, wxString > parseBoardProperty()
LSET_MAP m_layerMasks
map layer names to their masks
bool parseMaybeAbsentBool(bool aDefaultValue)
Parses a boolean flag inside a list that existed before boolean normalization.
int parseBoardUnits()
Parse the current token as an ASCII numeric string with possible leading whitespace into a double pre...
std::unordered_map< wxString, KIID > KIID_MAP
The type of progress bar timeout.
PCB_DIMENSION_BASE * parseDIMENSION(BOARD_ITEM *aParent)
PCB_IO_KICAD_SEXPR_PARSER(LINE_READER *aReader, BOARD *aAppendToMe, std::function< bool(wxString, int, wxString, wxString)> aQueryUserCallback, PROGRESS_REPORTER *aProgressReporter=nullptr, unsigned aLineCount=0)
bool m_appendToExisting
reading into an existing board; reset UUIDs
PCB_SHAPE * parsePCB_SHAPE(BOARD_ITEM *aParent)
void parseDefaults(BOARD_DESIGN_SETTINGS &aSettings)
wxString GetRequiredVersion()
Return a string representing the version of KiCad required to open this file.
Object to handle a bitmap image that can be inserted in a PCB.
A progress reporter interface for use in multi-threaded environments.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
A name/value tuple with unique names and wxAny values.
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
STL namespace.
Container to hold information pertinent to a layer of a BOARD.
Definition: board.h:163
Convert net code using the mapping table if available, otherwise returns unchanged net code if < 0 or...