SCH_SEXPR_PLUGIN Class Reference

A SCH_PLUGIN derivation for loading schematic files using the new s-expression file format. More...

#include <sch_sexpr_plugin.h>

Inheritance diagram for SCH_SEXPR_PLUGIN:

Public Member Functions
	SCH_SEXPR_PLUGIN ()
virtual	~SCH_SEXPR_PLUGIN ()
const wxString	GetName () const override
	Return a brief hard coded name for this SCH_PLUGIN. More...
const wxString	GetFileExtension () const override
	Return the file extension for the SCH_PLUGIN. More...
const wxString	GetLibraryFileExtension () const override
	Return the library file extension for the SCH_PLUGIN object. More...
void	SetProgressReporter (PROGRESS_REPORTER *aReporter) override
	Set an optional progress reporter. More...
int	GetModifyHash () const override
	Return the modification hash from the library cache. More...
SCH_SHEET *	Load (const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr) override
	Load information from some input file format that this SCH_PLUGIN implementation knows about, into either a new SCH_SHEET or an existing one. More...
void	LoadContent (LINE_READER &aReader, SCH_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
void	Save (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr) override
	Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file. More...
void	Format (SCH_SHEET *aSheet)
void	Format (EE_SELECTION *aSelection, SCH_SHEET_PATH *aSelectionPath, SCHEMATIC &aSchematic, OUTPUTFORMATTER *aFormatter, bool aForClipboard)
void	EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath. More...
void	EnumerateSymbolLib (std::vector< LIB_SYMBOL * > &aSymbolList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath. More...
LIB_SYMBOL *	LoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
	Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about. More...
void	SaveSymbol (const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr) override
	Write aSymbol to an existing library located at aLibraryPath. More...
void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr) override
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath. More...
void	CreateSymbolLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Create a new empty symbol library at aLibraryPath. More...
bool	DeleteSymbolLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Delete an existing symbol library and returns true if successful, 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...
void	SaveLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
bool	CheckHeader (const wxString &aFileName) override
	Return true if the first line in aFileName begins with the expected header. More...
bool	IsSymbolLibWritable (const wxString &aLibraryPath) override
	Return true if the library at aLibraryPath is writable. More...
void	GetAvailableSymbolFields (std::vector< wxString > &aNames) override
	Retrieves a list of (custom) field names that are present on symbols in this library. More...
void	GetDefaultSymbolFields (std::vector< wxString > &aNames) override
	Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser. More...
const wxString &	GetError () const override
	Return an error string to the caller. More...
virtual void	SetReporter (REPORTER *aReporter)
	Set an optional reporter for warnings/errors. More...
virtual void	SymbolLibOptions (STRING_UTF8_MAP *aListToAppendTo) const
	Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
virtual bool	SupportsSubLibraries () const
virtual void	GetSubLibraryNames (std::vector< wxString > &aNames)
	Retrieves a list of sub-libraries in this library. More...
virtual void	SetLibTable (SYMBOL_LIB_TABLE *aTable)
	Some library plugins need to have access to their parent library table. More...

Static Public Member Functions
static LIB_SYMBOL *	ParseLibSymbol (LINE_READER &aReader, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
static void	FormatLibSymbol (LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)

Static Public Attributes
static const char *	PropBuffering = "buffering"
	The property used internally by the plugin to enable cache buffering which prevents the library file from being written every time the cache is changed. More...

Protected Member Functions
void	init (SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
	initialize PLUGIN like a constructor would. More...

Protected Attributes
int	m_version
	Version of file being loaded. More...
int	m_nextFreeFieldId
bool	m_appending
	Schematic load append status. More...
wxString	m_error
	For throwing exceptions or errors on partial loads. More...
PROGRESS_REPORTER *	m_progressReporter
wxString	m_path
	Root project path for loading child sheets. More...
std::stack< wxString >	m_currentPath
	Stack to maintain nested sheet paths. More...
SCH_SHEET *	m_rootSheet
	The root sheet of the schematic being loaded. More...
SCH_SHEET_PATH	m_currentSheetPath
SCHEMATIC *	m_schematic
OUTPUTFORMATTER *	m_out
	The formatter for saving SCH_SCREEN objects. More...
SCH_SEXPR_PLUGIN_CACHE *	m_cache

Private Member Functions
void	loadHierarchy (const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)
void	loadFile (const wxString &aFileName, SCH_SHEET *aSheet)
void	saveSymbol (SCH_SYMBOL *aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard)
void	saveField (SCH_FIELD *aField, int aNestLevel)
void	saveBitmap (SCH_BITMAP *aBitmap, int aNestLevel)
void	saveSheet (SCH_SHEET *aSheet, int aNestLevel)
void	saveJunction (SCH_JUNCTION *aJunction, int aNestLevel)
void	saveNoConnect (SCH_NO_CONNECT *aNoConnect, int aNestLevel)
void	saveBusEntry (SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)
void	saveLine (SCH_LINE *aLine, int aNestLevel)
void	saveShape (SCH_SHAPE *aShape, int aNestLevel)
void	saveText (SCH_TEXT *aText, int aNestLevel)
void	saveTextBox (SCH_TEXTBOX *aText, int aNestLevel)
void	saveBusAlias (std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)
void	saveInstances (const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)
void	cacheLib (const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
bool	isBuffering (const STRING_UTF8_MAP *aProperties)

Detailed Description

A SCH_PLUGIN derivation for loading schematic files using the new s-expression file format.

As with all SCH_PLUGINs there is no UI dependencies i.e. windowing calls allowed.

Definition at line 62 of file sch_sexpr_plugin.h.

Constructor & Destructor Documentation

SCH_SEXPR_PLUGIN()

SCH_SEXPR_PLUGIN::SCH_SEXPR_PLUGIN

(

)

Definition at line 75 of file sch_sexpr_plugin.cpp.

 :
 m_progressReporter( nullptr )
{
 init( nullptr );
}

References init().

~SCH_SEXPR_PLUGIN()

SCH_SEXPR_PLUGIN::~SCH_SEXPR_PLUGIN ( )

virtual

Definition at line 82 of file sch_sexpr_plugin.cpp.

{
 delete m_cache;
}

References m_cache.

Member Function Documentation

cacheLib()

void SCH_SEXPR_PLUGIN::cacheLib ( const wxString &  aLibraryFileName, const STRING_UTF8_MAP *  aProperties  )

private

Definition at line 1408 of file sch_sexpr_plugin.cpp.

{
 if( !m_cache || !m_cache->IsFile( aLibraryFileName ) || m_cache->IsFileChanged() )
 {
 // a spectacular episode in memory management:
 delete m_cache;
 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryFileName );
 
 if( !isBuffering( aProperties ) )
 m_cache->Load();
 }
}

References isBuffering(), SCH_LIB_PLUGIN_CACHE::IsFile(), SCH_LIB_PLUGIN_CACHE::IsFileChanged(), SCH_SEXPR_PLUGIN_CACHE::Load(), and m_cache.

Referenced by DeleteSymbol(), EnumerateSymbolLib(), LoadSymbol(), and SaveSymbol().

CheckHeader()

bool SCH_SEXPR_PLUGIN::CheckHeader ( const wxString &  aFileName )

overridevirtual

Return true if the first line in aFileName begins with the expected header.

Parameters

aFileName

is the name of the file to use as input

Reimplemented from SCH_PLUGIN.

Definition at line 1589 of file sch_sexpr_plugin.cpp.

{
 // Open file and check first line
 wxTextFile tempFile;
 
 tempFile.Open( aFileName );
 wxString firstline;
 // read the first line
 firstline = tempFile.GetFirstLine();
 tempFile.Close();
 
 return firstline.StartsWith( wxS( "EESchema" ) );
}

CreateSymbolLib()

void SCH_SEXPR_PLUGIN::CreateSymbolLib ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Create a new empty symbol library at aLibraryPath.

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

Definition at line 1525 of file sch_sexpr_plugin.cpp.

{
 if( wxFileExists( aLibraryPath ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' already exists." ),
 aLibraryPath.GetData() ) );
 }
 
 LOCALE_IO toggle;
 
 delete m_cache;
 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryPath );
 m_cache->SetModified();
 m_cache->Save();
 m_cache->Load(); // update m_writable and m_mod_time
}

References _, Format(), SCH_SEXPR_PLUGIN_CACHE::Load(), m_cache, SCH_SEXPR_PLUGIN_CACHE::Save(), SCH_LIB_PLUGIN_CACHE::SetModified(), and THROW_IO_ERROR.

DeleteSymbol()

void SCH_SEXPR_PLUGIN::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolName	is the name of a LIB_SYMBOL associated with it's root LIB_SYMBOL object 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 alias or the library or deleting it.

Reimplemented from SCH_PLUGIN.

Definition at line 1511 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 cacheLib( aLibraryPath, aProperties );
 
 m_cache->DeleteSymbol( aSymbolName );
 
 if( !isBuffering( aProperties ) )
 m_cache->Save();
}

References cacheLib(), SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), isBuffering(), m_cache, and SCH_SEXPR_PLUGIN_CACHE::Save().

DeleteSymbolLib()

bool SCH_SEXPR_PLUGIN::DeleteSymbolLib ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Delete an existing symbol library and returns true if successful, 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 symbols.
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 or false if library did not exist.

Exceptions

IO_ERROR

if there is a problem deleting an existing library.

Reimplemented from SCH_PLUGIN.

Definition at line 1544 of file sch_sexpr_plugin.cpp.

{
 wxFileName fn = aLibraryPath;
 
 if( !fn.FileExists() )
 return false;
 
 // 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( wxRemove( aLibraryPath ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' cannot be deleted." ),
 aLibraryPath.GetData() ) );
 }
 
 if( m_cache && m_cache->IsFile( aLibraryPath ) )
 {
 delete m_cache;
 m_cache = nullptr;
 }
 
 return true;
}

References _, Format(), SCH_LIB_PLUGIN_CACHE::IsFile(), m_cache, and THROW_IO_ERROR.

EnumerateSymbolLib() [1/2]

void SCH_SEXPR_PLUGIN::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.

Note

It is the responsibility of the caller to delete the returned object from the heap. Failure to do this will result in memory leaks.

Parameters

