Change the bus selection behavior of the schematic net highlight tool.

[CHANGED] Bus highlight tool now supports toggling between highlighting
          only the bus objects and highlighting the bus and all of the
          bus member objects.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/15388

(cherry picked from commit f6c99816b2)

eeschema/tools/sch_editor_control.cpp

@@ -806,18 +806,20 @@ static bool highlightNet( TOOL_MANAGER* aToolMgr, const VECTOR2D& aPosition )
         }
     }
 
-    wxString connectionName = ( conn ) ? conn->Name() : wxS( "" );
+    wxString connectionName = ( conn ) ? conn->Name() : wxString( wxS( "" ) );
 
     if( !conn || connectionName == editFrame->GetHighlightedConnection() )
     {
         editFrame->SetStatusText( wxT( "" ) );
         editFrame->SendCrossProbeClearHighlight();
         editFrame->SetHighlightedConnection( wxEmptyString );
+        editorControl->SetHighlightBusMembers( false );
     }
     else
     {
         editFrame->SetCrossProbeConnection( conn );
         editFrame->SetHighlightedConnection( connectionName );
+        editorControl->SetHighlightBusMembers( false );
     }
 
     editFrame->UpdateNetHighlightStatus();
@@ -1014,39 +1016,141 @@ int SCH_EDITOR_CONTROL::AssignNetclass( const TOOL_EVENT& aEvent )
 
 int SCH_EDITOR_CONTROL::UpdateNetHighlighting( const TOOL_EVENT& aEvent )
 {
+    wxCHECK( m_frame, 0 );
+
+    const SCH_SHEET_PATH&  sheetPath = m_frame->GetCurrentSheet();
     SCH_SCREEN*            screen = m_frame->GetCurrentSheet().LastScreen();
     CONNECTION_GRAPH*      connectionGraph = m_frame->Schematic().ConnectionGraph();
+    wxString               selectedName = m_frame->GetHighlightedConnection();
+
+    std::set<wxString>     connNames;
     std::vector<EDA_ITEM*> itemsToRedraw;
 
     wxCHECK( screen && connectionGraph, 0 );
 
-    bool     selectedIsBus = false;
+    if( !selectedName.IsEmpty() )
-    wxString selectedName  = m_frame->GetHighlightedConnection();
+    {
+        connNames.emplace( selectedName );
 
-    bool                 selectedIsNoNet  = false;
+        if( m_highlightBusMembers )
-    CONNECTION_SUBGRAPH* selectedSubgraph = nullptr;
+        {
+            CONNECTION_SUBGRAPH* sg = connectionGraph->FindSubgraphByName( selectedName,
+                                                                           sheetPath );
+
+            wxCHECK( sg, 0 );
+
+            for( const SCH_ITEM* item : sg->GetItems() )
+            {
+                wxCHECK2( item, continue );
+
+                SCH_CONNECTION* connection = item->Connection();
+
+                wxCHECK2( connection, continue );
+
+                for( const std::shared_ptr<SCH_CONNECTION>& member : connection->AllMembers() )
+                {
+                    if( member )
+                        connNames.emplace( member->Name() );
+                }
+            }
+        }
+    }
 
     for( SCH_ITEM* item : screen->Items() )
     {
-        bool redraw    = item->IsBrightened();
+        wxCHECK2( item, continue );
-        bool highlight = false;
 
-        if( !selectedName.IsEmpty() )
+        if( !item->IsConnectable() )
-        {
+            continue;
-            SCH_CONNECTION* itemConn  = nullptr;
+
-            SCH_SYMBOL*     symbol    = nullptr;
+        SCH_ITEM* redrawItem = nullptr;
 
         if( item->Type() == SCH_SYMBOL_T )
-                symbol = static_cast<SCH_SYMBOL*>( item );
-
-            if( symbol && symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->IsPower() )
-                itemConn = symbol->Connection();
-            else
-                itemConn = item->Connection();
-
-            if( itemConn && ( selectedName == itemConn->Name() ) )
         {
-                selectedIsBus = itemConn->IsBus();
+            SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
+
+            wxCHECK2( symbol, continue );
+
+            for( SCH_PIN* pin : symbol->GetPins() )
+            {
+                SCH_CONNECTION* pin_conn = pin->Connection();
+
+                wxCHECK2( pin_conn, continue );
+
+                if( !pin->IsBrightened() && connNames.count( pin_conn->Name() ) )
+                {
+                    pin->SetBrightened();
+                    redrawItem = symbol;
+                }
+                else if( pin->IsBrightened() && !connNames.count( pin_conn->Name() ) )
+                {
+                    pin->ClearBrightened();
+                    redrawItem = symbol;
+                }
+            }
+
+            if( symbol->IsPower() )
+            {
+                wxCHECK2( symbol->GetPins().size(), continue );
+
+                SCH_CONNECTION* pinConn = symbol->GetPins()[0]->Connection();
+
+                wxCHECK2( pinConn, continue );
+
+                std::vector<SCH_FIELD>& fields = symbol->GetFields();
+
+                for( int id : { REFERENCE_FIELD, VALUE_FIELD } )
+                {
+                    if( !fields[id].IsVisible() )
+                        continue;
+
+                    if( !item->IsBrightened() && connNames.count( pinConn->Name() ) )
+                    {
+                        fields[id].SetBrightened();
+                        redrawItem = symbol;
+                    }
+                    else if( item->IsBrightened() && !connNames.count( pinConn->Name() ) )
+                    {
+                        fields[id].ClearBrightened();
+                        redrawItem = symbol;
+                    }
+                }
+            }
+        }
+        else if( item->Type() == SCH_SHEET_T )
+        {
+            SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
+
+            wxCHECK2( sheet, continue );
+
+            for( SCH_SHEET_PIN* pin : sheet->GetPins() )
+            {
+                wxCHECK2( pin, continue );
+
+                SCH_CONNECTION* pin_conn = pin->Connection();
+
+                wxCHECK2( pin_conn, continue );
+
+                if( !pin->IsBrightened() && connNames.count( pin_conn->Name() ) )
+                {
+                    pin->SetBrightened();
+                    redrawItem = sheet;
+                }
+                else if( pin->IsBrightened() && !connNames.count( pin_conn->Name() ) )
+                {
+                    pin->ClearBrightened();
+                    redrawItem = sheet;
+                }
+            }
+        }
+        else
+        {
+            SCH_CONNECTION* itemConn = item->Connection();
+
+            wxCHECK2( itemConn, continue );
+
+            bool selectedIsNoNet = false;
+            CONNECTION_SUBGRAPH* selectedSubgraph = nullptr;
 
             if( itemConn->Driver() == nullptr )
             {
@@ -1058,104 +1162,39 @@ int SCH_EDITOR_CONTROL::UpdateNetHighlighting( const TOOL_EVENT& aEvent )
             {
                 for( SCH_ITEM* subgraphItem : selectedSubgraph->GetItems() )
                 {
-                        if( item == subgraphItem )
+                    if( !item->IsBrightened() && ( item == subgraphItem ) )
                     {
-                            highlight = true;
-                            break;
-                        }
-                    }
-                }
-                else if( selectedIsBus && itemConn && itemConn->IsNet() )
-                {
-                    for( const std::shared_ptr<SCH_CONNECTION>& member : itemConn->Members() )
-                    {
-                        if( member->Name() == itemConn->Name() )
-                        {
-                            highlight = true;
-                            break;
-                        }
-                        else if( member->IsBus() )
-                        {
-                            for( const std::shared_ptr<SCH_CONNECTION>& bus_member :
-                                 member->Members() )
-                            {
-                                if( bus_member->Name() == itemConn->Name() )
-                                {
-                                    highlight = true;
-                                    break;
-                                }
-                            }
-                        }
-                    }
-                }
-                else if( !selectedName.IsEmpty() && itemConn
-                       && ( selectedName == itemConn->Name() ) )
-                {
-                    highlight = true;
-                }
-            }
-        }
-
-        if( highlight )
                         item->SetBrightened();
-        else
+                        redrawItem = item;
+                    }
+                    else if( item->IsBrightened() && ( item != subgraphItem ) )
+                    {
                         item->ClearBrightened();
-
+                        redrawItem = item;
-        redraw |= item->IsBrightened();
+                    }
-
-        if( item->Type() == SCH_SYMBOL_T )
-        {
-            SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
-
-            redraw |= symbol->HasBrightenedPins();
-
-            symbol->ClearBrightenedPins();
-
-            for( SCH_PIN* pin : symbol->GetPins() )
-            {
-                SCH_CONNECTION* pin_conn = pin->Connection();
-
-                if( pin_conn && pin_conn->Name() == selectedName )
-                {
-                    pin->SetBrightened();
-                    redraw = true;
                 }
             }
-
-            if( symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->IsPower() )
-            {
-                std::vector<SCH_FIELD>& fields = symbol->GetFields();
-
-                for( int id : { REFERENCE_FIELD, VALUE_FIELD } )
-                {
-                    if( item->IsBrightened() && fields[id].IsVisible() )
-                        fields[id].SetBrightened();
             else
-                        fields[id].ClearBrightened();
-                }
-            }
-        }
-        else if( item->Type() == SCH_SHEET_T )
             {
-            for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( item )->GetPins() )
+                if( !item->IsBrightened() && connNames.count( itemConn->Name() ) )
                 {
-                SCH_CONNECTION* pin_conn = pin->Connection();
+                    item->SetBrightened();
-                bool            redrawPin = pin->IsBrightened();
+                    redrawItem = item;
-
+                }
-                if( pin_conn && pin_conn->Name() == selectedName )
+                else if( item->IsBrightened() && !connNames.count( itemConn->Name() ) )
-                    pin->SetBrightened();
+                {
-                else
+                    item->ClearBrightened();
-                    pin->ClearBrightened();
+                    redrawItem = item;
-
+                }
-                redrawPin ^= pin->IsBrightened();
-                redraw    |= redrawPin;
             }
         }
 
