Merge lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces into lp:~elementary-apps/scratch/scratch

[David Hewitt]

Add setting and functionality to draw spaces only for selected text.

Currently, in the preferences, you have the option to turn "draw spaces" on or off. This branch adds a third option where spaces are drawn only within the selected region. This is useful for seeing if there is a discrepancy between tabs or spaces in a particular part of a file.

The code is ported from Gtksourceview to Vala so spaces are drawn in exactly the same way, using the same algorithm, just in a more controlled manner between the selection start and end points. It looks as though it may be possible to do this more easily without porting too much code after Gtksourceview-3.20, but this solution will continue to work too.

[lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces]

1840. By David Hewitt on 2017-03-08

Remove un-needed dep on libm

[Corentin Noël (tintou)]

I think it's better to use an enum in the gsettings instead of comparing strings

[lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces]

1841. By David Hewitt on 2017-03-09

Switch to enum instead of string for gsettings

[David Hewitt (davidmhewitt)]

Agreed, thanks Corentin. That's done now. Did you get chance to test the functionality at all?

[lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces]

1842. By David Hewitt on 2017-03-12

Merge trunk

[Danielle Foré (danrabbit)]

I can confirm that it works as expected :)

[Jeremy Wootten (jeremywootten)]

Only very minor niggles:

1) When drawing spaces in selected text only, the spaces are drawn pale as expected so they are visible. However, if the setting is then changed to "Always" the spaces disappear in the selected region (because they are drawn dark on a dark background) which is unexpected. Admittedly, spaces disappear in selected text in trunk as well, but in this branch they can be drawn pale but are not.

2) If the setting is changed while text is selected the behaviour inside the selection is inconsistent. Going from "Never" to "Selected text only" does not cause spaces to appear in the selection. Going from "Always" to "Selected text only" causes them to appear. Going from "Selected text" to "Always" causes them to disappear. Going from "Selected text" to "Never" does not cause them to disappear. This may be related to point 1).

Also, the diff below does not seem to show the removal of code that was replaced by DrawSpaceUtils, not sure why.

[lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces]

1843. By David Hewitt on 2017-03-15

Prefix gsettings enum with io.elementary.scratch

1844. By David Hewitt on 2017-03-15

Trigger redraw when setting changed

[Jeremy Wootten (jeremywootten)]

Looks good now.

review: Approve (code, function)

[lp:~davidmhewitt/scratch/fix-1303562-draw-selected-spaces]

1845. By David Hewitt on 2017-03-26

Merged trunk

=== modified file 'schemas/org.pantheon.scratch.gschema.xml'
--- schemas/org.pantheon.scratch.gschema.xml	2016-12-13 02:06:39 +0000
+++ schemas/org.pantheon.scratch.gschema.xml	2017-03-26 16:25:47 +0000
@@ -5,6 +5,11 @@
 		<value nick="Maximized" value="1" />
 		<value nick="Fullscreen" value="2" />
 	</enum>
+	<enum id="io.elementary.scratch.draw-spaces-states">
+		<value nick="Never" value="0" />
+		<value nick="For Selection" value="1" />
+		<value nick="Always" value="2" />
+	</enum>
 	<schema path="/org/pantheon/scratch/saved-state/" id="org.pantheon.scratch.saved-state" gettext-domain="scratch">
 		<key name="window-state" enum="scratch-window-states">
 			<default>"Normal"</default>
@@ -104,8 +109,8 @@
 			<summary>Highlight Matching Brackets</summary>
 			<description>Whether Scratch should highlight matching brackets.</description>
 		</key>
-		<key name="draw-spaces" type="b">
-			<default>false</default>
+		<key name="draw-spaces" enum="io.elementary.scratch.draw-spaces-states">
+			<default>"Never"</default>
 			<summary>Draw spaces and tabs with symbols</summary>
 			<description>Draw spaces and tabs with symbols.</description>
 		</key>

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2016-04-13 05:03:04 +0000
+++ src/CMakeLists.txt	2017-03-26 16:25:47 +0000
@@ -2,6 +2,7 @@
     MainWindow.vala
     Scratch.vala
     Utils.vala
