rbhex-core 1.0.0

data/examples/testfields.rb

@@ -0,0 +1,195 @@
+require 'logger'
+require 'rbhex'
+require 'rbhex/core/include/appmethods.rb'
+def help_text
+      <<-eos
+               FIELD  HELP
+
+      This is some help text for Fields
+
+      Name is non-focusable
+      Line takes numbers from 1 to 200
+      Regex takes only alpha
+      Password takes only scotty or tiger or pass or qwerty, and maybe left blank
+
+      Use Alt (meta) with the highlighted character to jump to that field.
+      Alt-m goes to line, Alt-p to password.
+
+      Notice how the field label becomes red when focused (as in Pine/Alpine). This uses
+      the event :ENTER and :LEAVE
+
+
+
+      F10 -   Exit application  (also C-q)
+      Alt-!    -   Drop to shell
+      C-x c    -   Drop to shell
+      C-x l    -   list of files
+      C-x p    -   process list
+      C-x d    -   disk usage list
+      C-x s  -   Git status
+      C-x w  -   Git whatchanged
+      Alt-x    -   Command mode (<tab> to see commands and select)
+
+      F3      - View log
+      F4      - prompt for unix command and display in viewer
+      F5      - Drop to shell
+
+
+      -----------------------------------------------------------------------
+      eos
+end
+if $0 == __FILE__
+
+  include RubyCurses
+  include RubyCurses::Utils
+
+  begin
+  # Initialize curses
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    path = File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT)
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+
+    @lookfeel = :classic # :dialog # or :classic
+
+    @window = VER::Window.root_window
+    # Initialize few color pairs
+    # Create the window to be associated with the form
+    # Un post form and free the memory
+
+    catch(:close) do
+      colors = Ncurses.COLORS
+      $log.debug "START #{colors} colors testfield.rb --------- #{@window} "
+      @form = Form.new @window
+      title = (" "*30) + "Demo of Field (F10 quits, F1 help) " + Rbhex::Core::VERSION
+      Label.new @form, {:text => title, :row => 1, :col => 0, :color => :green, :bgcolor => :black}
+      r = 3; fc = 12;
+      mnemonics = %w[ n l r p]
+      %w[ name line regex password].each_with_index do |w,i|
+        field = Field.new @form do
+          name w
+          row  r
+          col  fc
+          display_length  30
+          #set_buffer "abcd "
+          set_label Label.new @form, {:text => w, :color=> :cyan, :mnemonic => mnemonics[i]}
+        end
+        r += 1
+      end
+
+      f = @form.by_name["line"]
+      f.display_length(3).set_buffer(24).valid_range(1..200).
+        maxlen(3).
+        type(:integer)
+
+      @form.by_name["name"].set_buffer( "Not focusable").
+        set_focusable(false)
+
+      @form.by_name["regex"].valid_regex(/^[A-Z][a-z]*/).
+        set_buffer( "SYNOP").
+        display_length(10).
+        maxlen = 20
+
+      @form.by_name["password"].set_buffer("").
+        show('*').
+        color(:red).
+        values(%w[scotty tiger secret pass qwerty]).
+        null_allowed true
+
+    r += 3
+    l1 = Label.new @form, :name => "profile", :attr => 'bold', :text => "Profile", :row => r, :col => fc
+    r += 1
+    f1 = Field.new @form,  :name => "name1", :maxlen => 20, :display_length => 20, :bgcolor => :white,
+      :color => :black, :text => "abc", :label => '    Name: ', :row => r, :col => fc
+    r += 1
+    f2 = Field.new @form, :name => "email", :display_length => 20, :bgcolor => :white,
+      :color => :blue, :text => "me@google.com", :label => '   Email: ', :row => r, :col => fc
+    r += 3
+    f3 = Field.new @form
+    f3.name("mobile").display_length(20).bgcolor(:white).color(:black).
+      text("").label('  Mobile: ').
+      row(r).col(fc).
+      type(:integer)
+    r += 2
+
+    Field.new(@form).
+    name("landline").display_length(20).bgcolor(:white).color(:black).
+      text("").label('Landline: ').
+      row(r).col(fc).
+      type(:integer)
+      # a form level event, whenever any widget is focussed, make the label red
+      @form.bind(:ENTER) { |f|   f.label && f.label.bgcolor = :red if (f.respond_to? :label and f.label.respond_to?(:bgcolor))}
+      @form.bind(:LEAVE) { |f|  f.label && f.label.bgcolor = 'black'   if (f.respond_to? :label and f.label.respond_to?(:bgcolor))}
+
+      @form.bind_key(FFI::NCurses::KEY_F3,'view log') {
+        require 'rbhex/core/util/viewer'
+        RubyCurses::Viewer.view(path || "rbc13.log", :close_key => KEY_ENTER, :title => "<Enter> to close")
+      }
+      @form.bind_key(FFI::NCurses::KEY_F4, 'system command') {  shell_output }
+      @form.bind_key(FFI::NCurses::KEY_F5, 'shell') {  suspend }
+      @form.bind_key([?\C-x,?c], 'shell') {  suspend }
+      @form.bind_key(?\M-!, 'shell') {  suspend }
+      @form.bind_key([?\C-x,?l], 'ls -al') {  run_command "ls -al" }
+      @form.bind_key([?\C-x,?p], 'ps -l') {  run_command "ps -l" }
+      @form.bind_key([?\C-x,?d], 'df -h') {  run_command "df -h" }
+      #@form.bind_key([?\C-x,?d], 'git diff') {  run_command "git diff --name-status" }
+      @form.bind_key([?\C-x, ?s], 'git st') {  run_command "git status" }
+      @form.bind_key([?\C-x,?w], 'git whatchanged') {  run_command "git whatchanged" }
+
+      @form.help_manager.help_text = help_text
+      #@form.bind_key(FFI::NCurses::KEY_F1, 'help') {  display_app_help help_text() }
+      @form.bind_key(FFI::NCurses::KEY_F1, 'help') {  display_app_help }
+      @form.repaint
+      @window.wrefresh
+      Ncurses::Panel.update_panels
+
+      # the main loop
+
+      while((ch = @window.getchar()) != FFI::NCurses::KEY_F10 )
+        break if ch == ?\C-q.getbyte(0)
+        begin
+          @form.handle_key(ch)
+
+        rescue FieldValidationException => fve
+          alert fve.to_s
+
+          f = @form.get_current_field
+          # lets restore the value
+          if f.respond_to? :restore_original_value
+            f.restore_original_value
+            @form.repaint
+          end
+          $error_message.value = ""
+        rescue => err
+          $log.error( err) if err
+          $log.error(err.backtrace.join("\n")) if err
+          textdialog err
+          $error_message.value = ""
+        end
+
+        # this should be avoided, we should not muffle the exception and set a variable
+        # However, we have been doing that
+        if $error_message.get_value != ""
+          if @lookfeel == :dialog
+            alert($error_message, {:bgcolor => :red, 'color' => 'yellow'}) if $error_message.get_value != ""
+          else
+            print_error_message $error_message, {:bgcolor => :red, :color => :yellow}
+          end
+          $error_message.value = ""
+        end
+
+        @window.wrefresh
+      end # while loop
+    end # catch
+  rescue => ex
+  ensure
+    $log.debug " -==== EXCEPTION =====-"
+    $log.debug( ex) if ex
+    $log.debug(ex.backtrace.join("\n")) if ex
+    @window.destroy if !@window.nil?
+    VER::stop_ncurses
+    puts ex if ex
+    puts(ex.backtrace.join("\n")) if ex
+  end
+end

