vedeu 0.4.9 → 0.4.10

data/lib/vedeu/input/mapper.rb

@@ -27,6 +27,8 @@ module Vedeu
       new(key, name).valid?
     end
 
+    # Returns a new instance of Vedeu::Mapper.
+    #
     # @param key [NilClass|String|Symbol]
     # @param name [NilClass|String]
     # @param repository [NilClass|Repository]
@@ -37,6 +39,9 @@ module Vedeu
       @repository = repository || Vedeu.keymaps
     end
 
+    # Returns a boolean indicating that the key is registered to the current
+    # keymap or the global or system keymap.
+    #
     # @return [Boolean]
     def keypress
       return false unless key
@@ -50,6 +55,9 @@ module Vedeu
       false
     end
 
+    # Returns a boolean indicating that the key is not registered to the current
+    # keymap, the global keymap or the system keymap.
+    #
     # @return [Boolean]
     def valid?
       return false unless key

data/lib/vedeu/launcher.rb

@@ -27,6 +27,8 @@ module Vedeu
           kernel = Kernel).debug_execute!
     end
 
+    # Returns a new instance of Vedeu::Launcher.
+    #
     # @param argv [Array]
     # @param stdin [IO]
     # @param stdout [IO]

data/lib/vedeu/main_loop.rb

@@ -22,8 +22,6 @@ module Vedeu
       @loop    = true
 
       while(@loop) do
-        Vedeu.trigger(:tick)
-
         yield
 
         safe_exit_point!
@@ -51,7 +49,7 @@ module Vedeu
         fail VedeuInterrupt
 
       else
-        Vedeu.trigger(:tock)
+        Vedeu.trigger(:tock, Time.now.to_f)
 
       end
     end

data/lib/vedeu/models/cell.rb

@@ -28,6 +28,8 @@ module Vedeu
     # @return [NilClass|Fixnum]
     attr_reader :y
 
+    # Returns a new instance of Vedeu::Cell.
+    #
     # @param attributes [Hash<Symbol => Array<Symbol|String>, Fixnum, String, Symbol]
     # @option attributes background [NilClass|String]
     # @option attributes foreground [NilClass|String]

data/lib/vedeu/models/composition.rb

@@ -15,7 +15,7 @@ module Vedeu
     collection Vedeu::Interfaces
     member     Vedeu::Interface
 
-    # Returns a new instance of Composition.
+    # Returns a new instance of Vedeu::Composition.
     #
     # @param attributes [Hash]
     # @option attributes colour [Vedeu::Colour]

data/lib/vedeu/models/group.rb

@@ -13,7 +13,7 @@ module Vedeu
     # @return [String]
     attr_accessor :name
 
-    # Return a new instance of Group.
+    # Return a new instance of Vedeu::Group.
     #
     # @param attributes [Hash]
     # @option attributes members [Array] A collection of names of interfaces

data/lib/vedeu/models/interface.rb

@@ -1,5 +1,6 @@
 require 'vedeu/geometry/content'
 require 'vedeu/models/all'
+require 'vedeu/output/null_border'
 require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
 require 'vedeu/buffers/buffer'
@@ -58,10 +59,18 @@ module Vedeu
       :right,
       :bottom,
       :left,
+      :y,
+      :yn,
+      :x,
+      :xn,
       :width,
-      :height
+      :height,
+      :top_left,
+      :top_right,
+      :bottom_left,
+      :bottom_right
 
-    # Return a new instance of Interface.
+    # Return a new instance of Vedeu::Interface.
     #
     # @param attributes [Hash]
     # @option attributes colour [Vedeu::Colour]
@@ -117,11 +126,20 @@ module Vedeu
     #
     # @return [Vedeu::Border|NilClass]
     def border
-      if border?
+      @border ||= if border?
         Vedeu.borders.find(name)
+
+      else
+        Vedeu::NullBorder.new(self)
+
       end
     end
 
+    # @return [Array<Array<Vedeu::Char>>]
+    def clear
+      Vedeu::Clear.render(self)
+    end
+
     # Fetch the cursor belonging to this interface (by name), if one does not
     # exist, it will be created, stored and returned.
     #
@@ -151,6 +169,15 @@ module Vedeu
     alias_method :content?, :lines?
     alias_method :value?, :lines?
 
+    # @return [Array<Array<Vedeu::Char>>]
+    def render
+      [
+        clear,
+        border.render,
+        viewport
+      ]
+    end
+
     # @return [Interface]
     def store
       super
@@ -161,6 +188,11 @@ module Vedeu
       store_group
     end
 