aSymbolList	is an array to populate with the LIB_SYMBOL pointers associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
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 the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_PLUGIN.

Definition at line 1460 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 bool powerSymbolsOnly = ( aProperties &&
 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
 
 cacheLib( aLibraryPath, aProperties );
 
 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
 
 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
 {
 if( !powerSymbolsOnly || it->second->IsPower() )
 aSymbolList.push_back( it->second );
 }
}

References cacheLib(), m_cache, SCH_LIB_PLUGIN_CACHE::m_symbols, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

EnumerateSymbolLib() [2/2]

void SCH_SEXPR_PLUGIN::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.

Parameters

aSymbolNameList	is an array to populate with the LIB_SYMBOL names associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
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 the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_PLUGIN.

Definition at line 1439 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 bool powerSymbolsOnly = ( aProperties &&
 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
 
 cacheLib( aLibraryPath, aProperties );
 
 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
 
 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
 {
 if( !powerSymbolsOnly || it->second->IsPower() )
 aSymbolNameList.Add( it->first );
 }
}

References cacheLib(), m_cache, SCH_LIB_PLUGIN_CACHE::m_symbols, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

Format() [1/2]

void SCH_SEXPR_PLUGIN::Format	(	EE_SELECTION *	aSelection,
		SCH_SHEET_PATH *	aSelectionPath,
		SCHEMATIC &	aSchematic,
		OUTPUTFORMATTER *	aFormatter,
		bool	aForClipboard
	)

Definition at line 498 of file sch_sexpr_plugin.cpp.

{
 wxCHECK( aSelection && aSelectionPath && aFormatter, /* void */ );
 
 LOCALE_IO toggle;
 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
 
 m_schematic = &aSchematic;
 m_out = aFormatter;
 
 size_t i;
 SCH_ITEM* item;
 std::map<wxString, LIB_SYMBOL*> libSymbols;
 SCH_SCREEN* screen = aSelection->GetScreen();
 
 for( i = 0; i < aSelection->GetSize(); ++i )
 {
 item = dynamic_cast<SCH_ITEM*>( aSelection->GetItem( i ) );
 
 wxCHECK2( item, continue );
 
 if( item->Type() != SCH_SYMBOL_T )
 continue;
 
 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
 
 wxCHECK2( symbol, continue );
 
 wxString libSymbolLookup = symbol->GetLibId().Format().wx_str();
 
 if( !symbol->UseLibIdLookup() )
 libSymbolLookup = symbol->GetSchSymbolLibraryName();
 
 auto it = screen->GetLibSymbols().find( libSymbolLookup );
 
 if( it != screen->GetLibSymbols().end() )
 libSymbols[ libSymbolLookup ] = it->second;
 }
 
 if( !libSymbols.empty() )
 {
 m_out->Print( 0, "(lib_symbols\n" );
 
 for( const std::pair<const wxString, LIB_SYMBOL*>& libSymbol : libSymbols )
 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( libSymbol.second, *m_out, 1, libSymbol.first );
 
 m_out->Print( 0, ")\n\n" );
 }
 
 // Store the selected sheets instance information
 SCH_SHEET_LIST selectedSheets;
 SCH_REFERENCE_LIST selectedSymbols;
 
 for( i = 0; i < aSelection->GetSize(); ++i )
 {
 item = (SCH_ITEM*) aSelection->GetItem( i );
 
 switch( item->Type() )
 {
 case SCH_SYMBOL_T:
 saveSymbol( static_cast<SCH_SYMBOL*>( item ), aSchematic, 0, aForClipboard );
 
 aSelectionPath->AppendSymbol( selectedSymbols, static_cast<SCH_SYMBOL*>( item ),
 true, true );
 break;
 
 case SCH_BITMAP_T:
 saveBitmap( static_cast< SCH_BITMAP* >( item ), 0 );
 break;
 
 case SCH_SHEET_T:
 saveSheet( static_cast< SCH_SHEET* >( item ), 0 );
 
 {
 SCH_SHEET_PATH subSheetPath = *aSelectionPath;
 subSheetPath.push_back( static_cast<SCH_SHEET*>( item ) );
 
 fullHierarchy.GetSheetsWithinPath( selectedSheets, subSheetPath );
 fullHierarchy.GetSymbolsWithinPath( selectedSymbols, subSheetPath, true, true );
 }
 
 break;
 
 case SCH_JUNCTION_T:
 saveJunction( static_cast< SCH_JUNCTION* >( item ), 0 );
 break;
 
 case SCH_NO_CONNECT_T:
 saveNoConnect( static_cast< SCH_NO_CONNECT* >( item ), 0 );
 break;
 
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_BUS_BUS_ENTRY_T:
 saveBusEntry( static_cast< SCH_BUS_ENTRY_BASE* >( item ), 0 );
 break;
 
 case SCH_LINE_T:
 saveLine( static_cast< SCH_LINE* >( item ), 0 );
 break;
 
 case SCH_SHAPE_T:
 saveShape( static_cast<SCH_SHAPE*>( item ), 0 );
 break;
 
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 saveText( static_cast<SCH_TEXT*>( item ), 0 );
 break;
 
 case SCH_TEXTBOX_T:
 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 0 );
 break;
 
 default:
 wxASSERT( "Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
 }
 }
 
 // Make all instance information relative to the selection path
 KIID_PATH selectionPath = aSelectionPath->Path();
 
 selectedSheets.SortByPageNumbers();
 std::vector<SCH_SHEET_INSTANCE> sheetinstances = selectedSheets.GetSheetInstances();
 
 for( SCH_SHEET_INSTANCE& sheetInstance : sheetinstances )
 {
 wxASSERT_MSG( sheetInstance.m_Path.MakeRelativeTo( selectionPath ),
 "Sheet is not inside the selection path?" );
 }
 
 selectionPath = aSelectionPath->Path();
 selectedSymbols.SortByReferenceOnly();
 std::vector<SCH_SYMBOL_INSTANCE> symbolInstances = selectedSymbols.GetSymbolInstances();
 
 for( SCH_SYMBOL_INSTANCE& symbolInstance : symbolInstances )
 {
 wxASSERT_MSG( symbolInstance.m_Path.MakeRelativeTo( selectionPath ),
 "Symbol is not inside the selection path?" );
 }
}

References SCH_SHEET_PATH::AppendSymbol(), LIB_ID::Format(), SELECTION::GetItem(), SCH_SYMBOL::GetLibId(), SCH_SCREEN::GetLibSymbols(), SCH_SYMBOL::GetSchSymbolLibraryName(), EE_SELECTION::GetScreen(), SCH_SHEET_LIST::GetSheetInstances(), SCHEMATIC::GetSheets(), SCH_SHEET_LIST::GetSheetsWithinPath(), SELECTION::GetSize(), SCH_REFERENCE_LIST::GetSymbolInstances(), SCH_SHEET_LIST::GetSymbolsWithinPath(), m_out, m_schematic, SCH_SHEET_PATH::Path(), OUTPUTFORMATTER::Print(), SCH_SHEET_PATH::push_back(), saveBitmap(), saveBusEntry(), saveJunction(), saveLine(), saveNoConnect(), saveShape(), saveSheet(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), saveSymbol(), saveText(), saveTextBox(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_SHEET_LIST::SortByPageNumbers(), SCH_REFERENCE_LIST::SortByReferenceOnly(), EDA_ITEM::Type(), SCH_SYMBOL::UseLibIdLookup(), and UTF8::wx_str().

Format() [2/2]

void SCH_SEXPR_PLUGIN::Format

(

SCH_SHEET *

aSheet

)

Definition at line 358 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET* object." );
 wxCHECK_RET( m_schematic != nullptr, "NULL SCHEMATIC* object." );
 
 SCH_SCREEN* screen = aSheet->GetScreen();
 
 wxCHECK( screen, /* void */ );
 
 m_out->Print( 0, "(kicad_sch (version %d) (generator eeschema)\n\n",
 SEXPR_SCHEMATIC_FILE_VERSION );
 
 m_out->Print( 1, "(uuid %s)\n\n", TO_UTF8( screen->m_uuid.AsString() ) );
 
 screen->GetPageSettings().Format( m_out, 1, 0 );
 m_out->Print( 0, "\n" );
 screen->GetTitleBlock().Format( m_out, 1, 0 );
 
 // Save cache library.
 m_out->Print( 1, "(lib_symbols\n" );
 
 for( std::pair<const wxString, LIB_SYMBOL*>& libSymbol : screen->GetLibSymbols() )
 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( libSymbol.second, *m_out, 2, libSymbol.first );
 
 m_out->Print( 1, ")\n\n" );
 
 for( const std::shared_ptr<BUS_ALIAS>& alias : screen->GetBusAliases() )
 saveBusAlias( alias, 1 );
 
 // Enforce item ordering
 auto cmp =
 []( const SCH_ITEM* a, const SCH_ITEM* b )
 {
 if( a->Type() != b->Type() )
 return a->Type() < b->Type();
 
 return a->m_Uuid < b->m_Uuid;
 };
 
 std::multiset<SCH_ITEM*, decltype( cmp )> save_map( cmp );
 
 for( SCH_ITEM* item : screen->Items() )
 save_map.insert( item );
 
 KICAD_T itemType = TYPE_NOT_INIT;
 SCH_LAYER_ID layer = SCH_LAYER_ID_START;
 
 for( SCH_ITEM* item : save_map )
 {
 if( itemType != item->Type() )
 {
 itemType = item->Type();
 
 if( itemType != SCH_SYMBOL_T
 && itemType != SCH_JUNCTION_T
 && itemType != SCH_SHEET_T )
 {
 m_out->Print( 0, "\n" );
 }
 }
 
 switch( item->Type() )
 {
 case SCH_SYMBOL_T:
 m_out->Print( 0, "\n" );
 saveSymbol( static_cast<SCH_SYMBOL*>( item ), *m_schematic, 1, false );
 break;
 
 case SCH_BITMAP_T:
 saveBitmap( static_cast<SCH_BITMAP*>( item ), 1 );
 break;
 
 case SCH_SHEET_T:
 m_out->Print( 0, "\n" );
 saveSheet( static_cast<SCH_SHEET*>( item ), 1 );
 break;
 
 case SCH_JUNCTION_T:
 saveJunction( static_cast<SCH_JUNCTION*>( item ), 1 );
 break;
 
 case SCH_NO_CONNECT_T:
 saveNoConnect( static_cast<SCH_NO_CONNECT*>( item ), 1 );
 break;
 
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_BUS_BUS_ENTRY_T:
 saveBusEntry( static_cast<SCH_BUS_ENTRY_BASE*>( item ), 1 );
 break;
 
 case SCH_LINE_T:
 if( layer != item->GetLayer() )
 {
 if( layer == SCH_LAYER_ID_START )
 {
 layer = item->GetLayer();
 }
 else
 {
 layer = item->GetLayer();
 m_out->Print( 0, "\n" );
 }
 }
 
 saveLine( static_cast<SCH_LINE*>( item ), 1 );
 break;
 
 case SCH_SHAPE_T:
 saveShape( static_cast<SCH_SHAPE*>( item ), 1 );
 break;
 
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 saveText( static_cast<SCH_TEXT*>( item ), 1 );
 break;
 
 case SCH_TEXTBOX_T:
 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 1 );
 break;
 
 default:
 wxASSERT( "Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
 }
 }
 
 if( aSheet->HasRootInstance() )
 {
 std::vector< SCH_SHEET_INSTANCE> instances;
 
 instances.emplace_back( aSheet->GetRootInstance() );
 saveInstances( instances, 1 );
 }
 
 m_out->Print( 0, ")\n" );
}

