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() )
142 if( !row || row->
SchLibType() == SCH_IO_MGR::SCH_DATABASE )
164 msg.Printf(
_(
"Library '%s' not found in the Symbol Library Table." ), aLibrary );
173 SCH_IO_MGR::SCH_FILE_T aFileType )
175 wxCHECK( aFileType != SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY,
false );
177 wxString::Format(
"Library missing: %s", aLibrary ) );
179 wxFileName fn( aFileName );
180 wxCHECK( !fn.FileExists() || fn.IsFileWritable(),
false );
184 std::map<std::string, UTF8> properties;
188 auto it =
m_libs.find( aLibrary );
195 const auto& symbolBuffers = libBuf.
GetBuffers();
197 for(
const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : symbolBuffers )
199 wxCHECK2( symbolBuf,
continue );
200 if( !libBuf.
SaveBuffer( *symbolBuf, aFileName, &*pi,
true ) )
208 wxFileName original, destination( aFileName );
219 if(
res && original == destination )
231 if( symbol->IsAlias() )
233 std::shared_ptr< LIB_SYMBOL > oldParent = symbol->
GetParent().lock();
235 wxCHECK_MSG( oldParent,
false,
236 wxString::Format( wxT(
"Derived symbol '%s' found with "
237 "undefined parent." ),
238 symbol->GetName() ) );
240 LIB_SYMBOL* libParent = pi->LoadSymbol( aLibrary, oldParent->GetName(),
245 libParent =
new LIB_SYMBOL( *oldParent.get() );
246 pi->SaveSymbol( aLibrary, libParent, &properties );
251 pi->SaveSymbol( aLibrary, newSymbol, &properties );
253 else if( !pi->LoadSymbol( aLibrary, symbol->GetName(), &properties ) )
255 pi->SaveSymbol( aLibrary,
new LIB_SYMBOL( *symbol ), &properties );
268 pi->SaveLibrary( aFileName );
283 auto it =
m_libs.find( aLibrary );
284 return it !=
m_libs.end() ? it->second.IsModified() :
false;
289 const wxString& aLibrary )
const
291 auto libIt =
m_libs.find( aLibrary );
293 if( libIt ==
m_libs.end() )
297 const std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
299 return symbolBuf ? symbolBuf->IsModified() :
false;
305 auto libIt =
m_libs.find( aLibrary );
307 if( libIt ==
m_libs.end() )
311 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
313 wxCHECK( symbolBuf, );
315 symbolBuf->GetScreen()->SetContentModified();
321 auto libIt =
m_libs.find( aLibrary );
323 if( libIt ==
m_libs.end() )
326 for(
auto& symbolBuf : libIt->second.GetBuffers() )
339 const wxString& aLibrary )
const
341 auto libIt =
m_libs.find( aLibrary );
343 if( libIt ==
m_libs.end() )
346 auto symbolBuf = libIt->second.GetBuffer( aAlias );
347 wxCHECK( symbolBuf,
false );
349 symbolBuf->GetScreen()->SetContentModified(
false );
357 wxString::Format(
"Library missing: %s", aLibrary ) );
366 wxString::Format(
"Library missing: %s", aLibrary ) );
374 std::list<LIB_SYMBOL*> ret;
376 wxString::Format(
"Library missing: %s", aLibrary ) );
378 auto libIt =
m_libs.find( aLibrary );
380 if( libIt !=
m_libs.end() )
382 for(
const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : libIt->second.GetBuffers() )
383 ret.push_back( &symbolBuf->GetSymbol() );
387 std::vector<LIB_SYMBOL*> aliases;
398 std::copy( aliases.begin(), aliases.end(), std::back_inserter( ret ) );
406 const wxString& aLibrary )
409 wxString::Format(
"Library missing: %s, for alias %s", aLibrary, aAlias ) );
415 if( !bufferedSymbol )
422 if( symbol ==
nullptr )
430 std::shared_ptr<LIB_SYMBOL> parent = symbol->
GetParent().lock();
431 wxCHECK_MSG( parent,
nullptr,
432 wxString::Format(
"Derived symbol '%s' found with undefined parent.",
436 bufferedParent = libBuf.
GetSymbol( parent->GetName() );
438 if( !bufferedParent )
440 auto newParent = std::make_unique<LIB_SYMBOL>( *parent.get() );
441 bufferedParent = newParent.get();
442 libBuf.
CreateBuffer( std::move( newParent ), std::make_unique<SCH_SCREEN>() );
446 auto newSymbol = std::make_unique<LIB_SYMBOL>( *symbol );
447 bufferedSymbol = newSymbol.get();
452 libBuf.
CreateBuffer( std::move( newSymbol ), std::make_unique<SCH_SCREEN>() );
458 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ), aAlias, aLibrary );
460 bufferedSymbol =
nullptr;
464 return bufferedSymbol;
471 wxString::Format(
"Library missing: %s, for alias %s", aLibrary, aAlias ) );
472 wxCHECK_MSG( !aAlias.IsEmpty(),
nullptr,
473 wxString::Format(
"Alias missing in library: %s", aLibrary ) );
474 auto it =
m_libs.find( aLibrary );
475 wxCHECK( it !=
m_libs.end(),
nullptr );
478 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = buf.
GetBuffer( aAlias );
480 return symbolBuf ? symbolBuf->GetScreen() :
nullptr;
486 wxCHECK_MSG( aSymbol,
false, wxString::Format(
"Null symbol in library: %s", aLibrary ) );
488 wxString::Format(
"Library missing: %s, for smybol %s", aLibrary,
492 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aSymbol->
GetName() );
496 LIB_SYMBOL& bufferedSymbol = symbolBuf->GetSymbol();
500 bufferedSymbol = *aSymbol;
503 symbolBuf->GetScreen()->SetContentModified();
507 auto symbolCopy = std::make_unique<LIB_SYMBOL>( *aSymbol,
nullptr );
511 auto newScreen = std::make_unique<SCH_SCREEN>();
513 libBuf.
CreateBuffer( std::move( symbolCopy ), std::move( newScreen ) );
522 const wxString& aLibrary )
525 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aOldName );
527 wxCHECK( symbolBuf && aSymbol,
false );
538 auto it =
m_libs.find( aLibrary );
541 return LIB_ID( aLibrary, aAlias );
543 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = it->second.GetBuffer( aAlias );
544 wxCHECK( symbolBuf,
LIB_ID( aLibrary, aAlias ) );
545 LIB_SYMBOL original( symbolBuf->GetOriginal() );
547 if( original.
GetName() != aAlias )
554 symbolBuf->GetSymbol() = original;
564 auto it =
m_libs.find( aLibrary );
584 for(
const auto& lib :
m_libs )
586 if( !lib.second.IsModified() )
589 for(
const std::shared_ptr<SYMBOL_BUFFER>& buffer : lib.second.GetBuffers() )
591 if( !buffer->IsModified() )
594 RevertSymbol( lib.first, buffer->GetOriginal().GetName() );
605 std::shared_ptr<SYMBOL_BUFFER> symbolBuf = libBuf.
GetBuffer( aAlias );
606 wxCHECK( symbolBuf,
false );
618 const wxString& aLibrary )
const
621 auto libIt =
m_libs.find( aLibrary );
623 if( libIt !=
m_libs.end() )
625 LIB_SYMBOL* symbol = libIt->second.GetSymbol( aAlias );
642 msg.Printf(
_(
"Cannot load symbol '%s' from library '%s'." ), aAlias, aLibrary );
652 auto libBufIt =
m_libs.find( aLibrary );
655 if( libBufIt !=
m_libs.end() )
656 return !!libBufIt->second.GetBuffer( aAlias );
667 return alias !=
nullptr;
673 if( aLibrary.IsEmpty() )
676 if(
m_libs.count( aLibrary ) > 0 )
685 wxString
name =
"New_Library";
692 for(
unsigned int i = 0; i < std::numeric_limits<unsigned int>::max(); ++i )
695 return name + wxString::Format(
"%u", i );
699 return wxEmptyString;
704 wxArrayString& aSymbolNames,
714 const wxString& aLibraryName )
730 wxFileName fn( aFilePath );
746 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
747 schFileType = SCH_IO_MGR::SCH_LEGACY;
755 wxCHECK( schFileType != SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY,
false );
782 std::set<LIB_SYMBOL*> symbols;
787 wxArrayString aliases;
790 for(
const auto& aliasName : aliases )
793 symbols.insert( alias );
800 msg.Printf(
_(
"Cannot enumerate library '%s'." ), aLibrary );
810 auto it =
m_libs.find( aLibrary );
821 if( symbol->IsAlias() )
823 std::shared_ptr<LIB_SYMBOL> oldParent = symbol->GetParent().lock();
825 wxCHECK_MSG( oldParent, buf,
826 wxString::Format(
"Derived symbol '%s' found with undefined parent.",
827 symbol->GetName() ) );
833 auto newParent = std::make_unique<LIB_SYMBOL>( *oldParent.get() );
834 libParent = newParent.get();
835 buf.
CreateBuffer( std::move( newParent ), std::make_unique<SCH_SCREEN>() );
838 auto newSymbol = std::make_unique<LIB_SYMBOL>( *symbol );
839 newSymbol->SetParent( libParent );
840 buf.
CreateBuffer( std::move( newSymbol ), std::make_unique<SCH_SCREEN>() );
842 else if( !buf.
GetSymbol( symbol->GetName() ) )
844 buf.
CreateBuffer( std::make_unique<LIB_SYMBOL>( *symbol ),
845 std::make_unique<SCH_SCREEN>() );
860 catch(
const std::exception& e)
862 wxLogError(
_(
"Error updating library buffer: %s" ), e.what() );
867 wxLogError(
_(
"Error updating library buffer: %s" ), e.What() );
872 wxLogError(
_(
"Error updating library buffer." ) );
883 std::unique_ptr<SCH_SCREEN> aScreen ) :
884 m_screen(
std::
move( aScreen ) ), m_symbol(
std::
move( aSymbol ) )
904 if(
m_original->GetLibId().GetLibNickname() !=
m_symbol->GetLibId().GetLibNickname() )
919 if(
m_original->GetLibId().GetLibNickname() !=
m_symbol->GetLibId().GetLibNickname() )
946 std::unique_ptr<SCH_SCREEN> aScreen )
949 wxASSERT( aCopy->GetLib() ==
nullptr );
953 LIB_ID libId = aCopy->GetLibId();
955 aCopy->SetLibId( libId );
957 auto symbolBuf = std::make_shared<SYMBOL_BUFFER>( std::move( aCopy ), std::move( aScreen ) );
970 bufferedSymbol = aCopy;
979 const auto sameBufferPredicate = [&](
const std::shared_ptr<SYMBOL_BUFFER>& aBuf )
981 return aBuf.get() == &aSymbolBuf;
984 auto symbolBufIt = std::find_if(
m_symbols.begin(),
m_symbols.end(), sameBufferPredicate );
985 wxCHECK( symbolBufIt !=
m_symbols.end(),
false );
1007 wxCHECK( !aFileName.IsEmpty(),
false );
1009 wxString errorMsg =
_(
"Error saving symbol %s to library '%s'." ) + wxS(
"\n%s" );
1012 std::map<std::string, UTF8> properties;
1019 const wxString originalName = originalSymbol.
GetName();
1026 if( aPlugin->
LoadSymbol( aFileName, originalName ) )
1027 aPlugin->
DeleteSymbol( aFileName, originalName, &properties );
1042 std::shared_ptr<LIB_SYMBOL> bufferedParent = libSymbol.
GetParent().lock();
1043 parentSymbol = newCachedSymbol;
1045 wxCHECK( bufferedParent,
false );
1051 cachedParent = aPlugin->
LoadSymbol( aFileName, bufferedParent->GetName() );
1060 cachedParent =
new LIB_SYMBOL( *bufferedParent.get() );
1061 newCachedSymbol->
SetParent( cachedParent );
1065 aPlugin->
SaveSymbol( aFileName, cachedParent, aBuffer ? &properties :
nullptr );
1076 aPlugin->
SaveSymbol( aFileName, newCachedSymbol, aBuffer ? &properties :
nullptr );
1085 auto originalParent = std::make_unique<LIB_SYMBOL>( *bufferedParent.get() );
1087 aSymbolBuf.
SetOriginal( std::move( originalParent ) );
1089 auto newSymbol = std::make_unique<LIB_SYMBOL>( libSymbol );
1090 newSymbol->SetParent( &parentRef );
1095 newCachedSymbol->
SetParent( cachedParent );
1099 aPlugin->
SaveSymbol( aFileName, newCachedSymbol, aBuffer ? &properties :
nullptr );
1108 auto originalBufferedParent =
GetBuffer( bufferedParent->GetName() );
1109 wxCHECK( originalBufferedParent,
false );
1111 auto newSymbol = std::make_unique<LIB_SYMBOL>( libSymbol );
1112 newSymbol->SetParent( &originalBufferedParent->GetSymbol() );
1122 aPlugin->
SaveSymbol( aFileName, parentSymbol, aBuffer ? &properties :
nullptr );
1130 aSymbolBuf.
SetOriginal( std::make_unique<LIB_SYMBOL>( libSymbol ) );
1133 wxArrayString derivedSymbols;
1139 for(
const wxString& entry : derivedSymbols )
1141 std::shared_ptr<SYMBOL_BUFFER> symbol =
GetBuffer( entry );
1143 wxCHECK2( symbol,
continue );
1146 derivedSymbol->
SetParent( parentSymbol );
1151 aBuffer ? &properties :
nullptr );
1169 for( std::shared_ptr<SYMBOL_BUFFER> entry :
m_symbols )
1171 if( entry->GetSymbol().GetName() == aAlias )
1175 return std::shared_ptr<SYMBOL_BUFFER>(
nullptr );
1181 for(
const std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1183 if( entry->GetSymbol().IsAlias() )
1188 wxCHECK( parent,
false );
1190 if( parent->GetName() == aParentName )
1201 for( std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1203 const LIB_SYMBOL& symbol = entry->GetSymbol();
1204 if( ( symbol.
IsAlias() && ( aFilter == SYMBOL_NAME_FILTER::ROOT_ONLY ) )
1205 || ( symbol.
IsRoot() && ( aFilter == SYMBOL_NAME_FILTER::DERIVED_ONLY ) ) )
1216 wxCHECK( !aSymbolName.IsEmpty(), 0 );
1218 for( std::shared_ptr<SYMBOL_BUFFER>& entry :
m_symbols )
1220 const LIB_SYMBOL& symbol = entry->GetSymbol();
1226 wxCHECK2( parent,
continue );
1228 if( parent->GetName() == aSymbolName )
1230 aList.Add( symbol.
GetName() );
1237 return aList.GetCount();
1244 wxArrayString derivedSymbolNames;
1245 std::deque<std::shared_ptr<SYMBOL_BUFFER>>::iterator it;
1249 for(
const wxString& symbolName : derivedSymbolNames )
1252 [symbolName]( std::shared_ptr<SYMBOL_BUFFER>& buf )
1254 return buf->GetSymbol().GetName() == symbolName;
1257 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().