Merge lp:~julien-spautz/scratch/comment-plugin into lp:~elementary-apps/scratch/scratch

[Julien Spautz]

Implemented a comment/uncomment shortcut as plugin. Not sure what shortcut to use so I'm using Ctrl M and Ctrl Shift M for commenting and uncommenting respectively which I've used in some other editor, don't know which one.

The plugin gets the comment tokens for the current language from gtk.sourceview. It will either comment the current line or the selected text. If only block or only line comments are supported, they are used as a substitute for the other. Un commenting simply removes all comment tokens in the current line or selection, doesn't watch for strings or other exceptions yet.

[lp:~julien-spautz/scratch/comment-plugin]

1288. By Julien Spautz on 2014-04-23

undo deleted line

[Julien Spautz (julien-spautz)]

Undoing is also kind of fucked up, no idea why.

[Mario Guerriero (mefrio-g)]

Apart for the bug you mentioned I noticed another little bug. Do the following steps to reproduce:

 - Create a new document
 - Write something
 - Change language highlighting to Vala (or any other language)
 - Try to comment some lines with CTRL+M

It just does not watch for the language_changed signal emitted by the Scratch.Widgets.SourceView class.

[Mario Guerriero (mefrio-g)]

review: Needs Fixing

[lp:~julien-spautz/scratch/comment-plugin]

1289. By Julien Spautz on 2014-04-27

watch for language changes

[Mario Guerriero (mefrio-g)]

I still experience the bug I described above.

Unmerged revisions

1289. By Julien Spautz on 2014-04-27

watch for language changes

1288. By Julien Spautz on 2014-04-23

undo deleted line

1287. By Julien Spautz on 2014-04-23

implemented uncommenting

1286. By Julien Spautz on 2014-04-22

implemented keyboard shortcut for commenting lines or blocks, uncommenting not yet supported

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-01-31 14:58:18 +0000
+++ CMakeLists.txt	2014-04-27 15:17:23 +0000
@@ -100,4 +100,4 @@
 add_subdirectory (po)
 
 # Data
-install (FILES ${CMAKE_CURRENT_SOURCE_DIR}/data/scratch-text-editor.desktop DESTINATION share/applications)
+install (FILES ${CMAKE_CURRENT_SOURCE_DIR}/data/scratch-text-editor.desktop DESTINATION share/applications)
\ No newline at end of file

=== modified file 'plugins/CMakeLists.txt'
--- plugins/CMakeLists.txt	2013-07-08 00:40:39 +0000
+++ plugins/CMakeLists.txt	2014-04-27 15:17:23 +0000
@@ -12,3 +12,4 @@
 add_subdirectory (source-tree)
 add_subdirectory (outline)
 add_subdirectory (vim-emulation)
+add_subdirectory (comment)
\ No newline at end of file

=== added directory 'plugins/comment'
=== added file 'plugins/comment/CMakeLists.txt'
--- plugins/comment/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ plugins/comment/CMakeLists.txt	2014-04-27 15:17:23 +0000
@@ -0,0 +1,24 @@
+add_definitions(${NORMAL_CFLAGS})
+link_directories(${NORMAL_LINK_DIRS})
+vala_precompile(VALA_C
+    CommentPlugin.vala
+    Commentator.vala
+PACKAGES
+    gtk+-3.0
+    gee-0.8
+    granite
+    scratchcore
+    libpeas-1.0
+    gtksourceview-3.0
+    ${ZEITGEIST_DEPS}
+OPTIONS
+    --vapidir=${CMAKE_BINARY_DIR}
+    --vapidir=${CMAKE_BINARY_DIR}/src/
+    --vapidir=${CMAKE_BINARY_DIR}/scratchcore/
+)
+add_library(comment MODULE ${VALA_C})
+target_link_libraries(comment ${NORMAL_LIBRARIES})
+install(TARGETS comment DESTINATION lib/scratch/plugins/comment/)
+install(FILES comment.plugin DESTINATION lib/scratch/plugins/comment/)
+add_dependencies(comment scratchcore scratch)
+message("-- File Manager plugin will be compiled")
\ No newline at end of file