References KIID::AsString(), PAGE_INFO::Format(), TITLE_BLOCK::Format(), SCH_SCREEN::GetBusAliases(), SCH_SCREEN::GetLibSymbols(), SCH_SCREEN::GetPageSettings(), SCH_SHEET::GetRootInstance(), SCH_SHEET::GetScreen(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET::HasRootInstance(), SCH_SCREEN::Items(), m_out, m_schematic, SCH_SCREEN::m_uuid, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveInstances(), saveJunction(), saveLine(), saveNoConnect(), saveShape(), saveSheet(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), saveSymbol(), saveText(), saveTextBox(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LAYER_ID_START, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SEXPR_SCHEMATIC_FILE_VERSION, TO_UTF8, EDA_ITEM::Type(), and TYPE_NOT_INIT.

Referenced by SCH_EDITOR_CONTROL::doCopy(), and Save().

FormatLibSymbol()

void SCH_SEXPR_PLUGIN::FormatLibSymbol ( LIB_SYMBOL *  aPart, OUTPUTFORMATTER &  aFormatter  )

static

Definition at line 1660 of file sch_sexpr_plugin.cpp.

{
 
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( symbol, formatter );
}

References SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Copy(), and SYMBOL_EDIT_FRAME::CopySymbolToClipboard().

GetAvailableSymbolFields()

void SCH_SEXPR_PLUGIN::GetAvailableSymbolFields ( std::vector< wxString > &  aNames )

overridevirtual

Retrieves a list of (custom) field names that are present on symbols in this library.

The plugin is responsible for guaranteeing that this list contains the set of unique custom field names present on any symbols contained in the library.

The required KiCad fields are not included in this list.

Parameters

aNames

will be filled with any custom fields present in this library.

Reimplemented from SCH_PLUGIN.

Definition at line 1612 of file sch_sexpr_plugin.cpp.

{
 if( !m_cache )
 return;
 
 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
 
 std::set<wxString> fieldNames;
 
 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
 {
 std::vector<LIB_FIELD*> fields;
 it->second->GetFields( fields );
 
 for( LIB_FIELD* field : fields )
 {
 if( field->IsMandatory() )
 continue;
 
 // TODO(JE): enable configurability of this outside database libraries?
 // if( field->ShowInChooser() )
 fieldNames.insert( field->GetName() );
 }
 }
 
 std::copy( fieldNames.begin(), fieldNames.end(), std::back_inserter( aNames ) );
}

References m_cache, and SCH_LIB_PLUGIN_CACHE::m_symbols.

Referenced by GetDefaultSymbolFields().

GetDefaultSymbolFields()

void SCH_SEXPR_PLUGIN::GetDefaultSymbolFields ( std::vector< wxString > &  aNames )

overridevirtual

Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

This list should be a subset of the result returned by GetAvailableSymbolFields().

The preference for which fields to hide and show for a given library is stored on a per-library basis in a user's preferences (or in the project local settings for a project- local library). The set of fields returned by GetDefaultSymbolFields() will be used if this preference is missing.

Parameters

aNames

will be filled with the custom field names that should be shown by default

Reimplemented from SCH_PLUGIN.

Definition at line 1641 of file sch_sexpr_plugin.cpp.

{
 GetAvailableSymbolFields( aNames );
}

References GetAvailableSymbolFields().

GetError()

const wxString & SCH_SEXPR_PLUGIN::GetError ( ) const

inlineoverridevirtual

Return an error string to the caller.

This is useful for schematic loaders that can load partial schematics where throwing an exception would be problematic such as the KiCad legacy plugin.

Returns

an unformatted string containing errors if any.

Reimplemented from SCH_PLUGIN.

Definition at line 138 of file sch_sexpr_plugin.h.

{ return m_error; }

References m_error.

GetFileExtension()

const wxString SCH_SEXPR_PLUGIN::GetFileExtension ( ) const

inlineoverridevirtual

Return the file extension for the SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 74 of file sch_sexpr_plugin.h.

 {
 return wxT( "kicad_sch" );
 }

GetLibraryFileExtension()

const wxString SCH_SEXPR_PLUGIN::GetLibraryFileExtension ( ) const

inlineoverridevirtual

Return the library file extension for the SCH_PLUGIN object.

Implements SCH_PLUGIN.

Definition at line 79 of file sch_sexpr_plugin.h.

 {
 return wxT( "kicad_sym" );
 }

GetModifyHash()

int SCH_SEXPR_PLUGIN::GetModifyHash ( ) const

overridevirtual

Return the modification hash from the library cache.

Note

This is temporary until the new s-expr file format is implement. The new file format will embed symbols instead of referencing them from the library. This function can be removed when the new file format is implemented.

Returns

the modification hash of the library cache.

Implements SCH_PLUGIN.

Definition at line 1429 of file sch_sexpr_plugin.cpp.

{
 if( m_cache )
 return m_cache->GetModifyHash();
 
 // If the cache hasn't been loaded, it hasn't been modified.
 return 0;
}

References SCH_LIB_PLUGIN_CACHE::GetModifyHash(), and m_cache.

GetName()

const wxString SCH_SEXPR_PLUGIN::GetName ( ) const

inlineoverridevirtual

Return a brief hard coded name for this SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 69 of file sch_sexpr_plugin.h.

 {
 return wxT( "Eeschema s-expression" );
 }

GetSubLibraryNames()

virtual void SCH_PLUGIN::GetSubLibraryNames ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of sub-libraries in this library.

Some types of symbol library support sub-libraries, which are a single-level organizational hierarchy that is implementation-defined per plugin. Most of KiCad ignores sub-libraries and treats the hierarchy between library and symbol as flat, but the sub-libraries are used for sorting and grouping symbols in the symbol chooser.

Has no effect if SupportsSubLibraries() returns false.

Parameters

aNames

will be filled with a list of sub-libraries within this symbol library

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 463 of file sch_io_mgr.h.

{}

Referenced by SYMBOL_LIB_TABLE_ROW::GetSubLibraryNames().

init()

void SCH_SEXPR_PLUGIN::init ( SCHEMATIC *  aSchematic, const STRING_UTF8_MAP *  aProperties = nullptr  )

protected

initialize PLUGIN like a constructor would.

Definition at line 88 of file sch_sexpr_plugin.cpp.

{
 m_version = 0;
 m_appending = false;
 m_rootSheet = nullptr;
 m_schematic = aSchematic;
 m_cache = nullptr;
 m_out = nullptr;
 m_nextFreeFieldId = 100; // number arbitrarily > MANDATORY_FIELDS or SHEET_MANDATORY_FIELDS
}

References m_appending, m_cache, m_nextFreeFieldId, m_out, m_rootSheet, m_schematic, and m_version.

Referenced by Load(), Save(), and SCH_SEXPR_PLUGIN().

isBuffering()

bool SCH_SEXPR_PLUGIN::isBuffering ( const STRING_UTF8_MAP *  aProperties )

private

Definition at line 1423 of file sch_sexpr_plugin.cpp.

{
 return ( aProperties && aProperties->Exists( SCH_SEXPR_PLUGIN::PropBuffering ) );
}

References STRING_UTF8_MAP::Exists(), and PropBuffering.

Referenced by cacheLib(), DeleteSymbol(), and SaveSymbol().

IsSymbolLibWritable()

bool SCH_SEXPR_PLUGIN::IsSymbolLibWritable ( const wxString &  aLibraryPath )

overridevirtual

Return true if the library at aLibraryPath is writable.

(Often system libraries are read only because of where they are installed.)

Parameters

aLibraryPath

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

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented from SCH_PLUGIN.

Definition at line 1604 of file sch_sexpr_plugin.cpp.

{
 wxFileName fn( aLibraryPath );
 
 return ( fn.FileExists() && fn.IsFileWritable() ) || fn.IsDirWritable();
}

Load()

SCH_SHEET * SCH_SEXPR_PLUGIN::Load ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Load information from some input file format that this SCH_PLUGIN implementation knows about, into either a new SCH_SHEET or an existing one.

This may be used to load an entire new SCH_SHEET, 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.
aKiway	is the KIWAY object used to access the symbol libraries loaded by the project.
aAppendToMe	is an existing SCH_SHEET 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.

Returns

the successfully loaded schematic, or the same one as aAppendToMe if aAppendToMe was not NULL, and the 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 SCH_PLUGIN.

Definition at line 100 of file sch_sexpr_plugin.cpp.

{
 wxASSERT( !aFileName || aSchematic != nullptr );
 
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 SCH_SHEET* sheet;
 
 wxFileName fn = aFileName;
 
 // Unfortunately child sheet file names the legacy schematic file format are not fully
 // qualified and are always appended to the project path. The aFileName attribute must
 // always be an absolute path so the project path can be used for load child sheet files.
 wxASSERT( fn.IsAbsolute() );
 
 if( aAppendToMe )
 {
 m_appending = true;
 wxLogTrace( traceSchPlugin, "Append \"%s\" to sheet \"%s\".",
 aFileName, aAppendToMe->GetFileName() );
 
 wxFileName normedFn = aAppendToMe->GetFileName();
 
 if( !normedFn.IsAbsolute() )
 {
 if( aFileName.Right( normedFn.GetFullPath().Length() ) == normedFn.GetFullPath() )
 m_path = aFileName.Left( aFileName.Length() - normedFn.GetFullPath().Length() );
 }
 
 if( m_path.IsEmpty() )
 m_path = aSchematic->Prj().GetProjectPath();
 
 wxLogTrace( traceSchPlugin, "Normalized append path \"%s\".", m_path );
 }
 else
 {
 m_path = aSchematic->Prj().GetProjectPath();
 }
 
 m_currentPath.push( m_path );
 init( aSchematic, aProperties );
 
 if( aAppendToMe == nullptr )
 {
 // Clean up any allocated memory if an exception occurs loading the schematic.
 std::unique_ptr<SCH_SHEET> newSheet = std::make_unique<SCH_SHEET>( aSchematic );
 
 wxFileName relPath( aFileName );
 
 // Do not use wxPATH_UNIX as option in MakeRelativeTo(). It can create incorrect
 // relative paths on Windows, because paths have a disk identifier (C:, D: ...)
 relPath.MakeRelativeTo( aSchematic->Prj().GetProjectPath() );
 
 newSheet->SetFileName( relPath.GetFullPath() );
 m_rootSheet = newSheet.get();
 loadHierarchy( SCH_SHEET_PATH(), newSheet.get() );
 
 // If we got here, the schematic loaded successfully.
 sheet = newSheet.release();
 m_rootSheet = nullptr; // Quiet Coverity warning.
 }
 else
 {
 wxCHECK_MSG( aSchematic->IsValid(), nullptr, "Can't append to a schematic with no root!" );
 m_rootSheet = &aSchematic->Root();
 sheet = aAppendToMe;
 loadHierarchy( SCH_SHEET_PATH(), sheet );
 }
 
 wxASSERT( m_currentPath.size() == 1 ); // only the project path should remain
 
 m_currentPath.pop(); // Clear the path stack for next call to Load
 
 return sheet;
}

References SCH_SHEET::GetFileName(), PROJECT::GetProjectPath(), init(), SCHEMATIC::IsValid(), loadHierarchy(), m_appending, m_currentPath, m_path, m_rootSheet, SCHEMATIC::Prj(), SCHEMATIC::Root(), and traceSchPlugin.

LoadContent()

void SCH_SEXPR_PLUGIN::LoadContent	(	LINE_READER &	aReader,
		SCH_SHEET *	aSheet,
		int	aVersion = SEXPR_SCHEMATIC_FILE_VERSION
	)

Definition at line 320 of file sch_sexpr_plugin.cpp.

{
 wxCHECK( aSheet, /* void */ );
 
 LOCALE_IO toggle;
 SCH_SEXPR_PARSER parser( &aReader );
 
 parser.ParseSchematic( aSheet, true, aFileVersion );
}

References SCH_SEXPR_PARSER::ParseSchematic().

Referenced by SCH_EDITOR_CONTROL::Paste().

loadFile()

void SCH_SEXPR_PLUGIN::loadFile ( const wxString &  aFileName, SCH_SHEET *  aSheet  )

private

Definition at line 295 of file sch_sexpr_plugin.cpp.

{
 FILE_LINE_READER reader( aFileName );
 
 size_t lineCount = 0;
 
 if( m_progressReporter )
 {
 m_progressReporter->Report( wxString::Format( _( "Loading %s..." ), aFileName ) );
 
 if( !m_progressReporter->KeepRefreshing() )
 THROW_IO_ERROR( ( "Open cancelled by user." ) );
 
 while( reader.ReadLine() )
 lineCount++;
 
 reader.Rewind();
 }
 
 SCH_SEXPR_PARSER parser( &reader, m_progressReporter, lineCount, m_rootSheet, m_appending );
 
 parser.ParseSchematic( aSheet );
}

References _, Format(), PROGRESS_REPORTER::KeepRefreshing(), m_appending, m_progressReporter, m_rootSheet, SCH_SEXPR_PARSER::ParseSchematic(), FILE_LINE_READER::ReadLine(), PROGRESS_REPORTER::Report(), FILE_LINE_READER::Rewind(), and THROW_IO_ERROR.

Referenced by loadHierarchy().

loadHierarchy()

void SCH_SEXPR_PLUGIN::loadHierarchy ( const SCH_SHEET_PATH &  aParentSheetPath, SCH_SHEET *  aSheet  )

private

Definition at line 179 of file sch_sexpr_plugin.cpp.

{
 m_currentSheetPath.push_back( aSheet );
 
 SCH_SCREEN* screen = nullptr;
 
 if( !aSheet->GetScreen() )
 {
 // SCH_SCREEN objects store the full path and file name where the SCH_SHEET object only
 // stores the file name and extension. Add the project path to the file name and
 // extension to compare when calling SCH_SHEET::SearchHierarchy().
 wxFileName fileName = aSheet->GetFileName();
 
 if( !fileName.IsAbsolute() )
 fileName.MakeAbsolute( m_currentPath.top() );
 
 // Save the current path so that it gets restored when descending and ascending the
 // sheet hierarchy which allows for sheet schematic files to be nested in folders
 // relative to the last path a schematic was loaded from.
 wxLogTrace( traceSchPlugin, "Saving path '%s'", m_currentPath.top() );
  m_currentPath.push( fileName.GetPath() );
 wxLogTrace( traceSchPlugin, "Current path '%s'", m_currentPath.top() );
 wxLogTrace( traceSchPlugin, "Loading '%s'", fileName.GetFullPath() );
 
 SCH_SHEET_PATH ancestorSheetPath = aParentSheetPath;
 
 while( !ancestorSheetPath.empty() )
 {
 if( ancestorSheetPath.LastScreen()->GetFileName() == fileName.GetFullPath() )
 {
 if( !m_error.IsEmpty() )
 m_error += "\n";
 
 m_error += wxString::Format( _( "Could not load sheet '%s' because it already "
 "appears as a direct ancestor in the schematic "
 "hierarchy." ),
 fileName.GetFullPath() );
 
 fileName = wxEmptyString;
 
 break;
 }
 
 ancestorSheetPath.pop_back();
 }
 
 if( ancestorSheetPath.empty() )
 {
 // Existing schematics could be either in the root sheet path or the current sheet
 // load path so we have to check both.
 if( !m_rootSheet->SearchHierarchy( fileName.GetFullPath(), &screen ) )
 m_currentSheetPath.at( 0 )->SearchHierarchy( fileName.GetFullPath(), &screen );
 }
 
 if( screen )
 {
 aSheet->SetScreen( screen );
 aSheet->GetScreen()->SetParent( m_schematic );
 // Do not need to load the sub-sheets - this has already been done.
 }
 else
 {
 aSheet->SetScreen( new SCH_SCREEN( m_schematic ) );
 aSheet->GetScreen()->SetFileName( fileName.GetFullPath() );
 
 try
 {
 loadFile( fileName.GetFullPath(), aSheet );
 }
 catch( const IO_ERROR& ioe )
 {
 // If there is a problem loading the root sheet, there is no recovery.
 if( aSheet == m_rootSheet )
 throw;
 
 // For all subsheets, queue up the error message for the caller.
 if( !m_error.IsEmpty() )
 m_error += "\n";
 
 m_error += ioe.What();
 }
 
 if( fileName.FileExists() )
 {
 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsFileWritable() );
 aSheet->GetScreen()->SetFileExists( true );
 }
 else
 {
 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsDirWritable() );
 aSheet->GetScreen()->SetFileExists( false );
 }
 
 SCH_SHEET_PATH currentSheetPath = aParentSheetPath;
 currentSheetPath.push_back( aSheet );
 
 // This was moved out of the try{} block so that any sheet definitions that
 // the plugin fully parsed before the exception was raised will be loaded.
 for( SCH_ITEM* aItem : aSheet->GetScreen()->Items().OfType( SCH_SHEET_T ) )
 {
 wxCHECK2( aItem->Type() == SCH_SHEET_T, /* do nothing */ );
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
 
 // Recursion starts here.
 loadHierarchy( currentSheetPath, sheet );
 }
 }
 
 m_currentPath.pop();
 wxLogTrace( traceSchPlugin, "Restoring path \"%s\"", m_currentPath.top() );
 }
 
 m_currentSheetPath.pop_back();
}

