vedeu 0.5.13 → 0.6.0

data/lib/vedeu/input/editor/virtual_cursor.rb

@@ -0,0 +1,167 @@
+module Vedeu
+
+  module Editor
+
+    # Maintains a cursor position within the Vedeu::Editor::Document class.
+    #
+    class VirtualCursor
+
+      # @!attribute [rw] bx
+      # @return [Fixnum]
+      attr_accessor :bx
+
+      # @!attribute [rw] by
+      # @return [Fixnum]
+      attr_accessor :by
+
+      # @!attribute [rw] bxn
+      # @return [Fixnum]
+      attr_accessor :bxn
+
+      # @!attribute [rw] byn
+      # @return [Fixnum]
+      attr_accessor :byn
+
+      # @!attribute [rw] ox
+      # @return [Fixnum]
+      attr_accessor :ox
+
+      # @!attribute [rw] oy
+      # @return [Fixnum]
+      attr_accessor :oy
+
+      # @!attribute [rw] x
+      # @return [Fixnum]
+      attr_accessor :x
+
+      # @!attribute [rw] y
+      # @return [Fixnum]
+      attr_accessor :y
+
+      # Returns a new instance of Vedeu::Editor::VirtualCursor.
+      #
+      # @param y [Fixnum] The current line.
+      # @param x [Fixnum] The current character with the line.
+      # @param by [Fixnum]
+      # @param bx [Fixnum]
+      # @param byn [Fixnum]
+      # @param bxn [Fixnum]
+      # @param oy [Fixnum]
+      # @param ox [Fixnum]
+      # @return [Vedeu::Editor::VirtualCursor]
+      def initialize(y: 0, x: 0, by:, bx:, byn:, bxn:, oy: 0, ox: 0)
+        @y   = (y.nil? || y < 0) ? 0 : y
+        @x   = (x.nil? || x < 0) ? 0 : x
+        @by  = by
+        @bx  = bx
+        @byn = byn
+        @bxn = bxn
+        @ox  = ox
+        @oy  = oy
+      end
+
+      # Move the virtual cursor to the beginning of the line.
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def bol
+        @ox = 0
+        @x  = 0
+
+        self
+      end
+
+      # Move the virtual cursor down by one line.
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def down
+        @y += 1
+
+        self
+      end
+
+      # Move the virtual cursor to the left.
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def left
+        @ox -= 1 unless @ox == 0
+        @x  -= 1
+
+        self
+      end
+
+      # Move the virtual cursor to the origin (0, 0).
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def reset!
+        @x  = 0
+        @y  = 0
+        @ox = 0
+        @oy = 0
+
+        self
+      end
+
+      # Move the virtual cursor to the right.
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def right
+        @x += 1
+
+        self
+      end
+
+      # Return the escape sequence for setting the cursor position and show the
+      # cursor.
+      #
+      # @return [String]
+      def to_s
+        "\e[#{real_y};#{real_x}H\e[?25h"
+      end
+
+      # Move the virtual cursor up by one line.
+      #
+      # @return [Vedeu::Editor::VirtualCursor]
+      def up
+        @oy -= 1 unless @oy == 0
+        @y  -= 1
+
+        self
+      end
+
+      # @return [Fixnum] The column/character coordinate.
+      def x
+        @x  = 0               if @x <= 0
+        @ox = @x - (bxn - bx) if @x > bxn - bx
+
+        @x
+      end
+
+      # @return [Fixnum] The row/line coordinate.
+      def y
+        @y  = 0               if @y <= 0
+        @oy = @y - (byn - by) if @y > byn - by
+
+        @y
+      end
+
+      private
+
+      # Return the real y coordinate.
+      #
+      # @return [Fixnum]
+      def real_y
+        (by + y) - oy
+      end
+
+      # Return the real x coordinate.
+      #
+      # @return [Fixnum]
+      def real_x
+        (bx + x) - ox
+      end
+
+    end # VirtualCursor
+
+  end # Editor
+
+end # Vedeu

data/lib/vedeu/input/input.rb

@@ -31,6 +31,9 @@ module Vedeu
       if reader.raw_mode?
         Vedeu.trigger(:_keypress_, keypress)
 
+      elsif reader.fake_mode?
+        Vedeu.trigger(:_editor_, keypress)
+
       else
         Vedeu.trigger(:_command_, command)
 
@@ -45,14 +48,6 @@ module Vedeu
 
     private
 
-    # Returns the input from the terminal.
-    #
-    # @return [String]
-    def input
-      @input ||= reader.read
-    end
-    alias_method :command, :input
-
     # Returns the translated (when possible) keypress(es) as either a String or
     # a Symbol.
     #
@@ -60,95 +55,16 @@ module Vedeu
     def keypress
       key = input
 
-      specials.fetch(key, key)
+      Vedeu::InputTranslator.translate(key)
     end
 
