vedeu 0.4.9 → 0.4.10

data/lib/vedeu/output/clear.rb

@@ -4,18 +4,23 @@ module Vedeu
   #
   class Clear
 
-    # Clears the area defined by the interface.
-    #
-    # @return [Array|String]
-    # @see #initialize
-    def self.clear(interface)
-      new(interface).write
+    class << self
+
+      # Clears the area defined by the interface.
+      #
+      # @return [Array|String]
+      # @see #initialize
+      def clear(interface)
+        new(interface).write
+      end
+      alias_method :render, :clear
+
     end
 
-    # Return a new instance of Output.
+    # Return a new instance of Vedeu::Clear.
     #
     # @param interface [Interface]
-    # @return [Output]
+    # @return [Vedeu::Clear]
     def initialize(interface)
       @interface = interface
     end
@@ -26,7 +31,7 @@ module Vedeu
     #
     # @return [Array<Array<Vedeu::Char>>]
     def clear
-      Array.new(interface.height) do |iy|
+      @clear ||= Array.new(interface.height) do |iy|
         Array.new(interface.width) do |ix|
           Vedeu::Char.new({ value:    ' ',
                             colour:   interface.colour,
@@ -48,7 +53,9 @@ module Vedeu
         Vedeu::HTMLRenderer.to_file(Vedeu::VirtualBuffer.retrieve)
       end
 
-      Vedeu::Terminal.output(Vedeu::Renderer.render(clear))
+      # Vedeu::FileRenderer.render(clear)
+
+      Vedeu::TerminalRenderer.render(clear)
     end
 
     private

data/lib/vedeu/output/colour.rb

@@ -22,7 +22,7 @@ module Vedeu
     # @return [Foreground|String]
     attr_reader :foreground
 
-    # Returns a new instance of Colour.
+    # Returns a new instance of Vedeu::Colour.
     #
     # @param attributes [Hash]
     # @option attributes background [String]

data/lib/vedeu/output/compositor.rb

@@ -20,7 +20,7 @@ module Vedeu
       new(name).compose
     end
 
-    # Initialize a new Compositor.
+    # Initialize a new Vedeu::Compositor.
     #
     # @param name [String] The name of the buffer.
     # @return [Compositor]
@@ -28,6 +28,9 @@ module Vedeu
       @name = name
     end
 
+    # Applies any overridden colours or styles in the buffered view to the
+    # stored interface.
+    #
     # @return [Array<Interface>]
     def compose
       buffer.each do |view|

data/lib/vedeu/output/foreground.rb

@@ -11,6 +11,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.foreground_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.foreground_colours.registered?(colour)
+    end
+
+    # Retrieves the escape sequence for the HTML/CSS colour code.
+    #
+    # @param colour [String]
+    # @return [String]
+    def retrieve(colour)
+      Vedeu.foreground_colours.retrieve(colour)
+    end
+
     # @return [String]
     def named_codes
       Vedeu::Esc.foreground_codes[colour]

data/lib/vedeu/output/html_char.rb

@@ -14,6 +14,8 @@ module Vedeu
       new(char).render
     end
 
+    # Returns a new instance of Vedeu::HTMLChar.
+    #
     # @param char [Vedeu::Char]
     # @return [Vedeu::HTMLChar]
     def initialize(char)

data/lib/vedeu/output/null_border.rb

@@ -0,0 +1,49 @@
+module Vedeu
+
+  # Provides a non-existent Vedeu::Border that acts like the real thing, but
+  # does nothing.
+  #
+  class NullBorder
+
+    # Returns a new instance of Vedeu::NullBorder.
+    #
+    # @param interface [Vedeu::Interface]
+    # @return [Vedeu::NullBorder]
+    def initialize(interface)
+      @interface = interface
+    end
+
+    # @return [Fixnum]
+    def bx
+      interface.x
+    end
+
+    # @return [Fixnum]
+    def bxn
+      interface.xn
+    end
+
+    # @return [Fixnum]
+    def by
+      interface.y
+    end
+
+    # @return [Fixnum]
+    def byn
+      interface.yn
+    end
+
+    # @return [Array]
+    def render
+      []
+    end
+
+    private
+
+    # @!attribute [r] interface
+    # @return [Vedeu::Interface]
+    attr_reader :interface
+
+  end # NullBorder
+
+end # Vedeu

data/lib/vedeu/output/output.rb

@@ -1,7 +1,4 @@
-require 'vedeu/output/clear'
-require 'vedeu/output/html_renderer'
-require 'vedeu/output/renderer'
-require 'vedeu/output/viewport'
+require 'vedeu/output/renderers/all'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/support/terminal'
 
@@ -20,7 +17,7 @@ module Vedeu
       new(interface).render
     end
 
-    # Return a new instance of Output.
+    # Return a new instance of Vedeu::Output.
     #
     # @param interface [Interface]
     # @return [Output]
@@ -33,12 +30,14 @@ module Vedeu
     # @return [Array]
     def render
       if Vedeu::Configuration.drb?
-        Vedeu.trigger(:_drb_store_output_, virtual_view)
+        Vedeu.trigger(:_drb_store_output_, rendered)
 
         Vedeu::HTMLRenderer.to_file(Vedeu::VirtualBuffer.retrieve)
       end
 
-      Vedeu::Terminal.output(Vedeu::Renderer.render(virtual_view))
+      # Vedeu::FileRenderer.render(rendered)
+
+      Vedeu::TerminalRenderer.render(rendered)
     end
 
     private
@@ -47,43 +46,8 @@ module Vedeu
     # @return [Interface]
     attr_reader :interface
 
-    # Builds up a virtual view; a grid of Vedeu::Char objects- each one holding
-    # one character along with its colour, style and position attributes.
-    #
-    # @note
-    #   omg!
-    #
-    # @return [Array<Array<Vedeu::Char>>]
-    def virtual_view
-      out = [ clear_area_first! ]
-
-      Vedeu.log(type: :output, message: "Rendering: '#{interface.name}'")
-
-      viewport.each_with_index do |line, iy|
-        row = []
-        line.each_with_index do |char, ix|
-          row << if char.x != ix || char.y != iy
-            char.position = Vedeu::IndexPosition[iy, ix, interface.top, interface.left]
-            char
-
-          else
-            char
-
-          end
-        end
-        out << row
-      end
-      out
-    end
-
-    # @return [Array<Array<Vedeu::Char>>]
-    def clear_area_first!
-      Vedeu::Clear.new(interface).clear
-    end
-
-    # @return [void]
-    def viewport
-      @viewport ||= Vedeu::Viewport.new(interface).render
+    def rendered
+      @rendered ||= interface.render
     end
 
   end # Output

data/lib/vedeu/output/renderers/all.rb

@@ -0,0 +1,3 @@
+require 'vedeu/output/renderers/file_renderer'
+require 'vedeu/output/renderers/html_renderer'
+require 'vedeu/output/renderers/terminal_renderer'

data/lib/vedeu/output/{renderer.rb → renderers/file_renderer.rb}

@@ -1,9 +1,10 @@
 module Vedeu
 
   # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-  # and content suitable for a terminal.
+  # and content suitable for a terminal, and writes them to a file in the /tmp
+  # directory.
   #
-  class Renderer
+  class FileRenderer
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
@@ -11,15 +12,17 @@ module Vedeu
       new(*output).render
     end
 
+    # Returns a new instance of Vedeu::FileRenderer.
+    #
     # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::Renderer]
+    # @return [Vedeu::FileRenderer]
     def initialize(*output)
-      @output = output
+      @output  = output
     end
 
     # @return [String]
     def render
-      Array(output).flatten.map(&:to_s).join
+      File.open("/tmp/out_#{Time.now.to_f}", 'w') { |f| f.write(parsed) }
     end
 
     private
@@ -28,6 +31,11 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
-  end # Renderer
+    # @return [String]
+    def parsed
+      Array(output).flatten.map(&:to_s).join
+    end
+
+  end # FileRenderer
 
 end # Vedeu

data/lib/vedeu/output/{html_renderer.rb → renderers/html_renderer.rb}

@@ -17,6 +17,8 @@ module Vedeu
       new(output).to_file(path)
     end
 
+    # Returns a new instance of Vedeu::HTMLRenderer.
+    #
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [Vedeu::HTMLRenderer]
     def initialize(output)
@@ -63,7 +65,7 @@ module Vedeu
 
     # @return [String]
     def template
-      File.dirname(__FILE__) + '/templates/html_renderer.vedeu'
+      File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
     end
 
     # @return [String]

data/lib/vedeu/output/renderers/terminal_renderer.rb

@@ -0,0 +1,50 @@
+module Vedeu
+
+  # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
+  # and content suitable for a terminal.
+  #
+  class TerminalRenderer
+
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(*output)
+      new(*output).render
+    end
+
+    # Returns a new instance of Vedeu::TerminalRenderer.
+    #
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [Vedeu::TerminalRenderer]
+    def initialize(*output)
+      @output = output
+    end
+
+    # @return [Array<String>]
+    def render
+      Vedeu::Terminal.output(hide_cursor, parsed, show_cursor)
+    end
+
+    private
+
+    # @!attribute [r] output
+    # @return [Array<Array<Vedeu::Char>>]
+    attr_reader :output
+
+    # @return [String]
+    def show_cursor
+      Vedeu::Esc.string(:show_cursor)
+    end
+
+    # @return [String]
+    def parsed
+      Array(output).flatten.map(&:to_s).join
+    end
+
+    # @return [String]
+    def hide_cursor
+      Vedeu::Esc.string(:hide_cursor)
+    end
+
+  end # TerminalRenderer
+
+end # Vedeu

data/lib/vedeu/output/text.rb

@@ -9,7 +9,7 @@ module Vedeu
       new(value, options).aligned
     end
 
-    # Returns a new instance of Text.
+    # Returns a new instance of Vedeu::Text.
     #
     # @param value [String]
     # @param options [Hash]

data/lib/vedeu/output/translator.rb

@@ -38,7 +38,7 @@ module Vedeu
       new(colour).escape_sequence
     end
 
-    # Return a new instance of Translator.
+    # Return a new instance of Vedeu::Translator.
     #
     # @param colour [Fixnum|String|Symbol]
     # @return [Translator]
@@ -52,6 +52,9 @@ module Vedeu
       if no_colour?
         ''
 
+      elsif registered?(colour)
+        retrieve(colour)
+
       elsif rgb?
         rgb
 
@@ -81,6 +84,22 @@ module Vedeu
 
     private
 
+    # Subclasses implement this method.
+    #
+    # @param colour [String]
+    # @return [String]
+    def retrieve(colour)
+      ''
+    end
+
+    # Subclasses implement this method.
+    #
+    # @param colour [String]
+    # @return [FalseClass]
+    def registered?(colour)
+      false
+    end
+
     # @return [Boolean]
     def no_colour?
       colour.nil? || colour.to_s.empty?
@@ -136,7 +155,7 @@ module Vedeu
     # @return [String]
     def rgb
       if Vedeu::Configuration.colour_mode == 16777216
-        sprintf(rgb_prefix, *css_to_rgb)
+        register(colour, sprintf(rgb_prefix, *css_to_rgb))
 
       else
         numbered

data/lib/vedeu/output/viewport.rb

@@ -24,7 +24,13 @@ module Vedeu
       :height,
       :width
 
-    # Returns an instance of Viewport.
+    # @param interface [Vedeu::Interface]
+    # @return [Array<Array<Vedeu::Char>>]
+    def self.render(interface)
+      new(interface).render
+    end
+
+    # Returns an instance of Vedeu::Viewport.
     #
     # @param interface [Interface] An instance of interface.
     # @return [Viewport]
@@ -37,30 +43,25 @@ module Vedeu
     #
     # @return [Array<Array<String>>]
     def render
-      if border?
-        out = []
+      Vedeu.log(type: :output, message: "Rendering: '#{interface.name}'")
 
-        out << border.top if border.top?
+      out = []
 
-        show[0...bordered_height].each do |line|
-          out << [border.left, line[0...bordered_width], border.right].flatten
+      show[0...bordered_height].each_with_index do |line, iy|
+        line[0...bordered_width].each_with_index do |column, ix|
+          column.position = IndexPosition[iy, ix, interface.border.by, interface.border.bx]
+          out << column
         end
-
-        out << border.bottom if border.bottom?
-
-        out
-
-      else
-        show
-
       end
+
+      out
     end
 
     # Returns a string representation of the viewport.
     #
     # @return [String]
     def to_s
-      render.map(&:join).join("\n")
+      render.map(&:to_s).join("\n")
     end
 
     private
@@ -80,41 +81,7 @@ module Vedeu
     def show
       return [] unless lines?
 
-      padded_lines.map { |line| padded_columns(line) }
-    end
-
-    # Returns the lines, padded where necessary for the viewport.
-    #
-    # @return [Array<Array<String>>]
-    def padded_lines
-      visible = lines[rows] || []
-
-      pad(visible, :height)
-    end
-
-    # Returns the columns, padded where necessary for the given line.
-    #
-    # @param line [Array<String>]
-    # @return [Array<String>]
-    def padded_columns(line)
-      visible = line.chars[columns] || []
-
-      pad(visible, :width)
-    end
-
-    # Pads the number of rows or columns to always return an Array of the same
-    # length for each viewport or line respectively.
-    #
-    # @param visible [Array<Array<String>>|Array<String>]
-    # @param dimension [Symbol] The dimension to pad (:height or :width).
-    # @return [Array<Array<String>>|Array<String>]
-    def pad(visible, dimension)
-      dim  = send(dimension)
-      size = visible.size
-
-      return visible unless size < dim
-
-      visible + [Vedeu::Char.new({ value: ' ' })] * (dim - size)
+      (lines[rows] || []).map { |line| (line.chars[columns] || []) }
     end
 
     # Using the current cursor's y position, return a range of visible lines.