data/examples/testkeypress.rb

@@ -0,0 +1,72 @@
+# demo to test keypresses
+# press any key and see the value that ncurses or our routines catch.
+# Press alt and control combinations and Function keys
+# Ideally each key should return only one value. Sometimes, some TERM setting
+# or terminal emulator may not give correct values or may give different values
+# from what we are expecting.
+# Exit using 'q'.
+require 'logger'
+require 'rbhex'
+require 'rbhex/core/widgets/rtextview'
+if $0 == __FILE__
+  include RubyCurses
+  include RubyCurses::Utils
+
+  begin
+  # Initialize curses
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")))
+
+    $log.level = Logger::DEBUG
+
+    @window = VER::Window.root_window
+
+    catch(:close) do
+      colors = Ncurses.COLORS
+      $log.debug "START #{colors} colors  ---------"
+      @form = Form.new @window
+      r = 1; c = 30;
+
+      # please use a hash to pass these values, avoid this old style
+      # i want to move away from it as it comlpicates code
+        texta = TextView.new @form do
+          name   "mytext"
+          row  r
+          col  c
+          width 60
+          height 15
+          #editable false
+          focusable false
+          title "[ Keypresses ]"
+          #title_attrib (Ncurses::A_REVERSE | Ncurses::A_BOLD)
+          title_attrib (Ncurses::A_BOLD)
+        end
+      help = "q to quit. Check keys. F1..10, C-a..z, Alt a-zA-Z0-9, C-left,rt, Sh-F5..10 .: #{$0}"
+      help1 = "Press in quick succession: 1) M-[, w     and (2)  M-[, M-w.        (3)  M-Sh-O, w."
+      RubyCurses::Label.new @form, {'text' => help, "row" => 21, "col" => 2, "color" => "yellow"}
+      RubyCurses::Label.new @form, {'text' => help1, "row" => 22, "col" => 2, "color" => "green"}
+
+      @form.repaint
+      @window.wrefresh
+      Ncurses::Panel.update_panels
+      while((ch = @window.getchar()) != 0 )
+        str = keycode_tos ch
+        $log.debug  "#{ch} got (#{str})"
+        texta << "#{ch} got (#{str})"
+        texta.goto_end
+        texta.repaint
+        @form.repaint
+        @window.wrefresh
+        break if ch == ?\q.getbyte(0)
+      end
+    end
+  rescue => ex
+  ensure
+    @window.destroy if !@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

