vedeu 0.4.40 → 0.4.41

data/lib/vedeu/geometry/index_position.rb

@@ -32,6 +32,7 @@ module Vedeu
     def []
       Vedeu::Position.new(y, x)
     end
+    alias_method :to_position, :[]
 
     # An object is equal when its values are the same.
     #

data/lib/vedeu/geometry/position.rb

@@ -75,6 +75,11 @@ module Vedeu
       [y, x]
     end
 
+    # @return [Vedeu::Position]
+    def to_position
+      self
+    end
+
     # Return the escape sequence required to position the cursor at a particular
     # point on the screen. When passed a block, will do the aforementioned,
     # call the block and then reposition to this location.

data/lib/vedeu/input/all.rb

@@ -5,14 +5,6 @@ require_relative 'keymap'
 
 module Vedeu
 
-  # Define a keymap called '_system_' which will hold some vital keys needed by
-  # Vedeu to run effectively.
-  Vedeu::DSL::Keymap.keymap('_system_') do |keymap|
-    Vedeu::Configuration.system_keys.each do |label, keypress|
-      keymap.key(keypress) { Vedeu.trigger(("_#{label}_").to_sym) }
-    end
-  end
-
   # Define a keymap called '_global_' which will respond no matter which
   # interface is in focus.
   #

data/lib/vedeu/input/input.rb

@@ -86,14 +86,30 @@ module Vedeu
         "\eOQ"    => :f2,
         "\eOR"    => :f3,
         "\eOS"    => :f4,
-        "\e[15~"  => :f5,
-        "\e[17~"  => :f6,
-        "\e[18~"  => :f7,
-        "\e[19~"  => :f8,
-        "\e[20~"  => :f9,
-        "\e[21~"  => :f10,
-        "\e[23~"  => :f11,
-        "\e[24~"  => :f12,
+        "\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_f6,
+        "\e[19~"    => :f8,
+        "\e[19;2~"  => :shift_f8,
+        "\e[19;5~"  => :ctrl_f6,
+        "\e[20~"    => :f9,
+        "\e[20;2~"  => :shift_f9,
+        "\e[20;5~"  => :ctrl_f6,
+        "\e[21~"    => :f10,
+        "\e[21;2~"  => :shift_f10,
+        "\e[21;5~"  => :ctrl_f6,
+        "\e[23~"    => :f11,
+        "\e[23;2~"  => :shift_f11,
+        "\e[23;5~"  => :ctrl_f6,
+        "\e[24~"    => :f12,
+        "\e[24;2~"  => :shift_f12,
+        "\e[24;5~"  => :ctrl_f6,
         "\e[1;2P" => :print_screen,
         "\e[1;2Q" => :scroll_lock,
         "\e[1;2R" => :pause_break,

data/lib/vedeu/input/mapper.rb

@@ -46,27 +46,27 @@ module Vedeu
     end
 
     # Returns a boolean indicating that the key is registered to the current
-    # keymap or the global or system keymap.
+    # keymap, or the global keymap.
     #
     # @return [Boolean]
     def keypress
       return false unless key
 
+      Vedeu.log(type: :debug, message: "Key detected: #{key.inspect}")
+
       return true if key_defined? && keymap.use(key)
 
       return true if global_key? && keymap('_global_').use(key)
 
-      return true if system_key? && keymap('_system_').use(key)
-
       false
     end
 
     # Returns a boolean indicating that the key is not registered to the current
-    # keymap, the global keymap or the system keymap.
+    # keymap, or the global keymap.
     #
     # @return [Boolean]
     def valid?
-      return false if !key || key_defined? || global_key? || system_key?
+      return false if !key || key_defined? || global_key?
 
       true
     end
@@ -90,13 +90,6 @@ module Vedeu
       key_defined?('_global_')
     end
 
-    # Is the key a system key?
-    #
-    # @return [Boolean]
-    def system_key?
-      key_defined?('_system_')
-    end
-
     # Is the key defined in the named keymap?
     #
     # @param named [NilClass|String]

