test_symbol_library_manager.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 PARTICULAR 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, see <https://www.gnu.org/licenses/>.
 */

 
#include <qa_utils/wx_utils/unit_test_utils.h>
 
// Code under test
#include <symbol_library_manager.h>
#include <symbol_editor/lib_symbol_library_manager.h>
#include <sch_field.h>
#include <sch_io/kicad_sexpr/sch_io_kicad_sexpr.h>
#include <sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.h>
#include <sch_io/sch_io_mgr.h>
#include <richio.h>
 
#include <wx/filename.h>
 
class SYMBOL_LIBRARY_MANAGER_TEST_FIXTURE
{
public:
    SYMBOL_LIBRARY_MANAGER_TEST_FIXTURE()
    {
    }
};
 
 
BOOST_FIXTURE_TEST_SUITE( SymbolLibraryManager, SYMBOL_LIBRARY_MANAGER_TEST_FIXTURE )
 
 

BOOST_AUTO_TEST_CASE( SymbolBuffer )
{
    std::unique_ptr<LIB_SYMBOL> symbol = std::make_unique<LIB_SYMBOL>( wxS( "Symbol" ) );
    std::unique_ptr<SCH_SCREEN> screen = std::make_unique<SCH_SCREEN>();
 
    LIB_SYMBOL& symbolRef = *symbol;
 
    SYMBOL_BUFFER buffer( std::move( symbol ), std::move( screen ) );
 
    BOOST_CHECK( !buffer.IsModified() );
    BOOST_CHECK( &buffer.GetSymbol() == &symbolRef );
    BOOST_CHECK( buffer.GetOriginal() == symbolRef );
 
    buffer.GetScreen()->SetContentModified();
    BOOST_CHECK( buffer.IsModified() );
 
    std::unique_ptr<LIB_SYMBOL> originalSymbol =
            std::make_unique<LIB_SYMBOL>( wxS( "OriginalSymbol" ) );
    LIB_SYMBOL& originalSymbolRef = *originalSymbol;
 
    buffer.SetOriginal( std::move( originalSymbol ) );
 
    BOOST_CHECK( &buffer.GetOriginal() == &originalSymbolRef );
    BOOST_CHECK( buffer.GetOriginal() == originalSymbolRef );
    BOOST_CHECK( &buffer.GetSymbol() != &buffer.GetOriginal() );
}
 

