A PLUGIN derivation for saving and loading Pcbnew s-expression formatted files. More...

#include <pcb_plugin.h>

Inheritance diagram for PCB_PLUGIN:

Public Member Functions
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...

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

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

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

	PCB_PLUGIN (int aControlFlags=CTL_FOR_BOARD)

virtual	~PCB_PLUGIN ()

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 Member Functions
void	format (const BOARD *aBoard, int aNestLevel=0) const

void	format (const PCB_DIMENSION_BASE *aDimension, int aNestLevel=0) const

void	format (const FP_SHAPE *aFPShape, int aNestLevel=0) const

void	format (const PCB_GROUP *aGroup, int aNestLevel=0) const

void	format (const PCB_SHAPE *aSegment, int aNestLevel=0) const

void	format (const PCB_TARGET *aTarget, int aNestLevel=0) const

void	format (const FOOTPRINT *aFootprint, int aNestLevel=0) const

void	format (const PAD *aPad, int aNestLevel=0) const

void	format (const PCB_TEXT *aText, int aNestLevel=0) const

void	format (const FP_TEXT *aText, int aNestLevel=0) const

void	format (const PCB_TRACK *aTrack, int aNestLevel=0) const

void	format (const ZONE *aZone, int aNestLevel=0) const

void	formatLayer (const BOARD_ITEM *aItem) const

void	formatLayers (LSET aLayerMask, int aNestLevel=0) const

Friends
class	FP_CACHE

Detailed Description

A PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.

Note: This class is not thread safe, but it is re-entrant multiple times in sequence.

Definition at line 141 of file pcb_plugin.h.

Constructor & Destructor Documentation

◆ PCB_PLUGIN()

PCB_PLUGIN::PCB_PLUGIN ( int aControlFlags = CTL_FOR_BOARD )

Definition at line 2269 of file pcb_plugin.cpp.

  :
  m_cache( nullptr ),
  m_ctl( aControlFlags ),
  m_parser( new PCB_PARSER() ),
  m_mapping( new NETINFO_MAPPING() )
 {
  init( nullptr );
  m_out = &m_sf;
 }

References init(), m_out, and m_sf.

◆ ~PCB_PLUGIN()

PCB_PLUGIN::~PCB_PLUGIN ( )

virtual

Definition at line 2280 of file pcb_plugin.cpp.

 {
  delete m_cache;
  delete m_parser;
  delete m_mapping;
 }

References m_cache, m_mapping, and m_parser.

Member Function Documentation

◆ DoLoad()

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

Definition at line 2318 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(), init(), PCB_PARSER::IsTooRecent(), 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 Load().

◆ FootprintDelete()

void PCB_PLUGIN::FootprintDelete	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const PROPERTIES *	aProperties = `nullptr`
	)

overridevirtual

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 2576 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(), init(), FP_CACHE::IsWritable(), m_cache, FP_CACHE::Remove(), THROW_IO_ERROR, and validateCache().

◆ FootprintEnumerate()

void PCB_PLUGIN::FootprintEnumerate	(	wxArrayString &	aFootprintNames,
		const wxString &	aLibraryPath,
		bool	aBestEfforts,
		const PROPERTIES *	aProperties = `nullptr`
	)

overridevirtual

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 2377 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(), init(), m_cache, THROW_IO_ERROR, validateCache(), and IO_ERROR::What().

◆ FootprintExists()

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

overridevirtual

Check for the existence of a footprint.

Reimplemented from PLUGIN.

Definition at line 2442 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`
	)

overridevirtual

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 2602 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(), FP_CACHE, init(), m_cache, FP_CACHE::Save(), and THROW_IO_ERROR.

◆ FootprintLibDelete()

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

overridevirtual

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 2620 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, 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`
	)

overridevirtual

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

◆ FootprintSave()

void PCB_PLUGIN::FootprintSave	(	const wxString &	aLibraryPath,
		const FOOTPRINT *	aFootprint,
		const PROPERTIES *	aProperties = `nullptr`
	)

overridevirtual

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 2482 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(), init(), FP_CACHE::IsWritable(), KiCadFootprintFileExtension, Kiface(), m_cache, m_ctl, PCBNEW_SETTINGS::m_FlipLeftRight, WX_FILENAME::ResolvePossibleSymlinks(), FP_CACHE::Save(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), THROW_IO_ERROR, traceKicadPcbPlugin, and validateCache().

◆ Format()

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

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 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(), format(), CLIPBOARD_IO::Save(), FP_CACHE::Save(), Save(), and CLIPBOARD_IO::SaveSelection().

◆ format() [1/12]

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

private

Definition at line 660 of file pcb_plugin.cpp.

 {
  std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_footprints( aBoard->Footprints().begin(),
  aBoard->Footprints().end() );
  std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_drawings( aBoard->Drawings().begin(),
  aBoard->Drawings().end() );
  std::set<PCB_TRACK*, PCB_TRACK::cmp_tracks> sorted_tracks( aBoard->Tracks().begin(),
  aBoard->Tracks().end() );
  std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_zones( aBoard->Zones().begin(),
  aBoard->Zones().end() );
  std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_groups( aBoard->Groups().begin(),
  aBoard->Groups().end() );
  formatHeader( aBoard, aNestLevel );
 
  // Save the footprints.
  for( BOARD_ITEM* footprint : sorted_footprints )
  {
  Format( footprint, aNestLevel );
  m_out->Print( 0, "\n" );
  }
 
  // Save the graphical items on the board (not owned by a footprint)
  for( BOARD_ITEM* item : sorted_drawings )
  Format( item, aNestLevel );
 
  if( sorted_drawings.size() )
  m_out->Print( 0, "\n" );
 
  // Do not save PCB_MARKERs, they can be regenerated easily.
 
  // Save the tracks and vias.
  for( PCB_TRACK* track : sorted_tracks )
  Format( track, aNestLevel );
 
  if( sorted_tracks.size() )
  m_out->Print( 0, "\n" );
 
  // Save the polygon (which are the newer technology) zones.
  for( auto zone : sorted_zones )
  Format( zone, aNestLevel );
 
  // Save the groups
  for( BOARD_ITEM* group : sorted_groups )
  Format( group, aNestLevel );
 }

References BOARD::Drawings(), BOARD::Footprints(), Format(), formatHeader(), group, BOARD::Groups(), m_out, OUTPUTFORMATTER::Print(), BOARD::Tracks(), and BOARD::Zones().

Referenced by Format().

◆ format() [2/12]

void PCB_PLUGIN::format	(	const PCB_DIMENSION_BASE *	aDimension,
		int	aNestLevel = `0`
	)		const

private

Definition at line 707 of file pcb_plugin.cpp.

 {
  const PCB_DIM_ALIGNED* aligned = dynamic_cast<const PCB_DIM_ALIGNED*>( aDimension );
  const PCB_DIM_ORTHOGONAL* ortho = dynamic_cast<const PCB_DIM_ORTHOGONAL*>( aDimension );
  const PCB_DIM_CENTER* center = dynamic_cast<const PCB_DIM_CENTER*>( aDimension );
  const PCB_DIM_LEADER* leader = dynamic_cast<const PCB_DIM_LEADER*>( aDimension );
 
  m_out->Print( aNestLevel, "(dimension" );
 
  if( aDimension->IsLocked() )
  m_out->Print( 0, " locked" );
 
  if( aDimension->Type() == PCB_DIM_ALIGNED_T )
  m_out->Print( 0, " (type aligned)" );
  else if( aDimension->Type() == PCB_DIM_LEADER_T )
  m_out->Print( 0, " (type leader)" );
  else if( aDimension->Type() == PCB_DIM_CENTER_T )
  m_out->Print( 0, " (type center)" );
  else if( aDimension->Type() == PCB_DIM_ORTHOGONAL_T )
  m_out->Print( 0, " (type orthogonal)" );
  else
  wxFAIL_MSG( wxT( "Cannot format unknown dimension type!" ) );
 
  formatLayer( aDimension );
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aDimension->m_Uuid.AsString() ) );
 
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel+1, "(pts (xy %s %s) (xy %s %s))\n",
  FormatInternalUnits( aDimension->GetStart().x ).c_str(),
  FormatInternalUnits( aDimension->GetStart().y ).c_str(),
  FormatInternalUnits( aDimension->GetEnd().x ).c_str(),
  FormatInternalUnits( aDimension->GetEnd().y ).c_str() );
 
  if( aligned )
  {
  m_out->Print( aNestLevel+1, "(height %s)\n",
  FormatInternalUnits( aligned->GetHeight() ).c_str() );
  }
 
  if( ortho )
  {
  m_out->Print( aNestLevel+1, "(orientation %d)\n",
  static_cast<int>( ortho->GetOrientation() ) );
  }
 
  if( !center )
  {
  Format( &aDimension->Text(), aNestLevel + 1 );
 
  m_out->Print( aNestLevel + 1, "(format" );
 
  if( !aDimension->GetPrefix().IsEmpty() )
  m_out->Print( 0, " (prefix %s)", m_out->Quotew( aDimension->GetPrefix() ).c_str() );
 
  if( !aDimension->GetSuffix().IsEmpty() )
  m_out->Print( 0, " (suffix %s)", m_out->Quotew( aDimension->GetSuffix() ).c_str() );
 
  m_out->Print( 0, " (units %d) (units_format %d) (precision %d)",
  static_cast<int>( aDimension->GetUnitsMode() ),
  static_cast<int>( aDimension->GetUnitsFormat() ), aDimension->GetPrecision() );
 
  if( aDimension->GetOverrideTextEnabled() )
  m_out->Print( 0, " (override_value %s)",
  m_out->Quotew( aDimension->GetOverrideText() ).c_str() );
 
  if( aDimension->GetSuppressZeroes() )
  m_out->Print( 0, " suppress_zeroes" );
 
  m_out->Print( 0, ")\n" );
  }
 
  m_out->Print( aNestLevel+1, "(style (thickness %s) (arrow_length %s) (text_position_mode %d)",
  FormatInternalUnits( aDimension->GetLineThickness() ).c_str(),
  FormatInternalUnits( aDimension->GetArrowLength() ).c_str(),
  static_cast<int>( aDimension->GetTextPositionMode() ) );
 
  if( aligned )
  {
  m_out->Print( 0, " (extension_height %s)",
  FormatInternalUnits( aligned->GetExtensionHeight() ).c_str() );
  }
 
  if( leader )
  m_out->Print( 0, " (text_frame %d)", static_cast<int>( leader->GetTextFrame() ) );
 
  m_out->Print( 0, " (extension_offset %s)",
  FormatInternalUnits( aDimension->GetExtensionOffset() ).c_str() );
 
  if( aDimension->GetKeepTextAligned() )
  m_out->Print( 0, " keep_text_aligned" );
 
  m_out->Print( 0, ")\n" );
 
  m_out->Print( aNestLevel, ")\n" );
 }

