CLIPBOARD_IO Class Reference

#include <kicad_clipboard.h>

Inheritance diagram for CLIPBOARD_IO:

Public Member Functions
	CLIPBOARD_IO ()
	~CLIPBOARD_IO ()
void	Save (const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=nullptr) override
	Write aBoard to a storage file in a format that this PLUGIN implementation knows about or it can be used to write a portion of aBoard to a special kind of export file. More...
void	SaveSelection (const PCB_SELECTION &selected, bool isFootprintEditor)
BOARD_ITEM *	Parse ()
BOARD *	Load (const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=nullptr, PROJECT *aProject=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
	Load information from some input file format that this PLUGIN implementation knows about into either a new BOARD or an existing one. More...
void	SetBoard (BOARD *aBoard)
const wxString	PluginName () const override
	Return a brief hard coded name for this PLUGIN. More...
const wxString	GetFileExtension () const override
	Returns the file extension for the PLUGIN. More...
BOARD *	DoLoad (LINE_READER &aReader, BOARD *aAppendToMe, const PROPERTIES *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount)
void	FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const PROPERTIES *aProperties=nullptr) override
	Return a list of footprint names contained within the library at aLibraryPath. More...
const FOOTPRINT *	GetEnumeratedFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=nullptr) override
	A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. More...
bool	FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=nullptr) override
	Check for the existence of a footprint. More...
FOOTPRINT *	FootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const PROPERTIES *aProperties=nullptr) override
	Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about. More...
void	FootprintSave (const wxString &aLibraryPath, const FOOTPRINT *aFootprint, const PROPERTIES *aProperties=nullptr) override
	Write aFootprint to an existing library located at aLibraryPath. More...
void	FootprintDelete (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=nullptr) override
	Delete aFootprintName from the library at aLibraryPath. More...
long long	GetLibraryTimestamp (const wxString &aLibraryPath) const override
	Generate a timestamp representing all the files in the library (including the library directory). More...
void	FootprintLibCreate (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
	Create a new empty footprint library at aLibraryPath empty. More...
bool	FootprintLibDelete (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
	Delete an existing footprint 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. More...
bool	IsFootprintLibWritable (const wxString &aLibraryPath) override
	Return true if the library at aLibraryPath is writable. More...
void	Format (const BOARD_ITEM *aItem, int aNestLevel=0) const
	Output aItem to aFormatter in s-expression format. More...
std::string	GetStringOutput (bool doClear)
void	SetOutputFormatter (OUTPUTFORMATTER *aFormatter)
BOARD_ITEM *	Parse (const wxString &aClipboardSourceInput)
virtual std::vector< FOOTPRINT * >	GetImportedCachedLibraryFootprints ()
	Return a container with the cached library footprints generated in the last call to Load. More...
virtual void	PrefetchLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	If possible, prefetches the specified library (e.g. More...
virtual void	FootprintLibOptions (PROPERTIES *aListToAppendTo) const
	Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions. More...

Protected Member Functions
void	validateCache (const wxString &aLibraryPath, bool checkModified=true)
const FOOTPRINT *	getFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)
void	init (const PROPERTIES *aProperties)
void	formatSetup (const BOARD *aBoard, int aNestLevel=0) const
	formats the board setup information More...
void	formatGeneral (const BOARD *aBoard, int aNestLevel=0) const
	formats the General section of the file More...
void	formatBoardLayers (const BOARD *aBoard, int aNestLevel=0) const
	formats the board layer information More...
void	formatNetInformation (const BOARD *aBoard, int aNestLevel=0) const
	formats the Nets and Netclasses More...
void	formatProperties (const BOARD *aBoard, int aNestLevel=0) const
	formats the Nets and Netclasses More...
void	formatHeader (const BOARD *aBoard, int aNestLevel=0) const
	writes everything that comes before the board_items, like settings and layers etc More...

Protected Attributes
wxString	m_error
	for throwing exceptions More...
BOARD *	m_board
	which BOARD, no ownership here More...
const PROPERTIES *	m_props
	passed via Save() or Load(), no ownership, may be NULL. More...
FP_CACHE *	m_cache
	Footprint library cache. More...
LINE_READER *	m_reader
	no ownership here. More...
wxString	m_filename
	for saves only, name is in m_reader for loads More...
STRING_FORMATTER	m_sf
OUTPUTFORMATTER *	m_out
	output any Format()s to this, no ownership More...
int	m_ctl
PCB_PARSER *	m_parser
NETINFO_MAPPING *	m_mapping
	mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes More...

Private Attributes
STRING_FORMATTER	m_formatter

Detailed Description

Definition at line 41 of file kicad_clipboard.h.

Constructor & Destructor Documentation

CLIPBOARD_IO()

CLIPBOARD_IO::CLIPBOARD_IO

(

)

Definition at line 44 of file kicad_clipboard.cpp.

 :
 PCB_PLUGIN(CTL_FOR_CLIPBOARD ),
 m_formatter()
{
 m_out = &m_formatter;
}

References m_formatter, and PCB_PLUGIN::m_out.

~CLIPBOARD_IO()

CLIPBOARD_IO::~CLIPBOARD_IO

(

)

Definition at line 52 of file kicad_clipboard.cpp.

{
}

Member Function Documentation

DoLoad()

BOARD * PCB_PLUGIN::DoLoad ( LINE_READER &  aReader, BOARD *  aAppendToMe, const PROPERTIES *  aProperties, PROGRESS_REPORTER *  aProgressReporter, unsigned  aLineCount  )

inherited

Definition at line 2320 of file pcb_plugin.cpp.

{
 init( aProperties );

 m_parser->SetLineReader( &aReader );
 m_parser->SetBoard( aAppendToMe );
 m_parser->SetProgressReporter( aProgressReporter, &aReader, aLineCount );

 BOARD* board;

 try
 {
 board = dynamic_cast<BOARD*>( m_parser->Parse() );
 }
 catch( const FUTURE_FORMAT_ERROR& )
 {
 // Don't wrap a FUTURE_FORMAT_ERROR in another
 throw;
 }
 catch( const PARSE_ERROR& parse_error )
 {
 if( m_parser->IsTooRecent() )
 throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
 else
 throw;
 }

 if( !board )
 {
 // The parser loaded something that was valid, but wasn't a board.
 THROW_PARSE_ERROR( _( "This file does not contain a PCB." ), m_parser->CurSource(),
 m_parser->CurLine(), m_parser->CurLineNumber(), m_parser->CurOffset() );
 }

 return board;
}

References _, PCB_PARSER::GetRequiredVersion(), PCB_PLUGIN::init(), PCB_PARSER::IsTooRecent(), PCB_PLUGIN::m_parser, PCB_PARSER::Parse(), PCB_PARSER::SetBoard(), PCB_PARSER::SetLineReader(), PCB_PARSER::SetProgressReporter(), and THROW_PARSE_ERROR.

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), and PCB_PLUGIN::Load().

FootprintDelete()

void PCB_PLUGIN::FootprintDelete ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const PROPERTIES *  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 PLUGIN.

Definition at line 2578 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.

 init( aProperties );

 validateCache( aLibraryPath );

 if( !m_cache->IsWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Library '%s' is read only." ),
 aLibraryPath.GetData() ) );
 }

 m_cache->Remove( aFootprintName );
}

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