References _, SCH_SHEET_PATH::at(), SCH_SHEET_PATH::empty(), Format(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCH_SHEET::GetScreen(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), loadFile(), loadHierarchy(), m_currentPath, m_currentSheetPath, m_error, m_rootSheet, m_schematic, EE_RTREE::OfType(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), SCH_SHEET_T, SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileExists(), SCH_SCREEN::SetFileName(), SCH_SCREEN::SetFileReadOnly(), EDA_ITEM::SetParent(), SCH_SHEET::SetScreen(), traceSchPlugin, and IO_ERROR::What().

Referenced by Load(), and loadHierarchy().

LoadSymbol()

LIB_SYMBOL * SCH_SEXPR_PLUGIN::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aPartName	is the name of the LIB_SYMBOL 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.

Returns

the part created on the heap if found caller shares it or NULL if not found.

Exceptions

IO_ERROR

if the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented from SCH_PLUGIN.

Definition at line 1481 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 cacheLib( aLibraryPath, aProperties );
 
 LIB_SYMBOL_MAP::const_iterator it = m_cache->m_symbols.find( aSymbolName );
 
 if( it == m_cache->m_symbols.end() )
 return nullptr;
 
 return it->second;
}

References cacheLib(), m_cache, and SCH_LIB_PLUGIN_CACHE::m_symbols.

ParseLibSymbol()

LIB_SYMBOL * SCH_SEXPR_PLUGIN::ParseLibSymbol ( LINE_READER &  aReader, int  aVersion = SEXPR_SCHEMATIC_FILE_VERSION  )

static

