reterm 0.4.2 → 0.5.0

data/lib/reterm/version.rb

@@ -1,3 +1,3 @@
 module RETerm
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end # module RETerm

data/lib/reterm/window.rb

@@ -25,6 +25,9 @@ module RETerm
   #
   class Window
     include EventDispatcher
+    include LogHelpers
+
+    attr_reader :window_id
 
     attr_accessor :rows, :cols
     attr_accessor :x,    :y
@@ -48,8 +51,10 @@ module RETerm
     # Assign component to window. This will autoassign local
     # window to component as well.
     def component=(c)
-      c.window = self
-      c.colors = @colors if colored?
+      clear!
+
+      c.window   = self
+      c.colors   = @colors if colored?
       @component = c
     end
 
@@ -58,12 +63,44 @@ module RETerm
       !!@parent
     end
 
+    # Return boolean indicating if this window has children
+    def children?
+      !@children.empty?
+    end
+
+    # Return boolean indicating if this window is the
+    # first child of its parent
+    def first_child?
+      return true unless parent?
+      parent.children.index(self) == 0
+    end
+
+    # Return boolean indicating if this window is the
+    # last child of its parent
+    def last_child?
+      return true unless parent?
+      parent.children.index(self) == (parent.children.size - 1)
+    end
+
+    # Return root window (recusively), self if parent is not set
+    def root
+      parent? ? parent.root : self
+    end
+
+    def total_x
+      @tx ||= parent? ? (parent.total_x + x) : x
+    end
+
+    def total_y
+      @ty ||= parent? ? (parent.total_y + y) : y
+    end
+
     # Instantiate Window with given args. None are required, but
     # unless :rows, :cols, :x, or :y is specified, window will be
     # created in it's default position.
     #
     # This method will generate a unique id for each window
-    # and add it to a static registery for subsequent tracking.
+    # and add it to a static registry for subsequent tracking.
     #
     # @param [Hash] args arguments used to instantiate window
     # @option args [Integer] :rows number of rows to assign to window
@@ -76,13 +113,23 @@ module RETerm
     # @option args [Window] :parent parent to assign to window, if
     #   set window will be created a a child, else it will be
     #   independently created & tracked.
+    # @options args [Boolean] :expand bool indicating
+    #   if window can be expanded on request
+    # @options args [Boolean] :must_expand bool indicating
+    #   if window must be expanded when requested. Failure
+    #   to expand will result in an error
+    # @options args [Boolean] :fill bool indicating
+    #   if window should fill remaining space
     #
     def initialize(args={})
       @@registry ||= []
       @@registry  << self
 
-      @rows = args[:rows] || (Terminal.rows - 1)
-      @cols = args[:cols] || (Terminal.cols - 1)
+      @@wid ||= 0
+      @@wid  += 1
+      @window_id = @@wid
+
+      @children = []
 
       @x    = args[:x] || 0
       @y    = args[:y] || 0
@@ -90,38 +137,147 @@ module RETerm
       @vborder = args[:vborder] || 0
       @hborder = args[:hborder] || 0
 
-      self.component = args[:component] if args.key?(:component)
+      component = args[:component]
+
+      @rows = args[:rows] ||
+              (component ?
+               (component.requested_rows + component.extra_padding) :
+               Terminal.rows)
+
+      @cols = args[:cols] ||
+              (component ?
+               (component.requested_cols + component.extra_padding) :
+               Terminal.cols)
 
       if args[:parent]
         @parent = args[:parent]
+
+        @rows, @cols = *Window.adjust_proportional(@parent, @rows, @cols)
+        @x,    @y    = *Window.align(@parent, @x, @y, @rows, @cols)
+
         @win = parent.win.derwin(@rows, @cols, @y, @x)
 
       else
         @parent = nil
+
+        @rows, @cols = *Window.adjust_proportional(Terminal, @rows, @cols)
+        @x,    @y    = *Window.align(Terminal, @x, @y, @rows, @cols)
+
         @win = Ncurses::WINDOW.new(@rows, @cols, @y, @x)
       end
 
+      self.component = component if !!component
+
       Ncurses::keypad(@win, true)
 
