KiCad PCB EDA Suite
Loading...
Searching...
No Matches
LIB_BUFFER Class Reference

Store a working copy of a library. More...

#include <symbol_library_manager.h>

Public Member Functions

 LIB_BUFFER (const wxString &aLibrary)
 
bool IsModified () const
 
int GetHash () const
 
LIB_SYMBOL * GetSymbol (const wxString &aAlias) const
 Return the working copy of a LIB_SYMBOL root object with specified alias.
 
bool CreateBuffer (std::unique_ptr< LIB_SYMBOL > aCopy, std::unique_ptr< SCH_SCREEN > aScreen, bool aNew=false)
 Create a new buffer to store a symbol. LIB_BUFFER takes ownership of aCopy.
 
bool UpdateBuffer (SYMBOL_BUFFER &aSymbolBuf, const LIB_SYMBOL &aCopy)
 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 RevertDeletedBuffers ()
 Move symbol buffers on the library's deleted list back to its main list.
 
void RevertAddedBuffers ()
 
const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & GetDeletedBuffers () const
 Return the deleted symbol buffers that need to be removed from the library file.
 
void ClearAddedAndDeletedBufferLists ()
 
bool SaveModifiedBuffers (const wxString &aFileName, SCH_IO *aPlugin)
 Save the modified symbols back to the library's own file aFileName.
 
bool SaveBuffer (SYMBOL_BUFFER &aSymbolBuf, const wxString &aFileName, SCH_IO *aPlugin, bool aBuffer)
 Save stored modifications using a plugin.
 
std::shared_ptr< SYMBOL_BUFFER > GetBuffer (const wxString &aAlias) const
 Return a symbol buffer with LIB_SYMBOL holding a symbolic alias.
 
const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & GetBuffers () const
 Return all buffered symbols.
 
bool HasDerivedSymbols (const wxString &aParentName) const
 Check to see any symbols in the buffer are derived from a parent named aParentName.
 
void GetSymbolNames (wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)
 Fetch a list of root symbols names from the library buffer.
 
size_t GetDerivedSymbolNames (const wxString &aSymbolName, wxArrayString &aList) const
 Fetch all of the symbols derived from a aSymbolName into aList.
 

Private Member Functions

int removeChildSymbols (const SYMBOL_BUFFER &aSymbolBuf)
 Remove all symbols derived from aSymbolBuf from the library buffer.
 

Private Attributes

std::deque< std::shared_ptr< SYMBOL_BUFFER > > m_symbols
 
std::deque< std::shared_ptr< SYMBOL_BUFFER > > m_added
 Buffer for added synbols until lib is saved.
 
std::deque< std::shared_ptr< SYMBOL_BUFFER > > m_deleted
 Buffer for deleted symbols until lib is saved.
 
const wxString m_libName
 Buffered library name.
 
int m_hash
 

Detailed Description

Store a working copy of a library.

Definition at line 76 of file symbol_library_manager.h.

Constructor & Destructor Documentation

◆ LIB_BUFFER()

LIB_BUFFER::LIB_BUFFER ( const wxString & aLibrary)
inline

Definition at line 79 of file symbol_library_manager.h.

References m_hash, and m_libName.

Member Function Documentation

◆ ClearAddedAndDeletedBufferLists()

void LIB_BUFFER::ClearAddedAndDeletedBufferLists ( )
inline

Definition at line 124 of file symbol_library_manager.h.

References m_added, and m_deleted.