data/examples/testlistbox.rb

@@ -0,0 +1,170 @@
+# NOTE: If the listbox is empty, that could mean that you have not generated
+#  ri documentation for this version of ruby. You can do so by doing:
+#    rvm docs generate-ri
+#    or
+#    rvm docs generate
+#  (This assumes you are using rvm)
+#
+# WARNING : IF THIS PROGRAM HANGS check the ri command
+# Maybe your version of ri has different options and is going interactive.
+# ruby 1.9.3's ri requires a -l option or else if becomes interactive.
+# this program tests out a listbox
+# This is written in the old style where we start and end ncurses and initiate a
+# getch loop. It gives more control.
+# The new style is to use App which does the ncurses setup and teardown, as well
+# as manages keys. It also takes care of logger and includes major stuff.
+require 'logger'
+require 'rbhex'
+require 'rbhex/core/widgets/rlist'
+require 'rbhex/core/widgets/rtextview'
+require 'rbhex/core/include/vieditable'
+#require 'rbhex/experimental/widgets/undomanager'
+class RubyCurses::List
+  # vieditable includes listeditable which
+  # does bring in some functions which can crash program like x and X TODO
+  # also, f overrides list f mapping. TODO
+  include ViEditable
+end
+  def my_help_text
+    <<-eos
+
+    =========================================================================
+    Basic Usage
+
+    Press <ENTER> on a class name on the first list, to view ri information
+    for it on the right.
+
+    Tab to right area, and press <ENTER> on a method name, to see its details
+    Press / <slash> in any box to search. e.g /String will take you to the
+    first occurrence of String. <n> will take you to next.
+
+    To go quickly to first class starting with 'S', type <f> followed by <S>.
+    Then press <n> to go to next match.
+
+    =========================================================================
+    Vim Edit Keys
+
+    The list on left has some extra vim keys enabled such as :
+    yy     - yank/copy current line/s
+    P, p   - paste after or before
+    dd     - delete current line
+    o      - insert a line after this one
+    C      - change content of current line
+    These are not of use here, but are demonstrative of list capabilities.
+
+    =========================================================================
+    Buffers
+
+    Ordinary a textview contains only one buffer. However, the one on the right
+    is extended for multiple buffers. Pressing ENTER on the left on several
+    rows opens multiple buffers on the right. Use M-n (Alt-N) and M-p to navigate.
+    ALternatively, : maps to a menu, so :n and :p may also be used.
+    <BACKSPACE> will also go to previous buffer, like a browser.
+
+    =========================================================================
+           Press <M-n> for next help screen, or try :n
+
+    eos
+  end
+if $0 == __FILE__
+  include RubyCurses
+
+  begin
+  # Initialize curses
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")))
+    $log.level = Logger::DEBUG
+
+    @window = VER::Window.root_window
+    $catch_alt_digits = true; # emacs like alt-1..9 numeric arguments
+    install_help_text my_help_text
+    # Initialize few color pairs
+    # Create the window to be associated with the form
+    # Un post form and free the memory
+
+    catch(:close) do
+      @form = Form.new @window
+      @form.bind_key(KEY_F1, 'help'){ display_app_help }
+
+      # this is the old style of printing something directly on the window.
+      # The new style is to use a header
+      @form.window.printstring 0, 30, "Demo of Listbox - some vim keys", $normalcolor, BOLD
+      r = 1; fc = 1;
+
+      # this is the old style of using a label at the screen bottom, you can use the status_line
+
+      v = "F10 quits. F1 Help.  Try j k gg G o O C dd f<char> w yy p P / . Press ENTER on Class or Method"
+      var = RubyCurses::Label.new @form, {'text' => v, "row" => FFI::NCurses.LINES-2,
+        "col" => fc, "display_length" => 100}
+
+      h = FFI::NCurses.LINES-3
+      file = "./data/ports.txt"
+      #mylist = File.open(file,'r').readlines
+      mylist = `ri -l `.split("\n")
+      w = 25
+      #0.upto(100) { |v| mylist << "#{v} scrollable data" }
+      #
+      listb = List.new @form, :name   => "mylist" ,
+        :row  => r ,
+        :col  => 1 ,
+        :width => w,
+        :height => h,
+        :list => mylist,
+        :selection_mode => :SINGLE,
+        :show_selector => true,
+        #row_selected_symbol "[X] "
+        #row_unselected_symbol "[ ] "
+        :title => " Ruby Classes "
+        #title_attrib 'reverse'
+      listb.one_key_selection = false # this allows us to map keys to methods
+      listb.vieditable_init_listbox
+      include Io
+      listb.bind_key(?r, 'get file'){ get_file("Get a file:") }
+      listb.bind(:PRESS) {
+        w = @form.by_name["tv"];
+        lines = `ri -f bs #{listb.text}`.split("\n")
+        #w.set_content(lines, :ansi)
+        w.add_content(lines, :content_type => :ansi, :title => listb.text)
+        w.buffer_last
+        #w.title = listb.text
+      }
+
+      tv = RubyCurses::TextView.new @form, :row => r, :col => w+1, :height => h, :width => FFI::NCurses.COLS-w-1,
+      :name => "tv", :title => "Press Enter on method"
+      tv.set_content ["Press Enter on list to view ri information in this area.",
+        "Press ENTER on method name to see details"]
+      require 'rbhex/core/include/multibuffer'
+      tv.extend(RubyCurses::MultiBuffers)
+
+      # pressing ENTER on a method name will popup details for that method
+      tv.bind(:PRESS) { |ev|
+        w = ev.word_under_cursor.strip
+        # check that user did not hit enter on empty area
+        if w != ""
+          _text = `ri -f bs #{tv.title}.#{w} 2>&1`
+          _text = _text.split("\n")
+          if _text && _text.size != 0
+            view(_text, :content_type => :ansi)
+          end
+        end
+      }
+
+
+    @form.repaint
+    @window.wrefresh
+    Ncurses::Panel.update_panels
+    while((ch = @window.getchar()) != KEY_F10 )
+      @form.handle_key(ch)
+      @window.wrefresh
+    end
+  end
+rescue => ex
+  $log.debug( ex) if ex
+  $log.debug(ex.backtrace.join("\n")) if ex
+ensure
+  @window.destroy if !@window.nil?
+  VER::stop_ncurses
+  p ex if ex
+  p(ex.backtrace.join("\n")) if ex
+end
+end

