CLIPBOARD_IO Class Reference

#include <kicad_clipboard.h>

Inheritance diagram for CLIPBOARD_IO:

Public Member Functions
	CLIPBOARD_IO ()
	~CLIPBOARD_IO ()
void	SetWriter (std::function< void(const wxString &)> aWriter)
void	SetReader (std::function< wxString()> aReader)
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	SaveSelection (const PCB_SELECTION &selected, bool isFootprintEditor)
BOARD_ITEM *	Parse ()
BOARD *	LoadBoard (const wxString &aFileName, BOARD *aAppendToMe, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) override
	Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one.
void	SetBoard (BOARD *aBoard)
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
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.
bool	CanReadBoard (const wxString &aFileName) const override
	Checks if this PCB_IO can read the specified board file.
BOARD *	DoLoad (LINE_READER &aReader, BOARD *aAppendToMe, 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.
bool	FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
	Check for the existence of a footprint.
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.
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.
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.
void	Format (const BOARD_ITEM *aItem) 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 std::vector< FOOTPRINT * >	GetImportedCachedLibraryFootprints ()
	Return a container with the cached library footprints generated in the last call to Load.
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	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
virtual void	AdvanceProgressPhase ()

Protected Member Functions
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	formatGeneral (const BOARD *aBoard) const
	formats the General section of the file
void	formatBoardLayers (const BOARD *aBoard) const
	formats the board layer information
void	formatNetInformation (const BOARD *aBoard) const
	formats the Nets and Netclasses
void	formatProperties (const BOARD *aBoard) const
	formats the Nets and Netclasses
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.
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 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.

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_SHAPE *aSegment) const
void	format (const PCB_TARGET *aTarget) const
void	format (const FOOTPRINT *aFootprint) const
void	format (const PAD *aPad) 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_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) const

Static Private Member Functions
static void	clipboardWriter (const wxString &aData)
static wxString	clipboardReader ()

Private Attributes
STRING_FORMATTER	m_formatter
std::function< void(const wxString &)>	m_writer
std::function< wxString()>	m_reader

Detailed Description

Definition at line 41 of file kicad_clipboard.h.

Constructor & Destructor Documentation

CLIPBOARD_IO()

CLIPBOARD_IO::CLIPBOARD_IO

(

)

Definition at line 45 of file kicad_clipboard.cpp.

References m_formatter, and PCB_IO_KICAD_SEXPR::m_out.

~CLIPBOARD_IO()

CLIPBOARD_IO::~CLIPBOARD_IO

(

)

Definition at line 55 of file kicad_clipboard.cpp.

Member Function Documentation

AdvanceProgressPhase()

void IO_BASE::AdvanceProgressPhase ( )

virtualinherited

Definition at line 133 of file io_base.cpp.

References _, PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::KeepRefreshing(), IO_BASE::m_progressReporter, and THROW_IO_ERROR.

Referenced by EAGLE_BASE::AdvanceProgressPhase().

CanReadBoard()

bool PCB_IO_KICAD_SEXPR::CanReadBoard ( const wxString &  aFileName ) const

overridevirtualinherited

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 288 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO::CanReadBoard(), PCB_IO_KICAD_SEXPR_PARSER::IsValidBoardHeader(), and PCB_IO_KICAD_SEXPR::m_queryUserCallback.

CanReadFootprint()

bool PCB_IO::CanReadFootprint ( const wxString &  aFileName ) const

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, PCB_IO_KICAD_LEGACY, and PCB_IO_ODBPP.

Definition at line 58 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().

CanReadLibrary()

bool IO_BASE::CanReadLibrary ( const wxString &  aFileName ) const

virtualinherited

Checks if this IO object can read the specified library file/directory.

If not overridden, 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, PCB_IO_IPC2581, PCB_IO_ODBPP, and SCH_IO_KICAD_SEXPR.

Definition at line 71 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(), PCB_IO_EAGLE::CanReadLibrary(), and SCH_IO_KICAD_SEXPR::CanReadLibrary().

clipboardReader()

wxString CLIPBOARD_IO::clipboardReader ( )

staticprivate

Definition at line 97 of file kicad_clipboard.cpp.

clipboardWriter()

void CLIPBOARD_IO::clipboardWriter ( const wxString &  aData )

staticprivate

Definition at line 66 of file kicad_clipboard.cpp.

References ignore_unused().

CreateLibrary()

void PCB_IO_KICAD_SEXPR::CreateLibrary ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

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.

Parameters

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.

Exceptions

IO_ERROR

if there is a problem finding the library, or creating it.

Reimplemented from IO_BASE.

Definition at line 3139 of file pcb_io_kicad_sexpr.cpp.

References _, PCB_IO_KICAD_SEXPR::FP_CACHE, PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_SEXPR::m_cache, FP_CACHE::Save(), and THROW_IO_ERROR.

DeleteLibrary()

bool PCB_IO_KICAD_SEXPR::DeleteLibrary ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

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.

Parameters

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.

Returns

true if library deleted, false if library did not exist.

Exceptions

IO_ERROR

if there is a problem deleting an existing library.

Reimplemented from IO_BASE.

Definition at line 3158 of file pcb_io_kicad_sexpr.cpp.

References _, FP_CACHE::IsPath(), FILEEXT::KiCadFootprintFileExtension, PCB_IO_KICAD_SEXPR::m_cache, THROW_IO_ERROR, and traceKicadPcbPlugin.

DoLoad()

BOARD * PCB_IO_KICAD_SEXPR::DoLoad ( LINE_READER &  aReader, BOARD *  aAppendToMe, const std::map< std::string, UTF8 > *  aProperties, PROGRESS_REPORTER *  aProgressReporter, unsigned  aLineCount  )

inherited

Definition at line 2826 of file pcb_io_kicad_sexpr.cpp.