BOOST_AUTO_TEST_CASE( LibBuffer )
{
    wxArrayString symbolNames;
    LIB_BUFFER    libBuffer( wxS( "TestLibrary" ) );
 
    BOOST_CHECK( !libBuffer.IsModified() );
    BOOST_CHECK_EQUAL( libBuffer.GetHash(), 1 );
 
    auto        parentSymbol1 = std::make_unique<LIB_SYMBOL>( wxS( "Parent1" ) );
    // A but clunky, but real code would get symbol from the LIB_BUFFER
    // via GetSymbol etc, rather than retaining a reference after construction.
    LIB_SYMBOL& parentSymbol1Ref = *parentSymbol1;
 
    BOOST_CHECK_EQUAL( libBuffer.GetSymbol( parentSymbol1->GetName() ), nullptr );
 
    parentSymbol1->GetValueField().SetText( parentSymbol1->GetName() );
    libBuffer.CreateBuffer( std::move( parentSymbol1 ), std::make_unique<SCH_SCREEN>() );
    BOOST_CHECK( libBuffer.GetSymbol( parentSymbol1Ref.GetName() ) == &parentSymbol1Ref );
    BOOST_CHECK( !libBuffer.HasDerivedSymbols( parentSymbol1Ref.GetName() ) );
    BOOST_CHECK_EQUAL( libBuffer.GetHash(), 2 );
 
    libBuffer.GetSymbolNames( symbolNames );
    BOOST_CHECK_EQUAL( symbolNames.GetCount(), 1 );
    BOOST_CHECK_EQUAL( symbolNames[0], parentSymbol1Ref.GetName() );
 
    symbolNames.Clear();
    libBuffer.GetSymbolNames( symbolNames, SYMBOL_NAME_FILTER::ROOT_ONLY );
    BOOST_CHECK_EQUAL( symbolNames.GetCount(), 1 );
    BOOST_CHECK_EQUAL( symbolNames[0], parentSymbol1Ref.GetName() );
 
    symbolNames.Clear();
    libBuffer.GetSymbolNames( symbolNames, SYMBOL_NAME_FILTER::DERIVED_ONLY );
    BOOST_CHECK_EQUAL( symbolNames.GetCount(), 0 );
 
    auto        childSymbol1 = std::make_unique<LIB_SYMBOL>( wxS( "Child1" ) );
    LIB_SYMBOL& childSymbol1Ref = *childSymbol1;
 
    childSymbol1->SetParent( &parentSymbol1Ref );
    childSymbol1->GetValueField().SetText( childSymbol1->GetName() );
    libBuffer.CreateBuffer( std::move( childSymbol1 ), std::make_unique<SCH_SCREEN>() );
    BOOST_CHECK( libBuffer.GetSymbol( childSymbol1Ref.GetName() ) == &childSymbol1Ref );
    BOOST_CHECK( libBuffer.HasDerivedSymbols( parentSymbol1Ref.GetName() ) );
    BOOST_CHECK_EQUAL( libBuffer.GetHash(), 3 );
 
    symbolNames.Clear();
    libBuffer.GetSymbolNames( symbolNames );
    BOOST_CHECK_EQUAL( symbolNames.GetCount(), 2 );
    BOOST_CHECK_EQUAL( symbolNames[0], parentSymbol1Ref.GetName() );
    BOOST_CHECK_EQUAL( symbolNames[1], childSymbol1Ref.GetName() );
 
    symbolNames.Clear();
    libBuffer.GetSymbolNames( symbolNames, SYMBOL_NAME_FILTER::DERIVED_ONLY );
    BOOST_CHECK_EQUAL( symbolNames.GetCount(), 1 );
    BOOST_CHECK_EQUAL( symbolNames[0], childSymbol1Ref.GetName() );
 
    symbolNames.Clear();
 
    BOOST_CHECK_EQUAL( libBuffer.GetDerivedSymbolNames( parentSymbol1Ref.GetName(), symbolNames ),
                       1 );
    BOOST_CHECK_EQUAL( symbolNames[0], childSymbol1Ref.GetName() );
 
    std::shared_ptr<SYMBOL_BUFFER> buf = libBuffer.GetBuffer( parentSymbol1Ref.GetName() );
 
    LIB_SYMBOL tmp( parentSymbol1Ref );
    tmp.GetDescriptionField().SetText( wxS( "Description" ) );
 
    libBuffer.UpdateBuffer( *buf, tmp );
    BOOST_CHECK_EQUAL( libBuffer.GetHash(), 4 );
    BOOST_CHECK( *libBuffer.GetSymbol( parentSymbol1Ref.GetName() ) == tmp );
 
    const bool deletedOk = libBuffer.DeleteBuffer( *buf );
    BOOST_CHECK( deletedOk );
    BOOST_CHECK( libBuffer.GetBuffers().empty() );
}
 