-      @children = []
+      @win.timeout(SYNC_TIMEOUT) if @win && sync_enabled? # XXX
 
+      @expand      = !!args[:expand]
+      @must_expand = !!args[:must_expand]
 
-      @@wid ||= 0
-      @@wid  += 1
+      @fill        = !!args[:fill]
+    end
 
-      @window_id = @@wid
+    ###
+
+    # Adjusts rows/cols in a context dependent manner
+    # TODO should proporational percentage be of remaining area?
+    def self.adjust_proportional(parent, rows, cols)
+      nr = rows
+      nc = cols
+
+      nr = parent.rows * nr if rows < 1
+      nc = parent.cols * nc if cols < 1
+
+      return nr, nc
+    end
+
+    # Adjusts x/y in context dependent manner
+    def self.align(parent, x, y, rows, cols)
+      nx = x
+      ny = y
+
+      nx = 1 if x == :left
+      ny = 1 if y == :top
+
+      nx = parent.cols - cols - 1 if x == :right
+      ny = parent.rows - rows - 1 if y == :bottom
+
+      nx = parent.cols / 2 - cols / 2 if x == :center
+      ny = parent.rows / 2 - rows / 2 if y == :center
+
+      return nx, ny
+    end
+
+    # Adjusts rows / cols so as to fill parent
+    def self.fill_parent(parent, x, y, rows, cols)
+      if (y + rows) < parent.rows
+        rows = parent.rows - y - 1
+      end
+
+      if (x + cols) < parent.cols
+        cols = parent.cols - x - 1
+      end
+
+      return rows, cols
     end
 
+    ###
+
     # Invoke window finalization routine by destroying it
     # and all children
     def finalize!
+      erase
+      @@registry.delete(self)
+
       children.each { |c|
         del_child c
-        cdk_scr.destroy if cdk?
-        component.finalize! if component?
       }
+
+      cdk_scr.destroy if cdk?
+      component.finalize! if component?
+    end
+
+    ###
+
+    def expand?
+      !!@expand
+    end
+
+    def must_expand?
+      !!@must_expand
     end
 
+    def request_expansion(r, c)
+      h = {:rows => r,
+           :cols => c,
+           :x    => x,
+           :y    => y}
+
+      if parent?
+        if parent.component.exceeds_bounds_with?(h)
+          if parent.component.expandable?
+            parent.component.expand(h)
+
+          else
+            raise ArgumentError, "cannot expand" if must_expand?
+            return false
+          end
+        end
+
+      else
+        unless Terminal.contains?(h)
+          raise ArgumentError, "terminal too small" if must_expand?
+          return false
+        end
+      end
+
+      resize(r, c)
+      true
+    end
+
+    ###
+
     # Return cdk screen (only used by CDK components)
     def cdk_scr
       enable_cdk!
@@ -133,6 +289,8 @@ module RETerm
       !!@cdk_scr
     end
 
+    ###
+
     # Static method returning all tracked windows
     def self.all
       @@registry ||= []
@@ -145,6 +303,8 @@ module RETerm
       @@registry.select { |w| !w.parent? }
     end
 
+    ###
+
     # Create child window, this method should not be invoked
     # by end-user, rather it is is invoked the Layout#add_child
     # is called.
@@ -155,7 +315,7 @@ module RETerm
       c
     end
 
-    # Remove child window, like #add_child, this is used internally
+    # Remove child window, like #create_child, this is used internally
     # and should not be invoked by the end user
     def del_child(child)
       @children.delete(child)
@@ -164,6 +324,41 @@ module RETerm
       child.win.delwin
     end
 
