|
KiCad PCB EDA Suite
|
A PCB_IO derivation for saving and loading Pcbnew s-expression formatted files. More...
#include <pcb_io_kicad_sexpr.h>
Public Member Functions | |
| const IO_BASE::IO_FILE_DESC | GetBoardFileDesc () const override |
| Return board file description for the PCB_IO. | |
| const IO_BASE::IO_FILE_DESC | GetLibraryFileDesc () const override |
| Get the descriptor for the individual library elements that this IO plugin operates on. | |
| const IO_BASE::IO_FILE_DESC | GetLibraryDesc () const override |
| Get the descriptor for the library container that this IO plugin operates on. | |
| void | SetQueryUserCallback (std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aOKButtonTitle)> aCallback) override |
| bool | CanReadBoard (const wxString &aFileName) const override |
| 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 used to write a portion of aBoard to a special kind of export file. | |
| void | FormatBoardToFormatter (OUTPUTFORMATTER *aOut, BOARD *aBoard, const std::map< std::string, UTF8 > *aProperties=nullptr) |
| Serialize a BOARD to an OUTPUTFORMATTER without file I/O or Prettify. | |
| void | DoLoad (LINE_READER &aReader, BOARD &aBoard, bool aIsNewLoad, const std::map< std::string, UTF8 > *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount) |
| 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 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 in plugins that support it. | |
| bool | CachesEnumeratedFootprints () const override |
| Return true if GetEnumeratedFootprint() returns a borrowed pointer from an internal cache. | |
| void | LeakCacheAtExit () override |
| Have the destructor leave the library cache unfreed. | |
| bool | FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override |
| Check for the existence of a footprint. | |
| std::unique_ptr< 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. | |
| std::unique_ptr< 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 PCB_IO knows about. | |
| 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 | FootprintDelete (const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override |
| Delete aFootprintName from the library at aLibraryPath. | |
| void | ClearCachedFootprints (const wxString &aLibraryPath) override |
| Clear any cached footprint data for the given library path. | |
| long long | GetLibraryTimestamp (const wxString &aLibraryPath) const override |
| Generate a timestamp representing all the files in the library (including the library directory). | |
| void | CreateLibrary (const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override |
| Create a new empty library at aLibraryPath empty. | |
| 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, or throws an exception if library exists but is read only or cannot be deleted for some other reason. | |
| bool | IsLibraryWritable (const wxString &aLibraryPath) override |
| Return true if the library at aLibraryPath is writable. | |
| PCB_IO_KICAD_SEXPR (int aControlFlags=CTL_FOR_BOARD) | |
| virtual | ~PCB_IO_KICAD_SEXPR () |
| void | Format (const BOARD_ITEM *aItem) const |
| Output aItem to aFormatter in s-expression format. | |
| void | FormatFootprintLibFile (FOOTPRINT *aFootprint) const |
| Output aFootprint as a complete footprint library file. | |
| std::string | GetStringOutput (bool doClear) |
| void | SetOutputFormatter (OUTPUTFORMATTER *aFormatter) |
| BOARD_ITEM * | Parse (const wxString &aClipboardSourceInput) |
| bool | IsPCB_IO () const override |
| Work-around for lack of dynamic_cast across compile units on Mac. | |
| virtual std::vector< std::pair< wxString, wxString > > | EnumerateProjectBoards (const wxString &aFileName) const |
| Check if this PCB_IO can read the specified board file. | |
| virtual std::vector< IMPORT_PROJECT_DESC > | EnumerateProjectEntries (const wxString &aFileName) const |
| Return the KiCad projects a project container splits into, one per board entry and one per PCB or schematic no entry names. | |
| virtual bool | CanReadFootprint (const wxString &aFileName) const |
| Check if this PCB_IO can read a footprint from specified file or directory. | |
| virtual void | SetQueryUserCallback (std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)> aCallback) |
| Register a KIDIALOG callback for collecting info from the user. | |
| std::unique_ptr< BOARD > | LoadBoard (const wxString &aFileName, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) |
| Load information from some input file format that this PCB_IO implementation knows about into new BOARD. | |
| void | LoadAndAppendBoard (const wxString &aFileName, BOARD &aAppendToMe, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) |
| Same as LoadBoard(), but appends the loaded board to an existing board, which must already exist. | |
| virtual std::vector< FOOTPRINT * > | GetImportedCachedLibraryFootprints () |
| Return a container with the cached library footprints generated in the last call to Load. | |
| virtual wxString | GetImportedDesignRules () const |
| Return custom DRC rules generated while importing the most recent board. | |
| virtual void | GetLibraryOptions (std::map< std::string, UTF8 > *aListToAppendTo) const override |
| Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions. | |
| const wxString & | GetName () const |
| Return a brief hard coded name for this IO interface. | |
| virtual void | SetReporter (REPORTER *aReporter) |
| Set an optional reporter for warnings/errors. | |
| virtual void | SetProgressReporter (PROGRESS_REPORTER *aReporter) |
| Set an optional progress reporter. | |
| virtual bool | CanReadLibrary (const wxString &aFileName) const |
| Checks if this IO object can read the specified library file/directory. | |
| virtual void | CancelLoad () |
| Ask a library load running on this plugin to end early. | |
| virtual void | ResumeLoad () noexcept |
| Called after the loads that were cancelled have ended, to clear what CancelLoad() left behind. | |
| virtual void | StopBackgroundRefresh () |
| Stop and join any thread that reads other libraries through the library adapter. | |
| virtual bool | SupportsConfigurationDialog () const |
| virtual DIALOG_SHIM * | CreateConfigurationDialog (wxWindow *aParent, const wxString &aLibraryPath) |
| virtual void | Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) const |
| virtual void | AdvanceProgressPhase () |
| virtual void | RegisterCallback (LAYER_MAPPING_HANDLER aLayerMappingHandler) |
| Register a different handler to be called when mapping of input layers to KiCad layers occurs. | |
Protected Member Functions | |
| void | loadBoard (const wxString &aFileName, BOARD &aBoard, bool aIsNewLoad, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) override |
| Parse aFileName into aBoard. | |
| void | validateCache (const wxString &aLibraryPath, bool checkModified=true) |
| const FOOTPRINT * | getFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties, bool checkModified) |
| void | init (const std::map< std::string, UTF8 > *aProperties) |
| void | formatSetup (const BOARD *aBoard) const |
| formats the board setup information | |
| void | formatDrillSymbolProfile (const BOARD_DESIGN_SETTINGS &aSettings) const |
| void | formatGeneral (const BOARD *aBoard) const |
| formats the General section of the file | |
| void | formatBoardLayers (const BOARD *aBoard) const |
| formats the board layer information | |
| void | formatProperties (const BOARD *aBoard) const |
| formats the Nets and Netclasses | |
| void | formatVariants (const BOARD *aBoard) const |
| formats the board variant registry | |
| void | formatHeader (const BOARD *aBoard) const |
| writes everything that comes before the board_items, like settings and layers etc | |
| void | formatTeardropParameters (const TEARDROP_PARAMETERS &tdParams) const |
Protected Attributes | |
| wxString | m_error |
| for throwing exceptions | |
| FP_CACHE * | m_cache |
| Footprint library cache. | |
| bool | m_leakCacheAtExit = false |
| LINE_READER * | m_reader |
| no ownership | |
| wxString | m_filename |
| for saves only, name is in m_reader for loads | |
| STRING_FORMATTER | m_sf |
| OUTPUTFORMATTER * | m_out |
| output any Format()s to this, no ownership | |
| int | m_ctl |
| std::function< bool(wxString aTitle, int aIcon, wxString aMsg, wxString aAction)> | m_queryUserCallback |
| BOARD * | m_board |
| The board BOARD being worked on, no ownership here. | |
| const std::map< std::string, UTF8 > * | m_props |
| Properties passed via Save() or Load(), no ownership, may be NULL. | |
| wxString | m_name |
| Name of the IO loader. | |
| REPORTER * | m_reporter |
| Reporter to log errors/warnings to, may be nullptr. | |
| PROGRESS_REPORTER * | m_progressReporter |
| Progress reporter to track the progress of the operation, may be nullptr. | |
| LAYER_MAPPING_HANDLER | m_layer_mapping_handler |
| Callback to get layer mapping. | |
Private Member Functions | |
| void | format (const BOARD *aBoard) const |
| void | format (const PCB_DIMENSION_BASE *aDimension) const |
| void | format (const PCB_REFERENCE_IMAGE *aBitmap) const |
| void | format (const PCB_GROUP *aGroup) const |
| void | format (const PCB_CONSTRAINT *aConstraint) const |
| void | format (const PCB_SHAPE *aSegment) const |
| void | format (const PCB_TARGET *aTarget) const |
| void | format (const PCB_POINT *aPoint) const |
| void | format (const PCB_GRID_ITEM *aGridItem) const |
| void | format (const FOOTPRINT *aFootprint, bool aInLibFile=false) const |
| void | formatInitialComments (const FOOTPRINT *aFootprint) const |
| void | format (const PAD *aPad) const |
| void | format (const PCB_BARCODE *aBarcode) const |
| void | format (const PCB_TEXT *aText) const |
| void | format (const PCB_TEXTBOX *aTextBox) const |
| void | format (const PCB_TABLE *aTable) const |
| void | format (const PCB_GENERATED_TABLE *aTable) const |
| void | formatGeneratedTableExtras (const PCB_GENERATED_TABLE *aTable) const |
| What only one kind of generated table carries, written after the shared settings. | |
| void | format (const PCB_DRILL_MAP *aMap) const |
| void | formatTableData (const PCB_TABLE *aTable) const |
| Geometry and cells with no identity, so an enclosing form owns uuid/layer/locked. | |
| void | format (const PCB_GENERATOR *aGenerator) const |
| void | format (const PCB_TRACK *aTrack) const |
| void | format (const ZONE *aZone) const |
| void | format (const ZONE_LAYER_PROPERTIES &aZoneLayerProperties, int aNestLevel, PCB_LAYER_ID aLayer) const |
| void | formatPolyPts (const SHAPE_LINE_CHAIN &outline, const FOOTPRINT *aParentFP=nullptr) const |
| void | formatRenderCache (const EDA_TEXT *aText) const |
| void | formatLayer (PCB_LAYER_ID aLayer, bool aIsKnockout=false) const |
| void | formatLayers (LSET aLayerMask, bool aEnumerateLayers, bool aIsZone=false) const |
Friends | |
| class | FP_CACHE |
A PCB_IO derivation for saving and loading Pcbnew s-expression formatted files.
Definition at line 361 of file pcb_io_kicad_sexpr.h.
| PCB_IO_KICAD_SEXPR::PCB_IO_KICAD_SEXPR | ( | int | aControlFlags = CTL_FOR_BOARD | ) |
Definition at line 3794 of file pcb_io_kicad_sexpr.cpp.
References init(), m_cache, m_ctl, m_out, m_sf, and PCB_IO::PCB_IO().
Referenced by CLIPBOARD_IO::CLIPBOARD_IO().
|
virtual |
Definition at line 3804 of file pcb_io_kicad_sexpr.cpp.
References LSAN_IGNORE, m_cache, and m_leakCacheAtExit.
|
virtualinherited |
Definition at line 133 of file io_base.cpp.
References m_progressReporter, and THROW_IO_CANCELLED.
|
inlineoverridevirtual |
Return true if GetEnumeratedFootprint() returns a borrowed pointer from an internal cache.
When true, the caller must NOT delete the returned pointer. When false (the default), GetEnumeratedFootprint() allocates a new FOOTPRINT and the caller owns the memory.
Reimplemented from PCB_IO.
Definition at line 414 of file pcb_io_kicad_sexpr.h.
|
inlinevirtualinherited |
Ask a library load running on this plugin to end early.
Called from another thread while an asynchronous load is in flight, so it must return at once. Plugins with no wait worth cutting short ignore it.
Reimplemented in SCH_IO_DATABASE.
Definition at line 168 of file io_base.h.
Referenced by LIBRARY_MANAGER_ADAPTER::cancelLoadingPlugins().
|
overridevirtual |
Reimplemented from PCB_IO.
Definition at line 264 of file pcb_io_kicad_sexpr.cpp.
References PCB_IO::CanReadBoard(), PCB_IO_KICAD_SEXPR_PARSER::IsValidBoardHeader(), and m_queryUserCallback.
|
virtualinherited |
Check if this PCB_IO can read a footprint from specified file or directory.
If not overriden, extension check is used.
Reimplemented in PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYPC, PCB_IO_IPC2581, PCB_IO_KICAD_LEGACY, and PCB_IO_ODBPP.
Definition at line 56 of file pcb_io.cpp.
References IO_BASE::GetLibraryFileDesc(), and IO_BASE::IO_FILE_DESC::m_FileExtensions.
Referenced by PCB_IO_CADSTAR_ARCHIVE::CanReadFootprint(), and PCB_IO_KICAD_LEGACY::CanReadFootprint().
|
virtualinherited |
Checks if this IO object can read the specified library file/directory.
If not overridden, extension check is used.
Reimplemented in PCB_IO_ALLEGRO, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO_V3, PCB_IO_EASYPC, PCB_IO_IPC2581, PCB_IO_ODBPP, PCB_IO_PADS_BINARY, SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO_V3, SCH_IO_EASYPC, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, SCH_IO_ORCAD, SCH_IO_PADS, and SCH_IO_PCAD.
Definition at line 71 of file io_base.cpp.
References GetLibraryDesc(), IO_BASE::IO_FILE_DESC::m_ExtensionsInDir, IO_BASE::IO_FILE_DESC::m_FileExtensions, and IO_BASE::IO_FILE_DESC::m_IsFile.
Referenced by PCB_IO_ALLEGRO::CanReadLibrary(), PCB_IO_ALTIUM_DESIGNER::CanReadLibrary(), PCB_IO_CADSTAR_ARCHIVE::CanReadLibrary(), PCB_IO_EAGLE::CanReadLibrary(), PCB_IO_EASYEDAPRO_V3::CanReadLibrary(), PCB_IO_EASYPC::CanReadLibrary(), PCB_IO_PADS_BINARY::CanReadLibrary(), SCH_IO_ALTIUM::CanReadLibrary(), SCH_IO_CADSTAR_ARCHIVE::CanReadLibrary(), SCH_IO_EAGLE::CanReadLibrary(), SCH_IO_EASYEDAPRO_V3::CanReadLibrary(), SCH_IO_EASYPC::CanReadLibrary(), SCH_IO_KICAD_LEGACY::CanReadLibrary(), SCH_IO_KICAD_SEXPR::CanReadLibrary(), SCH_IO_ORCAD::CanReadLibrary(), and SCH_IO_PADS::CanReadLibrary().
|
overridevirtual |
Clear any cached footprint data for the given library path.
This is used to free memory after footprints have been loaded into another cache. The default implementation does nothing; plugins with caches should override.
| aLibraryPath | is the path of the library whose cache should be cleared. |
Reimplemented from PCB_IO.
Definition at line 4231 of file pcb_io_kicad_sexpr.cpp.
References m_cache.
|
inlinevirtualinherited |
| aLibraryPath | is the fully expanded path of the library to configure |
Reimplemented in SCH_IO_DATABASE.
|
overridevirtual |
Create a new empty library at aLibraryPath empty.
It is an error to attempt to create an existing library or to attempt to create on a "read only" location.
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several elements. |
| aProperties | is an associative array that can be used to tell the library create function anything special, because it can take any number of additional named tuning arguments that the IO is known to support. The caller continues to own this object (IO may not delete it), and IOs should expect it to be optionally NULL. |
| IO_ERROR | if there is a problem finding the library, or creating it. |
Reimplemented from IO_BASE.
Definition at line 4247 of file pcb_io_kicad_sexpr.cpp.
References _, FP_CACHE, init(), m_cache, and THROW_IO_ERRORF.
|
overridevirtual |
Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.
| aLibraryPath | is a locator for the "library", usually a directory or file which will contain several elements. |
| aProperties | is an associative array that can be used to tell the library delete implementation function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| IO_ERROR | if there is a problem deleting an existing library. |
Reimplemented from IO_BASE.
Definition at line 4261 of file pcb_io_kicad_sexpr.cpp.
References _, CollectFilesLoopSafe(), FILEEXT::KiCadFootprintFileExtension, m_cache, THROW_IO_ERRORF, and traceKicadPcbPlugin.
| void PCB_IO_KICAD_SEXPR::DoLoad | ( | LINE_READER & | aReader, |
| BOARD & | aBoard, | ||
| bool | aIsNewLoad, | ||
| const std::map< std::string, UTF8 > * | aProperties, | ||
| PROGRESS_REPORTER * | aProgressReporter, | ||
| unsigned | aLineCount ) |
Definition at line 3840 of file pcb_io_kicad_sexpr.cpp.
References _, PCB_IO_LOAD_PROPERTIES::APPEND_PRESERVE_DESTINATION_STACKUP, LOAD_INFO_REPORTER::GetInstance(), BOARD::GetItemSet(), BOARD::GetNetInfo(), PCB_IO_KICAD_SEXPR_PARSER::GetParseWarnings(), PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), init(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), LAYER_MAPPABLE_PLUGIN::m_layer_mapping_handler, m_queryUserCallback, PCB_IO_KICAD_SEXPR_PARSER::Parse(), BOARD::Remove(), LOAD_INFO_REPORTER::Report(), RPT_SEVERITY_WARNING, PCB_IO_KICAD_SEXPR_PARSER::SetLayerMappingHandler(), and THROW_PARSE_ERROR.
Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), and loadBoard().
|
inlinevirtualinherited |
Check if this PCB_IO can read the specified board file.
If not overriden, extension check is used. Return the PCB document identifiers and source names in a project container.
Plugins that do not support project containers return an empty list.
Reimplemented in PCB_IO_EASYEDAPRO, and PCB_IO_EASYEDAPRO_V3.
|
inlinevirtualinherited |
Return the KiCad projects a project container splits into, one per board entry and one per PCB or schematic no entry names.
Plugins that do not support project containers return an empty list.
Reimplemented in PCB_IO_EASYEDAPRO, and PCB_IO_EASYEDAPRO_V3.
|
overridevirtual |
Delete aFootprintName from the library at aLibraryPath.
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
| aFootprintName | is the name of a footprint to delete from the specified library. |
| aProperties | is an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| IO_ERROR | if there is a problem finding the footprint or the library, or deleting it. |
Reimplemented from PCB_IO.
Definition at line 4216 of file pcb_io_kicad_sexpr.cpp.
References _, init(), m_cache, THROW_IO_ERRORF, and validateCache().
Referenced by PCBNEW_JOBS_HANDLER::runFpLibMerge().
|
overridevirtual |
Return a list of footprint names contained within the library at aLibraryPath.
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
| aProperties | is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| aFootprintNames | is the array of available footprint names inside a library. |
| aBestEfforts | if true, don't throw on errors, just return an empty list. |
| IO_ERROR | if the library cannot be found, or footprint cannot be loaded. |
Reimplemented from PCB_IO.
Definition at line 3966 of file pcb_io_kicad_sexpr.cpp.
References _, init(), m_cache, THROW_IO_ERROR, THROW_IO_ERRORF, validateCache(), and IO_ERROR::What().
Referenced by KICAD_DIFF::FP_LIB_DIFFER::LoadLibrary(), and PCBNEW_JOBS_HANDLER::runFpLibMerge().
|
overridevirtual |
Check for the existence of a footprint.
Reimplemented from PCB_IO.
Definition at line 4031 of file pcb_io_kicad_sexpr.cpp.
References FILEEXT::KiCadFootprintFileExtension.
Referenced by PCBNEW_JOBS_HANDLER::runFpLibMerge().
|
overridevirtual |
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
| aFootprintName | is the name of the footprint to load. |
| aProperties | is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| aKeepUUID | = true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor. Make sense only in kicad_plugin |
| IO_ERROR | if the library cannot be found or read. No exception is thrown in the case where aFootprintName cannot be found. |
Reimplemented from PCB_IO.
Definition at line 4075 of file pcb_io_kicad_sexpr.cpp.
References FOOTPRINT::Clone(), copy, FOOTPRINT::Duplicate(), getFootprint(), and IGNORE_PARENT_GROUP.
Referenced by KICAD_DIFF::FP_LIB_DIFFER::LoadLibrary(), and KI_TEST::ReadFootprintFromFile().
|
overridevirtual |
Write aFootprint to an existing library located at aLibraryPath.
If a footprint by the same name already exists, it is replaced.
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
| aFootprint | is what to store in the library. The caller continues to own the footprint after this call. |
| aProperties | is an associative array that can be used to tell the saver how to save the footprint, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| IO_ERROR | if there is a problem saving. |
Reimplemented from PCB_IO.
Definition at line 4101 of file pcb_io_kicad_sexpr.cpp.
References _, ANGLE_0, FOOTPRINT::ClearAllNets(), FOOTPRINT::Clone(), CTL_FOR_LIBRARY, F_Cu, FOOTPRINT::Flip(), FOOTPRINT::GetFPID(), FOOTPRINT::GetLayer(), FOOTPRINT::GetPosition(), LIB_ID::GetUniStringLibItemName(), init(), FILEEXT::KiCadFootprintFileExtension, Kiface(), KIFACE_BASE::KifaceSettings(), m_cache, m_ctl, PCBNEW_SETTINGS::m_FlipDirection, Pgm(), ReplaceIllegalFileNameChars(), WX_FILENAME::ResolvePossibleSymlinks(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), THROW_IO_ERRORF, TOP_BOTTOM, traceKicadPcbPlugin, and validateCache().
Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runFpLibMerge().
| void PCB_IO_KICAD_SEXPR::Format | ( | const BOARD_ITEM * | aItem | ) | const |
Output aItem to aFormatter in s-expression format.
| aItem | A pointer the an BOARD_ITEM object to format. |
| IO_ERROR | on write error. |
Definition at line 375 of file pcb_io_kicad_sexpr.cpp.
References format(), KIGFX::VIEW_ITEM::GetClass(), PCB_ARC_T, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DRILL_CHART_T, PCB_DRILL_MAP_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GRID_ITEM_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_STACKUP_TABLE_T, PCB_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and EDA_ITEM::Type().
Referenced by BOOST_AUTO_TEST_CASE(), format(), format(), format(), FormatBoardToFormatter(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), CLIPBOARD_IO::SaveBoard(), and CLIPBOARD_IO::SaveSelection().
|
private |
Definition at line 909 of file pcb_io_kicad_sexpr.cpp.
References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::ClearEmbeddedFiles(), BOARD::Constraints(), CTL_FOR_BOARD, BOARD::Drawings(), EMBEDDED_FILES::EmbeddedFileMap(), BOARD::Footprints(), Format(), formatHeader(), BOARD::Generators(), EMBEDDED_FILES::GetAreFontsEmbedded(), BOARD::GetEmbeddedFiles(), FOOTPRINT::GetEmbeddedFiles(), BOARD::GetNetInfo(), NETINFO_ITEM::GetNetname(), group, BOARD::Groups(), info, EMBEDDED_FILES::IsEmpty(), kv, m_ctl, m_out, name, BOARD::Points(), BOARD::Tracks(), ValueStringCompare(), EMBEDDED_FILES::WriteEmbeddedFiles(), and BOARD::Zones().
Referenced by Format(), format(), format(), format(), FormatFootprintLibFile(), formatSetup(), and formatTableData().
|
private |
| aInLibFile | leaves the initial comments and version to the enclosing library file. |
Definition at line 1468 of file pcb_io_kicad_sexpr.cpp.
References KIGFX::COLOR4D::a, FOOTPRINT::AllowMissingCourtyard(), FOOTPRINT::AllowSolderMaskBridges(), KIID_PATH::AsString(), KIGFX::COLOR4D::b, FOOTPRINT::Bodies(), FOOTPRINT::Constraints(), CTL_FOR_BOARD, CTL_OMIT_AT, CTL_OMIT_FOOTPRINT_VERSION, CTL_OMIT_LIBNAME, CTL_OMIT_PATH, CTL_OMIT_UUIDS, EXPAND_INNER_LAYERS, LIB_ID::Format(), Format(), format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), FormatDouble2Str(), formatInitialComments(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_EXCLUDE_FROM_SIM, FP_SMD, FP_THROUGH_HOLE, KIGFX::COLOR4D::g, JUMPER_GROUP_SET::GetAll(), EMBEDDED_FILES::GetAreFontsEmbedded(), FOOTPRINT::GetAttributes(), COMPONENT_CLASS::GetConstituentClasses(), FOOTPRINT::GetDuplicatePadNumbersAreJumpers(), FOOTPRINT::GetEmbeddedFiles(), FOOTPRINT::GetField(), FOOTPRINT::GetFields(), FOOTPRINT::GetFilters(), FOOTPRINT::GetFPID(), FOOTPRINT::GetHeight(), FOOTPRINT::GetKeywords(), FOOTPRINT::GetLayer(), FOOTPRINT::GetLibDescription(), LIB_ID::GetLibItemName(), FOOTPRINT::GetLocalClearance(), FOOTPRINT::GetLocalSolderMaskMargin(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), FOOTPRINT::GetLocalZoneConnection(), GetMajorMinorVersion(), FOOTPRINT::GetNetTiePadGroups(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPath(), FOOTPRINT::GetPosition(), FOOTPRINT::GetPrivateLayers(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), FOOTPRINT::GetSheetfile(), FOOTPRINT::GetSheetname(), FOOTPRINT::GetStackupLayers(), FOOTPRINT::GetStackupMode(), FOOTPRINT::GetStaticComponentClass(), EDA_TEXT::GetText(), FOOTPRINT::GetTransform(), FOOTPRINT::GetUnitInfo(), FOOTPRINT::GetVariants(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), INHERITED, FOOTPRINT::IsDNP(), EMBEDDED_FILES::IsEmpty(), JUMPER_GROUP_SET::IsEmpty(), FOOTPRINT::IsExcludedFromBOM(), FOOTPRINT::IsExcludedFromPosFiles(), FOOTPRINT::IsExcludedFromSim(), BOARD_ITEM::IsLocked(), FOOTPRINT::IsNetTie(), FOOTPRINT::IsPlaced(), FOOTPRINT::JumperPadGroups(), EXTRUDED_3D_BODY::m_color, m_ctl, EXTRUDED_3D_BODY::m_height, EXTRUDED_3D_BODY::m_layer, EXTRUDED_3D_BODY::m_material, EXTRUDED_3D_BODY::m_offset, m_out, EXTRUDED_3D_BODY::m_rotation, EXTRUDED_3D_BODY::m_scale, EXTRUDED_3D_BODY::m_show, EXTRUDED_3D_BODY::m_standoff, EDA_ITEM::m_Uuid, FOOTPRINT::Models(), LSET::Name(), pad, FOOTPRINT::Pads(), FOOTPRINT::Points(), KIGFX::COLOR4D::r, FOOTPRINT::Reference(), LSET::Seq(), SEXPR_BOARD_FILE_VERSION, UNDEFINED_LAYER, UNSELECTED_LAYER, KIGFX::COLOR4D::UNSPECIFIED, FOOTPRINT::Value(), EMBEDDED_FILES::WriteEmbeddedFiles(), VECTOR3< T >::x, VECTOR3< T >::y, VECTOR3< T >::z, and FOOTPRINT::Zones().
|
private |
Definition at line 1973 of file pcb_io_kicad_sexpr.cpp.
References _, ANGLE_45, ANGLE_90, ARC, B_Cu, PADSTACK::BackOuterLayers(), PADSTACK::BackPostMachining(), BEZIER, BGA, CASTELLATED, CHAMFERED_RECT, CIRCLE, PADSTACK::Clearance(), CONN, CONVEXHULL, COUNTERBORE, CTL_OMIT_PAD_NETS, LSET::CuStack(), CUSTOM, PADSTACK::DefaultThermalSpokeAngleForShape(), delta, PADSTACK::DRILL_PROPS::end, F_Cu, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, PADSTACK::ForEachUniqueLayer(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), FormatDouble2Str(), formatInternalUnits(), formatLayers(), KICAD_FORMAT::FormatOptBool(), formatPolyPts(), formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), PADSTACK::FRONT_INNER_BACK, PADSTACK::FrontOuterLayers(), PADSTACK::FrontPostMachining(), PAD::GetAnchorPadShape(), PAD::GetAttribute(), BOARD_ITEM::GetBoard(), PAD::GetChamferPositions(), PAD::GetChamferRectRatio(), BOARD::GetCopperLayerCount(), PAD::GetCustomShapeInZoneOpt(), PAD::GetDelta(), PAD::GetDrillShape(), PAD::GetDrillSize(), BOARD::GetEnabledLayers(), BOARD_ITEM::GetFPRelativePosition(), PAD::GetKeepTopBottom(), PAD::GetLayerSet(), PAD::GetLocalClearance(), PAD::GetLocalSolderMaskMargin(), PAD::GetLocalSolderPasteMargin(), PAD::GetLocalSolderPasteMarginRatio(), PAD::GetLocalThermalGapOverride(), PAD::GetLocalThermalSpokeWidthOverride(), PAD::GetLocalZoneConnection(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), PAD::GetNumber(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPadToDieDelay(), PAD::GetPadToDieLength(), BOARD_ITEM::GetParentFootprint(), PAD::GetPinFunction(), PAD::GetPinType(), PAD::GetPrimitives(), PAD::GetProperty(), PAD::GetRemoveUnconnected(), PAD::GetRoundRectRadiusRatio(), PAD::GetShape(), PAD::GetSimElectricalType(), BOARD_CONNECTED_ITEM::GetTeardropParams(), PAD::GetThermalSpokeAngle(), PAD::GetZoneLayerOverride(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, PADSTACK::HasExplicitDefinitionForLayer(), HEATSINK, INHERITED, PADSTACK::INNER_LAYERS, isDefaultTeardropParameters(), EDA_ANGLE::IsZero(), m_ctl, m_out, EDA_ITEM::m_Uuid, MAX_CU_LAYERS, MECHANICAL, PADSTACK::Mode(), LSET::Name(), NON_COMPONENT, NONE, PADSTACK::NORMAL, NOT_POST_MACHINED, NPTH, OBLONG, PADSTACK::Offset(), SHAPE_POLY_SET::Outline(), OVAL, PAD::Padstack(), POLY, PRESSFIT, PTH, RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, RECTANGLE, ROUNDRECT, PADSTACK::SecondaryDrill(), SEGMENT, SINK, PADSTACK::Size(), PADSTACK::DRILL_PROPS::size, SMD, SOURCE, PADSTACK::DRILL_PROPS::start, PADSTACK::TertiaryDrill(), TESTPOINT, PADSTACK::ThermalGap(), PADSTACK::ThermalSpokeAngle(), PADSTACK::ThermalSpokeWidth(), THROW_IO_ERRORF, TIME, TRAPEZOID, unbakeSize(), unbakeSizeUniform(), UNDEFINED_LAYER, VECTOR2< T >::x, VECTOR2< T >::y, ZLO_FORCE_FLASHED, and PADSTACK::ZoneConnection().
|
private |
Definition at line 2553 of file pcb_io_kicad_sexpr.cpp.
References CODE_128, CODE_39, DATA_MATRIX, EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), PCB_BARCODE::GetAngle(), PCB_BARCODE::GetErrorCorrection(), PCB_BARCODE::GetHeight(), PCB_BARCODE::GetKind(), BOARD_ITEM::GetLayer(), PCB_BARCODE::GetMargin(), PCB_BARCODE::GetPosition(), PCB_BARCODE::GetShowText(), PCB_BARCODE::GetText(), PCB_BARCODE::GetTextSize(), PCB_BARCODE::GetWidth(), H, PCB_BARCODE::IsKnockout(), BOARD_ITEM::IsLocked(), L, M, m_out, EDA_ITEM::m_Uuid, MICRO_QR_CODE, Q, QR_CODE, VECTOR2< T >::x, and VECTOR2< T >::y.
|
private |
Definition at line 3054 of file pcb_io_kicad_sexpr.cpp.
References ConstraintAnchorToken(), ConstraintTypeToken(), ConstraintValueIsLength(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), FormatDouble2Str(), KICAD_FORMAT::FormatUuid(), PCB_CONSTRAINT::GetConstraintType(), PCB_CONSTRAINT::GetMembers(), PCB_CONSTRAINT::GetValue(), PCB_CONSTRAINT::HasValue(), PCB_CONSTRAINT::IsDriving(), m_out, EDA_ITEM::m_Uuid, pcbIUScale, and VERTEX.
|
private |
Definition at line 1068 of file pcb_io_kicad_sexpr.cpp.
References center, format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), PCB_DIMENSION_BASE::GetArrowDirection(), PCB_DIMENSION_BASE::GetArrowLength(), PCB_DIMENSION_BASE::GetEnd(), PCB_DIM_ALIGNED::GetExtensionHeight(), PCB_DIMENSION_BASE::GetExtensionOffset(), PCB_DIM_ALIGNED::GetHeight(), PCB_DIMENSION_BASE::GetKeepTextAligned(), BOARD_ITEM::GetLayer(), PCB_DIM_RADIAL::GetLeaderLength(), PCB_DIMENSION_BASE::GetLineThickness(), PCB_DIMENSION_BASE::GetOverrideText(), PCB_DIMENSION_BASE::GetOverrideTextEnabled(), PCB_DIMENSION_BASE::GetPrecision(), PCB_DIMENSION_BASE::GetPrefix(), PCB_DIMENSION_BASE::GetStart(), PCB_DIMENSION_BASE::GetSuffix(), PCB_DIMENSION_BASE::GetSuppressZeroes(), PCB_DIM_LEADER::GetTextBorder(), PCB_DIMENSION_BASE::GetTextPositionMode(), PCB_DIMENSION_BASE::GetUnitsFormat(), PCB_DIMENSION_BASE::GetUnitsMode(), INWARD, BOARD_ITEM::IsLocked(), m_out, EDA_ITEM::m_Uuid, ortho, OUTWARD, VECTOR2< T >::x, and VECTOR2< T >::y.
|
private |
Definition at line 2826 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatDrillSpan(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), PCB_DRILL_MAP::GetAllSpans(), PCB_DRILL_MAP::GetGuideCross(), BOARD_ITEM::GetLayer(), PCB_DRILL_MAP::GetOffset(), PCB_DRILL_MAP::GetOutlineSlots(), PCB_DRILL_MAP::GetSpan(), PCB_DRILL_MAP::GetSymbolSize(), BOARD_ITEM::IsLocked(), m_out, and EDA_ITEM::m_Uuid.
|
private |
Definition at line 2863 of file pcb_io_kicad_sexpr.cpp.
References PCB_GENERATED_TABLE::AllColumns(), GENERATED_TABLE_SCHEMA::DefaultPrecision(), GENERATED_TABLE_SCHEMA::DefaultUnits(), GENERATED_TABLE_SCHEMA::Find(), KICAD_FORMAT::FormatBool(), formatGeneratedTableExtras(), formatInternalUnits(), formatLayer(), formatTableData(), KICAD_FORMAT::FormatUuid(), GeneratedTableAlignToken(), GeneratedTableUnitsToken(), PCB_TABLE::GetClass(), BOARD_ITEM::GetLayer(), PCB_GENERATED_TABLE::GetPrecision(), PCB_GENERATED_TABLE::GetUnits(), BOARD_ITEM::IsLocked(), GENERATED_TABLE_COLUMN_DEF::m_Align, GENERATED_TABLE_COLUMN_DEF::m_Heading, m_out, EDA_ITEM::m_Uuid, PCB_DRILL_CHART_T, PCB_STACKUP_TABLE_T, PCB_GENERATED_TABLE::RowKeys(), PCB_GENERATED_TABLE::Schema(), GENERATED_TABLE_SCHEMA::Token(), and EDA_ITEM::Type().
|
private |
Definition at line 3107 of file pcb_io_kicad_sexpr.cpp.
References Format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatPolyPts(), KICAD_FORMAT::FormatUuid(), PCB_GENERATOR::GetGeneratorType(), EDA_GROUP::GetItems(), PCB_GENERATOR::GetLayer(), EDA_GROUP::GetName(), PCB_GENERATOR::GetProperties(), PCB_GENERATOR::GetTemplateItems(), BOARD_ITEM::IsLocked(), m_out, EDA_ITEM::m_Uuid, LSET::Name(), name, and TO_UTF8.
|
private |
Definition at line 1404 of file pcb_io_kicad_sexpr.cpp.
References PCB_GRID_ITEM::Affects(), PCB_GRID_AFFECTS::cursor, EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), KICAD_FORMAT::FormatUuid(), PCB_GRID_ITEM::GetAssignedPriority(), PCB_GRID_ITEM::GetExtent(), PCB_GRID_ITEM::GetGridItemType(), PCB_GRID_ITEM::GetOrientation(), PCB_GRID_ITEM::GetPhiExtent(), PCB_GRID_ITEM::GetPhiSpacing(), PCB_GRID_ITEM::GetPosition(), PCB_GRID_ITEM::GetRadiusExtent(), PCB_GRID_ITEM::GetRadiusSpacing(), PCB_GRID_ITEM::GetSpacing(), PCB_GRID_ITEM::GetTickInterval(), BOARD_ITEM::IsLocked(), EDA_ANGLE::IsZero(), m_out, EDA_ITEM::m_Uuid, PCB_GRID_AFFECTS::placement, POLAR, and PCB_GRID_AFFECTS::routing.
|
private |
Definition at line 3003 of file pcb_io_kicad_sexpr.cpp.
References UTF8::c_str(), LIB_ID::Format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), KICAD_FORMAT::FormatUuid(), EDA_GROUP::GetDesignBlockLibId(), EDA_GROUP::GetItems(), EDA_GROUP::GetName(), EDA_GROUP::HasDesignBlockLink(), BOARD_ITEM::IsLocked(), PCB_IO::m_board, m_out, and EDA_ITEM::m_Uuid.
|
private |
Definition at line 1374 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), BOARD_ITEM::GetLayer(), PCB_POINT::GetLibraryPosition(), PCB_POINT::GetSize(), m_out, and EDA_ITEM::m_Uuid.
|
private |
Definition at line 1335 of file pcb_io_kicad_sexpr.cpp.
References EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatStreamData(), KICAD_FORMAT::FormatUuid(), REFERENCE_IMAGE::GetImage(), BITMAP_BASE::GetImageData(), REFERENCE_IMAGE::GetImageScale(), BOARD_ITEM::GetLayer(), REFERENCE_IMAGE::GetOpacity(), REFERENCE_IMAGE::GetOrientation(), PCB_REFERENCE_IMAGE::GetPosition(), PCB_REFERENCE_IMAGE::GetReferenceImage(), image, BOARD_ITEM::IsLocked(), EDA_ANGLE::IsZero(), m_out, EDA_ITEM::m_Uuid, BITMAP_BASE::SaveImageData(), VECTOR2< T >::x, and VECTOR2< T >::y.
|
private |
Definition at line 1184 of file pcb_io_kicad_sexpr.cpp.
References ARC, BEZIER, CIRCLE, CROSS_HATCH, CTL_OMIT_PAD_NETS, ELLIPSE, ELLIPSE_ARC, FILLED_SHAPE, LINE_ENDING::Format(), STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), formatLayers(), formatPolyPts(), KICAD_FORMAT::FormatUuid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetCornerRadius(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetEndEnding(), EDA_SHAPE::GetFillMode(), PCB_SHAPE::GetLayer(), PCB_SHAPE::GetLayerSet(), PCB_SHAPE::GetLibraryArcMid(), PCB_SHAPE::GetLibraryCornerRadius(), PCB_SHAPE::GetLibraryEllipseCenter(), PCB_SHAPE::GetLibraryEllipseEndAngle(), PCB_SHAPE::GetLibraryEllipseMajorRadius(), PCB_SHAPE::GetLibraryEllipseMinorRadius(), PCB_SHAPE::GetLibraryEllipseRotation(), PCB_SHAPE::GetLibraryEllipseStartAngle(), PCB_SHAPE::GetLibraryEnd(), PCB_SHAPE::GetLibraryShape(), PCB_SHAPE::GetLibraryStart(), PCB_SHAPE::GetLocalSolderMaskMargin(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetStartEnding(), PCB_SHAPE::GetStroke(), STROKE_PARAMS::GetWidth(), PCB_SHAPE::HasSolderMask(), HATCH, IsExternalCopperLayer(), BOARD_ITEM::IsLocked(), EDA_SHAPE::IsPolyShapeValid(), m_ctl, m_out, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), pcbIUScale, POLY, RECTANGLE, REVERSE_HATCH, SEGMENT, STROKE_PARAMS::SetWidth(), EDA_SHAPE::SHAPE_T_asString(), unbakeLinear(), and UNIMPLEMENTED_FOR.
|
private |
Definition at line 2984 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatBool(), formatLayer(), formatTableData(), KICAD_FORMAT::FormatUuid(), BOARD_ITEM::GetLayer(), BOARD_ITEM::IsLocked(), m_out, and EDA_ITEM::m_Uuid.
|
private |
Definition at line 1387 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), BOARD_ITEM::GetLayer(), PCB_TARGET::GetPosition(), PCB_TARGET::GetShape(), PCB_TARGET::GetSize(), PCB_TARGET::GetWidth(), m_out, and EDA_ITEM::m_Uuid.
|
private |
Definition at line 2620 of file pcb_io_kicad_sexpr.cpp.
References CTL_OMIT_COLOR, CTL_OMIT_HYPERLINK, EDA_TEXT::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), formatRenderCache(), KICAD_FORMAT::FormatUuid(), EDA_TEXT::GetAttributes(), EDA_TEXT::GetFont(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParentFootprint(), EDA_TEXT::GetText(), PCB_TEXT::GetTextAngle(), PCB_TEXT::GetTextPos(), FOOTPRINT::GetTransform(), TRANSFORM_TRS::InverseApply(), EDA_TEXT::IsKeepUpright(), BOARD_ITEM::IsKnockout(), BOARD_ITEM::IsLocked(), KIFONT::FONT::IsOutline(), EDA_TEXT::IsVisible(), m_out, EDA_ITEM::m_Uuid, PCB_FIELD_T, pcbIUScale, EDA_TEXT::SetAttributes(), and EDA_ITEM::Type().
|
private |
Definition at line 2698 of file pcb_io_kicad_sexpr.cpp.
References STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), formatLayer(), formatPolyPts(), formatRenderCache(), KICAD_FORMAT::FormatUuid(), EDA_TEXT::GetFont(), PCB_SHAPE::GetLayer(), PCB_SHAPE::GetLibPoly(), PCB_SHAPE::GetLibraryEnd(), PCB_SHAPE::GetLibraryShape(), PCB_SHAPE::GetLibraryStart(), PCB_TEXTBOX::GetMarginBottom(), PCB_TEXTBOX::GetMarginLeft(), PCB_TEXTBOX::GetMarginRight(), PCB_TEXTBOX::GetMarginTop(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), PCB_SHAPE::GetStroke(), EDA_TEXT::GetText(), PCB_TEXTBOX::GetTextAngle(), PCB_TEXTBOX::IsBorderEnabled(), BOARD_ITEM::IsKnockout(), BOARD_ITEM::IsLocked(), KIFONT::FONT::IsOutline(), EDA_ANGLE::IsZero(), m_out, EDA_ITEM::m_Uuid, EDA_ANGLE::Normalize720(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PCB_TABLECELL_T, pcbIUScale, POLY, RECTANGLE, EDA_SHAPE::SHAPE_T_asString(), EDA_ITEM::Type(), and UNIMPLEMENTED_FOR.
|
private |
Definition at line 3242 of file pcb_io_kicad_sexpr.cpp.
References _, B_Cu, PADSTACK::BackOuterLayers(), BLIND, BURIED, COUNTERBORE, CTL_OMIT_PAD_NETS, LSET::CuStack(), PADSTACK::Drill(), F_Cu, KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), FormatDouble2Str(), formatInternalUnits(), formatLayer(), formatLayers(), KICAD_FORMAT::FormatOptBool(), formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), PADSTACK::FRONT_INNER_BACK, PADSTACK::FrontOuterLayers(), BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), PCB_TRACK::GetEnd(), BOARD_CONNECTED_ITEM::GetLayer(), PCB_TRACK::GetLayerSet(), PCB_TRACK::GetLocalSolderMaskMargin(), PCB_ARC::GetMid(), BOARD_CONNECTED_ITEM::GetNetname(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), PADSTACK::MASK_LAYER_PROPS::has_covering, PADSTACK::MASK_LAYER_PROPS::has_plugging, PADSTACK::MASK_LAYER_PROPS::has_solder_mask, PCB_TRACK::HasSolderMask(), PADSTACK::INNER_LAYERS, PADSTACK::DRILL_PROPS::is_capped, PADSTACK::DRILL_PROPS::is_filled, isDefaultTeardropParameters(), IsExternalCopperLayer(), BOARD_ITEM::IsLocked(), KEEP_ALL, m_ctl, m_out, EDA_ITEM::m_Uuid, MICROVIA, PADSTACK::Mode(), LSET::Name(), PADSTACK::NORMAL, NOT_POST_MACHINED, PCB_ARC_T, PCB_VIA_T, REMOVE_ALL, REMOVE_EXCEPT_START_AND_END, PADSTACK::Size(), START_END_ONLY, THROUGH, THROW_IO_ERRORF, EDA_ITEM::Type(), UNDEFINED_DRILL_DIAMETER, UNDEFINED_LAYER, via, VECTOR2< T >::x, and ZLO_FORCE_FLASHED.
|
private |
Definition at line 3500 of file pcb_io_kicad_sexpr.cpp.
References _, AREA, EDA_ANGLE::AsDegrees(), KIID::AsString(), chain, ZONE_SETTINGS::CHAMFER, COMPONENT_CLASS, COPPER_THIEVING, CTL_OMIT_PAD_NETS, DESIGN_BLOCK, DIAGONAL_EDGE, DIAGONAL_FULL, DOTS, THIEVING_SETTINGS::element_size, ZONE_SETTINGS::FILLET, format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), FormatDouble2Str(), formatInternalUnits(), formatLayer(), formatLayers(), formatPolyPts(), KICAD_FORMAT::FormatUuid(), FULL, THIEVING_SETTINGS::gap, EDA_ORIENTATION::GetAngle(), ZONE::GetAssignedPriority(), BOARD_ITEM::GetBoard(), ZONE::GetBorderHatchPitch(), ZONE::GetCornerRadius(), ZONE::GetCornerSmoothingType(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), ZONE::GetDoNotAllowZoneFills(), BOARD::GetEnabledLayers(), ZONE::GetFilledPolysList(), ZONE::GetFillMode(), ZONE::GetFirstLayer(), ZONE::GetHatchBorderAlgorithm(), ZONE::GetHatchGap(), ZONE::GetHatchHoleMinArea(), ZONE::GetHatchOrientation(), ZONE::GetHatchSmoothingLevel(), ZONE::GetHatchSmoothingValue(), ZONE::GetHatchStyle(), ZONE::GetHatchThickness(), ZONE::GetIslandRemovalMode(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), ZONE::GetLinkSet(), ZONE::GetLocalClearance(), ZONE::GetMinIslandArea(), ZONE::GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), ZONE::GetNumCorners(), ZONE::GetPadConnection(), ZONE::GetPlacementAreaEnabled(), ZONE::GetPlacementAreaSource(), ZONE::GetPlacementAreaSourceType(), ZONE::GetRepeatOptions(), ZONE::GetTeardropAreaType(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), ZONE::GetThievingSettings(), ZONE::GetZoneName(), GROUP_PLACEMENT, HATCH, HATCH_PATTERN, ZONE::IsFilled(), ZONE::IsIsland(), BOARD_ITEM::IsLocked(), ZONE::IsOnCopperLayer(), ZONE::IsTeardropArea(), ZONE::LayerProperties(), THIEVING_SETTINGS::line_width, REPEAT_LAYOUT_OPTIONS::m_anchor, REPEAT_LAYOUT_OPTIONS::m_connectedRoutingOnly, REPEAT_LAYOUT_OPTIONS::m_copyOtherItems, REPEAT_LAYOUT_OPTIONS::m_copyPlacement, REPEAT_LAYOUT_OPTIONS::m_copyRouting, m_ctl, REPEAT_LAYOUT_OPTIONS::m_groupItems, REPEAT_LAYOUT_OPTIONS::m_includeLockedItems, m_out, EDA_ITEM::m_Uuid, LSET::Name(), niluuid, NO_HATCH, ZONE_SETTINGS::NO_SMOOTHING, NONE, THIEVING_SETTINGS::orientation, ZONE::Outline(), THIEVING_SETTINGS::pattern, pcbIUScale, SHAPE_POLY_SET::Polygon(), LSET::Seq(), SHEETNAME, SQUARES, THIEVING_SETTINGS::stagger, TD_VIAPAD, THERMAL, THROW_IO_ERRORF, and THT_THERMAL.
|
private |
Definition at line 3774 of file pcb_io_kicad_sexpr.cpp.
References formatInternalUnits(), ZONE_LAYER_PROPERTIES::hatching_offset, m_out, and LSET::Name().
|
protected |
formats the board layer information
Definition at line 766 of file pcb_io_kicad_sexpr.cpp.
References LSET::CuStack(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD::GetLayerType(), IsCopperLayer(), LT_BACK, LT_FRONT, m_out, LSET::Name(), LSET::TechAndUserUIOrder(), and User_1.
Referenced by formatHeader(), and CLIPBOARD_IO::SaveSelection().
| void PCB_IO_KICAD_SEXPR::FormatBoardToFormatter | ( | OUTPUTFORMATTER * | aOut, |
| BOARD * | aBoard, | ||
| const std::map< std::string, UTF8 > * | aProperties = nullptr ) |
Serialize a BOARD to an OUTPUTFORMATTER without file I/O or Prettify.
Handles init(), EmbedFonts/ClearEmbeddedFonts, header, Format(), and footer. The caller owns the formatter and is responsible for flushing/closing it. Skips GroupsSanityCheck (no UI interaction allowed from timer callbacks).
Definition at line 307 of file pcb_io_kicad_sexpr.cpp.
References Format(), GetMajorMinorVersion(), init(), PCB_IO::m_board, m_out, and SEXPR_BOARD_FILE_VERSION.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGIT_PCB_MERGE::FormatBoard(), SaveBoard(), and BOARD::SaveToHistory().
|
protected |
Definition at line 697 of file pcb_io_kicad_sexpr.cpp.
References DRILL_SYMBOL_PROFILE::Assignments(), DrillGroupKeyToken(), DrillMarkModeToken(), DrillMarkPolicyToken(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), BOARD_DESIGN_SETTINGS::GetDrillSymbolProfile(), DRILL_SYMBOL_PROFILE::GetFreezeAssignments(), DRILL_SYMBOL_PROFILE::GetMarkPolicy(), DRILL_SYMBOL_PROFILE::GetName(), DRILL_SYMBOL_PROFILE::GetSymbolSize(), DRILL_SYMBOL_PROFILE::GetSymbolWidth(), DRILL_SYMBOL_PROFILE::GroupKeys(), LETTER, m_out, and SHAPE.
Referenced by formatSetup().
| void PCB_IO_KICAD_SEXPR::FormatFootprintLibFile | ( | FOOTPRINT * | aFootprint | ) | const |
Output aFootprint as a complete footprint library file.
| aFootprint | has its embedded fonts updated to match its settings, so pass a copy of a live footprint. |
Definition at line 355 of file pcb_io_kicad_sexpr.cpp.
References EMBEDDED_FILES::ClearEmbeddedFonts(), FOOTPRINT::EmbedFonts(), format(), formatInitialComments(), EMBEDDED_FILES::GetAreFontsEmbedded(), FOOTPRINT::GetEmbeddedFiles(), GetMajorMinorVersion(), m_out, and SEXPR_FOOTPRINT_LIB_FILE_VERSION.
Referenced by KI_TEST::DumpFootprintToFile(), and FOOTPRINT_EDIT_FRAME::ExportFootprint().
|
protected |
formats the General section of the file
Definition at line 749 of file pcb_io_kicad_sexpr.cpp.
References PAGE_INFO::Format(), TITLE_BLOCK::Format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), BOARD::GetDesignSettings(), BOARD::GetPageSettings(), BOARD::GetTitleBlock(), BOARD::LegacyTeardrops(), and m_out.
Referenced by formatHeader().
|
private |
What only one kind of generated table carries, written after the shared settings.
Definition at line 2938 of file pcb_io_kicad_sexpr.cpp.
References PCB_DRILL_CHART::Filter(), filter, KICAD_FORMAT::FormatBool(), DRILL_CHART_TEMPLATE::GetShowTotals(), PCB_DRILL_CHART::GetShowTotals(), PCB_DRILL_CHART::GetSymbolColumn(), m_out, DRILL_CHART_TEMPLATE::MakeDefault(), PCB_DRILL_CHART_T, PCB_DRILL_CHART::RowShapes(), and EDA_ITEM::Type().
Referenced by format().
|
protected |
writes everything that comes before the board_items, like settings and layers etc
Definition at line 854 of file pcb_io_kicad_sexpr.cpp.
References formatBoardLayers(), formatGeneral(), formatProperties(), formatSetup(), and formatVariants().
Referenced by format().
|
private |
Definition at line 1453 of file pcb_io_kicad_sexpr.cpp.
References CTL_OMIT_INITIAL_COMMENTS, FOOTPRINT::GetInitialComments(), m_ctl, m_out, and TO_UTF8.
Referenced by format(), and FormatFootprintLibFile().
|
private |
|
private |
Definition at line 1888 of file pcb_io_kicad_sexpr.cpp.
References LSET::AllCuMask(), LSET::AllCuMask(), B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, PCB_IO::m_board, m_out, MAX_CU_LAYERS, LSET::Name(), paste, and PCB_LAYER_ID_COUNT.
|
private |
Definition at line 539 of file pcb_io_kicad_sexpr.cpp.
References SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_LINE_CHAIN::CPoint(), formatInternalUnits(), SHAPE_ARC::GetArcMid(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), m_out, and SHAPE_LINE_CHAIN::PointCount().
Referenced by format(), format(), format(), format(), format(), and formatRenderCache().
|
protected |
formats the Nets and Netclasses
Definition at line 818 of file pcb_io_kicad_sexpr.cpp.
References BOARD::GetProperties(), and m_out.
Referenced by formatHeader().
|
private |
Definition at line 574 of file pcb_io_kicad_sexpr.cpp.
References FOR_CANVAS, EDA_UNIT_UTILS::FormatAngle(), formatPolyPts(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetFont(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextThickness(), m_out, and KIGFX::GAL::SetLineWidth().
|
protected |
formats the board setup information
Definition at line 602 of file pcb_io_kicad_sexpr.cpp.
References PCB_PLOT_PARAMS::Format(), format(), BOARD_STACKUP::FormatBoardStackup(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatDrillSymbolProfile(), formatInternalUnits(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), BOARD::GetPlotOptions(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), BOARD_DESIGN_SETTINGS::m_AllowSoldermaskBridgesInFPs, BOARD_DESIGN_SETTINGS::m_CapVias, BOARD_DESIGN_SETTINGS::m_CoverViasBack, BOARD_DESIGN_SETTINGS::m_CoverViasFront, BOARD_DESIGN_SETTINGS::m_FillVias, BOARD_DESIGN_SETTINGS::m_HasStackup, m_out, BOARD_DESIGN_SETTINGS::m_PlugViasBack, BOARD_DESIGN_SETTINGS::m_PlugViasFront, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, BOARD_DESIGN_SETTINGS::m_TentViasBack, BOARD_DESIGN_SETTINGS::m_TentViasFront, BOARD_DESIGN_SETTINGS::m_ZoneLayerProperties, VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by formatHeader().
|
private |
Geometry and cells with no identity, so an enclosing form owns uuid/layer/locked.
Definition at line 2777 of file pcb_io_kicad_sexpr.cpp.
References STROKE_PARAMS::Format(), format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatCustomProperties(), formatInternalUnits(), PCB_TABLE::GetBorderStroke(), PCB_TABLE::GetCells(), PCB_TABLE::GetColCount(), PCB_TABLE::GetColWidth(), PCB_TABLE::GetRowCount(), PCB_TABLE::GetRowHeight(), PCB_TABLE::GetSeparatorsStroke(), m_out, pcbIUScale, PCB_TABLE::StrokeColumns(), PCB_TABLE::StrokeExternal(), PCB_TABLE::StrokeHeaderSeparator(), and PCB_TABLE::StrokeRows().
|
protected |
Definition at line 888 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, TEARDROP_PARAMETERS::m_CurvedEdges, TEARDROP_PARAMETERS::m_Enabled, m_out, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, and TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio.
|
protected |
formats the board variant registry
Definition at line 829 of file pcb_io_kicad_sexpr.cpp.
References BOARD::GetVariantDescription(), BOARD::GetVariantNames(), and m_out.
Referenced by formatHeader().
|
inlineoverridevirtual |
Return board file description for the PCB_IO.
Reimplemented from PCB_IO.
Definition at line 364 of file pcb_io_kicad_sexpr.h.
References _HKI.
|
overridevirtual |
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management in plugins that support it.
Whether the returned pointer is borrowed or owned by the caller depends on the plugin. Use CachesEnumeratedFootprints() to determine.
Reimplemented from PCB_IO.
Definition at line 4023 of file pcb_io_kicad_sexpr.cpp.
References getFootprint().
|
protected |
Definition at line 3998 of file pcb_io_kicad_sexpr.cpp.
References init(), m_cache, and validateCache().
Referenced by FootprintLoad(), and GetEnumeratedFootprint().
|
virtualinherited |
Return a container with the cached library footprints generated in the last call to Load.
This function is intended to be used ONLY by the non-KiCad board importers for the purpose of obtaining the footprint library of the design and creating a project-specific library.
Reimplemented in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_EASYEDAPRO_V3, PCB_IO_GEDA, PCB_IO_IPC2581, PCB_IO_ODBPP, PCB_IO_SPRINT_LAYOUT, and PCB_IO_TARGET3001.
Definition at line 99 of file pcb_io.cpp.
References NOT_IMPLEMENTED.
Referenced by ReconcileImportedFootprints().
|
inlinevirtualinherited |
Return custom DRC rules generated while importing the most recent board.
The caller owns persistence of these rules beside the imported KiCad board.
Reimplemented in PCB_IO_EAGLE, PCB_IO_EASYEDAPRO, PCB_IO_EASYEDAPRO_V3, PCB_IO_EASYPC, and PCB_IO_TARGET3001.
|
inlineoverridevirtual |
Get the descriptor for the library container that this IO plugin operates on.
Implements IO_BASE.
Definition at line 378 of file pcb_io_kicad_sexpr.h.
References _HKI.
|
inlineoverridevirtual |
Get the descriptor for the individual library elements that this IO plugin operates on.
For libraries where all the elements are in a single container (e.g. all elements in a single file), then this will return the descriptor from IO_BASE::GetLibraryDesc().
Reimplemented from IO_BASE.
Definition at line 373 of file pcb_io_kicad_sexpr.h.
References _HKI.
|
overridevirtualinherited |
Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions.
Options are typically appended so that a derived PCB_IO can call its base class function by the same name first, thus inheriting options declared there. Some base class options could pertain to all Footprint*() functions in all derived PLUGINs.
| aListToAppendTo | holds a tuple of
In the future perhaps aListToAppendTo evolves to something capable of also holding a wxValidator for the cells in said dialog: http://forums.wxwidgets.org/viewtopic.php?t=23277&p=104180. This would require a 3 column list, and introducing wx GUI knowledge to PLUGIN, which has been avoided to date. |
Reimplemented from IO_BASE.
Definition at line 185 of file pcb_io.cpp.
References _, and IO_BASE::GetLibraryOptions().
|
overridevirtual |
Generate a timestamp representing all the files in the library (including the library directory).
Timestamps should not be considered ordered, they either match or they don't.
Implements PCB_IO.
Definition at line 4241 of file pcb_io_kicad_sexpr.cpp.
References FP_CACHE::GetTimestamp().
|
inlineinherited |
Return a brief hard coded name for this IO interface.
Definition at line 79 of file io_base.h.
References m_name.
Referenced by SCH_IO_EASYPC::convertComponent(), SCH_IO_EASYEDAPRO_V3::EnumerateSymbolLib(), PCB_IO_EASYPC::GetEnumeratedFootprint(), SCH_IO_EASYPC::LoadSchematicFile(), SCH_IO_EASYEDAPRO_V3::LoadSymbol(), SCH_IO_EASYPC::LoadSymbol(), SCH_IO_ALTIUM::ParseAltiumSch(), and SCH_IO_ALTIUM::ParseLibFile().
|
inline |
Definition at line 465 of file pcb_io_kicad_sexpr.h.
References m_sf.
Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint().
|
overridevirtual |
Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.
If this is a footprint library, the first footprint should be loaded. The default implementation uses FootprintEnumerate and FootprintLoad to load first footprint.
| aFootprintPath | is a path of the footprint file. |
| aFootprintNameOut | is the name output of the loaded footprint. |
| aProperties | is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| IO_ERROR | if the footprint cannot be found or read. |
Reimplemented from PCB_IO.
Definition at line 4048 of file pcb_io_kicad_sexpr.cpp.
References LIB_TREE_ITEM::GetFootprint(), and PCB_IO_KICAD_SEXPR_PARSER::ParseFootprintLib().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), classifyFootprintLibraries(), DowngradeFootprintFileToTemp(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), and PCBNEW_JOBS_HANDLER::runFpLibMerge().
|
protected |
Definition at line 3943 of file pcb_io_kicad_sexpr.cpp.
References PCB_IO::m_board, PCB_IO::m_props, and m_reader.
Referenced by CreateLibrary(), DoLoad(), FootprintDelete(), FootprintEnumerate(), FootprintSave(), FormatBoardToFormatter(), getFootprint(), IsLibraryWritable(), PCB_IO_KICAD_SEXPR(), and CLIPBOARD_IO::SaveBoard().
|
overridevirtual |
Return true if the library at aLibraryPath is writable.
The system libraries are typically read only because of where they are installed..
| aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
| IO_ERROR | if no library at aLibraryPath exists. |
Reimplemented from IO_BASE.
Definition at line 4329 of file pcb_io_kicad_sexpr.cpp.
References init(), m_cache, and validateCache().
|
inlineoverridevirtualinherited |
|
inlineoverridevirtual |
Have the destructor leave the library cache unfreed.
Only for use as the process exits, since freeing the caches of thousands of libraries one item at a time holds it up for seconds. The cache stays usable until the plugin is destroyed, so threads still reading it are safe. Plugins without a large cache ignore it.
Reimplemented from IO_BASE.
Definition at line 416 of file pcb_io_kicad_sexpr.h.
References m_leakCacheAtExit.
|
inherited |
Same as LoadBoard(), but appends the loaded board to an existing board, which must already exist.
| aFileName | is the file name of the board to load and append to aAppendToMe. | |
| aAppendToMe | is the existing board to append to. The caller always owns it. | |
| [in] | aProperties | are any custom properties for the plugin. |
| [in] | aProject | is an optional PROJECT object. |
Definition at line 85 of file pcb_io.cpp.
References loadBoard().
Referenced by PCB_CONTROL::AppendBoard(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().
|
inherited |
Load information from some input file format that this PCB_IO implementation knows about into new BOARD.
| aFileName | is the name of the file to use as input and may be foreign in nature or native in nature. |
| aProperties | is an associative array that can be used to tell the loader how to load the file, because it can take any number of additional named arguments that the plugin is known to support. These are tuning parameters for the import or load. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. |
| aProject | is the optional PROJECT object primarily used by third party importers. |
| IO_ERROR | if there is a problem loading, and its contents should say what went wrong, using line number and character offsets of the input file if possible. |
| IO_CANCELLED | if the user cancelled the load. |
Definition at line 72 of file pcb_io.cpp.
References loadBoard().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CachedLoad(), checkAllCopperFillZonesHaveClearance(), checkCustomPadArcSurvives(), checkImportedOriginOffset(), checkTransformedBoardUsesOnlyKnownTokens(), ExportBoardToOlderVersion(), PCBNEW_JOBS_HANDLER::JobDowngrade(), PNS_LOG_FILE::Load(), LoadAndVerify(), EAGLE_BINARY_IMPORT_FIXTURE::loadBoard(), and KI_TEST::LoadBoardWithCapture().
|
overrideprotectedvirtual |
Parse aFileName into aBoard.
The caller owns aBoard in both cases.
| aFileName | is the file name of the board to load. | |
| [in] | aBoard | is the BOARD object to load aFileName into. |
| aIsNewLoad | is true for a fresh load (adopt the file's setup, keep the file's UUIDs) and false when merging into an existing board (preserve its setup, regenerate UUIDs that would clash). | |
| aProperties | are any optional properties used by the plugin. | |
| aProject |
Reimplemented from PCB_IO.
Definition at line 3813 of file pcb_io_kicad_sexpr.cpp.
References _, DoLoad(), LOAD_INFO_REPORTER::GetInstance(), IO_BASE::m_progressReporter, FILE_LINE_READER::ReadLine(), FILE_LINE_READER::Rewind(), and THROW_IO_CANCELLED.
| BOARD_ITEM * PCB_IO_KICAD_SEXPR::Parse | ( | const wxString & | aClipboardSourceInput | ) |
Definition at line 334 of file pcb_io_kicad_sexpr.cpp.
References PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), m_queryUserCallback, PCB_IO_KICAD_SEXPR_PARSER::Parse(), and TO_UTF8.
Referenced by CLIPBOARD_IO::Parse().
|
inlinevirtualinherited |
Register a different handler to be called when mapping of input layers to KiCad layers occurs.
The function is marked as virtual, so the plugins can implement extra logic (e.g., enable warnings or checks)
| aLayerMappingHandler |
Reimplemented in PCB_IO_CADSTAR_ARCHIVE.
Definition at line 74 of file plugin_common_layer_mapping.h.
References m_layer_mapping_handler.
Referenced by PCB_IO_ALLEGRO::PCB_IO_ALLEGRO(), PCB_IO_ALTIUM_CIRCUIT_MAKER::PCB_IO_ALTIUM_CIRCUIT_MAKER(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::PCB_IO_ALTIUM_CIRCUIT_STUDIO(), PCB_IO_ALTIUM_DESIGNER::PCB_IO_ALTIUM_DESIGNER(), PCB_IO_CADSTAR_ARCHIVE::PCB_IO_CADSTAR_ARCHIVE(), PCB_IO_EAGLE::PCB_IO_EAGLE(), PCB_IO_PADS::PCB_IO_PADS(), PCB_IO_PADS_BINARY::PCB_IO_PADS_BINARY(), PCB_IO_SOLIDWORKS::PCB_IO_SOLIDWORKS(), and PCB_IO_CADSTAR_ARCHIVE::RegisterCallback().
|
virtualinherited |
Definition at line 124 of file io_base.cpp.
References m_reporter.
Referenced by PCB_IO_IPC2581::addShape(), PCB_IO_ODBPP::ConfigureExport(), SCH_IO_EASYEDAPRO_V3::EnumerateSymbolLib(), PCB_IO_ODBPP::ExportODB(), PCB_IO_IPC2581::generateBOMSection(), PCB_IO_IPC2581::generateComponents(), PCB_IO_IPC2581::generateLayerSetDrill(), PCB_IO_IPC2581::generateLayerSetNet(), PCB_IO_IPC2581::generateProfile(), PCB_IO::ImportFootprint(), PCB_IO_DIPTRACE::loadBoard(), PCB_IO_EASYEDAPRO_V3::loadBoard(), SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), PCB_IO_KICAD_LEGACY::loadPAD(), PCB_IO_EAGLE::loadPolygon(), SCH_IO_EASYEDAPRO_V3::LoadSchematicFile(), SCH_IO_EAGLE::loadSegments(), PCB_IO_KICAD_LEGACY::loadZONE_CONTAINER(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePad(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageText(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), and SCH_IO_DATABASE::reportIssue().
|
inlinevirtualnoexceptinherited |
Called after the loads that were cancelled have ended, to clear what CancelLoad() left behind.
Reimplemented in SCH_IO_DATABASE.
Definition at line 171 of file io_base.h.
Referenced by LIBRARY_MANAGER_ADAPTER::resumeLoadingPlugins().
|
overridevirtual |
Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be used to write a portion of aBoard to a special kind of export file.
| aFileName | is the name of a file to save to on disk. |
| aBoard | is the class BOARD in memory document tree from which to extract information when writing to aFileName. The caller continues to own the BOARD, and the plugin should refrain from modifying the BOARD if possible. |
| aProperties | is an associative array that can be used to tell the saver how to save the file, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it) and plugins should expect it to be optionally NULL. |
| IO_ERROR | if there is a problem saving or exporting. |
Reimplemented from PCB_IO.
Definition at line 284 of file pcb_io_kicad_sexpr.cpp.
References _, PRETTIFIED_FILE_OUTPUTFORMATTER::Finish(), FormatBoardToFormatter(), BOARD::GroupsSanityCheck(), and m_queryUserCallback.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkTransformedBoardUsesOnlyKnownTokens(), KI_TEST::DumpBoardToFile(), PCBNEW_JOBS_HANDLER::runPcbMerge(), and ROUTER_TOOL::saveRouterDebugLog().
|
inline |
Definition at line 475 of file pcb_io_kicad_sexpr.h.
References m_out.
Referenced by BOOST_AUTO_TEST_CASE(), KI_TEST::DumpFootprintToFile(), and PCBNEW_JOBS_HANDLER::runFpLibMerge().
|
inlinevirtualinherited |
Set an optional progress reporter.
Reimplemented in SCH_IO_CADSTAR_ARCHIVE.
Definition at line 94 of file io_base.h.
References m_progressReporter.
Referenced by PCB_CONTROL::AppendBoard(), GenerateIpc2581File(), and generateOneODBPackage().
|
inlinevirtualinherited |
Register a KIDIALOG callback for collecting info from the user.
Definition at line 129 of file pcb_io.h.
Referenced by PCB_CONTROL::AppendBoard().
|
inlineoverride |
Definition at line 383 of file pcb_io_kicad_sexpr.h.
References m_queryUserCallback.
|
inlinevirtualinherited |
Set an optional reporter for warnings/errors.
Reimplemented in SCH_IO_CADSTAR_ARCHIVE.
Definition at line 89 of file io_base.h.
References m_reporter.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ExportOdb(), GenerateIpc2581File(), generateOneODBPackage(), KI_TEST::LoadBoardWithCapture(), SCH_IO_GEDA::loadDeferredSheets(), and SCH_IO_GEDA::LoadSchematicFile().
|
inlinevirtualinherited |
Stop and join any thread that reads other libraries through the library adapter.
Called before the plugin is retired, while every library such a thread could reach is still alive. The plugin is not used again.
Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.
|
inlinevirtualinherited |
Reimplemented in SCH_IO_DATABASE.
|
protected |
Definition at line 3951 of file pcb_io_kicad_sexpr.cpp.
References FP_CACHE, and m_cache.
Referenced by FootprintDelete(), FootprintEnumerate(), FootprintSave(), getFootprint(), and IsLibraryWritable().
|
friend |
Definition at line 575 of file pcb_io_kicad_sexpr.h.
References FP_CACHE.
Referenced by CreateLibrary(), FP_CACHE, and validateCache().
|
protectedinherited |
The board BOARD being worked on, no ownership here.
Definition at line 404 of file pcb_io.h.
Referenced by PCB_IO_AUTOTRAX::addItem(), PCB_IO_AUTOTRAX::buildBoard(), PCB_IO_AUTOTRAX::buildComponent(), PCB_IO_EAGLE::centerBoard(), PCB_IO_AUTOTRAX::emitFill(), PCB_IO_AUTOTRAX::emitPad(), PCB_IO_AUTOTRAX::emitTrack(), PCB_IO_AUTOTRAX::emitVia(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::FormatBoardToFormatter(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_ALTIUM_DESIGNER::GetImportedCachedLibraryFootprints(), PCB_IO_AUTOTRAX::getNet(), PCB_IO_EAGLE::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_LEGACY::loadAllSections(), PCB_IO_ALLEGRO::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::loadBoard(), PCB_IO_ALTIUM_DESIGNER::loadBoard(), PCB_IO_AUTOTRAX::loadBoard(), PCB_IO_CADSTAR_ARCHIVE::loadBoard(), PCB_IO_DIPTRACE::loadBoard(), PCB_IO_EAGLE::loadBoard(), PCB_IO_EASYEDA::loadBoard(), PCB_IO_EASYEDAPRO::loadBoard(), PCB_IO_EASYEDAPRO_V3::loadBoard(), PCB_IO_EASYPC::loadBoard(), PCB_IO_FABMASTER::loadBoard(), PCB_IO_GEDA::loadBoard(), PCB_IO_KICAD_LEGACY::loadBoard(), PCB_IO_PCAD::loadBoard(), PCB_IO_SOLIDWORKS::loadBoard(), PCB_IO_TARGET3001::loadBoard(), PCB_IO_EAGLE::loadClasses(), PCB_IO_KICAD_LEGACY::loadDIMENSION(), PCB_IO_EAGLE::loadElements(), PCB_IO_KICAD_LEGACY::loadGENERAL(), PCB_IO_EAGLE::loadLayerDefs(), PCB_IO_KICAD_LEGACY::loadNETCLASS(), PCB_IO_KICAD_LEGACY::loadNETINFO_ITEM(), PCB_IO_KICAD_LEGACY::loadPAD(), PCB_IO_KICAD_LEGACY::loadPCB_LINE(), PCB_IO_KICAD_LEGACY::loadPCB_TARGET(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::loadPolygon(), PCB_IO_KICAD_LEGACY::loadSETUP(), PCB_IO_KICAD_LEGACY::loadSHEET(), PCB_IO_EAGLE::loadSignals(), PCB_IO_KICAD_LEGACY::loadTrackList(), PCB_IO_KICAD_LEGACY::loadZONE_CONTAINER(), PCB_IO_EAGLE::makeFootprint(), PCB_IO_EAGLE::packagePad(), PCB_IO_AUTOTRAX::parentOf(), PCB_IO_GEDA::parseElement(), PCB_IO_GEDA::parseLayer(), PCB_IO_GEDA::parseNetList(), PCB_IO_GEDA::parseVia(), PCB_IO(), CLIPBOARD_IO::SaveBoard(), CLIPBOARD_IO::SaveSelection(), and CLIPBOARD_IO::SetBoard().
|
protected |
Footprint library cache.
Definition at line 580 of file pcb_io_kicad_sexpr.h.
Referenced by ClearCachedFootprints(), CreateLibrary(), DeleteLibrary(), FootprintDelete(), FootprintEnumerate(), FootprintSave(), getFootprint(), IsLibraryWritable(), PCB_IO_KICAD_SEXPR(), validateCache(), and ~PCB_IO_KICAD_SEXPR().
|
protected |
Definition at line 588 of file pcb_io_kicad_sexpr.h.
Referenced by FootprintSave(), format(), format(), format(), format(), format(), format(), formatInitialComments(), and PCB_IO_KICAD_SEXPR().
|
protected |
for throwing exceptions
Definition at line 578 of file pcb_io_kicad_sexpr.h.
|
protected |
for saves only, name is in m_reader for loads
Definition at line 584 of file pcb_io_kicad_sexpr.h.
|
protectedinherited |
Callback to get layer mapping.
Definition at line 81 of file plugin_common_layer_mapping.h.
Referenced by PCB_IO_KICAD_SEXPR::DoLoad(), PCB_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_ALTIUM_CIRCUIT_MAKER::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::loadBoard(), PCB_IO_ALTIUM_DESIGNER::loadBoard(), PCB_IO_CADSTAR_ARCHIVE::loadBoard(), PCB_IO_EASYPC::loadBoard(), PCB_IO_SOLIDWORKS::loadBoard(), PCB_IO_ALLEGRO::LoadBoardFromData(), PCB_IO_PADS::loadBoardSetup(), PCB_IO_PADS_BINARY::loadBoardSetup(), PCB_IO_EAGLE::mapEagleLayersToKicad(), and RegisterCallback().
|
protected |
Definition at line 581 of file pcb_io_kicad_sexpr.h.
Referenced by LeakCacheAtExit(), and ~PCB_IO_KICAD_SEXPR().
|
protectedinherited |
Name of the IO loader.
Definition at line 261 of file io_base.h.
Referenced by PCB_IO_IPC2581::generateBOMSection(), GetName(), IO_BASE(), and PCB_IO_IPC2581::pinName().
|
protected |
output any Format()s to this, no ownership
Definition at line 587 of file pcb_io_kicad_sexpr.h.
Referenced by CLIPBOARD_IO::CLIPBOARD_IO(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), format(), formatBoardLayers(), FormatBoardToFormatter(), formatDrillSymbolProfile(), FormatFootprintLibFile(), formatGeneral(), formatGeneratedTableExtras(), formatInitialComments(), formatLayer(), formatLayers(), formatPolyPts(), formatProperties(), formatRenderCache(), formatSetup(), formatTableData(), formatTeardropParameters(), formatVariants(), PCB_IO_KICAD_SEXPR(), and SetOutputFormatter().
|
protectedinherited |
Progress reporter to track the progress of the operation, may be nullptr.
Definition at line 267 of file io_base.h.
Referenced by AdvanceProgressPhase(), SCH_IO_KICAD_LEGACY::checkpoint(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), SCH_IO_EAGLE::ensureLoadedLibrary(), PCB_IO_ODBPP::ExportODB(), PCB_IO_IPC2581::generateComponents(), PCB_IO_IPC2581::generateLayerFeatures(), PCB_IO_IPC2581::generatePhyNetGroup(), IO_BASE(), PCB_IO_ALTIUM_CIRCUIT_MAKER::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::loadBoard(), PCB_IO_ALTIUM_DESIGNER::loadBoard(), PCB_IO_CADSTAR_ARCHIVE::loadBoard(), PCB_IO_DIPTRACE::loadBoard(), PCB_IO_EASYEDA::loadBoard(), PCB_IO_EASYEDAPRO::loadBoard(), PCB_IO_EASYEDAPRO_V3::loadBoard(), PCB_IO_EASYPC::loadBoard(), PCB_IO_FABMASTER::loadBoard(), PCB_IO_KICAD_SEXPR::loadBoard(), PCB_IO_PADS::loadBoard(), PCB_IO_PADS_BINARY::loadBoard(), PCB_IO_SOLIDWORKS::loadBoard(), PCB_IO_TARGET3001::loadBoard(), PCB_IO_ALLEGRO::LoadBoardFromData(), SCH_IO_KICAD_LEGACY::loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_ORCAD::loadOlbSymbols(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_DIPTRACE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYPC::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ORCAD::LoadSchematicFile(), SCH_IO_PADS::LoadSchematicFile(), SCH_IO_TARGET3001::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), PCB_IO_IPC2581::reportPhase(), PCB_IO_IPC2581::SaveBoard(), SetProgressReporter(), SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter(), and PCB_IO_IPC2581::tickProgress().
|
protectedinherited |
Properties passed via Save() or Load(), no ownership, may be NULL.
Definition at line 407 of file pcb_io.h.
Referenced by PCB_IO_EAGLE::centerBoard(), PCB_IO_EAGLE::init(), PCB_IO_GEDA::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_ALLEGRO::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::loadBoard(), PCB_IO_ALTIUM_DESIGNER::loadBoard(), PCB_IO_AUTOTRAX::loadBoard(), PCB_IO_CADSTAR_ARCHIVE::loadBoard(), PCB_IO_DIPTRACE::loadBoard(), PCB_IO_EASYEDA::loadBoard(), PCB_IO_EASYEDAPRO::loadBoard(), PCB_IO_EASYEDAPRO_V3::loadBoard(), PCB_IO_EASYPC::loadBoard(), PCB_IO_FABMASTER::loadBoard(), PCB_IO_PCAD::loadBoard(), PCB_IO_SOLIDWORKS::loadBoard(), PCB_IO_SPRINT_LAYOUT::loadBoard(), PCB_IO_TARGET3001::loadBoard(), and PCB_IO().
|
protected |
Definition at line 590 of file pcb_io_kicad_sexpr.h.
Referenced by CanReadBoard(), DoLoad(), Parse(), SaveBoard(), and SetQueryUserCallback().
|
protected |
|
protectedinherited |
Reporter to log errors/warnings to, may be nullptr.
Definition at line 264 of file io_base.h.
Referenced by SCH_IO_EASYPC::convertComponent(), PCB_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), SCH_IO_EASYEDA::EnumerateSymbolLib(), SCH_IO_GEDA::flushPendingComponent(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), SCH_IO_GEDA::getOrLoadSymbol(), SCH_IO_GEDA::importHierarchicalSheet(), IO_BASE(), PCB_IO_EASYPC::library(), SCH_IO_EASYPC::library(), SCH_IO_PADS::loadBinarySchematicFile(), PCB_IO_ALTIUM_CIRCUIT_MAKER::loadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::loadBoard(), PCB_IO_ALTIUM_DESIGNER::loadBoard(), PCB_IO_CADSTAR_ARCHIVE::loadBoard(), PCB_IO_EASYPC::loadBoard(), PCB_IO_FABMASTER::loadBoard(), PCB_IO_PADS::loadBoard(), PCB_IO_PADS_BINARY::loadBoard(), PCB_IO_PCAD::loadBoard(), PCB_IO_SOLIDWORKS::loadBoard(), PCB_IO_TARGET3001::loadBoard(), PCB_IO_ALLEGRO::LoadBoardFromData(), PCB_IO_PADS::loadCopperShapes(), PCB_IO_PADS_BINARY::loadCopperShapes(), SCH_IO_GEDA::loadDeferredSheets(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), SCH_IO_ORCAD::loadOlbSymbols(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_DIPTRACE::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSchematicFile(), SCH_IO_EASYPC::LoadSchematicFile(), SCH_IO_GEDA::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ORCAD::LoadSchematicFile(), SCH_IO_PADS::LoadSchematicFile(), SCH_IO_TARGET3001::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSymbol(), PCB_IO_PADS::loadTracksAndVias(), PCB_IO_PADS_BINARY::loadTracksAndVias(), PCB_IO_PADS::loadZones(), PCB_IO_PADS_BINARY::loadZones(), SCH_IO_ALTIUM::NameNetsAfterNetLabels(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_PCAD::populateScreen(), Report(), PCB_IO_AUTOTRAX::reporter(), SCH_IO_ALTIUM::SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_DIPTRACE::SCH_IO_DIPTRACE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYPC::SCH_IO_EASYPC(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), SCH_IO_ORCAD::SCH_IO_ORCAD(), SCH_IO_TARGET3001::SCH_IO_TARGET3001(), SetReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().
|
protected |
Definition at line 586 of file pcb_io_kicad_sexpr.h.
Referenced by GetStringOutput(), and PCB_IO_KICAD_SEXPR().