From 4bcd56b1f6e723baa2b3181a81047424ab253e6d Mon Sep 17 00:00:00 2001
From: david-beinder <david.beinder@mce.li>
Date: Thu, 21 Jan 2021 17:51:45 +0100
Subject: [PATCH] Always include unit number when copying to clipboard Fixes
 https://gitlab.com/kicad/code/kicad/issues/5898 (A)

---
 .../sch_plugins/kicad/sch_sexpr_plugin.cpp     | 18 +++++++++++++-----
 eeschema/sch_plugins/kicad/sch_sexpr_plugin.h  |  5 +++--
 eeschema/tools/sch_editor_control.cpp          |  2 +-
 3 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/eeschema/sch_plugins/kicad/sch_sexpr_plugin.cpp b/eeschema/sch_plugins/kicad/sch_sexpr_plugin.cpp
index 16330ea577..36ea6ddc53 100644
--- a/eeschema/sch_plugins/kicad/sch_sexpr_plugin.cpp
+++ b/eeschema/sch_plugins/kicad/sch_sexpr_plugin.cpp
@@ -636,7 +636,7 @@ void SCH_SEXPR_PLUGIN::Format( SCH_SHEET* aSheet )
         {
         case SCH_COMPONENT_T:
             m_out->Print( 0, "\n" );
-            saveSymbol( static_cast<SCH_COMPONENT*>( item ), 1 );
+            saveSymbol( static_cast<SCH_COMPONENT*>( item ), nullptr, 1 );
             break;
 
         case SCH_BITMAP_T:
@@ -776,7 +776,8 @@ void SCH_SEXPR_PLUGIN::Format( SCH_SHEET* aSheet )
 }
 
 
-void SCH_SEXPR_PLUGIN::Format( EE_SELECTION* aSelection, OUTPUTFORMATTER* aFormatter )
+void SCH_SEXPR_PLUGIN::Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSheetPath, 
+                               OUTPUTFORMATTER* aFormatter )
 {
     wxCHECK( aSelection && aFormatter, /* void */ );
 
@@ -830,7 +831,7 @@ void SCH_SEXPR_PLUGIN::Format( EE_SELECTION* aSelection, OUTPUTFORMATTER* aForma
         switch( item->Type() )
         {
         case SCH_COMPONENT_T:
-            saveSymbol( static_cast< SCH_COMPONENT* >( item ), 0 );
+            saveSymbol( static_cast<SCH_COMPONENT*>( item ), aSheetPath, 0 );
             break;
 
         case SCH_BITMAP_T:
@@ -872,7 +873,8 @@ void SCH_SEXPR_PLUGIN::Format( EE_SELECTION* aSelection, OUTPUTFORMATTER* aForma
 }
 
 
-void SCH_SEXPR_PLUGIN::saveSymbol( SCH_COMPONENT* aSymbol, int aNestLevel )
+void SCH_SEXPR_PLUGIN::saveSymbol( SCH_COMPONENT* aSymbol, SCH_SHEET_PATH* aSheetPath,
+                                   int aNestLevel )
 {
     wxCHECK_RET( aSymbol != nullptr && m_out != nullptr, "" );
 
@@ -934,8 +936,14 @@ void SCH_SEXPR_PLUGIN::saveSymbol( SCH_COMPONENT* aSymbol, int aNestLevel )
         m_out->Print( 0, ")" );
     }
 
+    int unit = -1;
+
     if( !( aSymbol->GetInstanceReferences().size() > 1 ) )
-        m_out->Print( 0, " (unit %d)", aSymbol->GetUnit() );
+        unit = aSymbol->GetUnit();
+    else if( aSheetPath != nullptr )
+        unit = aSymbol->GetUnitSelection( aSheetPath );
+    if ( unit >= 0 )
+        m_out->Print( 0, " (unit %d)", unit );
 
     if( aSymbol->GetConvert() == LIB_ITEM::LIB_CONVERT::DEMORGAN )
         m_out->Print( 0, " (convert %d)", aSymbol->GetConvert() );
diff --git a/eeschema/sch_plugins/kicad/sch_sexpr_plugin.h b/eeschema/sch_plugins/kicad/sch_sexpr_plugin.h
index a1cfb21876..aed2618ba7 100644
--- a/eeschema/sch_plugins/kicad/sch_sexpr_plugin.h
+++ b/eeschema/sch_plugins/kicad/sch_sexpr_plugin.h
@@ -96,7 +96,8 @@ public:
 
     void Format( SCH_SHEET* aSheet );
 
-    void Format( EE_SELECTION* aSelection, OUTPUTFORMATTER* aFormatter );
+    void Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSheetPath,
+                 OUTPUTFORMATTER* aFormatter );
 
     void EnumerateSymbolLib( wxArrayString&    aSymbolNameList,
                              const wxString&   aLibraryPath,
@@ -130,7 +131,7 @@ private:
     void loadHierarchy( SCH_SHEET* aSheet );
     void loadFile( const wxString& aFileName, SCH_SHEET* aSheet );
 
-    void saveSymbol( SCH_COMPONENT* aComponent, int aNestLevel );
+    void saveSymbol( SCH_COMPONENT* aComponent, SCH_SHEET_PATH* aSheetPath, int aNestLevel );
     void saveField( SCH_FIELD* aField, int aNestLevel );
     void saveBitmap( SCH_BITMAP* aBitmap, int aNestLevel );
     void saveSheet( SCH_SHEET* aSheet, int aNestLevel );
diff --git a/eeschema/tools/sch_editor_control.cpp b/eeschema/tools/sch_editor_control.cpp
index 4591918fe6..87850fbfeb 100644
--- a/eeschema/tools/sch_editor_control.cpp
+++ b/eeschema/tools/sch_editor_control.cpp
@@ -1238,7 +1238,7 @@ bool SCH_EDITOR_CONTROL::doCopy()
     STRING_FORMATTER formatter;
     SCH_SEXPR_PLUGIN plugin;
 
-    plugin.Format( &selection, &formatter );
+    plugin.Format( &selection, &m_frame->GetCurrentSheet(), &formatter );
 
     return m_toolMgr->SaveClipboard( formatter.GetString() );
 }