vedeu 0.4.26 → 0.4.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bba3e9391ad8c7f14484b09adc03826c64cdff5
-  data.tar.gz: 166ea2c63e70165ec7a7b33902e8946d7f14c3b5
+  metadata.gz: 74b7a510a12140180d027df9a11090a30a05c9a6
+  data.tar.gz: 22694b40928d66db21201bf4ba5e4db403b25d32
 SHA512:
-  metadata.gz: b18d838e63f6d47ed70ad102e5db5157bbebebbf34faf0acdcc7cbdc34cfbf13348ee2d24cb3e765d478d1f7076290c5053c1092f60d1087bf8093c97d42b603
-  data.tar.gz: c10f07257a95dde84f961448fe4ba6d07a2539235258be5163792eeb1c345af2052786d2e006a1dd54f3452cf931aa10faf037e9fd559ef7073803186e98c393
+  metadata.gz: 3559b8cbb66f263c3ae5ba69057003c076a471b64344356283fee0ea65f1a37517408c9b7efe7f256f79d03ebcf628534c71f7479a8a317a8d8d605438c6cdb7
+  data.tar.gz: 62aa833e9ff4e93306294626b982da0b44bdcfbffe03d9cb77e227440d8c8872a13830a733a7408d5f3b4efb437d0d50e519ba1191463576b9b5db6be5861da6

data/examples/material_colours_app.rb

@@ -25,11 +25,12 @@ class VedeuMaterialColoursApp
     colour foreground: '#ffffff', background: :default
     cursor!
     geometry 'main_interface' do
-      x  5
-      xn 25
-      y  3
+      x  3
+      xn 24
+      y  2
       yn 13
     end
+    zindex 2
   end
 
   interface 'other_interface' do
@@ -45,6 +46,7 @@ class VedeuMaterialColoursApp
       y  3
       yn 13
     end
+    zindex 1
   end
 
   keymap('_global_') do

data/examples/panel_app.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+# An example application to demonstrate colours, cursor and interface movement,
+# maximising/unmaximising of interfaces and toggling of cursors and interfaces.
+class VedeuPanelApp
+
+  include Vedeu
+
+  configure do
+    debug!
+    log '/tmp/vedeu_panel_app.log'
+    # renderers Vedeu::Renderers::File
+  end
+
+  # line { centre 'Blue',        width: 20, background: '#2196f3' }
+  interface 'main_interface' do
+    border 'main_interface' do
+      colour foreground: '#000000', background: '#cddc39' # lime
+      title 'Panel: Yes/No'
+    end
+    colour foreground: '#000000', background: '#cddc39'
+    cursor!
+    geometry 'main_interface' do
+      centred!
+      width  columns(10)
+      height 9
+    end
+  end
+
+  keymap('_global_') do
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
+  end
+
+  renders do
+    view 'main_interface' do
+      lines do
+        line ' '
+        line 'This is an example panel. It should be used for Yes/No questions.'
+        line 'Do you like it?'
+      end
+      button('Yes!', :confirm, true)
+    end
+  end
+
+  focus_by_name 'main_interface'
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end
+
+VedeuPanelApp.start(ARGV)

data/lib/vedeu/bindings.rb

@@ -110,6 +110,16 @@ module Vedeu
       Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
     end
 
+    # When triggered will return the current position of the cursor.
+    Vedeu.bind(:_cursor_position_) do |name|
+      named  = name ? name : Vedeu.focus
+      cursor = Vedeu.cursors.by_name(named)
+
+      Vedeu.log(type: :debug, message: cursor.inspect)
+
+      Vedeu::Position.new(cursor.y, cursor.x) if cursor
+    end
+
     # @see {Vedeu::Move}
     Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }
 

data/lib/vedeu/cursor/cursor.rb

@@ -106,6 +106,12 @@ module Vedeu
       @show_cursor ||= Vedeu::EscapeChar.new(Vedeu::Esc.show_cursor)
     end
 
+    # @param value [Boolean]
+    # @return [void]
+    def visible=(value)
+      @visible = @attributes[:visible] = value
+    end
+
     private
 
     # Return the position of this cursor.

data/lib/vedeu/cursor/move.rb

@@ -148,22 +148,10 @@ module Vedeu
     # @return [Hash<Symbol => Boolean,Fixnum, String>]
     def merged_attributes
       if entity.to_s == 'Vedeu::Geometry'
-        {
-          centred:    false,
-          maximised:  false,
-          name:       name,
-          x:          (x + dx),
-          y:          (y + dy),
-          xn:         (xn + dx),
-          yn:         (yn + dy),
-        }
+        geometry_attributes
 
       else
-        cursor.attributes.merge!(
-          x:  x_position,
-          y:  y_position,
-          ox: ox,
-          oy: oy)
+        cursor_attributes
 
       end
     end
