From e517cad12bee6d389bcb294d5e702a448a37d8e6 Mon Sep 17 00:00:00 2001
From: Wayne Stambaugh <stambaughw@gmail.com>
Date: Wed, 30 Nov 2022 15:44:47 -0500
Subject: [PATCH] Fix broken hierarchical sheet file paths when adding nest
 sheets.

The file path for each sheet must always be relative to it's parent sheet
or absolute if using a relative path is not possible.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/10868
---
 eeschema/sheet.cpp | 53 ++++++++++++++++++++++++++--------------------
 1 file changed, 30 insertions(+), 23 deletions(-)

diff --git a/eeschema/sheet.cpp b/eeschema/sheet.cpp
index 0ff75f0591..e351670994 100644
--- a/eeschema/sheet.cpp
+++ b/eeschema/sheet.cpp
@@ -108,8 +108,6 @@ bool SCH_EDIT_FRAME::LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHier
     wxASSERT( aSheet && aHierarchy );
 
     wxString    msg;
-    wxString    topLevelSheetPath;
-    wxFileName  tmp;
     wxFileName  currentSheetFileName;
     bool        libTableChanged = false;
     SCH_IO_MGR::SCH_FILE_T schFileType = SCH_IO_MGR::GuessPluginTypeFromSchPath( aFileName );
@@ -168,36 +166,45 @@ bool SCH_EDIT_FRAME::LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHier
         return false;
     }
 
-    tmp = fileName;
-
     // If the loaded schematic is in a different folder from the current project and
     // it contains hierarchical sheets, the hierarchical sheet paths need to be updated.
     if( fileName.GetPathWithSep() != Prj().GetProjectPath() && newSheet->CountSheets() )
     {
-        // Give the user the option to choose relative path if possible.
-        if( tmp.MakeRelativeTo( Prj().GetProjectPath() ) )
-            topLevelSheetPath = tmp.GetPathWithSep();
-        else
-            topLevelSheetPath = fileName.GetPathWithSep();
+        SCH_SHEET_LIST loadedSheets( newSheet.get() );
 
-        if( wxFileName::GetPathSeparator() == '\\' )
-            topLevelSheetPath.Replace( "\\", "/" );
-
-        // Update the paths to the loaded sheets.
-        std::vector< SCH_ITEM* > sheetsInLoadedSchematic;
-
-        newSheet->GetScreen()->GetSheets( &sheetsInLoadedSchematic );
-
-        for( SCH_ITEM* item : sheetsInLoadedSchematic )
+        for( const SCH_SHEET_PATH& sheetPath : loadedSheets )
         {
-            SCH_SHEET* sheet = static_cast< SCH_SHEET* >( item );
+            // Skip the loaded sheet since the user already determined if the file path should
+            // be relative or absolute.
+            if( sheetPath.size() == 1 )
+                continue;
 
-            wxCHECK2( sheet, continue );
+            wxString lastSheetPath = fileName.GetPathWithSep();
 
-            wxFileName loadedSheetFileName = sheet->GetFileName();
-            wxString newSheetFilePath = topLevelSheetPath + loadedSheetFileName.GetFullName();
+            for( unsigned i = 1; i < sheetPath.size(); i++ )
+            {
+                SCH_SHEET* sheet = sheetPath.at( i );
+                wxCHECK2( sheet, continue );
 
-            sheet->SetFileName( newSheetFilePath );
+                SCH_SCREEN* screen = sheet->GetScreen();
+                wxCHECK2( screen, continue );
+
+                // Use the screen file name which should always be absolute.
+                wxFileName loadedSheetFileName = screen->GetFileName();
+                wxCHECK2( loadedSheetFileName.IsAbsolute(), continue );
+
+                wxFileName tmp = loadedSheetFileName;
+                wxString sheetFileName;
+
+                if( tmp.MakeRelativeTo( lastSheetPath ) )
+                    sheetFileName = tmp.GetFullPath();
+                else
+                    sheetFileName = loadedSheetFileName.GetFullPath();
+
+                sheetFileName.Replace( wxT( "\\" ), wxT( "/" ) );
+                sheet->SetFileName( sheetFileName );
+                lastSheetPath = loadedSheetFileName.GetPath();
+            }
         }
     }