+    DrawSpacesUtils.vala
     Dialogs/PreferencesDialog.vala
     Widgets/DocumentView.vala
     Widgets/ToolBar.vala

=== modified file 'src/Dialogs/PreferencesDialog.vala'
--- src/Dialogs/PreferencesDialog.vala	2016-05-09 22:14:07 +0000
+++ src/Dialogs/PreferencesDialog.vala	2017-03-26 16:25:47 +0000
@@ -31,7 +31,6 @@
         Gtk.Switch highlight_current_line;
         Gtk.Switch highlight_matching_brackets;
         Gtk.Switch line_break;
-        Gtk.Switch draw_spaces;
         Gtk.Switch spaces_instead_of_tabs_switch;
         Gtk.Switch autoindent_switch;
 
@@ -163,7 +162,11 @@
             line_break = new SettingsSwitch ("line-break");
 
             var draw_spaces_label = new SettingsLabel (_("Draw Spaces:"));
-            draw_spaces = new SettingsSwitch ("draw-spaces");
+            var draw_spaces_combo = new Gtk.ComboBoxText ();
+            draw_spaces_combo.append ("Never", _("Never"));
+            draw_spaces_combo.append ("For Selection", _("For selected text"));
+            draw_spaces_combo.append ("Always", _("Always"));
+            Scratch.settings.schema.bind ("draw-spaces", draw_spaces_combo, "active-id", SettingsBindFlags.DEFAULT);
 
             var line_numbers_label = new SettingsLabel (_("Show line numbers:"));
             var line_numbers = new SettingsSwitch ("show-line-numbers");
@@ -206,7 +209,7 @@
             content.attach (line_break_label, 0, 3, 1, 1);
             content.attach (line_break, 1, 3, 1, 1);
             content.attach (draw_spaces_label, 0, 4, 1, 1);
-            content.attach (draw_spaces, 1, 4, 1, 1);
+            content.attach (draw_spaces_combo, 1, 4, 1, 1);
             content.attach (line_numbers_label, 0, 5, 1, 1);
             content.attach (line_numbers, 1, 5, 1, 1);
 #if GTKSOURCEVIEW_3_18

