Merge lp:~philip.scott/scratch/restore-docs-per-tab into lp:~elementary-apps/scratch/scratch

[Felipe Escoto]

- Save and restore opened documents per view
- Prevent New Docs from not saving

The settings schema for the opened docs is now split into two, one per view. This is updated when you open, close or move a tab, so it's always up to date

[lp:~philip.scott/scratch/restore-docs-per-tab]

1788. By Felipe Escoto on 2016-12-13

Save documents per view

[Danielle Foré (danrabbit)]

I can confirm that this works as expected

review: Approve

=== modified file 'schemas/org.pantheon.scratch.gschema.xml'
--- schemas/org.pantheon.scratch.gschema.xml	2016-04-13 05:03:04 +0000
+++ schemas/org.pantheon.scratch.gschema.xml	2016-12-13 02:07:05 +0000
@@ -59,9 +59,14 @@
 			<summary>Show the welcome screen or the last opened files at Scratch launch</summary>
 			<description>Show the welcome screen or the last opened files at Scratch launch.</description>
 		</key>
-		<key type="as" name="opened-files">
-			<default>['']</default>
-			<summary>Files opened in the previously session of Scratch</summary>
+		<key name="opened-files-view1" type="as">
+			<default>[]</default>
+			<summary>Files opened in the previously session of Scratch on the first view</summary>
+			<description>It is used to open the files opened in the last Scratch session</description>
+		</key>
+		<key name="opened-files-view2" type="as">
+			<default>[]</default>
+			<summary>Files opened in the previously session of Scratch on the second view</summary>
 			<description>It is used to open the files opened in the last Scratch session</description>
 		</key>
 		<key name="autosave" type="b">
@@ -139,7 +144,12 @@
 			<summary>Preferred Style Scheme</summary>
 			<description>Set the preferred style scheme.</description>
 		</key>
-		<key name="focused-document" type="s">
+		<key name="focused-document-view1" type="s">
+			<default>''</default>
+			<summary>Remember the last focused document.</summary>
+			<description>Restore the focused document from a previous session when opening Scratch.</description>
+		</key>
+		<key name="focused-document-view2" type="s">
 			<default>''</default>
 			<summary>Remember the last focused document.</summary>
 			<description>Restore the focused document from a previous session when opening Scratch.</description>

=== modified file 'src/MainWindow.vala'
--- src/MainWindow.vala	2016-08-27 15:11:14 +0000
+++ src/MainWindow.vala	2016-12-13 02:07:05 +0000
@@ -294,6 +294,74 @@
             set_widgets_sensitive (!split_view.is_empty ());
         }
 