BOOST_AUTO_TEST_CASE( NewSymbolCreation )
{
    NEW_SYMBOL_PROPERTIES props;
 
    props.name = wxS( "Standalone" );
    props.reference = wxS( "U" );
    props.unitCount = 2;
    props.pinNameInside = true;
    props.pinTextPosition = 2;
    props.powerSymbol = false;
    props.showPinNumber = true;
    props.showPinName = true;
    props.unitsInterchangeable = false;
    props.includeInBom = true;
    props.includeOnBoard = true;
    props.alternateBodyStyle = false;
 
    std::unique_ptr<LIB_SYMBOL> standalone =
            LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol( props, nullptr );
 
    BOOST_CHECK_EQUAL( standalone->GetReferenceField().GetText(), props.reference );
    BOOST_CHECK_EQUAL( standalone->GetUnitCount(), props.unitCount );
    BOOST_CHECK( standalone->GetPinNameOffset() > 0 );
 
    auto parent = std::make_unique<LIB_SYMBOL>( wxS( "Parent" ) );
    parent->GetValueField().SetText( parent->GetName() );
    SCH_FIELD* user = new SCH_FIELD( parent.get(), FIELD_T::USER, wxS( "UF" ) );
    user->SetText( wxS( "V" ) );
    parent->AddField( user );
 
    props.name = wxS( "Child" );
    props.parentSymbolName = parent->GetName();
    props.keepFootprint = false;
    props.keepDatasheet = false;
    props.transferUserFields = true;
    props.keepContentUserFields = false;
 
    std::unique_ptr<LIB_SYMBOL> child =
            LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol( props, parent.get() );
 
    BOOST_CHECK( child->GetParent().lock().get() == parent.get() );
    BOOST_CHECK( child->GetFootprintField().GetText().IsEmpty() );
    BOOST_CHECK( child->GetDatasheetField().GetText().IsEmpty() );
 
    std::vector<SCH_FIELD*> childFields;
    child->GetFields( childFields );
 
    bool found = false;
 
    for( SCH_FIELD* field : childFields )
    {
        if( field->GetId() == FIELD_T::USER )
        {
            found = true;
            BOOST_CHECK( field->GetText().IsEmpty() );
        }
    }
 
    BOOST_CHECK( found );
}
 

BOOST_AUTO_TEST_CASE( NewPowerSymbolSeedsValueFromName )
{
    NEW_SYMBOL_PROPERTIES props;
 
    props.name = wxS( "+5V" );
    props.reference = wxS( "#PWR" );
    props.unitCount = 1;
    props.pinNameInside = false;
    props.pinTextPosition = 0;
    props.powerSymbol = true;
    props.showPinNumber = false;
    props.showPinName = false;
    props.unitsInterchangeable = true;
    props.includeInBom = false;
    props.includeOnBoard = false;
    props.alternateBodyStyle = false;
 
    std::unique_ptr<LIB_SYMBOL> symbol = LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol( props, nullptr );
 
    BOOST_REQUIRE( symbol->IsGlobalPower() );
    BOOST_CHECK_EQUAL( symbol->GetValueField().GetText(), props.name );
}
 

