KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_kicad_sexpr.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) 1992-2024 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
25#ifndef PCB_IO_KICAD_SEXPR_H_
26#define PCB_IO_KICAD_SEXPR_H_
27
28#include <pcb_io/pcb_io.h>
29#include <pcb_io/pcb_io_mgr.h>
30#include <ctl_flags.h>
31
32#include <richio.h>
33#include <string>
34#include <layer_ids.h>
35#include <lset.h>
36#include <boost/ptr_container/ptr_map.hpp>
37#include <wx_filename.h>
39
40class BOARD;
41class BOARD_ITEM;
42class FP_CACHE;
43class LSET;
45class NETINFO_MAPPING;
48class PCB_SHAPE;
50class PCB_TARGET;
51class PAD;
52class PCB_GROUP;
53class PCB_GENERATOR;
54class PCB_TRACK;
55class ZONE;
56class PCB_TEXT;
57class PCB_TEXTBOX;
58class PCB_TABLE;
59class EDA_TEXT;
62class PCB_IO_KICAD_SEXPR; // forward decl
63
65
66//#define SEXPR_BOARD_FILE_VERSION 3 // first s-expression format, used legacy cu stack
67//#define SEXPR_BOARD_FILE_VERSION 4 // reversed cu stack, changed Inner* to In* in reverse order
68// // went to 32 Cu layers from 16.
69//----------------- Start of 5.0 development -----------------
70//#define SEXPR_BOARD_FILE_VERSION 20160815 // differential pair settings per net class
71//#define SEXPR_BOARD_FILE_VERSION 20170123 // EDA_TEXT refactor, moved 'hide'
72//#define SEXPR_BOARD_FILE_VERSION 20170920 // long pad names and custom pad shape
73//#define SEXPR_BOARD_FILE_VERSION 20170922 // Keepout zones can exist on multiple layers
74//#define SEXPR_BOARD_FILE_VERSION 20171114 // Save 3D model offset in mm, instead of inches
75//#define SEXPR_BOARD_FILE_VERSION 20171125 // Locked/unlocked FP_TEXT
76//#define SEXPR_BOARD_FILE_VERSION 20171130 // 3D model offset written using "offset" parameter
77//----------------- Start of 6.0 development -----------------
78//#define SEXPR_BOARD_FILE_VERSION 20190331 // hatched zones and chamfered round rect pads
79//#define SEXPR_BOARD_FILE_VERSION 20190421 // curves in custom pads
80//#define SEXPR_BOARD_FILE_VERSION 20190516 // Remove segment count from zones
81//#define SEXPR_BOARD_FILE_VERSION 20190605 // Add layer defaults
82//#define SEXPR_BOARD_FILE_VERSION 20190905 // Add board physical stackup info in setup section
83//#define SEXPR_BOARD_FILE_VERSION 20190907 // Keepout areas in footprints
84//#define SEXPR_BOARD_FILE_VERSION 20191123 // pin function in pads
85//#define SEXPR_BOARD_FILE_VERSION 20200104 // pad property for fabrication
86//#define SEXPR_BOARD_FILE_VERSION 20200119 // arcs in tracks
87//#define SEXPR_BOARD_FILE_VERSION 20200512 // page -> paper
88//#define SEXPR_BOARD_FILE_VERSION 20200518 // save hole_to_hole_min
89//#define SEXPR_BOARD_FILE_VERSION 20200614 // Add support for fp_rects and gr_rects
90//#define SEXPR_BOARD_FILE_VERSION 20200625 // Multilayer zones, zone names, island controls
91//#define SEXPR_BOARD_FILE_VERSION 20200628 // remove visibility settings
92//#define SEXPR_BOARD_FILE_VERSION 20200724 // Add KIID to footprints
93//#define SEXPR_BOARD_FILE_VERSION 20200807 // Add zone hatch advanced settings
94//#define SEXPR_BOARD_FILE_VERSION 20200808 // Add properties to footprints
95//#define SEXPR_BOARD_FILE_VERSION 20200809 // Add REMOVE_UNUSED_LAYERS option to vias and THT pads
96//#define SEXPR_BOARD_FILE_VERSION 20200811 // Add groups
97//#define SEXPR_BOARD_FILE_VERSION 20200818 // Remove Status flag bitmap and setup counts
98//#define SEXPR_BOARD_FILE_VERSION 20200819 // Add board-level properties
99//#define SEXPR_BOARD_FILE_VERSION 20200825 // Remove host information
100//#define SEXPR_BOARD_FILE_VERSION 20200828 // Add new fabrication attributes
101//#define SEXPR_BOARD_FILE_VERSION 20200829 // Remove library name from exported footprints
102//#define SEXPR_BOARD_FILE_VERSION 20200909 // Change DIMENSION format
103//#define SEXPR_BOARD_FILE_VERSION 20200913 // Add leader dimension
104//#define SEXPR_BOARD_FILE_VERSION 20200916 // Add center dimension
105//#define SEXPR_BOARD_FILE_VERSION 20200921 // Add orthogonal dimension
106//#define SEXPR_BOARD_FILE_VERSION 20200922 // Add user name to layer definition.
107//#define SEXPR_BOARD_FILE_VERSION 20201002 // Add groups in footprints (for footprint editor).
108//#define SEXPR_BOARD_FILE_VERSION 20201114 // Add first-class support for filled shapes.
109//#define SEXPR_BOARD_FILE_VERSION 20201115 // module -> footprint and change fill syntax.
110//#define SEXPR_BOARD_FILE_VERSION 20201116 // Write version and generator string in footprint files.
111//#define SEXPR_BOARD_FILE_VERSION 20201220 // Add free via token
112//#define SEXPR_BOARD_FILE_VERSION 20210108 // Pad locking moved from footprint to pads
113//#define SEXPR_BOARD_FILE_VERSION 20210126 // Store pintype alongside pinfunction (in pads).
114//#define SEXPR_BOARD_FILE_VERSION 20210228 // Move global margins back to board file
115//#define SEXPR_BOARD_FILE_VERSION 20210424 // Correct locked flag syntax (remove parens).
116//#define SEXPR_BOARD_FILE_VERSION 20210606 // Change overbar syntax from `~...~` to `~{...}`.
117//#define SEXPR_BOARD_FILE_VERSION 20210623 // Add support for reading/writing arcs in polygons
118//#define SEXPR_BOARD_FILE_VERSION 20210722 // Reading/writing group locked flags
119//#define SEXPR_BOARD_FILE_VERSION 20210824 // Opacity in 3D colors
120//#define SEXPR_BOARD_FILE_VERSION 20210925 // Locked flag for fp_text
121//#define SEXPR_BOARD_FILE_VERSION 20211014 // Arc formatting
122//----------------- Start of 7.0 development -----------------
123//#define SEXPR_BOARD_FILE_VERSION 20211226 // Add radial dimension
124//#define SEXPR_BOARD_FILE_VERSION 20211227 // Add thermal relief spoke angle overrides
125//#define SEXPR_BOARD_FILE_VERSION 20211228 // Add allow_soldermask_bridges footprint attribute
126//#define SEXPR_BOARD_FILE_VERSION 20211229 // Stroke formatting
127//#define SEXPR_BOARD_FILE_VERSION 20211230 // Dimensions in footprints
128//#define SEXPR_BOARD_FILE_VERSION 20211231 // Private footprint layers
129//#define SEXPR_BOARD_FILE_VERSION 20211232 // Fonts
130//#define SEXPR_BOARD_FILE_VERSION 20220131 // Textboxes
131//#define SEXPR_BOARD_FILE_VERSION 20220211 // End support for V5 zone fill strategy
132//#define SEXPR_BOARD_FILE_VERSION 20220225 // Remove TEDIT
133//#define SEXPR_BOARD_FILE_VERSION 20220308 // Knockout text and Locked graphic text property saved
134//#define SEXPR_BOARD_FILE_VERSION 20220331 // Plot on all layers selection setting
135//#define SEXPR_BOARD_FILE_VERSION 20220417 // Automatic dimension precisions
136//#define SEXPR_BOARD_FILE_VERSION 20220427 // Exclude Edge.Cuts & Margin from fp private layers
137//#define SEXPR_BOARD_FILE_VERSION 20220609 // Add teardrop keywords to identify teardrop zones
138//#define SEXPR_BOARD_FILE_VERSION 20220621 // Add Image support
139//#define SEXPR_BOARD_FILE_VERSION 20220815 // Add allow-soldermask-bridges-in-FPs flag
140//#define SEXPR_BOARD_FILE_VERSION 20220818 // First-class storage for net-ties
141//#define SEXPR_BOARD_FILE_VERSION 20220914 // Number boxes for custom-shape pads
142//#define SEXPR_BOARD_FILE_VERSION 20221018 // Via & pad zone-layer-connections
143//----------------- Start of 8.0 development -----------------
144//#define SEXPR_BOARD_FILE_VERSION 20230410 // DNP attribute propagated from schematic to attr
145//#define SEXPR_BOARD_FILE_VERSION 20230517 // Teardrop parameters for pads and vias
146//#define SEXPR_BOARD_FILE_VERSION 20230620 // PCB Fields
147//#define SEXPR_BOARD_FILE_VERSION 20230730 // Connectivity for graphic shapes
148//#define SEXPR_BOARD_FILE_VERSION 20230825 // Textbox explicit border flag
149//#define SEXPR_BOARD_FILE_VERSION 20230906 // Multiple image type support in files
150//#define SEXPR_BOARD_FILE_VERSION 20230913 // Custom-shaped-pad spoke templates
151//#define SEXPR_BOARD_FILE_VERSION 20231007 // Generative objects
152//#define SEXPR_BOARD_FILE_VERSION 20231014 // V8 file format normalization
153//#define SEXPR_BOARD_FILE_VERSION 20231212 // Reference image locking/UUIDs, footprint boolean format
154//#define SEXPR_BOARD_FILE_VERSION 20231231 // Use 'uuid' rather than 'id' for generators and groups
155//#define SEXPR_BOARD_FILE_VERSION 20240108 // Convert teardrop parameters to explicit bools
156//----------------- Start of 9.0 development -----------------
157//#define SEXPR_BOARD_FILE_VERSION 20240201 // Use nullable properties for overrides
158//#define SEXPR_BOARD_FILE_VERSION 20240202 // Tables
159//#define SEXPR_BOARD_FILE_VERSION 20240225 // Rationalization of solder_paste_margin
160//#define SEXPR_BOARD_FILE_VERSION 20240609 // Add 'tenting' keyword
161//#define SEXPR_BOARD_FILE_VERSION 20240617 // Table angles
162//#define SEXPR_BOARD_FILE_VERSION 20240703 // User layer types
163#define SEXPR_BOARD_FILE_VERSION 20240706 // Embedded Files
164
165#define BOARD_FILE_HOST_VERSION 20200825
166#define LEGACY_ARC_FORMATTING 20210925
167#define LEGACY_NET_TIES 20220815
169#define FIRST_NORMALIZED_VERISON 20230924
170
171
172// common combinations of the above:
173
175#define CTL_FOR_CLIPBOARD (CTL_OMIT_INITIAL_COMMENTS) // (CTL_OMIT_NETS)
176
178#define CTL_FOR_LIBRARY \
179 ( CTL_OMIT_PAD_NETS | CTL_OMIT_UUIDS | CTL_OMIT_PATH | CTL_OMIT_AT | CTL_OMIT_LIBNAME )
180
183#define CTL_FOR_BOARD (CTL_OMIT_INITIAL_COMMENTS|CTL_OMIT_FOOTPRINT_VERSION)
184
194{
196 std::unique_ptr<FOOTPRINT> m_footprint;
197
198public:
199 FP_CACHE_ITEM( FOOTPRINT* aFootprint, const WX_FILENAME& aFileName );
200
201 const WX_FILENAME& GetFileName() const { return m_filename; }
202 void SetFilePath( const wxString& aFilePath ) { m_filename.SetPath( aFilePath ); }
203 const FOOTPRINT* GetFootprint() const { return m_footprint.get(); }
204};
205
206typedef boost::ptr_map<wxString, FP_CACHE_ITEM> FP_CACHE_FOOTPRINT_MAP;
207
209{
210 PCB_IO_KICAD_SEXPR* m_owner; // Plugin object that owns the cache.
211 wxFileName m_lib_path; // The path of the library.
212 wxString m_lib_raw_path; // For quick comparisons.
213 FP_CACHE_FOOTPRINT_MAP m_footprints; // Map of footprint filename to FOOTPRINT*.
214
215 bool m_cache_dirty; // Stored separately because it's expensive to check
216 // m_cache_timestamp against all the files.
217 long long m_cache_timestamp; // A hash of the timestamps for all the footprint
218 // files.
219
220public:
221 FP_CACHE( PCB_IO_KICAD_SEXPR* aOwner, const wxString& aLibraryPath );
222
223 wxString GetPath() const { return m_lib_raw_path; }
224
225 bool IsWritable() const { return m_lib_path.IsOk() && m_lib_path.IsDirWritable(); }
226
227 bool Exists() const { return m_lib_path.IsOk() && m_lib_path.DirExists(); }
228
230
231 // Most all functions in this class throw IO_ERROR exceptions. There are no
232 // error codes nor user interface calls from here, nor in any PLUGIN.
233 // Catch these exceptions higher up please.
234
240 void Save( FOOTPRINT* aFootprint = nullptr );
241
242 void Load();
243
244 void Remove( const wxString& aFootprintName );
245
251 static long long GetTimestamp( const wxString& aLibPath );
252
256 bool IsModified();
257
269 bool IsPath( const wxString& aPath ) const;
270
271 void SetPath( const wxString& aPath );
272};
273
274
281{
282public:
284 {
285 // Would have used wildcards_and_files_ext.cpp's KiCadPcbFileExtension,
286 // but to be pure, a plugin should not assume that it will always be linked
287 // with the core of the Pcbnew code. (Might someday be a DLL/DSO.) Besides,
288 // file extension policy should be controlled by the plugin.
289 return IO_BASE::IO_FILE_DESC( _HKI( "KiCad printed circuit board files" ), { "kicad_pcb" } );
290 }
291
293 {
294 return IO_BASE::IO_FILE_DESC( _HKI( "KiCad footprint file" ), { "kicad_mod" } );
295 }
296
298 {
299 return IO_BASE::IO_FILE_DESC( _HKI( "KiCad footprint files" ), {}, { "kicad_mod" }, false );
300 }
301
302 void SetQueryUserCallback( std::function<bool( wxString aTitle, int aIcon, wxString aMessage,
303 wxString aOKButtonTitle )> aCallback ) override
304 {
305 m_queryUserCallback = std::move( aCallback );
306 }
307
308 bool CanReadBoard( const wxString& aFileName ) const override;
309
310 void SaveBoard( const wxString& aFileName, BOARD* aBoard,
311 const STRING_UTF8_MAP* aProperties = nullptr ) override;
312
313 BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
314 const STRING_UTF8_MAP* aProperties = nullptr, PROJECT* aProject = nullptr ) override;
315
316 BOARD* DoLoad( LINE_READER& aReader, BOARD* aAppendToMe, const STRING_UTF8_MAP* aProperties,
317 PROGRESS_REPORTER* aProgressReporter, unsigned aLineCount );
318
319 void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
320 bool aBestEfforts, const STRING_UTF8_MAP* aProperties = nullptr ) override;
321
322 const FOOTPRINT* GetEnumeratedFootprint( const wxString& aLibraryPath,
323 const wxString& aFootprintName,
324 const STRING_UTF8_MAP* aProperties = nullptr ) override;
325
326 bool FootprintExists( const wxString& aLibraryPath, const wxString& aFootprintName,
327 const STRING_UTF8_MAP* aProperties = nullptr ) override;
328
329 FOOTPRINT* ImportFootprint( const wxString& aFootprintPath, wxString& aFootprintNameOut,
330 const STRING_UTF8_MAP* aProperties = nullptr ) override;
331
332 FOOTPRINT* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
333 bool aKeepUUID = false,
334 const STRING_UTF8_MAP* aProperties = nullptr ) override;
335
336 void FootprintSave( const wxString& aLibraryPath, const FOOTPRINT* aFootprint,
337 const STRING_UTF8_MAP* aProperties = nullptr ) override;
338
339 void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName,
340 const STRING_UTF8_MAP* aProperties = nullptr ) override;
341
342 long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override;
343
344 void CreateLibrary( const wxString& aLibraryPath,
345 const STRING_UTF8_MAP* aProperties = nullptr) override;
346
347 bool DeleteLibrary( const wxString& aLibraryPath,
348 const STRING_UTF8_MAP* aProperties = nullptr ) override;
349
350 bool IsLibraryWritable( const wxString& aLibraryPath ) override;
351
352 PCB_IO_KICAD_SEXPR( int aControlFlags = CTL_FOR_BOARD );
353
354 virtual ~PCB_IO_KICAD_SEXPR();
355
363 void Format( const BOARD_ITEM* aItem, int aNestLevel = 0 ) const;
364
365 std::string GetStringOutput( bool doClear )
366 {
367 std::string ret = m_sf.GetString();
368
369 if( doClear )
370 m_sf.Clear();
371
372 return ret;
373 }
374
375 void SetOutputFormatter( OUTPUTFORMATTER* aFormatter ) { m_out = aFormatter; }
376
377 BOARD_ITEM* Parse( const wxString& aClipboardSourceInput );
378
379protected:
380 void validateCache( const wxString& aLibraryPath, bool checkModified = true );
381
382 const FOOTPRINT* getFootprint( const wxString& aLibraryPath, const wxString& aFootprintName,
383 const STRING_UTF8_MAP* aProperties, bool checkModified );
384
385 void init( const STRING_UTF8_MAP* aProperties );
386
388 void formatSetup( const BOARD* aBoard, int aNestLevel = 0 ) const;
389
391 void formatGeneral( const BOARD* aBoard, int aNestLevel = 0 ) const;
392
394 void formatBoardLayers( const BOARD* aBoard, int aNestLevel = 0 ) const;
395
397 void formatNetInformation( const BOARD* aBoard, int aNestLevel = 0 ) const;
398
400 void formatProperties( const BOARD* aBoard, int aNestLevel = 0 ) const;
401
403 void formatHeader( const BOARD* aBoard, int aNestLevel = 0 ) const;
404
405 void formatTeardropParameters( const TEARDROP_PARAMETERS& tdParams, int aNestLevel = 0 ) const;
406
407private:
408 void format( const BOARD* aBoard, int aNestLevel = 0 ) const;
409
410 void format( const PCB_DIMENSION_BASE* aDimension, int aNestLevel = 0 ) const;
411
412 void format( const PCB_REFERENCE_IMAGE* aBitmap, int aNestLevel = 0 ) const;
413
414 void format( const PCB_GROUP* aGroup, int aNestLevel = 0 ) const;
415
416 void format( const PCB_SHAPE* aSegment, int aNestLevel = 0 ) const;
417
418 void format( const PCB_TARGET* aTarget, int aNestLevel = 0 ) const;
419
420 void format( const FOOTPRINT* aFootprint, int aNestLevel = 0 ) const;
421
422 void format( const PAD* aPad, int aNestLevel = 0 ) const;
423
424 void format( const PCB_TEXT* aText, int aNestLevel = 0 ) const;
425 void format( const PCB_TEXTBOX* aTextBox, int aNestLevel = 0 ) const;
426
427 void format( const PCB_TABLE* aTable, int aNestLevel = 0 ) const;
428
429 void format( const PCB_GENERATOR* aGenerator, int aNestLevel = 0 ) const;
430
431 void format( const PCB_TRACK* aTrack, int aNestLevel = 0 ) const;
432
433 void format( const ZONE* aZone, int aNestLevel = 0 ) const;
434
435 void formatPolyPts( const SHAPE_LINE_CHAIN& outline, int aNestLevel, bool aCompact,
436 const FOOTPRINT* aParentFP = nullptr ) const;
437
438 void formatRenderCache( const EDA_TEXT* aText, int aNestLevel ) const;
439
440 void formatLayer( PCB_LAYER_ID aLayer, bool aIsKnockout = false ) const;
441
442 void formatLayers( LSET aLayerMask, int aNestLevel = 0 ) const;
443
444 friend class FP_CACHE;
445
446protected:
447 wxString m_error;
448
450
452 wxString m_filename;
453
456 int m_ctl;
459
460 std::function<bool( wxString aTitle, int aIcon, wxString aMsg, wxString aAction )> m_queryUserCallback;
461};
462
463#endif // PCB_IO_KICAD_SEXPR_H_
Container for design settings for a BOARD object.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:79
Helper class for creating a footprint library cache.
std::unique_ptr< FOOTPRINT > m_footprint
WX_FILENAME m_filename
void SetFilePath(const wxString &aFilePath)
const FOOTPRINT * GetFootprint() const
const WX_FILENAME & GetFileName() const
static long long GetTimestamp(const wxString &aLibPath)
Generate a timestamp representing all source files in the cache (including the parent directory).
FP_CACHE_FOOTPRINT_MAP & GetFootprints()
bool Exists() const
void Save(FOOTPRINT *aFootprint=nullptr)
Save the footprint cache or a single footprint from it to disk.
PCB_IO_KICAD_SEXPR * m_owner
bool IsModified()
Return true if the cache is not up-to-date.
long long m_cache_timestamp
wxString m_lib_raw_path
void SetPath(const wxString &aPath)
wxFileName m_lib_path
bool IsPath(const wxString &aPath) const
Check if aPath is the same as the current cache path.
FP_CACHE_FOOTPRINT_MAP m_footprints
bool IsWritable() const
void Remove(const wxString &aFootprintName)
wxString GetPath() const
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: lset.h:35
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:322
Definition: pad.h:54
Abstract dimension API.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:52
Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object...
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PCB_IO can read the specified board file.
void formatRenderCache(const EDA_TEXT *aText, int aNestLevel) const
const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
Get the descriptor for the library container that this IO plugin operates on.
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
bool IsLibraryWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void SaveBoard(const wxString &aFileName, BOARD *aBoard, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be u...
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
const FOOTPRINT * GetEnumeratedFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr) override
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
void init(const STRING_UTF8_MAP *aProperties)
void formatLayers(LSET aLayerMask, int aNestLevel=0) const
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PC...
const IO_BASE::IO_FILE_DESC GetLibraryFileDesc() const override
Get the descriptor for the individual library elements that this IO plugin operates on.
const FOOTPRINT * getFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties, bool checkModified)
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties=nullptr, PROJECT *aProject=nullptr) override
Load information from some input file format that this PCB_IO implementation knows about into either ...
void formatSetup(const BOARD *aBoard, int aNestLevel=0) const
formats the board setup information
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
FP_CACHE * m_cache
Footprint library cache.
void formatPolyPts(const SHAPE_LINE_CHAIN &outline, int aNestLevel, bool aCompact, const FOOTPRINT *aParentFP=nullptr) const
void formatHeader(const BOARD *aBoard, int aNestLevel=0) const
writes everything that comes before the board_items, like settings and layers etc
void formatNetInformation(const BOARD *aBoard, int aNestLevel=0) const
formats the Nets and Netclasses
void formatProperties(const BOARD *aBoard, int aNestLevel=0) const
formats the Nets and Netclasses
void FootprintSave(const wxString &aLibraryPath, const FOOTPRINT *aFootprint, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aFootprint to an existing library located at aLibraryPath.
void formatGeneral(const BOARD *aBoard, int aNestLevel=0) const
formats the General section of the file
FOOTPRINT * ImportFootprint(const wxString &aFootprintPath, wxString &aFootprintNameOut, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.
void Format(const BOARD_ITEM *aItem, int aNestLevel=0) const
Output aItem to aFormatter in s-expression format.
void SetQueryUserCallback(std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aOKButtonTitle)> aCallback) override
BOARD * DoLoad(LINE_READER &aReader, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount)
bool FootprintExists(const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr) override
Check for the existence of a footprint.
wxString m_filename
for saves only, name is in m_reader for loads
void format(const BOARD *aBoard, int aNestLevel=0) const
std::function< bool(wxString aTitle, int aIcon, wxString aMsg, wxString aAction)> m_queryUserCallback
const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const override
Returns board file description for the PCB_IO.
BOARD_ITEM * Parse(const wxString &aClipboardSourceInput)
void formatBoardLayers(const BOARD *aBoard, int aNestLevel=0) const
formats the board layer information
void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete aFootprintName from the library at aLibraryPath.
STRING_FORMATTER m_sf
void formatTeardropParameters(const TEARDROP_PARAMETERS &tdParams, int aNestLevel=0) const
void formatLayer(PCB_LAYER_ID aLayer, bool aIsKnockout=false) const
void SetOutputFormatter(OUTPUTFORMATTER *aFormatter)
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
std::string GetStringOutput(bool doClear)
LINE_READER * m_reader
no ownership
wxString m_error
for throwing exceptions
void CreateLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Create a new empty library at aLibraryPath empty.
bool DeleteLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete an existing library and returns true, or if library does not exist returns false,...
A base class that BOARD loading and saving plugins should derive from.
Definition: pcb_io.h:72
Object to handle a bitmap image that can be inserted in a PCB.
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:433
const std::string & GetString()
Definition: richio.h:456
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:446
A name/value tuple with unique names and optional values.
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
A wrapper around a wxFileName which is much more performant with a subset of the API.
Definition: wx_filename.h:50
void SetPath(const wxString &aPath)
Definition: wx_filename.cpp:40
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
#define _HKI(x)
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
#define CTL_FOR_BOARD
The zero arg constructor when PCB_PLUGIN is used for PLUGIN::Load() and PLUGIN::Save()ing a BOARD fil...
boost::ptr_map< wxString, FP_CACHE_ITEM > FP_CACHE_FOOTPRINT_MAP
Container that describes file type info.
Definition: io_base.h:40