textbringer 0.1.8 → 0.1.9

data/lib/textbringer/commands.rb

@@ -4,26 +4,38 @@ require "open3"
 require "io/wait"
 
 module Textbringer
+  Command = Struct.new(:name, :block, :doc)
+
   module Commands
     include Utils
 
-    @@command_list = []
+    @command_table = {}
 
     def self.list
-      @@command_list
+      @command_table.keys
+    end
+
+    def self.command_table
+      @command_table
+    end
+
+    def self.[](name)
+      @command_table[name.intern]
     end
 
-    def define_command(name, &block)
+    def define_command(name, doc: "No documentation", &block)
+      name = name.intern
       Commands.send(:define_method, name, &block)
-      @@command_list << name if !@@command_list.include?(name)
+      Commands.command_table[name] = Command.new(name, block, doc)
       name
     end
     module_function :define_command
 
     def undefine_command(name)
-      if @@command_list.include?(name)
+      name = name.intern
+      if Commands.command_table.key?(name)
         Commands.send(:undef_method, name)
-        @@command_list.delete(name)
+        Commands.command_table.delete(name)
       end
     end
     module_function :undefine_command

data/lib/textbringer/commands/buffers.rb

@@ -2,63 +2,175 @@
 
 module Textbringer
   module Commands
-    [
-      :forward_char,
-      :backward_char,
-      :forward_word,
-      :backward_word,
-      :next_line,
-      :previous_line,
-      :delete_char,
-      :backward_delete_char,
-    ].each do |name|
-      define_command(name) do |n = number_prefix_arg|
-        Buffer.current.send(name, n)
-      end
+    define_command(:forward_char,
+                   doc: "Move point n characters forward.") do
+      |n = number_prefix_arg|
+      Buffer.current.forward_char(n)
+    end
+    
+    define_command(:backward_char,
+                   doc: "Move point n characters backward.") do
+      |n = number_prefix_arg|
+      Buffer.current.backward_char(n)
     end
 
-    [
-      :beginning_of_line,
-      :end_of_line,
-      :beginning_of_buffer,
-      :end_of_buffer,
-      :exchange_point_and_mark,
-      :copy_region,
-      :kill_region,
-      :yank,
-      :newline,
-      :delete_region,
-      :transpose_chars
-    ].each do |name|
-      define_command(name) do
-        Buffer.current.send(name)
-      end
+    define_command(:forward_word,
+                   doc: "Move point n words forward.") do
+      |n = number_prefix_arg|
+      Buffer.current.forward_word(n)
+    end
+
+    define_command(:backward_word,
+                   doc: "Move point n words backward.") do
+      |n = number_prefix_arg|
+      Buffer.current.backward_word(n)
+    end
+    
+
+    define_command(:next_line,
+                   doc: "Move point n lines forward.") do
+      |n = number_prefix_arg|
+      Buffer.current.next_line(n)
+    end
+    
+    define_command(:previous_line,
+                   doc: "Move point n lines backward.") do
+      |n = number_prefix_arg|
+      Buffer.current.previous_line(n)
+    end
+    
+    define_command(:delete_char,
+                   doc: "Delete n characters forward.") do
+      |n = number_prefix_arg|
+      Buffer.current.delete_char(n)
+    end
+    
+    define_command(:backward_delete_char,
+                   doc: "Delete n characters backward.") do
+      |n = number_prefix_arg|
+      Buffer.current.backward_delete_char(n)
+    end
+
+    define_command(:beginning_of_line,
+                   doc: "Move point to the beginning of the current line.") do
+      Buffer.current.beginning_of_line
     end
 
-    define_command(:set_mark_command) do
-      Buffer.current.set_mark
-      message("Mark set")
+    define_command(:end_of_line,
+                   doc: "Move point to the end of the current line.") do
+      Buffer.current.end_of_line
     end
 