=== added file 'plugins/comment/CommentPlugin.vala'
--- plugins/comment/CommentPlugin.vala	1970-01-01 00:00:00 +0000
+++ plugins/comment/CommentPlugin.vala	2014-04-27 15:17:23 +0000
@@ -0,0 +1,65 @@
+// -*- Mode: vala; indent-tabs-mode: nil; tab-width: 4 -*-
+/***
+  BEGIN LICENSE
+
+  Copyright (C) 2013 Julien Spautz <[e-mail]>
+  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
+***/
+
+public const string NAME = N_("Comments");
+public const string DESCRIPTION = N_("Comment and uncomment selected code");
+
+namespace Scratch.Plugins {
+
+    public Scratch.Services.Interface plugins;
+
+    Gee.HashMap <Scratch.Services.Document, Comment.Commentator> commentators;
+
+    public class CommentPlugin : Peas.ExtensionBase, Peas.Activatable {
+
+        public Object object { owned get; construct; }
+
+        public Scratch.Services.Interface plugins {
+            owned get { return object as Scratch.Services.Interface; }
+        }
+
+        public CommentPlugin () {
+            message ("Starting Comment Plugin");
+        }
+
+        public void activate () {
+            commentators = new Gee.HashMap <Scratch.Services.Document, Comment.Commentator> ();
+            plugins.hook_document.connect (on_hook_document);
+        }
+
+        public void deactivate () {
+        }
+
+        public void update_state () {
+        }
+
+        void on_hook_document (Scratch.Services.Document document) {
+            if (commentators.has_key (document) == false)
+                commentators [document] = new Comment.Commentator (document);
+        }
+    }
+}
+
+[ModuleInit]
+public void peas_register_types (GLib.TypeModule module) {
+  var objmodule = module as Peas.ObjectModule;
+  objmodule.register_extension_type (typeof (Peas.Activatable),
+                                     typeof (Scratch.Plugins.CommentPlugin));
+}
\ No newline at end of file

