test_issue24044_expression_net_names.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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>
#include <schematic_utils/schematic_file_util.h>
 
#include <schematic.h>
#include <schematic_settings.h>
#include <algorithm>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
#include <sch_sheet_pin.h>
#include <sch_screen.h>
#include <sch_label.h>
#include <settings/settings_manager.h>
#include <locale_io.h>
 
 
struct ISSUE_24044_FIXTURE
{
    SETTINGS_MANAGER           m_settingsManager;
    std::unique_ptr<SCHEMATIC> m_schematic;
};
 

BOOST_FIXTURE_TEST_CASE( Issue24044ExpressionNetNames, ISSUE_24044_FIXTURE )
{
    LOCALE_IO dummy;
 
    KI_TEST::LoadSchematic( m_settingsManager, "issue24044/issue24044", m_schematic );
 
    SCH_SHEET_LIST hierarchy = m_schematic->Hierarchy();
 
    // Collect the two sub-sheet instance paths (both reference channels.kicad_sch but on
    // different pages).
    std::vector<SCH_SHEET_PATH> childPaths;
 
    for( const SCH_SHEET_PATH& path : hierarchy )
    {
        if( path.size() == 2 )
            childPaths.push_back( path );
    }
 
    BOOST_REQUIRE_EQUAL( childPaths.size(), 2U );
 
    for( const SCH_SHEET_PATH& childPath : childPaths )
    {
        SCH_SHEET* childSheet = childPath.Last();
        BOOST_REQUIRE( childSheet );
 
        // Build the lookup on the child sheet's hierarchical labels
        std::set<wxString> labelTexts;
 
        for( SCH_ITEM* item : childSheet->GetScreen()->Items() )
        {
            if( item->Type() == SCH_HIER_LABEL_T )
            {
                SCH_HIERLABEL* label = static_cast<SCH_HIERLABEL*>( item );
                labelTexts.insert( label->GetShownText( &childPath, INTERNAL ) );
            }
        }
 
        wxString labelList;
 
        for( const wxString& t : labelTexts )
        {
            if( !labelList.IsEmpty() )
                labelList += wxT( "," );
 
            labelList += t;
        }
 
        // Every sheet pin's resolved name must appear in the child's hierarchical labels
        for( SCH_SHEET_PIN* pin : childSheet->GetPins() )
        {
            wxString pinText = pin->GetShownText( &childPath, INTERNAL );
 
            BOOST_CHECK_MESSAGE( !pinText.Contains( wxT( "@{" ) )
                                         && !pinText.Contains( wxT( "${" ) ),
                                 wxString::Format( "Sheet pin '%s' on path '%s' did not fully "
                                                   "resolve expression variables",
                                                   pinText,
                                                   childPath.PathHumanReadable() ) );
 
            BOOST_CHECK_MESSAGE( labelTexts.count( pinText ) == 1,
                                 wxString::Format( "Sheet pin '%s' on path '%s' has no matching "
                                                   "hierarchical label inside the child sheet. "
                                                   "Labels: [%s]",
                                                   pinText,
                                                   childPath.PathHumanReadable(),
                                                   labelList ) );
        }
    }
 
    // Each sheet instance should produce a different resolved name (the expression depends
    // on the page number, so the two instances must disambiguate).
    std::set<wxString> allPinTexts;
 
    for( const SCH_SHEET_PATH& childPath : childPaths )
    {
        for( SCH_SHEET_PIN* pin : childPath.Last()->GetPins() )
            allPinTexts.insert( pin->GetShownText( &childPath, INTERNAL ) );
    }
 
    BOOST_CHECK_EQUAL( allPinTexts.size(), 4U );
 
    // Verify the computed names match the expected formula for each page number
    for( const SCH_SHEET_PATH& childPath : childPaths )
    {
        long page = 0;
        BOOST_REQUIRE( childPath.GetPageNumber().ToLong( &page ) );
 
        std::set<wxString> expected = {
            wxString::Format( "Ch%ld", ( page - 2 ) * 2 + 0 ),
            wxString::Format( "Ch%ld", ( page - 2 ) * 2 + 1 )
        };
 
        std::set<wxString> actual;
 
        for( SCH_SHEET_PIN* pin : childPath.Last()->GetPins() )
            actual.insert( pin->GetShownText( &childPath, INTERNAL ) );
 
        wxString actualList;
 
        for( const wxString& t : actual )
        {
            if( !actualList.IsEmpty() )
                actualList += wxT( "," );
 
            actualList += t;
        }
 
        BOOST_CHECK_MESSAGE( actual == expected,
                             wxString::Format( "Page %ld expected {Ch%ld, Ch%ld} but got {%s}",
                                               page,
                                               ( page - 2 ) * 2 + 0,
                                               ( page - 2 ) * 2 + 1,
                                               actualList ) );
    }
}
 