Definition at line 1647 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 LIB_SYMBOL_MAP map;
 SCH_SEXPR_PARSER parser( &aReader );
 
 parser.NeedLEFT();
 parser.NextTok();
 
 return parser.ParseSymbol( map, aFileVersion );
}

References SCH_SEXPR_PARSER::ParseSymbol().

Referenced by SYMBOL_EDIT_FRAME::DuplicateSymbol(), and SYMBOL_EDITOR_EDIT_TOOL::Paste().

Save()

void SCH_SEXPR_PLUGIN::Save ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.

Parameters

aFileName	is the name of a file to save to on disk.
aSheet	is the class SCH_SHEET in memory document tree from which to extract information when writing to aFileName. The caller continues to own the SCHEMATIC, and the plugin should refrain from modifying the SCHEMATIC if possible.
aSchematic	is the SCHEMATIC object used to access any schematic-wide or project information needed to save the document.
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. Set the #PropSaveCurrentSheetOnly property to only save the current sheet. Otherwise, all hierarchical sheets are saved.

Exceptions

IO_ERROR

if there is a problem saving or exporting.

Reimplemented from SCH_PLUGIN.

Definition at line 331 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET object." );
 wxCHECK_RET( !aFileName.IsEmpty(), "No schematic file name defined." );
 
 LOCALE_IO toggle; // toggles on, then off, the C locale, to write floating point values.
 
 init( aSchematic, aProperties );
 
 wxFileName fn = aFileName;
 
 // File names should be absolute. Don't assume everything relative to the project path
 // works properly.
 wxASSERT( fn.IsAbsolute() );
 
 FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
 
 m_out = &formatter; // no ownership
 
 Format( aSheet );
 
 if( aSheet->GetScreen() )
 aSheet->GetScreen()->SetFileExists( true );
}

References Format(), SCH_SHEET::GetScreen(), init(), m_out, and SCH_SCREEN::SetFileExists().

Referenced by KI_TEST::DumpSchematicToFile().

saveBitmap()

void SCH_SEXPR_PLUGIN::saveBitmap ( SCH_BITMAP *  aBitmap, int  aNestLevel  )

private

Definition at line 909 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aBitmap != nullptr && m_out != nullptr, "" );
 
 const wxImage* image = aBitmap->GetImage()->GetImageData();
 
 wxCHECK_RET( image != nullptr, "wxImage* is NULL" );
 
 m_out->Print( aNestLevel, "(image (at %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBitmap->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBitmap->GetPosition().y ).c_str() );
 
 double scale = aBitmap->GetImage()->GetScale();
 
 // 20230121 or older file format versions assumed 300 image PPI at load/save.
 // Let's keep compatibility by changing image scale.
 if( SEXPR_SCHEMATIC_FILE_VERSION <= 20230121 )
 {
 BITMAP_BASE* bm_image = aBitmap->GetImage();
 scale = scale * 300.0 / bm_image->GetPPI();
 }
 
 if( scale != 1.0 )
 m_out->Print( 0, " (scale %g)", scale );
 
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aBitmap->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel + 1, "(data" );
 
 wxMemoryOutputStream stream;
 
 image->SaveFile( stream, wxBITMAP_TYPE_PNG );
 
 // Write binary data in hexadecimal form (ASCII)
 wxStreamBuffer* buffer = stream.GetOutputStreamBuffer();
 wxString out = wxBase64Encode( buffer->GetBufferStart(), buffer->GetBufferSize() );
 
 // Apparently the MIME standard character width for base64 encoding is 76 (unconfirmed)
 // so use it in a vein attempt to be standard like.
#define MIME_BASE64_LENGTH 76
 
 size_t first = 0;
 
 while( first < out.Length() )
 {
 m_out->Print( 0, "\n" );
 m_out->Print( aNestLevel + 2, "%s", TO_UTF8( out( first, MIME_BASE64_LENGTH ) ) );
 first += MIME_BASE64_LENGTH;
 }
 
 m_out->Print( 0, "\n" );
 m_out->Print( aNestLevel + 1, ")\n" ); // Closes data token.
 m_out->Print( aNestLevel, ")\n" ); // Closes image token.
}

References KIID::AsString(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_BITMAP::GetImage(), BITMAP_BASE::GetImageData(), SCH_BITMAP::GetPosition(), BITMAP_BASE::GetPPI(), BITMAP_BASE::GetScale(), image, m_out, EDA_ITEM::m_Uuid, MIME_BASE64_LENGTH, OUTPUTFORMATTER::Print(), scale, schIUScale, SEXPR_SCHEMATIC_FILE_VERSION, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveBusAlias()

void SCH_SEXPR_PLUGIN::saveBusAlias ( std::shared_ptr< BUS_ALIAS >  aAlias, int  aNestLevel  )

private

Definition at line 1363 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aAlias != nullptr, "BUS_ALIAS* is NULL" );
 
 wxString members;
 
 for( const wxString& member : aAlias->Members() )
 {
 if( !members.IsEmpty() )
 members += wxS( " " );
 
 members += m_out->Quotew( member );
 }
 
 m_out->Print( aNestLevel, "(bus_alias %s (members %s))\n",
 m_out->Quotew( aAlias->GetName() ).c_str(),
 TO_UTF8( members ) );
}

References m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and TO_UTF8.

Referenced by Format().

saveBusEntry()

void SCH_SEXPR_PLUGIN::saveBusEntry ( SCH_BUS_ENTRY_BASE *  aBusEntry, int  aNestLevel  )

private

Definition at line 1142 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aBusEntry != nullptr && m_out != nullptr, "" );
 
 // Bus to bus entries are converted to bus line segments.
 if( aBusEntry->GetClass() == "SCH_BUS_BUS_ENTRY" )
 {
 SCH_LINE busEntryLine( aBusEntry->GetPosition(), LAYER_BUS );
 
 busEntryLine.SetEndPoint( aBusEntry->GetEnd() );
 saveLine( &busEntryLine, aNestLevel );
 }
 else
 {
 m_out->Print( aNestLevel, "(bus_entry (at %s %s) (size %s %s)\n",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBusEntry->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBusEntry->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBusEntry->GetSize().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aBusEntry->GetSize().y ).c_str() );
 
 aBusEntry->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
 
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aBusEntry->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel, ")\n" );
 }
}

References KIID::AsString(), STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_ITEM::GetClass(), SCH_BUS_ENTRY_BASE::GetEnd(), SCH_BUS_ENTRY_BASE::GetPosition(), SCH_BUS_ENTRY_BASE::GetSize(), SCH_BUS_ENTRY_BASE::GetStroke(), LAYER_BUS, m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), saveLine(), schIUScale, SCH_LINE::SetEndPoint(), TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveField()

void SCH_SEXPR_PLUGIN::saveField ( SCH_FIELD *  aField, int  aNestLevel  )

private

Definition at line 862 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aField != nullptr && m_out != nullptr, "" );
 
 wxString fieldName = aField->GetCanonicalName();
 // For some reason (bug in legacy parser?) the field ID for non-mandatory fields is -1 so
 // check for this in order to correctly use the field name.
 
 if( aField->GetId() == -1 /* undefined ID */ )
 {
 aField->SetId( m_nextFreeFieldId );
 m_nextFreeFieldId += 1;
 }
 else if( aField->GetId() >= m_nextFreeFieldId )
 {
 m_nextFreeFieldId = aField->GetId() + 1;
 }
 
 m_out->Print( aNestLevel, "(property %s %s (at %s %s %s)",
 m_out->Quotew( fieldName ).c_str(),
 m_out->Quotew( aField->GetText() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aField->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aField->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( aField->GetTextAngle() ).c_str() );
 
 if( aField->IsNameShown() )
 m_out->Print( 0, " (show_name)" );
 
 if( !aField->CanAutoplace() )
 m_out->Print( 0, " (do_not_autoplace)" );
 
 if( !aField->IsDefaultFormatting()
 || ( aField->GetTextHeight() != schIUScale.MilsToIU( DEFAULT_SIZE_TEXT ) ) )
 {
 m_out->Print( 0, "\n" );
 aField->Format( m_out, aNestLevel, 0 );
 m_out->Print( aNestLevel, ")\n" ); // Closes property token with font effects.
 }
 else
 {
 m_out->Print( 0, ")\n" ); // Closes property token without font effects.
 }
}

References SCH_FIELD::CanAutoplace(), DEFAULT_SIZE_TEXT, EDA_TEXT::Format(), EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetId(), SCH_FIELD::GetPosition(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextHeight(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsNameShown(), m_nextFreeFieldId, m_out, EDA_IU_SCALE::MilsToIU(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), schIUScale, SCH_FIELD::SetId(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveSheet(), saveSymbol(), and saveText().

saveInstances()

void SCH_SEXPR_PLUGIN::saveInstances ( const std::vector< SCH_SHEET_INSTANCE > &  aSheets, int  aNestLevel  )

private

Definition at line 1383 of file sch_sexpr_plugin.cpp.

{
 if( aInstances.size() )
 {
 m_out->Print( 0, "\n" );
 m_out->Print( aNestLevel, "(sheet_instances\n" );
 
 for( const SCH_SHEET_INSTANCE& instance : aInstances )
 {
 wxString path = instance.m_Path.AsString();
 
 if( path.IsEmpty() )
 path = wxT( "/" ); // Root path
 
 m_out->Print( aNestLevel + 1, "(path %s (page %s))\n",
 m_out->Quotew( path ).c_str(),
 m_out->Quotew( instance.m_PageNumber ).c_str() );
 }
 
 m_out->Print( aNestLevel, ")\n" ); // Close sheet instances token.
 }
}

References m_out, path, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by Format().

saveJunction()

void SCH_SEXPR_PLUGIN::saveJunction ( SCH_JUNCTION *  aJunction, int  aNestLevel  )

private

Definition at line 1107 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aJunction != nullptr && m_out != nullptr, "" );
 
 m_out->Print( aNestLevel, "(junction (at %s %s) (diameter %s) (color %d %d %d %s)\n",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aJunction->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aJunction->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aJunction->GetDiameter() ).c_str(),
 KiROUND( aJunction->GetColor().r * 255.0 ),
 KiROUND( aJunction->GetColor().g * 255.0 ),
 KiROUND( aJunction->GetColor().b * 255.0 ),
 FormatDouble2Str( aJunction->GetColor().a ).c_str() );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aJunction->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel, ")\n" );
}

