rbhex-core 1.0.0

data/lib/rbhex/core/include/rchangeevent.rb

@@ -0,0 +1,27 @@
+=begin
+  * Name: ChangeEvent
+  * Description: Event used to notify interested parties that state of component has changed
+  * Author: rkumar (arunachalesha)
+  
+  --------
+  * Date: 2010-02-26 11:32 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+
+# Event created when state changed (as in ViewPort)
+module RubyCurses
+  class ChangeEvent
+    attr_accessor :source
+    def initialize source
+      @source = source
+    end
+    def to_s
+      inspect
+    end
+    def inspect
+      "ChangeEvent #{@source}"
+    end
+  end
+end

data/lib/rbhex/core/include/rhistory.rb

@@ -0,0 +1,95 @@
+# ----------------------------------------------------------------------------- #
+#         File: rhistory.rb
+#  Description: a module that pops up history, and then updates selected value
+#               This goes with Field.
+#               e.g.,
+#               field.extend(FieldHistory)
+#
+#               The module name History was throwing up errors
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2011-11-27 - 18:10
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2011-11-27 - 20:11
+# ----------------------------------------------------------------------------- #
+#
+# supply history for this object, at least give an empty array
+# widget would typically be Field,
+#  otherwise it should implement *text()* for getting and setting value
+#  and a *CHANGED* event for when user has modified a value and moved out
+# You can externally set $history_key to any unused key, otherwise it is M-h
+module RubyCurses
+  extend self
+  module FieldHistory
+    def self.extended(obj)
+
+      obj.instance_exec {
+        @history ||= []
+        $history_key ||= ?\M-h
+        # ensure that the field is not overriding this in handle_key
+        bind_key($history_key) { _show_history }
+        # widget should have CHANGED event, or this will either give error, or just not work
+        # else please update history whenever you want a value to be retrieved
+        bind(:CHANGED) { @history << @text if @text && (!@history.include? @text) }
+      }
+    end
+
+    # pass the array of history values
+    # Trying out a change where an item can also be sent in.
+    # I am lost, i want the initialization to happen once.
+    def history arr
+      return @history unless arr
+      if arr.is_a? Array
+        @history = arr
+      else
+        @history << arr unless @history.include? arr
+      end
+    end
+    def history=(x); history(x); end
+
+    # pass in some configuration for histroy such as row and column to show popup on
+    def history_config config={}
+      @_history_config = config
+    end
+
+    # popup the hist
+    #
+    private
+    def _show_history
+      return unless @history
+      return  if @history.empty?
+      list = @history
+      @_history_config ||= {}
+      #list = ["No history"]  if @history.empty?
+      raise ArgumentError, "show_history got nil list" unless list
+      # calculate r and c
+      # col if fine, except for when there's a label.
+      wcol = 0 # taking care of when dialog uses history 2012-01-4
+      wcol = self.form.window.left if self.form
+      c = wcol + ( @field_col || @col) # this is also dependent on window coords, as in a status_window or messagebox
+      sz = @history.size
+      wrow = 0
+      wrow = self.form.window.top if self.form
+      crow = wrow + @row
+      # if list can be displayed above, then fit it just above
+      if crow > sz + 2
+        r = crow - sz - 2
+      else
+        # else fit it in next row
+        r = crow + 1
+      end
+      #r = @row - 10
+      #if @row < 10
+        #r = @row + 1
+      #end
+      r = @_history_config[:row] || r
+      c = @_history_config[:col] || c
+      ret = popuplist(list, :row => r, :col => c, :title  => " History ")
+      if ret
+        self.text = list[ret]
+        self.set_form_col
+      end
+      @form.repaint if @form
+      @window.wrefresh if @window
+    end
+  end # mod History
+end # mod RubyC

data/lib/rbhex/core/include/rinputdataevent.rb

