Merge lp:~jeremywootten/scratch/fix-ambiguous-tab-names-in-scratch into lp:~elementary-apps/scratch/scratch

[Jeremy Wootten]

Where two tabs are opened at different folders that have the same name, label the tabs in a way that distinguishes them.

In this branch, enough of the parent path needed to distinguish them is prepended to the tab-name.

[Zisu Andrei (matzipan)]

When I close the tab with similar name, I guess it should revert back to the original name.

review: Needs Fixing

[Zisu Andrei (matzipan)]

Some comments inline

review: Needs Fixing

[lp:~jeremywootten/scratch/fix-ambiguous-tab-names-in-scratch]

1754. By Jeremy Wootten on 2016-10-11

Revert to normal name on close all tabs with same name

1755. By Jeremy Wootten on 2016-10-11

Address inline comments

[Zisu Andrei (matzipan)]

A comment inline.

And a short mention. I don't know how it would be best to handle this, but basically, while testing this, if the parent folder's name is big, say "fix-ambiguous-tab-names-in-scratch", the filename will actually end up truncated.

To deal with this, Atom, for example, append the folder name instead.

Sorry I didn't notice this earlier.

review: Needs Fixing

[Jeremy Wootten (jeremywootten)]

Better wait until the equivalent pantheon-files branch is merged so that a consistent approach can be used.

Unmerged revisions

1755. By Jeremy Wootten on 2016-10-11

Address inline comments

1754. By Jeremy Wootten on 2016-10-11

Revert to normal name on close all tabs with same name

1753. By Jeremy Wootten on 2016-09-09

Distinguish ambiguous tab names

=== modified file 'src/Services/Document.vala'
--- src/Services/Document.vala	2016-04-28 00:27:27 +0000
+++ src/Services/Document.vala	2016-10-11 16:25:29 +0000
@@ -44,6 +44,7 @@
         public signal void doc_opened ();
         public signal void doc_saved ();
         public signal void doc_closed ();
+        public signal void file_changed ();
 
         // Widgets
         public Scratch.Widgets.SourceView source_view;
@@ -61,6 +62,7 @@
             set {
                 source_file.set_location (value);
                 file_changed ();
+                after_file_changed ();
             }
         }
 
@@ -357,9 +359,6 @@
             // Change syntax highlight
             this.source_view.change_syntax_highlight_from_file (this.file);
 
-            // Change label
-            this.label = get_basename ();
-
             return true;
         }
 
@@ -426,7 +425,6 @@
             box.pack_start (scroll, true, true, 0);
 #endif
             this.page = box;
-            this.label = get_basename ();
         }
 
         // Get file uri
@@ -730,7 +728,7 @@
             return this.file.query_exists ();
         }
 
-        private void file_changed () {
+        private void after_file_changed () {
             if (mount != null) {
                 mount.unmounted.disconnect (unmounted_cb);
                 mount = null;

=== modified file 'src/Widgets/DocumentView.vala'
--- src/Widgets/DocumentView.vala	2015-11-09 21:25:02 +0000
+++ src/Widgets/DocumentView.vala	2016-10-11 16:25:29 +0000
@@ -217,7 +217,7 @@
         }
 
         private void on_doc_added (Granite.Widgets.Tab tab) {
-            var doc = tab as Services.Document;
+            var doc = (Services.Document) tab;
             doc.main_actions = window.main_actions;
 
             this.docs.append (doc);
@@ -225,6 +225,9 @@
             doc.source_view.drag_data_received.connect (this.drag_received);
             doc.source_view.drag_motion.connect (this.drag_motion);
 
+            doc.label = check_for_tab_with_same_name (doc);
+            doc.file_changed.connect (after_doc_file_changed);
+
         }
 
         private void on_doc_removed (Granite.Widgets.Tab tab) {
@@ -234,10 +237,15 @@
             doc.source_view.focus_in_event.disconnect (this.on_focus_in_event);
             doc.source_view.drag_data_received.disconnect (this.drag_received);
             doc.source_view.drag_motion.disconnect (this.drag_motion);
+            doc.file_changed.disconnect (after_doc_file_changed);
 
             // Check if the view is empty
             if (this.is_empty ()) {
                 empty ();
+            } else {
+                foreach (Services.Document d in docs) {
+                    after_doc_file_changed (d);
+                }
             }
         }
 
@@ -268,6 +276,10 @@
             doc.focus ();
         }
 
+        private void after_doc_file_changed (Services.Document doc) {
+            doc.label = check_for_tab_with_same_name (doc);
+        }
+
         private bool on_focus_in_event () {
             var doc = get_current_document ();
             if (doc == null) {
@@ -293,5 +305,69 @@
                 Gtk.drag_finish (ctx, true, false, time);
             }
         }
+
+        private string check_for_tab_with_same_name (Services.Document doc) {
+            string name = doc.file.get_basename ();
+            string new_name = name;
+            string? path = doc.file.get_uri ();
+
+            foreach (Granite.Widgets.Tab tab in notebook.tabs) {
+                var content = (Services.Document)(tab);
+                if (content != doc) {
+                    string? content_path = content.file.get_uri ();
+                    string title = content.file.get_basename ();
+                    if (title == name && content_path != path) {
+                        if (title == tab.label) {
+                            Idle.add_full (GLib.Priority.LOW, () => {
+                                content.label = check_for_tab_with_same_name (content);
+                                return false;
+                            }); /* Trigger relabelling of conflicting tab (but not before this function finishes) */
+                        }
+                        new_name = append_parent (name, path, content_path); /*Also relabel this tab */
+                    }
+                }
+            }
+
+            return new_name;
+        }
+
+        private string append_parent (string name, string path, string conflict_path) {
+            string prefix = "";
+            string conflict_prefix = "";
+            string temp_path = path;
+            string temp_conflict_path = conflict_path;
+
+            /* Add parent directories until path and conflict path differ */
+            while (prefix == conflict_prefix) {
+                var parent_path = get_parent_path_from_path (temp_path);
+                var parent_conflict_path = get_parent_path_from_path (temp_conflict_path);
+                prefix = Path.get_basename (parent_path) + Path.DIR_SEPARATOR_S + prefix;
+                conflict_prefix = Path.get_basename (parent_conflict_path) + Path.DIR_SEPARATOR_S + conflict_prefix;
+                temp_path = parent_path;
+                temp_conflict_path = parent_conflict_path;
+            }
+
+            return prefix + name;
+        }
+
+        /*** Simplified version of PF.FileUtils function, with fewer checks ***/
+        private string get_parent_path_from_path (string path) {
+            if (path.length < 2) {
+                return Path.DIR_SEPARATOR_S;
+            }
+
+            StringBuilder sb = new StringBuilder (path);
+            if (path.has_suffix (Path.DIR_SEPARATOR_S)) {
+                sb.erase (sb.str.length - 1,-1);
+            }
+
+            int last_separator = sb.str.last_index_of (Path.DIR_SEPARATOR_S);
+            if (last_separator < 0) {
+                last_separator = 0;
+            }
+
+            sb.erase (last_separator, -1);
+            return sb.str + Path.DIR_SEPARATOR_S;
+        }
     }
 }