rbhex-core 1.0.0

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

@@ -0,0 +1,80 @@
+# ----------------------------------------------------------------------------- #
+#         File: action.rb
+#  Description: A common action class which can be used with buttons, popupmenu
+#               and anythign else that takes an action or command
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: been around since the beginning
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: use ,,L
+#  NOTE: I don't like the dependence on rwidget and EventHandler. Seems it needs
+#   that only for fire_handler and not sure if that's used. I've not bound :FIRE
+#   ever.
+#
+#   Darn, do i really need to have dsl_accessors and property This is not a
+#   widget and there's no repaint. Do button's and popups really repaint
+#   themselves when a dsl_property is modified ?
+# ----------------------------------------------------------------------------- #
+#
+require 'rbhex/core/widgets/rwidget'
+include RubyCurses
+module RubyCurses
+  ## encapsulates behaviour allowing centralization
+  # == Example
+  #    a = Action.new("&New Row") { commands }
+  #    a.accelerator "Alt N"
+  #    menu.add(a)
+  #    b = Button.new form do
+  #      action a
+  #      ...
+  #    end
+  class Action < Proc
+    include EventHandler # removed 2012-01-3 maybe you can bind FIRE
+    #include ConfigSetup # removed 2012-01-3
+    # name used on button or menu
+    dsl_property :name
+    dsl_property :enabled
+    dsl_accessor :tooltip_text
+    dsl_accessor :help_text
+    dsl_accessor :mnemonic
+    dsl_accessor :accelerator
+
+    def initialize name, config={}, &block
+      super &block
+      @name = name
+      @name.freeze
+      @enabled = true
+      # removing dependency from config
+      #config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      @config = config
+      keys = @config.keys
+      keys.each do |e|
+        variable_set(e, @config[e])
+      end
+      @_events = [:FIRE]
+    end
+    def call
+      return unless @enabled
+      # seems to be here, if you've bound :FIRE no this, not on any widget
+      fire_handler :FIRE, self
+      super
+    end
+    # the next 3 are to adapt this to CMenuitems
+    def hotkey
+      return @mnemonic if @mnemonic
+      ix = @name.index('&')
+      if ix
+        return @name[ix+1, 1].downcase
+      end
+    end
+    # to adapt this to CMenuitems
+    def label
+      @name.sub('&','')
+    end
+    # to adapt this to CMenuitems
+    def action
+      self
+    end
+
+  end # class
+end # module
+

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

@@ -0,0 +1,49 @@
+# ----------------------------------------------------------------------------- #
+#         File: actionmanager.rb
+#  Description: a class that manages actions for a widget
+#
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2012-01-4
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: ,,L
+# ----------------------------------------------------------------------------- #
+#
+# Maintains actions for a widget
+module RubyCurses
+  class ActionManager
+    include Io
+    attr_reader :actions
+
+    def initialize #form, config={}, &block
+      @actions = []
+       #instance_eval &block if block_given?
+    end
+    def add_action act
+      @actions << act
+    end
+    def remove_action act
+      @actions.remove act
+    end
+    #
+    # insert an item at given position (index)
+    def insert_action pos, *val
+      @actions[pos] = val
+    end
+    #def create_menuitem *args
+      #PromptMenu.create_menuitem *args
+    #end
+
+    # popup the hist
+    #
+    def show_actions
+      return if @actions.empty?
+      list = @actions
+      menu = PromptMenu.new self do |m|
+      list.each { |e|
+        m.add *e
+      }
+      end
+      menu.display_new :title => 'Widget Menu (Press letter)'
+    end
+  end # class
+end # mod RubyC

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