◆ format() [3/12]

void PCB_PLUGIN::format	(	const FP_SHAPE *	aFPShape,
		int	aNestLevel = `0`
	)		const

private

Definition at line 939 of file pcb_plugin.cpp.

 {
  std::string locked = aFPShape->IsLocked() ? " locked" : "";
 
  switch( aFPShape->GetShape() )
  {
  case SHAPE_T::SEGMENT:
  m_out->Print( aNestLevel, "(fp_line%s (start %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aFPShape->GetStart0() ).c_str(),
  FormatInternalUnits( aFPShape->GetEnd0() ).c_str() );
  break;
 
  case SHAPE_T::RECT:
  m_out->Print( aNestLevel, "(fp_rect%s (start %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aFPShape->GetStart0() ).c_str(),
  FormatInternalUnits( aFPShape->GetEnd0() ).c_str() );
  break;
 
  case SHAPE_T::CIRCLE:
  m_out->Print( aNestLevel, "(fp_circle%s (center %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aFPShape->GetStart0() ).c_str(),
  FormatInternalUnits( aFPShape->GetEnd0() ).c_str() );
  break;
 
  case SHAPE_T::ARC:
  m_out->Print( aNestLevel, "(fp_arc%s (start %s) (mid %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aFPShape->GetStart0() ).c_str(),
  FormatInternalUnits( aFPShape->GetArcMid0() ).c_str(),
  FormatInternalUnits( aFPShape->GetEnd0() ).c_str() );
  break;
 
  case SHAPE_T::POLY:
  if( aFPShape->IsPolyShapeValid() )
  {
  const SHAPE_POLY_SET& poly = aFPShape->GetPolyShape();
  const SHAPE_LINE_CHAIN& outline = poly.Outline( 0 );
 
  m_out->Print( aNestLevel, "(fp_poly%s (pts",
  locked.c_str() );
 
  bool need_newline = false;
 
  for( int ii = 0; ii < outline.PointCount(); ++ii )
  {
  int nestLevel = 0;
 
  if( !( ii % 4 ) || !ADVANCED_CFG::GetCfg().m_CompactSave )
  {
  // newline every 4 pts.
  m_out->Print( 0, "\n" );
  need_newline = false;
  nestLevel = aNestLevel + 2;
  }
 
  int ind = outline.ArcIndex( ii );
 
  if( ind < 0 )
  {
  m_out->Print( nestLevel, "%s(xy %s)",
  nestLevel ? "" : " ",
  FormatInternalUnits( outline.CPoint( ii ) ).c_str() );
  need_newline = true;
  }
  else
  {
  auto& arc = outline.Arc( ind );
  m_out->Print( nestLevel, "%s(arc (start %s) (mid %s) (end %s))",
  nestLevel ? "" : " ",
   FormatInternalUnits( arc.GetP0() ).c_str(),
  FormatInternalUnits( arc.GetArcMid() ).c_str(),
  FormatInternalUnits( arc.GetP1() ).c_str() );
  need_newline = true;
 
  do
  {
  ++ii;
  } while( ii < outline.PointCount() && outline.ArcIndex( ii ) == ind );
 
  --ii;
  }
  }
 
  if( need_newline )
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel + 1, ")" );
  }
  else
  {
  wxFAIL_MSG( wxT( "Cannot format invalid polygon." ) );
  return;
  }
  break;
 
  case SHAPE_T::BEZIER:
  m_out->Print( aNestLevel, "(fp_curve%s (pts (xy %s) (xy %s) (xy %s) (xy %s))",
  locked.c_str(),
  FormatInternalUnits( aFPShape->GetStart0() ).c_str(),
  FormatInternalUnits( aFPShape->GetBezierC1_0() ).c_str(),
  FormatInternalUnits( aFPShape->GetBezierC2_0() ).c_str(),
  FormatInternalUnits( aFPShape->GetEnd0() ).c_str() );
  break;
 
  default:
  wxFAIL_MSG( "PCB_PLUGIN::format not implemented for " + aFPShape->SHAPE_T_asString() );
  return;
  };
 
  formatLayer( aFPShape );
 
  m_out->Print( 0, " (width %s)", FormatInternalUnits( aFPShape->GetWidth() ).c_str() );
 
  // The filled flag represents if a solid fill is present on circles, rectangles and polygons
  if( ( aFPShape->GetShape() == SHAPE_T::POLY )
  || ( aFPShape->GetShape() == SHAPE_T::RECT )
  || ( aFPShape->GetShape() == SHAPE_T::CIRCLE ) )
  {
  if( aFPShape->IsFilled() )
  m_out->Print( 0, " (fill solid)" );
  else
  m_out->Print( 0, " (fill none)" );
  }
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aFPShape->m_Uuid.AsString() ) );
 
  m_out->Print( 0, ")\n" );
 }

References ARC, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), KIID::AsString(), BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), FormatInternalUnits(), formatLayer(), FP_SHAPE::GetArcMid0(), FP_SHAPE::GetBezierC1_0(), FP_SHAPE::GetBezierC2_0(), ADVANCED_CFG::GetCfg(), FP_SHAPE::GetEnd0(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), FP_SHAPE::GetStart0(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), BOARD_ITEM::IsLocked(), EDA_SHAPE::IsPolyShapeValid(), locked, ADVANCED_CFG::m_CompactSave, m_out, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), SHAPE_LINE_CHAIN::PointCount(), POLY, OUTPUTFORMATTER::Print(), RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and TO_UTF8.

◆ format() [4/12]

