fix sometimes losing tab state (fixes #5236)

Author: kjk

src/AppSettings.cpp

@@ -296,48 +296,80 @@ bool LoadSettings() {
     return true;
 }
 
+static TabState* CloneTabState(const TabState* src) {
+    TabState* dst = (TabState*)AllocStruct<TabState>();
+    dst->filePath = str::Dup(src->filePath);
+    dst->displayMode = str::Dup(src->displayMode);
+    dst->pageNo = src->pageNo;
+    dst->zoom = str::Dup(src->zoom);
+    dst->rotation = src->rotation;
+    dst->scrollPos = src->scrollPos;
+    dst->showToc = src->showToc;
+    dst->tocState = new Vec<int>(*src->tocState);
+    return dst;
+}
+
+Vec<SessionData*>* gInitialSessionData = nullptr;
+
 static void RememberSessionState() {
-    Vec<SessionData*>* sessionData = gGlobalPrefs->sessionData;
-    ResetSessionState(sessionData);
+    Vec<SessionData*>* sessionState = gGlobalPrefs->sessionData;
+    FreeSessionState(sessionState);
 
     if (!gGlobalPrefs->rememberOpenedFiles) {
         return;
     }
 
-    if (gWindows.size() == 0) {
-        return;
-    }
-
     for (auto* win : gWindows) {
-        SessionData* data = NewSessionData();
+        SessionData* windowState = NewSessionData();
         for (WindowTab* tab : win->Tabs()) {
-            if (tab->IsAboutTab()) {
+            if (!tab->filePath) {
+                // home page tab
                 continue;
             }
             const char* fp = tab->filePath;
-            FileState* fs = NewDisplayState(fp);
-            if (tab->ctrl) {
-                tab->ctrl->GetDisplayState(fs);
+            if (!tab->ctrl) {
+                // lazy loading, file not loaded into a tab
+                // use the saved state from previous session
+                // note: might stil have issues if multiple tabs with same file
+                bool didFind = false;
+                int nWindows = gInitialSessionData->Size();
+                for (int i = 0; i < nWindows; i++) {
+                    SessionData* psd = gInitialSessionData->At(i);
+                    int nTabs = psd->tabStates->Size();
+                    for (int j = 0; j < nTabs; j++) {
+                        TabState* pts = psd->tabStates->At(j);
+                        if (str::Eq(pts->filePath, fp)) {
+                            TabState* ts = CloneTabState(pts);
+                            windowState->tabStates->Append(ts);
+                            didFind = true;
+                            break;
+                        }
+                    }
+                }
+                ReportIf(!didFind);
+                continue;
             }
+            FileState* fs = NewDisplayState(fp);
+            tab->ctrl->GetDisplayState(fs);
             fs->showToc = tab->showToc;
             *fs->tocState = tab->tocState;
             TabState* ts = NewTabState(fs);
-            data->tabStates->Append(ts);
+            windowState->tabStates->Append(ts);
             DeleteDisplayState(fs);
         }
-        if (data->tabStates->Size() == 0) {
+        if (windowState->tabStates->Size() == 0) {
             continue;
         }
-        data->tabIndex = win->GetTabIdx(win->CurrentTab()) + 1;
-        if (data->tabIndex < 0) {
-            data->tabIndex = 0;
+        windowState->tabIndex = win->GetTabIdx(win->CurrentTab()) + 1;
+        if (windowState->tabIndex < 0) {
+            windowState->tabIndex = 0;
         }
         // TODO: allow recording this state without changing gGlobalPrefs
         RememberDefaultWindowPosition(win);
-        data->windowState = gGlobalPrefs->windowState;
-        data->windowPos = gGlobalPrefs->windowPos;
-        data->sidebarDx = gGlobalPrefs->sidebarDx;
-        sessionData->Append(data);
+        windowState->windowState = gGlobalPrefs->windowState;
+        windowState->windowPos = gGlobalPrefs->windowPos;
+        windowState->sidebarDx = gGlobalPrefs->sidebarDx;
+        sessionState->Append(windowState);
     }
 }
 

src/AppSettings.h

@@ -11,6 +11,8 @@ enum {
 
 extern bool gDontSaveSettings;
 
+extern Vec<SessionData*>* gInitialSessionData;
+
 TempStr GetSettingsPathTemp();
 TempStr GetSettingsFileNameTemp();
 

src/GlobalPrefs.cpp

@@ -99,7 +99,7 @@ TabState* NewTabState(FileState* fs) {
     return state;
 }
 
-void ResetSessionState(Vec<SessionData*>* sessionData) {
+void FreeSessionState(Vec<SessionData*>* sessionData) {
     ReportIf(!sessionData);
     if (!sessionData) {
         return;

src/GlobalPrefs.h

@@ -15,7 +15,7 @@ void DeleteGlobalPrefs(GlobalPrefs* gp);
 
 SessionData* NewSessionData();
 TabState* NewTabState(FileState* fs);
-void ResetSessionState(Vec<SessionData*>* sessionData);
+void FreeSessionState(Vec<SessionData*>* sessionData);
 ParsedColor* GetParsedColor(const char* s, ParsedColor& parsed);
 COLORREF GetParsedCOLORREF(const char* s, ParsedColor& parsed, COLORREF def);
 

src/Installer.cpp

@@ -20,8 +20,8 @@
 #include "wingui/WinGui.h"
 
 #include "resource.h"
-#include "AppSettings.h"
 #include "Settings.h"
+#include "AppSettings.h"
 #include "Flags.h"
 #include "Version.h"
 #include "Annotation.h"

src/SumatraStartup.cpp

@@ -937,7 +937,6 @@ int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE, LPSTR, int) {
     HWND existingHwnd = nullptr;
     WindowTab* tabToSelect = nullptr;
     const char* logFilePath = nullptr;
-    Vec<SessionData*>* sessionData = nullptr;
 
     supressThrowFromNew();
 
@@ -1260,10 +1259,10 @@ int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE, LPSTR, int) {
     // keep this data alive until the end of program and ensure it's not
     // over-written by re-loading settings file while we're using it
     // and also to keep TabState forever for lazy loading of tabs
-    sessionData = gGlobalPrefs->sessionData;
+    gInitialSessionData = gGlobalPrefs->sessionData;
     gGlobalPrefs->sessionData = new Vec<SessionData*>();
 
-    restoreSession = gGlobalPrefs->restoreSession && (sessionData->size() > 0) && !gPluginMode;
+    restoreSession = gGlobalPrefs->restoreSession && (gInitialSessionData->Size() > 0) && !gPluginMode;
     if (!gGlobalPrefs->useTabs && (existingInstanceHwnd != nullptr)) {
         // do not restore a session if tabs are disabled and SumatraPDF is already running
         // TODO: maybe disable restoring if tabs are disabled?
@@ -1283,7 +1282,7 @@ int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE, LPSTR, int) {
     }
 
     if (restoreSession) {
-        for (SessionData* data : *sessionData) {
+        for (SessionData* data : *gInitialSessionData) {
             win = CreateAndShowMainWindow(data);
             for (TabState* state : *data->tabStates) {
                 if (str::IsEmpty(state->filePath)) {
@@ -1421,9 +1420,10 @@ int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE, LPSTR, int) {
     }
     str::Free(logFilePath);
 
-    if (sessionData) {
-        DeleteVecMembers(*sessionData);
-        delete sessionData;
+    if (gInitialSessionData) {
+        FreeSessionState(gInitialSessionData);
+        delete gInitialSessionData;
+        gInitialSessionData = nullptr;
     }
     FreeExternalViewers();
     while (gWindows.size() > 0) {