@@ -0,0 +1,47 @@
+=begin
+  * Name: InputDataEvent
+  * Description: Event created when data modified in Field or TextEdit
+  * Author: rkumar (arunachalesha)
+  
+  --------
+  * Date:  2008-12-24 17:27 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+NOTE: this is how we used to write code in the Java days. Anyone reading this source,
+this is NOT how to code in rubyland. Please see this link, for how to code such as class:
+http://blog.grayproductions.net/articles/all_about_struct
+
+=end
+
+# Event created when data modified in Field or TextEdit
+#  2008-12-24 17:54 
+module RubyCurses
+  class InputDataEvent
+    attr_accessor :index0, :index1, :source, :type, :row, :text
+    def initialize index0, index1, source, type, row, text
+      @index0 = index0
+      @index1 = index1
+      @source = source
+      @type = type
+      @row = row
+      @text = text
+    end
+    # until now to_s was returning inspect, but to make it easy for users let us return the value
+    # they most expect which is the text that was changed
+    def to_s
+      inspect
+    end
+    def inspect
+      ## now that textarea.to_s prints content we shouldn pass it here.
+      #"#{@type.to_s}, #{@source}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+      "#{@type.to_s}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+    end
+    # this is so that earlier applications were getting source in the block, not an event. they 
+    # were doing a fld.getvalue, so we must keep those apps running
+    # @since 1.2.0  added 2010-09-11 12:25 
+    def getvalue
+      @source.getvalue
+    end
+  end
+end

data/lib/rbhex/core/include/vieditable.rb