void PCB_PLUGIN::format	(	const PCB_GROUP *	aGroup,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1767 of file pcb_plugin.cpp.

 {
  // Don't write empty groups
  if( aGroup->GetItems().empty() )
  return;
 
  m_out->Print( aNestLevel, "(group %s%s (id %s)\n",
  m_out->Quotew( aGroup->GetName() ).c_str(),
  aGroup->IsLocked() ? " locked" : "",
  TO_UTF8( aGroup->m_Uuid.AsString() ) );
 
  m_out->Print( aNestLevel + 1, "(members\n" );
 
  wxArrayString memberIds;
 
  for( BOARD_ITEM* member : aGroup->GetItems() )
  memberIds.Add( member->m_Uuid.AsString() );
 
  memberIds.Sort();
 
  for( const wxString& memberId : memberIds )
  m_out->Print( aNestLevel + 2, "%s\n", TO_UTF8( memberId ) );
 
  m_out->Print( aNestLevel + 1, ")\n" ); // Close `members` token.
  m_out->Print( aNestLevel, ")\n" ); // Close `group` token.
 }

References KIID::AsString(), PCB_GROUP::GetItems(), PCB_GROUP::GetName(), BOARD_ITEM::IsLocked(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.

◆ format() [5/12]

void PCB_PLUGIN::format	(	const PCB_SHAPE *	aSegment,
		int	aNestLevel = `0`
	)		const

private

Definition at line 806 of file pcb_plugin.cpp.

 {
  std::string locked = aShape->IsLocked() ? " locked" : "";
 
  switch( aShape->GetShape() )
  {
  case SHAPE_T::SEGMENT:
  m_out->Print( aNestLevel, "(gr_line%s (start %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aShape->GetStart() ).c_str(),
  FormatInternalUnits( aShape->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::RECT:
  m_out->Print( aNestLevel, "(gr_rect%s (start %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aShape->GetStart() ).c_str(),
  FormatInternalUnits( aShape->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::CIRCLE:
  m_out->Print( aNestLevel, "(gr_circle%s (center %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aShape->GetStart() ).c_str(),
  FormatInternalUnits( aShape->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::ARC:
  m_out->Print( aNestLevel, "(gr_arc%s (start %s) (mid %s) (end %s)",
  locked.c_str(),
  FormatInternalUnits( aShape->GetStart() ).c_str(),
  FormatInternalUnits( aShape->GetArcMid() ).c_str(),
  FormatInternalUnits( aShape->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::POLY:
  if( aShape->IsPolyShapeValid() )
  {
  const SHAPE_POLY_SET& poly = aShape->GetPolyShape();
  const SHAPE_LINE_CHAIN& outline = poly.Outline( 0 );
 
  m_out->Print( aNestLevel, "(gr_poly%s\n", locked.c_str() );
  m_out->Print( aNestLevel + 1, "(pts\n" );
 
  bool needNewline = false;
  int nestLevel = aNestLevel + 2;
  int shapesAdded = 0;
 
  for( int ii = 0; ii < outline.PointCount(); ++ii )
  {
  int ind = outline.ArcIndex( ii );
 
  if( ind < 0 )
  {
  m_out->Print( nestLevel, "(xy %s)",
  FormatInternalUnits( outline.CPoint( ii ) ).c_str() );
  needNewline = true;
  }
  else
  {
  const SHAPE_ARC& arc = outline.Arc( ind );
  m_out->Print( nestLevel, "(arc (start %s) (mid %s) (end %s))",
  FormatInternalUnits( arc.GetP0() ).c_str(),
  FormatInternalUnits( arc.GetArcMid() ).c_str(),
  FormatInternalUnits( arc.GetP1() ).c_str() );
  needNewline = true;
 
  do
  {
  ++ii;
  } while( ii < outline.PointCount() && outline.ArcIndex( ii ) == ind );
 
  --ii;
  }
 
  ++shapesAdded;
 
  if( !( shapesAdded % 4 ) || !ADVANCED_CFG::GetCfg().m_CompactSave )
  {
  // newline every 4 shapes if compact save
  m_out->Print( 0, "\n" );
  needNewline = false;
  }
  }
 
  if( needNewline )
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel + 1, ")" );
  }
  else
  {
  wxFAIL_MSG( wxT( "Cannot format invalid polygon." ) );
  return;
  }
 
  break;
 
  case SHAPE_T::BEZIER:
  m_out->Print( aNestLevel, "(gr_curve%s (pts (xy %s) (xy %s) (xy %s) (xy %s))",
  locked.c_str(),
  FormatInternalUnits( aShape->GetStart() ).c_str(),
  FormatInternalUnits( aShape->GetBezierC1() ).c_str(),
  FormatInternalUnits( aShape->GetBezierC2() ).c_str(),
  FormatInternalUnits( aShape->GetEnd() ).c_str() );
  break;
 
  default:
  UNIMPLEMENTED_FOR( aShape->SHAPE_T_asString() );
  return;
  };
 
  formatLayer( aShape );
 
  m_out->Print( 0, " (width %s)", FormatInternalUnits( aShape->GetWidth() ).c_str() );
 
  // The filled flag represents if a solid fill is present on circles, rectangles and polygons
  if( ( aShape->GetShape() == SHAPE_T::POLY )
  || ( aShape->GetShape() == SHAPE_T::RECT )
  || ( aShape->GetShape() == SHAPE_T::CIRCLE ) )
  {
  if( aShape->IsFilled() )
  m_out->Print( 0, " (fill solid)" );
  else
  m_out->Print( 0, " (fill none)" );
  }
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aShape->m_Uuid.AsString() ) );
 
  m_out->Print( 0, ")\n" );
 }

References ARC, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), KIID::AsString(), BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), FormatInternalUnits(), formatLayer(), SHAPE_ARC::GetArcMid(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), ADVANCED_CFG::GetCfg(), EDA_SHAPE::GetEnd(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), BOARD_ITEM::IsLocked(), EDA_SHAPE::IsPolyShapeValid(), locked, ADVANCED_CFG::m_CompactSave, m_out, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), SHAPE_LINE_CHAIN::PointCount(), POLY, OUTPUTFORMATTER::Print(), RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), TO_UTF8, and UNIMPLEMENTED_FOR.

◆ format() [6/12]

void PCB_PLUGIN::format	(	const PCB_TARGET *	aTarget,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1072 of file pcb_plugin.cpp.

 {
  m_out->Print( aNestLevel, "(target %s (at %s) (size %s)",
  ( aTarget->GetShape() ) ? "x" : "plus",
  FormatInternalUnits( aTarget->GetPosition() ).c_str(),
  FormatInternalUnits( aTarget->GetSize() ).c_str() );
 
  if( aTarget->GetWidth() != 0 )
  m_out->Print( 0, " (width %s)", FormatInternalUnits( aTarget->GetWidth() ).c_str() );
 
  formatLayer( aTarget );
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aTarget->m_Uuid.AsString() ) );
 
  m_out->Print( 0, ")\n" );
 }

References KIID::AsString(), FormatInternalUnits(), formatLayer(), PCB_TARGET::GetPosition(), PCB_TARGET::GetShape(), PCB_TARGET::GetSize(), PCB_TARGET::GetWidth(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), and TO_UTF8.

◆ format() [7/12]

void PCB_PLUGIN::format	(	const FOOTPRINT *	aFootprint,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1090 of file pcb_plugin.cpp.

 {
  if( !( m_ctl & CTL_OMIT_INITIAL_COMMENTS ) )
  {
  const wxArrayString* initial_comments = aFootprint->GetInitialComments();
 
  if( initial_comments )
  {
  for( unsigned i = 0; i < initial_comments->GetCount(); ++i )
  m_out->Print( aNestLevel, "%s\n", TO_UTF8( (*initial_comments)[i] ) );
 
  m_out->Print( 0, "\n" ); // improve readability?
  }
  }
 
  if( m_ctl & CTL_OMIT_LIBNAME )
  m_out->Print( aNestLevel, "(footprint %s",
  m_out->Quotes( aFootprint->GetFPID().GetLibItemName() ).c_str() );
  else
  m_out->Print( aNestLevel, "(footprint %s",
  m_out->Quotes( aFootprint->GetFPID().Format() ).c_str() );
 
  if( !( m_ctl & CTL_OMIT_FOOTPRINT_VERSION ) )
  m_out->Print( 0, " (version %d) (generator pcbnew)\n ", SEXPR_BOARD_FILE_VERSION );
 
  if( aFootprint->IsLocked() )
  m_out->Print( 0, " locked" );
 
  if( aFootprint->IsPlaced() )
  m_out->Print( 0, " placed" );
 
  formatLayer( aFootprint );
 
  m_out->Print( 0, "\n" );
  m_out->Print( aNestLevel+1, "(tedit %lX)", (unsigned long)aFootprint->GetLastEditTime() );
 
  if( !( m_ctl & CTL_OMIT_TSTAMPS ) )
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aFootprint->m_Uuid.AsString() ) );
 
  m_out->Print( 0, "\n" );
 
  if( !( m_ctl & CTL_OMIT_AT ) )
  {
  m_out->Print( aNestLevel+1, "(at %s",
  FormatInternalUnits( aFootprint->GetPosition() ).c_str() );
 
  if( aFootprint->GetOrientation() != 0.0 )
  m_out->Print( 0, " %s", FormatAngle( aFootprint->GetOrientation() ).c_str() );
 
  m_out->Print( 0, ")\n" );
  }
 
  if( !aFootprint->GetDescription().IsEmpty() )
  m_out->Print( aNestLevel+1, "(descr %s)\n",
  m_out->Quotew( aFootprint->GetDescription() ).c_str() );
 
  if( !aFootprint->GetKeywords().IsEmpty() )
  m_out->Print( aNestLevel+1, "(tags %s)\n",
  m_out->Quotew( aFootprint->GetKeywords() ).c_str() );
 
  const std::map<wxString, wxString>& props = aFootprint->GetProperties();
 
  for( const std::pair<const wxString, wxString>& prop : props )
  {
  m_out->Print( aNestLevel+1, "(property %s %s)\n",
  m_out->Quotew( prop.first ).c_str(),
  m_out->Quotew( prop.second ).c_str() );
  }
 
  if( !( m_ctl & CTL_OMIT_PATH ) && !aFootprint->GetPath().empty() )
  m_out->Print( aNestLevel+1, "(path %s)\n",
  m_out->Quotew( aFootprint->GetPath().AsString() ).c_str() );
 
  if( aFootprint->GetPlacementCost90() != 0 )
  m_out->Print( aNestLevel+1, "(autoplace_cost90 %d)\n", aFootprint->GetPlacementCost90() );
 
  if( aFootprint->GetPlacementCost180() != 0 )
  m_out->Print( aNestLevel+1, "(autoplace_cost180 %d)\n", aFootprint->GetPlacementCost180() );
 
  if( aFootprint->GetLocalSolderMaskMargin() != 0 )
  m_out->Print( aNestLevel+1, "(solder_mask_margin %s)\n",
  FormatInternalUnits( aFootprint->GetLocalSolderMaskMargin() ).c_str() );
 
  if( aFootprint->GetLocalSolderPasteMargin() != 0 )
  m_out->Print( aNestLevel+1, "(solder_paste_margin %s)\n",
  FormatInternalUnits( aFootprint->GetLocalSolderPasteMargin() ).c_str() );
 
  if( aFootprint->GetLocalSolderPasteMarginRatio() != 0 )
  m_out->Print( aNestLevel+1, "(solder_paste_ratio %s)\n",
  Double2Str( aFootprint->GetLocalSolderPasteMarginRatio() ).c_str() );
 
  if( aFootprint->GetLocalClearance() != 0 )
  m_out->Print( aNestLevel+1, "(clearance %s)\n",
  FormatInternalUnits( aFootprint->GetLocalClearance() ).c_str() );
 
  if( aFootprint->GetZoneConnection() != ZONE_CONNECTION::INHERITED )
  m_out->Print( aNestLevel+1, "(zone_connect %d)\n",
  static_cast<int>( aFootprint->GetZoneConnection() ) );
 
  if( aFootprint->GetThermalWidth() != 0 )
  m_out->Print( aNestLevel+1, "(thermal_width %s)\n",
  FormatInternalUnits( aFootprint->GetThermalWidth() ).c_str() );
 
  if( aFootprint->GetThermalGap() != 0 )
  m_out->Print( aNestLevel+1, "(thermal_gap %s)\n",
  FormatInternalUnits( aFootprint->GetThermalGap() ).c_str() );
 
  // Attributes
  if( aFootprint->GetAttributes() )
  {
  m_out->Print( aNestLevel+1, "(attr" );
 
  if( aFootprint->GetAttributes() & FP_SMD )
  m_out->Print( 0, " smd" );
 
  if( aFootprint->GetAttributes() & FP_THROUGH_HOLE )
  m_out->Print( 0, " through_hole" );
 
  if( aFootprint->GetAttributes() & FP_BOARD_ONLY )
  m_out->Print( 0, " board_only" );
 
  if( aFootprint->GetAttributes() & FP_EXCLUDE_FROM_POS_FILES )
  m_out->Print( 0, " exclude_from_pos_files" );
 
  if( aFootprint->GetAttributes() & FP_EXCLUDE_FROM_BOM )
  m_out->Print( 0, " exclude_from_bom" );
 
  m_out->Print( 0, ")\n" );
  }
 
  Format( (BOARD_ITEM*) &aFootprint->Reference(), aNestLevel + 1 );
  Format( (BOARD_ITEM*) &aFootprint->Value(), aNestLevel + 1 );
 
  std::set<PAD*, FOOTPRINT::cmp_pads> sorted_pads( aFootprint->Pads().begin(),
  aFootprint->Pads().end() );
  std::set<BOARD_ITEM*, FOOTPRINT::cmp_drawings> sorted_drawings(
  aFootprint->GraphicalItems().begin(),
  aFootprint->GraphicalItems().end() );
  std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_zones( aFootprint->Zones().begin(),
  aFootprint->Zones().end() );
  std::set<BOARD_ITEM*, PCB_GROUP::ptr_cmp> sorted_groups( aFootprint->Groups().begin(),
  aFootprint->Groups().end() );
 
  // Save drawing elements.
 
  for( BOARD_ITEM* gr : sorted_drawings )
  Format( gr, aNestLevel+1 );
 
  // Save pads.
  for( PAD* pad : sorted_pads )
  Format( pad, aNestLevel+1 );
 
  // Save zones.
  for( BOARD_ITEM* zone : sorted_zones )
  Format( zone, aNestLevel + 1 );
 
  // Save groups.
  for( BOARD_ITEM* group : sorted_groups )
  Format( group, aNestLevel + 1 );
 
  // Save 3D info.
  auto bs3D = aFootprint->Models().begin();
  auto es3D = aFootprint->Models().end();
 
  while( bs3D != es3D )
  {
  if( !bs3D->m_Filename.IsEmpty() )
  {
  m_out->Print( aNestLevel+1, "(model %s%s\n",
  m_out->Quotew( bs3D->m_Filename ).c_str(),
  bs3D->m_Show ? "" : " hide" );
 
  if( bs3D->m_Opacity != 1.0 )
  m_out->Print( aNestLevel+2, "(opacity %0.4f)", bs3D->m_Opacity );
 
  m_out->Print( aNestLevel+2, "(offset (xyz %s %s %s))\n",
  Double2Str( bs3D->m_Offset.x ).c_str(),
  Double2Str( bs3D->m_Offset.y ).c_str(),
  Double2Str( bs3D->m_Offset.z ).c_str() );
 
  m_out->Print( aNestLevel+2, "(scale (xyz %s %s %s))\n",
  Double2Str( bs3D->m_Scale.x ).c_str(),
  Double2Str( bs3D->m_Scale.y ).c_str(),
  Double2Str( bs3D->m_Scale.z ).c_str() );
 
  m_out->Print( aNestLevel+2, "(rotate (xyz %s %s %s))\n",
  Double2Str( bs3D->m_Rotation.x ).c_str(),
  Double2Str( bs3D->m_Rotation.y ).c_str(),
  Double2Str( bs3D->m_Rotation.z ).c_str() );
 
  m_out->Print( aNestLevel+1, ")\n" );
  }
 
  ++bs3D;
  }
 
  m_out->Print( aNestLevel, ")\n" );
 }

References KIID::AsString(), KIID_PATH::AsString(), CTL_OMIT_AT, CTL_OMIT_FOOTPRINT_VERSION, CTL_OMIT_INITIAL_COMMENTS, CTL_OMIT_LIBNAME, CTL_OMIT_PATH, CTL_OMIT_TSTAMPS, Double2Str(), LIB_ID::Format(), Format(), FormatAngle(), FormatInternalUnits(), formatLayer(), FP_BOARD_ONLY, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, FOOTPRINT::GetAttributes(), FOOTPRINT::GetDescription(), FOOTPRINT::GetFPID(), FOOTPRINT::GetInitialComments(), FOOTPRINT::GetKeywords(), FOOTPRINT::GetLastEditTime(), LIB_ID::GetLibItemName(), FOOTPRINT::GetLocalClearance(), FOOTPRINT::GetLocalSolderMaskMargin(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPath(), FOOTPRINT::GetPlacementCost180(), FOOTPRINT::GetPlacementCost90(), FOOTPRINT::GetPosition(), FOOTPRINT::GetProperties(), FOOTPRINT::GetThermalGap(), FOOTPRINT::GetThermalWidth(), FOOTPRINT::GetZoneConnection(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), INHERITED, FOOTPRINT::IsLocked(), FOOTPRINT::IsPlaced(), m_ctl, m_out, EDA_ITEM::m_Uuid, FOOTPRINT::Models(), pad, FOOTPRINT::Pads(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotes(), OUTPUTFORMATTER::Quotew(), FOOTPRINT::Reference(), SEXPR_BOARD_FILE_VERSION, TO_UTF8, FOOTPRINT::Value(), and FOOTPRINT::Zones().

◆ format() [8/12]

void PCB_PLUGIN::format	(	const PAD *	aPad,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1376 of file pcb_plugin.cpp.

 {
  const char* shape;
 
  switch( aPad->GetShape() )
  {
  case PAD_SHAPE::CIRCLE: shape = "circle"; break;
  case PAD_SHAPE::RECT: shape = "rect"; break;
  case PAD_SHAPE::OVAL: shape = "oval"; break;
  case PAD_SHAPE::TRAPEZOID: shape = "trapezoid"; break;
  case PAD_SHAPE::CHAMFERED_RECT:
  case PAD_SHAPE::ROUNDRECT: shape = "roundrect"; break;
  case PAD_SHAPE::CUSTOM: shape = "custom"; break;
 
  default:
  THROW_IO_ERROR( wxString::Format( _( "unknown pad type: %d"), aPad->GetShape() ) );
  }
 
  const char* type;
 
  switch( aPad->GetAttribute() )
  {
  case PAD_ATTRIB::PTH: type = "thru_hole"; break;
  case PAD_ATTRIB::SMD: type = "smd"; break;
  case PAD_ATTRIB::CONN: type = "connect"; break;
  case PAD_ATTRIB::NPTH: type = "np_thru_hole"; break;
 
  default:
  THROW_IO_ERROR( wxString::Format( "unknown pad attribute: %d", aPad->GetAttribute() ) );
  }
 
  const char* property = nullptr;
 
  switch( aPad->GetProperty() )
  {
  case PAD_PROP::NONE: break; // could be "none"
  case PAD_PROP::BGA: property = "pad_prop_bga"; break;
  case PAD_PROP::FIDUCIAL_GLBL: property = "pad_prop_fiducial_glob"; break;
  case PAD_PROP::FIDUCIAL_LOCAL: property = "pad_prop_fiducial_loc"; break;
  case PAD_PROP::TESTPOINT: property = "pad_prop_testpoint"; break;
  case PAD_PROP::HEATSINK: property = "pad_prop_heatsink"; break;
  case PAD_PROP::CASTELLATED: property = "pad_prop_castellated"; break;
 
  default:
  THROW_IO_ERROR( wxString::Format( "unknown pad property: %d", aPad->GetProperty() ) );
  }
 
  m_out->Print( aNestLevel, "(pad %s %s %s",
  m_out->Quotew( aPad->GetNumber() ).c_str(),
  type,
  shape );
 
  if( aPad->IsLocked() )
  m_out->Print( 0, " locked" );
 
  m_out->Print( 0, " (at %s", FormatInternalUnits( aPad->GetPos0() ).c_str() );
 
  if( aPad->GetOrientation() != 0.0 )
  m_out->Print( 0, " %s", FormatAngle( aPad->GetOrientation() ).c_str() );
 
  m_out->Print( 0, ")" );
 
  m_out->Print( 0, " (size %s)", FormatInternalUnits( aPad->GetSize() ).c_str() );
 
  if( (aPad->GetDelta().GetWidth()) != 0 || (aPad->GetDelta().GetHeight() != 0 ) )
  m_out->Print( 0, " (rect_delta %s)", FormatInternalUnits( aPad->GetDelta() ).c_str() );
 
  wxSize sz = aPad->GetDrillSize();
  wxPoint shapeoffset = aPad->GetOffset();
 
  if( (sz.GetWidth() > 0) || (sz.GetHeight() > 0) ||
  (shapeoffset.x != 0) || (shapeoffset.y != 0) )
  {
  m_out->Print( 0, " (drill" );
 
  if( aPad->GetDrillShape() == PAD_DRILL_SHAPE_OBLONG )
  m_out->Print( 0, " oval" );
 
  if( sz.GetWidth() > 0 )
  m_out->Print( 0, " %s", FormatInternalUnits( sz.GetWidth() ).c_str() );
 
  if( sz.GetHeight() > 0 && sz.GetWidth() != sz.GetHeight() )
  m_out->Print( 0, " %s", FormatInternalUnits( sz.GetHeight() ).c_str() );
 
  if( (shapeoffset.x != 0) || (shapeoffset.y != 0) )
  m_out->Print( 0, " (offset %s)", FormatInternalUnits( aPad->GetOffset() ).c_str() );
 
  m_out->Print( 0, ")" );
  }
 
  // Add pad property, if exists.
  if( property )
  m_out->Print( 0, " (property %s)", property );
 
  formatLayers( aPad->GetLayerSet() );
 
  if( aPad->GetAttribute() == PAD_ATTRIB::PTH )
  {
  if( aPad->GetRemoveUnconnected() )
  {
  m_out->Print( 0, " (remove_unused_layers)" );
 
  if( aPad->GetKeepTopBottom() )
  m_out->Print( 0, " (keep_end_layers)" );
  }
  }
 
  // Output the radius ratio for rounded and chamfered rect pads
  if( aPad->GetShape() == PAD_SHAPE::ROUNDRECT || aPad->GetShape() == PAD_SHAPE::CHAMFERED_RECT)
  {
  m_out->Print( 0, " (roundrect_rratio %s)",
  Double2Str( aPad->GetRoundRectRadiusRatio() ).c_str() );
  }
 
  // Output the chamfer corners for chamfered rect pads
  if( aPad->GetShape() == PAD_SHAPE::CHAMFERED_RECT)
  {
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel+1, "(chamfer_ratio %s)",
  Double2Str( aPad->GetChamferRectRatio() ).c_str() );
 
  m_out->Print( 0, " (chamfer" );
 
  if( ( aPad->GetChamferPositions() & RECT_CHAMFER_TOP_LEFT ) )
  m_out->Print( 0, " top_left" );
 
  if( ( aPad->GetChamferPositions() & RECT_CHAMFER_TOP_RIGHT ) )
  m_out->Print( 0, " top_right" );
 
  if( ( aPad->GetChamferPositions() & RECT_CHAMFER_BOTTOM_LEFT ) )
  m_out->Print( 0, " bottom_left" );
 
  if( ( aPad->GetChamferPositions() & RECT_CHAMFER_BOTTOM_RIGHT ) )
  m_out->Print( 0, " bottom_right" );
 
  m_out->Print( 0, ")" );
  }
 
  std::string output;
 
  // Unconnected pad is default net so don't save it.
  if( !( m_ctl & CTL_OMIT_PAD_NETS ) && aPad->GetNetCode() != NETINFO_LIST::UNCONNECTED )
  {
  StrPrintf( &output, " (net %d %s)", m_mapping->Translate( aPad->GetNetCode() ),
  m_out->Quotew( aPad->GetNetname() ).c_str() );
  }
 
  // Pin functions and types are closely related to nets, so if CTL_OMIT_NETS is set, omit
  // them as well (for instance when saved from library editor).
  if( !( m_ctl & CTL_OMIT_PAD_NETS ) )
  {
  if( !aPad->GetPinFunction().IsEmpty() )
  {
  StrPrintf( &output, " (pinfunction %s)",
  m_out->Quotew( aPad->GetPinFunction() ).c_str() );
  }
 
  if( !aPad->GetPinType().IsEmpty() )
  {
  StrPrintf( &output, " (pintype %s)",
  m_out->Quotew( aPad->GetPinType() ).c_str() );
  }
  }
 
  if( aPad->GetPadToDieLength() != 0 )
  {
  StrPrintf( &output, " (die_length %s)",
  FormatInternalUnits( aPad->GetPadToDieLength() ).c_str() );
  }
 
  if( aPad->GetLocalSolderMaskMargin() != 0 )
  {
  StrPrintf( &output, " (solder_mask_margin %s)",
  FormatInternalUnits( aPad->GetLocalSolderMaskMargin() ).c_str() );
  }
 
  if( aPad->GetLocalSolderPasteMargin() != 0 )
  {
  StrPrintf( &output, " (solder_paste_margin %s)",
  FormatInternalUnits( aPad->GetLocalSolderPasteMargin() ).c_str() );
  }
 
  if( aPad->GetLocalSolderPasteMarginRatio() != 0 )
  {
  StrPrintf( &output, " (solder_paste_margin_ratio %s)",
  Double2Str( aPad->GetLocalSolderPasteMarginRatio() ).c_str() );
  }
 
  if( aPad->GetLocalClearance() != 0 )
  {
  StrPrintf( &output, " (clearance %s)",
  FormatInternalUnits( aPad->GetLocalClearance() ).c_str() );
  }
 
  if( aPad->GetZoneConnection() != ZONE_CONNECTION::INHERITED )
  {
  StrPrintf( &output, " (zone_connect %d)",
  static_cast<int>( aPad->GetZoneConnection() ) );
  }
 
  if( aPad->GetThermalSpokeWidth() != 0 )
  {
  StrPrintf( &output, " (thermal_width %s)",
  FormatInternalUnits( aPad->GetThermalSpokeWidth() ).c_str() );
  }
 
  if( aPad->GetThermalGap() != 0 )
  {
  StrPrintf( &output, " (thermal_gap %s)",
  FormatInternalUnits( aPad->GetThermalGap() ).c_str() );
  }
 
  if( output.size() )
  {
  m_out->Print( 0, "\n" );
  m_out->Print( aNestLevel+1, "%s", output.c_str()+1 ); // +1 skips 1st space on 1st element
  }
 
  if( aPad->GetShape() == PAD_SHAPE::CUSTOM )
  {
  m_out->Print( 0, "\n");
  m_out->Print( aNestLevel+1, "(options" );
 
  if( aPad->GetCustomShapeInZoneOpt() == CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL )
  m_out->Print( 0, " (clearance convexhull)" );
  #if 1 // Set to 1 to output the default option
  else
  m_out->Print( 0, " (clearance outline)" );
  #endif
 
  // Output the anchor pad shape (circle/rect)
  if( aPad->GetAnchorPadShape() == PAD_SHAPE::RECT )
  shape = "rect";
  else
  shape = "circle";
 
  m_out->Print( 0, " (anchor %s)", shape );
 
  m_out->Print( 0, ")"); // end of (options ...
 
  // Output graphic primitive of the pad shape
  m_out->Print( 0, "\n");
  m_out->Print( aNestLevel+1, "(primitives" );
 
  int nested_level = aNestLevel+2;
 
  // Output all basic shapes
  for( const std::shared_ptr<PCB_SHAPE>& primitive : aPad->GetPrimitives() )
  {
  m_out->Print( 0, "\n");
 
  switch( primitive->GetShape() )
  {
  case SHAPE_T::SEGMENT:
  m_out->Print( nested_level, "(gr_line (start %s) (end %s)",
  FormatInternalUnits( primitive->GetStart() ).c_str(),
  FormatInternalUnits( primitive->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::RECT:
  m_out->Print( nested_level, "(gr_rect (start %s) (end %s)",
  FormatInternalUnits( primitive->GetStart() ).c_str(),
  FormatInternalUnits( primitive->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::ARC:
  m_out->Print( aNestLevel, "(gr_arc (start %s) (mid %s) (end %s)",
  FormatInternalUnits( primitive->GetStart() ).c_str(),
  FormatInternalUnits( primitive->GetArcMid() ).c_str(),
  FormatInternalUnits( primitive->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::CIRCLE:
  m_out->Print( nested_level, "(gr_circle (center %s) (end %s)",
  FormatInternalUnits( primitive->GetStart() ).c_str(),
  FormatInternalUnits( primitive->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::BEZIER:
  m_out->Print( nested_level, "(gr_curve (pts (xy %s) (xy %s) (xy %s) (xy %s))",
  FormatInternalUnits( primitive->GetStart() ).c_str(),
  FormatInternalUnits( primitive->GetBezierC1() ).c_str(),
  FormatInternalUnits( primitive->GetBezierC2() ).c_str(),
  FormatInternalUnits( primitive->GetEnd() ).c_str() );
  break;
 
  case SHAPE_T::POLY:
  if( primitive->IsPolyShapeValid() )
  {
  const SHAPE_POLY_SET& poly = primitive->GetPolyShape();
  const SHAPE_LINE_CHAIN& outline = poly.Outline( 0 );
 
  m_out->Print( nested_level, "(gr_poly (pts" );
 
  bool need_newline = false;
 
  for( int ii = 0; ii < outline.PointCount(); ++ii )
  {
  nested_level = 0;
 
  if( !( ii % 4 ) || !ADVANCED_CFG::GetCfg().m_CompactSave )
  {
  // newline every 4 pts.
  m_out->Print( 0, "\n" );
  need_newline = false;
  nested_level = aNestLevel + 4;
  }
 
  int ind = outline.ArcIndex( ii );
 
  if( ind < 0 )
  {
  m_out->Print( nested_level, "%s(xy %s)",
  nested_level ? "" : " ",
  FormatInternalUnits( outline.CPoint( ii ) ).c_str() );
  need_newline = true;
  }
  else
  {
  const SHAPE_ARC& arc = outline.Arc( ind );
  m_out->Print( nested_level, "%s(arc (start %s) (mid %s) (end %s))",
  nested_level ? "" : " ",
  FormatInternalUnits( arc.GetP0() ).c_str(),
  FormatInternalUnits( arc.GetArcMid() ).c_str(),
  FormatInternalUnits( arc.GetP1() ).c_str() );
  need_newline = true;
 
  do
  {
  ++ii;
  } while( ii < outline.PointCount() && outline.ArcIndex( ii ) == ind );
 
  --ii;
  }
  }
 
  if( need_newline )
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel + 3, ")" );
  }
  break;
 
  default:
  break;
  }
 
  m_out->Print( 0, " (width %s)",
  FormatInternalUnits( primitive->GetWidth() ).c_str() );
 
  if( primitive->IsFilled() )
  m_out->Print( 0, " (fill yes)" );
 
  m_out->Print( 0, ")" );
  }
 
  m_out->Print( 0, "\n");
  m_out->Print( aNestLevel+1, ")" ); // end of (basic_shapes
  }
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aPad->m_Uuid.AsString() ) );
 
  m_out->Print( 0, ")\n" );
 }

References _, ARC, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), KIID::AsString(), BEZIER, BGA, CASTELLATED, CHAMFERED_RECT, CIRCLE, CONN, SHAPE_LINE_CHAIN::CPoint(), CTL_OMIT_PAD_NETS, CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL, CUSTOM, Double2Str(), FIDUCIAL_GLBL, FIDUCIAL_LOCAL, Format(), FormatAngle(), FormatInternalUnits(), formatLayers(), PAD::GetAnchorPadShape(), SHAPE_ARC::GetArcMid(), PAD::GetAttribute(), ADVANCED_CFG::GetCfg(), PAD::GetChamferPositions(), PAD::GetChamferRectRatio(), PAD::GetCustomShapeInZoneOpt(), PAD::GetDelta(), PAD::GetDrillShape(), PAD::GetDrillSize(), PAD::GetKeepTopBottom(), PAD::GetLayerSet(), PAD::GetLocalClearance(), PAD::GetLocalSolderMaskMargin(), PAD::GetLocalSolderPasteMargin(), PAD::GetLocalSolderPasteMarginRatio(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), PAD::GetNumber(), PAD::GetOffset(), PAD::GetOrientation(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), PAD::GetPadToDieLength(), PAD::GetPinFunction(), PAD::GetPinType(), PAD::GetPos0(), PAD::GetPrimitives(), PAD::GetProperty(), PAD::GetRemoveUnconnected(), PAD::GetRoundRectRadiusRatio(), PAD::GetShape(), PAD::GetSize(), PAD::GetThermalGap(), PAD::GetThermalSpokeWidth(), PAD::GetZoneConnection(), HEATSINK, INHERITED, PAD::IsLocked(), ADVANCED_CFG::m_CompactSave, m_ctl, m_mapping, m_out, EDA_ITEM::m_Uuid, NONE, NPTH, SHAPE_POLY_SET::Outline(), OVAL, PAD_DRILL_SHAPE_OBLONG, SHAPE_LINE_CHAIN::PointCount(), POLY, OUTPUTFORMATTER::Print(), PTH, OUTPUTFORMATTER::Quotew(), RECT, RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, ROUNDRECT, SEGMENT, SMD, StrPrintf(), TESTPOINT, THROW_IO_ERROR, TO_UTF8, NETINFO_MAPPING::Translate(), TRAPEZOID, and NETINFO_LIST::UNCONNECTED.

◆ format() [9/12]

void PCB_PLUGIN::format	(	const PCB_TEXT *	aText,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1743 of file pcb_plugin.cpp.

 {
  m_out->Print( aNestLevel, "(gr_text %s (at %s",
  m_out->Quotew( aText->GetText() ).c_str(),
  FormatInternalUnits( aText->GetTextPos() ).c_str() );
 
  if( aText->GetTextAngle() != 0.0 )
  m_out->Print( 0, " %s", FormatAngle( aText->GetTextAngle() ).c_str() );
 
  m_out->Print( 0, ")" );
 
  formatLayer( aText );
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aText->m_Uuid.AsString() ) );
 
  m_out->Print( 0, "\n" );
 
  // PCB_TEXTS are never hidden, so always omit "hide" attribute
  aText->EDA_TEXT::Format( m_out, aNestLevel, m_ctl | CTL_OMIT_HIDE );
 
  m_out->Print( aNestLevel, ")\n" );
 }

References KIID::AsString(), CTL_OMIT_HIDE, FormatAngle(), FormatInternalUnits(), formatLayer(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), m_ctl, m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.

◆ format() [10/12]

void PCB_PLUGIN::format	(	const FP_TEXT *	aText,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1795 of file pcb_plugin.cpp.

 {
  std::string type;
 
  switch( aText->GetType() )
  {
  case FP_TEXT::TEXT_is_REFERENCE: type = "reference"; break;
  case FP_TEXT::TEXT_is_VALUE: type = "value"; break;
  case FP_TEXT::TEXT_is_DIVERS: type = "user";
  }
 
  std::string locked = aText->IsLocked() ? " locked" : "";
 
  m_out->Print( aNestLevel, "(fp_text %s%s %s (at %s",
  type.c_str(),
  locked.c_str(),
  m_out->Quotew( aText->GetText() ).c_str(),
  FormatInternalUnits( aText->GetPos0() ).c_str() );
 
  // Due to Pcbnew history, fp_text angle is saved as an absolute on screen angle,
  // but internally the angle is held relative to its parent footprint. parent
  // may be NULL when saving a footprint outside a BOARD.
  double orient = aText->GetTextAngle();
  FOOTPRINT* parent = (FOOTPRINT*) aText->GetParent();
 
  if( parent )
  {
  // GetTextAngle() is always in -360..+360 range because of
  // FP_TEXT::SetTextAngle(), but summing that angle with an
  // additional board angle could kick sum up >= 360 or <= -360, so to have
  // consistent results, normalize again for the BOARD save. A footprint
  // save does not use this code path since parent is NULL.
 #if 0
  // This one could be considered reasonable if you like positive angles
  // in your board text.
  orient = NormalizeAnglePos( orient + parent->GetOrientation() );
 #else
  // Choose compatibility for now, even though this is only a 720 degree clamp
  // with two possible values for every angle.
  orient = NormalizeAngle360Min( orient + parent->GetOrientation() );
 #endif
  }
 
  if( orient != 0.0 )
  m_out->Print( 0, " %s", FormatAngle( orient ).c_str() );
 
  if( !aText->IsKeepUpright() )
  m_out->Print( 0, " unlocked" );
 
  m_out->Print( 0, ")" );
  formatLayer( aText );
 
  if( !aText->IsVisible() )
  m_out->Print( 0, " hide" );
 
  m_out->Print( 0, "\n" );
 
  aText->EDA_TEXT::Format( m_out, aNestLevel, m_ctl | CTL_OMIT_HIDE );
 
  m_out->Print( aNestLevel + 1, "(tstamp %s)\n", TO_UTF8( aText->m_Uuid.AsString() ) );
 
  m_out->Print( aNestLevel, ")\n" );
 }

References KIID::AsString(), CTL_OMIT_HIDE, FormatAngle(), FormatInternalUnits(), formatLayer(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParent(), FP_TEXT::GetPos0(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), FP_TEXT::GetType(), FP_TEXT::IsKeepUpright(), BOARD_ITEM::IsLocked(), EDA_TEXT::IsVisible(), locked, m_ctl, m_out, EDA_ITEM::m_Uuid, NormalizeAngle360Min(), NormalizeAnglePos(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, and TO_UTF8.

◆ format() [11/12]

void PCB_PLUGIN::format	(	const PCB_TRACK *	aTrack,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1860 of file pcb_plugin.cpp.

 {
  if( aTrack->Type() == PCB_VIA_T )
  {
  PCB_LAYER_ID layer1, layer2;
 
  const PCB_VIA* via = static_cast<const PCB_VIA*>( aTrack );
  BOARD* board = (BOARD*) via->GetParent();
 
  wxCHECK_RET( board != nullptr, wxT( "Via " ) +
  via->GetSelectMenuText( EDA_UNITS::MILLIMETRES ) + wxT( " has no parent." ) );
 
  m_out->Print( aNestLevel, "(via" );
 
  via->LayerPair( &layer1, &layer2 );
 
  switch( via->GetViaType() )
  {
  case VIATYPE::THROUGH: // Default shape not saved.
  break;
 
  case VIATYPE::BLIND_BURIED:
  m_out->Print( 0, " blind" );
  break;
 
  case VIATYPE::MICROVIA:
  m_out->Print( 0, " micro" );
  break;
 
  default:
  THROW_IO_ERROR( wxString::Format( _( "unknown via type %d" ), via->GetViaType() ) );
  }
 
  if( via->IsLocked() )
  m_out->Print( 0, " locked" );
 
  m_out->Print( 0, " (at %s) (size %s)",
  FormatInternalUnits( aTrack->GetStart() ).c_str(),
  FormatInternalUnits( aTrack->GetWidth() ).c_str() );
 
  // Old boards were using UNDEFINED_DRILL_DIAMETER value in file for via drill when
  // via drill was the netclass value.
  // recent boards always set the via drill to the actual value, but now we need to
  // always store the drill value, because netclass value is not stored in the board file.
  // Otherwise the drill value of some (old) vias can be unknown
  if( via->GetDrill() != UNDEFINED_DRILL_DIAMETER )
  m_out->Print( 0, " (drill %s)", FormatInternalUnits( via->GetDrill() ).c_str() );
  else // Probably old board!
  m_out->Print( 0, " (drill %s)", FormatInternalUnits( via->GetDrillValue() ).c_str() );
 
  m_out->Print( 0, " (layers %s %s)",
  m_out->Quotew( LSET::Name( layer1 ) ).c_str(),
  m_out->Quotew( LSET::Name( layer2 ) ).c_str() );
 
  if( via->GetRemoveUnconnected() )
  {
  m_out->Print( 0, " (remove_unused_layers)" );
 
  if( via->GetKeepTopBottom() )
  m_out->Print( 0, " (keep_end_layers)" );
  }
 
  if( via->GetIsFree() )
  m_out->Print( 0, " (free)" );
  }
  else if( aTrack->Type() == PCB_ARC_T )
  {
  const PCB_ARC* arc = static_cast<const PCB_ARC*>( aTrack );
  std::string locked = arc->IsLocked() ? " locked" : "";
 
  m_out->Print( aNestLevel, "(arc%s (start %s) (mid %s) (end %s) (width %s)",
  locked.c_str(),
  FormatInternalUnits( arc->GetStart() ).c_str(),
  FormatInternalUnits( arc->GetMid() ).c_str(),
  FormatInternalUnits( arc->GetEnd() ).c_str(),
  FormatInternalUnits( arc->GetWidth() ).c_str() );
 
  m_out->Print( 0, " (layer %s)", m_out->Quotew( LSET::Name( arc->GetLayer() ) ).c_str() );
  }
  else
  {
  std::string locked = aTrack->IsLocked() ? " locked" : "";
 
  m_out->Print( aNestLevel, "(segment%s (start %s) (end %s) (width %s)",
  locked.c_str(),
  FormatInternalUnits( aTrack->GetStart() ).c_str(),
  FormatInternalUnits( aTrack->GetEnd() ).c_str(),
  FormatInternalUnits( aTrack->GetWidth() ).c_str() );
 
  m_out->Print( 0, " (layer %s)", m_out->Quotew( LSET::Name( aTrack->GetLayer() ) ).c_str() );
  }
 
  m_out->Print( 0, " (net %d)", m_mapping->Translate( aTrack->GetNetCode() ) );
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aTrack->m_Uuid.AsString() ) );
 
  m_out->Print( 0, ")\n" );
 }

References _, KIID::AsString(), BLIND_BURIED, Format(), FormatInternalUnits(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), PCB_ARC::GetMid(), BOARD_CONNECTED_ITEM::GetNetCode(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), BOARD_ITEM::IsLocked(), locked, m_mapping, m_out, EDA_ITEM::m_Uuid, MICROVIA, MILLIMETRES, LSET::Name(), PCB_ARC_T, PCB_VIA_T, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), THROUGH, THROW_IO_ERROR, TO_UTF8, NETINFO_MAPPING::Translate(), EDA_ITEM::Type(), UNDEFINED_DRILL_DIAMETER, and via.

◆ format() [12/12]

void PCB_PLUGIN::format	(	const ZONE *	aZone,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1960 of file pcb_plugin.cpp.

 {
  std::string locked = aZone->IsLocked() ? " locked" : "";
 
  // Save the NET info; For keepout zones, net code and net name are irrelevant
  // so be sure a dummy value is stored, just for ZONE compatibility
  // (perhaps netcode and netname should be not stored)
  m_out->Print( aNestLevel, "(zone%s (net %d) (net_name %s)",
  locked.c_str(),
  aZone->GetIsRuleArea() ? 0 : m_mapping->Translate( aZone->GetNetCode() ),
  m_out->Quotew( aZone->GetIsRuleArea() ? wxT("") : aZone->GetNetname() ).c_str() );
 
  // If a zone exists on multiple layers, format accordingly
  if( aZone->GetLayerSet().count() > 1 )
  {
  formatLayers( aZone->GetLayerSet() );
  }
  else
  {
  formatLayer( aZone );
  }
 
  m_out->Print( 0, " (tstamp %s)", TO_UTF8( aZone->m_Uuid.AsString() ) );
 
  if( !aZone->GetZoneName().empty() )
  m_out->Print( 0, " (name %s)", m_out->Quotew( aZone->GetZoneName() ).c_str() );
 
  // Save the outline aux info
  std::string hatch;
 
  switch( aZone->GetHatchStyle() )
  {
  default:
  case ZONE_BORDER_DISPLAY_STYLE::NO_HATCH: hatch = "none"; break;
  case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE: hatch = "edge"; break;
  case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL: hatch = "full"; break;
  }
 
  m_out->Print( 0, " (hatch %s %s)\n", hatch.c_str(),
  FormatInternalUnits( aZone->GetBorderHatchPitch() ).c_str() );
 
  if( aZone->GetPriority() > 0 )
  m_out->Print( aNestLevel+1, "(priority %d)\n", aZone->GetPriority() );
 
  m_out->Print( aNestLevel+1, "(connect_pads" );
 
  switch( aZone->GetPadConnection() )
  {
  default:
  case ZONE_CONNECTION::THERMAL: // Default option not saved or loaded.
  break;
 
  case ZONE_CONNECTION::THT_THERMAL:
  m_out->Print( 0, " thru_hole_only" );
  break;
 
  case ZONE_CONNECTION::FULL:
  m_out->Print( 0, " yes" );
  break;
 
  case ZONE_CONNECTION::NONE:
  m_out->Print( 0, " no" );
  break;
  }
 
  m_out->Print( 0, " (clearance %s))\n",
  FormatInternalUnits( aZone->GetLocalClearance() ).c_str() );
 
  m_out->Print( aNestLevel+1, "(min_thickness %s)",
  FormatInternalUnits( aZone->GetMinThickness() ).c_str() );
 
  // write it only if V 6.O version option is used (i.e. do not write if the "legacy"
  // algorithm is used)
  if( !aZone->GetFilledPolysUseThickness() )
  m_out->Print( 0, " (filled_areas_thickness no)" );
 
  m_out->Print( 0, "\n" );
 
  if( aZone->GetIsRuleArea() )
  {
  m_out->Print( aNestLevel + 1,
  "(keepout (tracks %s) (vias %s) (pads %s ) (copperpour %s) "
  "(footprints %s))\n",
  aZone->GetDoNotAllowTracks() ? "not_allowed" : "allowed",
  aZone->GetDoNotAllowVias() ? "not_allowed" : "allowed",
  aZone->GetDoNotAllowPads() ? "not_allowed" : "allowed",
  aZone->GetDoNotAllowCopperPour() ? "not_allowed" : "allowed",
  aZone->GetDoNotAllowFootprints() ? "not_allowed" : "allowed" );
  }
 
  m_out->Print( aNestLevel + 1, "(fill" );
 
  // Default is not filled.
  if( aZone->IsFilled() )
  m_out->Print( 0, " yes" );
 
  // Default is polygon filled.
  if( aZone->GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN )
  m_out->Print( 0, " (mode hatch)" );
 
  m_out->Print( 0, " (thermal_gap %s) (thermal_bridge_width %s)",
  FormatInternalUnits( aZone->GetThermalReliefGap() ).c_str(),
  FormatInternalUnits( aZone->GetThermalReliefSpokeWidth() ).c_str() );
 
  if( aZone->GetCornerSmoothingType() != ZONE_SETTINGS::SMOOTHING_NONE )
  {
  m_out->Print( 0, " (smoothing" );
 
  switch( aZone->GetCornerSmoothingType() )
  {
  case ZONE_SETTINGS::SMOOTHING_CHAMFER:
  m_out->Print( 0, " chamfer" );
  break;
 
  case ZONE_SETTINGS::SMOOTHING_FILLET:
  m_out->Print( 0, " fillet" );
  break;
 
  default:
  THROW_IO_ERROR( wxString::Format( _( "unknown zone corner smoothing type %d" ),
  aZone->GetCornerSmoothingType() ) );
  }
  m_out->Print( 0, ")" );
 
  if( aZone->GetCornerRadius() != 0 )
  m_out->Print( 0, " (radius %s)",
  FormatInternalUnits( aZone->GetCornerRadius() ).c_str() );
  }
 
  if( aZone->GetIslandRemovalMode() != ISLAND_REMOVAL_MODE::ALWAYS )
  {
  m_out->Print( 0, " (island_removal_mode %d) (island_area_min %s)",
  static_cast<int>( aZone->GetIslandRemovalMode() ),
  FormatInternalUnits( aZone->GetMinIslandArea() / IU_PER_MM ).c_str() );
  }
 
  if( aZone->GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN )
  {
  m_out->Print( 0, "\n" );
  m_out->Print( aNestLevel+2, "(hatch_thickness %s) (hatch_gap %s) (hatch_orientation %s)",
  FormatInternalUnits( aZone->GetHatchThickness() ).c_str(),
  FormatInternalUnits( aZone->GetHatchGap() ).c_str(),
  Double2Str( aZone->GetHatchOrientation() ).c_str() );
 
  if( aZone->GetHatchSmoothingLevel() > 0 )
  {
  m_out->Print( 0, "\n" );
  m_out->Print( aNestLevel+2, "(hatch_smoothing_level %d) (hatch_smoothing_value %s)",
  aZone->GetHatchSmoothingLevel(),
  Double2Str( aZone->GetHatchSmoothingValue() ).c_str() );
  }
 
  m_out->Print( 0, "\n" );
  m_out->Print( aNestLevel+2, "(hatch_border_algorithm %s) (hatch_min_hole_area %s)",
  aZone->GetHatchBorderAlgorithm() ? "hatch_thickness" : "min_thickness",
  Double2Str( aZone->GetHatchHoleMinArea() ).c_str() );
  }
 
  m_out->Print( 0, ")\n" );
 
  if( aZone->GetNumCorners() )
  {
  SHAPE_POLY_SET::POLYGON poly = aZone->Outline()->Polygon(0);
 
  for( auto& chain : poly )
  {
  m_out->Print( aNestLevel + 1, "(polygon\n" );
  m_out->Print( aNestLevel + 2, "(pts" );
 
  bool need_newline = true;
 
  for( int ii = 0; ii < chain.PointCount(); ++ii )
  {
  int nestLevel = 0;
 
  if( !( ii % 4 ) || !ADVANCED_CFG::GetCfg().m_CompactSave ) // newline every 4 pts
  {
  m_out->Print( 0, "\n" );
  need_newline = false;
  nestLevel = aNestLevel + 3;
  }
 
  int ind = chain.ArcIndex( ii );
 
  if( ind < 0 )
  {
  m_out->Print( nestLevel, "%s(xy %s)",
  nestLevel ? "" : " ",
  FormatInternalUnits( chain.CPoint( ii ) ).c_str() );
  need_newline = true;
  }
  else
  {
  auto& arc = chain.Arc( ind );
  m_out->Print( nestLevel, "%s(arc (start %s) (mid %s) (end %s))",
  nestLevel ? "" : " ",
  FormatInternalUnits( arc.GetP0() ).c_str(),
  FormatInternalUnits( arc.GetArcMid() ).c_str(),
  FormatInternalUnits( arc.GetP1() ).c_str() );
  need_newline = true;
 
  do
  {
  ++ii;
  } while( ii < chain.PointCount() && chain.ArcIndex( ii ) == ind );
 
  --ii;
  }
  }
 
  if( need_newline )
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel + 2, ")\n" );
  m_out->Print( aNestLevel + 1, ")\n" );
 
  }
  }
 
  // Save the PolysList (filled areas)
  for( PCB_LAYER_ID layer : aZone->GetLayerSet().Seq() )
  {
  const SHAPE_POLY_SET& fv = aZone->GetFilledPolysList( layer );
 
  for( int ii = 0; ii < fv.OutlineCount(); ++ii )
  {
  m_out->Print( aNestLevel + 1, "(filled_polygon\n" );
  m_out->Print( aNestLevel + 2, "(layer %s)\n",
  m_out->Quotew( LSET::Name( layer ) ).c_str() );
 
  if( aZone->IsIsland( layer, ii ) )
  m_out->Print( aNestLevel + 2, "(island)\n" );
 
  m_out->Print( aNestLevel + 2, "(pts" );
 
  const SHAPE_LINE_CHAIN& chain = fv.COutline( ii );
 
  bool need_newline = true;
 
  for( int jj = 0; jj < chain.PointCount(); ++jj )
  {
  int nestLevel = 0;
 
  if( !( jj%4 ) || !ADVANCED_CFG::GetCfg().m_CompactSave ) // newline every 4 pts
  {
  m_out->Print( 0, "\n" );
  need_newline = false;
  nestLevel = aNestLevel + 3;
  }
 
  int ind = chain.ArcIndex( jj );
 
  if( ind < 0 )
  {
  m_out->Print( nestLevel, "%s(xy %s)",
  nestLevel ? "" : " ",
  FormatInternalUnits( chain.CPoint( jj ) ).c_str() );
  need_newline = true;
  }
  else
  {
  auto& arc = chain.Arc( ind );
  m_out->Print( nestLevel, "%s(arc (start %s) (mid %s) (end %s))",
  nestLevel ? "" : " ",
  FormatInternalUnits( arc.GetP0() ).c_str(),
  FormatInternalUnits( arc.GetArcMid() ).c_str(),
  FormatInternalUnits( arc.GetP1() ).c_str() );
  need_newline = true;
 
  do
  {
  ++jj;
  } while( jj < chain.PointCount() && chain.ArcIndex( jj ) == ind );
 
  --jj;
  }
  }
 
  if( need_newline )
  m_out->Print( 0, "\n" );
 
  m_out->Print( aNestLevel+2, ")\n" );
  m_out->Print( aNestLevel+1, ")\n" );
  }
 
  // Save the filling segments list
  const std::vector<SEG>& segs = aZone->FillSegments( layer );
 
  if( segs.size() )
  {
  m_out->Print( aNestLevel + 1, "(fill_segments\n" );
  m_out->Print( aNestLevel + 2, "(layer %s)\n",
  TO_UTF8( BOARD::GetStandardLayerName( layer ) ) );
 
  for( const SEG& seg : segs )
  {
  m_out->Print( aNestLevel + 2, "(pts (xy %s) (xy %s))\n",
  FormatInternalUnits( wxPoint( seg.A ) ).c_str(),
  FormatInternalUnits( wxPoint( seg.B ) ).c_str() );
  }
 
  m_out->Print( aNestLevel + 1, ")\n" );
  }
  }
 
  m_out->Print( aNestLevel, ")\n" );
 }

References _, ALWAYS, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), KIID::AsString(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), DIAGONAL_EDGE, DIAGONAL_FULL, Double2Str(), ZONE::FillSegments(), Format(), FormatInternalUnits(), formatLayer(), formatLayers(), FULL, ZONE::GetBorderHatchPitch(), ADVANCED_CFG::GetCfg(), ZONE::GetCornerRadius(), ZONE::GetCornerSmoothingType(), ZONE::GetDoNotAllowCopperPour(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), ZONE::GetFilledPolysList(), ZONE::GetFilledPolysUseThickness(), ZONE::GetFillMode(), 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::GetPriority(), BOARD::GetStandardLayerName(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), ZONE::GetZoneName(), HATCH_PATTERN, ZONE::IsFilled(), ZONE::IsIsland(), BOARD_ITEM::IsLocked(), IU_PER_MM, locked, ADVANCED_CFG::m_CompactSave, m_mapping, m_out, EDA_ITEM::m_Uuid, LSET::Name(), NO_HATCH, NONE, ZONE::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), SHAPE_POLY_SET::Polygon(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), ZONE_SETTINGS::SMOOTHING_CHAMFER, ZONE_SETTINGS::SMOOTHING_FILLET, ZONE_SETTINGS::SMOOTHING_NONE, THERMAL, THROW_IO_ERROR, THT_THERMAL, TO_UTF8, and NETINFO_MAPPING::Translate().

◆ formatBoardLayers()

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

protected

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(), m_board, m_out, Margin, LSET::Name(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), LAYER::ShowType(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

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

◆ formatGeneral()

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

protected

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(), m_ctl, m_out, and OUTPUTFORMATTER::Print().

Referenced by formatHeader().

◆ formatHeader()

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

protected

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 formatBoardLayers(), formatGeneral(), formatNetInformation(), formatProperties(), and formatSetup().

Referenced by format().

◆ formatLayer()

void PCB_PLUGIN::formatLayer ( const BOARD_ITEM * aItem ) const

private

Definition at line 466 of file pcb_plugin.cpp.

 {
  PCB_LAYER_ID layer = aItem->GetLayer();
 
  m_out->Print( 0, " (layer %s)", m_out->Quotew( LSET::Name( layer ) ).c_str() );
 }

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

Referenced by format().

◆ formatLayers()

void PCB_PLUGIN::formatLayers	(	LSET	aLayerMask,
		int	aNestLevel = `0`
	)		const

private

Definition at line 1290 of file pcb_plugin.cpp.

 {
  std::string output;
 
  if( aNestLevel == 0 )
  output += ' ';
 
  output += "(layers";
 
  static const LSET cu_all( LSET::AllCuMask() );
  static const LSET fr_bk( 2, B_Cu, F_Cu );
  static const LSET adhes( 2, B_Adhes, F_Adhes );
  static const LSET paste( 2, B_Paste, F_Paste );
  static const LSET silks( 2, B_SilkS, F_SilkS );
  static const LSET mask( 2, B_Mask, F_Mask );
  static const LSET crt_yd( 2, B_CrtYd, F_CrtYd );
  static const LSET fab( 2, B_Fab, F_Fab );
 
  LSET cu_mask = cu_all;
 
  // output copper layers first, then non copper
 
  if( ( aLayerMask & cu_mask ) == cu_mask )
  {
  output += " *.Cu";
  aLayerMask &= ~cu_all; // clear bits, so they are not output again below
  }
  else if( ( aLayerMask & cu_mask ) == fr_bk )
  {
  output += " F&B.Cu";
  aLayerMask &= ~fr_bk;
  }
 
  if( ( aLayerMask & adhes ) == adhes )
  {
  output += " *.Adhes";
  aLayerMask &= ~adhes;
  }
 
  if( ( aLayerMask & paste ) == paste )
  {
  output += " *.Paste";
  aLayerMask &= ~paste;
  }
 
  if( ( aLayerMask & silks ) == silks )
  {
  output += " *.SilkS";
  aLayerMask &= ~silks;
  }
 
  if( ( aLayerMask & mask ) == mask )
  {
  output += " *.Mask";
  aLayerMask &= ~mask;
  }
 
  if( ( aLayerMask & crt_yd ) == crt_yd )
  {
  output += " *.CrtYd";
  aLayerMask &= ~crt_yd;
  }
 
  if( ( aLayerMask & fab ) == fab )
  {
  output += " *.Fab";
  aLayerMask &= ~fab;
  }
 
  // output any individual layers not handled in wildcard combos above
  wxString layerName;
 
  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
  {
  if( aLayerMask[layer] )
  {
  layerName = LSET::Name( PCB_LAYER_ID( layer ) );
  output += ' ';
  output += m_out->Quotew( layerName );
  }
  }
 
  m_out->Print( aNestLevel, "%s)", output.c_str() );
 }

References LSET::AllCuMask(), B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, m_out, LSET::Name(), paste, PCB_LAYER_ID_COUNT, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by format().

◆ formatNetInformation()

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

protected

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 m_mapping, m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and NETINFO_MAPPING::Translate().

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

◆ formatProperties()

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

protected

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(), m_out, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by formatHeader().

◆ formatSetup()

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

protected

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

◆ GetEnumeratedFootprint()

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

overridevirtual

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

Reimplemented from PLUGIN.

Definition at line 2434 of file pcb_plugin.cpp.

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

References getFootprint().

◆ GetFileExtension()

const wxString PCB_PLUGIN::GetFileExtension ( ) const

inlineoverridevirtual

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
	)

protected

Definition at line 2406 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(), init(), m_cache, and validateCache().

Referenced by FootprintLoad(), and 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

overridevirtual

Generate a timestamp representing all the files in the library (including the library directory).

Timestamps should not be considered ordered, they either match or they don't.

Implements PLUGIN.

Definition at line 2596 of file pcb_plugin.cpp.

 {
  return FP_CACHE::GetTimestamp( aLibraryPath );
 }

References FP_CACHE::GetTimestamp().

◆ GetStringOutput()

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

inline

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

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint().

◆ init()

void PCB_PLUGIN::init ( const PROPERTIES * aProperties )

protected

Definition at line 2357 of file pcb_plugin.cpp.

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

References m_board, m_props, and m_reader.

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

◆ IsFootprintLibWritable()

bool PCB_PLUGIN::IsFootprintLibWritable ( const wxString & aLibraryPath )

overridevirtual

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 2697 of file pcb_plugin.cpp.

 {
  LOCALE_IO toggle;
 
  init( nullptr );
 
  validateCache( aLibraryPath );
 
  return m_cache->IsWritable();
 }

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

◆ Load()

BOARD * PCB_PLUGIN::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 2288 of file pcb_plugin.cpp.

 {
  FILE_LINE_READER reader( aFileName );
 
  unsigned lineCount = 0;
 
  if( aProgressReporter )
  {
  aProgressReporter->Report( wxString::Format( _( "Loading %s..." ), aFileName ) );
 
  if( !aProgressReporter->KeepRefreshing() )
  THROW_IO_ERROR( _( "Open cancelled by user." ) );
 
  while( reader.ReadLine() )
  lineCount++;
 
  reader.Rewind();
  }
 
  BOARD* board = DoLoad( reader, aAppendToMe, aProperties, aProgressReporter, lineCount );
 
  // Give the filename to the board if it's new
  if( !aAppendToMe )
  board->SetFileName( aFileName );
 
  return board;
 }

References _, DoLoad(), Format(), PROGRESS_REPORTER::KeepRefreshing(), FILE_LINE_READER::ReadLine(), PROGRESS_REPORTER::Report(), FILE_LINE_READER::Rewind(), BOARD::SetFileName(), and THROW_IO_ERROR.

Referenced by PNS_LOG_FILE::Load().

◆ Parse()

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

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(), m_parser, PCB_PARSER::Parse(), PCB_PARSER::SetLineReader(), and TO_UTF8.

Referenced by CLIPBOARD_IO::Parse(), and parse_footprint_kicad().

◆ PluginName()

const wxString PCB_PLUGIN::PluginName ( ) const

inlineoverridevirtual

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.

76 {

77 }

◆ Save()

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

Reimplemented in CLIPBOARD_IO.

Definition at line 338 of file pcb_plugin.cpp.

 {
  LOCALE_IO toggle; // toggles on, then off, the C locale.
 
  wxString sanityResult = aBoard->GroupsSanityCheck();
 
  if( sanityResult != wxEmptyString )
  {
  KIDIALOG dlg( nullptr, wxString::Format(
  _( "Please report this bug. Error validating group structure: %s"
  "\n\nSave anyway?" ), sanityResult ),
  _( "Internal group data structure corrupt" ),
  wxOK | wxCANCEL | wxICON_ERROR );
  dlg.SetOKLabel( _( "Save Anyway" ) );
 
  if( dlg.ShowModal() == wxID_CANCEL )
  return;
  }
 
  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 );
 
  FILE_OUTPUTFORMATTER formatter( aFileName );
 
  m_out = &formatter; // no ownership
 
  m_out->Print( 0, "(kicad_pcb (version %d) (generator pcbnew)\n", SEXPR_BOARD_FILE_VERSION );
 
  Format( aBoard, 1 );
 
  m_out->Print( 0, ")\n" );
 
  m_out = nullptr;
 }

References _, Format(), Format(), BOARD::GroupsSanityCheck(), init(), m_board, m_mapping, m_out, OUTPUTFORMATTER::Print(), NETINFO_MAPPING::SetBoard(), SEXPR_BOARD_FILE_VERSION, and KIDIALOG::ShowModal().

Referenced by KI_TEST::DumpBoardToFile(), and ROUTER_TOOL::saveRouterDebugLog().

◆ SetOutputFormatter()

void PCB_PLUGIN::SetOutputFormatter ( OUTPUTFORMATTER * aFormatter )

inline

Definition at line 221 of file pcb_plugin.h.

221 { m_out = aFormatter; }

PCB_PLUGIN::m_out

OUTPUTFORMATTER * m_out

output any Format()s to this, no ownership

Definition: pcb_plugin.h:294

References m_out.

Referenced by FP_CACHE::Save().

◆ validateCache()

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

protected

Definition at line 2365 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 FP_CACHE, FP_CACHE::IsModified(), FP_CACHE::IsPath(), FP_CACHE::Load(), and m_cache.

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

Friends And Related Function Documentation

◆ FP_CACHE

friend class FP_CACHE

friend

Definition at line 280 of file pcb_plugin.h.

Referenced by FootprintLibCreate(), and validateCache().

Member Data Documentation

◆ m_board

BOARD* PCB_PLUGIN::m_board

protected

which BOARD, no ownership here

Definition at line 284 of file pcb_plugin.h.

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

◆ m_cache

FP_CACHE* PCB_PLUGIN::m_cache

protected

Footprint library cache.

Definition at line 288 of file pcb_plugin.h.

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

◆ m_ctl

int PCB_PLUGIN::m_ctl

protected

Definition at line 295 of file pcb_plugin.h.

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

◆ m_error

wxString PCB_PLUGIN::m_error

protected

for throwing exceptions

Definition at line 283 of file pcb_plugin.h.

◆ m_filename

wxString PCB_PLUGIN::m_filename

protected

for saves only, name is in m_reader for loads

Definition at line 291 of file pcb_plugin.h.

◆ m_mapping

NETINFO_MAPPING* PCB_PLUGIN::m_mapping

protected

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 format(), formatNetInformation(), CLIPBOARD_IO::Save(), Save(), CLIPBOARD_IO::SaveSelection(), and ~PCB_PLUGIN().

◆ m_out

OUTPUTFORMATTER* PCB_PLUGIN::m_out

protected

output any Format()s to this, no ownership

Definition at line 294 of file pcb_plugin.h.

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

◆ m_parser

PCB_PARSER* PCB_PLUGIN::m_parser

protected

Definition at line 296 of file pcb_plugin.h.

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

◆ m_props

const PROPERTIES* PCB_PLUGIN::m_props

protected

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

Definition at line 287 of file pcb_plugin.h.

Referenced by init().

◆ m_reader

LINE_READER* PCB_PLUGIN::m_reader

protected

no ownership here.

Definition at line 290 of file pcb_plugin.h.

Referenced by init().

◆ m_sf

STRING_FORMATTER PCB_PLUGIN::m_sf

protected

Definition at line 293 of file pcb_plugin.h.

Referenced by GetStringOutput(), and PCB_PLUGIN().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PCB_PLUGIN()

◆ ~PCB_PLUGIN()

Member Function Documentation

◆ DoLoad()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLibOptions()

◆ FootprintLoad()

◆ FootprintSave()

◆ Format()

◆ format() [1/12]

◆ format() [2/12]

◆ format() [3/12]

◆ format() [4/12]

◆ format() [5/12]

◆ format() [6/12]

◆ format() [7/12]

◆ format() [8/12]

◆ format() [9/12]

◆ format() [10/12]

◆ format() [11/12]

◆ format() [12/12]

◆ formatBoardLayers()

◆ formatGeneral()

◆ formatHeader()

◆ formatLayer()

◆ formatLayers()

◆ formatNetInformation()

◆ formatProperties()

◆ formatSetup()

◆ GetEnumeratedFootprint()

◆ GetFileExtension()

◆ getFootprint()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryTimestamp()

◆ GetStringOutput()

◆ init()

◆ IsFootprintLibWritable()

◆ Load()

◆ Parse()

◆ PluginName()

◆ PrefetchLib()

◆ Save()

◆ SetOutputFormatter()

◆ validateCache()

Friends And Related Function Documentation

◆ FP_CACHE

Member Data Documentation

◆ m_board

◆ m_cache

◆ m_ctl

◆ m_error

◆ m_filename

◆ m_mapping

◆ m_out

◆ m_parser

◆ m_props

◆ m_reader

◆ m_sf