BOOST_AUTO_TEST_CASE( DeletedSymbolsAreRemovedFromFile )
{
    // Create a temporary directory and library file
    wxString tempDir = wxFileName::CreateTempFileName( wxS( "kicad_test_" ) );
    wxRemoveFile( tempDir );
    wxFileName::Mkdir( tempDir );
    wxString libPath = wxFileName( tempDir, wxS( "test_lib.kicad_sym" ) ).GetFullPath();
 
    // Step 1: Create a library with a parent and derived symbol using the plugin directly
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        plugin->CreateLibrary( libPath );
 
        // Create parent symbol
        std::unique_ptr<LIB_SYMBOL> parentSymbol = std::make_unique<LIB_SYMBOL>( wxS( "Parent" ) );
        parentSymbol->GetValueField().SetText( wxS( "Parent" ) );
        parentSymbol->GetReferenceField().SetText( wxS( "U" ) );
 
        LIB_SYMBOL* parentPtr = parentSymbol.get();
        plugin->SaveSymbol( libPath, std::make_unique<LIB_SYMBOL>( *parentSymbol ) );
 
        // Create derived symbol
        std::unique_ptr<LIB_SYMBOL> derivedSymbol = std::make_unique<LIB_SYMBOL>( wxS( "Derived" ) );
        derivedSymbol->GetValueField().SetText( wxS( "Derived" ) );
        derivedSymbol->SetParent( parentPtr );
 
        plugin->SaveSymbol( libPath, std::make_unique<LIB_SYMBOL>( *derivedSymbol ) );
        plugin->SaveLibrary( libPath );
    }
 
    // Step 2: Verify both symbols exist in the library
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        LIB_SYMBOL* parent = plugin->LoadSymbol( libPath, wxS( "Parent" ) );
        LIB_SYMBOL* derived = plugin->LoadSymbol( libPath, wxS( "Derived" ) );
 
        BOOST_REQUIRE( parent != nullptr );
        BOOST_REQUIRE( derived != nullptr );
        BOOST_CHECK( derived->IsDerived() );
    }
 
    // Step 3: Load symbols into LIB_BUFFER and delete the derived symbol
    LIB_BUFFER libBuffer( wxS( "TestLibrary" ) );
 
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        LIB_SYMBOL* loadedParent = plugin->LoadSymbol( libPath, wxS( "Parent" ) );
        LIB_SYMBOL* loadedDerived = plugin->LoadSymbol( libPath, wxS( "Derived" ) );
 
        BOOST_REQUIRE( loadedParent != nullptr );
        BOOST_REQUIRE( loadedDerived != nullptr );
 
        // Set up parent relationship
        loadedDerived->SetParent( loadedParent );
 
        // Create buffers (parent first, then derived)
        libBuffer.CreateBuffer( std::make_unique<LIB_SYMBOL>( *loadedParent ),
                                std::make_unique<SCH_SCREEN>() );
 
        std::unique_ptr<LIB_SYMBOL> derivedCopy = std::make_unique<LIB_SYMBOL>( *loadedDerived );
        derivedCopy->SetParent( libBuffer.GetSymbol( wxS( "Parent" ) ) );
        libBuffer.CreateBuffer( std::move( derivedCopy ), std::make_unique<SCH_SCREEN>() );
    }
 
    // Verify buffer state before deletion
    BOOST_CHECK_EQUAL( libBuffer.GetBuffers().size(), 2 );
    BOOST_CHECK( libBuffer.GetSymbol( wxS( "Parent" ) ) != nullptr );
    BOOST_CHECK( libBuffer.GetSymbol( wxS( "Derived" ) ) != nullptr );
 
    // Delete the derived symbol from the buffer
    std::shared_ptr<SYMBOL_BUFFER> derivedBuf = libBuffer.GetBuffer( wxS( "Derived" ) );
    BOOST_REQUIRE( derivedBuf != nullptr );
 
    bool deleteResult = libBuffer.DeleteBuffer( *derivedBuf );
    BOOST_CHECK( deleteResult );
 
    // Verify buffer state after deletion
    BOOST_CHECK_EQUAL( libBuffer.GetBuffers().size(), 1 );
    BOOST_CHECK( libBuffer.GetSymbol( wxS( "Parent" ) ) != nullptr );
    BOOST_CHECK( libBuffer.GetSymbol( wxS( "Derived" ) ) == nullptr );
 
    // Step 4: Save the library using the same pattern as SYMBOL_LIBRARY_MANAGER::SaveLibrary
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        std::map<std::string, UTF8> properties;
        properties.emplace( SCH_IO_KICAD_SEXPR::PropBuffering, "" );
 
        // Save remaining buffers (just Parent)
        for( const std::shared_ptr<SYMBOL_BUFFER>& symbolBuf : libBuffer.GetBuffers() )
        {
            libBuffer.SaveBuffer( *symbolBuf, libPath, &*plugin, true );
        }
 
        // Delete symbols that were removed from the buffer (this is the fix for the bug)
        for( const std::shared_ptr<SYMBOL_BUFFER>& deletedBuf : libBuffer.GetDeletedBuffers() )
        {
            const wxString& originalName = deletedBuf->GetOriginal().GetName();
 
            if( plugin->LoadSymbol( libPath, originalName ) )
                plugin->DeleteSymbol( libPath, originalName, &properties );
        }
 
        plugin->SaveLibrary( libPath );
        libBuffer.ClearDeletedBuffer();
    }
 
    // Step 5: Reload the library and verify the derived symbol is gone
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
 
        LIB_SYMBOL* parent = plugin->LoadSymbol( libPath, wxS( "Parent" ) );
        LIB_SYMBOL* derived = plugin->LoadSymbol( libPath, wxS( "Derived" ) );
 
        BOOST_CHECK( parent != nullptr );
        // This is the actual check for the bug - the derived symbol should be deleted
        BOOST_CHECK_MESSAGE( derived == nullptr,
                             "Derived symbol should have been deleted from the library file" );
    }
 
    // Cleanup
    if( wxFileName::DirExists( tempDir ) )
    {
        wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
    }
}
 