@@ -0,0 +1,214 @@
+module RubyCurses
+  module Utils
+    private
+    def _suspend clear=true
+      return unless block_given?
+      Ncurses.def_prog_mode
+      if clear
+        Ncurses.endwin
+        # NOTE: avoid false since screen remains half off
+        # too many issues
+      else
+        system "/bin/stty sane"
+      end
+      yield if block_given?
+      Ncurses.reset_prog_mode
+      if !clear
+        # Hope we don't screw your terminal up with this constantly.
+        VER::stop_ncurses
+        VER::start_ncurses
+        #@form.reset_all # not required
+      end
+      @form.repaint if @form
+      @window.wrefresh if @window
+      Ncurses::Panel.update_panels
+    end
+    #
+    # Suspends to shell so user can execute commands.
+    # Maybe not be able to get your prompt correctly.
+    #
+    public
+    def suspend
+      _suspend(false) do
+        system("tput cup 26 0")
+        system("tput ed")
+        system("echo Enter C-d to return to application")
+        system (ENV['PS1']='\s-\v\$ ') if ENV['SHELL']== '/bin/bash'
+        system(ENV['SHELL']);
+      end
+    end
+
+    #
+    # Displays application help using either array provided
+    # or checking for :help_text method
+    # @param [Array] help text
+    def display_app_help help_array= nil
+      if help_array
+        arr = help_array
+      elsif respond_to? :help_text
+        arr = help_text
+      else
+        arr = []
+        arr << "    NO HELP SPECIFIED FOR APP #{self}  "
+        arr << "    "
+        arr << "     --- General help ---          "
+        arr << "    F10         -  exit application "
+        arr << "    Alt-x       -  select commands  "
+        arr << "    :           -  select commands  "
+        arr << "    "
+      end
+      case arr
+      when String
+        arr = arr.split("\n")
+      when Array
+      end
+      w = arr.max_by(&:length).length
+
+      require 'rbhex/core/util/viewer'
+      RubyCurses::Viewer.view(arr, :layout => [2, 10, [4+arr.size, 24].min, w+2],:close_key => KEY_ENTER, :title => "<Enter> to close", :print_footer => true) do |t|
+      # you may configure textview further here.
+      #t.suppress_borders true
+      #t.color = :black
+      #t.bgcolor = :white
+      # or
+      t.attr = :reverse
+      end
+    end
+    #
+    # prompts user for unix command and displays output in viewer
+    #
+    def shell_output
+      $shell_history ||= []
+      cmd = get_string("Enter shell command:", :maxlen => 50) do |f|
+        require 'rbhex/core/include/rhistory'
+        f.extend(FieldHistory)
+        f.history($shell_history)
+      end
+      if cmd && !cmd.empty?
+        run_command cmd
+        $shell_history.push(cmd) unless $shell_history.include? cmd
+      end
+    end
+
+    #
+    # executes given command and displays in viewer
+    # @param [String] unix command, e.g., git -st
+    def run_command cmd
+      # http://whynotwiki.com/Ruby_/_Process_management#What_happens_to_standard_error_.28stderr.29.3F
+      require 'rbhex/core/util/viewer'
+      begin
+        res = `#{cmd} 2>&1`
+      rescue => ex
+        res = ex.to_s
+        res << ex.backtrace.join("\n")
+      end
+      res.gsub!("\t","   ")
+      RubyCurses::Viewer.view(res.split("\n"), :close_key => KEY_ENTER, :title => "<Enter> to close, M-l M-h to scroll")
+    end
+    def shell_out command
+      w = @window || @form.window
+      w.hide
+      Ncurses.endwin
+      ret = system command
+      Ncurses.refresh
+      #Ncurses.curs_set 0  # why ?
+      w.show
+      return ret
+    end
+  end # utils
+  class PrefixCommand
+    attr_accessor :object
+    def initialize _symbol, calling, config={}, &block
+      @object = calling
+      @symbol = _symbol
+      @descriptions = {}
+      define_prefix_command _symbol
+      yield self if block_given?
+    end
+    def define_prefix_command _name, config={}
+      $rb_prefix_map ||= {}
+      #h = {}
+      #@map = h
+      _name = _name.to_sym unless _name.is_a? Symbol
+      # TODO it may already exist, so retrieve it
+      $rb_prefix_map[_name] ||= {}
+      @map = $rb_prefix_map[_name]
+      # create a variable by name _name
+      # create a method by same name to use
+      @object.instance_eval %{
+        def #{_name.to_s} *args
+           h = $rb_prefix_map["#{_name}".to_sym]
+           raise "No prefix_map named #{_name}, #{$rb_prefix_map.keys} " unless h
+           ch = @window.getchar
+           if ch
+              res =  h[ch]
+              if res.is_a? Proc
+                res.call
+              else
+                 send(res) if res
+              end
+           else
+              0
+           end
+        end
+      }
+      return _name
+    end
+    def call
+      h = @map
+      ch = @object.window.getch # dicey.
+        $log.debug "XXX:  CALLED #{ch} "
+      if ch
+        if ch == KEY_F1
+          text =  ["Options are: "]
+          h.keys.each { |e| c = keycode_tos(e); text << " #{c} #{@descriptions[e]} " }
+          textdialog text, :title => " #{@symbol} key bindings "
+          return
+        end
+        res =  h[ch]
+        if res.is_a? Proc
+          res.call
+        elsif res.is_a? Symbol
+          @object.send(res) if res
+        else
+          Ncurses.beep
+          @object.window.ungetch(ch)
+
+          :UNHANDLED
+        end
+      else
+        raise "got nothing"
+      end
+    end
+
+    # define a key within a prefix key map such as C-x
+    # Now that i am moving this from global, how will describe bindings get hold of the bindings
+    # and descriptions
+    def define_key _keycode, *args, &blk
+      _symbol = @symbol
+      h = $rb_prefix_map[_symbol]
+      raise ArgumentError, "No such keymap #{_symbol} defined. Use define_prefix_command." unless h
+      _keycode = _keycode[0].getbyte(0) if _keycode[0].class == String
+      arg = args.shift
+      if arg.is_a? String
+        desc = arg
+        arg = args.shift
+      elsif arg.is_a? Symbol
+        # its a symbol
+        desc = arg.to_s
+      elsif arg.nil?
+        desc = "unknown"
+      else
+        raise ArgumentError, "Don't know how to handle #{arg.class} in PrefixManager"
+      end
+      @descriptions[_keycode] = desc
+
+      if !block_given?
+        blk = arg
+      end
+      h[_keycode] = blk
+    end
+    alias :key :define_key
+  end
+end # module RubyC
+include RubyCurses::Utils

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