@@ -212,11 +200,29 @@ module Vedeu
       @cursor ||= Vedeu.cursors.by_name(name)
     end
 
+    # @return [Hash<Symbol => void>]
+    def cursor_attributes
+      cursor.attributes.merge!(x: x_position, y: y_position, ox: ox, oy: oy)
+    end
+
     # @return (see Vedeu::Geometries#by_name)
     def geometry
       @geometry ||= Vedeu.geometries.by_name(name)
     end
 
+    # @return [Hash<Symbol => FalseClass,String,Fixnum>]
+    def geometry_attributes
+      {
+        centred:    false,
+        maximised:  false,
+        name:       name,
+        x:          (x + dx),
+        y:          (y + dy),
+        xn:         (xn + dx),
+        yn:         (yn + dy),
+      }
+    end
+
     # Apply the direction amount to the cursor offset. If the offset is less
     # than 0, correct to 0.
     #

data/lib/vedeu/dsl/interface.rb

@@ -198,6 +198,13 @@ module Vedeu
         model.name = value
       end
 
+      # Set the cursor to invisible for the interface.
+      #
+      # @return [Vedeu::Cursor]
+      def no_cursor!
+        cursor(false)
+      end
+
       # Set the interface to visible.
       #
       # @return [void]
@@ -238,6 +245,55 @@ module Vedeu
         model.visible = boolean
       end
 
+      # Set the zindex of the interface. This controls the render order of
+      # interfaces. Interfaces with a lower zindex will render before those
+      # with a higher zindex.
+      #
+      # @example
+      #   --4-- # rendered last
+      #   --3--
+      #   --2--
+      #   --1-- # rendered first
+      #
+      #   interface 'my_interface' do
+      #     zindex 3
+      #     # ...
+      #
+      # @param value [Fixnum]
+      # @return [void]
+      def zindex(value)
+        model.zindex = value
+      end
+      alias_method :z_index, :zindex
+      alias_method :z,       :zindex
+
+      # @param label [String]
+      # @param name [String|Symbol]
+      # @param value [Boolean|void]
+      # @return [void]
+      def button(label, name, value = true)
+        button_name   = "button_#{model.name}_#{name}"
+        button_label  = " #{label} "
+        button_height = 3
+        button_width  = button_label.size + 2
+
+        Vedeu.interface button_name do
+          border {}
+          cursor
+          geometry do
+            height(button_height)
+            width(button_width)
+          end
+        end
+        Vedeu.renders do
+          view button_name do
+            lines do
+              line button_label
+            end
+          end
+        end
+      end
+
       protected
 
       # @!attribute [r] client

data/lib/vedeu/models/escape_char.rb

@@ -1,7 +1,14 @@
 module Vedeu
 
+  # Represents an invisible escape character sequence.
   class EscapeChar
 
+    # @!attribute [r] value
+    # @return [String]
+    attr_reader :value
+    alias_method :to_s, :value
+    alias_method :to_str, :value
+
     # @param value [String]
     # @return [Vedeu::EscapeChar]
     def initialize(value)
@@ -37,13 +44,6 @@ module Vedeu
       ''
     end
 
-    # @return [String]
-    def value
-      @value
-    end
-    alias_method :to_s, :value
-    alias_method :to_str, :value
-
   end # EscapeChar
 
 end # Vedeu

data/lib/vedeu/models/interface.rb

@@ -36,6 +36,10 @@ module Vedeu
     # @return [Vedeu::Composition]
     attr_accessor :parent
 
+    # @!attribute [rw] zindex
+    # @return [Fixnum]
+    attr_accessor :zindex
+
     # @!attribute [rw] visible
     # @return [Boolean] Whether the interface is visible.
     attr_accessor :visible
@@ -62,6 +66,7 @@ module Vedeu
     # @option attributes repository [Vedeu::InterfacesRepository]
     # @option attributes style [Vedeu::Style]
     # @option attributes visible [Boolean]
+    # @option attributes zindex [Fixnum]
     # @return [Vedeu::Interface]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
@@ -74,6 +79,7 @@ module Vedeu
       @parent     = @attributes[:parent]
       @repository = @attributes[:repository]
       @visible    = @attributes[:visible]
+      @zindex     = @attributes[:zindex]
     end
 
     # @param child [Vedeu::Line]
@@ -110,13 +116,17 @@ module Vedeu
     def render
       return [] unless visible?
 
-      [
-        hide_cursor,
+      Vedeu.trigger(:_cursor_hide_, name)
+
+      output = [
         Vedeu::Clear.new(self).render,
         Vedeu.borders.by_name(name).render,
         Vedeu::Viewport.render(self),
-        show_cursor,
       ]
+
+      Vedeu.trigger(:_cursor_show_, name)
+
+      output
     end
 
     # @return [Interface]
@@ -150,23 +160,10 @@ module Vedeu
         repository: Vedeu.interfaces,
         style:      nil,
         visible:    true,
+        zindex:     0,
       }
     end
 