BOOST_AUTO_TEST_CASE( SaveLibraryAsToNewFile )
{
    wxString tempDir = wxFileName::CreateTempFileName( wxS( "kicad_test_" ) );
    wxRemoveFile( tempDir );
    wxFileName::Mkdir( tempDir );
 
    wxString srcPath = wxFileName( tempDir, wxS( "source.kicad_sym" ) ).GetFullPath();
    wxString dstPath = wxFileName( tempDir, wxS( "destination.kicad_sym" ) ).GetFullPath();
 
    // Create a source library with two symbols (one parent, one derived)
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        plugin->CreateLibrary( srcPath );
 
        auto parent = std::make_unique<LIB_SYMBOL>( wxS( "Parent" ) );
        parent->GetValueField().SetText( wxS( "Parent" ) );
        parent->GetReferenceField().SetText( wxS( "U" ) );
        LIB_SYMBOL* parentPtr = parent.get();
 
        plugin->SaveSymbol( srcPath, std::make_unique<LIB_SYMBOL>( *parent ) );
 
        auto derived = std::make_unique<LIB_SYMBOL>( wxS( "Derived" ) );
        derived->GetValueField().SetText( wxS( "Derived" ) );
        derived->SetParent( parentPtr );
 
        plugin->SaveSymbol( srcPath, std::make_unique<LIB_SYMBOL>( *derived ) );
        plugin->SaveLibrary( srcPath );
    }
 
    // Simulate "Save Library As" to a new file that does not exist yet.
    // This mirrors the else-branch in SYMBOL_LIBRARY_MANAGER::SaveLibrary.
    {
        IO_RELEASER<SCH_IO> srcPlugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        IO_RELEASER<SCH_IO> dstPlugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        std::map<std::string, UTF8> properties;
        properties.emplace( SCH_IO_KICAD_SEXPR::PropBuffering, "" );
 
        LIB_SYMBOL* loadedParent = srcPlugin->LoadSymbol( srcPath, wxS( "Parent" ) );
        LIB_SYMBOL* loadedDerived = srcPlugin->LoadSymbol( srcPath, wxS( "Derived" ) );
        BOOST_REQUIRE( loadedParent != nullptr );
        BOOST_REQUIRE( loadedDerived != nullptr );
 
        // Buffer symbols into the destination plugin using the target path (which
        // does not exist yet). This must not throw.
        BOOST_CHECK_NO_THROW(
                dstPlugin->SaveSymbol( dstPath, std::make_unique<LIB_SYMBOL>( *loadedParent ),
                                       &properties ) );
 
        auto newDerived = std::make_unique<LIB_SYMBOL>( *loadedDerived );
        LIB_SYMBOL* dstParent = dstPlugin->LoadSymbol( dstPath, wxS( "Parent" ), &properties );
        BOOST_REQUIRE( dstParent != nullptr );
        newDerived->SetParent( dstParent );
 
        BOOST_CHECK_NO_THROW(
                dstPlugin->SaveSymbol( dstPath, std::move( newDerived ), &properties ) );
 
        BOOST_CHECK_NO_THROW( dstPlugin->SaveLibrary( dstPath ) );
    }
 
    // Reload the destination library and verify both symbols are present
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
 
        LIB_SYMBOL* parent = plugin->LoadSymbol( dstPath, wxS( "Parent" ) );
        LIB_SYMBOL* derived = plugin->LoadSymbol( dstPath, wxS( "Derived" ) );
 
        BOOST_CHECK_MESSAGE( parent != nullptr,
                             "Parent symbol should exist in the saved-as library" );
        BOOST_CHECK_MESSAGE( derived != nullptr,
                             "Derived symbol should exist in the saved-as library" );
 
        if( derived )
            BOOST_CHECK( derived->IsDerived() );
    }
 
    if( wxFileName::DirExists( tempDir ) )
        wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
}
 

