38#include <wx/filename.h>
57 std::unique_ptr<LIB_SYMBOL> symbol = std::make_unique<LIB_SYMBOL>( wxS(
"Symbol" ) );
58 std::unique_ptr<SCH_SCREEN> screen = std::make_unique<SCH_SCREEN>();
62 SYMBOL_BUFFER buffer( std::move( symbol ), std::move( screen ) );
71 std::unique_ptr<LIB_SYMBOL> originalSymbol =
72 std::make_unique<LIB_SYMBOL>( wxS(
"OriginalSymbol" ) );
73 LIB_SYMBOL& originalSymbolRef = *originalSymbol;
88 wxArrayString symbolNames;
94 auto parentSymbol1 = std::make_unique<LIB_SYMBOL>( wxS(
"Parent1" ) );
101 parentSymbol1->GetValueField().SetText( parentSymbol1->GetName() );
102 libBuffer.
CreateBuffer( std::move( parentSymbol1 ), std::make_unique<SCH_SCREEN>() );
120 auto childSymbol1 = std::make_unique<LIB_SYMBOL>( wxS(
"Child1" ) );
123 childSymbol1->
SetParent( &parentSymbol1Ref );
124 childSymbol1->GetValueField().SetText( childSymbol1->GetName() );
125 libBuffer.
CreateBuffer( std::move( childSymbol1 ), std::make_unique<SCH_SCREEN>() );
147 std::shared_ptr<SYMBOL_BUFFER> buf = libBuffer.
GetBuffer( parentSymbol1Ref.
GetName() );
169 props.
name = wxS(
"Standalone" );
182 std::unique_ptr<LIB_SYMBOL> standalone =
189 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"Parent" ) );
190 parent->GetValueField().SetText( parent->GetName() );
193 parent->AddField( user );
195 props.
name = wxS(
"Child" );
202 std::unique_ptr<LIB_SYMBOL> child =
205 BOOST_CHECK( child->GetParent().lock().get() == parent.get() );
206 BOOST_CHECK( child->GetFootprintField().GetText().IsEmpty() );
207 BOOST_CHECK( child->GetDatasheetField().GetText().IsEmpty() );
209 std::vector<SCH_FIELD*> childFields;
210 child->GetFields( childFields );
236 props.
name = wxS(
"+5V" );
267 wxString tempDir = wxFileName::CreateTempFileName( wxS(
"kicad_test_" ) );
268 wxRemoveFile( tempDir );
269 wxFileName::Mkdir( tempDir );
270 wxString libPath = wxFileName( tempDir, wxS(
"test_lib.kicad_sym" ) ).GetFullPath();
275 plugin->CreateLibrary( libPath );
278 std::unique_ptr<LIB_SYMBOL> parentSymbol = std::make_unique<LIB_SYMBOL>( wxS(
"Parent" ) );
279 parentSymbol->GetValueField().SetText( wxS(
"Parent" ) );
280 parentSymbol->GetReferenceField().SetText( wxS(
"U" ) );
283 plugin->SaveSymbol( libPath, std::make_unique<LIB_SYMBOL>( *parentSymbol ) );
286 std::unique_ptr<LIB_SYMBOL> derivedSymbol = std::make_unique<LIB_SYMBOL>( wxS(
"Derived" ) );
287 derivedSymbol->GetValueField().SetText( wxS(
"Derived" ) );
288 derivedSymbol->SetParent( parentPtr );
290 plugin->SaveSymbol( libPath, std::make_unique<LIB_SYMBOL>( *derivedSymbol ) );
291 plugin->SaveLibrary( libPath );
297 LIB_SYMBOL* parent = plugin->LoadSymbol( libPath, wxS(
"Parent" ) );
298 LIB_SYMBOL* derived = plugin->LoadSymbol( libPath, wxS(
"Derived" ) );
310 LIB_SYMBOL* loadedParent = plugin->LoadSymbol( libPath, wxS(
"Parent" ) );
311 LIB_SYMBOL* loadedDerived = plugin->LoadSymbol( libPath, wxS(
"Derived" ) );
317 loadedDerived->
SetParent( loadedParent );
320 libBuffer.
CreateBuffer( std::make_unique<LIB_SYMBOL>( *loadedParent ),
321 std::make_unique<SCH_SCREEN>() );
323 std::unique_ptr<LIB_SYMBOL> derivedCopy = std::make_unique<LIB_SYMBOL>( *loadedDerived );
324 derivedCopy->SetParent( libBuffer.
GetSymbol( wxS(
"Parent" ) ) );
325 libBuffer.
CreateBuffer( std::move( derivedCopy ), std::make_unique<SCH_SCREEN>() );
334 std::shared_ptr<SYMBOL_BUFFER> derivedBuf = libBuffer.
GetBuffer( wxS(
"Derived" ) );
337 bool deleteResult = libBuffer.
DeleteBuffer( *derivedBuf );
348 std::map<std::string, UTF8> properties;
352 for(
const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : libBuffer.
GetBuffers() )
354 libBuffer.
SaveBuffer( *symbolBuf, libPath, &*plugin,
true );
358 for(
const std::shared_ptr<SYMBOL_BUFFER>& deletedBuf : libBuffer.
GetDeletedBuffers() )
360 const wxString& originalName = deletedBuf->GetOriginal().GetName();
362 if( plugin->LoadSymbol( libPath, originalName ) )
363 plugin->DeleteSymbol( libPath, originalName, &properties );
366 plugin->SaveLibrary( libPath );
374 LIB_SYMBOL* parent = plugin->LoadSymbol( libPath, wxS(
"Parent" ) );
375 LIB_SYMBOL* derived = plugin->LoadSymbol( libPath, wxS(
"Derived" ) );
379 BOOST_CHECK_MESSAGE( derived ==
nullptr,
380 "Derived symbol should have been deleted from the library file" );
384 if( wxFileName::DirExists( tempDir ) )
386 wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
404 wxString tempDir = wxFileName::CreateTempFileName( wxS(
"kicad_test_" ) );
405 wxRemoveFile( tempDir );
406 wxFileName::Mkdir( tempDir );
408 wxString srcPath = wxFileName( tempDir, wxS(
"source.kicad_sym" ) ).GetFullPath();
409 wxString dstPath = wxFileName( tempDir, wxS(
"destination.kicad_sym" ) ).GetFullPath();
414 plugin->CreateLibrary( srcPath );
416 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"Parent" ) );
417 parent->GetValueField().SetText( wxS(
"Parent" ) );
418 parent->GetReferenceField().SetText( wxS(
"U" ) );
421 plugin->SaveSymbol( srcPath, std::make_unique<LIB_SYMBOL>( *parent ) );
423 auto derived = std::make_unique<LIB_SYMBOL>( wxS(
"Derived" ) );
424 derived->GetValueField().SetText( wxS(
"Derived" ) );
425 derived->SetParent( parentPtr );
427 plugin->SaveSymbol( srcPath, std::make_unique<LIB_SYMBOL>( *derived ) );
428 plugin->SaveLibrary( srcPath );
436 std::map<std::string, UTF8> properties;
439 LIB_SYMBOL* loadedParent = srcPlugin->LoadSymbol( srcPath, wxS(
"Parent" ) );
440 LIB_SYMBOL* loadedDerived = srcPlugin->LoadSymbol( srcPath, wxS(
"Derived" ) );
446 BOOST_CHECK_NO_THROW(
447 dstPlugin->SaveSymbol( dstPath, std::make_unique<LIB_SYMBOL>( *loadedParent ),
450 auto newDerived = std::make_unique<LIB_SYMBOL>( *loadedDerived );
451 LIB_SYMBOL* dstParent = dstPlugin->LoadSymbol( dstPath, wxS(
"Parent" ), &properties );
453 newDerived->SetParent( dstParent );
455 BOOST_CHECK_NO_THROW(
456 dstPlugin->SaveSymbol( dstPath, std::move( newDerived ), &properties ) );
458 BOOST_CHECK_NO_THROW( dstPlugin->SaveLibrary( dstPath ) );
465 LIB_SYMBOL* parent = plugin->LoadSymbol( dstPath, wxS(
"Parent" ) );
466 LIB_SYMBOL* derived = plugin->LoadSymbol( dstPath, wxS(
"Derived" ) );
468 BOOST_CHECK_MESSAGE( parent !=
nullptr,
469 "Parent symbol should exist in the saved-as library" );
470 BOOST_CHECK_MESSAGE( derived !=
nullptr,
471 "Derived symbol should exist in the saved-as library" );
477 if( wxFileName::DirExists( tempDir ) )
478 wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
493 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"BaseSymbol" ) );
524 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"BaseSymbol" ) );
525 parent->GetValueField().SetText( wxS(
"BaseSymbol" ) );
526 parent->GetReferenceField().SetText( wxS(
"U" ) );
540 BOOST_REQUIRE_NO_THROW(
543 const std::string out = formatter.
GetString();
545 BOOST_CHECK_MESSAGE( out.find(
"(extends \"RecordedParent\")" ) != std::string::npos,
546 "Derived symbol should serialize (extends ...) using the recorded parent name" );
558 wxString tempDir = wxFileName::CreateTempFileName( wxS(
"kicad_test_" ) );
559 wxRemoveFile( tempDir );
560 wxFileName::Mkdir( tempDir );
562 wxString dstPath = wxFileName( tempDir, wxS(
"copy_target.kicad_sym" ) ).GetFullPath();
565 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"BaseSymbol" ) );
566 parent->GetValueField().SetText( wxS(
"BaseSymbol" ) );
567 parent->GetReferenceField().SetText( wxS(
"U" ) );
569 auto derived = std::make_unique<LIB_SYMBOL>( wxS(
"DerivedSymbol" ) );
570 derived->SetParent( parent.get() );
571 derived->SetParentName( parent->GetName() );
572 derived->GetValueField().SetText( wxS(
"DerivedSymbol" ) );
577 std::map<std::string, UTF8> properties;
580 BOOST_CHECK_NO_THROW(
581 plugin->SaveSymbol( dstPath, std::make_unique<LIB_SYMBOL>( *parent ), &properties ) );
583 LIB_SYMBOL* dstParent = plugin->LoadSymbol( dstPath, wxS(
"BaseSymbol" ), &properties );
586 auto newChild = std::make_unique<LIB_SYMBOL>( *derived );
587 newChild->SetParent( dstParent );
588 newChild->SetParentName( dstParent->
GetName() );
590 BOOST_CHECK_NO_THROW( plugin->SaveSymbol( dstPath, std::move( newChild ), &properties ) );
591 BOOST_CHECK_NO_THROW( plugin->SaveLibrary( dstPath ) );
598 LIB_SYMBOL* reloadedParent = plugin->LoadSymbol( dstPath, wxS(
"BaseSymbol" ) );
599 LIB_SYMBOL* reloadedChild = plugin->LoadSymbol( dstPath, wxS(
"DerivedSymbol" ) );
607 if( wxFileName::DirExists( tempDir ) )
608 wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
624 auto parent = std::make_unique<LIB_SYMBOL>( wxS(
"Parent" ) );
627 libBuffer.
CreateBuffer( std::move( parent ), std::make_unique<SCH_SCREEN>() );
629 auto child = std::make_unique<LIB_SYMBOL>( wxS(
"Child" ) );
630 child->SetParent( &parentRef );
631 libBuffer.
CreateBuffer( std::move( child ), std::make_unique<SCH_SCREEN>() );
640 std::shared_ptr<SYMBOL_BUFFER> parentBuf = libBuffer.
GetBuffer( wxS(
"Parent" ) );
662 auto originalRoot = std::make_unique<LIB_SYMBOL>( wxS(
"Root" ) );
663 auto originalMid = std::make_unique<LIB_SYMBOL>( wxS(
"Mid" ) );
664 auto originalLeaf = std::make_unique<LIB_SYMBOL>( wxS(
"Leaf" ) );
666 originalMid->SetParent( originalRoot.get() );
667 originalLeaf->SetParent( originalMid.get() );
673 auto midCopy = std::make_unique<LIB_SYMBOL>( *originalMid );
676 libBuffer.
CreateBuffer( std::move( midCopy ), std::make_unique<SCH_SCREEN>() );
678 auto leafCopy = std::make_unique<LIB_SYMBOL>( *originalLeaf );
679 leafCopy->SetParent( midCopyPtr );
680 libBuffer.
CreateBuffer( std::move( leafCopy ), std::make_unique<SCH_SCREEN>() );
682 auto rootCopy = std::make_unique<LIB_SYMBOL>( *originalRoot );
685 libBuffer.
CreateBuffer( std::move( rootCopy ), std::make_unique<SCH_SCREEN>() );
689 auto midDuplicate = std::make_unique<LIB_SYMBOL>( *originalMid );
690 midDuplicate->SetParent( rootCopyPtr );
691 libBuffer.
CreateBuffer( std::move( midDuplicate ), std::make_unique<SCH_SCREEN>() );
696 BOOST_CHECK( names.Index( wxS(
"Mid" ) ) != wxNOT_FOUND );
697 BOOST_CHECK( names.Index( wxS(
"Leaf" ) ) != wxNOT_FOUND );
717 auto originalA = std::make_unique<LIB_SYMBOL>( wxS(
"A" ) );
718 auto originalB = std::make_unique<LIB_SYMBOL>( wxS(
"B" ) );
722 auto symbolA = std::make_unique<LIB_SYMBOL>( wxS(
"A" ) );
723 symbolA->SetParent( originalB.get() );
724 libBuffer.
CreateBuffer( std::move( symbolA ), std::make_unique<SCH_SCREEN>() );
726 auto symbolB = std::make_unique<LIB_SYMBOL>( wxS(
"B" ) );
727 symbolB->SetParent( originalA.get() );
728 libBuffer.
CreateBuffer( std::move( symbolB ), std::make_unique<SCH_SCREEN>() );
736 std::shared_ptr<SYMBOL_BUFFER> bufferA = libBuffer.
GetBuffer( wxS(
"A" ) );
745wxString makeTempLibrary(
const std::vector<wxString>& aNames, wxString& aDir )
747 aDir = wxFileName::CreateTempFileName( wxS(
"kicad_test_" ) );
748 wxRemoveFile( aDir );
749 wxFileName::Mkdir( aDir );
751 wxString
path = wxFileName( aDir, wxS(
"lib.kicad_sym" ) ).GetFullPath();
754 plugin->CreateLibrary(
path );
756 for(
const wxString&
name : aNames )
757 plugin->SaveSymbol(
path, std::make_unique<LIB_SYMBOL>(
name ) );
759 plugin->SaveLibrary(
path );
764void bufferSymbols(
LIB_BUFFER& aBuffer,
const wxString& aPath,
const std::vector<wxString>& aNames )
768 for(
const wxString&
name : aNames )
772 aBuffer.
CreateBuffer( std::make_unique<LIB_SYMBOL>( *loaded ), std::make_unique<SCH_SCREEN>() );
780 renamed.SetName( aNewName );
785void saveLibrary(
LIB_BUFFER& aBuffer,
const wxString& aPath )
789 for(
const std::shared_ptr<SYMBOL_BUFFER>& buf : aBuffer.
GetBuffers() )
790 aBuffer.
SaveBuffer( *buf, aPath, &*plugin,
true );
792 plugin->SaveLibrary( aPath );
796bool inLibrary(
const wxString& aPath,
const wxString& aName )
799 return plugin->LoadSymbol( aPath, aName ) !=
nullptr;
811 wxString
path = makeTempLibrary( { wxS(
"A" ), wxS(
"B" ) }, dir );
814 bufferSymbols( libBuffer,
path, { wxS(
"A" ), wxS(
"B" ) } );
818 std::shared_ptr<SYMBOL_BUFFER> bufA = libBuffer.GetBuffer( wxS(
"A" ) );
819 std::shared_ptr<SYMBOL_BUFFER> bufB = libBuffer.GetBuffer( wxS(
"B" ) );
824 renameBuffer( libBuffer, *bufA, wxS(
"B" ) );
825 renameBuffer( libBuffer, *bufB, wxS(
"A" ) );
826 saveLibrary( libBuffer,
path );
831 wxFileName::Rmdir( dir, wxPATH_RMDIR_RECURSIVE );
841 wxString
path = makeTempLibrary( { wxS(
"Old" ) }, dir );
844 bufferSymbols( libBuffer,
path, { wxS(
"Old" ) } );
846 std::shared_ptr<SYMBOL_BUFFER> buf = libBuffer.GetBuffer( wxS(
"Old" ) );
850 renameBuffer( libBuffer, *buf, wxS(
"New" ) );
851 saveLibrary( libBuffer,
path );
856 wxFileName::Rmdir( dir, wxPATH_RMDIR_RECURSIVE );
866 wxString tempDir = wxFileName::CreateTempFileName( wxS(
"kicad_test_" ) );
867 wxRemoveFile( tempDir );
868 wxFileName::Mkdir( tempDir );
869 wxString libPath = wxFileName( tempDir, wxS(
"4xxx.kicad_sym" ) ).GetFullPath();
877 std::vector<LIB_SYMBOL*> originals;
878 plugin->EnumerateSymbolLib( originals, libPath );
882 if( libBuffer.
GetSymbol( symbol->GetName() ) )
885 auto copy = std::make_unique<LIB_SYMBOL>( *symbol );
887 if( symbol->IsDerived() )
893 auto newParent = std::make_unique<LIB_SYMBOL>( *symbol->GetParent().lock() );
894 parent = newParent.get();
895 libBuffer.
CreateBuffer( std::move( newParent ), std::make_unique<SCH_SCREEN>() );
898 copy->SetParent( parent );
901 libBuffer.
CreateBuffer( std::move(
copy ), std::make_unique<SCH_SCREEN>() );
906 wxFFile file( libPath, wxS(
"rb" ) );
907 std::string
text(
static_cast<size_t>( file.Length() ),
'\0' );
911 size_t description =
text.find(
"Dual D FlipFlop, Set & reset" );
913 text.replace( description, 29,
"Dual D flip-flop, pulled" );
915 wxFFile out( libPath, wxS(
"wb" ) );
919 std::shared_ptr<SYMBOL_BUFFER> edited = libBuffer.
GetBuffer( wxS(
"4016" ) );
921 edited->GetSymbol().GetDescriptionField().SetText( wxS(
"Quad bilateral switch, edited" ) );
922 edited->GetScreen()->SetContentModified();
925 for(
int ii = 0; ii < 2; ++ii )
929 plugin->SaveLibrary( libPath );
930 edited->GetScreen()->SetContentModified(
false );
934 LIB_SYMBOL* pulled = plugin->LoadSymbol( libPath, wxS(
"4013" ) );
935 LIB_SYMBOL* parent = plugin->LoadSymbol( libPath, wxS(
"4016" ) );
936 LIB_SYMBOL* derived = plugin->LoadSymbol( libPath, wxS(
"4066" ) );
943 wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
void SetContentModified(bool aModified=true)
Store a working copy of a library.
void ClearAddedAndDeletedBufferLists()
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 DeleteBuffer(const SYMBOL_BUFFER &aSymbolBuf)
Delete the given symbol buffer from the library buffer.
bool SaveModifiedBuffers(const wxString &aFileName, SCH_IO *aPlugin)
Save the modified symbols back to the library's own file aFileName.
void GetSymbolNames(wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)
Fetch a list of root symbols names from the library buffer.
const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & GetDeletedBuffers() const
Return the deleted symbol buffers that need to be removed from the library file.
size_t GetDerivedSymbolNames(const wxString &aSymbolName, wxArrayString &aList) const
Fetch all of the symbols derived from a aSymbolName into aList.
bool SaveBuffer(SYMBOL_BUFFER &aSymbolBuf, const wxString &aFileName, SCH_IO *aPlugin, bool aBuffer)
Save stored modifications using a plugin.
const std::deque< std::shared_ptr< SYMBOL_BUFFER > > & GetBuffers() const
Return all buffered symbols.
std::shared_ptr< SYMBOL_BUFFER > GetBuffer(const wxString &aAlias) const
Return a symbol buffer with LIB_SYMBOL holding a symbolic alias.
LIB_SYMBOL * GetSymbol(const wxString &aAlias) const
Return the working copy of a LIB_SYMBOL root object with specified alias.
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)
Update the buffered symbol with the contents of aCopy.
static std::unique_ptr< LIB_SYMBOL > CreateSymbol(const NEW_SYMBOL_PROPERTIES &aProps, LIB_SYMBOL *aParent)
Define a library symbol object.
SCH_FIELD & GetDescriptionField()
wxString GetDescription() const override
Get the Description field text value */.
std::weak_ptr< LIB_SYMBOL > & GetParent()
void SetParent(LIB_SYMBOL *aParent=nullptr)
wxString GetName() const override
SCH_FIELD & GetValueField()
const wxString & GetParentName() const
void SetParentName(const wxString &aParentName)
void SetText(const wxString &aText) override
static void SaveSymbol(LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, const wxString &aLibName=wxEmptyString, bool aIncludeData=true)
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
LIB_SYMBOL & GetSymbol() const
SCH_SCREEN * GetScreen() const
LIB_SYMBOL & GetOriginal() const
void SetOriginal(std::unique_ptr< LIB_SYMBOL > aSymbol)
SYMBOL_LIBRARY_MANAGER_TEST_FIXTURE()
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
std::string GetEeschemaTestDataDir()
Get the configured location of Eeschema test data.
wxString parentSymbolName
bool keepContentUserFields
bool unitsInterchangeable
@ USER
The field ID hasn't been set yet; field is invalid.
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_CHECK(res.column_datatype(0)==SQL_NUMERIC||res.column_datatype(0)==SQL_DECIMAL)
BOOST_REQUIRE_EQUAL(rows.size(), 1)
BOOST_CHECK_EQUAL(std::any_cast< std::string >(rows[0].at("val")), "12345678901234567.89")
BOOST_REQUIRE(res.columns()==1)
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_CASE(SymbolBuffer)
Test the SYMBOL_BUFFER object.