25#ifndef PCB_IO_KICAD_SEXPR_H_
26#define PCB_IO_KICAD_SEXPR_H_
36#include <boost/ptr_container/ptr_map.hpp>
171#define SEXPR_BOARD_FILE_VERSION 20241010
173#define BOARD_FILE_HOST_VERSION 20200825
174#define LEGACY_ARC_FORMATTING 20210925
175#define LEGACY_NET_TIES 20220815
177#define FIRST_NORMALIZED_VERISON 20230924
183#define CTL_FOR_CLIPBOARD (CTL_OMIT_INITIAL_COMMENTS)
186#define CTL_FOR_LIBRARY \
187 ( CTL_OMIT_PAD_NETS | CTL_OMIT_UUIDS | CTL_OMIT_PATH | CTL_OMIT_AT | CTL_OMIT_LIBNAME )
191#define CTL_FOR_BOARD (CTL_OMIT_INITIAL_COMMENTS|CTL_OMIT_FOOTPRINT_VERSION)
252 void Remove(
const wxString& aFootprintName );
259 static long long GetTimestamp(
const wxString& aLibPath );
277 bool IsPath(
const wxString& aPath )
const;
279 void SetPath(
const wxString& aPath );
311 wxString aOKButtonTitle )> aCallback )
override
316 bool CanReadBoard(
const wxString& aFileName )
const override;
319 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
322 const std::map<std::string, UTF8>* aProperties =
nullptr,
PROJECT* aProject =
nullptr )
override;
327 void FootprintEnumerate( wxArrayString& aFootprintNames,
const wxString& aLibraryPath,
328 bool aBestEfforts,
const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
331 const wxString& aFootprintName,
332 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
334 bool FootprintExists(
const wxString& aLibraryPath,
const wxString& aFootprintName,
335 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
338 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
341 bool aKeepUUID =
false,
342 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
345 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
347 void FootprintDelete(
const wxString& aLibraryPath,
const wxString& aFootprintName,
348 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
353 const std::map<std::string, UTF8>* aProperties =
nullptr)
override;
356 const std::map<std::string, UTF8>* aProperties =
nullptr )
override;
388 void validateCache(
const wxString& aLibraryPath,
bool checkModified =
true );
391 const std::map<std::string, UTF8>* aProperties,
bool checkModified );
393 void init(
const std::map<std::string, UTF8>* aProperties );
416 void format(
const BOARD* aBoard,
int aNestLevel = 0 )
const;
430 void format(
const PAD* aPad,
int aNestLevel = 0 )
const;
441 void format(
const ZONE* aZone,
int aNestLevel = 0 )
const;
444 const FOOTPRINT* aParentFP =
nullptr )
const;
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...
Information pertinent to a Pcbnew printed circuit board.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Helper class for creating a footprint library cache.
std::unique_ptr< FOOTPRINT > m_footprint
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()
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
void SetPath(const wxString &aPath)
bool IsPath(const wxString &aPath) const
Check if aPath is the same as the current cache path.
FP_CACHE_FOOTPRINT_MAP m_footprints
void Remove(const wxString &aFootprintName)
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
LSET is a set of PCB_LAYER_IDs.
A PADSTACK defines the characteristics of a single or multi-layer pad, in the IPC sense of the word.
A set of BOARD_ITEMs (i.e., without duplicates).
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.
BOARD * DoLoad(LINE_READER &aReader, BOARD *aAppendToMe, const std::map< std::string, UTF8 > *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount)
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.
FOOTPRINT * ImportFootprint(const wxString &aFootprintPath, wxString &aFootprintNameOut, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.
void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Delete aFootprintName from the library at aLibraryPath.
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.
bool DeleteLibrary(const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Delete an existing library and returns true, or if library does not exist returns false,...
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 std::map< std::string, UTF8 > *aProperties=nullptr) override
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
void CreateLibrary(const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Create a new empty library at aLibraryPath empty.
void formatLayers(LSET aLayerMask, int aNestLevel=0) const
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
const IO_BASE::IO_FILE_DESC GetLibraryFileDesc() const override
Get the descriptor for the individual library elements that this IO plugin operates on.
void formatSetup(const BOARD *aBoard, int aNestLevel=0) const
formats the board setup information
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
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PC...
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) override
Load information from some input file format that this PCB_IO implementation knows about into either ...
bool FootprintExists(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Check for the existence of a footprint.
void FootprintSave(const wxString &aLibraryPath, const FOOTPRINT *aFootprint, const std::map< std::string, UTF8 > *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
void SaveBoard(const wxString &aFileName, BOARD *aBoard, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be u...
void formatTenting(const PADSTACK &aPadstack) const
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
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 init(const std::map< std::string, UTF8 > *aProperties)
void formatBoardLayers(const BOARD *aBoard, int aNestLevel=0) const
formats the board layer information
void formatTeardropParameters(const TEARDROP_PARAMETERS &tdParams, int aNestLevel=0) const
void formatLayer(PCB_LAYER_ID aLayer, bool aIsKnockout=false) const
const FOOTPRINT * getFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties, bool checkModified)
void SetOutputFormatter(OUTPUTFORMATTER *aFormatter)
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
virtual ~PCB_IO_KICAD_SEXPR()
std::string GetStringOutput(bool doClear)
LINE_READER * m_reader
no ownership
wxString m_error
for throwing exceptions
A base class that BOARD loading and saving plugins should derive from.
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.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
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.
void SetPath(const wxString &aPath)
Handle a list of polygons defining a copper zone.
PCB_LAYER_ID
A quick note on layer IDs:
#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.