References _, PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), PCB_IO_KICAD_SEXPR::m_queryUserCallback, PCB_IO_KICAD_SEXPR_PARSER::Parse(), and THROW_PARSE_ERROR.

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), and PCB_IO_KICAD_SEXPR::LoadBoard().

FootprintDelete()

void PCB_IO_KICAD_SEXPR::FootprintDelete ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

Delete aFootprintName from the library at aLibraryPath.

Parameters

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.

Exceptions

IO_ERROR

if there is a problem finding the footprint or the library, or deleting it.

Reimplemented from PCB_IO.

Definition at line 3112 of file pcb_io_kicad_sexpr.cpp.

References _, PCB_IO_KICAD_SEXPR::init(), FP_CACHE::IsWritable(), PCB_IO_KICAD_SEXPR::m_cache, FP_CACHE::Remove(), THROW_IO_ERROR, and PCB_IO_KICAD_SEXPR::validateCache().

FootprintEnumerate()

void PCB_IO_KICAD_SEXPR::FootprintEnumerate ( wxArrayString &  aFootprintNames, const wxString &  aLibraryPath, bool  aBestEfforts, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

Return a list of footprint names contained within the library at aLibraryPath.

Parameters

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.

Exceptions

IO_ERROR

if the library cannot be found, or footprint cannot be loaded.

Reimplemented from PCB_IO.

Definition at line 2886 of file pcb_io_kicad_sexpr.cpp.

References FP_CACHE::GetFootprints(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_SEXPR::m_cache, THROW_IO_ERROR, PCB_IO_KICAD_SEXPR::validateCache(), and IO_ERROR::What().

FootprintExists()

bool PCB_IO_KICAD_SEXPR::FootprintExists ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

Check for the existence of a footprint.

Reimplemented from PCB_IO.

Definition at line 2951 of file pcb_io_kicad_sexpr.cpp.

References FILEEXT::KiCadFootprintFileExtension.

FootprintLoad()

FOOTPRINT * PCB_IO_KICAD_SEXPR::FootprintLoad ( const wxString &  aLibraryPath, const wxString &  aFootprintName, bool  aKeepUUID = false, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.

Parameters

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

Returns

the FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

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 2988 of file pcb_io_kicad_sexpr.cpp.

References FOOTPRINT::Clone(), copy, FOOTPRINT::Duplicate(), PCB_IO_KICAD_SEXPR::getFootprint(), IGNORE_PARENT_GROUP, and fontconfig::FONTCONFIG::SetReporter().

FootprintSave()

void PCB_IO_KICAD_SEXPR::FootprintSave ( const wxString &  aLibraryPath, const FOOTPRINT *  aFootprint, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

Write aFootprint to an existing library located at aLibraryPath.

If a footprint by the same name already exists, it is replaced.

Parameters

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.

Exceptions

IO_ERROR

if there is a problem saving.

Reimplemented from PCB_IO.

Definition at line 3014 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(), PCB_IO_KICAD_SEXPR::init(), FP_CACHE::IsWritable(), FILEEXT::KiCadFootprintFileExtension, Kiface(), KIFACE_BASE::KifaceSettings(), PCB_IO_KICAD_SEXPR::m_cache, PCB_IO_KICAD_SEXPR::m_ctl, PCBNEW_SETTINGS::m_FlipDirection, Pgm(), ReplaceIllegalFileNameChars(), WX_FILENAME::ResolvePossibleSymlinks(), FP_CACHE::Save(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), THROW_IO_ERROR, traceKicadPcbPlugin, PCB_IO_KICAD_SEXPR::validateCache(), and UTF8::wx_str().

Referenced by KI_TEST::DumpFootprintToFile().

format() [1/15]

void PCB_IO_KICAD_SEXPR::format ( const BOARD *  aBoard ) const

privateinherited

Definition at line 793 of file pcb_io_kicad_sexpr.cpp.

References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::ClearEmbeddedFiles(), CTL_FOR_BOARD, BOARD::Drawings(), EMBEDDED_FILES::EmbeddedFileMap(), BOARD::Footprints(), PCB_IO_KICAD_SEXPR::Format(), PCB_IO_KICAD_SEXPR::formatHeader(), BOARD::Generators(), EMBEDDED_FILES::GetAreFontsEmbedded(), BOARD::GetEmbeddedFiles(), FOOTPRINT::GetEmbeddedFiles(), group, BOARD::Groups(), EMBEDDED_FILES::IsEmpty(), PCB_IO_KICAD_SEXPR::m_ctl, PCB_IO_KICAD_SEXPR::m_out, OUTPUTFORMATTER::Print(), BOARD::Tracks(), EMBEDDED_FILES::WriteEmbeddedFiles(), and BOARD::Zones().

Referenced by PCB_IO_KICAD_SEXPR::Format(), PCB_IO_KICAD_SEXPR::format(), and PCB_IO_KICAD_SEXPR::formatSetup().

Format()

void PCB_IO_KICAD_SEXPR::Format ( const BOARD_ITEM *  aItem ) const

inherited

Output aItem to aFormatter in s-expression format.

Parameters

aItem

A pointer the an BOARD_ITEM object to format.

Exceptions

IO_ERROR

on write error.

Definition at line 379 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::format(), KIGFX::VIEW_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(), PCB_IO_KICAD_SEXPR::format(), FP_CACHE::Save(), SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), and SaveSelection().

format() [2/15]

void PCB_IO_KICAD_SEXPR::format ( const FOOTPRINT *  aFootprint ) const

privateinherited

Definition at line 1146 of file pcb_io_kicad_sexpr.cpp.

References FOOTPRINT::AllowMissingCourtyard(), FOOTPRINT::AllowSolderMaskBridges(), KIID_PATH::AsString(), CTL_FOR_BOARD, CTL_OMIT_AT, CTL_OMIT_FOOTPRINT_VERSION, CTL_OMIT_INITIAL_COMMENTS, CTL_OMIT_LIBNAME, CTL_OMIT_PATH, CTL_OMIT_UUIDS, LIB_ID::Format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), KICAD_FORMAT::FormatUuid(), FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, EMBEDDED_FILES::GetAreFontsEmbedded(), FOOTPRINT::GetAttributes(), COMPONENT_CLASS::GetConstituentClasses(), FOOTPRINT::GetDuplicatePadNumbersAreJumpers(), FOOTPRINT::GetEmbeddedFiles(), 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::GetStaticComponentClass(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), EMBEDDED_FILES::IsEmpty(), FOOTPRINT::IsLocked(), FOOTPRINT::IsNetTie(), FOOTPRINT::IsPlaced(), EDA_ANGLE::IsZero(), FOOTPRINT::JumperPadGroups(), PCB_IO_KICAD_SEXPR::m_ctl, PCB_IO_KICAD_SEXPR::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(), EMBEDDED_FILES::WriteEmbeddedFiles(), and FOOTPRINT::Zones().

format() [3/15]

void PCB_IO_KICAD_SEXPR::format ( const PAD *  aPad ) const

privateinherited

Definition at line 1509 of file pcb_io_kicad_sexpr.cpp.

References _, PADSTACK::ALL_LAYERS, ANGLE_45, ANGLE_90, B_Cu, PADSTACK::BackOuterLayers(), PADSTACK::Clearance(), PADSTACK::CONVEXHULL, CTL_OMIT_PAD_NETS, LSET::CuStack(), delta, F_Cu, EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayers(), KICAD_FORMAT::FormatOptBool(), PCB_IO_KICAD_SEXPR::formatPolyPts(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), PADSTACK::FRONT_INNER_BACK, PADSTACK::FrontOuterLayers(), 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(), PAD::GetPinFunction(), PAD::GetPinType(), PAD::GetPrimitives(), PAD::GetProperty(), PAD::GetRemoveUnconnected(), PAD::GetRoundRectRadiusRatio(), PAD::GetShape(), PAD::GetSize(), BOARD_CONNECTED_ITEM::GetTeardropParams(), PAD::GetThermalSpokeAngle(), PAD::GetZoneLayerOverride(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, PADSTACK::INNER_LAYERS, isDefaultTeardropParameters(), EDA_ANGLE::IsZero(), PCB_IO_KICAD_SEXPR::m_ctl, PCB_IO_KICAD_SEXPR::m_mapping, PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, MAX_CU_LAYERS, PADSTACK::Mode(), LSET::Name(), PADSTACK::NORMAL, SHAPE_POLY_SET::Outline(), PAD::Padstack(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, PADSTACK::ThermalGap(), PADSTACK::ThermalSpokeAngle(), PADSTACK::ThermalSpokeWidth(), THROW_IO_ERROR, NETINFO_MAPPING::Translate(), NETINFO_LIST::UNCONNECTED, VECTOR2< T >::x, VECTOR2< T >::y, ZLO_FORCE_FLASHED, and PADSTACK::ZoneConnection().

format() [4/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_DIMENSION_BASE *  aDimension ) const

privateinherited

Definition at line 862 of file pcb_io_kicad_sexpr.cpp.

References center, PCB_IO_KICAD_SEXPR::format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::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(), BOARD_ITEM::IsLocked(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, ortho, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), VECTOR2< T >::x, and VECTOR2< T >::y.

format() [5/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_GENERATOR *  aGenerator ) const

privateinherited

Definition at line 2240 of file pcb_io_kicad_sexpr.cpp.

References KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatPolyPts(), KICAD_FORMAT::FormatUuid(), PCB_GENERATOR::GetGeneratorType(), EDA_GROUP::GetItems(), BOARD_ITEM::GetLayer(), EDA_GROUP::GetName(), PCB_GENERATOR::GetProperties(), BOARD_ITEM::IsLocked(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, LSET::Name(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.

format() [6/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_GROUP *  aGroup ) const

privateinherited

Definition at line 2207 of file pcb_io_kicad_sexpr.cpp.

References UTF8::c_str(), LIB_ID::Format(), KICAD_FORMAT::FormatBool(), KICAD_FORMAT::FormatUuid(), EDA_GROUP::GetDesignBlockLibId(), EDA_GROUP::GetItems(), EDA_GROUP::GetName(), EDA_GROUP::HasDesignBlockLink(), BOARD_ITEM::IsLocked(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

format() [7/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_REFERENCE_IMAGE *  aBitmap ) const

privateinherited

Definition at line 1098 of file pcb_io_kicad_sexpr.cpp.

References KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), KICAD_FORMAT::FormatStreamData(), KICAD_FORMAT::FormatUuid(), REFERENCE_IMAGE::GetImage(), BITMAP_BASE::GetImageData(), REFERENCE_IMAGE::GetImageScale(), BOARD_ITEM::GetLayer(), PCB_REFERENCE_IMAGE::GetPosition(), PCB_REFERENCE_IMAGE::GetReferenceImage(), image, BOARD_ITEM::IsLocked(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), BITMAP_BASE::SaveImageData(), VECTOR2< T >::x, and VECTOR2< T >::y.

format() [8/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_SHAPE *  aSegment ) const

privateinherited

Definition at line 977 of file pcb_io_kicad_sexpr.cpp.

References STROKE_PARAMS::Format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatPolyPts(), KICAD_FORMAT::FormatUuid(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), PCB_SHAPE::GetLayer(), PCB_SHAPE::GetLayerSet(), PCB_SHAPE::GetLocalSolderMaskMargin(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), PCB_SHAPE::GetStroke(), PCB_SHAPE::HasSolderMask(), IsExternalCopperLayer(), BOARD_ITEM::IsLocked(), EDA_SHAPE::IsPolyShapeValid(), PCB_IO_KICAD_SEXPR::m_mapping, PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), pcbIUScale, OUTPUTFORMATTER::Print(), EDA_SHAPE::SHAPE_T_asString(), NETINFO_MAPPING::Translate(), and UNIMPLEMENTED_FOR.

format() [9/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_TABLE *  aTable ) const

privateinherited

Definition at line 2154 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::format(), STROKE_PARAMS::Format(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::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(), PCB_IO_KICAD_SEXPR::m_out, pcbIUScale, OUTPUTFORMATTER::Print(), PCB_TABLE::StrokeColumns(), PCB_TABLE::StrokeExternal(), PCB_TABLE::StrokeHeaderSeparator(), and PCB_TABLE::StrokeRows().

format() [10/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_TARGET *  aTarget ) const

privateinherited

Definition at line 1130 of file pcb_io_kicad_sexpr.cpp.

References formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), KICAD_FORMAT::FormatUuid(), BOARD_ITEM::GetLayer(), PCB_TARGET::GetPosition(), PCB_TARGET::GetShape(), PCB_TARGET::GetSize(), PCB_TARGET::GetWidth(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, and OUTPUTFORMATTER::Print().

format() [11/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_TEXT *  aText ) const

privateinherited

Definition at line 2018 of file pcb_io_kicad_sexpr.cpp.

References CTL_OMIT_COLOR, CTL_OMIT_HYPERLINK, EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::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(), PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and RotatePoint().

format() [12/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_TEXTBOX *  aTextBox ) const

privateinherited

Definition at line 2082 of file pcb_io_kicad_sexpr.cpp.

References STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatPolyPts(), PCB_IO_KICAD_SEXPR::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::IsKnockout(), BOARD_ITEM::IsLocked(), KIFONT::FONT::IsOutline(), EDA_ANGLE::IsZero(), PCB_IO_KICAD_SEXPR::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.

format() [13/15]

void PCB_IO_KICAD_SEXPR::format ( const PCB_TRACK *  aTrack ) const

privateinherited

Definition at line 2338 of file pcb_io_kicad_sexpr.cpp.

References _, B_Cu, PADSTACK::BackOuterLayers(), LSET::CuStack(), PADSTACK::Drill(), F_Cu, KICAD_FORMAT::FormatBool(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), KICAD_FORMAT::FormatOptBool(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), KICAD_FORMAT::FormatUuid(), PADSTACK::FRONT_INNER_BACK, PADSTACK::FrontOuterLayers(), BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), PCB_TRACK::GetLayerSet(), PCB_TRACK::GetLocalSolderMaskMargin(), PCB_ARC::GetMid(), BOARD_CONNECTED_ITEM::GetNetCode(), 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(), PADSTACK::KEEP_ALL, PCB_IO_KICAD_SEXPR::m_mapping, PCB_IO_KICAD_SEXPR::m_out, EDA_ITEM::m_Uuid, PADSTACK::Mode(), LSET::Name(), PADSTACK::NORMAL, PCB_ARC_T, PCB_VIA_T, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), PADSTACK::REMOVE_ALL, PADSTACK::REMOVE_EXCEPT_START_AND_END, PADSTACK::Size(), THROW_IO_ERROR, NETINFO_MAPPING::Translate(), EDA_ITEM::Type(), UNDEFINED_DRILL_DIAMETER, via, VECTOR2< T >::x, and ZLO_FORCE_FLASHED.

format() [14/15]

void PCB_IO_KICAD_SEXPR::format ( const ZONE *  aZone ) const

privateinherited

Definition at line 2527 of file pcb_io_kicad_sexpr.cpp.

References _, EDA_ANGLE::AsDegrees(), chain, PCB_IO_KICAD_SEXPR::format(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatPolyPts(), KICAD_FORMAT::FormatUuid(), 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::GetLocalClearance(), ZONE::GetMinIslandArea(), ZONE::GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), ZONE::GetNumCorners(), ZONE::GetPadConnection(), ZONE::GetPlacementAreaEnabled(), ZONE::GetPlacementAreaSource(), ZONE::GetPlacementAreaSourceType(), 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, ZONE::LayerProperties(), PCB_IO_KICAD_SEXPR::m_mapping, PCB_IO_KICAD_SEXPR::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().

format() [15/15]

void PCB_IO_KICAD_SEXPR::format ( const ZONE_LAYER_PROPERTIES &  aZoneLayerProperties, int  aNestLevel, PCB_LAYER_ID  aLayer  ) const

privateinherited

Definition at line 2756 of file pcb_io_kicad_sexpr.cpp.

References formatInternalUnits(), ZONE_LAYER_PROPERTIES::hatching_offset, PCB_IO_KICAD_SEXPR::m_out, LSET::Name(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

formatBoardLayers()

void PCB_IO_KICAD_SEXPR::formatBoardLayers ( const BOARD *  aBoard ) const

protectedinherited

formats the board layer information

Definition at line 661 of file pcb_io_kicad_sexpr.cpp.

References LSET::CuStack(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD::GetLayerType(), IsCopperLayer(), LT_BACK, LT_FRONT, PCB_IO::m_board, PCB_IO_KICAD_SEXPR::m_out, LSET::Name(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LAYER::ShowType(), LSET::TechAndUserUIOrder(), and User_1.

Referenced by PCB_IO_KICAD_SEXPR::formatHeader(), and SaveSelection().

formatGeneral()

void PCB_IO_KICAD_SEXPR::formatGeneral ( const BOARD *  aBoard ) const

protectedinherited

formats the General section of the file

Definition at line 643 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(), PCB_IO_KICAD_SEXPR::m_out, and OUTPUTFORMATTER::Print().

Referenced by PCB_IO_KICAD_SEXPR::formatHeader().

formatHeader()

void PCB_IO_KICAD_SEXPR::formatHeader ( const BOARD *  aBoard ) const

protectedinherited

writes everything that comes before the board_items, like settings and layers etc

Definition at line 738 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::formatBoardLayers(), PCB_IO_KICAD_SEXPR::formatGeneral(), PCB_IO_KICAD_SEXPR::formatNetInformation(), PCB_IO_KICAD_SEXPR::formatProperties(), and PCB_IO_KICAD_SEXPR::formatSetup().

Referenced by PCB_IO_KICAD_SEXPR::format().

formatLayer()

void PCB_IO_KICAD_SEXPR::formatLayer ( PCB_LAYER_ID  aLayer, bool  aIsKnockout = false  ) const

privateinherited

Definition at line 482 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::m_out, LSET::Name(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by PCB_IO_KICAD_SEXPR::format().

formatLayers()

void PCB_IO_KICAD_SEXPR::formatLayers ( LSET  aLayerMask, bool  aEnumerateLayers  ) const

privateinherited

Definition at line 1428 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, BOARD::GetCopperLayerCount(), PCB_IO::m_board, PCB_IO_KICAD_SEXPR::m_out, MAX_CU_LAYERS, LSET::Name(), paste, PCB_LAYER_ID_COUNT, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by PCB_IO_KICAD_SEXPR::format().

formatNetInformation()

void PCB_IO_KICAD_SEXPR::formatNetInformation ( const BOARD *  aBoard ) const

protectedinherited

formats the Nets and Netclasses

Definition at line 713 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::m_mapping, PCB_IO_KICAD_SEXPR::m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and NETINFO_MAPPING::Translate().

Referenced by PCB_IO_KICAD_SEXPR::formatHeader(), and SaveSelection().

formatPolyPts()

void PCB_IO_KICAD_SEXPR::formatPolyPts ( const SHAPE_LINE_CHAIN &  outline, const FOOTPRINT *  aParentFP = nullptr  ) const

privateinherited

Definition at line 490 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(), PCB_IO_KICAD_SEXPR::m_out, SHAPE_LINE_CHAIN::PointCount(), and OUTPUTFORMATTER::Print().

Referenced by PCB_IO_KICAD_SEXPR::format(), and PCB_IO_KICAD_SEXPR::formatRenderCache().

formatProperties()

void PCB_IO_KICAD_SEXPR::formatProperties ( const BOARD *  aBoard ) const

protectedinherited

formats the Nets and Netclasses

Definition at line 727 of file pcb_io_kicad_sexpr.cpp.

References BOARD::GetProperties(), PCB_IO_KICAD_SEXPR::m_out, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by PCB_IO_KICAD_SEXPR::formatHeader().

formatRenderCache()

void PCB_IO_KICAD_SEXPR::formatRenderCache ( const EDA_TEXT *  aText ) const

privateinherited

Definition at line 525 of file pcb_io_kicad_sexpr.cpp.

References EDA_UNIT_UTILS::FormatAngle(), PCB_IO_KICAD_SEXPR::formatPolyPts(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetFont(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextThickness(), PCB_IO_KICAD_SEXPR::m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and KIGFX::GAL::SetLineWidth().

Referenced by PCB_IO_KICAD_SEXPR::format().

formatSetup()

void PCB_IO_KICAD_SEXPR::formatSetup ( const BOARD *  aBoard ) const

protectedinherited

formats the board setup information

Definition at line 553 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::format(), PCB_PLOT_PARAMS::Format(), BOARD_STACKUP::FormatBoardStackup(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), formatInternalUnits(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), 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, ZONE_SETTINGS::m_LayerProperties, PCB_IO_KICAD_SEXPR::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, OUTPUTFORMATTER::Print(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_IO_KICAD_SEXPR::formatHeader().

formatTeardropParameters()

void PCB_IO_KICAD_SEXPR::formatTeardropParameters ( const TEARDROP_PARAMETERS &  tdParams ) const

protectedinherited

Definition at line 772 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, PCB_IO_KICAD_SEXPR::m_out, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, and OUTPUTFORMATTER::Print().

Referenced by PCB_IO_KICAD_SEXPR::format().

GetBoardFileDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_KICAD_SEXPR::GetBoardFileDesc ( ) const

inlineoverridevirtualinherited

Returns board file description for the PCB_IO.

Reimplemented from PCB_IO.

Definition at line 306 of file pcb_io_kicad_sexpr.h.

References _HKI.

GetEnumeratedFootprint()

const FOOTPRINT * PCB_IO_KICAD_SEXPR::GetEnumeratedFootprint ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

Reimplemented from PCB_IO.

Definition at line 2943 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::getFootprint().

getFootprint()

const FOOTPRINT * PCB_IO_KICAD_SEXPR::getFootprint ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const std::map< std::string, UTF8 > *  aProperties, bool  checkModified  )

protectedinherited

Definition at line 2916 of file pcb_io_kicad_sexpr.cpp.

References FP_CACHE::GetFootprints(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_SEXPR::m_cache, and PCB_IO_KICAD_SEXPR::validateCache().

Referenced by PCB_IO_KICAD_SEXPR::FootprintLoad(), and PCB_IO_KICAD_SEXPR::GetEnumeratedFootprint().

GetImportedCachedLibraryFootprints()

std::vector< FOOTPRINT * > PCB_IO::GetImportedCachedLibraryFootprints ( )

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.

Returns

Footprints (caller owns the objects)

Reimplemented in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_IPC2581, and PCB_IO_ODBPP.

Definition at line 81 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

GetLibraryDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_KICAD_SEXPR::GetLibraryDesc ( ) const

inlineoverridevirtualinherited

Get the descriptor for the library container that this IO plugin operates on.

Returns

File descriptor for the container of the library elements

Implements IO_BASE.

Definition at line 320 of file pcb_io_kicad_sexpr.h.

References _HKI.

GetLibraryFileDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_KICAD_SEXPR::GetLibraryFileDesc ( ) const

inlineoverridevirtualinherited

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().

Returns

File descriptor for the library elements

Reimplemented from IO_BASE.

Definition at line 315 of file pcb_io_kicad_sexpr.h.

References _HKI.

GetLibraryOptions()

void PCB_IO::GetLibraryOptions ( std::map< std::string, UTF8 > *  aListToAppendTo ) const

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.

Note

Since aListToAppendTo is a #PROPERTIES object, all options will be unique and last guy wins.

Parameters

aListToAppendTo

holds a tuple of option This eventually is what shows up into the fp-lib-table "options" field, possibly combined with others. internationalized description The internationalized description is displayed in DIALOG_PLUGIN_OPTIONS. It may be multi-line and be quite explanatory of the option. 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 168 of file pcb_io.cpp.

References _, and IO_BASE::GetLibraryOptions().

GetLibraryTimestamp()

long long PCB_IO_KICAD_SEXPR::GetLibraryTimestamp ( const wxString &  aLibraryPath ) const

overridevirtualinherited

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 3133 of file pcb_io_kicad_sexpr.cpp.

References FP_CACHE::GetTimestamp().

GetName()

const wxString & IO_BASE::GetName ( ) const

inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 79 of file io_base.h.

Referenced by SCH_IO_ALTIUM::ParseLibFile().

GetStringOutput()

std::string PCB_IO_KICAD_SEXPR::GetStringOutput ( bool  doClear )

inlineinherited

Definition at line 390 of file pcb_io_kicad_sexpr.h.

References STRING_FORMATTER::Clear(), STRING_FORMATTER::GetString(), and PCB_IO_KICAD_SEXPR::m_sf.

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint().

ImportFootprint()

FOOTPRINT * PCB_IO_KICAD_SEXPR::ImportFootprint ( const wxString &  aFootprintPath, wxString &  aFootprintNameOut, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtualinherited

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.

Parameters

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.

Returns

the FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

IO_ERROR

if the footprint cannot be found or read.

Reimplemented from PCB_IO.

Definition at line 2968 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::Parse(), and fontconfig::FONTCONFIG::SetReporter().

init()

void PCB_IO_KICAD_SEXPR::init ( const std::map< std::string, UTF8 > *  aProperties )

protectedinherited

Definition at line 2864 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO::m_board, PCB_IO::m_props, and PCB_IO_KICAD_SEXPR::m_reader.

Referenced by PCB_IO_KICAD_SEXPR::CreateLibrary(), PCB_IO_KICAD_SEXPR::DoLoad(), PCB_IO_KICAD_SEXPR::FootprintDelete(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintSave(), PCB_IO_KICAD_SEXPR::getFootprint(), PCB_IO_KICAD_SEXPR::IsLibraryWritable(), LoadBoard(), PCB_IO_KICAD_SEXPR::PCB_IO_KICAD_SEXPR(), SaveBoard(), and PCB_IO_KICAD_SEXPR::SaveBoard().

IsLibraryWritable()

bool PCB_IO_KICAD_SEXPR::IsLibraryWritable ( const wxString &  aLibraryPath )

overridevirtualinherited

Return true if the library at aLibraryPath is writable.

The system libraries are typically read only because of where they are installed..

Parameters

aLibraryPath

is a locator for the "library", usually a directory, file, or URL containing several footprints.

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented from IO_BASE.

Definition at line 3236 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::init(), FP_CACHE::IsWritable(), PCB_IO_KICAD_SEXPR::m_cache, and PCB_IO_KICAD_SEXPR::validateCache().

LoadBoard()

BOARD * CLIPBOARD_IO::LoadBoard ( const wxString &  aFileName, BOARD *  aAppendToMe, const std::map< std::string, UTF8 > *  aProperties = nullptr, PROJECT *  aProject = nullptr  )

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.

Parameters

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.

Returns

the successfully loaded board, or the same one as aAppendToMe if aAppendToMe was not NULL, and caller owns it.

Exceptions

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 506 of file kicad_clipboard.cpp.

References _, KIDIALOG::DoNotShowCheckbox(), PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), m_reader, PCB_IO_KICAD_SEXPR_PARSER::Parse(), PCB_T, BOARD::SetFileName(), KIDIALOG::ShowModal(), THROW_PARSE_ERROR, and EDA_ITEM::Type().

Parse() [1/2]

BOARD_ITEM * CLIPBOARD_IO::Parse

(

)

Definition at line 463 of file kicad_clipboard.cpp.

References m_reader, and PCB_IO_KICAD_SEXPR::Parse().

Referenced by PCB_CONTROL::Paste().

Parse() [2/2]

BOARD_ITEM * PCB_IO_KICAD_SEXPR::Parse ( const wxString &  aClipboardSourceInput )

inherited

Definition at line 358 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion(), PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent(), PCB_IO_KICAD_SEXPR::m_queryUserCallback, PCB_IO_KICAD_SEXPR_PARSER::Parse(), and TO_UTF8.

Referenced by PCB_IO_KICAD_SEXPR::ImportFootprint(), and Parse().

Report()

void IO_BASE::Report ( const wxString &  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

virtualinherited

Definition at line 124 of file io_base.cpp.

References IO_BASE::m_reporter, and REPORTER::Report().

Referenced by SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), and EAGLE_BASE::Report().

SaveBoard()

void CLIPBOARD_IO::SaveBoard ( const wxString &  aFileName, BOARD *  aBoard, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

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.

Parameters

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.

Exceptions

IO_ERROR

if there is a problem saving or exporting.

Reimplemented from PCB_IO.

Definition at line 481 of file kicad_clipboard.cpp.

References PCB_IO_KICAD_SEXPR::Format(), GetMajorMinorVersion(), STRING_FORMATTER::GetString(), PCB_IO_KICAD_SEXPR::init(), PCB_IO::m_board, m_formatter, PCB_IO_KICAD_SEXPR::m_mapping, m_writer, KICAD_FORMAT::Prettify(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), NETINFO_MAPPING::SetBoard(), and SEXPR_BOARD_FILE_VERSION.

Referenced by API_HANDLER_PCB::handleSaveDocumentToString().

SaveSelection()

void CLIPBOARD_IO::SaveSelection	(	const PCB_SELECTION &	selected,
		bool	isFootprintEditor
	)

Definition at line 118 of file kicad_clipboard.cpp.

References FOOTPRINT::Add(), EDA_ITEM::Clone(), copy, dummy, SELECTION::Empty(), BOARD::Footprints(), PCB_IO_KICAD_SEXPR::Format(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), PCB_IO_KICAD_SEXPR::formatNetInformation(), SELECTION::Front(), EDA_TEXT::GetAttributes(), PCB_TEXT::GetDrawRotation(), EDA_TEXT::GetHyperlink(), BOARD_ITEM::GetLayer(), GetMajorMinorVersion(), FOOTPRINT::GetNextFieldOrdinal(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetPosition(), PCB_TEXT::GetPosition(), FOOTPRINT::GetReference(), SELECTION::GetReferencePoint(), STRING_FORMATTER::GetString(), EDA_TEXT::GetText(), FOOTPRINT::GetValue(), group, SELECTION::HasReferencePoint(), EDA_ITEM::IsSelected(), PCB_IO::m_board, m_formatter, PCB_IO_KICAD_SEXPR::m_mapping, m_writer, FOOTPRINT::Move(), FOOTPRINT::MoveAnchorPosition(), pad, FOOTPRINT::Pads(), PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_PAD_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TEXT_T, KICAD_FORMAT::Prettify(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), EDA_TEXT::SetAttributes(), NETINFO_MAPPING::SetBoard(), EDA_ITEM::SetFlags(), FOOTPRINT::SetFPID(), EDA_TEXT::SetHyperlink(), BOARD_ITEM::SetLayer(), BOARD_ITEM::SetLocked(), FOOTPRINT::SetLocked(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), FOOTPRINT::SetPosition(), PCB_TEXT::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), SEXPR_BOARD_FILE_VERSION, SELECTION::Size(), STRUCT_DELETED, table, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDIT_TOOL::copyToClipboard(), and API_HANDLER_PCB::handleSaveSelectionToString().

SetBoard()

void CLIPBOARD_IO::SetBoard

(

BOARD *

aBoard

)

Definition at line 60 of file kicad_clipboard.cpp.

References PCB_IO::m_board.

Referenced by EDIT_TOOL::copyToClipboard(), and API_HANDLER_PCB::handleSaveSelectionToString().

SetOutputFormatter()

void PCB_IO_KICAD_SEXPR::SetOutputFormatter ( OUTPUTFORMATTER *  aFormatter )

inlineinherited

Definition at line 400 of file pcb_io_kicad_sexpr.h.

References PCB_IO_KICAD_SEXPR::m_out.

Referenced by FP_CACHE::Save().

SetProgressReporter()

virtual void IO_BASE::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 89 of file io_base.h.

Referenced by PCB_CONTROL::AppendBoard().

SetQueryUserCallback() [1/2]

virtual void PCB_IO::SetQueryUserCallback ( std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)>  aCallback )

inlinevirtualinherited

Registers a KIDIALOG callback for collecting info from the user.

Definition at line 97 of file pcb_io.h.

Referenced by PCB_CONTROL::AppendBoard().

SetQueryUserCallback() [2/2]

void PCB_IO_KICAD_SEXPR::SetQueryUserCallback ( std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aOKButtonTitle)>  aCallback )

inlineoverrideinherited

Definition at line 325 of file pcb_io_kicad_sexpr.h.

References PCB_IO_KICAD_SEXPR::m_queryUserCallback.

SetReader()

void CLIPBOARD_IO::SetReader ( std::function< wxString()>  aReader )

inline

Definition at line 48 of file kicad_clipboard.h.

References m_reader.

SetReporter()

virtual void IO_BASE::SetReporter ( REPORTER *  aReporter )

inlinevirtualinherited

Set an optional reporter for warnings/errors.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 84 of file io_base.h.

SetWriter()

void CLIPBOARD_IO::SetWriter ( std::function< void(const wxString &)>  aWriter )

inline

Definition at line 47 of file kicad_clipboard.h.

References m_writer.

Referenced by API_HANDLER_PCB::handleSaveDocumentToString(), and API_HANDLER_PCB::handleSaveSelectionToString().

validateCache()

void PCB_IO_KICAD_SEXPR::validateCache ( const wxString &  aLibraryPath, bool  checkModified = true  )

protectedinherited

Definition at line 2872 of file pcb_io_kicad_sexpr.cpp.

References PCB_IO_KICAD_SEXPR::FP_CACHE, FP_CACHE::IsModified(), FP_CACHE::IsPath(), FP_CACHE::Load(), PCB_IO_KICAD_SEXPR::m_cache, and fontconfig::FONTCONFIG::SetReporter().

Referenced by PCB_IO_KICAD_SEXPR::FootprintDelete(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintSave(), PCB_IO_KICAD_SEXPR::getFootprint(), and PCB_IO_KICAD_SEXPR::IsLibraryWritable().

Member Data Documentation

m_board

BOARD* PCB_IO::m_board

protectedinherited

The board BOARD being worked on, no ownership here.

Definition at line 324 of file pcb_io.h.

Referenced by PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_ALTIUM_DESIGNER::GetImportedCachedLibraryFootprints(), PCB_IO_EAGLE::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::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(), SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), SaveSelection(), and SetBoard().

m_cache

FP_CACHE* PCB_IO_KICAD_SEXPR::m_cache

protectedinherited

Footprint library cache.

Definition at line 478 of file pcb_io_kicad_sexpr.h.

Referenced by PCB_IO_KICAD_SEXPR::CreateLibrary(), PCB_IO_KICAD_SEXPR::DeleteLibrary(), PCB_IO_KICAD_SEXPR::FootprintDelete(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintSave(), PCB_IO_KICAD_SEXPR::getFootprint(), PCB_IO_KICAD_SEXPR::IsLibraryWritable(), PCB_IO_KICAD_SEXPR::validateCache(), and PCB_IO_KICAD_SEXPR::~PCB_IO_KICAD_SEXPR().

m_ctl

int PCB_IO_KICAD_SEXPR::m_ctl

protectedinherited

Definition at line 485 of file pcb_io_kicad_sexpr.h.

Referenced by PCB_IO_KICAD_SEXPR::FootprintSave(), and PCB_IO_KICAD_SEXPR::format().

m_error

wxString PCB_IO_KICAD_SEXPR::m_error

protectedinherited

for throwing exceptions

Definition at line 476 of file pcb_io_kicad_sexpr.h.

m_filename

wxString PCB_IO_KICAD_SEXPR::m_filename

protectedinherited

for saves only, name is in m_reader for loads

Definition at line 481 of file pcb_io_kicad_sexpr.h.

m_formatter

STRING_FORMATTER CLIPBOARD_IO::m_formatter

private

Definition at line 73 of file kicad_clipboard.h.

Referenced by CLIPBOARD_IO(), SaveBoard(), and SaveSelection().

m_mapping

NETINFO_MAPPING* PCB_IO_KICAD_SEXPR::m_mapping

protectedinherited

mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes

Definition at line 486 of file pcb_io_kicad_sexpr.h.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::formatNetInformation(), SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), SaveSelection(), and PCB_IO_KICAD_SEXPR::~PCB_IO_KICAD_SEXPR().

m_name

wxString IO_BASE::m_name

protectedinherited

Name of the IO loader.

Definition at line 217 of file io_base.h.

m_out

OUTPUTFORMATTER* PCB_IO_KICAD_SEXPR::m_out

protectedinherited

output any Format()s to this, no ownership

Definition at line 484 of file pcb_io_kicad_sexpr.h.

Referenced by CLIPBOARD_IO(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), PCB_IO_KICAD_SEXPR::formatGeneral(), PCB_IO_KICAD_SEXPR::formatLayer(), PCB_IO_KICAD_SEXPR::formatLayers(), PCB_IO_KICAD_SEXPR::formatNetInformation(), PCB_IO_KICAD_SEXPR::formatPolyPts(), PCB_IO_KICAD_SEXPR::formatProperties(), PCB_IO_KICAD_SEXPR::formatRenderCache(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), PCB_IO_KICAD_SEXPR::PCB_IO_KICAD_SEXPR(), PCB_IO_KICAD_SEXPR::SaveBoard(), and PCB_IO_KICAD_SEXPR::SetOutputFormatter().

m_progressReporter

PROGRESS_REPORTER* IO_BASE::m_progressReporter

protectedinherited

Progress reporter to track the progress of the operation, may be nullptr.

Definition at line 223 of file io_base.h.

Referenced by IO_BASE::AdvanceProgressPhase(), SCH_IO_KICAD_LEGACY::checkpoint(), SCH_IO_EAGLE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ODBPP::ExportODB(), 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(), PCB_IO_KICAD_SEXPR::LoadBoard(), SCH_IO_KICAD_LEGACY::loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), PCB_IO_IPC2581::SaveBoard(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().

m_props

const std::map<std::string, UTF8>* PCB_IO::m_props

protectedinherited

Properties passed via Save() or Load(), no ownership, may be NULL.

Definition at line 327 of file pcb_io.h.

Referenced by PCB_IO_EAGLE::init(), PCB_IO_GEDA::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::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().

m_queryUserCallback

std::function<bool( wxString aTitle, int aIcon, wxString aMsg, wxString aAction )> PCB_IO_KICAD_SEXPR::m_queryUserCallback

protectedinherited

Definition at line 489 of file pcb_io_kicad_sexpr.h.

Referenced by PCB_IO_KICAD_SEXPR::CanReadBoard(), PCB_IO_KICAD_SEXPR::DoLoad(), PCB_IO_KICAD_SEXPR::Parse(), PCB_IO_KICAD_SEXPR::SaveBoard(), and PCB_IO_KICAD_SEXPR::SetQueryUserCallback().

m_reader

std::function<wxString()> CLIPBOARD_IO::m_reader

private

Definition at line 75 of file kicad_clipboard.h.

Referenced by LoadBoard(), Parse(), and SetReader().

m_reporter

REPORTER* IO_BASE::m_reporter

protectedinherited

Reporter to log errors/warnings to, may be nullptr.

Definition at line 220 of file io_base.h.

Referenced by SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParsePowerPort(), PCB_IO_ALTIUM_DESIGNER::PCB_IO_ALTIUM_DESIGNER(), PCB_IO_SOLIDWORKS::PCB_IO_SOLIDWORKS(), IO_BASE::Report(), 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(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().

m_sf

STRING_FORMATTER PCB_IO_KICAD_SEXPR::m_sf

protectedinherited

Definition at line 483 of file pcb_io_kicad_sexpr.h.

Referenced by PCB_IO_KICAD_SEXPR::GetStringOutput(), and PCB_IO_KICAD_SEXPR::PCB_IO_KICAD_SEXPR().

m_writer

std::function<void(const wxString&)> CLIPBOARD_IO::m_writer

private

Definition at line 74 of file kicad_clipboard.h.

Referenced by SaveBoard(), SaveSelection(), and SetWriter().

---

The documentation for this class was generated from the following files:

• kicad_clipboard.h
• kicad_clipboard.cpp