KiCad PCB EDA Suite
|
A #PLUGIN 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 |
Returns 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 |
Checks if this PCB_IO can read the specified board file. | |
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 used to write a portion of aBoard to a special kind of export file. | |
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 a new BOARD or an existing one. | |
BOARD * | DoLoad (LINE_READER &aReader, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount) |
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. | |
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. | |
bool | FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr) override |
Check for the existence of a footprint. | |
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. | |
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 PCB_IO knows about. | |
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 | FootprintDelete (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *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). | |
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, 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, int aNestLevel=0) const |
Output aItem to aFormatter in s-expression format. | |
std::string | GetStringOutput (bool doClear) |
void | SetOutputFormatter (OUTPUTFORMATTER *aFormatter) |
BOARD_ITEM * | Parse (const wxString &aClipboardSourceInput) |
virtual bool | CanReadFootprint (const wxString &aFileName) const |
Checks 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) |
Registers a KIDIALOG callback for collecting info from the user. | |
virtual std::vector< FOOTPRINT * > | GetImportedCachedLibraryFootprints () |
Return a container with the cached library footprints generated in the last call to Load. | |
virtual void | PrefetchLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) |
If possible, prefetches the specified library (e.g. | |
virtual void | GetLibraryOptions (STRING_UTF8_MAP *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. | |
Protected Member Functions | |
void | validateCache (const wxString &aLibraryPath, bool checkModified=true) |
const FOOTPRINT * | getFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties, bool checkModified) |
void | init (const STRING_UTF8_MAP *aProperties) |
void | formatSetup (const BOARD *aBoard, int aNestLevel=0) const |
formats the board setup information | |
void | formatGeneral (const BOARD *aBoard, int aNestLevel=0) const |
formats the General section of the file | |
void | formatBoardLayers (const BOARD *aBoard, int aNestLevel=0) const |
formats the board layer information | |
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 | formatHeader (const BOARD *aBoard, int aNestLevel=0) const |
writes everything that comes before the board_items, like settings and layers etc | |
void | formatTeardropParameters (const TEARDROP_PARAMETERS &tdParams, int aNestLevel=0) const |
Protected Attributes | |
wxString | m_error |
for throwing exceptions | |
FP_CACHE * | m_cache |
Footprint library cache. | |
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 |
NETINFO_MAPPING * | m_mapping |
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes | |
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 STRING_UTF8_MAP * | 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. | |
Private Member Functions | |
void | format (const BOARD *aBoard, int aNestLevel=0) const |
void | format (const PCB_DIMENSION_BASE *aDimension, int aNestLevel=0) const |
void | format (const PCB_REFERENCE_IMAGE *aBitmap, int aNestLevel=0) const |
void | format (const PCB_GROUP *aGroup, int aNestLevel=0) const |
void | format (const PCB_SHAPE *aSegment, int aNestLevel=0) const |
void | format (const PCB_TARGET *aTarget, int aNestLevel=0) const |
void | format (const FOOTPRINT *aFootprint, int aNestLevel=0) const |
void | format (const PAD *aPad, int aNestLevel=0) const |
void | format (const PCB_TEXT *aText, int aNestLevel=0) const |
void | format (const PCB_TEXTBOX *aTextBox, int aNestLevel=0) const |
void | format (const PCB_TABLE *aTable, int aNestLevel=0) const |
void | format (const PCB_GENERATOR *aGenerator, int aNestLevel=0) const |
void | format (const PCB_TRACK *aTrack, int aNestLevel=0) const |
void | format (const ZONE *aZone, int aNestLevel=0) const |
void | formatPolyPts (const SHAPE_LINE_CHAIN &outline, int aNestLevel, bool aCompact, const FOOTPRINT *aParentFP=nullptr) const |
void | formatRenderCache (const EDA_TEXT *aText, int aNestLevel) const |
void | formatLayer (PCB_LAYER_ID aLayer, bool aIsKnockout=false) const |
void | formatLayers (LSET aLayerMask, int aNestLevel=0) const |
Friends | |
class | FP_CACHE |
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
Definition at line 284 of file pcb_io_kicad_sexpr.h.
PCB_IO_KICAD_SEXPR::PCB_IO_KICAD_SEXPR | ( | int | aControlFlags = CTL_FOR_BOARD | ) |
Definition at line 2492 of file pcb_io_kicad_sexpr.cpp.
|
virtual |
Definition at line 2502 of file pcb_io_kicad_sexpr.cpp.
|
overridevirtual |
Checks if this PCB_IO can read the specified board file.
If not overriden, extension check is used.
Reimplemented from PCB_IO.
Definition at line 278 of file pcb_io_kicad_sexpr.cpp.
References PCB_IO::CanReadBoard(), PCB_IO_KICAD_SEXPR_PARSER::IsValidBoardHeader(), and m_queryUserCallback.
|
virtualinherited |
Checks 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_IPC2581, and PCB_IO_KICAD_LEGACY.
Definition at line 59 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 overriden, extension check is used.
Reimplemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_KICAD_LEGACY, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, and PCB_IO_IPC2581.
Definition at line 67 of file io_base.cpp.
References IO_BASE::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 SCH_IO_ALTIUM::CanReadLibrary(), SCH_IO_CADSTAR_ARCHIVE::CanReadLibrary(), SCH_IO_EAGLE::CanReadLibrary(), SCH_IO_KICAD_LEGACY::CanReadLibrary(), PCB_IO_ALTIUM_DESIGNER::CanReadLibrary(), PCB_IO_CADSTAR_ARCHIVE::CanReadLibrary(), and PCB_IO_EAGLE::CanReadLibrary().
|
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 2841 of file pcb_io_kicad_sexpr.cpp.
References _, FP_CACHE, init(), m_cache, FP_CACHE::Save(), and THROW_IO_ERROR.
|
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 2859 of file pcb_io_kicad_sexpr.cpp.
References _, FP_CACHE::IsPath(), FILEEXT::KiCadFootprintFileExtension, m_cache, THROW_IO_ERROR, and traceKicadPcbPlugin.
BOARD * PCB_IO_KICAD_SEXPR::DoLoad | ( | LINE_READER & | aReader, |
BOARD * | aAppendToMe, | ||
const STRING_UTF8_MAP * | aProperties, | ||
PROGRESS_REPORTER * | aProgressReporter, | ||
unsigned | aLineCount | ||
) |
Definition at line 2539 of file pcb_io_kicad_sexpr.cpp.
References _, PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), init(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), m_queryUserCallback, PCB_IO_KICAD_SEXPR_PARSER::Parse(), and THROW_PARSE_ERROR.
Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), and LoadBoard().
|
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 2815 of file pcb_io_kicad_sexpr.cpp.
References _, init(), FP_CACHE::IsWritable(), m_cache, FP_CACHE::Remove(), THROW_IO_ERROR, and validateCache().
|
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 2595 of file pcb_io_kicad_sexpr.cpp.
References FP_CACHE::GetFootprints(), init(), m_cache, THROW_IO_ERROR, validateCache(), and IO_ERROR::What().
|
overridevirtual |
Check for the existence of a footprint.
Reimplemented from PCB_IO.
Definition at line 2660 of file pcb_io_kicad_sexpr.cpp.
References FILEEXT::KiCadFootprintFileExtension.
|
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 2693 of file pcb_io_kicad_sexpr.cpp.
References FOOTPRINT::Clone(), copy, FOOTPRINT::Duplicate(), and getFootprint().
|
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 2717 of file pcb_io_kicad_sexpr.cpp.
References _, ANGLE_0, FOOTPRINT::Clone(), CTL_FOR_LIBRARY, FP_CACHE::Exists(), F_Cu, FOOTPRINT::Flip(), FP_CACHE::GetFootprints(), FOOTPRINT::GetFPID(), FOOTPRINT::GetLayer(), LIB_ID::GetLibItemName(), FOOTPRINT::GetPosition(), init(), FP_CACHE::IsWritable(), FILEEXT::KiCadFootprintFileExtension, Kiface(), KIFACE_BASE::KifaceSettings(), m_cache, m_ctl, PCBNEW_SETTINGS::m_FlipLeftRight, Pgm(), ReplaceIllegalFileNameChars(), WX_FILENAME::ResolvePossibleSymlinks(), FP_CACHE::Save(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), BOARD_ITEM::SetParentGroup(), THROW_IO_ERROR, traceKicadPcbPlugin, validateCache(), and UTF8::wx_str().
|
private |
Definition at line 790 of file pcb_io_kicad_sexpr.cpp.
References BOARD::Drawings(), BOARD::Footprints(), Format(), formatHeader(), BOARD::Generators(), group, BOARD::Groups(), m_out, OUTPUTFORMATTER::Print(), BOARD::Tracks(), and BOARD::Zones().
void PCB_IO_KICAD_SEXPR::Format | ( | const BOARD_ITEM * | aItem, |
int | aNestLevel = 0 |
||
) | const |
Output aItem to aFormatter in s-expression format.
aItem | A pointer the an BOARD_ITEM object to format. |
aNestLevel | The indentation nest level. |
IO_ERROR | on write error. |
Definition at line 361 of file pcb_io_kicad_sexpr.cpp.
References format(), EDA_ITEM::GetClass(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_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 FOOTPRINT_EDIT_FRAME::ExportFootprint(), format(), FP_CACHE::Save(), CLIPBOARD_IO::SaveBoard(), SaveBoard(), and CLIPBOARD_IO::SaveSelection().
|
private |
Definition at line 1102 of file pcb_io_kicad_sexpr.cpp.
References KIID_PATH::AsString(), CTL_OMIT_AT, CTL_OMIT_FOOTPRINT_VERSION, CTL_OMIT_INITIAL_COMMENTS, CTL_OMIT_LIBNAME, CTL_OMIT_PATH, CTL_OMIT_UUIDS, CTX_QUOTED_STR, EscapeString(), LIB_ID::Format(), format(), Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), FP_ALLOW_MISSING_COURTYARD, FP_ALLOW_SOLDERMASK_BRIDGES, FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, FOOTPRINT::GetAttributes(), FOOTPRINT::GetFields(), FOOTPRINT::GetFilters(), FOOTPRINT::GetFPID(), FOOTPRINT::GetInitialComments(), 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(), FOOTPRINT::GetSheetfile(), FOOTPRINT::GetSheetname(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), FOOTPRINT::IsLocked(), FOOTPRINT::IsNetTie(), FOOTPRINT::IsPlaced(), EDA_ANGLE::IsZero(), locked, m_ctl, m_out, EDA_ITEM::m_Uuid, FOOTPRINT::Models(), LSET::Name(), pad, FOOTPRINT::Pads(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotes(), OUTPUTFORMATTER::Quotew(), FOOTPRINT::Reference(), LSET::Seq(), SEXPR_BOARD_FILE_VERSION, TO_UTF8, FOOTPRINT::Value(), and FOOTPRINT::Zones().
|
private |
Definition at line 1449 of file pcb_io_kicad_sexpr.cpp.
References _, ANGLE_45, ANGLE_90, CTL_OMIT_PAD_NETS, CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL, LSET::CuStack(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), formatLayers(), formatPolyPts(), formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), PAD::GetAnchorPadShape(), PAD::GetAttribute(), BOARD_ITEM::GetBoard(), ADVANCED_CFG::GetCfg(), PAD::GetChamferPositions(), PAD::GetChamferRectRatio(), 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::GetLocalZoneConnection(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), PAD::GetNumber(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPadToDieLength(), PAD::GetPinFunction(), PAD::GetPinType(), PAD::GetPrimitives(), PAD::GetProperty(), PAD::GetRemoveUnconnected(), PAD::GetRoundRectRadiusRatio(), PAD::GetShape(), PAD::GetSize(), BOARD_CONNECTED_ITEM::GetTeardropParams(), PAD::GetThermalGap(), PAD::GetThermalSpokeAngle(), PAD::GetThermalSpokeWidth(), PAD::GetZoneLayerOverride(), isDefaultTeardropParameters(), EDA_ANGLE::IsZero(), m_ctl, m_mapping, m_out, EDA_ITEM::m_Uuid, LSET::Name(), SHAPE_POLY_SET::Outline(), PAD_DRILL_SHAPE_OBLONG, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, StrPrintf(), THROW_IO_ERROR, NETINFO_MAPPING::Translate(), NETINFO_LIST::UNCONNECTED, VECTOR2< T >::x, VECTOR2< T >::y, and ZLO_FORCE_FLASHED.
|
private |
Definition at line 843 of file pcb_io_kicad_sexpr.cpp.
References format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), 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(), BOARD_ITEM::IsLocked(), m_out, EDA_ITEM::m_Uuid, ortho, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), VECTOR2< T >::x, and VECTOR2< T >::y.
|
private |
Definition at line 2054 of file pcb_io_kicad_sexpr.cpp.
References SHAPE_LINE_CHAIN::CPoints(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), KICAD_FORMAT::FormatUuid(), PCB_GENERATOR::GetGeneratorType(), PCB_GROUP::GetItems(), BOARD_ITEM::GetLayer(), PCB_GROUP::GetName(), PCB_GENERATOR::GetProperties(), BOARD_ITEM::IsLocked(), locked, m_out, EDA_ITEM::m_Uuid, LSET::Name(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.
|
private |
Definition at line 2024 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatUuid(), PCB_GROUP::GetItems(), PCB_GROUP::GetName(), BOARD_ITEM::IsLocked(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.
|
private |
Definition at line 1038 of file pcb_io_kicad_sexpr.cpp.
References KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), PCB_REFERENCE_IMAGE::GetImage(), BITMAP_BASE::GetImageData(), BITMAP_BASE::GetImageDataBuffer(), BOARD_ITEM::GetLayer(), PCB_REFERENCE_IMAGE::GetPosition(), BITMAP_BASE::GetScale(), image, BOARD_ITEM::IsLocked(), locked, m_out, EDA_ITEM::m_Uuid, MIME_BASE64_LENGTH, OUTPUTFORMATTER::Print(), TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.
|
private |
Definition at line 947 of file pcb_io_kicad_sexpr.cpp.
References STROKE_PARAMS::Format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), formatPolyPts(), KICAD_FORMAT::FormatUuid(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), ADVANCED_CFG::GetCfg(), EDA_SHAPE::GetEnd(), PCB_SHAPE::GetLayer(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), PCB_SHAPE::GetStroke(), EDA_SHAPE::IsFilled(), BOARD_ITEM::IsLocked(), EDA_SHAPE::IsPolyShapeValid(), m_mapping, m_out, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), pcbIUScale, OUTPUTFORMATTER::Print(), EDA_SHAPE::SHAPE_T_asString(), NETINFO_MAPPING::Translate(), and UNIMPLEMENTED_FOR.
|
private |
Definition at line 1964 of file pcb_io_kicad_sexpr.cpp.
References format(), STROKE_PARAMS::Format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), PCB_TABLE::GetBorderStroke(), PCB_TABLE::GetCells(), PCB_TABLE::GetColCount(), PCB_TABLE::GetColWidth(), BOARD_ITEM::GetLayer(), PCB_TABLE::GetRowCount(), PCB_TABLE::GetRowHeight(), PCB_TABLE::GetSeparatorsStroke(), BOARD_ITEM::IsLocked(), m_out, pcbIUScale, OUTPUTFORMATTER::Print(), PCB_TABLE::StrokeColumns(), PCB_TABLE::StrokeExternal(), PCB_TABLE::StrokeHeader(), and PCB_TABLE::StrokeRows().
|
private |
Definition at line 1084 of file pcb_io_kicad_sexpr.cpp.
References formatInternalUnits(), formatLayer(), KICAD_FORMAT::FormatUuid(), BOARD_ITEM::GetLayer(), PCB_TARGET::GetPosition(), PCB_TARGET::GetShape(), PCB_TARGET::GetSize(), PCB_TARGET::GetWidth(), m_out, EDA_ITEM::m_Uuid, and OUTPUTFORMATTER::Print().
|
private |
Definition at line 1829 of file pcb_io_kicad_sexpr.cpp.
References CTL_OMIT_HIDE, EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), formatRenderCache(), KICAD_FORMAT::FormatUuid(), EDA_TEXT::GetFont(), BOARD_ITEM::GetLayer(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetPosition(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsKeepUpright(), BOARD_ITEM::IsKnockout(), BOARD_ITEM::IsLocked(), KIFONT::FONT::IsOutline(), EDA_TEXT::IsVisible(), m_ctl, m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and RotatePoint().
|
private |
Definition at line 1891 of file pcb_io_kicad_sexpr.cpp.
References CTL_OMIT_HIDE, STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatLayer(), formatPolyPts(), formatRenderCache(), KICAD_FORMAT::FormatUuid(), EDA_SHAPE::GetEnd(), EDA_TEXT::GetFont(), PCB_SHAPE::GetLayer(), PCB_TEXTBOX::GetMarginBottom(), PCB_TEXTBOX::GetMarginLeft(), PCB_TEXTBOX::GetMarginRight(), PCB_TEXTBOX::GetMarginTop(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), PCB_SHAPE::GetStroke(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), PCB_TEXTBOX::IsBorderEnabled(), BOARD_ITEM::IsLocked(), KIFONT::FONT::IsOutline(), EDA_ANGLE::IsZero(), m_ctl, m_out, EDA_ITEM::m_Uuid, EDA_ANGLE::Normalize720(), SHAPE_POLY_SET::Outline(), PCB_TABLECELL_T, pcbIUScale, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), EDA_SHAPE::SHAPE_T_asString(), EDA_ITEM::Type(), and UNIMPLEMENTED_FOR.
|
private |
Definition at line 2151 of file pcb_io_kicad_sexpr.cpp.
References _, LSET::CuStack(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), BOARD::GetEnabledLayers(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), PCB_ARC::GetMid(), BOARD_CONNECTED_ITEM::GetNetCode(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), isDefaultTeardropParameters(), BOARD_ITEM::IsLocked(), m_mapping, m_out, EDA_ITEM::m_Uuid, LSET::Name(), PCB_ARC_T, PCB_VIA_T, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), THROW_IO_ERROR, NETINFO_MAPPING::Translate(), EDA_ITEM::Type(), UNDEFINED_DRILL_DIAMETER, via, and ZLO_FORCE_FLASHED.
|
private |
Definition at line 2270 of file pcb_io_kicad_sexpr.cpp.
References _, EDA_ANGLE::AsDegrees(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), formatLayer(), formatLayers(), formatPolyPts(), KICAD_FORMAT::FormatUuid(), ZONE::GetAssignedPriority(), BOARD_ITEM::GetBoard(), ZONE::GetBorderHatchPitch(), ADVANCED_CFG::GetCfg(), ZONE::GetCornerRadius(), ZONE::GetCornerSmoothingType(), ZONE::GetDoNotAllowCopperPour(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), 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::GetLocalClearance(), ZONE::GetMinIslandArea(), ZONE::GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), ZONE::GetNumCorners(), ZONE::GetPadConnection(), ZONE::GetTeardropAreaType(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), ZONE::GetZoneName(), ZONE::IsFilled(), ZONE::IsIsland(), BOARD_ITEM::IsLocked(), ZONE::IsOnCopperLayer(), ZONE::IsTeardropArea(), EDA_IU_SCALE::IU_PER_MM, m_mapping, m_out, EDA_ITEM::m_Uuid, LSET::Name(), ZONE::Outline(), pcbIUScale, SHAPE_POLY_SET::Polygon(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), ZONE_SETTINGS::SMOOTHING_CHAMFER, ZONE_SETTINGS::SMOOTHING_FILLET, ZONE_SETTINGS::SMOOTHING_NONE, THROW_IO_ERROR, and NETINFO_MAPPING::Translate().
|
protected |
formats the board layer information
Definition at line 634 of file pcb_io_kicad_sexpr.cpp.
References arrayDim(), B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, LSET::CuStack(), Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD::GetLayerType(), PCB_IO::m_board, m_out, Margin, LSET::Name(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), LAYER::ShowType(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.
Referenced by formatHeader(), and CLIPBOARD_IO::SaveSelection().
|
protected |
formats the General section of the file
Definition at line 614 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(), m_ctl, m_out, and OUTPUTFORMATTER::Print().
Referenced by formatHeader().
|
protected |
writes everything that comes before the board_items, like settings and layers etc
Definition at line 734 of file pcb_io_kicad_sexpr.cpp.
References formatBoardLayers(), formatGeneral(), formatNetInformation(), formatProperties(), and formatSetup().
Referenced by format().
|
private |
Definition at line 464 of file pcb_io_kicad_sexpr.cpp.
References m_out, LSET::Name(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().
Referenced by format().
|
private |
Definition at line 1363 of file pcb_io_kicad_sexpr.cpp.
References 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, m_out, LSET::Name(), paste, PCB_LAYER_ID_COUNT, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().
Referenced by format().
|
protected |
formats the Nets and Netclasses
Definition at line 704 of file pcb_io_kicad_sexpr.cpp.
References m_mapping, m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and NETINFO_MAPPING::Translate().
Referenced by formatHeader(), and CLIPBOARD_IO::SaveSelection().
|
private |
Definition at line 472 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, SHAPE_LINE_CHAIN::PointCount(), and OUTPUTFORMATTER::Print().
Referenced by format(), and formatRenderCache().
|
protected |
formats the Nets and Netclasses
Definition at line 720 of file pcb_io_kicad_sexpr.cpp.
References BOARD::GetProperties(), m_out, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().
Referenced by formatHeader().
|
private |
Definition at line 525 of file pcb_io_kicad_sexpr.cpp.
References EDA_UNIT_UTILS::FormatAngle(), formatPolyPts(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetFont(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextThickness(), m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and KIGFX::GAL::SetLineWidth().
Referenced by format().
|
protected |
formats the board setup information
Definition at line 553 of file pcb_io_kicad_sexpr.cpp.
References PCB_PLOT_PARAMS::Format(), BOARD_STACKUP::FormatBoardStackup(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), 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_HasStackup, m_out, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, OUTPUTFORMATTER::Print(), VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by formatHeader().
|
protected |
Definition at line 768 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_CurveSegCount, TEARDROP_PARAMETERS::m_Enabled, m_out, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, and OUTPUTFORMATTER::Print().
Referenced by format().
|
inlineoverridevirtual |
Returns board file description for the PCB_IO.
Reimplemented from PCB_IO.
Definition at line 287 of file pcb_io_kicad_sexpr.h.
References _HKI.
|
overridevirtual |
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
Reimplemented from PCB_IO.
Definition at line 2652 of file pcb_io_kicad_sexpr.cpp.
References getFootprint().
|
protected |
Definition at line 2624 of file pcb_io_kicad_sexpr.cpp.
References FP_CACHE::GetFootprints(), 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_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, and PCB_IO_IPC2581.
Definition at line 82 of file pcb_io.cpp.
References NOT_IMPLEMENTED.
|
inlineoverridevirtual |
Get the descriptor for the library container that this IO plugin operates on.
Implements IO_BASE.
Definition at line 301 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 296 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 #PLUGIN 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 172 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 2835 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 71 of file io_base.h.
References IO_BASE::m_name.
Referenced by SCH_IO_ALTIUM::ParseLibFile().
|
inline |
Definition at line 369 of file pcb_io_kicad_sexpr.h.
References STRING_FORMATTER::Clear(), STRING_FORMATTER::GetString(), and 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.
aLibraryPath | 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 2676 of file pcb_io_kicad_sexpr.cpp.
References Parse().
|
protected |
Definition at line 2575 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(), getFootprint(), IsLibraryWritable(), CLIPBOARD_IO::LoadBoard(), PCB_IO_KICAD_SEXPR(), CLIPBOARD_IO::SaveBoard(), and 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 2936 of file pcb_io_kicad_sexpr.cpp.
References init(), FP_CACHE::IsWritable(), m_cache, and validateCache().
|
overridevirtual |
Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one.
This may be used to load an entire new BOARD, or to augment an existing one if aAppendToMe is not NULL.
aFileName | is the name of the file to use as input and may be foreign in nature or native in nature. |
aAppendToMe | is an existing BOARD to append to, but if NULL then this means "do not append, rather load anew". |
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. |
Reimplemented from PCB_IO.
Definition at line 2509 of file pcb_io_kicad_sexpr.cpp.
References _, DoLoad(), PROGRESS_REPORTER::KeepRefreshing(), IO_BASE::m_progressReporter, FILE_LINE_READER::ReadLine(), PROGRESS_REPORTER::Report(), FILE_LINE_READER::Rewind(), BOARD::SetFileName(), and THROW_IO_ERROR.
Referenced by PNS_LOG_FILE::Load().
BOARD_ITEM * PCB_IO_KICAD_SEXPR::Parse | ( | const wxString & | aClipboardSourceInput | ) |
Definition at line 340 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 ImportFootprint(), and CLIPBOARD_IO::Parse().
|
virtualinherited |
If possible, prefetches the specified library (e.g.
performing downloads). Does not parse. Threadsafe.
This is a no-op for libraries that cannot be prefetched. Plugins that cannot prefetch need not override this; a default no-op is provided.
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. |
IO_ERROR | if there is an error prefetching the library. |
Definition at line 104 of file pcb_io.cpp.
|
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 298 of file pcb_io_kicad_sexpr.cpp.
References _, OUTPUTFORMATTER::Finish(), Format(), GetMajorMinorVersion(), BOARD::GroupsSanityCheck(), init(), PCB_IO::m_board, m_mapping, m_out, m_queryUserCallback, OUTPUTFORMATTER::Print(), NETINFO_MAPPING::SetBoard(), and SEXPR_BOARD_FILE_VERSION.
Referenced by KI_TEST::DumpBoardToFile(), and ROUTER_TOOL::saveRouterDebugLog().
|
inline |
Definition at line 379 of file pcb_io_kicad_sexpr.h.
References m_out.
Referenced by FP_CACHE::Save().
|
inlinevirtualinherited |
Set an optional progress reporter.
Reimplemented in SCH_IO_CADSTAR_ARCHIVE.
Definition at line 81 of file io_base.h.
References IO_BASE::m_progressReporter.
Referenced by PCB_CONTROL::AppendBoard().
|
inlinevirtualinherited |
Registers a KIDIALOG callback for collecting info from the user.
Definition at line 98 of file pcb_io.h.
Referenced by PCB_CONTROL::AppendBoard().
|
inlineoverride |
Definition at line 306 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 76 of file io_base.h.
References IO_BASE::m_reporter.
|
protected |
Definition at line 2583 of file pcb_io_kicad_sexpr.cpp.
References FP_CACHE, FP_CACHE::IsModified(), FP_CACHE::IsPath(), FP_CACHE::Load(), and m_cache.
Referenced by FootprintDelete(), FootprintEnumerate(), FootprintSave(), getFootprint(), and IsLibraryWritable().
|
friend |
Definition at line 448 of file pcb_io_kicad_sexpr.h.
Referenced by CreateLibrary(), and validateCache().
|
protectedinherited |
The board BOARD being worked on, no ownership here.
Definition at line 343 of file pcb_io.h.
Referenced by PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), formatBoardLayers(), PCB_IO_EAGLE::init(), PCB_IO_KICAD_LEGACY::init(), init(), PCB_IO_KICAD_LEGACY::loadAllSections(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EAGLE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), PCB_IO_KICAD_LEGACY::LoadBoard(), PCB_IO_PCAD::LoadBoard(), PCB_IO_KICAD_LEGACY::loadDIMENSION(), PCB_IO_KICAD_LEGACY::loadGENERAL(), PCB_IO_EAGLE::loadLayerDefs(), LP_CACHE::LoadModules(), 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_KICAD_LEGACY::loadSETUP(), PCB_IO_KICAD_LEGACY::loadSHEET(), PCB_IO_KICAD_LEGACY::loadTrackList(), PCB_IO_KICAD_LEGACY::loadZONE_CONTAINER(), CLIPBOARD_IO::SaveBoard(), SaveBoard(), CLIPBOARD_IO::SaveSelection(), and CLIPBOARD_IO::SetBoard().
|
protected |
Footprint library cache.
Definition at line 453 of file pcb_io_kicad_sexpr.h.
Referenced by CreateLibrary(), DeleteLibrary(), FootprintDelete(), FootprintEnumerate(), FootprintSave(), getFootprint(), IsLibraryWritable(), validateCache(), and ~PCB_IO_KICAD_SEXPR().
|
protected |
Definition at line 460 of file pcb_io_kicad_sexpr.h.
Referenced by FootprintSave(), format(), and formatGeneral().
|
protected |
for throwing exceptions
Definition at line 451 of file pcb_io_kicad_sexpr.h.
|
protected |
for saves only, name is in m_reader for loads
Definition at line 456 of file pcb_io_kicad_sexpr.h.
|
protected |
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
Definition at line 461 of file pcb_io_kicad_sexpr.h.
Referenced by format(), formatNetInformation(), CLIPBOARD_IO::SaveBoard(), SaveBoard(), CLIPBOARD_IO::SaveSelection(), and ~PCB_IO_KICAD_SEXPR().
|
protectedinherited |
|
protected |
output any Format()s to this, no ownership
Definition at line 459 of file pcb_io_kicad_sexpr.h.
Referenced by CLIPBOARD_IO::CLIPBOARD_IO(), format(), formatBoardLayers(), formatGeneral(), formatLayer(), formatLayers(), formatNetInformation(), formatPolyPts(), formatProperties(), formatRenderCache(), formatSetup(), formatTeardropParameters(), PCB_IO_KICAD_SEXPR(), CLIPBOARD_IO::SaveBoard(), SaveBoard(), and SetOutputFormatter().
|
protectedinherited |
Progress reporter to track the progress of the operation, may be nullptr.
Definition at line 213 of file io_base.h.
Referenced by SCH_IO_EAGLE::checkpoint(), SCH_IO_KICAD_LEGACY::checkpoint(), SCH_IO_EAGLE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_IPC2581::generateAvlSection(), PCB_IO_IPC2581::generateBOMSection(), PCB_IO_IPC2581::generateContentSection(), PCB_IO_IPC2581::generateEcadSection(), PCB_IO_IPC2581::generateHistorySection(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), LoadBoard(), SCH_IO_KICAD_LEGACY::loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_EAGLE::loadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), PCB_IO_IPC2581::SaveBoard(), IO_BASE::SetProgressReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().
|
protectedinherited |
Properties passed via Save() or Load(), no ownership, may be NULL.
Definition at line 346 of file pcb_io.h.
Referenced by PCB_IO_EAGLE::init(), PCB_IO_GEDA::init(), PCB_IO_KICAD_LEGACY::init(), init(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), and PCB_IO_PCAD::LoadBoard().
|
protected |
Definition at line 464 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 210 of file io_base.h.
Referenced by SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), SCH_IO_EAGLE::loadInstance(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseCircle(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseDesignator(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_IO_ALTIUM::ParseFileName(), SCH_IO_ALTIUM::ParseHarnessConnector(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseImplementation(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePin(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_ALTIUM::ParseRecord(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetEntry(), SCH_IO_ALTIUM::ParseSheetName(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseStorage(), SCH_IO_ALTIUM::SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_EAGLE::SCH_IO_EAGLE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYEDAPRO::SCH_IO_EASYEDAPRO(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), IO_BASE::SetReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().
|
protected |
Definition at line 458 of file pcb_io_kicad_sexpr.h.
Referenced by GetStringOutput(), and PCB_IO_KICAD_SEXPR().