BOOST_AUTO_TEST_CASE( SetParentKeepsParentNameInSync )
{
    auto parent = std::make_unique<LIB_SYMBOL>( wxS( "BaseSymbol" ) );
 
    LIB_SYMBOL derived( wxS( "DerivedSymbol" ) );
    BOOST_CHECK( derived.GetParentName().IsEmpty() );
 
    derived.SetParent( parent.get() );
    BOOST_CHECK( derived.IsDerived() );
    BOOST_CHECK_EQUAL( derived.GetParentName(), wxS( "BaseSymbol" ) );
 
    // Detaching the live pointer must not erase the recorded name, so a derived symbol whose live
    // parent has been lost can still be serialized by name.
    derived.SetParent( static_cast<LIB_SYMBOL*>( nullptr ) );
    BOOST_CHECK_EQUAL( derived.GetParent().lock(), nullptr );
    BOOST_CHECK_EQUAL( derived.GetParentName(), wxS( "BaseSymbol" ) );
}
 

BOOST_AUTO_TEST_CASE( SerializeDerivedSymbolUsesParentName )
{
    auto parent = std::make_unique<LIB_SYMBOL>( wxS( "BaseSymbol" ) );
    parent->GetValueField().SetText( wxS( "BaseSymbol" ) );
    parent->GetReferenceField().SetText( wxS( "U" ) );
 
    LIB_SYMBOL derived( wxS( "DerivedSymbol" ) );
    derived.SetParent( parent.get() );
    derived.GetValueField().SetText( wxS( "DerivedSymbol" ) );
 
    BOOST_REQUIRE( derived.IsDerived() );
 
    // Force the recorded name to differ from the live parent's name. The writer must emit the
    // recorded name, proving it does not read through the live (potentially dangling) pointer.
    derived.SetParentName( wxS( "RecordedParent" ) );
 
    STRING_FORMATTER formatter;
 
    BOOST_REQUIRE_NO_THROW(
            SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( &derived, formatter, wxEmptyString, true ) );
 
    const std::string out = formatter.GetString();
 
    BOOST_CHECK_MESSAGE( out.find( "(extends \"RecordedParent\")" ) != std::string::npos,
                         "Derived symbol should serialize (extends ...) using the recorded parent name" );
}
 