+    # @return [Array<Array<Vedeu::Char>>]
+    def viewport
+      Vedeu::Viewport.render(self)
+    end
+
     private
 
     # The default values for a new instance of this class.

data/lib/vedeu/models/line.rb

@@ -25,7 +25,7 @@ module Vedeu
 
     alias_method :value, :streams
 
-    # Returns a new instance of Line.
+    # Returns a new instance of Vedeu::Line.
     #
     # @param attributes [Hash]
     # @option attributes streams [Vedeu::Streams]
@@ -64,6 +64,11 @@ module Vedeu
       streams.empty?
     end
 
+    # @return [NilClass|String]
+    def name
+      parent.name if parent
+    end
+
     # Returns the size of the content in characters without formatting.
     #
     # @return [Fixnum]

data/lib/vedeu/models/menu.rb

@@ -57,7 +57,7 @@ module Vedeu
       build({ name: name }, &block).store
     end
 
-    # Returns a new instance of Menu.
+    # Returns a new instance of Vedeu::Menu.
     #
     # @param attributes [Hash]
     # @option attributes collection [Array]

data/lib/vedeu/models/stream.rb

@@ -27,7 +27,7 @@ module Vedeu
     alias_method :data,    :value
     alias_method :text,    :value
 
-    # Returns a new instance of Stream.
+    # Returns a new instance of Vedeu::Stream.
     #
     # @param attributes [Hash]
     # @option attributes value [String]
@@ -74,6 +74,11 @@ module Vedeu
       value.empty?
     end
 
+    # @return [NilClass|String]
+    def name
+      parent.name if parent
+    end
+
     # Returns the size of the content in characters without formatting.
     #
     # @return [Fixnum]
@@ -81,22 +86,6 @@ module Vedeu
       value.size
     end
 
-    # @return [String]
-    def value
-      # Vedeu::Char.coerce(@value, parent, colour, style)
-      # @value ||= if @value.size > 1
-      #   @value.chars.map do |char|
-      #     Vedeu::Char.new(char, parent, colour, style)
-      #   end
-      # elsif @value.size == 1
-      #   Vedeu::Char.new(@value, parent, colour, style)
-      # else
-      #   # ???
-      # end
-
-      @value
-    end
-
     # Delegate to Vedeu::Line#width if available.
     #
     # @return [Fixnum]

data/lib/vedeu/output/all.rb

@@ -5,6 +5,7 @@ require 'vedeu/output/background'
 require 'vedeu/output/foreground'
 
 require 'vedeu/output/border'
+require 'vedeu/output/null_border'
 require 'vedeu/output/colour'
 require 'vedeu/output/compositor'
 
@@ -15,10 +16,10 @@ require 'vedeu/output/style'
 require 'vedeu/output/text'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/output/html_char'
-require 'vedeu/output/html_renderer'
 require 'vedeu/output/refresh'
 
-require 'vedeu/output/renderer'
+require 'vedeu/output/renderers/all'
+
 require 'vedeu/output/output'
 
 require 'vedeu/output/viewport'

data/lib/vedeu/output/background.rb

@@ -7,6 +7,32 @@ module Vedeu
 
     private
 
+    # Registers a HTML/CSS colour code and escape sequence to reduce processing.
+    #
+    # @param colour [String] A HTML/CSS colour code.
+    # @param escape_sequence [String] The HTML/CSS colour code as an escape
+    #   sequence.
+    # @return [String]
+    def register(colour, escape_sequence)
+      Vedeu.background_colours.register(colour, escape_sequence)
+    end
+
+    # Returns a boolean indicating the HTML/CSS colour code has been registered.
+    #
+    # @param colour [String]
+    # @return [Boolean]
+    def registered?(colour)
+      Vedeu.background_colours.registered?(colour)
+    end
+
+    # Retrieves the escape sequence for the HTML/CSS colour code.
+    #
+    # @param colour [String]
+    # @return [String]
+    def retrieve(colour)
+      Vedeu.background_colours.retrieve(colour)
+    end
+
     # @return [String]
     def named_codes
       Vedeu::Esc.background_codes[colour]

data/lib/vedeu/output/border.rb

@@ -80,7 +80,7 @@ module Vedeu
     # @return [Style]
     attr_reader :style
 
-    # Returns a new instance of Border.
+    # Returns a new instance of Vedeu::Border.
     #
     # @param attributes [Hash]
     # @option attributes bottom_left [String] The bottom left border character.
@@ -123,6 +123,50 @@ module Vedeu
       @style        = @attributes[:style]
     end
 
