symbol_library_manager.h

Go to the documentation of this file.

/*
 * This program source code file is symbol of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 CERN
 * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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
 * 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
 */

#ifndef SYMBOL_LIBRARY_MANAGER_H
#define SYMBOL_LIBRARY_MANAGER_H

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

class LIB_SYMBOL;
class SYMBOL_LIB;
class PROGRESS_REPORTER;
class SCH_PLUGIN;
class SYMBOL_EDIT_FRAME;
class SYMBOL_LIB_TABLE;
class SYMBOL_LIB_TABLE_ROW;
class LIB_LOGGER;


class SYMBOL_LIBRARY_MANAGER
{
public:
 SYMBOL_LIBRARY_MANAGER( SYMBOL_EDIT_FRAME& aFrame );
 ~SYMBOL_LIBRARY_MANAGER();

 void Sync( const wxString& aForceRefresh,
 std::function<void( int, int, const wxString& )> aProgressCallback );

 void Preload( PROGRESS_REPORTER& aReporter );

 int GetHash() const;

 bool HasModifications() const;

 int GetLibraryHash( const wxString& aLibrary ) const;

 wxArrayString GetLibraryNames() const;

 SYMBOL_LIB_TABLE_ROW* GetLibrary( const wxString& aLibrary ) const;

 std::list<LIB_SYMBOL*> GetAliases( const wxString& aLibrary ) const;

 bool CreateLibrary( const wxString& aFilePath, SYMBOL_LIB_TABLE* aTable )
 {
 return addLibrary( aFilePath, true, aTable );
 }

 bool AddLibrary( const wxString& aFilePath, SYMBOL_LIB_TABLE* aTable )
 {
 return addLibrary( aFilePath, false, aTable );
 }

 bool UpdateSymbol( LIB_SYMBOL* aSymbol, const wxString& aLibrary );

 bool UpdateSymbolAfterRename( LIB_SYMBOL* aSymbol, const wxString& oldAlias,
 const wxString& aLibrary );

 bool RemoveSymbol( const wxString& aName, const wxString& aLibrary );

 LIB_SYMBOL* GetAlias( const wxString& aAlias, const wxString& aLibrary ) const;

 LIB_SYMBOL* GetBufferedSymbol( const wxString& aAlias, const wxString& aLibrary );

 SCH_SCREEN* GetScreen( const wxString& aAlias, const wxString& aLibrary );

 bool SymbolExists( const wxString& aAlias, const wxString& aLibrary ) const;

 bool LibraryExists( const wxString& aLibrary, bool aCheckEnabled = false ) const;

 bool IsLibraryLoaded( const wxString& aLibrary ) const;

 bool IsLibraryModified( const wxString& aLibrary ) const;

 bool IsSymbolModified( const wxString& aAlias, const wxString& aLibrary ) const;

 bool ClearLibraryModified( const wxString& aLibrary ) const;

 bool ClearSymbolModified( const wxString& aAlias, const wxString& aLibrary ) const;

 bool IsLibraryReadOnly( const wxString& aLibrary ) const;

 bool FlushSymbol( const wxString& aAlias, const wxString& aLibrary );

 bool SaveLibrary( const wxString& aLibrary, const wxString& aFileName,
 SCH_IO_MGR::SCH_FILE_T aFileType = SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY );

 LIB_ID RevertSymbol( const wxString& aAlias, const wxString& aLibrary );

 bool RevertLibrary( const wxString& aLibrary );

 bool RevertAll();

 wxString GetUniqueLibraryName() const;

 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& GetAdapter() { return m_adapter; }

 void GetRootSymbolNames( const wxString& aLibName, wxArrayString& aRootSymbolNames );

 bool HasDerivedSymbols( const wxString& aSymbolName, const wxString& aLibraryName );

 size_t GetLibraryCount() const;

private:
 static wxString getLibraryName( const wxString& aFilePath );

 bool addLibrary( const wxString& aFilePath, bool aCreate, SYMBOL_LIB_TABLE* aTable );

 SYMBOL_LIB_TABLE* symTable() const;

 SYMBOL_TREE_SYNCHRONIZING_ADAPTER* getAdapter()
 {
 return static_cast<SYMBOL_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
 }

 class SYMBOL_BUFFER
 {
 public:
 SYMBOL_BUFFER( LIB_SYMBOL* aSymbol = nullptr,
 std::unique_ptr<SCH_SCREEN> aScreen = nullptr );
 ~SYMBOL_BUFFER();

 LIB_SYMBOL* GetSymbol() const { return m_symbol; }
 void SetSymbol( LIB_SYMBOL* aSymbol );

 LIB_SYMBOL* GetOriginal() const { return m_original; }
 void SetOriginal( LIB_SYMBOL* aSymbol );

 bool IsModified() const;
 SCH_SCREEN* GetScreen() const { return m_screen.get(); }

 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;
 }

 private:
 std::unique_ptr<SCH_SCREEN> m_screen;

 LIB_SYMBOL* m_symbol; // Working copy
 LIB_SYMBOL* m_original; // Initial state of the symbol
 };


 class LIB_BUFFER
 {
 public:
 LIB_BUFFER( const wxString& aLibrary ) :
 m_libName( aLibrary ),
 m_hash( 1 )
 { }

 bool IsModified() const
 {
 if( !m_deleted.empty() )
 return true;

 for( const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : m_symbols )
 {
 if( symbolBuf->IsModified() )
 return true;
 }

 return false;
 }

 int GetHash() const { return m_hash; }

 LIB_SYMBOL* GetSymbol( const wxString& aAlias ) const;

 bool CreateBuffer( LIB_SYMBOL* aCopy, SCH_SCREEN* aScreen );

 bool UpdateBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, LIB_SYMBOL* aCopy );

 bool DeleteBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf );

 void ClearDeletedBuffer()
 {
 m_deleted.clear();
 }

 bool SaveBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, SYMBOL_LIB_TABLE* aLibTable );

 bool SaveBuffer( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf, const wxString& aFileName,
 SCH_PLUGIN* aPlugin, bool aBuffer );

 std::shared_ptr<SYMBOL_BUFFER> GetBuffer( const wxString& aAlias ) const;

 const std::deque< std::shared_ptr<SYMBOL_BUFFER> >& GetBuffers() const { return m_symbols; }

 bool HasDerivedSymbols( const wxString& aParentName ) const;

 void GetRootSymbolNames( wxArrayString& aRootSymbolNames );

 size_t GetDerivedSymbolNames( const wxString& aSymbolName, wxArrayString& aList );

 private:
 int removeChildSymbols( std::shared_ptr<SYMBOL_BUFFER> aSymbolBuf );

 std::deque< std::shared_ptr<SYMBOL_BUFFER> > m_symbols;

 std::deque< std::shared_ptr<SYMBOL_BUFFER> > m_deleted;
 const wxString m_libName; // Buffered library name
 int m_hash;
 };

 std::set<LIB_SYMBOL*> getOriginalSymbols( const wxString& aLibrary );

 LIB_BUFFER& getLibraryBuffer( const wxString& aLibrary );

 std::map<wxString, LIB_BUFFER> m_libs;

 SYMBOL_EDIT_FRAME& m_frame; 
 LIB_LOGGER* m_logger;
 int m_syncHash; 

 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
};

#endif /* SYMBOL_LIBRARY_MANAGER_H */