BOOST_AUTO_TEST_CASE( SaveCopyAsDerivedSymbolToNewLibrary )
{
    wxString tempDir = wxFileName::CreateTempFileName( wxS( "kicad_test_" ) );
    wxRemoveFile( tempDir );
    wxFileName::Mkdir( tempDir );
 
    wxString dstPath = wxFileName( tempDir, wxS( "copy_target.kicad_sym" ) ).GetFullPath();
 
    // Build an in-memory parent/derived pair like the symbol editor holds while editing.
    auto parent = std::make_unique<LIB_SYMBOL>( wxS( "BaseSymbol" ) );
    parent->GetValueField().SetText( wxS( "BaseSymbol" ) );
    parent->GetReferenceField().SetText( wxS( "U" ) );
 
    auto derived = std::make_unique<LIB_SYMBOL>( wxS( "DerivedSymbol" ) );
    derived->SetParent( parent.get() );
    derived->SetParentName( parent->GetName() );
    derived->GetValueField().SetText( wxS( "DerivedSymbol" ) );
 
    // Save the parent then the child to a brand new library, mirroring SYMBOL_SAVE_AS_HANDLER.
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
        std::map<std::string, UTF8> properties;
        properties.emplace( SCH_IO_KICAD_SEXPR::PropBuffering, "" );
 
        BOOST_CHECK_NO_THROW(
                plugin->SaveSymbol( dstPath, std::make_unique<LIB_SYMBOL>( *parent ), &properties ) );
 
        LIB_SYMBOL* dstParent = plugin->LoadSymbol( dstPath, wxS( "BaseSymbol" ), &properties );
        BOOST_REQUIRE( dstParent != nullptr );
 
        auto newChild = std::make_unique<LIB_SYMBOL>( *derived );
        newChild->SetParent( dstParent );
        newChild->SetParentName( dstParent->GetName() );
 
        BOOST_CHECK_NO_THROW( plugin->SaveSymbol( dstPath, std::move( newChild ), &properties ) );
        BOOST_CHECK_NO_THROW( plugin->SaveLibrary( dstPath ) );
    }
 
    // Reload and verify the derived symbol survived with a valid parent.
    {
        IO_RELEASER<SCH_IO> plugin( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
 
        LIB_SYMBOL* reloadedParent = plugin->LoadSymbol( dstPath, wxS( "BaseSymbol" ) );
        LIB_SYMBOL* reloadedChild = plugin->LoadSymbol( dstPath, wxS( "DerivedSymbol" ) );
 
        BOOST_CHECK( reloadedParent != nullptr );
        BOOST_REQUIRE( reloadedChild != nullptr );
        BOOST_CHECK( reloadedChild->IsDerived() );
        BOOST_CHECK_EQUAL( reloadedChild->GetParent().lock().get(), reloadedParent );
    }
 
    if( wxFileName::DirExists( tempDir ) )
        wxFileName::Rmdir( tempDir, wxPATH_RMDIR_RECURSIVE );
}
 

BOOST_AUTO_TEST_CASE( DerivedSymbolNamesForUnbufferedSymbol )
{
    LIB_BUFFER libBuffer( wxS( "TestLibrary" ) );
 
    auto        parent = std::make_unique<LIB_SYMBOL>( wxS( "Parent" ) );
    LIB_SYMBOL& parentRef = *parent;
 
    libBuffer.CreateBuffer( std::move( parent ), std::make_unique<SCH_SCREEN>() );
 
    auto child = std::make_unique<LIB_SYMBOL>( wxS( "Child" ) );
    child->SetParent( &parentRef );
    libBuffer.CreateBuffer( std::move( child ), std::make_unique<SCH_SCREEN>() );
 
    wxArrayString names;
 
    BOOST_CHECK_EQUAL( libBuffer.GetDerivedSymbolNames( wxS( "NeverBuffered" ), names ), 0 );
    BOOST_CHECK( names.IsEmpty() );
 
    // Deleting a symbol drops it from the buffer while the tree selection and the open symbol can
    // still name it.
    std::shared_ptr<SYMBOL_BUFFER> parentBuf = libBuffer.GetBuffer( wxS( "Parent" ) );
    BOOST_REQUIRE( parentBuf != nullptr );
    BOOST_CHECK( libBuffer.DeleteBuffer( *parentBuf ) );
    BOOST_CHECK( libBuffer.GetSymbol( wxS( "Parent" ) ) == nullptr );
 
    names.Clear();
    BOOST_CHECK_EQUAL( libBuffer.GetDerivedSymbolNames( wxS( "Parent" ), names ), 0 );
    BOOST_CHECK( names.IsEmpty() );
}
 