data/lib/vedeu/models/composition.rb

@@ -8,7 +8,7 @@ module Vedeu
     include Vedeu::Model
     include Vedeu::Presentation
 
-    collection Vedeu::Interfaces
+    collection Vedeu::InterfaceCollection
     member     Vedeu::Interface
 
     # @!attribute [r] attributes
@@ -29,12 +29,12 @@ module Vedeu
     end
 
     # @param child [Vedeu::Interface]
-    # @return [Vedeu::Interfaces]
+    # @return [Vedeu::InterfaceCollection]
     def add(child)
       @interfaces = interfaces.add(child)
     end
 
-    # @return [Vedeu::Interfaces]
+    # @return [Vedeu::InterfaceCollection]
     def interfaces
       collection.coerce(@interfaces, self)
     end

data/lib/vedeu/models/escape_char.rb

@@ -11,6 +11,8 @@ module Vedeu
     alias_method :to_s, :value
     alias_method :to_str, :value
 
+    # Returns a new instance of Vedeu::EscapeChar.
+    #
     # @param value [String]
     # @return [Vedeu::EscapeChar]
     def initialize(value)

data/lib/vedeu/models/focus.rb

@@ -4,6 +4,14 @@ module Vedeu
   # serving to store and manipulate the which interface is currently being
   # focussed.
   #
+  # @note
+  #   - Interfaces are added to the collection in the order they are defined.
+  #   - If the interface definition contains `focus!`,
+  #     (see Vedeu::DSL::Interface#focus!) then that interface is prepended to
+  #     the list.
+  #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is used, then
+  #     the list pointer (`current`) is set to the interface of that name.
+  #
   # @api private
   module Focus
 

data/lib/vedeu/models/interface.rb

@@ -65,7 +65,7 @@ module Vedeu
     # @option attributes lines [Vedeu::Lines]
     # @option attributes name [String]
     # @option attributes parent [Vedeu::Composition]
-    # @option attributes repository [Vedeu::InterfacesRepository]
+    # @option attributes repository [Vedeu::Interfaces]
     # @option attributes style [Vedeu::Style]
     # @option attributes visible [Boolean]
     # @option attributes zindex [Fixnum]

data/lib/vedeu/models/line.rb

@@ -17,11 +17,6 @@ module Vedeu
     # @return [Interface]
     attr_accessor :parent
 
-    # @!attribute [rw] streams
-    # @return [Streams]
-    attr_accessor :streams
-    alias_method :value, :streams
-
     # @!attribute [r] attributes
     # @return [Hash]
     attr_reader :attributes
@@ -79,6 +74,7 @@ module Vedeu
     def streams
       @_streams ||= collection.coerce(@streams, self)
     end
+    alias_method :value, :streams
 
     # Delegate to Vedeu::Interface#width if available.
     #

data/lib/vedeu/models/menu.rb

@@ -41,12 +41,14 @@ module Vedeu
     # @example
     #   Vedeu.menu 'my_interface' do
     #     items [:item_1, :item_2, :item_3]
-    #     ...
+    #     # ...
+    #   end
     #
     #   Vedeu.menu do
     #     name 'menus_must_have_a_name'
     #     items Track.all_my_favourites
-    #     ...
+    #     # ...
+    #   end
     #
     # @raise [InvalidSyntax] The required block was not given.
     # @return [API::Menu]

data/lib/vedeu/models/panel.rb

@@ -5,6 +5,8 @@ module Vedeu
   # @api private
   class Panel
 
+    # Returns a new instance of Vedeu::Panel.
+    #
     # @return [Vedeu::Panel]
     def initialize
     end

data/lib/vedeu/null/buffer.rb

@@ -12,6 +12,8 @@ module Vedeu
       # @return [String]
       attr_reader :name
 
+      # Returns a new instance of Vedeu::Null::Buffer.
+      #
       # @param name [String]
       # @return [Vedeu::Null::Buffer]
       def initialize(name)

data/lib/vedeu/null/interface.rb