@@ -0,0 +1,48 @@
+# I am moving the common title and border printing stuff into 
+# a separate module.
+module RubyCurses
+  module BorderTitle
+    dsl_accessor :suppress_borders            #to_print_borders
+    dsl_accessor :border_attrib, :border_color
+    dsl_accessor :title                       #set this on top
+    dsl_accessor :title_attrib                #bold, reverse, normal
+
+    def bordertitle_init
+      @_bordertitle_init_called = true
+      @row_offset = @col_offset = 0 if @suppress_borders 
+      @internal_width = 1 if @suppress_borders # the other programs have zero not 1 NOTE
+    end
+    # why the dash does it reduce height by one.
+    def print_borders
+      bordertitle_init unless @_bordertitle_init_called
+      raise ArgumentError, "Graphic not set" unless @graphic
+      raise "#{self} needs width" unless @width
+      raise "#{self} needs height" unless @height
+      width = @width
+      height = @height-1
+      window = @graphic
+      startcol = @col 
+      startrow = @row 
+      @color_pair = get_color($datacolor)
+      bordercolor = @border_color || @color_pair
+      borderatt = @border_attrib || Ncurses::A_NORMAL
+      window.print_border startrow, startcol, height, width, bordercolor, borderatt
+      print_title
+    end
+    def print_title
+      bordertitle_init unless @_bordertitle_init_called
+      return unless @title
+      raise "#{self} needs width" unless @width
+      @color_pair ||= get_color($datacolor) # should we not use this ??? XXX 
+      #$log.debug " print_title #{@row}, #{@col}, #{@width}  "
+      # check title.length and truncate if exceeds width
+      _title = @title
+      if @title.length > @width - 2
+        _title = @title[0..@width-2]
+      end
+      @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, @color_pair, @title_attrib) unless @title.nil?
+    end
+
+  end
+end
+include BorderTitle

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