References KIGFX::COLOR4D::a, KIID::AsString(), KIGFX::COLOR4D::b, FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), KIGFX::COLOR4D::g, SCH_JUNCTION::GetColor(), SCH_JUNCTION::GetDiameter(), SCH_JUNCTION::GetPosition(), KiROUND(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), KIGFX::COLOR4D::r, schIUScale, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SaveLibrary()

void SCH_SEXPR_PLUGIN::SaveLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Reimplemented from SCH_PLUGIN.

Definition at line 1570 of file sch_sexpr_plugin.cpp.

{
 if( !m_cache )
 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryPath );
 
 wxString oldFileName = m_cache->GetFileName();
 
 if( !m_cache->IsFile( aLibraryPath ) )
 {
 m_cache->SetFileName( aLibraryPath );
 }
 
 // This is a forced save.
 m_cache->SetModified();
 m_cache->Save();
 m_cache->SetFileName( oldFileName );
}

References SCH_LIB_PLUGIN_CACHE::GetFileName(), SCH_LIB_PLUGIN_CACHE::IsFile(), m_cache, SCH_SEXPR_PLUGIN_CACHE::Save(), SCH_LIB_PLUGIN_CACHE::SetFileName(), and SCH_LIB_PLUGIN_CACHE::SetModified().

saveLine()

void SCH_SEXPR_PLUGIN::saveLine ( SCH_LINE *  aLine, int  aNestLevel  )

private

Definition at line 1214 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aLine != nullptr && m_out != nullptr, "" );
 
 wxString lineType;
 
 STROKE_PARAMS line_stroke = aLine->GetStroke();
 
 switch( aLine->GetLayer() )
 {
 case LAYER_BUS: lineType = "bus"; break;
 case LAYER_WIRE: lineType = "wire"; break;
 case LAYER_NOTES: lineType = "polyline"; break;
 default:
 UNIMPLEMENTED_FOR( LayerName( aLine->GetLayer() ) );
 }
 
 m_out->Print( aNestLevel, "(%s (pts (xy %s %s) (xy %s %s))\n",
 TO_UTF8( lineType ),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
  aLine->GetStartPoint().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aLine->GetStartPoint().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aLine->GetEndPoint().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aLine->GetEndPoint().y ).c_str() );
 
 line_stroke.Format( m_out, schIUScale, aNestLevel + 1 );
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aLine->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_LINE::GetStartPoint(), SCH_LINE::GetStroke(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, LayerName(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format(), and saveBusEntry().

saveNoConnect()

void SCH_SEXPR_PLUGIN::saveNoConnect ( SCH_NO_CONNECT *  aNoConnect, int  aNestLevel  )

private

Definition at line 1129 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aNoConnect != nullptr && m_out != nullptr, "" );
 
 m_out->Print( aNestLevel, "(no_connect (at %s %s) (uuid %s))\n",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aNoConnect->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aNoConnect->GetPosition().y ).c_str(),
 TO_UTF8( aNoConnect->m_Uuid.AsString() ) );
}

References KIID::AsString(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_NO_CONNECT::GetPosition(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveShape()

void SCH_SEXPR_PLUGIN::saveShape ( SCH_SHAPE *  aShape, int  aNestLevel  )

private

Definition at line 1177 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aShape != nullptr && m_out != nullptr, "" );
 
 switch( aShape->GetShape() )
 {
 case SHAPE_T::ARC:
 formatArc( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
 aShape->GetFillColor(), aShape->m_Uuid );
 break;
 
 case SHAPE_T::CIRCLE:
 formatCircle( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
 aShape->GetFillColor(), aShape->m_Uuid );
 break;
 
 case SHAPE_T::RECT:
 formatRect( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
 aShape->GetFillColor(), aShape->m_Uuid );
 break;
 
 case SHAPE_T::BEZIER:
 formatBezier( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
 aShape->GetFillColor(), aShape->m_Uuid );
 break;
 
 case SHAPE_T::POLY:
 formatPoly( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
 aShape->GetFillColor(), aShape->m_Uuid );
 break;
 
 default:
 UNIMPLEMENTED_FOR( aShape->SHAPE_T_asString() );
 }
}

References ARC, BEZIER, CIRCLE, formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetShape(), SCH_SHAPE::GetStroke(), m_out, EDA_ITEM::m_Uuid, POLY, RECT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by Format().

saveSheet()

void SCH_SEXPR_PLUGIN::saveSheet ( SCH_SHEET *  aSheet, int  aNestLevel  )

private

