reterm 0.4.2

data/lib/reterm/panel.rb

@@ -0,0 +1,37 @@
+module RETerm
+  # Panels provide quick ways to switch between menus, pushing and
+  # poping them on/off an internal stack
+  class Panel
+    include EventDispatcher
+
+    # Initialize panel from the given window.
+    #
+    # This maintains an internal registry of panels created
+    # for event dispatching purposes
+    def initialize(window)
+      @@registry ||= {}
+
+      # panel already associated with window
+      raise ArgumentError, window if @@registry.key?(window)
+
+      @@registry[window] = self
+
+      @window = window
+      @panel  = Ncurses::Panel::PANEL.new(@window.win)
+    end
+
+    # Render this panel by surfacing it ot hte top of the stack
+    def show
+      Ncurses::Panel.top_panel(@panel)
+      update_reterm
+
+      @@registry.values.each { |panel|
+        if panel == self
+          dispatch :panel_show
+        else
+          panel.dispatch :panel_hide
+        end
+      }
+    end
+  end # class Panel
+end # module RETerm

data/lib/reterm/resize.rb

@@ -0,0 +1,27 @@
+module RETerm
+  # Seconds between terminal size syncs
+  RESIZE_TIME = 0.2
+
+  # Internal helper to track size of terminal.
+  # This is a simple mechanism that launches a
+  # worker thread to periodically poll terminal size.
+  def track_resize
+    @track_resize = true
+    d = Terminal.dimensions
+
+    @resize_thread = Thread.new {
+      while @track_resize
+        Terminal.reset!
+        t = Terminal.dimensions
+        Terminal.resize! if t != d
+        sleep(RESIZE_TIME)
+      end
+    }
+  end
+
+  # Terminate resize tracking thread (if running)
+  def stop_track_resize
+    @track_resize = false
+    @resize_thread.join if @resize_thread
+  end
+end # module RETerm

data/lib/reterm/terminal.rb

@@ -0,0 +1,33 @@
+module RETerm
+  # Provides helper mechanisms which to retrieve terminal
+  # information (dimensions, etc)
+  class Terminal
+    def self.reset!
+      @dimensions = nil
+    end
+
+    def self.dimensions
+      require 'terminfo'
+      @dimensions ||= TermInfo.screen_size
+    end
+
+    def self.load
+      dimensions
+      nil
+    end
+
+    def self.cols
+      dimensions[1]
+    end
+
+    def self.rows
+      dimensions[0]
+    end
+
+    def self.resize!
+      Window.top.each { |w|
+        w.dispatch :resize
+      }
+    end
+  end
+end # module Terminal

data/lib/reterm/version.rb

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

data/lib/reterm/window.rb