@@ -0,0 +1,203 @@
+# ------------------------------------------------------------ #
+#         File: chunk.rb
+#  Description:
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 07.11.11 - 12:31
+#  Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2013-04-01 13:38
+# ------------------------------------------------------------ #
+#
+
+module RubyCurses
+  module Chunks
+    extend self
+    class Chunk
+
+      # color_pair of associated text
+      # text to print
+      # attribute of associated text
+      #attr_accessor :color, :text, :attrib
+      attr_reader :chunk
+
+      def initialize color, text, attrib
+        @chunk = [ color, text, attrib ]
+        #@color = color
+        #@text  = text
+        #@attrib = attrib
+      end
+      def color
+        @chunk[0]
+      end
+      def text
+        @chunk[1]
+      end
+      def attrib
+        @chunk[2]
+      end
+    end
+
+    # consists of an array of chunks and corresponds to a line
+    # to be printed.
+    class ChunkLine
+
+      # an array of chunks
+      attr_reader :chunks
+
+      def initialize arr=nil
+        @chunks = arr.nil? ? Array.new : arr
+      end
+      def <<(chunk)
+        raise ArgumentError, "Chunk object expected. Received #{chunk.class} " unless chunk.is_a? Chunk
+        @chunks << chunk
+      end
+      alias :add :<<
+      def each &block
+        @chunks.each &block
+      end
+
+      # returns length of text in chunks
+      def row_length
+        result = 0
+        @chunks.each { |e| result += e.text.length }
+        return result
+      end
+      # returns match for str in this chunk
+      # added 2013-03-07 - 23:59
+      def index str
+        result = 0
+        @chunks.each { |e| txt = e.text;
+          ix =  txt.index(str)
+          return result + ix if ix
+          result += e.text.length
+        }
+        return nil
+      end
+      alias :length :row_length
+      alias :size   :row_length
+
+      # return a Chunkline containing only the text for the range requested
+      def substring start, size
+        raise "substring not implemented yet"
+      end
+      def to_s
+        result = ""
+        @chunks.each { |e| result << e.text }
+        result
+      end
+
+      # added to take care of many string methods that are called.
+      # Callers really don't know this is a chunkline, they assume its a string
+      # 2013-03-21 - 19:01
+      def method_missing(sym, *args, &block)
+        self.to_s.send sym, *args, &block
+      end
+    end
+    class ColorParser
+      def initialize cp
+        color_parser cp
+        @color_pair = $datacolor
+        @attrib     = FFI::NCurses::A_NORMAL
+        @color_array = [:white]
+        @bgcolor_array = [:black]
+        @attrib_array = [@attrib]
+        @color_pair_array = [@color_pair]
+        @color = :white
+        @bgcolor = :black
+      end
+      #
+      # Takes a formatted string and converts the parsed parts to chunks.
+      #
+      # @param [String] takes the entire line or string and breaks into an array of chunks
+      # @yield chunk if block
+      # @return [ChunkLine] # [Array] array of chunks
+      # @since 1.4.1   2011-11-3 experimental, can change
+      public
+      def convert_to_chunk s, colorp=$datacolor, att=FFI::NCurses::A_NORMAL
+        #require 'rbhex/core/include/chunk'
+
+        @color_parser ||= get_default_color_parser()
+        ## defaults
+        color_pair = @color_pair
+        attrib = @attrib
+        #res = []
+        res = ChunkLine.new
+        color = @color
+        bgcolor = @bgcolor
+        # stack the values, so when user issues "/end" we can pop earlier ones
+
+        @color_parser.parse_format(s) do |p|
+          case p
+          when Array
+            ## got color / attrib info, this starts a new span
+
+            #color, bgcolor, attrib = *p
+            lc, lb, la = *p
+            if la
+              @attrib = get_attrib la
+            end
+            if lc || lb
+              @color = lc ? lc : @color_array.last
+              @bgcolor = lb ? lb : @bgcolor_array.last
+              @color_array << @color
+              @bgcolor_array << @bgcolor
+              @color_pair = get_color($datacolor, @color, @bgcolor)
+            end
+            @color_pair_array << @color_pair
+            @attrib_array << @attrib
+            #$log.debug "XXX: CHUNK start #{color_pair} , #{attrib} :: c:#{lc} b:#{lb} "
+            #$log.debug "XXX: CHUNK start arr #{@color_pair_array} :: #{@attrib_array} "
+
+          when :endcolor
+
+            # end the current (last) span
+            @color_pair_array.pop
+            @color_pair = @color_pair_array.last
+            @attrib_array.pop
+            @attrib = @attrib_array.last
+            #$log.debug "XXX: CHUNK end #{color_pair} , #{attrib} "
+            #$log.debug "XXX: CHUNK end arr #{@color_pair_array} :: #{@attrib_array} "
+          when :reset   # ansi has this
+            # end all previous colors
+            @color_pair = $datacolor # @color_pair_array.first
+            @color_pair_array = [@color_pair]
+            @attrib = FFI::NCurses::A_NORMAL #@attrib_array.first
+            @attrib_array = [@attrib]
+            @bgcolor_array = [@bgcolor_array.first]
+            @color_array = [@color_array.first]
+
+          when String
+
+            ## create the chunk
+            #$log.debug "XXX:  CHUNK     using on #{p}  : #{@color_pair} , #{@attrib} " # 2011-12-10 12:38:51
+
+            #chunk =  [color_pair, p, attrib]
+            chunk = Chunk.new @color_pair, p, @attrib
+            if block_given?
+              yield chunk
+            else
+              res << chunk
+            end
+          end
+        end # parse
+        return res unless block_given?
+      end
+      def get_default_color_parser
+        require 'rbhex/core/util/colorparser'
+        @color_parser || DefaultColorParser.new
+      end
+      # supply with a color parser, if you supplied formatted text
+      public
+      def color_parser f
+        $log.debug "XXX:  color_parser setting in CP to #{f} "
+        if f == :tmux
+          @color_parser = get_default_color_parser()
+        elsif f == :ansi
+          require 'rbhex/core/util/ansiparser'
+          @color_parser = AnsiParser.new
+        else
+          @color_parser = f
+        end
+      end
+    end # class
+  end
+end