Referenced by BOOST_AUTO_TEST_CASE(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ CreateBuffer()

bool LIB_BUFFER::CreateBuffer ( std::unique_ptr< LIB_SYMBOL > aCopy,
std::unique_ptr< SCH_SCREEN > aScreen,
bool aNew = false )

◆ DeleteBuffer()

◆ GetBuffer()

◆ GetBuffers()

const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & LIB_BUFFER::GetBuffers ( ) const
inline

◆ GetDeletedBuffers()

const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & LIB_BUFFER::GetDeletedBuffers ( ) const
inline

Return the deleted symbol buffers that need to be removed from the library file.

Definition at line 122 of file symbol_library_manager.h.

References m_deleted.

Referenced by BOOST_AUTO_TEST_CASE(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ GetDerivedSymbolNames()

size_t LIB_BUFFER::GetDerivedSymbolNames ( const wxString & aSymbolName,
wxArrayString & aList ) const

Fetch all of the symbols derived from a aSymbolName into aList.

Parameters
aSymbolNameis the name of the symbol to search for derived symbols in this buffer.
aListis the list of symbols names derived from aSymbolName.
Returns
a size_t count of the number of symbols derived from aSymbolName.

Definition at line 1390 of file symbol_library_manager.cpp.

References getParentName(), and m_symbols.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SYMBOL_LIBRARY_MANAGER::GetDerivedSymbolNames(), and removeChildSymbols().

◆ GetHash()

int LIB_BUFFER::GetHash ( ) const
inline

Definition at line 98 of file symbol_library_manager.h.

References m_hash.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetSymbol()

LIB_SYMBOL * LIB_BUFFER::GetSymbol ( const wxString & aAlias) const

◆ GetSymbolNames()

void LIB_BUFFER::GetSymbolNames ( wxArrayString & aSymbolNames,
SYMBOL_NAME_FILTER aFilter = SYMBOL_NAME_FILTER::ALL )

Fetch a list of root symbols names from the library buffer.

Parameters
aSymbolNamesis a reference to a list to populate with root symbol names.
aFilteris the symbol derivation type.

Definition at line 1373 of file symbol_library_manager.cpp.

References DERIVED_ONLY, LIB_SYMBOL::GetName(), LIB_SYMBOL::IsDerived(), LIB_SYMBOL::IsRoot(), m_symbols, ROOT_ONLY, and UnescapeString().

Referenced by BOOST_AUTO_TEST_CASE(), and SYMBOL_LIBRARY_MANAGER::GetSymbolNames().

◆ HasDerivedSymbols()

bool LIB_BUFFER::HasDerivedSymbols ( const wxString & aParentName) const

Check to see any symbols in the buffer are derived from a parent named aParentName.

Parameters
aParentNameis the name of the parent to test.
Returns
true if any symbols are found derived from a symbol named aParent, otherwise false.

Definition at line 1359 of file symbol_library_manager.cpp.

References getParentName(), and m_symbols.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DeleteBuffer(), and SYMBOL_LIBRARY_MANAGER::HasDerivedSymbols().

◆ IsModified()

bool LIB_BUFFER::IsModified ( ) const
inline

Definition at line 84 of file symbol_library_manager.h.

References m_deleted, and m_symbols.

Referenced by BOOST_AUTO_TEST_CASE().

◆ removeChildSymbols()

int LIB_BUFFER::removeChildSymbols ( const SYMBOL_BUFFER & aSymbolBuf)
private

Remove all symbols derived from aSymbolBuf from the library buffer.

Parameters
aSymbolBufis the buffer to remove child symbols from.
Returns
the count of SYMBOL_BUFFER objects removed from the library.

Definition at line 1439 of file symbol_library_manager.cpp.

References GetDerivedSymbolNames(), LIB_SYMBOL::GetName(), SYMBOL_BUFFER::GetSymbol(), m_deleted, and m_symbols.

Referenced by DeleteBuffer().

◆ RevertAddedBuffers()

void LIB_BUFFER::RevertAddedBuffers ( )

Definition at line 1081 of file symbol_library_manager.cpp.

References m_added, m_hash, and m_symbols.

◆ RevertDeletedBuffers()

void LIB_BUFFER::RevertDeletedBuffers ( )

Move symbol buffers on the library's deleted list back to its main list.

Definition at line 1071 of file symbol_library_manager.cpp.

References m_deleted, m_hash, and m_symbols.

◆ SaveBuffer()

◆ SaveModifiedBuffers()

bool LIB_BUFFER::SaveModifiedBuffers ( const wxString & aFileName,
SCH_IO * aPlugin )

Save the modified symbols back to the library's own file aFileName.

The others are left as the file has them, which may be newer than the buffer when something else, such as a git pull, changed the file.

Definition at line 1109 of file symbol_library_manager.cpp.

References _, SCH_IO::EnumerateSymbolLib(), m_symbols, res, SaveBuffer(), and IO_ERROR::What().

Referenced by BOOST_AUTO_TEST_CASE(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ UpdateBuffer()

bool LIB_BUFFER::UpdateBuffer ( SYMBOL_BUFFER & aSymbolBuf,
const LIB_SYMBOL & aCopy )

Update the buffered symbol with the contents of aCopy.

Definition at line 1029 of file symbol_library_manager.cpp.

References SYMBOL_BUFFER::GetSymbol(), and m_hash.

Referenced by BOOST_AUTO_TEST_CASE(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbolAfterRename().

Member Data Documentation

◆ m_added

std::deque<std::shared_ptr<SYMBOL_BUFFER> > LIB_BUFFER::m_added
private

Buffer for added synbols until lib is saved.

Definition at line 188 of file symbol_library_manager.h.

Referenced by ClearAddedAndDeletedBufferLists(), CreateBuffer(), and RevertAddedBuffers().

◆ m_deleted

std::deque<std::shared_ptr<SYMBOL_BUFFER> > LIB_BUFFER::m_deleted
private

Buffer for deleted symbols until lib is saved.

Definition at line 189 of file symbol_library_manager.h.

Referenced by ClearAddedAndDeletedBufferLists(), DeleteBuffer(), GetDeletedBuffers(), IsModified(), removeChildSymbols(), and RevertDeletedBuffers().

◆ m_hash

int LIB_BUFFER::m_hash
private

◆ m_libName

const wxString LIB_BUFFER::m_libName
private

Buffered library name.

Definition at line 190 of file symbol_library_manager.h.

Referenced by CreateBuffer(), and LIB_BUFFER().

◆ m_symbols


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