kicad/eeschema/symbol_editor/symbol_library_manager.h

432 lines
15 KiB
C
Raw Normal View History

2017-11-12 17:55:20 +00:00
/*
* This program source code file is symbol of KiCad, a free EDA CAD application.
2017-11-12 17:55:20 +00:00
*
* Copyright (C) 2017 CERN
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
*
2017-11-12 17:55:20 +00:00
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A SYMBOLICULAR PURPOSE. See the
2017-11-12 17:55:20 +00:00
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* https://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
2020-10-31 01:27:16 +00:00
#ifndef SYMBOL_LIBRARY_MANAGER_H
#define SYMBOL_LIBRARY_MANAGER_H
2017-11-12 17:55:20 +00:00
#include <map>
#include <list>
#include <deque>
#include <set>
#include <memory>
#include <wx/arrstr.h>
#include <symbol_tree_synchronizing_adapter.h>
#include <sch_io_mgr.h>
#include <sch_screen.h>
2017-11-12 17:55:20 +00:00
2021-06-10 18:51:46 +00:00
class LIB_SYMBOL;
class SYMBOL_LIB;
class PROGRESS_REPORTER;
class SCH_PLUGIN;
2020-10-31 01:27:16 +00:00
class SYMBOL_EDIT_FRAME;
2017-11-12 17:55:20 +00:00
class SYMBOL_LIB_TABLE;
class SYMBOL_LIB_TABLE_ROW;
class LIB_LOGGER;
2017-11-12 17:55:20 +00:00
/**
* Class to handle modifications to the symbol libraries.
*/
2020-10-31 01:27:16 +00:00
class SYMBOL_LIBRARY_MANAGER
2017-11-12 17:55:20 +00:00
{
public:
2020-10-31 01:27:16 +00:00
SYMBOL_LIBRARY_MANAGER( SYMBOL_EDIT_FRAME& aFrame );
~SYMBOL_LIBRARY_MANAGER();
2017-11-12 17:55:20 +00:00
/**
* Updates the #SYMBOL_LIBRARY_MANAGER data to synchronize with Symbol Library Table.
2017-11-12 17:55:20 +00:00
*/
void Sync( const wxString& aForceRefresh,
std::function<void( int, int, const wxString& )> aProgressCallback );
2017-11-12 17:55:20 +00:00
/**
* Preloads all symbol libraries in the symbol library table using SYMBOL_ASYNC_LOADER.
* Call before the first call to Sync() to get better performance.
* @param aReporter is used to report progress of the load
*/
void Preload( PROGRESS_REPORTER& aReporter );
2017-11-12 17:55:20 +00:00
int GetHash() const;
bool HasModifications() const;
/**
* Return a library hash value to determine if it has changed.
*
2019-07-18 23:37:04 +00:00
* For buffered libraries, it returns a number corresponding to the number of modifications.
* For original libraries, hash is computed basing on the library URI. Returns -1 when the
* requested library does not exist.
*/
2017-11-12 17:55:20 +00:00
int GetLibraryHash( const wxString& aLibrary ) const;
/**
* Return the array of library names.
2017-11-12 17:55:20 +00:00
*/
wxArrayString GetLibraryNames() const;
/**
* Find a single library within the (aggregate) library table.
*/
SYMBOL_LIB_TABLE_ROW* GetLibrary( const wxString& aLibrary ) const;
2021-06-10 18:51:46 +00:00
std::list<LIB_SYMBOL*> GetAliases( const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Create an empty library and adds it to the library table. The library file is created.
2017-11-12 17:55:20 +00:00
*/
bool CreateLibrary( const wxString& aFilePath, SYMBOL_LIB_TABLE* aTable )
2017-11-12 17:55:20 +00:00
{
return addLibrary( aFilePath, true, aTable );
2017-11-12 17:55:20 +00:00
}
/**
* Add an existing library. The library is added to the library table as well.
2017-11-12 17:55:20 +00:00
*/
bool AddLibrary( const wxString& aFilePath, SYMBOL_LIB_TABLE* aTable )
2017-11-12 17:55:20 +00:00
{
return addLibrary( aFilePath, false, aTable );
2017-11-12 17:55:20 +00:00
}
/**
* Update the symbol buffer with a new version of the symbol.
* The library buffer creates a copy of the symbol.
* It is required to save the library to use the updated symbol in the schematic editor.
2017-11-12 17:55:20 +00:00
*/
bool UpdateSymbol( LIB_SYMBOL* aSymbol, const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Update the symbol buffer with a new version of the symbol when the name has changed.
* The old library buffer will be deleted and a new one created with the new name.
*/
bool UpdateSymbolAfterRename( LIB_SYMBOL* aSymbol, const wxString& oldAlias,
const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Remove the symbol from the symbol buffer.
* It is required to save the library to have the symbol removed in the schematic editor.
2017-11-12 17:55:20 +00:00
*/
bool RemoveSymbol( const wxString& aName, const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there
2017-11-12 17:55:20 +00:00
* is no working copy.
*/
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* GetAlias( const wxString& aAlias, const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Return the symbol copy from the buffer. In case it does not exist yet, the copy is created.
* #SYMBOL_LIBRARY_MANAGER retains the ownership.
2017-11-12 17:55:20 +00:00
*/
LIB_SYMBOL* GetBufferedSymbol( const wxString& aAlias, const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Return the screen used to edit a specific symbol. #SYMBOL_LIBRARY_MANAGER retains the
* ownership.
2017-11-12 17:55:20 +00:00
*/
SCH_SCREEN* GetScreen( const wxString& aAlias, const wxString& aLibrary );
/**
* Return true if symbol with a specific alias exists in library (either original one or
* buffered).
2017-11-12 17:55:20 +00:00
*/
bool SymbolExists( const wxString& aAlias, const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Return true if library exists. If \a aCheckEnabled is set, then the library must
* also be enabled in the library table.
2017-11-12 17:55:20 +00:00
*/
bool LibraryExists( const wxString& aLibrary, bool aCheckEnabled = false ) const;
2017-11-12 17:55:20 +00:00
/**
* Return true if the library was successfully loaded.
*/
bool IsLibraryLoaded( const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Return true if library has unsaved modifications.
2017-11-12 17:55:20 +00:00
*/
bool IsLibraryModified( const wxString& aLibrary ) const;
/**
* Return true if symbol has unsaved modifications.
2017-11-12 17:55:20 +00:00
*/
bool IsSymbolModified( const wxString& aAlias, const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Clear the modified flag for all symbols in a library.
*/
bool ClearLibraryModified( const wxString& aLibrary ) const;
/**
* Clear the modified flag for a symbol.
*/
bool ClearSymbolModified( const wxString& aAlias, const wxString& aLibrary ) const;
2017-11-12 17:55:20 +00:00
/**
* Return true if the library is stored in a read-only file.
*
2017-11-12 17:55:20 +00:00
* @return True on success, false otherwise.
*/
bool IsLibraryReadOnly( const wxString& aLibrary ) const;
/**
* Save symbol changes to the library copy used by the schematic editor. Not it is not
2017-11-12 17:55:20 +00:00
* necessarily saved to the file.
*
2017-11-12 17:55:20 +00:00
* @return True on success, false otherwise.
*/
bool FlushSymbol( const wxString& aAlias, const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Save library to a file, including unsaved changes.
*
* @param aLibrary is the library name.
* @param aFileName is the target file name.
* @return True on success, false otherwise.
*/
bool SaveLibrary( const wxString& aLibrary, const wxString& aFileName,
SCH_IO_MGR::SCH_FILE_T aFileType = SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY );
2017-11-12 17:55:20 +00:00
/**
* Revert unsaved changes for a symbolicular symbol.
*
* @return The LIB_ID of the reverted symbol (which may be different in the case
* of a rename)
2017-11-12 17:55:20 +00:00
*/
LIB_ID RevertSymbol( const wxString& aAlias, const wxString& aLibrary );
2017-11-12 17:55:20 +00:00
/**
* Revert unsaved changes for a symbolicular library.
*
2017-11-12 17:55:20 +00:00
* @return True on success, false otherwise.
*/
bool RevertLibrary( const wxString& aLibrary );
/**
* Revert all pending changes.
*
* @return True if all changes successfully reverted.
*/
bool RevertAll();
2017-11-12 17:55:20 +00:00
/**
* Return a library name that is not currently in use.
2017-11-12 17:55:20 +00:00
* Used for generating names for new libraries.
*/
wxString GetUniqueLibraryName() const;
/**
* Return the adapter object that provides the stored data.
2017-11-12 17:55:20 +00:00
*/
2020-11-07 14:31:50 +00:00
wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& GetAdapter() { return m_adapter; }
2017-11-12 17:55:20 +00:00
void GetRootSymbolNames( const wxString& aLibName, wxArrayString& aRootSymbolNames );
/**
* Check if symbol \a aSymbolName in library \a aLibraryName is a root symbol that
* has derived symbols.
*
* @return true if \aSymbolName in \a aLibraryName has derived symbols.
*/
bool HasDerivedSymbols( const wxString& aSymbolName, const wxString& aLibraryName );
size_t GetLibraryCount() const;
2017-11-12 17:55:20 +00:00
private:
///< Extract library name basing on the file name.
2017-11-12 17:55:20 +00:00
static wxString getLibraryName( const wxString& aFilePath );
///< Helper function to add either existing or create new library
bool addLibrary( const wxString& aFilePath, bool aCreate, SYMBOL_LIB_TABLE* aTable );
2017-11-12 17:55:20 +00:00
///< Return the current Symbol Library Table.
SYMBOL_LIB_TABLE* symTable() const;
2017-11-12 17:55:20 +00:00
2020-11-07 14:31:50 +00:00
SYMBOL_TREE_SYNCHRONIZING_ADAPTER* getAdapter()
{
return static_cast<SYMBOL_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
}
2021-06-10 18:51:46 +00:00
///< Class to store a working copy of a LIB_SYMBOL object and editor context.
class SYMBOL_BUFFER
2017-11-12 17:55:20 +00:00
{
public:
SYMBOL_BUFFER( LIB_SYMBOL* aSymbol = nullptr,
std::unique_ptr<SCH_SCREEN> aScreen = nullptr );
~SYMBOL_BUFFER();
2017-11-12 17:55:20 +00:00
LIB_SYMBOL* GetSymbol() const { return m_symbol; }
void SetSymbol( LIB_SYMBOL* aSymbol );
2017-11-12 17:55:20 +00:00
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* GetOriginal() const { return m_original; }
void SetOriginal( LIB_SYMBOL* aSymbol );
2017-11-12 17:55:20 +00:00
bool IsModified() const;
SCH_SCREEN* GetScreen() const { return m_screen.get(); }
///< Transfer the screen ownership
std::unique_ptr<SCH_SCREEN> RemoveScreen()
{
return std::move( m_screen );
}
bool SetScreen( std::unique_ptr<SCH_SCREEN> aScreen )
{
bool ret = !!m_screen;
m_screen = std::move( aScreen );
return ret;
}
2017-11-12 17:55:20 +00:00
private:
std::unique_ptr<SCH_SCREEN> m_screen;
2017-11-12 17:55:20 +00:00
LIB_SYMBOL* m_symbol; // Working copy
LIB_SYMBOL* m_original; // Initial state of the symbol
2017-11-12 17:55:20 +00:00
};
///< Store a working copy of a library.
2017-11-12 17:55:20 +00:00
class LIB_BUFFER
{
public:
2019-07-18 23:37:04 +00:00
LIB_BUFFER( const wxString& aLibrary ) :
m_libName( aLibrary ),
m_hash( 1 )
{ }
2017-11-12 17:55:20 +00:00
bool IsModified() const
{
if( !m_deleted.empty() )
return true;
2021-07-28 20:04:53 +00:00
for( const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : m_symbols )
2017-11-12 17:55:20 +00:00
{
if( symbolBuf->IsModified() )
2017-11-12 17:55:20 +00:00
return true;
}
return false;
}
2019-07-18 23:37:04 +00:00
int GetHash() const { return m_hash; }
2017-11-12 17:55:20 +00:00
2021-06-10 18:51:46 +00:00
///< Return the working copy of a LIB_SYMBOL root object with specified alias.
LIB_SYMBOL* GetSymbol( const wxString& aAlias ) const;
2017-11-12 17:55:20 +00:00
///< Create a new buffer to store a symbol. LIB_BUFFER takes ownership of aCopy.
2021-06-10 18:51:46 +00:00
bool CreateBuffer( LIB_SYMBOL* aCopy, SCH_SCREEN* aScreen );
2017-11-12 17:55:20 +00:00
///< Update the buffered symbol with the contents of \a aCopy.
2021-07-28 20:04:53 +00:00
bool UpdateBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, LIB_SYMBOL* aCopy );
2017-11-12 17:55:20 +00:00
2021-07-28 20:04:53 +00:00
bool DeleteBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf );
2017-11-12 17:55:20 +00:00
void ClearDeletedBuffer()
{
m_deleted.clear();
}
///< Save stored modifications to Symbol Lib Table. It may result in saving the symbol
///< to disk as well, depending on the row properties.
2021-07-28 20:04:53 +00:00
bool SaveBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, SYMBOL_LIB_TABLE* aLibTable );
2017-11-12 17:55:20 +00:00
///< Save stored modifications using a plugin. aBuffer decides whether the changes
///< should be cached or stored directly to the disk (for SCH_LEGACY_PLUGIN).
2021-07-28 20:04:53 +00:00
bool SaveBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, const wxString& aFileName,
SCH_PLUGIN* aPlugin, bool aBuffer );
///< Return a symbol buffer with LIB_SYMBOL holding a symbolicular alias
2021-07-28 20:04:53 +00:00
std::shared_ptr<SYMBOL_BUFFER> GetBuffer( const wxString& aAlias ) const;
2017-11-12 17:55:20 +00:00
///< Return all buffered symbols
2021-07-28 20:04:53 +00:00
const std::deque< std::shared_ptr<SYMBOL_BUFFER> >& GetBuffers() const { return m_symbols; }
2017-11-12 17:55:20 +00:00
/**
* Check to see any symbols in the buffer are derived from a parent named \a aParentName.
*
* @param aParentName is the name of the parent to test.
* @return true if any symbols are found derived from a symbol named \a aParent, otherwise
* false.
*/
bool HasDerivedSymbols( const wxString& aParentName ) const;
/**
* Fetch a list of root symbols names from the library buffer.
*
* @param aRootSymbolNames is a reference to a list to populate with root symbol names.
*/
void GetRootSymbolNames( wxArrayString& aRootSymbolNames );
2017-11-12 17:55:20 +00:00
/**
* Fetch all of the symbols derived from a \a aSymbolName into \a aList.
*
* @param aSymbolName is the name of the symbol to search for derived symbols in this
* buffer.
* @param aList is the list of symbols names derived from \a aSymbolName.
* @return a size_t count of the number of symbols derived from \a aSymbolName.
*/
size_t GetDerivedSymbolNames( const wxString& aSymbolName, wxArrayString& aList );
private:
/**
* Remove all symbols derived from \a aParent from the library buffer.
*
* @param aParent is the #SYMBOL_BUFFER to check against.
* @return the count of #SYMBOL_BUFFER objects removed from the library.
*/
2021-07-28 20:04:53 +00:00
int removeChildSymbols( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf );
2017-11-12 17:55:20 +00:00
2021-07-28 20:04:53 +00:00
std::deque< std::shared_ptr<SYMBOL_BUFFER> > m_symbols;
///< Buffer for deleted symbols until library is saved.
2021-07-28 20:04:53 +00:00
std::deque< std::shared_ptr<SYMBOL_BUFFER> > m_deleted;
const wxString m_libName; // Buffered library name
int m_hash;
2017-11-12 17:55:20 +00:00
};
2020-11-07 14:31:50 +00:00
/**
2021-06-10 18:51:46 +00:00
* Return a set of #LIB_SYMBOL objects belonging to the original library.
2020-11-07 14:31:50 +00:00
*/
std::set<LIB_SYMBOL*> getOriginalSymbols( const wxString& aLibrary );
2020-11-07 14:31:50 +00:00
/**
* Return an existing library buffer or creates one to using Symbol Library Table to get
2020-11-07 14:31:50 +00:00
* the original data.
*/
2017-11-12 17:55:20 +00:00
LIB_BUFFER& getLibraryBuffer( const wxString& aLibrary );
///< The library buffers
2017-11-12 17:55:20 +00:00
std::map<wxString, LIB_BUFFER> m_libs;
2020-11-07 14:31:50 +00:00
SYMBOL_EDIT_FRAME& m_frame; ///< Parent frame
LIB_LOGGER* m_logger;
2020-11-07 14:31:50 +00:00
int m_syncHash; ///< Symbol lib table hash value from last synchronization
2020-11-07 14:31:50 +00:00
wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
2017-11-12 17:55:20 +00:00
};
2020-10-31 01:27:16 +00:00
#endif /* SYMBOL_LIBRARY_MANAGER_H */