-    # Translates (when possible) entered escape sequences into symbols
-    # representing the key which was pressed.
+    # Returns the input from the terminal.
     #
-    # @return [Hash]
-    def specials
-      {
-        "\r"      => :enter,
-        "\n"      => :enter,
-        "\t"      => :tab,
-        "\e"      => :escape,
-        "\e[A"    => :up,
-        "\e[B"    => :down,
-        "\e[C"    => :right,
-        "\e[D"    => :left,
-        "\e[5~"   => :page_up,
-        "\e[6~"   => :page_down,
-        "\e[H"    => :home,
-        "\e[3~"   => :delete,
-        "\e[F"    => :end,
-        "\e[Z"    => :shift_tab,
-        "\e[1;2P" => :print_screen,
-        "\e[1;2Q" => :scroll_lock,
-        "\e[1;2R" => :pause_break,
-        "\u007F"  => :backspace,
-        "\u0001"  => :ctrl_a,
-        "\u0002"  => :ctrl_b,
-        "\u0003"  => :ctrl_c,
-        "\u0004"  => :ctrl_d,
-        "\u0005"  => :ctrl_e,
-        "\u0006"  => :ctrl_f,
-        "\u0007"  => :ctrl_g,
-        "\u0008"  => :ctrl_h,
-        # "\u0009"  => :ctrl_i, # duplicates tab
-        "\u0010"  => :ctrl_j, # produces "\n"
-        "\u0011"  => :ctrl_k,
-        "\u0012"  => :ctrl_l,
-        "\u0013"  => :ctrl_m,
-        "\u0014"  => :ctrl_n,
-        "\u0015"  => :ctrl_o,
-        "\u0016"  => :ctrl_p,
-        "\u0017"  => :ctrl_q,
-        "\u0018"  => :ctrl_r,
-        "\u0019"  => :ctrl_s,
-        # "\u0020"  => :ctrl_t, # duplicates spacebar
-        "\u0021"  => :ctrl_u,
-        "\u0022"  => :ctrl_v,
-        "\u0023"  => :ctrl_w,
-        "\u0024"  => :ctrl_x,
-        "\u0025"  => :ctrl_y,
-        "\u0026"  => :ctrl_z,
-      }.merge!(f_keys)
-    end
-
-    # @return [Hash<String => Symbol]
-    def f_keys
-      {
-        "\eOP"      => :f1,
-        "\eOQ"      => :f2,
-        "\eOR"      => :f3,
-        "\eOS"      => :f4,
-        "\e[15~"    => :f5,
-        "\e[15;2~"  => :shift_f5,
-        "\e[15;5~"  => :ctrl_f5,
-        "\e[17~"    => :f6,
-        "\e[17;2~"  => :shift_f6,
-        "\e[17;5~"  => :ctrl_f6,
-        "\e[18~"    => :f7,
-        "\e[18;2~"  => :shift_f7,
-        "\e[18;5~"  => :ctrl_f7,
-        "\e[19~"    => :f8,
-        "\e[19;2~"  => :shift_f8,
-        "\e[19;5~"  => :ctrl_f8,
-        "\e[20~"    => :f9,
-        "\e[20;2~"  => :shift_f9,
-        "\e[20;5~"  => :ctrl_f9,
-        "\e[21~"    => :f10,
-        "\e[21;2~"  => :shift_f10,
-        "\e[21;5~"  => :ctrl_f10,
-        "\e[23~"    => :f11,
-        "\e[23;2~"  => :shift_f11,
-        "\e[23;5~"  => :ctrl_f11,
-        "\e[24~"    => :f12,
-        "\e[24;2~"  => :shift_f12,
-        "\e[24;5~"  => :ctrl_f12,
-      }
+    # @return [String]
+    def input
+      @input ||= reader.read
     end
+    alias_method :command, :input
 
   end # Input
 

data/lib/vedeu/input/input_translator.rb

