From 4cf22e428ca9a8d12b727d42387a44767d51ca27 Mon Sep 17 00:00:00 2001
From: Wayne Stambaugh <stambaughw@gmail.com>
Date: Mon, 22 Jan 2024 16:55:29 -0500
Subject: [PATCH] Fix broken pasted sheet page numbering.

This change no longer sorts pasted sheets by page number.  This was done
because pasted sheets may not be numbered.  When sheets are not numbered
they are sorted by UUID path which results in some unexpected results.
Since the pasted sheet code uses recursion, pages will be numbered in the
order they are added.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/16580
---
 eeschema/tools/sch_editor_control.cpp | 30 +++++++++++++++++++--------
 1 file changed, 21 insertions(+), 9 deletions(-)

diff --git a/eeschema/tools/sch_editor_control.cpp b/eeschema/tools/sch_editor_control.cpp
index 53864837e8..9119fb0e1a 100644
--- a/eeschema/tools/sch_editor_control.cpp
+++ b/eeschema/tools/sch_editor_control.cpp
@@ -1468,7 +1468,8 @@ void SCH_EDITOR_CONTROL::updatePastedSymbol( SCH_SYMBOL* aSymbol, SCH_SCREEN* aP
 
 
 SCH_SHEET_PATH SCH_EDITOR_CONTROL::updatePastedSheet( const SCH_SHEET_PATH& aPastePath,
-                                                      const KIID_PATH& aClipPath, SCH_SHEET* aSheet,
+                                                      const KIID_PATH& aClipPath,
+                                                      SCH_SHEET* aSheet,
                                                       bool aForceKeepAnnotations,
                                                       SCH_SHEET_LIST* aPastedSheetsSoFar,
                                                       SCH_REFERENCE_LIST* aPastedSymbolsSoFar )
@@ -1479,6 +1480,8 @@ SCH_SHEET_PATH SCH_EDITOR_CONTROL::updatePastedSheet( const SCH_SHEET_PATH& aPas
     sheetPath.push_back( aSheet );
 
     aPastedSheetsSoFar->push_back( sheetPath );
+    wxLogDebug( wxS( "Adding pasted sheet path: %s from clipboard path: %s." ),
+                sheetPath.Path().AsString(), aClipPath.AsString() );
 
     if( aSheet->GetScreen() == nullptr )
         return sheetPath; // We can only really set the page number but not load any items
@@ -1930,15 +1933,11 @@ int SCH_EDITOR_CONTROL::Paste( const TOOL_EVENT& aEvent )
         getView()->Hide( item, true );
     }
 
-    sheetPathsForScreen.SortByPageNumbers();
-
     if( sheetsPasted )
     {
         // Update page numbers: Find next free numeric page number
         for( SCH_SHEET_PATH& sheetPath : sheetPathsForScreen )
         {
-            pastedSheets[sheetPath].SortByPageNumbers();
-
             for( SCH_SHEET_PATH& pastedSheet : pastedSheets[sheetPath] )
             {
                 int      page = 1;
@@ -1947,14 +1946,27 @@ int SCH_EDITOR_CONTROL::Paste( const TOOL_EVENT& aEvent )
                 while( hierarchy.PageNumberExists( pageNum ) )
                     pageNum = wxString::Format( "%d", ++page );
 
-                pastedSheet.SetPageNumber( pageNum );
+                wxLogDebug( wxS( "Setting sheet path %s instance." ),
+                            pastedSheet.Path().AsString() );
+
+                SCH_SHEET_INSTANCE sheetInstance;
+
+                sheetInstance.m_Path = pastedSheet.Path();
+
+                // Don't include the actual sheet in the instance path.
+                sheetInstance.m_Path.pop_back();
+                sheetInstance.m_PageNumber = pageNum;
+                sheetInstance.m_ProjectName = m_frame->Prj().GetProjectName();
+
+                SCH_SHEET* sheet = pastedSheet.Last();
+
+                wxCHECK2( sheet, continue );
+
+                sheet->AddInstance( sheetInstance );
                 hierarchy.push_back( pastedSheet );
 
                 // Remove all pasted sheet instance data that is not part of the current project.
                 std::vector<KIID_PATH> instancesToRemove;
-                SCH_SHEET* sheet = pastedSheet.Last();
-
-                wxCHECK2( sheet, continue );
 
                 for( const SCH_SHEET_INSTANCE& instance : sheet->GetInstances() )
                 {