=== added file 'plugins/comment/Commentator.vala'
--- plugins/comment/Commentator.vala	1970-01-01 00:00:00 +0000
+++ plugins/comment/Commentator.vala	2014-04-27 15:17:23 +0000
@@ -0,0 +1,175 @@
+// -*- Mode: vala; indent-tabs-mode: nil; tab-width: 4 -*-
+/***
+  BEGIN LICENSE
+
+  Copyright (C) 2013 Julien Spautz <[e-mail]>
+  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.Plugins.Comment {
+
+    class Commentator : Object {
+
+        string line_comment_start;
+        string block_comment_start;
+        string block_comment_end;
+
+        bool supports_comments {
+            get { return supports_line_comments || supports_block_comments; }
+        }
+
+        bool supports_line_comments {
+            get { return line_comment_start != ""; }
+        }
+
+        bool supports_block_comments {
+            get { return block_comment_start != ""
+                      && block_comment_end != ""; }
+        }
+
+        public Scratch.Services.Document document { get; construct; }
+
+        public Scratch.Widgets.SourceView source_view {
+            get { return document.source_view; }
+        }
+        
+        public Gtk.SourceBuffer buffer {
+            get { return source_view.buffer; }
+        }
+
+        public Commentator (Scratch.Services.Document document) {
+            Object (document: document);
+            get_comment_tokens ();
+            connect_signals ();
+        }
+
+        void connect_signals () {
+            source_view.key_press_event.connect (handle_key_press);
+            buffer.notify["language"].connect (get_comment_tokens);
+        }
+
+        bool handle_key_press (Object sender, Gdk.EventKey event) {
+            var ctrl = (event.state & Gdk.ModifierType.CONTROL_MASK) != 0;
+            var shift = (event.state & Gdk.ModifierType.SHIFT_MASK) != 0;
+
+            if (ctrl && event.keyval == Gdk.Key.m) {
+                comment ();
+                return true;
+            } else if (ctrl && shift && event.keyval == Gdk.Key.M) {
+                uncomment ();
+            }
+
+            return false;
+        }
+
+        void get_comment_tokens () {
+            var source_language = buffer.language;
+            line_comment_start = source_language.get_metadata ("line-comment-start") ?? "";
+            block_comment_start = source_language.get_metadata ("block-comment-start") ?? "";
+            block_comment_end = source_language.get_metadata ("block-comment-end") ?? "";
+        }
+
+        void comment () {
+            if (supports_comments == false)
+                return;
+
+            if (buffer.has_selection)
+                comment_block ();
+            else
+                comment_line ();
+        }
+        
+        void uncomment () {
+            if (supports_comments == false)
+                return;
+
+            if (buffer.has_selection)
+                uncomment_block ();
+            else
+                uncomment_line ();
+        }
+
+        void comment_line () {
+            if (supports_line_comments == false) {
+                comment_line_with_block_comments ();
+                return;
+            }
+
+            Gtk.TextIter start;
+            buffer.get_iter_at_mark (out start, buffer.get_insert ());
+            start.set_line_offset (0);
+            buffer.insert (ref start, line_comment_start, -1);
+        }
+
+        void comment_line_with_block_comments () {
+            Gtk.TextIter start;
+            buffer.get_iter_at_mark (out start, buffer.get_insert ());
+            start.set_line_offset (0);
+            buffer.insert (ref start, block_comment_start, -1);
+            start.forward_to_line_end ();
+            buffer.insert (ref start, block_comment_end, -1);
+        }
+
+        void comment_block () {
+            if (supports_block_comments == false) {
+                comment_block_with_line_comments ();
+                return;
+            }
+
+            Gtk.TextIter start, end;
+            buffer.get_selection_bounds (out start, out end);
+            buffer.insert (ref start, block_comment_start, -1);
+            buffer.get_selection_bounds (out start, out end);
+            buffer.insert (ref end, block_comment_end, -1);
+        }
+
+        void comment_block_with_line_comments () {
+            Gtk.TextIter start, end;
+            buffer.get_selection_bounds (out start, out end);
+
+            var start_line = start.get_line ();
+            var end_line = end.get_line ();
+
+            for (var line = start_line; line <= end_line; line++) {
+                start.set_line (line);
+                buffer.insert (ref start, line_comment_start, -1);
+            }
+        }
+
+        void uncomment_block () {
+            Gtk.TextIter start, end;
+            buffer.get_selection_bounds (out start, out end);
+            var selection = buffer.get_text (start, end, true);
+            var uncommented = selection.replace (line_comment_start, "")
+                                       .replace (block_comment_start, "")
+                                       .replace (block_comment_end, "");
+            buffer.delete_selection (false, false);
+            buffer.insert_at_cursor (uncommented, -1);
+        }
+        
+        void uncomment_line () {
+            Gtk.TextIter start, end;
+            buffer.get_iter_at_mark (out start, buffer.get_insert ());
+            buffer.get_iter_at_mark (out end, buffer.get_insert ());
+            start.set_line_offset (0);
+            end.forward_to_line_end ();
+            
+            var line_text = buffer.get_text (start, end, true);
+            var uncommented = line_text.replace (line_comment_start, "");
+            buffer.delete_interactive (ref start, ref end, true);
+            buffer.insert_at_cursor (uncommented, -1);
+        }
+    }
+}
\ No newline at end of file

=== added file 'plugins/comment/comment.plugin'
--- plugins/comment/comment.plugin	1970-01-01 00:00:00 +0000
+++ plugins/comment/comment.plugin	2014-04-27 15:17:23 +0000
@@ -0,0 +1,10 @@
+[Plugin]
+Module=comment
+Loader=C
+IAge=2
+Name=Comments
+Description=Comment and uncomment selected code
+Icon=system-
+Authors=Julien Spautz
+Copyright=Copyright © 2013 Scratch Developers
+Website=http://launchpad.net/scratch
\ No newline at end of file

=== modified file 'plugins/vim-emulation/vim-emulation.vala'
--- plugins/vim-emulation/vim-emulation.vala	2013-07-12 21:56:40 +0000
+++ plugins/vim-emulation/vim-emulation.vala	2014-04-27 15:17:23 +0000
@@ -253,4 +253,4 @@
     var objmodule = module as Peas.ObjectModule;
     objmodule.register_extension_type (typeof (Peas.Activatable),
                                      typeof (Scratch.Plugins.VimEmulation));
-}
+}
\ No newline at end of file

=== modified file 'src/Widgets/SourceView.vala'
--- src/Widgets/SourceView.vala	2014-03-27 07:56:52 +0000
+++ src/Widgets/SourceView.vala	2014-04-27 15:17:23 +0000
@@ -28,6 +28,7 @@
 
         public new SourceBuffer buffer;
         public Gtk.TextMark mark;
+
         public SourceLanguageManager manager;
         public SourceStyleSchemeManager style_scheme_manager;
 
@@ -37,7 +38,7 @@
 
         // Properties
         private string font;
-        
+
         // Signals
         public signal void style_changed (SourceStyleScheme style);
 
@@ -189,7 +190,7 @@
             override_font (Pango.FontDescription.from_string (this.font));
 
             buffer.style_scheme = style_scheme_manager.get_scheme (Scratch.settings.style_scheme);
-        
+
             this.style_changed (buffer.style_scheme);
         }
 
@@ -203,7 +204,7 @@
             Scratch.settings.indent_width = (int) tab_width;
             Scratch.settings.font = this.font;
             Scratch.settings.style_scheme = buffer.style_scheme.id;
-            
+
             this.style_changed (buffer.style_scheme);
         }