70 while( !loader.
Done() )
87 msg.Replace(
"\n",
"<BR>" );
99 if( buffer.IsModified() )
112 hash += buffer.GetHash();
120 const auto libBufIt =
m_libs.find( aLibrary );
122 if( libBufIt !=
m_libs.end() )
123 return libBufIt->second.GetHash();
128 return row ? std::hash<std::string>{}( aLibrary.ToStdString() +
137 for(
const wxString& libName :
symTable()->GetLogicalLibs() )
140 if(
GetLibrary( libName )->SchLibType() == SCH_IO_MGR::SCH_DATABASE )
162 msg.Printf(
_(
"Library '%s' not found in the Symbol Library Table." ), aLibrary );
171 SCH_IO_MGR::SCH_FILE_T aFileType )
173 wxCHECK( aFileType != SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY &&
LibraryExists( aLibrary ),
false );
174 wxFileName fn( aFileName );
175 wxCHECK( !fn.FileExists() || fn.IsFileWritable(),
false );
179 std::map<std::string, UTF8> properties;
183 auto it =
m_libs.find( aLibrary );
190 const auto& symbolBuffers = libBuf.
GetBuffers();
192 for(
const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : symbolBuffers )
194 wxCHECK2( symbolBuf,
continue );
195 if( !libBuf.
SaveBuffer( *symbolBuf, aFileName, &*pi,
true ) )
203 wxFileName original, destination( aFileName );
214 if(
res && original == destination )
226 if( symbol->IsAlias() )
228 std::shared_ptr< LIB_SYMBOL > oldParent = symbol->
GetParent().lock();
230 wxCHECK_MSG( oldParent,
false,
231 wxString::Format( wxT(
"Derived symbol '%s' found with "
232 "undefined parent." ),
233 symbol->GetName() ) );
235 LIB_SYMBOL* libParent = pi->LoadSymbol( aLibrary, oldParent->GetName(),
240 libParent =
new LIB_SYMBOL( *oldParent.get() );
241 pi->SaveSymbol( aLibrary, libParent, &properties );
246 pi->SaveSymbol( aLibrary, newSymbol, &properties );
248 else if( !pi->LoadSymbol( aLibrary, symbol->GetName(), &properties ) )
250 pi->SaveSymbol( aLibrary,
new LIB_SYMBOL( *symbol ), &properties );
263 pi->SaveLibrary( aFileName );
278 auto it =
m_libs.find( aLibrary );
279 return it !=
m_libs.end() ? it->second.IsModified() :
false;
284 const wxString& aLibrary )
const
286 auto libIt =
m_libs.find( aLibrary );
288 if( libIt ==
m_libs.end() )
292 const std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
294 return symbolBuf ? symbolBuf->IsModified() :
false;
300 auto libIt =
m_libs.find( aLibrary );
302 if( libIt ==
m_libs.end() )
306 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
308 wxCHECK( symbolBuf, );
310 symbolBuf->GetScreen()->SetContentModified();
316 auto libIt =
m_libs.find( aLibrary );
318 if( libIt ==
m_libs.end() )
321 for(
auto& symbolBuf : libIt->second.GetBuffers() )
334 const wxString& aLibrary )
const
336 auto libIt =
m_libs.find( aLibrary );
338 if( libIt ==
m_libs.end() )
341 auto symbolBuf = libIt->second.GetBuffer( aAlias );
342 wxCHECK( symbolBuf,
false );
344 symbolBuf->GetScreen()->SetContentModified(
false );
367 std::list<LIB_SYMBOL*> ret;
370 auto libIt =
m_libs.find( aLibrary );
372 if( libIt !=
m_libs.end() )
374 for(
const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : libIt->second.GetBuffers() )
375 ret.push_back( &symbolBuf->GetSymbol() );
379 std::vector<LIB_SYMBOL*> aliases;
390 std::copy( aliases.begin(), aliases.end(), std::back_inserter( ret ) );
398 const wxString& aLibrary )
406 if( !bufferedSymbol )
413 if( symbol ==
nullptr )
421 std::shared_ptr<LIB_SYMBOL> parent = symbol->
GetParent().lock();
422 wxCHECK_MSG( parent,
nullptr,
423 wxString::Format(
"Derived symbol '%s' found with undefined parent.",
427 bufferedParent = libBuf.
GetSymbol( parent->GetName() );
429 if( !bufferedParent )
431 auto newParent = std::make_unique<LIB_SYMBOL>( *parent.get() );
432 bufferedParent = newParent.get();
433 libBuf.
CreateBuffer( std::move( newParent ), std::make_unique<SCH_SCREEN>() );
437 auto newSymbol = std::make_unique<LIB_SYMBOL>( *symbol );
438 bufferedSymbol = newSymbol.get();
443 libBuf.
CreateBuffer( std::move( newSymbol ), std::make_unique<SCH_SCREEN>() );
449 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ), aAlias, aLibrary );
451 bufferedSymbol =
nullptr;
455 return bufferedSymbol;
462 wxCHECK( !aAlias.IsEmpty(),
nullptr );
463 auto it =
m_libs.find( aLibrary );
464 wxCHECK( it !=
m_libs.end(),
nullptr );
467 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
469 return symbolBuf ? symbolBuf->GetScreen() :
nullptr;
476 wxCHECK( aSymbol,
false );
479 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aSymbol->
GetName() );
483 LIB_SYMBOL& bufferedSymbol = symbolBuf->GetSymbol();
487 bufferedSymbol = *aSymbol;
490 symbolBuf->GetScreen()->SetContentModified();
494 auto symbolCopy = std::make_unique<LIB_SYMBOL>( *aSymbol,
nullptr );
498 auto newScreen = std::make_unique<SCH_SCREEN>();
500 libBuf.
CreateBuffer( std::move( symbolCopy ), std::move( newScreen ) );
509 const wxString& aLibrary )
512 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aOldName );
514 wxCHECK( symbolBuf && aSymbol,
false );
525 auto it =
m_libs.find( aLibrary );
528 return LIB_ID( aLibrary, aAlias );
530 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = it->second.GetBuffer( aAlias );
531 wxCHECK( symbolBuf,
LIB_ID( aLibrary, aAlias ) );
532 LIB_SYMBOL original( symbolBuf->GetOriginal() );
534 if( original.
GetName() != aAlias )
541 symbolBuf->GetSymbol() = original;
551 auto it =
m_libs.find( aLibrary );
571 for(
const auto& lib :
m_libs )
573 if( !lib.second.IsModified() )
576 for(
const std::shared_ptr<SYMBOL_BUFFER>& buffer : lib.second.GetBuffers() )
578 if( !buffer->IsModified() )
581 RevertSymbol( lib.first, buffer->GetOriginal().GetName() );
592 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aAlias );
593 wxCHECK( symbolBuf,
false );
605 const wxString& aLibrary )
const
608 auto libIt =
m_libs.find( aLibrary );
610 if( libIt !=
m_libs.end() )
612 LIB_SYMBOL* symbol = libIt->second.GetSymbol( aAlias );
629 msg.Printf(
_(
"Cannot load symbol '%s' from library '%s'." ), aAlias, aLibrary );
639 auto libBufIt =
m_libs.find( aLibrary );
642 if( libBufIt !=
m_libs.end() )
643 return !!libBufIt->second.GetBuffer( aAlias );
654 return alias !=
nullptr;
660 if( aLibrary.IsEmpty() )
663 if(
m_libs.count( aLibrary ) > 0 )
672 wxString
name =
"New_Library";
679 for(
unsigned int i = 0; i < std::numeric_limits<unsigned int>::max(); ++i )
682 return name + wxString::Format(
"%u", i );
686 return wxEmptyString;
691 wxArrayString& aSymbolNames,
701 const wxString& aLibraryName )
717 wxFileName fn( aFilePath );
733 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
734 schFileType = SCH_IO_MGR::SCH_LEGACY;
742 wxCHECK( schFileType != SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY,
false );
769 std::set<LIB_SYMBOL*> symbols;
774 wxArrayString aliases;
777 for(
const auto& aliasName : aliases )
780 symbols.insert( alias );
787 msg.Printf(
_(
"Cannot enumerate library '%s'." ), aLibrary );
797 auto it =
m_libs.find( aLibrary );
808 if( symbol->IsAlias() )
810 std::shared_ptr<LIB_SYMBOL> oldParent = symbol->GetParent().lock();
812 wxCHECK_MSG( oldParent, buf,
813 wxString::Format(
"Derived symbol '%s' found with undefined parent.",
814 symbol->GetName() ) );
820 auto newParent = std::make_unique<LIB_SYMBOL>( *oldParent.get() );
821 libParent = newParent.get();
822 buf.
CreateBuffer( std::move( newParent ), std::make_unique<SCH_SCREEN>() );
825 auto newSymbol = std::make_unique<LIB_SYMBOL>( *symbol );
826 newSymbol->SetParent( libParent );
827 buf.
CreateBuffer( std::move( newSymbol ), std::make_unique<SCH_SCREEN>() );
829 else if( !buf.
GetSymbol( symbol->GetName() ) )
831 buf.
CreateBuffer( std::make_unique<LIB_SYMBOL>( *symbol ),
832 std::make_unique<SCH_SCREEN>() );
847 catch(
const std::exception& e)
849 wxLogError(
_(
"Error updating library buffer: %s" ), e.what() );
854 wxLogError(
_(
"Error updating library buffer: %s" ), e.What() );
859 wxLogError(
_(
"Error updating library buffer." ) );
870 std::unique_ptr<SCH_SCREEN> aScreen ) :
871 m_screen(
std::
move( aScreen ) ), m_symbol(
std::
move( aSymbol ) )
891 if(
m_original->GetLibId().GetLibNickname() !=
m_symbol->GetLibId().GetLibNickname() )
906 if(
m_original->GetLibId().GetLibNickname() !=
m_symbol->GetLibId().GetLibNickname() )
933 std::unique_ptr<SCH_SCREEN> aScreen )
936 wxASSERT( aCopy->GetLib() ==
nullptr );
940 LIB_ID libId = aCopy->GetLibId();
942 aCopy->SetLibId( libId );
944 auto symbolBuf = std::make_shared<SYMBOL_BUFFER>( std::move( aCopy ), std::move( aScreen ) );
957 bufferedSymbol = aCopy;
966 const auto sameBufferPredicate = [&](
const std::shared_ptr<SYMBOL_BUFFER>& aBuf )
968 return aBuf.get() == &aSymbolBuf;
971 auto symbolBufIt = std::find_if(
m_symbols.begin(),
m_symbols.end(), sameBufferPredicate );
972 wxCHECK( symbolBufIt !=
m_symbols.end(),
false );
994 wxCHECK( !aFileName.IsEmpty(),
false );
996 wxString errorMsg =
_(
"Error saving symbol %s to library '%s'." ) + wxS(
"\n%s" );
999 std::map<std::string, UTF8> properties;
1006 const wxString originalName = originalSymbol.
GetName();
1013 if( aPlugin->
LoadSymbol( aFileName, originalName ) )
1014 aPlugin->
DeleteSymbol( aFileName, originalName, &properties );
1029 std::shared_ptr<LIB_SYMBOL> bufferedParent = libSymbol.
GetParent().lock();
1030 parentSymbol = newCachedSymbol;
1032 wxCHECK( bufferedParent,
false );
1038 cachedParent = aPlugin->
LoadSymbol( aFileName, bufferedParent->GetName() );
1047 cachedParent =
new LIB_SYMBOL( *bufferedParent.get() );
1048 newCachedSymbol->
SetParent( cachedParent );
1052 aPlugin->
SaveSymbol( aFileName, cachedParent, aBuffer ? &properties :
nullptr );
1063 aPlugin->
SaveSymbol( aFileName, newCachedSymbol, aBuffer ? &properties :
nullptr );
1072 auto originalParent = std::make_unique<LIB_SYMBOL>( *bufferedParent.get() );
1074 aSymbolBuf.
SetOriginal( std::move( originalParent ) );
1076 auto newSymbol = std::make_unique<LIB_SYMBOL>( libSymbol );
1077 newSymbol->SetParent( &parentRef );
1082 newCachedSymbol->
SetParent( cachedParent );
1086 aPlugin->
SaveSymbol( aFileName, newCachedSymbol, aBuffer ? &properties :
nullptr );
1095 auto originalBufferedParent =
GetBuffer( bufferedParent->GetName() );
1096 wxCHECK( originalBufferedParent,
false );
1098 auto newSymbol = std::make_unique<LIB_SYMBOL>( libSymbol );
1099 newSymbol->SetParent( &originalBufferedParent->GetSymbol() );
1109 aPlugin->
SaveSymbol( aFileName, parentSymbol, aBuffer ? &properties :
nullptr );
1117 aSymbolBuf.
SetOriginal( std::make_unique<LIB_SYMBOL>( libSymbol ) );
1120 wxArrayString derivedSymbols;
1126 for(
const wxString& entry : derivedSymbols )
1128 std::shared_ptr<SYMBOL_BUFFER> symbol =
GetBuffer( entry );
1130 wxCHECK2( symbol,
continue );
1133 derivedSymbol->
SetParent( parentSymbol );
1138 aBuffer ? &properties :
nullptr );
1156 for( std::shared_ptr<SYMBOL_BUFFER> entry :
m_symbols )
1158 if( entry->GetSymbol().GetName() == aAlias )
1162 return std::shared_ptr<SYMBOL_BUFFER>(
nullptr );
1168 for(
const std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1170 if( entry->GetSymbol().IsAlias() )
1175 wxCHECK( parent,
false );
1177 if( parent->GetName() == aParentName )
1188 for( std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1190 const LIB_SYMBOL& symbol = entry->GetSymbol();
1191 if( ( symbol.
IsAlias() && ( aFilter == SYMBOL_NAME_FILTER::ROOT_ONLY ) )
1192 || ( symbol.
IsRoot() && ( aFilter == SYMBOL_NAME_FILTER::DERIVED_ONLY ) ) )
1203 wxCHECK( !aSymbolName.IsEmpty(), 0 );
1205 for( std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1207 const LIB_SYMBOL& symbol = entry->GetSymbol();
1213 wxCHECK2( parent,
continue );
1215 if( parent->GetName() == aSymbolName )
1217 aList.Add( symbol.
GetName() );
1224 return aList.GetCount();
1231 wxArrayString derivedSymbolNames;
1232 std::deque<std::shared_ptr<SYMBOL_BUFFER>>::iterator it;
1236 for(
const wxString& symbolName : derivedSymbolNames )
1239 [symbolName]( std::shared_ptr<SYMBOL_BUFFER>& buf )
1241 return buf->GetSymbol().GetName() == symbolName;
1244 wxCHECK2( it !=
m_symbols.end(),
continue );
void SetContentModified(bool aModified=true)
void MessageSet(const wxString &message)
Add a message (in bold) to message list.
void AddHTML_Text(const wxString &message)
Add HTML text (without any change) to message list.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
size_t GetDerivedSymbolNames(const wxString &aSymbolName, wxArrayString &aList)
Fetch all of the symbols derived from a aSymbolName into aList.
bool CreateBuffer(std::unique_ptr< LIB_SYMBOL > aCopy, std::unique_ptr< SCH_SCREEN > aScreen)
Update the buffered symbol with the contents of aCopy.
bool DeleteBuffer(const SYMBOL_BUFFER &aSymbolBuf)
Delete the given symbol buffer from the library buffer.
void ClearDeletedBuffer()
Save stored modifications using a plugin.
void GetSymbolNames(wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)
Fetch a list of root symbols names from the library buffer.
std::deque< std::shared_ptr< SYMBOL_BUFFER > > m_symbols
std::deque< std::shared_ptr< SYMBOL_BUFFER > > m_deleted
Buffer for deleted symbols until library is saved.
bool SaveBuffer(SYMBOL_BUFFER &aSymbolBuf, const wxString &aFileName, SCH_IO *aPlugin, bool aBuffer)
Return a symbol buffer with LIB_SYMBOL holding a symbolicular alias.
const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & GetBuffers() const
std::shared_ptr< SYMBOL_BUFFER > GetBuffer(const wxString &aAlias) const
Return all buffered symbols.
LIB_SYMBOL * GetSymbol(const wxString &aAlias) const
Create a new buffer to store a symbol. LIB_BUFFER takes ownership of aCopy.
int removeChildSymbols(const SYMBOL_BUFFER &aSymbolBuf)
Remove all symbols derived from aParent from the library buffer.
bool HasDerivedSymbols(const wxString &aParentName) const
Check to see any symbols in the buffer are derived from a parent named aParentName.
bool UpdateBuffer(SYMBOL_BUFFER &aSymbolBuf, const LIB_SYMBOL &aCopy)
const wxString m_libName
Buffered library name.
A logical library item identifier and consists of various portions much like a URI.
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
const UTF8 & GetLibItemName() const
Define a library symbol object.
const LIB_ID & GetLibId() const override
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
void SetParent(LIB_SYMBOL *aParent=nullptr)
wxString GetName() const override
void SetLibId(const LIB_ID &aLibId)
LIB_SYMBOL_REF & GetParent()
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
bool RemoveRow(const LIB_TABLE_ROW *aRow)
Removes a row from the table and frees the pointer.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
A progress reporter interface for use in multi-threaded environments.
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a symbol library using the file extension of aLibPath.
Base class that schematic file and library loading and saving plugins should derive from.
virtual void SaveSymbol(const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const std::map< std::string, UTF8 > *aProperties=nullptr)
Write aSymbol to an existing library located at aLibraryPath.
virtual void DeleteSymbol(const wxString &aLibraryPath, const wxString &aSymbolName, const std::map< std::string, UTF8 > *aProperties=nullptr)
Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
virtual LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aPartName, const std::map< std::string, UTF8 > *aProperties=nullptr)
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
bool Done()
Returns a string containing any errors generated during the load.
const wxString & GetErrors() const
Represents a pair of <nickname, loaded parts list>
void Start()
Spins up threads to load all the libraries in m_nicknames.
bool Join()
Finalizes the threads and combines the output into the target output map.
Store a working copy of a library.
std::unique_ptr< LIB_SYMBOL > m_symbol
std::unique_ptr< SCH_SCREEN > m_screen
void SetSymbol(std::unique_ptr< LIB_SYMBOL > aSymbol)
LIB_SYMBOL & GetSymbol() const
SYMBOL_BUFFER(std::unique_ptr< LIB_SYMBOL > aSymbol=nullptr, std::unique_ptr< SCH_SCREEN > aScreen=nullptr)
std::unique_ptr< LIB_SYMBOL > m_original
LIB_SYMBOL & GetOriginal() const
void SetOriginal(std::unique_ptr< LIB_SYMBOL > aSymbol)
LIB_SYMBOL * GetBufferedSymbol(const wxString &aAlias, const wxString &aLibrary)
Return the symbol copy from the buffer.
bool UpdateSymbolAfterRename(LIB_SYMBOL *aSymbol, const wxString &oldAlias, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol when the name has changed.
bool IsLibraryReadOnly(const wxString &aLibrary) const
Return true if the library is stored in a read-only file.
bool ClearSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Clear the modified flag for a symbol.
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Return true if library exists.
size_t GetLibraryCount() const
bool ClearLibraryModified(const wxString &aLibrary) const
Clear the modified flag for all symbols in a library.
LIB_SYMBOL * GetAlias(const wxString &aAlias, const wxString &aLibrary) const
Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no w...
SCH_SCREEN * GetScreen(const wxString &aAlias, const wxString &aLibrary)
Return the screen used to edit a specific symbol.
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
wxArrayString GetLibraryNames() const
Return the array of library names.
void SetSymbolModified(const wxString &aAlias, const wxString &aLibrary)
bool SymbolExists(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol with a specific alias exists in library (either original one or buffered).
LIB_BUFFER & getLibraryBuffer(const wxString &aLibrary)
Return an existing library buffer or creates one to using Symbol Library Table to get the original da...
wxString GetUniqueLibraryName() const
Return a library name that is not currently in use.
bool HasModifications() const
bool RemoveSymbol(const wxString &aName, const wxString &aLibrary)
Remove the symbol from the symbol buffer.
static wxString getLibraryName(const wxString &aFilePath)
Helper function to add either existing or create new library.
virtual void OnDataChanged() const
Extract library name basing on the file name.
bool addLibrary(const wxString &aFilePath, bool aCreate, SYMBOL_LIB_TABLE &aTable)
Return the current Symbol Library Table.
bool IsSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
bool IsLibraryLoaded(const wxString &aLibrary) const
Return true if the library was successfully loaded.
SYMBOL_LIB_TABLE * symTable() const
Class to store a working copy of a LIB_SYMBOL object and editor context.
virtual ~SYMBOL_LIBRARY_MANAGER()
bool RevertLibrary(const wxString &aLibrary)
Revert unsaved changes for a symbolicular library.
void GetSymbolNames(const wxString &aLibName, wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)
std::set< LIB_SYMBOL * > getOriginalSymbols(const wxString &aLibrary)
Return a set of LIB_SYMBOL objects belonging to the original library.
int GetLibraryHash(const wxString &aLibrary) const
Return a library hash value to determine if it has changed.
void Preload(PROGRESS_REPORTER &aReporter)
Preloads all symbol libraries in the symbol library table using SYMBOL_ASYNC_LOADER.
bool RevertAll()
Revert all pending changes.
SYMBOL_LIBRARY_MANAGER(SCH_BASE_FRAME &aFrame)
LIB_ID RevertSymbol(const wxString &aAlias, const wxString &aLibrary)
Revert unsaved changes for a symbolicular symbol.
SYMBOL_LIB_TABLE_ROW * GetLibrary(const wxString &aLibrary) const
Find a single library within the (aggregate) library table.
SCH_BASE_FRAME & m_frame
Parent frame.
std::list< LIB_SYMBOL * > GetAliases(const wxString &aLibrary) const
bool UpdateSymbol(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol.
bool SaveLibrary(const wxString &aLibrary, const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFileType=SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY)
Save library to a file, including unsaved changes.
bool HasDerivedSymbols(const wxString &aSymbolName, const wxString &aLibraryName)
Check if symbol aSymbolName in library aLibraryName is a root symbol that has derived symbols.
std::map< wxString, LIB_BUFFER > m_libs
The library buffers.
bool UpdateLibraryBuffer(const wxString &aLibrary)
Update the library buffer with a new version of the library.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
void LoadSymbolLib(std::vector< LIB_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
bool IsSymbolLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
bool IsSymbolLibLoaded(const wxString &aNickname)
Return true if the library given by aNickname was successfully loaded.
void CreateSymbolLib(const wxString &aNickname)
void EnumerateSymbolLib(const wxString &aNickname, wxArrayString &aAliasNames, bool aPowerSymbolsOnly=false)
Return a list of symbol alias names contained within the library given by aNickname.
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
#define THROW_IO_ERROR(msg)
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
PGM_BASE & Pgm()
The global Program "get" accessor.
wxString UnescapeString(const wxString &aSource)
Definition for symbol library class.
#define FN_NORMALIZE_FLAGS
Default flags to pass to wxFileName::Normalize().