-    define_command(:goto_char) do
-      |n = read_from_minibuffer("Go to char: ")|
-      Buffer.current.goto_char(n.to_i)
+    define_command(:beginning_of_buffer,
+                   doc: "Move point to the beginning of the buffer.") do
+      Buffer.current.beginning_of_buffer
+    end
+
+    define_command(:end_of_buffer,
+                   doc: "Move point to the end of the buffer.") do
+      Buffer.current.end_of_buffer
+    end
+
+    define_command(:push_mark,
+                   doc: <<~EOD) do
+        Set mark at pos, and push the mark on the mark ring.
+        Unlike Emacs, the new mark is pushed on the mark ring instead of
+        the old one.
+      EOD
+      |pos = Buffer.current.point|
+      Buffer.current.push_mark(pos)
+    end
+
+    define_command(:pop_mark,
+                   doc: "Pop the mark from the mark ring.") do
+      Buffer.current.pop_mark
+    end
+
+    define_command(:pop_to_mark,
+                   doc: <<~EOD) do
+        Move point to where the mark is, and pop the mark from
+        the mark ring.
+      EOD
+      Buffer.current.pop_to_mark
+    end
+
+    define_command(:exchange_point_and_mark,
+                   doc: "Exchange the positions of point and mark.") do
+      Buffer.current.exchange_point_and_mark
+    end
+
+    define_command(:copy_region,
+                   doc: "Copy the region to the kill ring.") do
+      Buffer.current.copy_region
+    end
+
+    define_command(:kill_region,
+                   doc: "Copy and delete the region.") do
+      Buffer.current.kill_region
+    end
+
+    define_command(:yank,
+                   doc: "Insert the last text copied in the kill ring.") do
+      Buffer.current.yank
+    end
+
+    define_command(:newline,
+                   doc: "Insert a newline.") do
+      Buffer.current.newline
+    end
+
+    define_command(:delete_region,
+                   doc: "Delete the region without copying.") do
+      Buffer.current.delete_region
+    end
+
+    define_command(:transpose_chars,
+                   doc: "Transpose characters.") do
+      Buffer.current.transpose_chars
+    end
+
+    define_command(:set_mark_command,
+                   doc: <<~EOD) do
+        Set the mark at point.
+
+        With C-u, move point to where the mark is, and pop the mark from
+        the mark ring.
+      EOD
+      |arg = current_prefix_arg|
+      buffer = Buffer.current
+      if arg
+        buffer.pop_to_mark
+      else
+        buffer.push_mark
+        message("Mark set")
+      end
+    end
+
+    define_command(:goto_char,
+                   doc: "Move point to pos.") do
+      |pos = read_from_minibuffer("Go to char: ")|
+      Buffer.current.goto_char(pos.to_i)
       Window.current.recenter_if_needed
     end
 
-    define_command(:goto_line) do
+    define_command(:goto_line,
+                   doc: "Move point to line n.") do
       |n = read_from_minibuffer("Go to line: ")|
       Buffer.current.goto_line(n.to_i)
       Window.current.recenter_if_needed
     end
 
-    define_command(:self_insert) do |n = number_prefix_arg|
+    define_command(:self_insert,
+                   doc: "Insert the character typed.") do
+      |n = number_prefix_arg|
       c = Controller.current.last_key
       merge_undo = Controller.current.last_command == :self_insert
       Buffer.current.insert(c * n, merge_undo)
     end
 
-    define_command(:quoted_insert) do |n = number_prefix_arg|
+    define_command(:quoted_insert,
+                   doc: "Read a character, and insert it.") do
+      |n = number_prefix_arg|
       c = Controller.current.read_char
       if !c.is_a?(String)
         raise EditorError, "Invalid key"
@@ -66,17 +178,22 @@ module Textbringer
       Buffer.current.insert(c * n)
     end
 
-    define_command(:kill_line) do
+    define_command(:kill_line,
+                   doc: "Kill the rest of the current line.") do
       Buffer.current.kill_line(Controller.current.last_command == :kill_region)
       Controller.current.this_command = :kill_region
     end
 