-        if( redraw )
+        if( redrawItem )
-            itemsToRedraw.push_back( item );
+            itemsToRedraw.push_back( redrawItem );
     }
 
+    if( itemsToRedraw.size() )
+    {
         // Be sure highlight change will be redrawn
         KIGFX::VIEW* view = getView();
 
@@ -1163,6 +1202,7 @@ int SCH_EDITOR_CONTROL::UpdateNetHighlighting( const TOOL_EVENT& aEvent )
             view->Update( (KIGFX::VIEW_ITEM*)redrawItem, KIGFX::VIEW_UPDATE_FLAGS::REPAINT );
 
         m_frame->GetCanvas()->Refresh();
+    }
 
     return 0;
 }

eeschema/tools/sch_editor_control.h

@@ -42,7 +42,8 @@ public:
             EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.EditorControl" ),
             m_probingPcbToSch( false ),
             m_pickerItem( nullptr ),
-            m_duplicateIsHoverSelection( false )
+            m_duplicateIsHoverSelection( false ),
+            m_highlightBusMembers( false )
     { }
 
     ~SCH_EDITOR_CONTROL() { }
@@ -157,6 +158,13 @@ public:
                                  bool aSearchHierarchy, SCH_SEARCH_T aSearchType,
                                  const wxString& aSearchText );
 
+    void SetHighlightBusMembers( bool aHighlightBusMembers )
+    {
+        m_highlightBusMembers = aHighlightBusMembers;
+    }
+
+    bool GetHighlightBusMembers() const { return m_highlightBusMembers; }
+
 private:
     ///< copy selection to clipboard or to m_duplicateClipboard
     bool doCopy( bool aUseDuplicateClipboard = false );
@@ -211,6 +219,8 @@ private:
     std::string m_duplicateClipboard;       // Temporary storage for Duplicate action
     bool        m_duplicateIsHoverSelection;
 
+    bool        m_highlightBusMembers;
+
     // A map of sheet filename --> screens for the clipboard contents.  We use these to hook up
     // cut/paste operations for unsaved sheet content.
     std::map<wxString, SCH_SCREEN*>          m_supplementaryClipboard;