@@ -7,6 +7,8 @@ module Vedeu
     # @api private
     class Interface
 
+      # Returns a new instance of Vedeu::Null::Interface.
+      #
       # @param name [String]
       # @return [Vedeu::Null::Interface]
       def initialize(name = nil)

data/lib/vedeu/output/background.rb

@@ -18,7 +18,7 @@ module Vedeu
       "\e[48;5;"
     end
 
-    # @return [Vedeu::BackgroundColours]
+    # @return [Vedeu::Backgrounds]
     def repository
       Vedeu.background_colours
     end

data/lib/vedeu/output/border.rb

@@ -1,3 +1,5 @@
+require 'vedeu/output/render_border'
+
 module Vedeu
 
   # Provides the mechanism to decorate an interface with a border on all edges,
@@ -82,7 +84,7 @@ module Vedeu
 
     # @!attribute [r] enabled
     # @return [Boolean]
-    attr_reader :enabled
+    attr_accessor :enabled
     alias_method :enabled?, :enabled
 
     # Returns a new instance of Vedeu::Border.
@@ -156,18 +158,7 @@ module Vedeu
 
     # @return [Array<Array<Vedeu::Char>>]
     def render
-      return [] unless visible?
-      return [] unless enabled?
-
-      Vedeu.timer("Rendering border: #{name}") do
-        out = [top, bottom]
-
-        height.times do |y|
-          out << [left(y), right(y)]
-        end
-
-        out.flatten
-      end
+      @render ||= Vedeu::RenderBorder.with(self)
     end
 
     # @return [String]
@@ -176,152 +167,8 @@ module Vedeu
     end
     alias_method :to_str, :to_s
 
-    # Renders the bottom border for the interface.
-    #
-    # @return [String]
-    def bottom
-      return [] unless bottom?
-
-      out = []
-      out << border(bottom_left, :bottom_left, *[yn, x]) if left?
-      out << horizontal_border(:bottom_horizontal, yn)
-      out << border(bottom_right, :bottom_right, *[yn, xn]) if right?
-      out
-    end
-
-    # Renders the left border for the interface.
-    #
-    # @param iy [Fixnum]
-    # @return [String]
-    def left(iy = 0)
-      return [] unless left?
-
-      border(vertical, :left_vertical, *[(by + iy), x])
-    end
-
-    # Renders the right border for the interface.
-    #
-    # @param iy [Fixnum]
-    # @return [String]
-    def right(iy = 0)
-      return [] unless right?
-
-      border(vertical, :left_vertical, *[(by + iy), xn])
-    end
-
-    # Renders the top border for the interface.
-    #
-    # @note
-    #   If a title has been specified, then the top border will include this
-    #   title unless the size of the interface is smaller than the padded title
-    #   length.
-    #
-    # @return [String]
-    def top
-      return [] unless top?
-
-      out = []
-      out << border(top_left, :top_left, *[y, x]) if left?
-      if title? && width > title_characters.size
-        out << titlebar
-
-      else
-        out << horizontal_border(:top_horizontal, y)
-
-      end
-      out << border(top_right, :top_right, *[y, xn]) if right?
-      out
-    end
-
-    # The parent of a border is always an interface.
-    #
-    # @return [Vedeu::Interface]
-    def parent
-      interface
-    end
-
     private
 