FootprintEnumerate()

void PCB_PLUGIN::FootprintEnumerate ( wxArrayString &  aFootprintNames, const wxString &  aLibraryPath, bool  aBestEfforts, const PROPERTIES *  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 PLUGIN.

Definition at line 2379 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 wxDir dir( aLibPath );
 wxString errorMsg;

 init( aProperties );

 try
 {
 validateCache( aLibPath );
 }
 catch( const IO_ERROR& ioe )
 {
 errorMsg = ioe.What();
 }

 // Some of the files may have been parsed correctly so we want to add the valid files to
 // the library.

 for( const auto& footprint : m_cache->GetFootprints() )
 aFootprintNames.Add( footprint.first );

 if( !errorMsg.IsEmpty() && !aBestEfforts )
 THROW_IO_ERROR( errorMsg );
}

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

FootprintExists()

bool PCB_PLUGIN::FootprintExists ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const PROPERTIES *  aProperties = nullptr  )

overridevirtualinherited

Check for the existence of a footprint.

Reimplemented from PLUGIN.

Definition at line 2444 of file pcb_plugin.cpp.

{
 // Note: checking the cache sounds like a good idea, but won't catch files which differ
 // only in case.
 //
 // Since this goes out to the native filesystem, we get platform differences (ie: MSW's
 // case-insensitive filesystem) handled "for free".
 // Warning: footprint names frequently contain a point. So be careful when initializing
 // wxFileName, and use a CTOR with extension specified
 wxFileName footprintFile( aLibraryPath, aFootprintName, KiCadFootprintFileExtension );

 return footprintFile.Exists();
}

References KiCadFootprintFileExtension.

FootprintLibCreate()

void PCB_PLUGIN::FootprintLibCreate ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

overridevirtualinherited

Create a new empty footprint 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 footprints.
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 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 library, or creating it.

Reimplemented from PLUGIN.

Definition at line 2604 of file pcb_plugin.cpp.

{
 if( wxDir::Exists( aLibraryPath ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Cannot overwrite library path '%s'." ),
 aLibraryPath.GetData() ) );
 }

 LOCALE_IO toggle;

 init( aProperties );

 delete m_cache;
 m_cache = new FP_CACHE( this, aLibraryPath );
 m_cache->Save();
}

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

FootprintLibDelete()

bool PCB_PLUGIN::FootprintLibDelete ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

overridevirtualinherited

Delete an existing footprint 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 footprints.
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 PLUGIN.

Definition at line 2622 of file pcb_plugin.cpp.

{
 wxFileName fn;
 fn.SetPath( aLibraryPath );

 // Return if there is no library path to delete.
 if( !fn.DirExists() )
 return false;

 if( !fn.IsDirWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Insufficient permissions to delete folder '%s'." ),
 aLibraryPath.GetData() ) );
 }

 wxDir dir( aLibraryPath );

 if( dir.HasSubDirs() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Library folder '%s' has unexpected sub-folders." ),
 aLibraryPath.GetData() ) );
 }

 // All the footprint files must be deleted before the directory can be deleted.
 if( dir.HasFiles() )
 {
 unsigned i;
 wxFileName tmp;
 wxArrayString files;

 wxDir::GetAllFiles( aLibraryPath, &files );

 for( i = 0; i < files.GetCount(); i++ )
 {
 tmp = files[i];

 if( tmp.GetExt() != KiCadFootprintFileExtension )
 {
 THROW_IO_ERROR( wxString::Format( _( "Unexpected file '%s' found in library "
 "path '%s'." ),
 files[i].GetData(),
 aLibraryPath.GetData() ) );
 }
 }

 for( i = 0; i < files.GetCount(); i++ )
 wxRemoveFile( files[i] );
 }

 wxLogTrace( traceKicadPcbPlugin, wxT( "Removing footprint library '%s'." ),
 aLibraryPath.GetData() );

 // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
 // we don't want that. we want bare metal portability with no UI here.
 if( !wxRmdir( aLibraryPath ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' cannot be deleted." ),
 aLibraryPath.GetData() ) );
 }

 // For some reason removing a directory in Windows is not immediately updated. This delay
 // prevents an error when attempting to immediately recreate the same directory when over
 // writing an existing library.
#ifdef __WINDOWS__
 wxMilliSleep( 250L );
#endif

 if( m_cache && !m_cache->IsPath( aLibraryPath ) )
 {
 delete m_cache;
 m_cache = nullptr;
 }

 return true;
}

References _, Format(), FP_CACHE::IsPath(), KiCadFootprintFileExtension, PCB_PLUGIN::m_cache, THROW_IO_ERROR, and traceKicadPcbPlugin.

FootprintLibOptions()

void PLUGIN::FootprintLibOptions ( PROPERTIES *  aListToAppendTo ) const

virtualinherited

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_FP_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 in EAGLE_PLUGIN.

Definition at line 147 of file plugin.cpp.

{
 // disable all these in another couple of months, after everyone has seen them:
#if 1
 (*aListToAppendTo)["debug_level"] = UTF8( _( "Enable <b>debug</b> logging for Footprint*() "
 "functions in this PLUGIN." ) );

 (*aListToAppendTo)["read_filter_regex"] = UTF8( _( "Regular expression <b>footprint name</b> "
 "filter." ) );

 (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _( "Enable transaction logging. The "
 "mere presence of this option "
 "turns on the logging, no need to "
 "set a Value." ) );

 (*aListToAppendTo)["username"] = UTF8( _( "User name for <b>login</b> to some special library "
 "server." ) );

 (*aListToAppendTo)["password"] = UTF8( _( "Password for <b>login</b> to some special library "
 "server." ) );
#endif

#if 1
 // Suitable for a C++ to python PLUGIN::Footprint*() adapter, move it to the adapter
 // if and when implemented.
 (*aListToAppendTo)["python_footprint_plugin"] = UTF8( _( "Enter the python module which "
 "implements the PLUGIN::Footprint*() "
 "functions." ) );
#endif
}

References _.

Referenced by EAGLE_PLUGIN::FootprintLibOptions().