@@ -0,0 +1,172 @@
+#**************************************************************
+# Author: rkumar (arunachalesha)
+# Date: 2010-03-11 22:18
+# Provides the caller ability to do some edit operations
+# on list widgets using either keys (vim largely)
+# or a menu. made originally for textview and multitextview
+#
+#**************************************************************
+
+
+require 'rbhex/core/include/listeditable'
+module RubyCurses
+  module ViEditable
+    include ListEditable
+
+    def vieditable_init
+      $log.debug " inside vieditable_init "
+      @editable = true
+      bind_key( ?C, :edit_line)
+      #bind_key( ?o, :insert_line)
+      #bind_key( ?O) { insert_line(@current_index-1) }
+      bind_key( ?o) { insert_line(@current_index+1) }
+      bind_key( ?O) { insert_line(@current_index) }
+      bind_key( ?D, :delete_eol)
+      bind_key( [?d, ?$], :delete_eol)
+      bind_key( [?d, ?d] , :delete_line )
+      bind_key( [?d, ?w], :delete_word )
+      bind_key( [?d, ?t], :delete_till )
+      bind_key( [?d, ?f], :delete_forward )
+      bind_key( ?\C-_ ) { @undo_handler.undo if @undo_handler }
+      bind_key( ?u ) { @undo_handler.undo if @undo_handler }
+      bind_key( ?\C-r ) { @undo_handler.redo if @undo_handler }
+      bind_key( ?x, :delete_curr_char )
+      bind_key( ?X, :delete_prev_char )
+      bind_key( [?y, ?y] , :kill_ring_save )
+      bind_key( ?p, :yank ) # paste after this line
+      bind_key( ?P ) { yank(@current_index - 1) } # should be before this line
+      bind_key(?w, :forward_word)
+      bind_key(?f, :forward_char)
+      bind_key(?\M-y, :yank_pop)
+      bind_key(?\M-w, :kill_ring_save)
+      @_events.push :CHANGE # thru vieditable
+
+    end
+    ##
+    # Separate mappings for listboxes.
+    # Some methods don;'t make sense for listboxes and are crashing
+    # since not present for them. f was being overwritten, too.
+    # Sorry for duplication, need to clean this somehow.
+    def vieditable_init_listbox
+      $log.debug " inside vieditable_init_listbox "
+      @editable = true
+      bind_key( ?C, :edit_line)
+      bind_key( ?o) { insert_line(@current_index+1) }
+      bind_key( ?O) { insert_line(@current_index) }
+      bind_key( [?d, ?d] , :delete_line )
+      bind_key( ?\C-_ ) { @undo_handler.undo if @undo_handler }
+      bind_key( ?u ) { @undo_handler.undo if @undo_handler }
+      bind_key( ?\C-r ) { @undo_handler.redo if @undo_handler }
+      bind_key( [?y, ?y] , :kill_ring_save )
+      bind_key( ?p, :yank ) # paste after this line
+      #bind_key( ?P ) { yank(@current_index - 1) } # should be before this line
+      # seems -1 was pasting 2 lines before
+      bind_key( ?P ) { yank(@current_index - 0) } # should be before this line
+      bind_key(?w, :forward_word)
+      bind_key(?\M-y, :yank_pop)
+      bind_key(?\C-y, :yank)
+      bind_key(?\M-w, :kill_ring_save)
+      @_events.push :CHANGE # thru vieditable
+      #bind_key( ?D, :delete_eol)
+      #bind_key( [?d, ?$], :delete_eol)
+      #bind_key(?f, :forward_char)
+      #bind_key( ?x, :delete_curr_char )
+      #bind_key( ?X, :delete_prev_char )
+      #bind_key( [?d, ?w], :delete_word )
+      #bind_key( [?d, ?t], :delete_till )
+      #bind_key( [?d, ?f], :delete_forward )
+
+    end
+
+    # currently only adding delete_line and some yank pop functions
+    # These will all give wrong results in table due to _header_offset
+    def vieditable_init_tabular
+      $log.debug " inside vieditable_init tabular"
+      @editable = true
+      #bind_key( ?C, :edit_line)
+      #bind_key( ?o, :insert_line)
+      #bind_key( ?O) { insert_line(@current_index-1) }
+      #bind_key( ?o) { insert_line(@current_index+1) }
+      #bind_key( ?O) { insert_line(@current_index) }
+      bind_key( [?d, ?d] , :delete_line )
+      #bind_key( ?\C-_ ) { @undo_handler.undo if @undo_handler }
+      #bind_key( ?u ) { @undo_handler.undo if @undo_handler }
+      #bind_key( ?\C-r ) { @undo_handler.redo if @undo_handler }
+      bind_key( [?y, ?y] , :kill_ring_save )
+      bind_key( ?p, :yank ) # paste after this line
+      bind_key( ?P ) { yank(@current_index - 1) } # should be before this line
+      bind_key(?\M-y, :yank_pop)
+      bind_key(?\M-w, :kill_ring_save)
+      @_events.push :CHANGE # thru vieditable
+    end
+
+    ##
+    # edit current or given line
+    def edit_line lineno=@current_index
+      line = self[lineno]
+      prompt = "Edit: "
+      maxlen = 80
+      config={};
+      oldline = line.dup
+      config[:default] = line
+      ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+      $log.debug " rbgetstr returned #{ret} , #{str} "
+      return if ret != 0
+      self[lineno].replace(str)
+      fire_handler :CHANGE, InputDataEvent.new(0,oldline.length, self, :DELETE_LINE, lineno, oldline)     #  2008-12-24 18:34
+      fire_handler :CHANGE, InputDataEvent.new(0,str.length, self, :INSERT_LINE, lineno, str)
+      @repaint_required = true
+      @widget_scrolled = true
+    end
+    ##
+    # insert a line
+    # FIXME needs to fire handler 2010-05-23 11:40
+    def insert_line lineno=@current_index
+      prompt = "Insert: "
+      maxlen = 80
+      #config={};
+      #config[:default] = line
+      #ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+      ret, str = input_string prompt
+      #ret, str = rbgetstr(@form.window, @row+@height-1, @col+1, prompt, maxlen, config)
+      $log.debug " rbgetstr returned #{ret} , #{str} "
+      return if ret != 0
+      @list.insert lineno, str
+      ## added handler on 2010-05-23 11:46 - undo works - tested in testlistbox.rb
+      fire_handler :CHANGE, InputDataEvent.new(0,str.length, self, :INSERT_LINE, lineno, str)
+      @widget_scrolled = true
+      @repaint_required = true
+    end
+    ##
+    # common method to edit given string
+    # @param [String] string to edit/modify
+    # @param [String] prompt to display before string
+    # @param [int] max length of input
+    # @return [0, -1] return value 0 if okay, -1 if error
+    #
+    def edit_string string, prompt="Edit: ", maxlen=80
+      config={};
+      config[:default] = string
+      ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+      #return str if ret == 0
+      #return ""
+    end
+    ##
+    # common method to input a blank string
+    # @param [String] prompt to display before string
+    # @param [int] max length of input
+    # @return [0, -1] return value 0 if okay, -1 if error
+    def input_string prompt="Insert: ", maxlen=80
+      #ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+      ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+      #return str if ret == 0
+      #return ""
+    end
+    def edit_chars
+
+    end
+    def edit_word
+
+    end
+  end # module
+end # module

data/lib/rbhex/core/include/widgetmenu.rb