data/examples/testmessagebox.rb

@@ -0,0 +1,140 @@
+# To test out the new messagebox
+#  The old messagebox provided a lot of convenience methods that were complicated
+#  and confusing. This one is simpler.
+#  The examples here are based on the old test1.rb that will not work now
+#  since the interface has been changed and simplified
+#
+require 'logger'
+require 'rbhex'
+require 'rbhex/core/widgets/rmessagebox'
+#require 'rbhex/deprecated/widgets/rmessagebox'
+
+if $0 == __FILE__
+  # Initialize curses
+  begin
+    # XXX update with new color and kb
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV['LOGDIR'] || "./" ,"rbc13.log")))
+    $log.level = Logger::DEBUG
+
+#    @window = VER::Window.root_window
+
+
+    catch(:close) do
+      choice = ARGV[0] && ARGV[0].to_i || 3
+      $log.debug "START  MESSAGE BOX TEST #{ARGV[0]}. choice==#{choice} ---------"
+      # need to pass a form, not window.
+      case choice
+      when 1
+        require 'rbhex/core/widgets/rlist'
+        nn = "mylist"
+        l = List.new  nil, :row => 2, :col => 5, :list => %w[john tim lee wong rahul edward why chad andy],
+          :selection_mode => :multiple, :height => 10, :width => 20 , :selected_color => :green, :selected_bgcolor => :white, :selected_indices => [2,6], :name => nn
+       #default_values %w[ lee why ]
+      @mb = MessageBox.new :width => 30, :height => 18 do
+        title "Select a name"
+        button_type :ok_cancel
+        item Label.new :row => 1, :col => 1, :text => "Enter your name:"
+        item l
+
+        #default_button 0 # TODO
+      end
+      @mb.run
+      $log.debug "XXX:  #{l.selected_indices}  "
+      n = @mb.widget(nn)
+      $log.debug "XXXX:  #{n.selected_indices}, #{n.name}  "
+      when 2
+      @mb = RubyCurses::MessageBox.new do
+        title "Color selector"
+        message "Select a color"
+        #item Label.new :text => "Select a color", :row => 1 , :col => 2
+
+        r = 3
+        c = 2
+        %w[&red &green &blue &yellow].each_with_index { |b, i|
+          bu =  Button.new :name => b, :text => b, :row => r, :col => c
+          bu.command { throw(:close, i) }
+          item bu
+          #bu.default_button(true) if i == 0
+          #r += 1
+          c += b.length + 5
+        }
+      end
+      index = @mb.run
+      $log.debug "XXX:  messagebox 2 ret #{index} "
+      when 3
+      @mb = RubyCurses::MessageBox.new do
+        title "Enter your name"
+        #message "Enter your first name. You are not permitted to enter x z or q and must enter a capital first"
+        message "Enter your first name. Initcaps "
+        add Field.new :chars_allowed => /[^0-9xyz]/, :valid_regex => /^[A-Z][a-z]*/, :default => "Matz", :bgcolor => :cyan
+        button_type :ok_cancel
+      end
+      @mb.run
+      $log.debug "XXX:  got #{@mb.widget(1).text} "
+      when 4
+      mb = MessageBox.new :title => "HTTP Configuration" , :width => 50 do
+        add Field.new :label => 'User', :name => "user", :display_length => 30, :bgcolor => :cyan
+        add CheckBox.new :text => "No &frames", :onvalue => "Selected", :offvalue => "UNselected"
+        add CheckBox.new :text => "Use &HTTP/1.0", :value => true
+        add CheckBox.new :text => "Use &passive FTP"
+        add Label.new    :text => " Language ", :attr => REVERSE
+        $radio = RubyCurses::Variable.new
+        add RadioButton.new :text => "py&thon", :value => "python", :color => :blue, :variable => $radio
+        add RadioButton.new :text => "rub&y", :color => :red, :variable => $radio
+        button_type :ok
+      end
+      field = mb.widget("user")
+      field.bind(:ENTER) do |f|
+        listconfig = {'bgcolor' => 'blue', 'color' => 'white'}
+        users= %w[john tim lee wong rahul edward _why chad andy]
+        index = popuplist(users, :relative_to => field, :col => field.col + 6, :width => field.display_length)
+        field.set_buffer users[index] if index
+      end
+      mb.run
+
+      when 5
+        require 'rbhex/core/widgets/rlist'
+        label = Label.new 'text' => 'File', 'mnemonic'=>'F', :row => 3, :col => 5
+        field = Field.new :name => "file", :row => 3 , :col => 10, :width => 40, :set_label => label
+        #flist = Dir.glob(File.join( File.expand_path("~/"), "*"))
+        flist = Dir.glob("*")
+        listb = List.new :name => "mylist", :row => 4, :col => 3, :width => 50, :height => 10,
+          :list => flist, :title => "File List", :selected_bgcolor => :white, :selected_color => :blue,
+          :selection_mode => :single, :border_attrib => REVERSE
+        #listb.bind(:ENTER_ROW) { field.set_buffer listb.selected_item }
+        # if you find that cursor goes into listbox while typing, then
+        # i've put set_form_row in listbox list_data_changed
+        field.bind(:CHANGE) do |f|
+          flist = Dir.glob("*"+f.getvalue+"*")
+          #l.insert( 0, *flist) if flist
+          listb.list flist
+        end
+        mb = RubyCurses::MessageBox.new :height => 20, :width => 60 do
+          title "Sample File Selector"
+          add label
+          add field
+          add listb
+          #height 20
+          #width 60
+          #top 5
+          #left 20
+          #default_button 0
+          button_type :ok_cancel
+
+        end
+        mb.run
+        $log.debug "MBOX :selected #{listb.selected_item}"
+      end
+
+    end
+  rescue => ex
+  ensure
+    @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