-    define_command(:kill_word) do
+    define_command(:kill_word,
+                   doc: "Kill a word.") do
       Buffer.current.kill_word(Controller.current.last_command == :kill_region)
       Controller.current.this_command = :kill_region
     end
 
-    define_command(:yank_pop) do
+    define_command(:yank_pop,
+                   doc: <<~EOD) do
+        Rotate the kill ring, and replace the yanked text.
+      EOD
       if Controller.current.last_command != :yank
         raise EditorError, "Previous command was not a yank"
       end
@@ -84,14 +201,41 @@ module Textbringer
       Controller.current.this_command = :yank
     end
 
-    define_command(:undo) do
+    define_command(:undo,
+                   doc: "Undo changes.") do
       Buffer.current.undo
       message("Undo!") unless Window.echo_area.current?
     end
 
-    define_command(:redo) do
+    define_command(:redo_command,
+                   doc: "Redo changes reverted by undo.") do
       Buffer.current.redo
       message("Redo!") unless Window.echo_area.current?
     end
+
+    define_command(:back_to_indentation,
+                   doc: "Move point to the first non-space character.") do
+      buffer = Buffer.current
+      buffer.beginning_of_line
+      while /[ \t]/ =~ buffer.char_after
+        buffer.forward_char
+      end
+    end
+
+    define_command(:delete_indentation,
+                   doc: <<~EOD) do
+        Delete indentation and join the current line to the previous line.
+      EOD
+      buffer = Buffer.current
+      back_to_indentation
+      pos = buffer.point
+      buffer.skip_re_backward(/[^\n]/)
+      return if buffer.beginning_of_buffer?
+      buffer.backward_char
+      buffer.skip_re_backward(/[ \t]/)
+      buffer.delete_region(buffer.point, pos)
+      buffer.insert(" ")
+      buffer.backward_char
+    end
   end
 end

data/lib/textbringer/commands/clipboard.rb

@@ -21,27 +21,41 @@ module Textbringer
       GLOBAL_MAP.define_key("\ey", :clipboard_yank_pop)
     end
 
-    define_command(:clipboard_copy_region) do
+    define_command(:clipboard_copy_region, doc: <<~EOD) do
+        Copy the region to the kill ring and the clipboard.
+      EOD
       copy_region
       Clipboard.copy(KILL_RING.current)
     end
 
-    define_command(:clipboard_kill_region) do
+    define_command(:clipboard_kill_region, doc: <<~EOD) do
+        Copy the region to the kill ring and the clipboard, and delete
+        the region.
+      EOD
       kill_region
       Clipboard.copy(KILL_RING.current)
     end
 
-    define_command(:clipboard_kill_line) do
+    define_command(:clipboard_kill_line, doc: <<~EOD) do
+        Kill the rest of the current line, and copy the killed text to
+        the clipboard.
+      EOD
       kill_line
       Clipboard.copy(KILL_RING.current)
     end
 
-    define_command(:clipboard_kill_word) do
+    define_command(:clipboard_kill_word, doc: <<~EOD) do
+        Kill a word, and copy the word to the clipboard.
+      EOD
       kill_word
       Clipboard.copy(KILL_RING.current)
     end
 
-    define_command(:clipboard_yank) do
+    define_command(:clipboard_yank, doc: <<~EOD) do
+        If the clipboard contents are different from the last killed text,
+        push the contents to the kill ring, and insert it.
+        Otherwise, just insert the last text copied in the kill ring.
+      EOD
       s = Clipboard.paste.encode(Encoding::UTF_8).gsub(/\r\n/, "\n")
       if !s.empty? && (KILL_RING.empty? || KILL_RING.current != s)
         KILL_RING.push(s)
@@ -50,7 +64,10 @@ module Textbringer
       Controller.current.this_command = :yank
     end
 
-    define_command(:clipboard_yank_pop) do
+    define_command(:clipboard_yank_pop, doc: <<~EOD) do
+        Rotate the kill ring, and replace the yanked text, and copy
+        the text to the clipboard.
+      EOD
       yank_pop
       Clipboard.copy(KILL_RING.current)
     end