BOOST_AUTO_TEST_CASE( DerivedSymbolNamesAcrossRebufferedParent )
{
    // The originals, as the library adapter owns them.  The buffer only ever holds copies.
    auto originalRoot = std::make_unique<LIB_SYMBOL>( wxS( "Root" ) );
    auto originalMid = std::make_unique<LIB_SYMBOL>( wxS( "Mid" ) );
    auto originalLeaf = std::make_unique<LIB_SYMBOL>( wxS( "Leaf" ) );
 
    originalMid->SetParent( originalRoot.get() );
    originalLeaf->SetParent( originalMid.get() );
 
    LIB_BUFFER libBuffer( wxS( "TestLibrary" ) );
 
    // Reaching Leaf first buffers a copy of Mid whose parent link still points at the unbuffered
    // original Root.
    auto        midCopy = std::make_unique<LIB_SYMBOL>( *originalMid );
    LIB_SYMBOL* midCopyPtr = midCopy.get();
 
    libBuffer.CreateBuffer( std::move( midCopy ), std::make_unique<SCH_SCREEN>() );
 
    auto leafCopy = std::make_unique<LIB_SYMBOL>( *originalLeaf );
    leafCopy->SetParent( midCopyPtr );
    libBuffer.CreateBuffer( std::move( leafCopy ), std::make_unique<SCH_SCREEN>() );
 
    auto        rootCopy = std::make_unique<LIB_SYMBOL>( *originalRoot );
    LIB_SYMBOL* rootCopyPtr = rootCopy.get();
 
    libBuffer.CreateBuffer( std::move( rootCopy ), std::make_unique<SCH_SCREEN>() );
 
    // Reaching Mid itself then buffers a second copy, this time parented to the buffered Root.
    // The duplicate entry is a separate getLibraryBuffer() defect; the walk has to tolerate it.
    auto midDuplicate = std::make_unique<LIB_SYMBOL>( *originalMid );
    midDuplicate->SetParent( rootCopyPtr );
    libBuffer.CreateBuffer( std::move( midDuplicate ), std::make_unique<SCH_SCREEN>() );
 
    wxArrayString names;
 
    BOOST_CHECK_EQUAL( libBuffer.GetDerivedSymbolNames( wxS( "Root" ), names ), 2 );
    BOOST_CHECK( names.Index( wxS( "Mid" ) ) != wxNOT_FOUND );
    BOOST_CHECK( names.Index( wxS( "Leaf" ) ) != wxNOT_FOUND );
 
    // HasDerivedSymbols() has always matched on the name.  The two have to agree or DeleteBuffer()
    // reports failure and orphans the children it did not remove.
    BOOST_CHECK( libBuffer.HasDerivedSymbols( wxS( "Root" ) ) );
    BOOST_CHECK( libBuffer.HasDerivedSymbols( wxS( "Mid" ) ) );
}
 

BOOST_AUTO_TEST_CASE( DerivedSymbolNamesExcludeRootFromNameCycle )
{
    // Unbuffered originals that close the cycle by name
    auto originalA = std::make_unique<LIB_SYMBOL>( wxS( "A" ) );
    auto originalB = std::make_unique<LIB_SYMBOL>( wxS( "B" ) );
 
    LIB_BUFFER libBuffer( wxS( "TestLibrary" ) );
 
    auto symbolA = std::make_unique<LIB_SYMBOL>( wxS( "A" ) );
    symbolA->SetParent( originalB.get() );
    libBuffer.CreateBuffer( std::move( symbolA ), std::make_unique<SCH_SCREEN>() );
 
    auto symbolB = std::make_unique<LIB_SYMBOL>( wxS( "B" ) );
    symbolB->SetParent( originalA.get() );
    libBuffer.CreateBuffer( std::move( symbolB ), std::make_unique<SCH_SCREEN>() );
 
    wxArrayString names;
 
    BOOST_CHECK_EQUAL( libBuffer.GetDerivedSymbolNames( wxS( "A" ), names ), 1 );
    BOOST_REQUIRE_EQUAL( names.GetCount(), 1 );
    BOOST_CHECK_EQUAL( names[0], wxS( "B" ) );
 
    std::shared_ptr<SYMBOL_BUFFER> bufferA = libBuffer.GetBuffer( wxS( "A" ) );
    BOOST_REQUIRE( bufferA != nullptr );
    BOOST_CHECK( libBuffer.DeleteBuffer( *bufferA ) );
    BOOST_CHECK( libBuffer.GetBuffers().empty() );
}
 
 
BOOST_AUTO_TEST_SUITE_END()