@@ -0,0 +1,155 @@
+module Vedeu
+
+  # Translates escape sequences provided by the terminal into symbols which
+  # Vedeu can use for various behaviours.
+  #
+  class InputTranslator
+
+    # @param code [String]
+    # @return [Symbol]
+    def self.translate(code)
+      new(code).translate
+    end
+
+    # Returns a new instance of Vedeu::InputTranslator.
+    #
+    # @param code [String]
+    # @return [Vedeu::InputTranslator]
+    def initialize(code)
+      @code = code
+    end
+
+    # @return [Symbol]
+    def translate
+      symbols.fetch(code, code)
+    end
+
+    protected
+
+    # @!attribute [r] code
+    # @return [String]
+    attr_reader :code
+
+    private
+
+    # @return [Hash<String => Symbol>]
+    def symbols
+      @symbols ||= f_keys.merge!(ctrl_letters).merge!(specials)
+    end
+
+    # @return [Hash<String => Symbol]
+    def ctrl_letters
+      {
+        "\u0001"  => :ctrl_a,
+        "\u0002"  => :ctrl_b,
+        "\u0003"  => :ctrl_c,
+        "\u2404"  => :ctrl_c,
+        "\u0004"  => :ctrl_d,
+        "\u2403"  => :ctrl_d,
+        "\u0005"  => :ctrl_e,
+        "\u0006"  => :ctrl_f,
+        "\u0007"  => :ctrl_g,
+        "\u0008"  => :ctrl_h,
+        # "\u0009"  => :ctrl_i, # duplicates tab
+        "\u0010"  => :ctrl_j, # produces "\n"
+        "\u0011"  => :ctrl_k,
+        "\u0012"  => :ctrl_l,
+        "\u0013"  => :ctrl_m,
+        "\u0014"  => :ctrl_n,
+        "\u0015"  => :ctrl_o,
+        "\u0016"  => :ctrl_p,
+        "\u0017"  => :ctrl_q,
+        "\u0018"  => :ctrl_r,
+        "\u2412"  => :ctrl_r,
+        "\u0019"  => :ctrl_s,
+        # "\u0020"  => :ctrl_t, # duplicates spacebar
+        "\u0021"  => :ctrl_u,
+        "\u0022"  => :ctrl_v,
+        "\u0023"  => :ctrl_w,
+        "\u0024"  => :ctrl_x,
+        "\u0025"  => :ctrl_y,
+        "\u0026"  => :ctrl_z,
+      }
+    end
+
+    # @return [Hash<String => Symbol]
+    def f_keys
+      {
+        "\eOP"      => :f1,
+        "\eOQ"      => :f2,
+        "\eOR"      => :f3,
+        "\eOS"      => :f4,
+
+        "\e[15~"    => :f5,
+        "\e[15;2~"  => :shift_f5,
+        "\e[15;5~"  => :ctrl_f5,
+
+        "\e[17~"    => :f6,
+        "\e[17;2~"  => :shift_f6,
+        "\e[17;5~"  => :ctrl_f6,
+
+        "\e[18~"    => :f7,
+        "\e[18;2~"  => :shift_f7,
+        "\e[18;5~"  => :ctrl_f7,
+
+        "\e[19~"    => :f8,
+        "\e[19;2~"  => :shift_f8,
+        "\e[19;5~"  => :ctrl_f8,
+
+        "\e[20~"    => :f9,
+        "\e[20;2~"  => :shift_f9,
+        "\e[20;5~"  => :ctrl_f9,
+
+        "\e[21~"    => :f10,
+        "\e[21;2~"  => :shift_f10,
+        "\e[21;5~"  => :ctrl_f10,
+
+        "\e[23~"    => :f11,
+        "\e[23;2~"  => :shift_f11,
+        "\e[23;5~"  => :ctrl_f11,
+
+        "\e[24~"    => :f12,
+        "\e[24;2~"  => :shift_f12,
+        "\e[24;5~"  => :ctrl_f12,
+      }
+    end
+
+    # @return [Hash<String => Symbol>]
+    def specials
+      {
+        "\u007F"  => :backspace,
+        "\u2408"  => :backspace,
+        "\u23CE"  => :carriage_return,
+        "\e[3~"   => :delete,
+        "\u232B"  => :delete,
+        "\e[B"    => :down,
+        "\u2193"  => :down,
+        "\e[F"    => :end,
+        "\r"      => :enter,
+        "\n"      => :enter,
+        "\e"      => :escape,
+        "\u238B"  => :escape,
+        "\e[H"    => :home,
+        "\eOH"    => :home,
+        "\e[2~"   => :insert,
+        "\e[D"    => :left,
+        "\u2190"  => :left,
+        "\u240A"  => :line_feed,
+        "\e[5~"   => :page_up,
+        "\e[6~"   => :page_down,
+        "\e[1;2R" => :pause_break,
+        "\e[1;2P" => :print_screen,
+        "\e[C"    => :right,
+        "\u2192"  => :right,
+        "\e[1;2Q" => :scroll_lock,
+        "\e[Z"    => :shift_tab,
+        "\t"      => :tab,
+        "\u21B9"  => :tab,
+        "\e[A"    => :up,
+        "\u2191"  => :up,
+      }
+    end
+
+  end # InputTranslator
+
+end # Vedeu

data/lib/vedeu/internal_api.rb

@@ -55,6 +55,15 @@ module Vedeu
     # @return [Vedeu::Debug]
     def_delegators Vedeu::Debug, :debug
 
+    # Manipulate the repository of documents.
+    #
+    # @example
+    #   Vedeu.documents
+    #
+    # @!method documents
+    # @return [Vedeu::Editor::Documents]
+    def_delegators Vedeu::Editor::Documents, :documents
+
     # Manipulate the repository of events.
     #
     # @example