@@ -0,0 +1,260 @@
+module RETerm
+  # Windows are areas rendered on screen, associated with components
+  # to be rendered in them. They specify the position to start drawing
+  # component as well as the maximum width and height. A border may be
+  # drawn around a window and a {ColorPair} associated.
+  #
+  # If Layout is added to a Window, children may subsequently be added.
+  # This should be performed via the Layout#add_child method.
+  #
+  # @example adding a layout to a window
+  #   init_reterm {
+  #     win = Window.new :rows => 50, :cols => 30
+  #     layout = Layouts::Horizontal.new
+  #     win.component = layout
+  #
+  #     child = layout.add_child :rows => 5, :cols => 10
+  #     child.class # => RETerm::Window
+  #
+  #     label = Components::Label.new :text => "Hello World!"
+  #     child.component = label
+  #
+  #     update_reterm
+  #     sleep(5)
+  #   }
+  #
+  class Window
+    include EventDispatcher
+
+    attr_accessor :rows, :cols
+    attr_accessor :x,    :y
+
+    attr_accessor :vborder
+    attr_accessor :hborder
+
+    attr_accessor :component
+
+    attr_reader :win
+
+    attr_reader :parent
+    attr_accessor :children
+
+    # Return bool indicating if this window has a component
+    # associated with it
+    def component?
+      !!@component
+    end
+
+    # Assign component to window. This will autoassign local
+    # window to component as well.
+    def component=(c)
+      c.window = self
+      c.colors = @colors if colored?
+      @component = c
+    end
+
+    # Return boolean if this window is a child of another
+    def parent?
+      !!@parent
+    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.
+    #
+    # @param [Hash] args arguments used to instantiate window
+    # @option args [Integer] :rows number of rows to assign to window
+    # @option args [Integer] :cols number of cols to assign to window
+    # @option args [Integer] :x starting x position of window
+    # @option args [Integer] :y starting y position of window
+    # @option args [Integer] :vborder vertical border char
+    # @option args [Integer] :hborder horizontal border char
+    # @option args [Component] :component component to assign to window
+    # @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.
+    #
+    def initialize(args={})
+      @@registry ||= []
+      @@registry  << self
+
+      @rows = args[:rows] || (Terminal.rows - 1)
+      @cols = args[:cols] || (Terminal.cols - 1)
+
+      @x    = args[:x] || 0
+      @y    = args[:y] || 0
+
+      @vborder = args[:vborder] || 0
+      @hborder = args[:hborder] || 0
+
+      self.component = args[:component] if args.key?(:component)
+
+      if args[:parent]
+        @parent = args[:parent]
+        @win = parent.win.derwin(@rows, @cols, @y, @x)
+
+      else
+        @parent = nil
+        @win = Ncurses::WINDOW.new(@rows, @cols, @y, @x)
+      end
+
+      Ncurses::keypad(@win, true)
+
+      @children = []
+
+
+      @@wid ||= 0
+      @@wid  += 1
+
+      @window_id = @@wid
+    end
+
+    # Invoke window finalization routine by destroying it
+    # and all children
+    def finalize!
+      children.each { |c|
+        del_child c
+        cdk_scr.destroy if cdk?
+        component.finalize! if component?
+      }
+    end
+
+    # Return cdk screen (only used by CDK components)
+    def cdk_scr
+      enable_cdk!
+      @cdk_scr ||= CDK::SCREEN.new(@win)
+    end
+
+    # Return bool indicating if cdk is enabled for this window/component
+    def cdk?
+      !!@cdk_scr
+    end
+
+    # Static method returning all tracked windows
+    def self.all
+      @@registry ||= []
+      @@registry
+    end
+
+    # Static method returning top level windows
+    def self.top
+      @@registry ||= []
+      @@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.
+    def create_child(h={})
+      c = self.class.new h.merge(:parent => self)
+      c.colors = @colors if colored?
+      children << c
+      c
+    end
+
+    # Remove child window, like #add_child, this is used internally
+    # and should not be invoked by the end user
+    def del_child(child)
+      @children.delete(child)
+      @@registry.delete(child)
+      child.finalize!
+      child.win.delwin
+    end
+
+    # Clear window by removing all children and reinitializing window space
+    def clear!
+      children.each { |c|
+        del_child(c)
+      }
+
+      @children = []
+      erase
+    end
+
+    # Erase window drawing area
+    def erase
+      @win.werase
+    end
+
+    # Refresh / resynchronize window and all children
+    def refresh
+      @win.refresh
+      children.each { |c|
+        c.refresh
+      }
+    end
+
+    # Remove Border around window
+    def no_border!
+      @win.border(' '.ord, ' '.ord, ' '.ord, ' '.ord, ' '.ord, ' '.ord, ' '.ord, ' '.ord)
+    end
+
+    # Draw Border around window
+    def border!
+      @win.box(@vborder, @hborder)
+    end
+
+    # Blocking call to capture next character from window
+    def getch
+      @win.getch
+    end
+
+    # Write string at specified loc
+    def mvaddstr(*a)
+      @win.mvaddstr(*a)
+    end
+
+    # Return bool indiciating if colors are set
+    def colored?
+      !!@colors
+    end
+
+    # Set window color
+    def colors=(c)
+      @colors = c.is_a?(ColorPair) ? c : ColorPair.for(c)
+      @win.bkgd(Ncurses.COLOR_PAIR(@colors.id))
+
+      component.colors = @colors if component?
+
+      children.each { |ch|
+        ch.colors = c
+      }
+    end
+
+    # 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
+    end
+
+    # Return window rows
+    def rows
+      dimensions[0]
+    end
+
+    # Return window cols
+    def cols
+      dimensions[1]
+    end
+
+    # Draw component in window
+    def draw!
+      component.draw! if component?
+    end
+
+    # Activate window component
+    def activate!
+      component.activate!
+    end
+  end
+end # module RETerm

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: reterm
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Mo Morsi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ncursesw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: RETerm provides a framework and components to build full featured terminal
+  interfaces.
+email:
+- mo@morsi.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- designer/main.rb
+- designer/src/ComponentParams.rb
+- designer/src/ComponentsList.rb
+- designer/src/CreatedList.rb
+- designer/src/Designer.rb
+- designer/src/ToggleArea.rb
+- designer/src/common.rb
+- designer/src/component_factory.rb
+- designer/src/component_map.rb
+- designer/src/glade/ComponentParams.glade
+- designer/src/glade/Designer.glade
+- designer/src/images/add.png
+- designer/src/images/asciitext.png
+- designer/src/images/blank.png
+- designer/src/images/blank_sm.png
+- designer/src/images/button.png
+- designer/src/images/dial.png
+- designer/src/images/entry.png
+- designer/src/images/hslider.png
+- designer/src/images/label.png
+- designer/src/images/matrix.png
+- designer/src/images/orig/Check.png
+- designer/src/images/orig/ascii_text.png
+- designer/src/images/orig/button.png
+- designer/src/images/orig/dial.png
+- designer/src/images/orig/entry.png
+- designer/src/images/orig/hslider.png
+- designer/src/images/orig/label.png
+- designer/src/images/orig/matrix.png
+- designer/src/images/orig/radio.png
+- designer/src/images/orig/rocker.png
+- designer/src/images/orig/slist.png
+- designer/src/images/orig/vslider.png
+- designer/src/images/radio.png
+- designer/src/images/remove.png
+- designer/src/images/rocker.png
+- designer/src/images/slist.png
+- designer/src/images/vslider.png
+- lib/reterm.rb
+- lib/reterm/color_pair.rb
+- lib/reterm/component.rb
+- lib/reterm/components.rb
+- lib/reterm/components/ascii_text.rb
+- lib/reterm/components/button.rb
+- lib/reterm/components/dial.rb
+- lib/reterm/components/dialog.rb
+- lib/reterm/components/entry.rb
+- lib/reterm/components/hslider.rb
+- lib/reterm/components/image.rb
+- lib/reterm/components/label.rb
+- lib/reterm/components/matrix.rb
+- lib/reterm/components/radio.rb
+- lib/reterm/components/rocker.rb
+- lib/reterm/components/slist.rb
+- lib/reterm/components/template.rb
+- lib/reterm/components/vslider.rb
+- lib/reterm/init.rb
+- lib/reterm/layout.rb
+- lib/reterm/layouts.rb
+- lib/reterm/layouts/horizontal.rb
+- lib/reterm/layouts/vertical.rb
+- lib/reterm/loader.rb
+- lib/reterm/menu.rb
+- lib/reterm/mixins/cdk_component.rb
+- lib/reterm/mixins/component_input.rb
+- lib/reterm/mixins/event_dispatcher.rb
+- lib/reterm/mixins/nav_input.rb
+- lib/reterm/panel.rb
+- lib/reterm/resize.rb
+- lib/reterm/terminal.rb
+- lib/reterm/version.rb
+- lib/reterm/window.rb
+homepage: http://github.com/movitto/reterm
+licenses:
+- MIT
+metadata: {}
+post_install_message: |-
+  ---
+  To use all components, the following additional gem dependencies should be installed:
+  artii
+  drawille
+  chunky_png
+  cdkTo use the interface designer you will also need to install the \"visualruby\" gem
+  If optional dependencies are missing the framework will still work but dependent components will fail to load
+  ---
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Text Based UI Framework built ontop of ncurses
+test_files: []