FootprintLoad()

FOOTPRINT * PCB_PLUGIN::FootprintLoad ( const wxString &  aLibraryPath, const wxString &  aFootprintName, bool  aKeepUUID = false, const PROPERTIES *  aProperties = nullptr  )

overridevirtualinherited

Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN 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 PLUGIN.

Definition at line 2460 of file pcb_plugin.cpp.

{
 const FOOTPRINT* footprint = getFootprint( aLibraryPath, aFootprintName, aProperties, true );

 if( footprint )
 {
 FOOTPRINT* copy;

 if( aKeepUUID )
 copy = static_cast<FOOTPRINT*>( footprint->Clone() );
 else
 copy = static_cast<FOOTPRINT*>( footprint->Duplicate() );

 copy->SetParent( nullptr );
 return copy;
 }

 return nullptr;
}

References FOOTPRINT::Clone(), copy, FOOTPRINT::Duplicate(), and PCB_PLUGIN::getFootprint().

FootprintSave()

void PCB_PLUGIN::FootprintSave ( const wxString &  aLibraryPath, const FOOTPRINT *  aFootprint, const PROPERTIES *  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 PLUGIN.

Definition at line 2484 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.

 init( aProperties );

 // In this public PLUGIN API function, we can safely assume it was
 // called for saving into a library path.
 m_ctl = CTL_FOR_LIBRARY;

 validateCache( aLibraryPath );

 if( !m_cache->IsWritable() )
 {
 if( !m_cache->Exists() )
 {
 const wxString msg = wxString::Format( _( "Library '%s' does not exist.\n"
 "Would you like to create it?"),
 aLibraryPath );

 if( wxMessageBox( msg, _( "Library Not Found"), wxYES_NO | wxICON_QUESTION ) != wxYES )
 return;

 // Save throws its own IO_ERROR on failure, so no need to recreate here
 m_cache->Save( nullptr );
 }
 else
 {
 wxString msg = wxString::Format( _( "Library '%s' is read only." ), aLibraryPath );
 THROW_IO_ERROR( msg );
 }
 }

 wxString footprintName = aFootprint->GetFPID().GetLibItemName();

 FOOTPRINT_MAP& footprints = m_cache->GetFootprints();

 // Quietly overwrite footprint and delete footprint file from path for any by same name.
 wxFileName fn( aLibraryPath, aFootprint->GetFPID().GetLibItemName(),
 KiCadFootprintFileExtension );

 // Write through symlinks, don't replace them
 WX_FILENAME::ResolvePossibleSymlinks( fn );

 if( !fn.IsOk() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Footprint file name '%s' is not valid." ),
 fn.GetFullPath() ) );
 }

 if( fn.FileExists() && !fn.IsFileWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Insufficient permissions to delete '%s'." ),
 fn.GetFullPath() ) );
 }

 wxString fullPath = fn.GetFullPath();
 wxString fullName = fn.GetFullName();
 FOOTPRINT_MAP::const_iterator it = footprints.find( footprintName );

 if( it != footprints.end() )
 {
 wxLogTrace( traceKicadPcbPlugin, wxT( "Removing footprint file '%s'." ), fullPath );
 footprints.erase( footprintName );
 wxRemoveFile( fullPath );
 }

 // I need my own copy for the cache
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( aFootprint->Clone() );

 // It's orientation should be zero and it should be on the front layer.
 footprint->SetOrientation( 0 );

 if( footprint->GetLayer() != F_Cu )
 {
 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );

 if( cfg )
 footprint->Flip( footprint->GetPosition(), cfg->m_FlipLeftRight );
 else
 footprint->Flip( footprint->GetPosition(), false );
 }

 // Detach it from the board
 footprint->SetParent( nullptr );

 wxLogTrace( traceKicadPcbPlugin, wxT( "Creating s-expr footprint file '%s'." ), fullPath );
 footprints.insert( footprintName,
 new FP_CACHE_ITEM( footprint, WX_FILENAME( fn.GetPath(), fullName ) ) );
 m_cache->Save( footprint );
}

References _, FOOTPRINT::Clone(), CTL_FOR_LIBRARY, FP_CACHE::Exists(), F_Cu, FOOTPRINT::Flip(), Format(), FP_CACHE::GetFootprints(), FOOTPRINT::GetFPID(), BOARD_ITEM::GetLayer(), LIB_ID::GetLibItemName(), FOOTPRINT::GetPosition(), PCB_PLUGIN::init(), FP_CACHE::IsWritable(), KiCadFootprintFileExtension, Kiface(), PCB_PLUGIN::m_cache, PCB_PLUGIN::m_ctl, PCBNEW_SETTINGS::m_FlipLeftRight, WX_FILENAME::ResolvePossibleSymlinks(), FP_CACHE::Save(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), THROW_IO_ERROR, traceKicadPcbPlugin, and PCB_PLUGIN::validateCache().

Format()

void PCB_PLUGIN::Format ( const BOARD_ITEM *  aItem, int  aNestLevel = 0  ) const

inherited

Output aItem to aFormatter in s-expression format.

Parameters

aItem	A pointer the an BOARD_ITEM object to format.
aNestLevel	The indentation nest level.

Exceptions

IO_ERROR

on write error.

Definition at line 400 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle; // public API function, perform anything convenient for caller

 switch( aItem->Type() )
 {
 case PCB_T:
 format( static_cast<const BOARD*>( aItem ), aNestLevel );
 break;

 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 format( static_cast<const PCB_DIMENSION_BASE*>( aItem ), aNestLevel );
 break;

 case PCB_SHAPE_T:
 format( static_cast<const PCB_SHAPE*>( aItem ), aNestLevel );
 break;

 case PCB_FP_SHAPE_T:
 format( static_cast<const FP_SHAPE*>( aItem ), aNestLevel );
 break;

 case PCB_TARGET_T:
 format( static_cast<const PCB_TARGET*>( aItem ), aNestLevel );
 break;

 case PCB_FOOTPRINT_T:
 format( static_cast<const FOOTPRINT*>( aItem ), aNestLevel );
 break;

 case PCB_PAD_T:
 format( static_cast<const PAD*>( aItem ), aNestLevel );
 break;

 case PCB_TEXT_T:
 format( static_cast<const PCB_TEXT*>( aItem ), aNestLevel );
 break;

 case PCB_FP_TEXT_T:
 format( static_cast<const FP_TEXT*>( aItem ), aNestLevel );
 break;

 case PCB_GROUP_T:
 format( static_cast<const PCB_GROUP*>( aItem ), aNestLevel );
 break;

 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 format( static_cast<const PCB_TRACK*>( aItem ), aNestLevel );
 break;

 case PCB_FP_ZONE_T:
 case PCB_ZONE_T:
 format( static_cast<const ZONE*>( aItem ), aNestLevel );
 break;

 default:
 wxFAIL_MSG( wxT( "Cannot format item " ) + aItem->GetClass() );
 }
}