data/lib/textbringer/commands/ctags.rb

@@ -2,9 +2,6 @@
 
 module Textbringer
   module Commands
-    GLOBAL_MAP.define_key("\e.", :find_tag)
-    GLOBAL_MAP.define_key("\e*", :pop_tag_mark)
-
     CTAGS = {
       path: nil,
       tags: nil,
@@ -58,7 +55,8 @@ module Textbringer
         push_tag_mark_and_find_file(file)
         beginning_of_buffer
         n.times do
-          re_search_forward("^" + Regexp.quote($1) + "$")
+          s = Regexp.quote($1.gsub(/\\([\\\/])/, "\\1"))
+          re_search_forward("^" + s + "$")
         end
         beginning_of_line
       when %r'\A\?\^(.*)\$\?\z'
@@ -92,28 +90,10 @@ module Textbringer
       CTAGS[:tags]
     end
 
-    define_command(:pop_tag_mark) do
-      tag_mark_stack = CTAGS[:tag_mark_stack]
-      if tag_mark_stack.empty?
-        raise EditorError, "No previous locations"
-      end
-      mark = tag_mark_stack.pop
-      begin
-        switch_to_buffer(mark.buffer)
-        mark.buffer.point_to_mark(mark)
-      ensure
-        mark.delete
-      end
-    end
-
     private
 
     def push_tag_mark_and_find_file(file)
-      tag_mark_stack = CTAGS[:tag_mark_stack]
-      if tag_mark_stack.size == CONFIG[:tag_mark_limit]
-        tag_mark_stack.shift.delete
-      end
-      tag_mark_stack.push(Buffer.current.new_mark)
+      Buffer.current.push_global_mark(force: true)
       find_file(file)
     end
   end

data/lib/textbringer/commands/files.rb

@@ -4,7 +4,7 @@ require "editorconfig"
 
 module Textbringer
   module Commands
-    define_command(:find_file) do
+    define_command(:find_file, doc: "Open or create a file.") do
       |file_name = read_file_name("Find file: ")|
       config = EditorConfig.load_file(file_name)
       buffer = Buffer.find_file(file_name)
@@ -48,7 +48,7 @@ module Textbringer
       end
     end
 
-    define_command(:save_buffer) do
+    define_command(:save_buffer, doc: "Save the current buffer to a file.") do
       if Buffer.current.file_name.nil?
         Buffer.current.file_name = read_file_name("File to save in: ")
         next if Buffer.current.file_name.nil?
@@ -63,7 +63,8 @@ module Textbringer
       message("Wrote #{Buffer.current.file_name}")
     end
 
-    define_command(:write_file) do
+    define_command(:write_file,
+                   doc: "Save the current buffer as the specified file.") do
       |file_name = read_file_name("Write file: ")|
       if File.directory?(file_name)
         file_name = File.expand_path(Buffer.current.name, file_name)
@@ -78,23 +79,25 @@ module Textbringer
       message("Wrote #{Buffer.current.file_name}")
     end
 
-    define_command(:set_buffer_file_encoding) do
+    define_command(:set_buffer_file_encoding,
+                   doc: "Set the file encoding of the current buffer.") do
       |enc = read_from_minibuffer("File encoding: ",
                                   default: Buffer.current.file_encoding.name)|
       Buffer.current.file_encoding = enc
     end
 
-    define_command(:set_buffer_file_format) do
+    define_command(:set_buffer_file_format,
+                   doc: "Set the file format of the current buffer.") do
       |format = read_from_minibuffer("File format: ",
                                      default: Buffer.current.file_format.to_s)|
       Buffer.current.file_format = format
     end
 
-    define_command(:pwd) do
+    define_command(:pwd, doc: "Show the current working directory.") do
       message(Dir.pwd)
     end
 
-    define_command(:chdir) do
+    define_command(:chdir, doc: "Change the current working directory.") do
       |dir_name = read_file_name("Change directory: ")|
       Dir.chdir(dir_name)
     end