@@ -0,0 +1,66 @@
+# ----------------------------------------------------------------------------- #
+#         File: widgetmenu.rb
+#  Description: a module that displays a menu for customization of a field
+#               e.g.,
+#               field.extend(WidgetMenu)
+#
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2011-12-2x
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2011-12-26 - 20:25
+# ----------------------------------------------------------------------------- #
+#
+# Provide a system for us to define a menu for customizing a widget, such that
+# applicatin can also add more menuitems
+module RubyCurses
+  extend self
+  module WidgetMenu
+    include Io # added 2011-12-26
+    # add a menu item which can any one of
+    # @param key, label, desc, action | symbol
+    #        key, symbol
+    #        Action
+    #        Action[] (maybe)
+    def self.extended(obj)
+      # don't want this executed each time
+      @objects ||= []
+      return if @objects.include? obj
+      @objects << obj
+
+      obj.instance_exec {
+        @_menuitems ||= []
+        # callign this method means that no other programs can use those actions else
+        # that method will be called more than once, so it must either be called in the constructor
+        # or else have a check that it is only called once.
+        obj.init_menu if obj.respond_to? :init_menu
+      }
+
+    end
+    def add_menu_item *val
+      #@_menuitems ||= []
+      @_menuitems << val
+    end
+    #
+    # insert an item at given position (index)
+    def insert_menu_item pos, *val
+      #@_menuitems ||= []
+      @_menuitems[pos] = val
+    end
+    def create_menuitem *args
+      PromptMenu.create_menuitem *args
+    end
+
+    # popup the hist
+    #
+    def _show_menu
+      return if @_menuitems.nil? || @_menuitems.empty?
+      list = @_menuitems
+      menu = PromptMenu.new self do |m|
+      list.each { |e|
+        m.add *e
+      }
+      end
+      menu.display_new :title => 'Widget Menu (Press letter)'
+    end
+  end # mod History
+end # mod RubyC

data/lib/rbhex/core/system/colormap.rb