References PCB_PLUGIN::format(), EDA_ITEM::GetClass(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, PCB_SHAPE_T, PCB_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_PLUGIN::format(), Save(), FP_CACHE::Save(), PCB_PLUGIN::Save(), and SaveSelection().

formatBoardLayers()

void PCB_PLUGIN::formatBoardLayers ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

formats the board layer information

Definition at line 542 of file pcb_plugin.cpp.

{
 m_out->Print( aNestLevel, "(layers\n" );

 // Save only the used copper layers from front to back.

 for( LSEQ cu = aBoard->GetEnabledLayers().CuStack(); cu; ++cu )
 {
 PCB_LAYER_ID layer = *cu;

 m_out->Print( aNestLevel+1, "(%d %s %s", layer,
 m_out->Quotew( LSET::Name( layer ) ).c_str(),
 LAYER::ShowType( aBoard->GetLayerType( layer ) ) );

 if( LSET::Name( layer ) != m_board->GetLayerName( layer ) )
 m_out->Print( 0, " %s", m_out->Quotew( m_board->GetLayerName( layer ) ).c_str() );

 m_out->Print( 0, ")\n" );
 }

 // Save used non-copper layers in the order they are defined.
 // desired sequence for non Cu BOARD layers.
 static const PCB_LAYER_ID non_cu[] =
 {
 B_Adhes, // 32
 F_Adhes,
 B_Paste,
 F_Paste,
 B_SilkS,
 F_SilkS,
 B_Mask,
 F_Mask,
 Dwgs_User,
 Cmts_User,
 Eco1_User,
 Eco2_User,
 Edge_Cuts,
 Margin,
 B_CrtYd,
 F_CrtYd,
 B_Fab,
 F_Fab,
 User_1,
 User_2,
 User_3,
 User_4,
 User_5,
 User_6,
 User_7,
 User_8,
 User_9
 };

 for( LSEQ seq = aBoard->GetEnabledLayers().Seq( non_cu, arrayDim( non_cu ) ); seq; ++seq )
 {
 PCB_LAYER_ID layer = *seq;

 m_out->Print( aNestLevel+1, "(%d %s user", layer,
 m_out->Quotew( LSET::Name( layer ) ).c_str() );

 if( m_board->GetLayerName( layer ) != LSET::Name( layer ) )
 m_out->Print( 0, " %s", m_out->Quotew( m_board->GetLayerName( layer ) ).c_str() );

 m_out->Print( 0, ")\n" );
 }

 m_out->Print( aNestLevel, ")\n\n" );
}

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_PLUGIN::m_board, PCB_PLUGIN::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 PCB_PLUGIN::formatHeader(), and SaveSelection().

formatGeneral()

void PCB_PLUGIN::formatGeneral ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

formats the General section of the file

Definition at line 526 of file pcb_plugin.cpp.

{
 const BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();

 m_out->Print( 0, "\n" );
 m_out->Print( aNestLevel, "(general\n" );
 m_out->Print( aNestLevel+1, "(thickness %s)\n",
 FormatInternalUnits( dsnSettings.GetBoardThickness() ).c_str() );

 m_out->Print( aNestLevel, ")\n\n" );

 aBoard->GetPageSettings().Format( m_out, aNestLevel, m_ctl );
 aBoard->GetTitleBlock().Format( m_out, aNestLevel, m_ctl );
}

References TITLE_BLOCK::Format(), PAGE_INFO::Format(), FormatInternalUnits(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), BOARD::GetDesignSettings(), BOARD::GetPageSettings(), BOARD::GetTitleBlock(), PCB_PLUGIN::m_ctl, PCB_PLUGIN::m_out, and OUTPUTFORMATTER::Print().

Referenced by PCB_PLUGIN::formatHeader().

formatHeader()

void PCB_PLUGIN::formatHeader ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

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

Definition at line 642 of file pcb_plugin.cpp.

{
 formatGeneral( aBoard, aNestLevel );

 // Layers list.
 formatBoardLayers( aBoard, aNestLevel );

 // Setup
 formatSetup( aBoard, aNestLevel );

 // Properties
 formatProperties( aBoard, aNestLevel );

 // Save net codes and names
 formatNetInformation( aBoard, aNestLevel );
}

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

Referenced by PCB_PLUGIN::format().

formatNetInformation()

void PCB_PLUGIN::formatNetInformation ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

formats the Nets and Netclasses

Definition at line 612 of file pcb_plugin.cpp.

{
 for( NETINFO_ITEM* net : *m_mapping )
 {
 if( net == nullptr ) // Skip not actually existing nets (orphan nets)
 continue;

 m_out->Print( aNestLevel, "(net %d %s)\n",
 m_mapping->Translate( net->GetNetCode() ),
 m_out->Quotew( net->GetNetname() ).c_str() );
 }

 m_out->Print( 0, "\n" );
}

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

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

formatProperties()

void PCB_PLUGIN::formatProperties ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

formats the Nets and Netclasses

Definition at line 628 of file pcb_plugin.cpp.

{
 for( const std::pair<const wxString, wxString>& prop : aBoard->GetProperties() )
 {
 m_out->Print( aNestLevel, "(property %s %s)\n",
 m_out->Quotew( prop.first ).c_str(),
 m_out->Quotew( prop.second ).c_str() );
 }

 if( !aBoard->GetProperties().empty() )
 m_out->Print( 0, "\n" );
}

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

Referenced by PCB_PLUGIN::formatHeader().

formatSetup()

void PCB_PLUGIN::formatSetup ( const BOARD *  aBoard, int  aNestLevel = 0  ) const

protectedinherited

formats the board setup information

Definition at line 474 of file pcb_plugin.cpp.

{
 // Setup
 m_out->Print( aNestLevel, "(setup\n" );

 // Save the board physical stackup structure
 const BOARD_STACKUP& stackup = aBoard->GetDesignSettings().GetStackupDescriptor();

 if( aBoard->GetDesignSettings().m_HasStackup )
 stackup.FormatBoardStackup( m_out, aBoard, aNestLevel+1 );

 BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();

 m_out->Print( aNestLevel+1, "(pad_to_mask_clearance %s)\n",
 FormatInternalUnits( dsnSettings.m_SolderMaskMargin ).c_str() );

 if( dsnSettings.m_SolderMaskMinWidth )
 m_out->Print( aNestLevel+1, "(solder_mask_min_width %s)\n",
 FormatInternalUnits( dsnSettings.m_SolderMaskMinWidth ).c_str() );

 if( dsnSettings.m_SolderPasteMargin != 0 )
 m_out->Print( aNestLevel+1, "(pad_to_paste_clearance %s)\n",
 FormatInternalUnits( dsnSettings.m_SolderPasteMargin ).c_str() );

 if( dsnSettings.m_SolderPasteMarginRatio != 0 )
 m_out->Print( aNestLevel+1, "(pad_to_paste_clearance_ratio %s)\n",
 Double2Str( dsnSettings.m_SolderPasteMarginRatio ).c_str() );

 wxPoint origin = dsnSettings.GetAuxOrigin();

 if( origin != wxPoint( 0, 0 ) )
 {
 m_out->Print( aNestLevel+1, "(aux_axis_origin %s %s)\n",
 FormatInternalUnits( origin.x ).c_str(),
 FormatInternalUnits( origin.y ).c_str() );
 }

 origin = dsnSettings.GetGridOrigin();

 if( origin != wxPoint( 0, 0 ) )
 {
 m_out->Print( aNestLevel+1, "(grid_origin %s %s)\n",
 FormatInternalUnits( origin.x ).c_str(),
 FormatInternalUnits( origin.y ).c_str() );
 }

 aBoard->GetPlotOptions().Format( m_out, aNestLevel+1 );

 m_out->Print( aNestLevel, ")\n\n" );
}

References Double2Str(), PCB_PLOT_PARAMS::Format(), BOARD_STACKUP::FormatBoardStackup(), FormatInternalUnits(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), BOARD::GetPlotOptions(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), BOARD_DESIGN_SETTINGS::m_HasStackup, PCB_PLUGIN::m_out, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, and OUTPUTFORMATTER::Print().

Referenced by PCB_PLUGIN::formatHeader().

GetEnumeratedFootprint()

const FOOTPRINT * PCB_PLUGIN::GetEnumeratedFootprint ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const PROPERTIES *  aProperties = nullptr  )