-    # @param position [Symbol] Either :top_horizontal, or :bottom_horizontal.
-    # @return [Array<Vedeu::Char>]
-    def horizontal_border(position, y_coordinate)
-      width.times.each_with_object([]) do |ix, a|
-        a << border(horizontal, position, *[y_coordinate, (bx + ix)])
-      end
-    end
-
-    # From the second element of {#title_characters} remove the border from each
-    # {#horizontal_border} Vedeu::Char, and add the title character.
-    #
-    # @return [Array<Vedeu::Char>]
-    def titlebar
-      horizontal_border(:top_horizontal, y).each_with_index do |char, index|
-        if index >= 1 && index <= title_characters.size
-          char.border = nil
-          char.value  = title_characters[(index - 1)]
-        end
-      end
-    end
-
-    # @return [Array<String>]
-    def title_characters
-      @title_characters ||= padded_title.chars
-    end
-
-    # Pads the title with a single whitespace either side.
-    #
-    # @example
-    #   title = 'Truncated!'
-    #   width = 20
-    #   # => ' Truncated! '
-    #
-    #   width = 10
-    #   # => ' Trunca '
-    #
-    # @return [String]
-    # @see #truncated_title
-    def padded_title
-      truncated_title.center(truncated_title.size + 2)
-    end
-
-    # Truncates the title to the width of the interface, minus characters needed
-    # to ensure there is at least a single character of horizontal border and a
-    # whitespace on either side of the title.
-    #
-    # @example
-    #   title = 'Truncated!'
-    #   width = 20
-    #   # => 'Truncated!'
-    #
-    #   width = 10
-    #   # => 'Trunca'
-    #
-    # @return [String]
-    def truncated_title
-      title.chomp.slice(0..(width - 5))
-    end
-
-    # Return boolean indicating whether this border has a non-empty title.
-    #
-    # @return [Boolean]
-    def title?
-      present?(title)
-    end
-
-    # @param value [String]
-    # @param type [Symbol|NilClass]
-    # @param iy [Fixnum]
-    # @param ix [Fixnum]
-    # @return [Vedeu::Char]
-    def border(value, type = :border, iy = 0, ix = 0)
-      Vedeu::Char.new(value:    value,
-                      parent:   interface,
-                      colour:   colour,
-                      style:    style,
-                      position: Vedeu::Position[iy, ix],
-                      border:   type)
-    end
-
     # @return [Vedeu::Geometry]
     def geometry
       Vedeu.geometries.by_name(name)
@@ -331,6 +178,7 @@ module Vedeu
     def interface
       @interface ||= Vedeu.interfaces.by_name(name)
     end
+    alias_method :parent, :interface
 
     # The default values for a new instance of this class.
     #

data/lib/vedeu/output/compressor.rb

@@ -13,6 +13,8 @@ module Vedeu
       new(output).render
     end
 
+    # Returns a new instance of Vedeu::Compressor.
+    #
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [Vedeu::Compressor]
     def initialize(output)

data/lib/vedeu/output/foreground.rb

@@ -18,7 +18,7 @@ module Vedeu
       "\e[38;5;"
     end
 
-    # @return [Vedeu::ForegroundColours]
+    # @return [Vedeu::Foregrounds]
     def repository
       Vedeu.foreground_colours
     end

data/lib/vedeu/output/refresh.rb

@@ -11,9 +11,7 @@ module Vedeu
     #
     # @return [Array]
     def all
-      message = 'Refreshing all interfaces'
-
-      Vedeu.timer(message) do
+      Vedeu.timer('Refreshing all interfaces') do
         Vedeu.interfaces.zindexed.each { |model| by_name(model.name) }
       end
     end
@@ -36,9 +34,7 @@ module Vedeu
     # @return [Array|ModelNotFound] A collection of the names of interfaces
     #   refreshed, or an exception if the group was not found.
     def by_group(group_name)
-      message = "Refreshing group: '#{group_name}'"
-
-      Vedeu.timer(message) do
+      Vedeu.timer("Refreshing group: '#{group_name}'") do
         members    = Vedeu.groups.find!(group_name).members
         interfaces = members.each { |name| Vedeu.interfaces.by_name(name) }
         by_zindex  = interfaces.sort { |a, b| a.zindex <=> b.zindex }
@@ -52,9 +48,9 @@ module Vedeu
     #   named buffer.
     # @return [Array|ModelNotFound]
     def by_name(name)
-      message = "Refreshing interface: '#{name}'"
-
-      Vedeu.timer(message) { Vedeu.buffers.by_name(name).render }
+      Vedeu.timer("Refreshing interface: '#{name}'") do
+        Vedeu.buffers.by_name(name).render
+      end
     end
 
   end # Refresh