=== added file 'src/DrawSpacesUtils.vala'
--- src/DrawSpacesUtils.vala	1970-01-01 00:00:00 +0000
+++ src/DrawSpacesUtils.vala	2017-03-26 16:25:47 +0000
@@ -0,0 +1,202 @@
+// -*- Mode: vala; indent-tabs-mode: nil; tab-width: 4 -*-
+/***
+  BEGIN LICENSE
+
+  Copyright (C) 2017 elementary LLC
+  This program is free software: you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License version 3, as published
+  by the Free Software Foundation.
+
+  This program is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranties of
+  MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+  PURPOSE.  See the GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License along
+  with this program.  If not, see <http://www.gnu.org/licenses/>
+
+  END LICENSE
+***/
+
+namespace Scratch.Utils {
+    static void get_end_iter (Gtk.TextView text_view, Gtk.TextIter start_iter, out Gtk.TextIter end_iter, int x, int y, bool is_wrapping) {
+        int min, max, i;
+        Gdk.Rectangle rect;
+
+        end_iter = start_iter;
+
+        if (!end_iter.ends_line ()) {
+            end_iter.forward_to_line_end ();
+        }
+
+        text_view.get_iter_location (end_iter, out rect);
+
+        if ((is_wrapping && rect.y < y) || (!is_wrapping && rect.x < x)) {
+            return;
+        }
+
+        min = start_iter.get_line_offset ();
+        max = end_iter.get_line_offset ();
+
+        while (max >= min) {
+            i = (min + max) >> 1;
+            end_iter.set_line_offset (i);
+            text_view.get_iter_location (end_iter, out rect);
+
+            if ((is_wrapping && rect.y < y) || (!is_wrapping && rect.x < x)) {
+                min = i + 1;
+            } else if ((is_wrapping && rect.y > y) || (!is_wrapping && rect.x > x)) {
+                max = i - 1;
+            } else {
+                break;
+            }
+        }
+    }
+
+    static void draw_space_at_iter (Cairo.Context cr, Gtk.TextView view, Gtk.TextIter iter, Gdk.Rectangle rect) {
+        int x, y;
+        double w;
+
+        view.buffer_to_window_coords (Gtk.TextWindowType.TEXT, rect.x, rect.y + rect.height * 2 / 3, out x, out y);
+
+        w = rect.width != 0 ? rect.width : rect.height;
+
+        cr.save ();
+        cr.move_to (x + w * 0.5, y);
+        cr.arc (x + w * 0.5, y, 0.8, 0, 2 * Math.PI);
+        cr.restore ();
+    }
+
+    static void draw_tab_at_iter (Cairo.Context cr, Gtk.TextView view, Gtk.TextIter iter, Gdk.Rectangle rect) {
+        int x, y;
+        double w, h;
+
+        view.buffer_to_window_coords (Gtk.TextWindowType.TEXT, rect.x, rect.y + rect.height * 2 / 3, out x, out y);
+
+        w = rect.width != 0 ? rect.width : rect.height;
+        h = rect.height;
+
+        cr.save ();
+        cr.move_to (x + w * 1 / 8, y);
+        cr.rel_line_to (w * 6 / 8, 0);
+        cr.rel_line_to (-h * 1 / 4, -h * 1 / 4);
+        cr.rel_move_to (+h * 1 / 4, +h * 1 / 4);
+        cr.rel_line_to (-h * 1 / 4, +h * 1 / 4);
+        cr.restore ();
+    }
+
+    static void draw_nbsp_at_iter (Cairo.Context cr, Gtk.TextView view, Gtk.TextIter iter, Gdk.Rectangle rect, bool narrowed) {
+        int x, y;
+        double w, h;
+
+        view.buffer_to_window_coords (Gtk.TextWindowType.TEXT, rect.x, rect.y + rect.height / 2, out x, out y);
+
+        w = rect.width != 0 ? rect.width : rect.height;
+        h = rect.height;
+
+        cr.save ();
+        cr.move_to (x + w * 1 / 6, y);
+        cr.rel_line_to (w * 4 / 6, 0);
+        cr.rel_line_to (-w * 2 / 6, +h * 1 / 4);
+        cr.rel_line_to (-w * 2 / 6, -h * 1 / 4);
+
+        if (narrowed) {
+            cr.fill ();
+        } else {
+            cr.stroke ();
+        }
+
+        cr.restore ();
+    }
+
+    static void draw_spaces_at_iter (Cairo.Context cr, Gtk.TextView text_view, Gtk.TextIter iter) {
+        unichar c;
+        Gdk.Rectangle rect;
+
+        text_view.get_iter_location (iter, out rect);
+
+        c = iter.get_char ();
+
+        if (c == '\t') {
+            draw_tab_at_iter (cr, text_view, iter, rect);
+        } else if (c.break_type () == UnicodeBreakType.NON_BREAKING_GLUE) {
+            draw_nbsp_at_iter (cr, text_view, iter, rect, c == 0x202F);
+        } else if (c.type () == UnicodeType.SPACE_SEPARATOR) {
+            draw_space_at_iter (cr, text_view, iter, rect);
+        } else if (c.type () == UnicodeType.SPACE_SEPARATOR) {
+            draw_space_at_iter (cr, text_view, iter, rect);
+        }
+    }
+
+    static void draw_tabs_and_spaces (Gtk.SourceView view, Cairo.Context cr) {
+        Gtk.TextIter selection_start, selection_end;
+        view.buffer.get_selection_bounds (out selection_start, out selection_end);
+
+        Gtk.TextView text_view;
+        Gdk.Rectangle clip;
+        int x1, y1, x2, y2;
+        Gtk.TextIter s, e;
+        Gtk.TextIter lineend;
+        bool is_wrapping;
+
+        if (!Gdk.cairo_get_clip_rectangle (cr, out clip)) {
+            return;
+        }
+
+        text_view = view;
+
+        is_wrapping = text_view.get_wrap_mode () != Gtk.WrapMode.NONE;
+
+        x1 = clip.x;
+        y1 = clip.y;
+        x2 = x1 + clip.width;
+        y2 = y1 + clip.height;
+
+        text_view.window_to_buffer_coords (Gtk.TextWindowType.TEXT, x1, y1, out x1, out y1);
+        text_view.window_to_buffer_coords (Gtk.TextWindowType.TEXT, x2, y2, out x2, out y2);
+
+        text_view.get_iter_at_location (out s, x1, y1);
+        text_view.get_iter_at_location (out e, x2, y2);
+
+        cr.set_source_rgba (1.0, 1.0, 1.0, 1.0);
+
+        cr.set_line_width (0.8);
+        cr.translate (-0.5, -0.5);
+
+        get_end_iter (text_view, s, out lineend, x2, y2, is_wrapping);
+
+        while (true) {
+            unichar c = s.get_char ();
+            int ly;
+
+            if (c.isspace () && s.compare (selection_start) >= 0 && s.compare (selection_end) < 0) {
+                draw_spaces_at_iter (cr, text_view, s);
+            }
+
+            if (!s.forward_char ()) {
+                break;
+            }
+
+            if (s.compare (lineend) > 0) {
+                if (s.compare (e) > 0) {
+                    break;
+                }
+
+                if (!s.starts_line () && !s.forward_line ()) {
+                    break;
+                }
+
+                text_view.get_line_yrange (s, out ly, null);
+                text_view.get_iter_at_location (out s, x1, ly);
+
+                if (!s.starts_line ()) {
+                    s.backward_char ();
+                }
+
+                get_end_iter (text_view, s, out lineend, x2, y2, is_wrapping);
+            }
+        }
+
+        cr.stroke ();
+    }
+}