overridevirtualinherited

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

Reimplemented from PLUGIN.

Definition at line 2436 of file pcb_plugin.cpp.

{
 return getFootprint( aLibraryPath, aFootprintName, aProperties, false );
}

References PCB_PLUGIN::getFootprint().

GetFileExtension()

const wxString PCB_PLUGIN::GetFileExtension ( ) const

inlineoverridevirtualinherited

Returns the file extension for the PLUGIN.

Implements PLUGIN.

Definition at line 149 of file pcb_plugin.h.

 {
 // Would have used wildcards_and_files_ext.cpp's KiCadPcbFileExtension,
 // but to be pure, a plugin should not assume that it will always be linked
 // with the core of the Pcbnew code. (Might someday be a DLL/DSO.) Besides,
 // file extension policy should be controlled by the plugin.
 return wxT( "kicad_pcb" );
 }

getFootprint()

const FOOTPRINT * PCB_PLUGIN::getFootprint ( const wxString &  aLibraryPath, const wxString &  aFootprintName, const PROPERTIES *  aProperties, bool  checkModified  )

protectedinherited

Definition at line 2408 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.

 init( aProperties );

 try
 {
 validateCache( aLibraryPath, checkModified );
 }
 catch( const IO_ERROR& )
 {
 // do nothing with the error
 }

 FOOTPRINT_MAP& footprints = m_cache->GetFootprints();
 FOOTPRINT_MAP::const_iterator it = footprints.find( aFootprintName );

 if( it == footprints.end() )
 return nullptr;

 return it->second->GetFootprint();
}

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

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

GetImportedCachedLibraryFootprints()

std::vector< FOOTPRINT * > PLUGIN::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 EAGLE_PLUGIN, and CADSTAR_PCB_ARCHIVE_PLUGIN.

Definition at line 54 of file plugin.cpp.

{
 not_implemented( this, __FUNCTION__ );
 return std::vector<FOOTPRINT*>();
}

References not_implemented().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

GetLibraryTimestamp()

long long PCB_PLUGIN::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 PLUGIN.

Definition at line 2598 of file pcb_plugin.cpp.

{
 return FP_CACHE::GetTimestamp( aLibraryPath );
}

References FP_CACHE::GetTimestamp().

GetStringOutput()

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

inlineinherited

Definition at line 211 of file pcb_plugin.h.

 {
 std::string ret = m_sf.GetString();

 if( doClear )
 m_sf.Clear();

 return ret;
 }

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

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint().

init()

void PCB_PLUGIN::init ( const PROPERTIES *  aProperties )

protectedinherited

Definition at line 2359 of file pcb_plugin.cpp.

{
 m_board = nullptr;
 m_reader = nullptr;
 m_props = aProperties;
}

References PCB_PLUGIN::m_board, PCB_PLUGIN::m_props, and PCB_PLUGIN::m_reader.