Definition at line 969 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aSheet != nullptr && m_out != nullptr, "" );
 
 m_out->Print( aNestLevel, "(sheet (at %s %s) (size %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSheet->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSheet->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSheet->GetSize().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSheet->GetSize().y ).c_str() );
 
 if( aSheet->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
 m_out->Print( 0, " (fields_autoplaced)" );
 
 m_out->Print( 0, "\n" );
 
 STROKE_PARAMS stroke( aSheet->GetBorderWidth(), PLOT_DASH_TYPE::SOLID,
 aSheet->GetBorderColor() );
 
 stroke.SetWidth( aSheet->GetBorderWidth() );
 stroke.Format( m_out, schIUScale, aNestLevel + 1 );
 
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(fill (color %d %d %d %0.4f))\n",
 KiROUND( aSheet->GetBackgroundColor().r * 255.0 ),
 KiROUND( aSheet->GetBackgroundColor().g * 255.0 ),
 KiROUND( aSheet->GetBackgroundColor().b * 255.0 ),
 aSheet->GetBackgroundColor().a );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aSheet->m_Uuid.AsString() ) );
 
 m_nextFreeFieldId = SHEET_MANDATORY_FIELDS;
 
 for( SCH_FIELD& field : aSheet->GetFields() )
 {
 saveField( &field, aNestLevel + 1 );
 }
 
 for( const SCH_SHEET_PIN* pin : aSheet->GetPins() )
 {
 m_out->Print( aNestLevel + 1, "(pin %s %s (at %s %s %s)\n",
 EscapedUTF8( pin->GetText() ).c_str(),
 getSheetPinShapeToken( pin->GetShape() ),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 pin->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 pin->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( getSheetPinAngle( pin->GetSide() ) ).c_str() );
 
 pin->Format( m_out, aNestLevel + 1, 0 );
 
 m_out->Print( aNestLevel + 2, "(uuid %s)\n", TO_UTF8( pin->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel + 1, ")\n" ); // Closes pin token.
 }
 
 // Save all sheet instances here except the root sheet instance.
 std::vector< SCH_SHEET_INSTANCE > sheetInstances = aSheet->GetInstances();
 
 auto it = sheetInstances.begin();
 
 while( it != sheetInstances.end() )
 {
 if( it->m_Path.size() == 0 )
 it = sheetInstances.erase( it );
 else
 it++;
 }
 
 if( !sheetInstances.empty() )
 {
 m_out->Print( aNestLevel + 1, "(instances\n" );
 
 KIID lastProjectUuid;
 KIID rootSheetUuid = m_schematic->Root().m_Uuid;
 SCH_SHEET_LIST fullHierarchy = m_schematic->GetSheets();
 bool project_open = false;
 
 for( size_t i = 0; i < sheetInstances.size(); i++ )
 {
 // If the instance data is part of this design but no longer has an associated sheet
 // path, don't save it. This prevents large amounts of orphaned instance data for the
 // current project from accumulating in the schematic files.
 //
 // Keep all instance data when copying to the clipboard. It may be needed on paste.
 if( ( sheetInstances[i].m_Path[0] == rootSheetUuid )
 && !fullHierarchy.GetSheetPathByKIIDPath( sheetInstances[i].m_Path, false ) )
 {
 if( project_open && ( ( i + 1 == sheetInstances.size() )
  || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
 {
 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
 project_open = false;
 }
 
 continue;
 }
 
 if( lastProjectUuid != sheetInstances[i].m_Path[0] )
 {
 wxString projectName;
 
 if( sheetInstances[i].m_Path[0] == rootSheetUuid )
 projectName = m_schematic->Prj().GetProjectName();
 else
 projectName = sheetInstances[i].m_ProjectName;
 
 lastProjectUuid = sheetInstances[i].m_Path[0];
 m_out->Print( aNestLevel + 2, "(project %s\n",
 m_out->Quotew( projectName ).c_str() );
 project_open = true;
 }
 
 wxString path = sheetInstances[i].m_Path.AsString();
 
 m_out->Print( aNestLevel + 3, "(path %s (page %s))\n",
 m_out->Quotew( path ).c_str(),
 m_out->Quotew( sheetInstances[i].m_PageNumber ).c_str() );
 
 if( project_open && ( ( i + 1 == sheetInstances.size() )
 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
 {
 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
 project_open = false;
 }
 }
 
 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances` token.
 }
 
 m_out->Print( aNestLevel, ")\n" ); // Closes sheet token.
}

References KIGFX::COLOR4D::a, KIID::AsString(), KIGFX::COLOR4D::b, EscapedUTF8(), FIELDS_AUTOPLACED_NO, STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), KIGFX::COLOR4D::g, SCH_SHEET::GetBackgroundColor(), SCH_SHEET::GetBorderColor(), SCH_SHEET::GetBorderWidth(), SCH_SHEET::GetFields(), SCH_ITEM::GetFieldsAutoplaced(), SCH_SHEET::GetInstances(), SCH_SHEET::GetPins(), SCH_SHEET::GetPosition(), PROJECT::GetProjectName(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), getSheetPinAngle(), getSheetPinShapeToken(), SCHEMATIC::GetSheets(), SCH_SHEET::GetSize(), KiROUND(), m_nextFreeFieldId, m_out, m_schematic, EDA_ITEM::m_Uuid, path, pin, OUTPUTFORMATTER::Print(), SCHEMATIC::Prj(), OUTPUTFORMATTER::Quotew(), KIGFX::COLOR4D::r, SCHEMATIC::Root(), saveField(), schIUScale, STROKE_PARAMS::SetWidth(), SHEET_MANDATORY_FIELDS, SOLID, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SaveSymbol()

void SCH_SEXPR_PLUGIN::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_SYMBOL by the same name already exists or there are any conflicting alias names, the new LIB_SYMBOL will silently overwrite any existing aliases and/or part because libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbol	is what to store in the library. The library is refreshed and the caller must update any LIB_SYMBOL pointers that may have changed.
aProperties	is an associative array that can be used to tell the saver how to save the symbol, 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 SCH_PLUGIN.

Definition at line 1497 of file sch_sexpr_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 cacheLib( aLibraryPath, aProperties );
 
 m_cache->AddSymbol( aSymbol );
 
 if( !isBuffering( aProperties ) )
 m_cache->Save();
}

References SCH_LIB_PLUGIN_CACHE::AddSymbol(), cacheLib(), isBuffering(), m_cache, and SCH_SEXPR_PLUGIN_CACHE::Save().

saveSymbol()

void SCH_SEXPR_PLUGIN::saveSymbol ( SCH_SYMBOL *  aSymbol, const SCHEMATIC &  aSchematic, int  aNestLevel, bool  aForClipboard  )

private

Definition at line 645 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aSymbol != nullptr && m_out != nullptr, "" );
 
 // Sort symbol instance data to minimize file churn.
 aSymbol->SortInstances( SortSymbolInstancesByProjectUuid );
 
 std::string libName;
 
 wxString symbol_name = aSymbol->GetLibId().Format();
 
 if( symbol_name.size() )
 {
 libName = toUTFTildaText( symbol_name );
 }
 else
 {
 libName = "_NONAME_";
 }
 
 EDA_ANGLE angle;
 int orientation = aSymbol->GetOrientation() & ~( SYM_MIRROR_X | SYM_MIRROR_Y );
 
 if( orientation == SYM_ORIENT_90 )
 angle = ANGLE_90;
 else if( orientation == SYM_ORIENT_180 )
 angle = ANGLE_180;
 else if( orientation == SYM_ORIENT_270 )
 angle = ANGLE_270;
 else
 angle = ANGLE_0;
 
 m_out->Print( aNestLevel, "(symbol" );
 
 if( !aSymbol->UseLibIdLookup() )
 {
 m_out->Print( 0, " (lib_name %s)",
 m_out->Quotew( aSymbol->GetSchSymbolLibraryName() ).c_str() );
 }
 
 m_out->Print( 0, " (lib_id %s) (at %s %s %s)",
 m_out->Quotew( aSymbol->GetLibId().Format().wx_str() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSymbol->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aSymbol->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
 
 bool mirrorX = aSymbol->GetOrientation() & SYM_MIRROR_X;
 bool mirrorY = aSymbol->GetOrientation() & SYM_MIRROR_Y;
 
 if( mirrorX || mirrorY )
 {
 m_out->Print( 0, " (mirror" );
 
 if( mirrorX )
 m_out->Print( 0, " x" );
 
 if( mirrorY )
 m_out->Print( 0, " y" );
 
 m_out->Print( 0, ")" );
 }
 
 // The symbol unit is always set to the first instance regardless of the current sheet
 // instance to prevent file churn.
 int unit = ( aSymbol->GetInstanceReferences().size() == 0 ) ?
 aSymbol->GetUnit() :
 aSymbol->GetInstanceReferences()[0].m_Unit;
 
  m_out->Print( 0, " (unit %d)", unit );
 
 if( aSymbol->GetConvert() == LIB_ITEM::LIB_CONVERT::DEMORGAN )
 m_out->Print( 0, " (convert %d)", aSymbol->GetConvert() );
 
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(in_bom %s)", ( aSymbol->GetIncludeInBom() ) ? "yes" : "no" );
 m_out->Print( 0, " (on_board %s)", ( aSymbol->GetIncludeOnBoard() ) ? "yes" : "no" );
 m_out->Print( 0, " (dnp %s)", ( aSymbol->GetDNP() ) ? "yes" : "no" );
 
 if( aSymbol->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
 m_out->Print( 0, " (fields_autoplaced)" );
 
 m_out->Print( 0, "\n" );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aSymbol->m_Uuid.AsString() ) );
 
 m_nextFreeFieldId = MANDATORY_FIELDS;
 
 for( SCH_FIELD& field : aSymbol->GetFields() )
 {
 int id = field.GetId();
 wxString value = field.GetText();
 
 if( !aForClipboard && aSymbol->GetInstanceReferences().size() )
 {
 // The instance fields are always set to the default instance regardless of the
 // sheet instance to prevent file churn.
 if( id == REFERENCE_FIELD )
 {
 field.SetText( aSymbol->GetInstanceReferences()[0].m_Reference );
 }
 else if( id == VALUE_FIELD )
 {
 field.SetText( aSymbol->GetValueFieldText( false ) );
 }
 else if( id == FOOTPRINT_FIELD )
 {
 field.SetText( aSymbol->GetFootprintFieldText( false ) );
 }
 }
 
 try
 {
 saveField( &field, aNestLevel + 1 );
 }
 catch( ... )
 {
 // Restore the changed field text on write error.
 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
 field.SetText( value );
 
 throw;
 }
 
 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
 field.SetText( value );
 }
 
 for( const std::unique_ptr<SCH_PIN>& pin : aSymbol->GetRawPins() )
 {
 if( pin->GetAlt().IsEmpty() )
 {
 m_out->Print( aNestLevel + 1, "(pin %s (uuid %s))\n",
 m_out->Quotew( pin->GetNumber() ).c_str(),
 TO_UTF8( pin->m_Uuid.AsString() ) );
 }
 else
 {
 m_out->Print( aNestLevel + 1, "(pin %s (uuid %s) (alternate %s))\n",
 m_out->Quotew( pin->GetNumber() ).c_str(),
 TO_UTF8( pin->m_Uuid.AsString() ),
 m_out->Quotew( pin->GetAlt() ).c_str() );
 }
 }
 
 if( !aSymbol->GetInstanceReferences().empty() )
 {
 m_out->Print( aNestLevel + 1, "(instances\n" );
 
 KIID lastProjectUuid;
 KIID rootSheetUuid = aSchematic.Root().m_Uuid;
 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
 bool project_open = false;
 
 for( size_t i = 0; i < aSymbol->GetInstanceReferences().size(); i++ )
 {
 // If the instance data is part of this design but no longer has an associated sheet
 // path, don't save it. This prevents large amounts of orphaned instance data for the
 // current project from accumulating in the schematic files.
 //
 // Keep all instance data when copying to the clipboard. It may be needed on paste.
 if( !aForClipboard
 && ( aSymbol->GetInstanceReferences()[i].m_Path[0] == rootSheetUuid )
 && !fullHierarchy.GetSheetPathByKIIDPath( aSymbol->GetInstanceReferences()[i].m_Path ) )
 {
 if( project_open && ( ( i + 1 == aSymbol->GetInstanceReferences().size() )
 || lastProjectUuid != aSymbol->GetInstanceReferences()[i+1].m_Path[0] ) )
 {
 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
 project_open = false;
 }
 
 continue;
 }
 
 if( lastProjectUuid != aSymbol->GetInstanceReferences()[i].m_Path[0] )
 {
 wxString projectName;
 
 if( aSymbol->GetInstanceReferences()[i].m_Path[0] == rootSheetUuid )
 projectName = aSchematic.Prj().GetProjectName();
 else
 projectName = aSymbol->GetInstanceReferences()[i].m_ProjectName;
 
 lastProjectUuid = aSymbol->GetInstanceReferences()[i].m_Path[0];
 m_out->Print( aNestLevel + 2, "(project %s\n",
 m_out->Quotew( projectName ).c_str() );
 project_open = true;
 }
 
 wxString path = aSymbol->GetInstanceReferences()[i].m_Path.AsString();
 
 m_out->Print( aNestLevel + 3, "(path %s\n",
 m_out->Quotew( path ).c_str() );
 m_out->Print( aNestLevel + 4, "(reference %s) (unit %d)\n",
 m_out->Quotew( aSymbol->GetInstanceReferences()[i].m_Reference ).c_str(),
 aSymbol->GetInstanceReferences()[i].m_Unit );
 m_out->Print( aNestLevel + 3, ")\n" );
 
 if( project_open && ( ( i + 1 == aSymbol->GetInstanceReferences().size() )
 || lastProjectUuid != aSymbol->GetInstanceReferences()[i+1].m_Path[0] ) )
 {
 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
 project_open = false;
 }
 }
 
 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances`.
 }
 
 m_out->Print( aNestLevel, ")\n" ); // Closes `symbol`.
}

References PNS::angle(), ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, KIID::AsString(), FIELDS_AUTOPLACED_NO, FOOTPRINT_FIELD, LIB_ID::Format(), EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_SYMBOL::GetConvert(), SCH_SYMBOL::GetDNP(), SCH_SYMBOL::GetFields(), SCH_ITEM::GetFieldsAutoplaced(), SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetIncludeInBom(), SCH_SYMBOL::GetIncludeOnBoard(), SCH_SYMBOL::GetInstanceReferences(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPosition(), PROJECT::GetProjectName(), SCH_SYMBOL::GetRawPins(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::GetSheets(), SCH_SYMBOL::GetUnit(), SCH_SYMBOL::GetValueFieldText(), m_nextFreeFieldId, m_out, EDA_ITEM::m_Uuid, MANDATORY_FIELDS, path, pin, OUTPUTFORMATTER::Print(), SCHEMATIC::Prj(), OUTPUTFORMATTER::Quotew(), REFERENCE_FIELD, SCHEMATIC::Root(), saveField(), schIUScale, SCH_SYMBOL::SortInstances(), SortSymbolInstancesByProjectUuid(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, TO_UTF8, toUTFTildaText(), SCH_SYMBOL::UseLibIdLookup(), VALUE_FIELD, UTF8::wx_str(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveText()

void SCH_SEXPR_PLUGIN::saveText ( SCH_TEXT *  aText, int  aNestLevel  )

private

Definition at line 1251 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aText != nullptr && m_out != nullptr, "" );
 
 // Note: label is nullptr SCH_TEXT, but not for SCH_LABEL_XXX,
 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aText );
 
 m_out->Print( aNestLevel, "(%s %s",
 getTextTypeToken( aText->Type() ),
 m_out->Quotew( aText->GetText() ).c_str() );
 
 if( aText->Type() == SCH_DIRECTIVE_LABEL_T )
 {
 SCH_DIRECTIVE_LABEL* flag = static_cast<SCH_DIRECTIVE_LABEL*>( aText );
 
 m_out->Print( 0, " (length %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 flag->GetPinLength() ).c_str() );
 }
 
 EDA_ANGLE angle = aText->GetTextAngle();
 
 if( label )
 {
 if( aText->Type() == SCH_GLOBAL_LABEL_T
 || aText->Type() == SCH_HIER_LABEL_T
 || aText->Type() == SCH_DIRECTIVE_LABEL_T )
 {
 m_out->Print( 0, " (shape %s)", getSheetPinShapeToken( label->GetShape() ) );
 }
 
 // The angle of the text is always 0 or 90 degrees for readibility reasons,
 // but the item itself can have more rotation (-90 and 180 deg)
 switch( aText->GetTextSpinStyle() )
 {
 default:
 case TEXT_SPIN_STYLE::LEFT: angle += ANGLE_180; break;
 case TEXT_SPIN_STYLE::UP: break;
 case TEXT_SPIN_STYLE::RIGHT: break;
 case TEXT_SPIN_STYLE::BOTTOM: angle += ANGLE_180; break;
 }
 }
 
 if( aText->GetText().Length() < 50 )
 {
 m_out->Print( 0, " (at %s %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aText->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aText->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
 }
 else
 {
 m_out->Print( 0, "\n" );
 m_out->Print( aNestLevel + 1, "(at %s %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aText->GetPosition().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
 aText->GetPosition().y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
 }
 
 if( aText->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
 m_out->Print( 0, " (fields_autoplaced)" );
 
 m_out->Print( 0, "\n" );
 aText->EDA_TEXT::Format( m_out, aNestLevel, 0 );
 
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aText->m_Uuid.AsString() ) );
 
 if( label )
 {
 for( SCH_FIELD& field : label->GetFields() )
 saveField( &field, aNestLevel + 1 );
 }
 
 m_out->Print( aNestLevel, ")\n" ); // Closes text token.
}

References PNS::angle(), ANGLE_180, KIID::AsString(), TEXT_SPIN_STYLE::BOTTOM, FIELDS_AUTOPLACED_NO, flag, EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_LABEL_BASE::GetFields(), SCH_ITEM::GetFieldsAutoplaced(), SCH_TEXT::GetPosition(), SCH_LABEL_BASE::GetShape(), getSheetPinShapeToken(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), SCH_TEXT::GetTextSpinStyle(), getTextTypeToken(), TEXT_SPIN_STYLE::LEFT, m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), TEXT_SPIN_STYLE::RIGHT, saveField(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, schIUScale, TO_UTF8, EDA_ITEM::Type(), TEXT_SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveTextBox()

void SCH_SEXPR_PLUGIN::saveTextBox ( SCH_TEXTBOX *  aText, int  aNestLevel  )

private

Definition at line 1332 of file sch_sexpr_plugin.cpp.

{
 wxCHECK_RET( aTextBox != nullptr && m_out != nullptr, "" );
 
 m_out->Print( aNestLevel, "(text_box %s\n",
 m_out->Quotew( aTextBox->GetText() ).c_str() );
 
 VECTOR2I pos = aTextBox->GetStart();
 VECTOR2I size = aTextBox->GetEnd() - pos;
 
 m_out->Print( aNestLevel + 1, "(at %s %s %s) (size %s %s)\n",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pos.x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pos.y ).c_str(),
 EDA_UNIT_UTILS::FormatAngle( aTextBox->GetTextAngle() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, size.x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, size.y ).c_str() );
 
 aTextBox->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
 m_out->Print( 0, "\n" );
 formatFill( m_out, aNestLevel + 1, aTextBox->GetFillMode(), aTextBox->GetFillColor() );
 m_out->Print( 0, "\n" );
 
 aTextBox->EDA_TEXT::Format( m_out, aNestLevel, 0 );
 
 if( aTextBox->m_Uuid != niluuid )
 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aTextBox->m_Uuid.AsString() ) );
 
 m_out->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetStart(), SCH_SHAPE::GetStroke(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), m_out, EDA_ITEM::m_Uuid, niluuid, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), schIUScale, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SetLibTable()

virtual void SCH_PLUGIN::SetLibTable ( SYMBOL_LIB_TABLE *  aTable )

inlinevirtualinherited

Some library plugins need to have access to their parent library table.

Parameters

aTable

is the table this plugin is registered within.

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 515 of file sch_io_mgr.h.

{}

Referenced by SYMBOL_LIB_TABLE::FindRow(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and SYMBOL_LIB_TABLE_ROW::Refresh().

SetProgressReporter()

void SCH_SEXPR_PLUGIN::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlineoverridevirtual

Set an optional progress reporter.

Reimplemented from SCH_PLUGIN.

Definition at line 84 of file sch_sexpr_plugin.h.

 {
 m_progressReporter = aReporter;
 }

References m_progressReporter.

SetReporter()

virtual void SCH_PLUGIN::SetReporter ( REPORTER *  aReporter )

inlinevirtualinherited

Set an optional reporter for warnings/errors.

Reimplemented in SCH_ALTIUM_PLUGIN, CADSTAR_SCH_ARCHIVE_PLUGIN, and SCH_EAGLE_PLUGIN.

Definition at line 168 of file sch_io_mgr.h.

{}

Referenced by SCH_EDIT_FRAME::importFile().

SupportsSubLibraries()

virtual bool SCH_PLUGIN::SupportsSubLibraries ( ) const

inlinevirtualinherited

Returns

true if this plugin supports libraries that contain sub-libraries.

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 449 of file sch_io_mgr.h.

{ return false; }

Referenced by SYMBOL_LIB_TABLE_ROW::SupportsSubLibraries().

SymbolLibOptions()

void SCH_PLUGIN::SymbolLibOptions ( STRING_UTF8_MAP *  aListToAppendTo ) const

virtualinherited

Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_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 Symbol*() functions in all derived SCH_PLUGINs.) Note that 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_SCH_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 SCH_PLUGIN, which has been avoided to date.

Definition at line 133 of file sch_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 Symbol*() functions in this SCH_PLUGIN."
 ) );
 
 (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
 "Regular expression <b>symbol 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 SCH_PLUGIN::Footprint*() adapter, move it to the adapter
 // if and when implemented.
 (*aListToAppendTo)["python_symbol_plugin"] = UTF8( _(
 "Enter the python symbol which implements the SCH_PLUGIN::Symbol*() functions."
 ) );
#endif
}

References _.

Member Data Documentation

m_appending

bool SCH_SEXPR_PLUGIN::m_appending

protected

Schematic load append status.

Definition at line 169 of file sch_sexpr_plugin.h.

Referenced by init(), Load(), and loadFile().

m_cache

SCH_SEXPR_PLUGIN_CACHE* SCH_SEXPR_PLUGIN::m_cache

protected

Definition at line 180 of file sch_sexpr_plugin.h.

Referenced by cacheLib(), CreateSymbolLib(), DeleteSymbol(), DeleteSymbolLib(), EnumerateSymbolLib(), GetAvailableSymbolFields(), GetModifyHash(), init(), LoadSymbol(), SaveLibrary(), SaveSymbol(), and ~SCH_SEXPR_PLUGIN().

m_currentPath

std::stack<wxString> SCH_SEXPR_PLUGIN::m_currentPath

protected

Stack to maintain nested sheet paths.

Definition at line 175 of file sch_sexpr_plugin.h.

Referenced by Load(), and loadHierarchy().

m_currentSheetPath

SCH_SHEET_PATH SCH_SEXPR_PLUGIN::m_currentSheetPath

protected

Definition at line 177 of file sch_sexpr_plugin.h.

Referenced by loadHierarchy().

m_error

wxString SCH_SEXPR_PLUGIN::m_error

protected

For throwing exceptions or errors on partial loads.

Definition at line 170 of file sch_sexpr_plugin.h.

Referenced by GetError(), and loadHierarchy().

m_nextFreeFieldId

int SCH_SEXPR_PLUGIN::m_nextFreeFieldId

protected

Definition at line 168 of file sch_sexpr_plugin.h.

Referenced by init(), saveField(), saveSheet(), and saveSymbol().

m_out

OUTPUTFORMATTER* SCH_SEXPR_PLUGIN::m_out

protected

The formatter for saving SCH_SCREEN objects.

Definition at line 179 of file sch_sexpr_plugin.h.

Referenced by Format(), init(), Save(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveField(), saveInstances(), saveJunction(), saveLine(), saveNoConnect(), saveShape(), saveSheet(), saveSymbol(), saveText(), and saveTextBox().

m_path

wxString SCH_SEXPR_PLUGIN::m_path

protected

Root project path for loading child sheets.

Definition at line 174 of file sch_sexpr_plugin.h.

Referenced by Load().

m_progressReporter

PROGRESS_REPORTER* SCH_SEXPR_PLUGIN::m_progressReporter

protected

Definition at line 172 of file sch_sexpr_plugin.h.

Referenced by loadFile(), and SetProgressReporter().

m_rootSheet

SCH_SHEET* SCH_SEXPR_PLUGIN::m_rootSheet

protected

The root sheet of the schematic being loaded.

Definition at line 176 of file sch_sexpr_plugin.h.

Referenced by init(), Load(), loadFile(), and loadHierarchy().

m_schematic

SCHEMATIC* SCH_SEXPR_PLUGIN::m_schematic

protected

Definition at line 178 of file sch_sexpr_plugin.h.

Referenced by Format(), init(), loadHierarchy(), and saveSheet().

m_version

int SCH_SEXPR_PLUGIN::m_version

protected

Version of file being loaded.

Definition at line 167 of file sch_sexpr_plugin.h.

Referenced by init().

PropBuffering

const char * SCH_SEXPR_PLUGIN::PropBuffering = "buffering"

static

The property used internally by the plugin to enable cache buffering which prevents the library file from being written every time the cache is changed.

This is useful when writing the schematic cache library file or saving a library to a new file name.

Definition at line 94 of file sch_sexpr_plugin.h.

Referenced by isBuffering().

---

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

• sch_sexpr_plugin.h
• sch_sexpr_plugin.cpp