BOOST_FIXTURE_TEST_CASE( Issue24044PathFormEquivalence, ISSUE_24044_FIXTURE )
{
    LOCALE_IO dummy;
 
    KI_TEST::LoadSchematic( m_settingsManager, "issue24044/issue24044", m_schematic );
 
    std::vector<SCH_SHEET_PATH> childPaths;
 
    for( const SCH_SHEET_PATH& path : m_schematic->Hierarchy() )
    {
        if( path.size() == 2 )
            childPaths.push_back( path );
    }
 
    BOOST_REQUIRE_EQUAL( childPaths.size(), 2U );
 
    for( const SCH_SHEET_PATH& childPath : childPaths )
    {
        SCH_SHEET* childSheet = childPath.Last();
        BOOST_REQUIRE( childSheet );
 
        // Build the parent-screen path (drop the trailing child sheet).  This is the path
        // shape that callers such as sch_selection_tool pass in.
        SCH_SHEET_PATH parentPath = childPath;
        parentPath.pop_back();
 
        BOOST_REQUIRE_EQUAL( parentPath.size() + 1U, childPath.size() );
 
        for( SCH_SHEET_PIN* pin : childSheet->GetPins() )
        {
            wxString fromChildPath  = pin->GetShownText( &childPath, INTERNAL );
            wxString fromParentPath = pin->GetShownText( &parentPath, INTERNAL );
 
            BOOST_CHECK_MESSAGE( fromChildPath == fromParentPath,
                                 wxString::Format( "Sheet pin resolution diverged between "
                                                   "path forms: child='%s' parent='%s'",
                                                   fromChildPath,
                                                   fromParentPath ) );
        }
    }
}
 
 
BOOST_FIXTURE_TEST_CASE( IntersheetReferencesUseTheRequestedInstance, ISSUE_24044_FIXTURE )
{
    LOCALE_IO locale;
    KI_TEST::LoadSchematic( m_settingsManager, "issue23840/BusAndVectors", m_schematic );
    std::vector<SCH_SHEET_PATH> paths;
 
    for( const auto& path : m_schematic->Hierarchy() )
    {
        if( path.LastScreen()->GetFileName().EndsWith( "LEDs.kicad_sch" ) )
            paths.push_back( path );
    }
 
    BOOST_REQUIRE_EQUAL( paths.size(), 2u );
    BOOST_REQUIRE( paths[0].LastScreen() == paths[1].LastScreen() );
    BOOST_REQUIRE( paths[0].GetPageNumber() != paths[1].GetPageNumber() );
    std::ranges::sort( paths, []( const auto& first, const auto& second )
    {
        return first.GetVirtualPageNumber() < second.GetVirtualPageNumber();
    } );
    auto sources = m_schematic->RootScreen()->Items().OfType( SCH_GLOBAL_LABEL_T );
    BOOST_REQUIRE( sources.begin() != sources.end() );
    auto* label = static_cast<SCH_GLOBALLABEL*>( ( *sources.begin() )->Duplicate( false ) );
    paths[0].LastScreen()->Append( label );
    auto& settings = m_schematic->Settings();
    settings.m_IntersheetRefsShow = false;
    settings.m_IntersheetRefsFormatShort = false;
    settings.m_IntersheetRefsPrefix.clear();
    settings.m_IntersheetRefsSuffix.clear();
 
    for( bool perPage : { false, true } )
    {
        label->SetText( perPage ? wxString( "R21_${#}" ) : wxString( "R21_SHARED" ) );
        m_schematic->RecomputeIntersheetRefs();
 
        for( bool ownPage : { false, true } )
        {
            settings.m_IntersheetRefsListOwnPage = ownPage;
 
            for( const auto& displayed : paths )
            {
                m_schematic->SetCurrentSheet( displayed );
 
                for( const auto& requested : paths )
                {
                    BOOST_TEST_CONTEXT( "per-page=" << perPage << " own-page=" << ownPage
                                        << " requested=" << requested.GetPageNumber()
                                        << " displayed=" << displayed.GetPageNumber() )
                    {
                        const wxString name = perPage ? "R21_" + requested.GetPageNumber()
                                                      : wxString( "R21_SHARED" );
                        BOOST_REQUIRE_EQUAL( label->GetShownText( &requested, FOR_GUI ), name );
                        std::vector<wxString> expected;
                        wxString expectedText;
 
                        for( const auto& other : paths )
                        {
                            if( ( perPage && other.Path() != requested.Path() )
                                || ( !ownPage && other.Path() == requested.Path() ) )
                                continue;
 
                            expected.push_back( other.GetPageNumber() );
 
                            if( !expectedText.IsEmpty() )
                                expectedText += ",";
 
                            expectedText += other.GetPageNumber();
                        }
 
                        std::vector<std::pair<wxString, wxString>> references;
                        label->GetIntersheetRefs( &requested, &references );
                        std::vector<wxString> actual;
 
                        for( const auto& [page, sheet] : references )
                            actual.push_back( page );
 
                        BOOST_TEST( actual == expected, boost::test_tools::per_element() );
                        wxString token = "INTERSHEET_REFS";
                        BOOST_REQUIRE( label->ResolveTextVar( &requested, &token, 0 ) );
                        BOOST_CHECK_EQUAL( token, expectedText );
                    }
                }
            }
        }
    }
}