=== modified file 'src/Services/Settings.vala'
--- src/Services/Settings.vala	2016-12-13 02:06:39 +0000
+++ src/Services/Settings.vala	2017-03-26 16:25:47 +0000
@@ -27,6 +27,12 @@
         FULLSCREEN = 2
     }
 
+    public enum ScratchDrawSpacesState {
+        NEVER = 0,
+        FOR_SELECTION = 1,
+        ALWAYS = 2
+    }
+
     public class SavedState : Granite.Services.Settings {
 
         public int window_width { get; set; }
@@ -51,7 +57,7 @@
         public bool line_break { get; set; }
         public bool highlight_current_line { get; set; }
         public bool highlight_matching_brackets { get; set; }
-        public bool draw_spaces { get; set; }
+        public ScratchDrawSpacesState draw_spaces { get; set; }
         public bool spaces_instead_of_tabs { get; set; }
         public bool auto_indent { get; set; }
         public int indent_width { get; set; }

=== modified file 'src/Widgets/SourceView.vala'
--- src/Widgets/SourceView.vala	2015-10-17 21:52:34 +0000
+++ src/Widgets/SourceView.vala	2017-03-26 16:25:47 +0000
@@ -190,10 +190,12 @@
             show_line_numbers = Scratch.settings.show_line_numbers;
             highlight_current_line = Scratch.settings.highlight_current_line;
             buffer.highlight_matching_brackets = Scratch.settings.highlight_matching_brackets;
-            if (settings.draw_spaces) {
+            if (settings.draw_spaces == ScratchDrawSpacesState.ALWAYS) {
                 draw_spaces = Gtk.SourceDrawSpacesFlags.TAB;
                 draw_spaces |= Gtk.SourceDrawSpacesFlags.SPACE;
             } else {
+                // Ensure we change the draw_spaces variable at least once to trigger redraw
+                draw_spaces = Gtk.SourceDrawSpacesFlags.TAB;
                 draw_spaces = Gtk.SourceDrawSpacesFlags.NBSP;
             }
 
@@ -326,5 +328,14 @@
 
             return false;
         }
+
+        public override void draw_layer (Gtk.TextViewLayer layer, Cairo.Context context) {
+            if (layer == Gtk.TextViewLayer.ABOVE && this.buffer.get_has_selection () && settings.draw_spaces == ScratchDrawSpacesState.FOR_SELECTION) {
+                context.save ();
+                Utils.draw_tabs_and_spaces (this, context);
+                context.restore ();
+            }
+            base.draw_layer (layer, context);
+        }
     }
 }