-    # @return [String]
-    def hide_cursor
-      return cursor.hide_cursor if cursor.visible?
-
-      ''
-    end
-
-    # @return [String]
-    def show_cursor
-      return cursor.show_cursor if cursor.visible?
-
-      ''
-    end
-
   end # Interface
 
 end # Vedeu

data/lib/vedeu/models/panel.rb

@@ -0,0 +1,17 @@
+module Vedeu
+
+  class Panel
+
+    def initialize
+    end
+
+    private
+
+    # @return [Vedeu::Area]
+    def area
+      @area = Vedeu::Area.from_dimensions(y_yn: y_yn, x_xn: x_xn)
+    end
+
+  end # Panel
+
+end # Vedeu

data/lib/vedeu/models/stream.rb

@@ -55,7 +55,7 @@ module Vedeu
     def chars
       return [] if empty?
 
-      value.chars.map do |char|
+      @chars ||= value.chars.map do |char|
         member.new(value:    char,
                    parent:   parent,
                    colour:   colour,

data/lib/vedeu/output/border.rb

@@ -159,15 +159,13 @@ module Vedeu
       return [] unless visible?
       return [] unless enabled?
 
-      Vedeu::Timer.for(:debug, "Border rendering: #{name}") do
-        out = [top, bottom]
+      out = [top, bottom]
 
-        height.times do |y|
-          out << [left(y), right(y)]
-        end
-
-        out.flatten
+      height.times do |y|
+        out << [left(y), right(y)]
       end
+
+      out.flatten
     end
 
     # @return [String]
@@ -183,9 +181,9 @@ module Vedeu
       return [] unless bottom?
 
       out = []
-      out << border(bottom_left, :bottom_left) if left?
-      out << horizontal_border(:bottom_horizontal)
-      out << border(bottom_right, :bottom_right) if right?
+      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
 
@@ -196,7 +194,7 @@ module Vedeu
     def left(iy = 0)
       return [] unless left?
 
-      border(vertical, :left_vertical, iy)
+      border(vertical, :left_vertical, *[(by + iy), x])
     end
 
     # Renders the right border for the interface.
@@ -206,7 +204,7 @@ module Vedeu
     def right(iy = 0)
       return [] unless right?
 
-      border(vertical, :right_vertical, iy)
+      border(vertical, :left_vertical, *[(by + iy), xn])
     end
 
     # Renders the top border for the interface.
@@ -216,15 +214,15 @@ module Vedeu
       return [] unless top?
 
       out = []
-      out << border(top_left, :top_left) if left?
+      out << border(top_left, :top_left, *[y, x]) if left?
       if title?
         out << titlebar
 
       else
-        out << horizontal_border(:top_horizontal)
+        out << horizontal_border(:top_horizontal, y)
 
       end
-      out << border(top_right, :top_right) if right?
+      out << border(top_right, :top_right, *[y, xn]) if right?
       out
     end
 
@@ -239,9 +237,9 @@ module Vedeu
 
     # @param position [Symbol] Either :top_horizontal, or :bottom_horizontal.
     # @return [Array<Vedeu::Char>]
-    def horizontal_border(position)
+    def horizontal_border(position, y_coordinate)
       width.times.each_with_object([]) do |ix, a|
-        a << border(horizontal, position, nil, ix)
+        a << border(horizontal, position, *[y_coordinate, (bx + ix)])
       end
     end
 
@@ -250,7 +248,7 @@ module Vedeu
     #
     # @return [Array<Vedeu::Char>]
     def titlebar
-      horizontal_border(:top_horizontal).each_with_index do |char, index|
+      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)]
@@ -313,7 +311,7 @@ module Vedeu
                       parent:   interface,
                       colour:   colour,
                       style:    style,
-                      position: position(type, iy, ix),
+                      position: Vedeu::Position[iy, ix],
                       border:   type)
     end
 
@@ -356,24 +354,6 @@ module Vedeu
       }
     end
 
-    # @param name [Symbol]
-    # @param iy [Fixnum]
-    # @param ix [Fixnum]
-    # @return [Vedeu::Position]
-    def position(name, iy = 0, ix = 0)
-      coords = case name
-               when :top_horizontal    then [y, (bx + ix)]
-               when :bottom_horizontal then [yn, (bx + ix)]
-               when :left_vertical     then [(by + iy), x]
-               when :right_vertical    then [(by + iy), xn]
-               when :bottom_left       then [yn, x]
-               when :bottom_right      then [yn, xn]
-               when :top_left          then [y, x]
-               when :top_right         then [y, xn]
-               end
-      Vedeu::Position.coerce(coords)
-    end
-
   end # Border
 
 end # Vedeu