+    # Return child containing specified screen coordiantes, else nil
+    def child_containing(x, y, z)
+      found = nil
+      children.find { |c|
+        next if found
+
+        # recursively descend into layout children
+        if c.component.kind_of?(Layout)
+          found = c.child_containing(x, y, z)
+
+        else
+          found =
+            c.total_x <= x && c.total_y <= y && # c.z >= z
+           (c.total_x + c.cols) >= x && (c.total_y + c.rows) >= y
+          found = c if found
+        end
+      }
+
+      found
+    end
+
+    ###
+
+    def resize(rows, cols)
+      r = win.resize rows, cols
+      raise ArgumentError, "could not resize window" if r == -1
+
+      @rows = rows
+      @cols = cols
+
+      self
+    end
+
+    ###
+
     # Clear window by removing all children and reinitializing window space
     def clear!
       children.each { |c|
@@ -176,7 +371,20 @@ module RETerm
 
     # Erase window drawing area
     def erase
-      @win.werase
+      children.each { |c|
+        c.erase
+      }
+
+      @win.werase if @win
+
+      component.component.erase if cdk?
+    end
+
+    # Erases window screen by overwriting it with blanks
+    def erase_scr
+      0.upto(rows) { |r|
+        mvaddstr(r, 1, " " * cols)
+      }
     end
 
     # Refresh / resynchronize window and all children
@@ -185,6 +393,17 @@ module RETerm
       children.each { |c|
         c.refresh
       }
+
+      component.component.screen.refresh if cdk?
+    end
+
+    def noutrefresh
+      @win.noutrefresh
+      children.each { |c|
+        c.noutrefresh
+      }
+
+      component.component.screen.noutrefresh if cdk?
     end
 
     # Remove Border around window
@@ -202,11 +421,61 @@ module RETerm
       @win.getch
     end
 
+    # Normal getch unless sync enabled in which case,
+    # timeout will be checked & components synchronized
+    def sync_getch
+      return self.getch unless sync_enabled?
+
+      c = -1
+      while c == -1 && !shutdown?
+        c = self.getch
+        run_sync!
+      end
+
+      c
+    end
+
+    # Dispatch to component synchronization
+    def sync!
+      component.sync! if component?
+      children.each { |c|
+        c.sync!
+      }
+    end
+
     # Write string at specified loc
     def mvaddstr(*a)
       @win.mvaddstr(*a)
     end
 
+    # Enable bold formatting
+    def bold!
+      @win.attron(Ncurses::A_BOLD)
+      return unless block_given?
+
+      yield
+      @win.attroff(Ncurses::A_BOLD)
+    end
+
+    # Disable bold formatting
+    def no_bold!
+      @win.attroff(Ncurses::A_BOLD)
+    end
+
+    # Enable reverse formatting
+    def reverse!
+      @win.attron(Ncurses::A_REVERSE)
+      return unless block_given?
+
+      yield
+      @win.attroff(Ncurses::A_REVERSE)
+    end
+
+    # Disabled reverse formatting
+    def no_reverse!
+      @win.attroff(Ncurses::A_REVERSE)
+    end
+
     # Return bool indiciating if colors are set
     def colored?
       !!@colors
@@ -214,8 +483,8 @@ module RETerm
 
     # Set window color
     def colors=(c)
-      @colors = c.is_a?(ColorPair) ? c : ColorPair.for(c)
-      @win.bkgd(Ncurses.COLOR_PAIR(@colors.id))
+      @colors = c.is_a?(ColorPair) ? c : ColorPair.for(c).first
+      @win.bkgd(Ncurses.COLOR_PAIR(@colors.id)) unless @win.nil?
 
       component.colors = @colors if component?
 
@@ -226,24 +495,21 @@ module RETerm
 
     # Return window dimensions as an array containing rows & cols
     def dimensions
-      @dimensions ||=
-        begin
-          rows = []
-          cols = []
-          @win.getmaxyx(rows, cols)
-          rows = rows.first
-          cols = cols.first
-          [rows, cols]
-        end
+      rows = []
+      cols = []
+      @win.getmaxyx(rows, cols)
+      rows = rows.first
+      cols = cols.first
+      [rows, cols]
     end
 
     # Return window rows
-    def rows
+    def actual_rows
       dimensions[0]
     end
 
     # Return window cols
-    def cols
+    def actual_cols
       dimensions[1]
     end
 
@@ -253,8 +519,8 @@ module RETerm
     end
 
     # Activate window component
-    def activate!
-      component.activate!
+    def activate!(*input)
+      component.activate!(*input)
     end
   end
 end # module RETerm