Referenced by PCB_PLUGIN::DoLoad(), PCB_PLUGIN::FootprintDelete(), PCB_PLUGIN::FootprintEnumerate(), PCB_PLUGIN::FootprintLibCreate(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::getFootprint(), PCB_PLUGIN::IsFootprintLibWritable(), Load(), PCB_PLUGIN::PCB_PLUGIN(), Save(), and PCB_PLUGIN::Save().

IsFootprintLibWritable()

bool PCB_PLUGIN::IsFootprintLibWritable ( 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 PLUGIN.

Definition at line 2699 of file pcb_plugin.cpp.

{
 LOCALE_IO toggle;

 init( nullptr );

 validateCache( aLibraryPath );

 return m_cache->IsWritable();
}

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

Load()

BOARD * CLIPBOARD_IO::Load ( const wxString &  aFileName, BOARD *  aAppendToMe, const PROPERTIES *  aProperties = nullptr, PROJECT *  aProject = nullptr, PROGRESS_REPORTER *  aProgressReporter = nullptr  )

overridevirtual

Load information from some input file format that this PLUGIN 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.
aProgressReporter	an optional progress reporter
aLineCount	a line count (necessary if a progress reporter is supplied)

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 PLUGIN.

Definition at line 382 of file kicad_clipboard.cpp.

{
 std::string result;

 wxLogNull doNotLog; // disable logging of failed clipboard actions

 auto clipboard = wxTheClipboard;
 wxClipboardLocker clipboardLock( clipboard );

 if( !clipboardLock )
 return nullptr;

 if( clipboard->IsSupported( wxDF_TEXT ) || clipboard->IsSupported( wxDF_UNICODETEXT ) )
 {
 wxTextDataObject data;
 clipboard->GetData( data );

 result = data.GetText().mb_str();
 }

 STRING_LINE_READER reader(result, wxT( "clipboard" ) );

 init( aProperties );

 m_parser->SetLineReader( &reader );
 m_parser->SetBoard( aAppendToMe );

 BOARD_ITEM* item;
 BOARD* board;

 try
 {
 item = m_parser->Parse();
 }
 catch( const FUTURE_FORMAT_ERROR& )
 {
 // Don't wrap a FUTURE_FORMAT_ERROR in another
 throw;
 }
 catch( const PARSE_ERROR& parse_error )
 {
 if( m_parser->IsTooRecent() )
 throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
 else
 throw;
 }

 if( item->Type() != PCB_T )
 {
 // The parser loaded something that was valid, but wasn't a board.
 THROW_PARSE_ERROR( _( "Clipboard content is not KiCad compatible" ),
 m_parser->CurSource(), m_parser->CurLine(),
 m_parser->CurLineNumber(), m_parser->CurOffset() );
 }
 else
 {
 board = dynamic_cast<BOARD*>( item );
 }

 // Give the filename to the board if it's new
 if( board && !aAppendToMe )
 board->SetFileName( aFileName );

 return board;
}

References _, PCB_PARSER::GetRequiredVersion(), PCB_PLUGIN::init(), PCB_PARSER::IsTooRecent(), PCB_PLUGIN::m_parser, PCB_PARSER::Parse(), PCB_T, PCB_PARSER::SetBoard(), BOARD::SetFileName(), PCB_PARSER::SetLineReader(), THROW_PARSE_ERROR, and EDA_ITEM::Type().

Parse() [1/2]

BOARD_ITEM * CLIPBOARD_IO::Parse

(

)

Definition at line 304 of file kicad_clipboard.cpp.

{
 BOARD_ITEM* item;
 wxString result;

 wxLogNull doNotLog; // disable logging of failed clipboard actions

 auto clipboard = wxTheClipboard;
 wxClipboardLocker clipboardLock( clipboard );

 if( !clipboardLock )
 return nullptr;

 if( clipboard->IsSupported( wxDF_TEXT ) || clipboard->IsSupported( wxDF_UNICODETEXT ) )
 {
 wxTextDataObject data;
 clipboard->GetData( data );
 result = data.GetText();
 }

 try
 {
 item = PCB_PLUGIN::Parse( result );
 }
 catch (...)
 {
 item = nullptr;
 }

 return item;
}

References PCB_PLUGIN::Parse().

Referenced by PCB_CONTROL::Paste().

Parse() [2/2]

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

inherited

Definition at line 378 of file pcb_plugin.cpp.

{
 std::string input = TO_UTF8( aClipboardSourceInput );

 STRING_LINE_READER reader( input, wxT( "clipboard" ) );

 m_parser->SetLineReader( &reader );

 try
 {
 return m_parser->Parse();
 }
 catch( const PARSE_ERROR& parse_error )
 {
 if( m_parser->IsTooRecent() )
 throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
 else
 throw;
 }
}

References PCB_PARSER::GetRequiredVersion(), PCB_PARSER::IsTooRecent(), PCB_PLUGIN::m_parser, PCB_PARSER::Parse(), PCB_PARSER::SetLineReader(), and TO_UTF8.

Referenced by Parse(), and parse_footprint_kicad().

PluginName()

const wxString PCB_PLUGIN::PluginName ( ) const

inlineoverridevirtualinherited

Return a brief hard coded name for this PLUGIN.

Implements PLUGIN.

Definition at line 144 of file pcb_plugin.h.

 {
 return wxT( "KiCad" );
 }

PrefetchLib()

void PLUGIN::PrefetchLib ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

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.

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.

Exceptions

IO_ERROR

if there is an error prefetching the library.

Definition at line 75 of file plugin.cpp.

{
}

Save()

void CLIPBOARD_IO::Save ( const wxString &  aFileName, BOARD *  aBoard, const PROPERTIES *  aProperties = nullptr  )

overridevirtual

Write aBoard to a storage file in a format that this PLUGIN 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_PLUGIN.

Definition at line 337 of file kicad_clipboard.cpp.

{
 init( aProperties );

 m_board = aBoard; // after init()

 // Prepare net mapping that assures that net codes saved in a file are consecutive integers
 m_mapping->SetBoard( aBoard );

 STRING_FORMATTER formatter;

 m_out = &formatter;

 m_out->Print( 0, "(kicad_pcb (version %d) (generator pcbnew)\n", SEXPR_BOARD_FILE_VERSION );

 Format( aBoard, 1 );

 m_out->Print( 0, ")\n" );

 wxLogNull doNotLog; // disable logging of failed clipboard actions

 auto clipboard = wxTheClipboard;
 wxClipboardLocker clipboardLock( clipboard );

 if( !clipboardLock )
 return;

 clipboard->SetData( new wxTextDataObject(
 wxString( m_formatter.GetString().c_str(), wxConvUTF8 ) ) );
 clipboard->Flush();

 // This section exists to return the clipboard data, ensuring it has fully
 // been processed by the system clipboard. This appears to be needed for
 // extremely large clipboard copies on asynchronous linux clipboard managers
 // such as KDE's Klipper
 if( clipboard->IsSupported( wxDF_TEXT ) || clipboard->IsSupported( wxDF_UNICODETEXT ) )
 {
 wxTextDataObject data;
 clipboard->GetData( data );
 ignore_unused( data.GetText() );
 }
}

References PCB_PLUGIN::Format(), STRING_FORMATTER::GetString(), ignore_unused(), PCB_PLUGIN::init(), PCB_PLUGIN::m_board, m_formatter, PCB_PLUGIN::m_mapping, PCB_PLUGIN::m_out, OUTPUTFORMATTER::Print(), NETINFO_MAPPING::SetBoard(), and SEXPR_BOARD_FILE_VERSION.

SaveSelection()

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

Definition at line 63 of file kicad_clipboard.cpp.

{
 VECTOR2I refPoint( 0, 0 );

 // dont even start if the selection is empty
 if( aSelected.Empty() )
 return;

 if( aSelected.HasReferencePoint() )
 refPoint = aSelected.GetReferencePoint();

 // Prepare net mapping that assures that net codes saved in a file are consecutive integers
 m_mapping->SetBoard( m_board );

 if( aSelected.Size() == 1 && aSelected.Front()->Type() == PCB_FOOTPRINT_T )
 {
 // make the footprint safe to transfer to other pcbs
 const FOOTPRINT* footprint = static_cast<FOOTPRINT*>( aSelected.Front() );
 // Do not modify existing board
 FOOTPRINT newFootprint( *footprint );

 for( PAD* pad : newFootprint.Pads() )
 pad->SetNetCode( 0 );

 // locked means "locked in place"; copied items therefore can't be locked
 newFootprint.SetLocked( false );

 // locate the reference point at (0, 0) in the copied items
 newFootprint.Move( wxPoint( -refPoint.x, -refPoint.y ) );

 Format( static_cast<BOARD_ITEM*>( &newFootprint ) );
 }
 else if( isFootprintEditor )
 {
 FOOTPRINT partialFootprint( m_board );

 // Useful to copy the selection to the board editor (if any), and provides
 // a dummy lib id.
 // Perhaps not a good Id, but better than a empty id
 KIID dummy;
 LIB_ID id( "clipboard", dummy.AsString() );
 partialFootprint.SetFPID( id );

 for( const EDA_ITEM* item : aSelected )
 {
 const PCB_GROUP* group = dynamic_cast<const PCB_GROUP*>( item );
 BOARD_ITEM* clone;

 if( const FP_TEXT* text = dyn_cast<const FP_TEXT*>( item ) )
 {
 if( text->GetType() != FP_TEXT::TEXT_is_DIVERS )
 continue;
 }

 if( group )
 clone = static_cast<BOARD_ITEM*>( group->DeepClone() );
 else
 clone = static_cast<BOARD_ITEM*>( item->Clone() );

 // If it is only a footprint, clear the nets from the pads
 if( PAD* pad = dyn_cast<PAD*>( clone ) )
 pad->SetNetCode( 0 );

 // Add the pad to the new footprint before moving to ensure the local coords are
 // correct
 partialFootprint.Add( clone );

 // A list of not added items, when adding items to the footprint
 // some FP_TEXT (reference and value) cannot be added to the footprint
 std::vector<BOARD_ITEM*> skipped_items;

 if( group )
 {
 static_cast<PCB_GROUP*>( clone )->RunOnDescendants(
 [&]( BOARD_ITEM* descendant )
 {
 // One cannot add a text reference or value to a given footprint:
 // only one is allowed. So add only FP_TEXT::TEXT_is_DIVERS
  bool can_add = true;

 if( const FP_TEXT* text = dyn_cast<const FP_TEXT*>( descendant ) )
 {
 if( text->GetType() != FP_TEXT::TEXT_is_DIVERS )
 can_add = false;
 }

 if( can_add )
 partialFootprint.Add( descendant );
 else
 skipped_items.push_back( descendant );
 } );
 }

 // locate the reference point at (0, 0) in the copied items
 clone->Move( (wxPoint) -refPoint );

 // Now delete items, duplicated but not added:
 for( BOARD_ITEM* skp_item : skipped_items )
 delete skp_item;
 }

 // Set the new relative internal local coordinates of copied items
 FOOTPRINT* editedFootprint = m_board->Footprints().front();
 wxPoint moveVector = partialFootprint.GetPosition() + editedFootprint->GetPosition();

 partialFootprint.MoveAnchorPosition( moveVector );

 Format( &partialFootprint, 0 );
 }
 else
 {
 // we will fake being a .kicad_pcb to get the full parser kicking
 // This means we also need layers and nets
 LOCALE_IO io;

 m_formatter.Print( 0, "(kicad_pcb (version %d) (generator pcbnew)\n",
 SEXPR_BOARD_FILE_VERSION );

 m_formatter.Print( 0, "\n" );

 formatBoardLayers( m_board );
 formatNetInformation( m_board );

 m_formatter.Print( 0, "\n" );

 for( EDA_ITEM* i : aSelected )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( i );
 BOARD_ITEM* copy = nullptr;

 if( item->Type() == PCB_FP_SHAPE_T )
 {
 // Convert to PCB_SHAPE_T
 copy = (BOARD_ITEM*) reinterpret_cast<PCB_SHAPE*>( item )->Clone();
 copy->SetLayer( item->GetLayer() );
 }
 else if( item->Type() == PCB_FP_TEXT_T )
 {
 // Convert to PCB_TEXT_T
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( item->GetParent() );
 FP_TEXT* fp_text = static_cast<FP_TEXT*>( item );
 PCB_TEXT* pcb_text = new PCB_TEXT( m_board );

 if( fp_text->GetText() == wxT( "${VALUE}" ) )
 pcb_text->SetText( footprint->GetValue() );
 else if( fp_text->GetText() == wxT( "${REFERENCE}" ) )
 pcb_text->SetText( footprint->GetReference() );
 else
 pcb_text->CopyText( *fp_text );

 pcb_text->SetEffects( *fp_text );
 pcb_text->SetLayer( fp_text->GetLayer() );
 copy = pcb_text;
 }
 else if( item->Type() == PCB_PAD_T )
 {
 // Create a parent to own the copied pad
 FOOTPRINT* footprint = new FOOTPRINT( m_board );
 PAD* pad = (PAD*) item->Clone();

 footprint->SetPosition( pad->GetPosition() );
 pad->SetPos0( wxPoint() );
 footprint->Add( pad );
 copy = footprint;
 }
 else if( item->Type() == PCB_FP_ZONE_T )
 {
 // Convert to PCB_ZONE_T
 ZONE* zone = new ZONE( m_board );
 zone->InitDataFromSrcInCopyCtor( *static_cast<ZONE*>( item ) );
 copy = zone;
 }
 else if( item->Type() == PCB_GROUP_T )
 {
 copy = static_cast<PCB_GROUP*>( item )->DeepClone();
 }
 else
 {
 copy = static_cast<BOARD_ITEM*>( item->Clone() );
 }

 auto prepItem = [&]( BOARD_ITEM* aItem )
 {
 aItem->SetLocked( false );
 };

 if( copy )
 {
 prepItem( copy );

 // locate the reference point at (0, 0) in the copied items
 copy->Move( (wxPoint) -refPoint );

 Format( copy, 1 );

 if( copy->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( copy )->RunOnDescendants( prepItem );
 static_cast<PCB_GROUP*>( copy )->RunOnDescendants( [&]( BOARD_ITEM* titem )
 {
 Format( titem, 1 );
 } );
 }

 delete copy;
 }
 }
 m_formatter.Print( 0, "\n)" );
 }

 // These are placed at the end to minimize the open time of the clipboard
 wxLogNull doNotLog; // disable logging of failed clipboard actions
 auto clipboard = wxTheClipboard;
 wxClipboardLocker clipboardLock( clipboard );

 if( !clipboardLock || !clipboard->IsOpened() )
 return;

 clipboard->SetData( new wxTextDataObject( wxString( m_formatter.GetString().c_str(),
 wxConvUTF8 ) ) );

 clipboard->Flush();

 #ifndef __WXOSX__
 // This section exists to return the clipboard data, ensuring it has fully
 // been processed by the system clipboard. This appears to be needed for
 // extremely large clipboard copies on asynchronous linux clipboard managers
 // such as KDE's Klipper. However, a read back of the data on OSX before the
 // clipboard is closed seems to cause an ASAN error (heap-buffer-overflow)
 // since it uses the cached version of the clipboard data and not the system
 // clipboard data.
 if( clipboard->IsSupported( wxDF_TEXT ) || clipboard->IsSupported( wxDF_UNICODETEXT ) )
 {
 wxTextDataObject data;
 clipboard->GetData( data );
 ignore_unused( data.GetText() );
 }
 #endif
}

References FOOTPRINT::Add(), EDA_ITEM::Clone(), copy, EDA_TEXT::CopyText(), dummy(), SELECTION::Empty(), BOARD::Footprints(), PCB_PLUGIN::Format(), PCB_PLUGIN::formatBoardLayers(), PCB_PLUGIN::formatNetInformation(), SELECTION::Front(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParent(), FOOTPRINT::GetPosition(), FOOTPRINT::GetReference(), SELECTION::GetReferencePoint(), STRING_FORMATTER::GetString(), FOOTPRINT::GetValue(), group, SELECTION::HasReferencePoint(), ignore_unused(), ZONE::InitDataFromSrcInCopyCtor(), PCB_PLUGIN::m_board, m_formatter, PCB_PLUGIN::m_mapping, FOOTPRINT::MoveAnchorPosition(), pad, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, OUTPUTFORMATTER::Print(), NETINFO_MAPPING::SetBoard(), EDA_TEXT::SetEffects(), FOOTPRINT::SetFPID(), BOARD_ITEM::SetLayer(), FOOTPRINT::SetPosition(), EDA_TEXT::SetText(), SEXPR_BOARD_FILE_VERSION, SELECTION::Size(), text, FP_TEXT::TEXT_is_DIVERS, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDIT_TOOL::copyToClipboard().

SetBoard()

void CLIPBOARD_IO::SetBoard

(

BOARD *

aBoard

)

Definition at line 57 of file kicad_clipboard.cpp.

{
 m_board = aBoard;
}

References PCB_PLUGIN::m_board.

Referenced by EDIT_TOOL::copyToClipboard().

SetOutputFormatter()

void PCB_PLUGIN::SetOutputFormatter ( OUTPUTFORMATTER *  aFormatter )

inlineinherited

Definition at line 221 of file pcb_plugin.h.

{ m_out = aFormatter; }

References PCB_PLUGIN::m_out.

Referenced by FP_CACHE::Save().

validateCache()

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

protectedinherited

Definition at line 2367 of file pcb_plugin.cpp.

{
 if( !m_cache || !m_cache->IsPath( aLibraryPath ) || ( checkModified && m_cache->IsModified() ) )
 {
 // a spectacular episode in memory management:
 delete m_cache;
 m_cache = new FP_CACHE( this, aLibraryPath );
 m_cache->Load();
 }
}

References PCB_PLUGIN::FP_CACHE, FP_CACHE::IsModified(), FP_CACHE::IsPath(), FP_CACHE::Load(), and PCB_PLUGIN::m_cache.

Referenced by PCB_PLUGIN::FootprintDelete(), PCB_PLUGIN::FootprintEnumerate(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::getFootprint(), and PCB_PLUGIN::IsFootprintLibWritable().

Member Data Documentation

m_board

BOARD* PCB_PLUGIN::m_board

protectedinherited

which BOARD, no ownership here

Definition at line 284 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::formatBoardLayers(), PCB_PLUGIN::init(), Save(), PCB_PLUGIN::Save(), SaveSelection(), and SetBoard().

m_cache

FP_CACHE* PCB_PLUGIN::m_cache

protectedinherited

Footprint library cache.

Definition at line 288 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::FootprintDelete(), PCB_PLUGIN::FootprintEnumerate(), PCB_PLUGIN::FootprintLibCreate(), PCB_PLUGIN::FootprintLibDelete(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::getFootprint(), PCB_PLUGIN::IsFootprintLibWritable(), PCB_PLUGIN::validateCache(), and PCB_PLUGIN::~PCB_PLUGIN().

m_ctl

int PCB_PLUGIN::m_ctl

protectedinherited

Definition at line 295 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::format(), and PCB_PLUGIN::formatGeneral().

m_error

wxString PCB_PLUGIN::m_error

protectedinherited

for throwing exceptions

Definition at line 283 of file pcb_plugin.h.

m_filename

wxString PCB_PLUGIN::m_filename

protectedinherited

for saves only, name is in m_reader for loads

Definition at line 291 of file pcb_plugin.h.

m_formatter

STRING_FORMATTER CLIPBOARD_IO::m_formatter

private

Definition at line 68 of file kicad_clipboard.h.

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

m_mapping

NETINFO_MAPPING* PCB_PLUGIN::m_mapping

protectedinherited

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

Definition at line 297 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::format(), PCB_PLUGIN::formatNetInformation(), Save(), PCB_PLUGIN::Save(), SaveSelection(), and PCB_PLUGIN::~PCB_PLUGIN().

m_out

OUTPUTFORMATTER* PCB_PLUGIN::m_out

protectedinherited

output any Format()s to this, no ownership

Definition at line 294 of file pcb_plugin.h.

Referenced by CLIPBOARD_IO(), PCB_PLUGIN::format(), PCB_PLUGIN::formatBoardLayers(), PCB_PLUGIN::formatGeneral(), PCB_PLUGIN::formatLayer(), PCB_PLUGIN::formatLayers(), PCB_PLUGIN::formatNetInformation(), PCB_PLUGIN::formatProperties(), PCB_PLUGIN::formatSetup(), PCB_PLUGIN::PCB_PLUGIN(), Save(), PCB_PLUGIN::Save(), and PCB_PLUGIN::SetOutputFormatter().

m_parser

PCB_PARSER* PCB_PLUGIN::m_parser

protectedinherited

Definition at line 296 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::DoLoad(), Load(), FP_CACHE::Load(), PCB_PLUGIN::Parse(), and PCB_PLUGIN::~PCB_PLUGIN().

m_props

const PROPERTIES* PCB_PLUGIN::m_props

protectedinherited

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

Definition at line 287 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::init().

m_reader

LINE_READER* PCB_PLUGIN::m_reader

protectedinherited

no ownership here.

Definition at line 290 of file pcb_plugin.h.

Referenced by PCB_PLUGIN::init().

m_sf

STRING_FORMATTER PCB_PLUGIN::m_sf

protectedinherited

Definition at line 293 of file pcb_plugin.h.

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

---

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

• kicad_clipboard.h
• kicad_clipboard.cpp