+        public void restore_opened_documents () {
+            if (settings.show_at_start == "last-tabs") {
+                start_loading ();
+
+                string[] uris_view1 = settings.opened_files_view1;
+                string[] uris_view2 = settings.opened_files_view2;
+                string focused_document1 = settings.focused_document_view1;
+                string focused_document2 = settings.focused_document_view2;
+
+                if (uris_view1.length > 0) {
+                    var view = add_view ();
+                    load_files_for_view (view, uris_view1);
+                    set_focused_document (view, focused_document1);
+
+                    if (view.is_empty ()) {
+                        split_view.remove_view (view);
+                    }
+                }
+
+                if (uris_view2.length > 0) {
+                    var view = add_view ();
+                    load_files_for_view (view, uris_view2);
+                    set_focused_document (view, focused_document2);
+
+                    if (view.is_empty ()) {
+                        split_view.remove_view (view);
+                    }
+                }
+
+                stop_loading ();
+            }
+        }
+
+        private void load_files_for_view (Scratch.Widgets.DocumentView view, string[] uris) {
+            foreach (string uri in uris) {
+               if (uri != "") {
+                    var file = File.new_for_uri (uri);
+                    if (file.query_exists ()) {
+                        var doc = new Scratch.Services.Document (main_actions, file);
+
+                        if (!doc.is_file_temporary || doc.exists ()) {
+                            open_document (doc, view);
+                        }
+                    }
+                }
+            }
+        }
+
+        // Set focus to last focused document, after all documents finished loading
+        private void set_focused_document (Scratch.Widgets.DocumentView view, string focused_document) {
+            if (focused_document != "") {
+                Scratch.Services.Document document_to_focus = null;
+
+                foreach (Scratch.Services.Document doc in view.docs) {
+                    if (doc.file != null) {
+                        if (doc.file.get_uri() == focused_document) {
+                            document_to_focus = doc;
+                            break;
+                        }
+                    }
+                }
+
+                if (document_to_focus != null) {
+                    view.notebook.current = document_to_focus;
+                }
+            }
+        }
+
         private bool on_key_pressed (Gdk.EventKey event) {
             switch (Gdk.keyval_name (event.keyval)) {
                 case "Escape":
@@ -392,17 +460,25 @@
         }
 
         // Open a document
-        public void open_document (Scratch.Services.Document doc) {
+        public void open_document (Scratch.Services.Document doc, Scratch.Widgets.DocumentView? view_ = null) {
             while (Gtk.events_pending ()) {
                 Gtk.main_iteration ();
             }
 
-            Scratch.Widgets.DocumentView? view = null;
+            Scratch.Widgets.DocumentView view = null;
+
+            if (view_ != null) {
+                view = view_;
+            }
+
             if (this.split_view.is_empty ()) {
                 view = split_view.add_view ();
                 view.open_document (doc);
             } else {
-                view = split_view.get_focus_child () as Scratch.Widgets.DocumentView;
+                if (view == null) {
+                    view = split_view.get_focus_child () as Scratch.Widgets.DocumentView;
+                }
+
                 if (view == null) {
                     view = this.split_view.current_view;
                 }
@@ -452,6 +528,7 @@
             if (!is_empty ()) {
                 foreach (var w in this.split_view.views) {
                     var view = w as Scratch.Widgets.DocumentView;
+                    view.is_closing = true;
                     foreach (var doc in view.docs) {
                         if (!doc.close (true)) {
                             view.set_current_document (doc);
@@ -530,41 +607,6 @@
             Scratch.saved_state.vp_size = vp.get_position ();
         }
 
-        // Update files-opened settings key
-        private void update_opened_files () {
-            // File list
-            string[] opened_files = {};
-            this.split_view.views.foreach ((view) => {
-                view.notebook.tabs.foreach ((tab) => {
-                    var doc = tab as Scratch.Services.Document;
-                    if (doc.file != null && doc.exists ()) {
-                        opened_files += doc.file.get_uri ();
-                    }
-                });
-            });
-
-
-            // Update the opened-files setting
-            if (settings.show_at_start == "last-tabs") {
-                settings.opened_files = opened_files;
-
-                // Update the focused-document setting
-                string file_uri = "";
-                if (this.split_view.current_view != null) {
-                    var current_document = this.split_view.current_view.get_current_document();
-                    if (current_document != null) {
-                        file_uri = current_document.file.get_uri();
-                    }
-                }
-
-                if (file_uri != "") {
-                    settings.focused_document = file_uri;
-                } else {
-                    settings.schema.reset ("focused-document");
-                }
-            }
-        }
-
         // SIGTERM/SIGINT Handling
         public bool quit_source_func () {
             action_quit ();
@@ -574,7 +616,6 @@
         // For exit cleanup
         private void handle_quit () {
             update_saved_state ();
-            update_opened_files ();
         }
 
         public void set_default_zoom () {
@@ -762,9 +803,9 @@
                 if (fetch_action.sensitive) {
                     /* Toggling the fetch action causes this function to be called again but the search_revealer child
                      * is still not revealed so nothing more happens.  We use the map signal on the search entry
-                     * to set it up once it has been revealed. */  
+                     * to set it up once it has been revealed. */
                     fetch_action.active = true;
-                } 
+                }
             } else {
                 set_search_text ();
             }

=== modified file 'src/Scratch.vala'
--- src/Scratch.vala	2016-09-01 04:13:38 +0000
+++ src/Scratch.vala	2016-12-13 02:07:05 +0000
@@ -242,44 +242,10 @@
             if (window == null) {
                 window = this.new_window ();
                 window.show ();
-                // Restore opened documents
-                if (settings.show_at_start == "last-tabs") {
-                    window.start_loading ();
-
-                    string[] uris = settings.schema.get_strv ("opened-files");
-
-                    foreach (string uri in uris) {
-                       if (uri != "") {
-                            var file = File.new_for_uri (uri);
-                            if (file.query_exists ()) {
-                                var doc = new Scratch.Services.Document (window.main_actions, file);
-                                window.open_document (doc);
-                            }
-                        }
-                    }
-
-                    // Set focus to last focused document, after all documents finished loading
-                    string focused_document = settings.schema.get_string("focused-document");
-                    if (focused_document != "" && window.split_view.current_view != null) {
-                        Scratch.Services.Document document_to_focus = null;
-                        var document_view = window.split_view.current_view;
-                        foreach (Scratch.Services.Document doc in document_view.docs) {
-                            if (doc.file != null) {
-                                if (doc.file.get_uri() == focused_document) {
-                                    document_to_focus = doc;
-                                    break;
-                                }
-                            }
-                        }
-                        if (document_to_focus != null)
-                            window.split_view.current_view.notebook.current = document_to_focus;
-                    }
-                    window.stop_loading ();
-                }
+                window.restore_opened_documents ();
             } else {
                 window.present ();
             }
-
         }
 
         protected override void open (File[] files, string hint) {

=== modified file 'src/Services/Settings.vala'
--- src/Services/Settings.vala	2016-04-13 05:03:04 +0000
+++ src/Services/Settings.vala	2016-12-13 02:07:05 +0000
@@ -62,9 +62,11 @@
         public string style_scheme { get; set; }
         public string[] plugins_enabled { get; set;}
         public string show_at_start { get; set; }
-        public string[] opened_files { get; set; }
+        public string[] opened_files_view1 { get; set; }
+        public string[] opened_files_view2 { get; set; }
         public bool autosave { get; set; }
-        public string focused_document { get; set; }
+        public string focused_document_view1 { get; set; }
+        public string focused_document_view2 { get; set; }
         public bool show_mini_map { get; set; }
         
         public Settings ()  {

=== modified file 'src/Widgets/DocumentView.vala'
--- src/Widgets/DocumentView.vala	2015-11-09 21:25:02 +0000
+++ src/Widgets/DocumentView.vala	2016-12-13 02:07:05 +0000
@@ -36,6 +36,9 @@
             }
         }
 
+        public uint view_id = -1;
+        public bool is_closing = false;
+
         // Signals
         public signal void document_change (Services.Document? document);
         public signal void empty ();
@@ -70,6 +73,7 @@
 
             this.notebook.tab_switched.connect ((old_tab, new_tab) => {
                 document_change (new_tab as Services.Document);
+                save_current_file (new_tab as Services.Document);
             });
 
             this.notebook.tab_restored.connect ((label, restore_data, icon) => {
@@ -224,7 +228,7 @@
             doc.source_view.focus_in_event.connect (this.on_focus_in_event);
             doc.source_view.drag_data_received.connect (this.drag_received);
             doc.source_view.drag_motion.connect (this.drag_motion);
-
+            save_opened_files ();
         }
 
         private void on_doc_removed (Granite.Widgets.Tab tab) {
@@ -239,6 +243,10 @@
             if (this.is_empty ()) {
                 empty ();
             }
+
+            if (!is_closing) {
+                save_opened_files ();
+            }
         }
 
         private void on_doc_moved (Granite.Widgets.Tab tab, int x, int y) {
@@ -266,6 +274,8 @@
             this.docs.insert (doc, new_pos);
 
             doc.focus ();
+
+            save_opened_files ();
         }
 
         private bool on_focus_in_event () {
@@ -293,5 +303,46 @@
                 Gtk.drag_finish (ctx, true, false, time);
             }
         }
+
+        public void save_opened_files () {
+            if (settings.show_at_start == "last-tabs") {
+                string[] opened_files = {};
+
+                notebook.tabs.foreach ((tab) => {
+                    var doc = tab as Scratch.Services.Document;
+                    if (doc.file != null && doc.exists ()) {
+                        opened_files += doc.file.get_uri ();
+                    }
+                });
+
+                if (view_id == 1) {
+                    settings.opened_files_view1 = opened_files;
+                } else {
+                    settings.opened_files_view2 = opened_files;
+                }
+            }
+        }
+
+        public void save_current_file (Services.Document? current_document) {
+            string file_uri = "";
+
+            if (current_document != null) {
+                file_uri = current_document.file.get_uri();
+            }
+
+            if (file_uri != "") {
+                if (view_id == 1) {
+                    settings.focused_document_view1 = file_uri;
+                } else {
+                    settings.focused_document_view2 = file_uri;
+                }
+            } else {
+                if (view_id == 1) {
+                    settings.schema.reset ("focused-document_view1");
+                } else {
+                    settings.schema.reset ("focused-document_view2");
+                }
+            }
+        }
     }
 }

=== modified file 'src/Widgets/SplitView.vala'
--- src/Widgets/SplitView.vala	2016-11-20 10:49:23 +0000
+++ src/Widgets/SplitView.vala	2016-12-13 02:07:05 +0000
@@ -120,11 +120,13 @@
             view.show_all ();
 
             views.append (view);
+            view.view_id = views.length ();
             this.current_view = view;
             debug ("View added successfully");
 
             // Enbale/Disable useless GtkActions about views
             check_actions ();
+
             return view;
         }
 
@@ -137,12 +139,25 @@
                 return;
             }
 
+            foreach (var doc in view.docs) {
+                if (!doc.close (true)) {
+                    view.set_current_document (doc);
+                    return;
+                }
+            }
+
             // Swap the position of the second view in the pane when we delete the first one
             if (get_child1 () == view && get_child2 () != null) {
-                var right_view = get_child2 ();
+                var right_view = get_child2 () as Scratch.Widgets.DocumentView;
                 remove (view);
                 remove (right_view);
                 pack1 (right_view, true, true);
+
+                view.view_id = 2;
+                right_view.view_id = 1;
+
+                view.save_opened_files ();
+                right_view.save_opened_files ();
             } else {
                 remove (view);
             }