+    # @return [Fixnum]
+    def bx
+      if enabled? && left?
+        interface.x + 1
+
+      else
+        interface.x
+
+      end
+    end
+
+    # @return [Fixnum]
+    def bxn
+      if enabled? && right?
+        interface.xn - 1
+
+      else
+        interface.xn
+
+      end
+    end
+
+    # @return [Fixnum]
+    def by
+      if enabled? && top?
+        interface.y + 1
+
+      else
+        interface.y
+
+      end
+    end
+
+    # @return [Fixnum]
+    def byn
+      if enabled? && bottom?
+        interface.yn - 1
+
+      else
+        interface.yn
+
+      end
+    end
+
     # Returns the width of the interface determined by whether a left, right,
     # both or neither borders are shown.
     #
@@ -173,6 +217,19 @@ module Vedeu
       @colour = Vedeu::Colour.coerce(value)
     end
 
+    # @return [Array<Array<Vedeu::Char>>]
+    def render
+      return [] unless enabled?
+
+      out = [top, bottom]
+
+      height.times do |y|
+        out << [left(y), right(y)]
+      end
+
+      out.flatten
+    end
+
     # @return [Vedeu::Style]
     def style
       Vedeu::Style.coerce(@style)
@@ -185,15 +242,6 @@ module Vedeu
       @style = Vedeu::Style.coerce(value)
     end
 
-    # Returns a string representation of the border for the interface without
-    # content.
-    #
-    # @return [Boolean]
-    def to_s
-      render = Vedeu::Viewport.new(interface).render
-      render.map { |line| line.flatten.join }.join("\n")
-    end
-
     # Renders the bottom border for the interface.
     #
     # @return [String]
@@ -203,8 +251,8 @@ module Vedeu
       out = []
 
       out << border(bottom_left, :bottom_left) if left?
-      width.times do
-        out << border(horizontal, :bottom_horizontal)
+      width.times do |ix|
+        out << border(horizontal, :bottom_horizontal, nil, ix)
       end
       out << border(bottom_right, :bottom_right) if right?
 
@@ -213,20 +261,22 @@ module Vedeu
 
     # Renders the left border for the interface.
     #
+    # @param iy [Fixnum]
     # @return [String]
-    def left
+    def left(iy = 0)
       return [] unless left?
 
-      border(vertical, :left_vertical)
+      border(vertical, :left_vertical, iy)
     end
 
     # Renders the right border for the interface.
     #
+    # @param iy [Fixnum]
     # @return [String]
-    def right
+    def right(iy = 0)
       return [] unless right?
 
-      border(vertical, :right_vertical)
+      border(vertical, :right_vertical, iy)
     end
 
     # Renders the top border for the interface.
@@ -237,8 +287,8 @@ module Vedeu
 
       out = []
       out << border(top_left, :top_left) if left?
-      width.times do
-        out << border(horizontal, :top_horizontal)
+      width.times do |ix|
+        out << border(horizontal, :top_horizontal, nil, ix)
       end
       out << border(top_right, :top_right) if right?
 
@@ -249,21 +299,18 @@ module Vedeu
 
     # @param value [String]
     # @param type [Symbol|NilClass]
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
     # @return [Vedeu::Char]
-    def border(value, type = :border)
+    def border(value, type = :border, iy = 0, ix = 0)
       Vedeu::Char.new({ value:    value,
                         parent:   interface,
                         colour:   colour,
                         style:    style,
-                        position: nil,
+                        position: position(type, iy, ix),
                         border:   type })
     end
 
-    # @return [Vedeu::Interface]
-    def interface
-      @interface ||= Vedeu.interfaces.find(name)
-    end
-
     # The default values for a new instance of this class.
     #
     # @return [Hash]
@@ -287,6 +334,39 @@ module Vedeu
       }
     end
 
+    # @return [Vedeu::Interface]
+    def interface
+      @interface ||= Vedeu.interfaces.find(name)
+    end
+
+    # @param name [Symbol]
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::Position]
+    def position(name, iy = 0, ix = 0)
+      case name
+      when :top_horizontal
+        Vedeu::Position[interface.y, (bx + ix)]
+
+      when :bottom_horizontal
+        Vedeu::Position[interface.yn, (bx + ix)]
+
+      when :left_vertical
+        Vedeu::Position[(by + iy), interface.x]
+
+      when :right_vertical
+        Vedeu::Position[(by + iy), interface.xn]
+
+      when :bottom_left  then interface.bottom_left
+      when :bottom_right then interface.bottom_right
+      when :top_left     then interface.top_left
+      when :top_right    then interface.top_right
+      else
+        nil
+
+      end
+    end
+
   end # Border
 
 end # Vedeu