@@ -0,0 +1,165 @@
+require 'rbhex/core/system/ncurses'
+
+module RubyCurses
+  module ColorMap
+    # 2010-09-20 12:22 changed colors from string to symbol
+    ## private
+    # returns a color constant for a human color string
+    def ColorMap.get_color_const colorstring
+      # added check for fixnum if we go beyond these constants 2011-11-28
+      # e.g. to use full 256 colors
+      return colorstring if colorstring.is_a? Fixnum
+      ret = FFI::NCurses.const_get "COLOR_#{colorstring.to_s.upcase}"
+    end
+    ## private
+    # creates a new color pair, puts in color map and returns color_pair
+    # number
+    def ColorMap.install_color fgc, bgc
+      #$log.debug " install_color found #{fgc} #{@bgc} "
+      @color_id += 1
+      fg = ColorMap.get_color_const fgc
+      bg = ColorMap.get_color_const bgc
+      FFI::NCurses.init_pair(@color_id, fg, bg);
+      $color_map[[fgc, bgc]] = @color_id
+      return @color_id
+    end
+    #
+    # returns the colors that make up the given pair
+    # you may want to find what makes up $bottomcolor and set color and bgcolor with it.
+    # @param [Fixnum] color_pair
+    # @return [Symbol, Symbol]  foreground and backgrounf color
+    # @example
+    #     color, bgcolor = get_colors_for_pair $datacolor
+    #
+    def ColorMap.get_colors_for_pair pair
+      $color_map.invert[pair]
+    end
+    ## public
+    # returns a color_pair for a given foreground and background color
+    def ColorMap.get_color fgc, bgc=$def_bg_color
+      fgc = fgc.to_sym if fgc.is_a? String
+      bgc = bgc.to_sym if bgc.is_a? String
+      if $color_map.include? [fgc, bgc]
+        #$log.debug " get_color found #{fgc} #{@bgc} "
+        return $color_map[[fgc, bgc]]
+      else
+        #$log.debug " get_color NOT found #{fgc} #{@bgc} "
+        return ColorMap.install_color fgc, bgc
+      end
+    end
+    def ColorMap.colors
+      @@colors
+    end
+    # returns true if color is a valid one, else false
+    # @param [Symbol] color such as :black :cyan :yellow
+    # @return [Boolean] true if valid, else false
+    def ColorMap.is_color? color
+      return true if color.is_a? Fixnum # so we can use 256 colors
+      @@colors.include? color.to_sym
+    end
+
+    ## public
+    # setup color map at start of application
+    def ColorMap.setup
+      @color_id = 0
+      $color_map = {}
+      FFI::NCurses.start_color();
+      # Initialize few color pairs
+      $def_fg_color = :white   # pls set these 2 for your application
+      $def_bg_color = :black
+      #COLORS = [COLOR_BLACK, COLOR_RED, COLOR_GREEN, COLOR_YELLOW, COLOR_BLUE,
+      #     COLOR_MAGENTA, COLOR_CYAN, COLOR_WHITE]
+      @@colors = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
+
+      # make foreground colors
+      bg = ColorMap.get_color_const $def_bg_color
+      @@colors[0...@@colors.size].each_with_index do |color, i|
+        next if color == $def_bg_color # NOTE hope this doesn't do something if you change def_bg
+        ColorMap.install_color color, $def_bg_color
+      end
+      $reversecolor = ColorMap.get_color $def_bg_color, $def_fg_color
+      $popupcolor = ColorMap.get_color :cyan, $def_fg_color
+
+      $errorcolor = ColorMap.get_color :white, :red
+      #$promptcolor = $selectedcolor = ColorMap.get_color(:yellow, :red)
+      $promptcolor = ColorMap.get_color(:yellow, :red)
+      $normalcolor = $datacolor = ColorMap.get_color(:white, :black)
+      $bottomcolor = $topcolor = ColorMap.get_color(:white, :blue)
+      $selectedcolor = $datacolor # since we now use reverse attr in list
+
+      $row_selected_attr = Ncurses::A_REVERSE
+      $row_focussed_attr = Ncurses::A_BOLD
+      $row_attr          = Ncurses::A_NORMAL
+
+      #    $log.debug " colormap SETUP: #{$datacolor} #{$reversecolor} "
+    end
+
+  end # modul
+  if $0 == __FILE__
+    require 'logger'
+    require 'ver/window'
+    #include Ncurses # FFI 2011-09-8
+    include ColorMap
+    # Initialize curses
+    begin
+      $log = Logger.new("rbc13.log")
+      VER::start_ncurses
+      @window = VER::Window.root_window
+      $log.level = Logger::DEBUG
+      ColorMap.setup
+
+      # Create the window to be associated with the form
+      # Un post form and free the memory
+
+      catch(:close) do
+        #      $log.debug "START  ---------"
+        # need to pass a form, not window.
+        r = 1; c = 2; i=0
+        attr = Ncurses::A_NORMAL
+        @window.printstring  20, c, "press 0-9 to change BG color,  F1/q to quit. r-everse, n-ormal,b-old ", ColorMap.get_color('white')
+
+
+
+        while((ch = @window.getchar()) != FFI::NCurses::KEY_F1 )
+          next if ch == -1
+          break if ch == ?q.getbyte(0)
+          case ch
+          when ?r.getbyte(0)
+            attr |= Ncurses::A_REVERSE
+          when ?b.getbyte(0)
+            attr |= Ncurses::A_BOLD
+          when ?n.getbyte(0)
+            attr = Ncurses::A_NORMAL
+          when ?u.getbyte(0)
+            attr |= Ncurses::A_UNDERLINE
+          else
+            i = ch.chr.to_i
+            i = 1 if i > ColorMap::colors.length-1
+          end
+          bg = ColorMap::colors[i]
+          @@colors = %w[black red green yellow blue magenta cyan white]
+          @window.printstring  r, c, "%-40s" % "red #{bg}      ", ColorMap.get_color('red',bg) , attr
+          @window.printstring  2, c, "%-40s" % "blue #{bg}      ", ColorMap.get_color('blue',bg) , attr
+          @window.printstring  3, c, "%-40s" % "white #{bg}      ", ColorMap.get_color('white',bg) , attr
+          @window.printstring  4, c, "%-40s" % "green #{bg}      ", ColorMap.get_color('green',bg) , attr
+          @window.printstring  5, c, "%-40s" % "cyan #{bg}      ", ColorMap.get_color('cyan',bg) , attr
+          @window.printstring  6, c, "%-40s" % "magenta #{bg}      ", ColorMap.get_color('magenta',bg) , attr
+          @window.printstring  7, c, "black #{bg}      ", ColorMap.get_color('black',bg) , attr
+          @window.wrefresh
+        end
+        #     VER::Keyboard.focus = tp
+      end
+    rescue => ex
+    ensure
+      #  @panel = @window.panel if @window
+      #  Ncurses::Panel.del_panel(@panel) if !@panel.nil?
+      #  @window.delwin if !@window.nil?
+      @window.destroy unless @window.nil?
+      VER::stop_ncurses
+      p ex if ex
+      p(ex.backtrace.join("\n")) if ex
+      #    $log.debug( ex) if ex
+      #    $log.debug(ex.backtrace.join("\n")) if ex
+    end
+  end
+end