canis 0.0.4

data/examples/testflowlayout.rb

@@ -0,0 +1,43 @@
+# ----------------------------------------------------------------------------- #
+#         File: testflowlayout.rb
+#  Description: 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-05-09 - 20:24
+#      License: MIT
+#  Last update: 2014-05-09 20:39
+# ----------------------------------------------------------------------------- #
+#  testflowlayout.rb  Copyright (C) 2012-2014 j kepler
+
+if __FILE__ == $PROGRAM_NAME
+  require 'canis/core/util/app'
+  require 'canis/core/widgets/listbox'
+  require 'canis/core/include/layouts/flowlayout'
+  App.new do
+
+    # if i add form here, it will repaint them first, and have no dimensions
+    lb = Listbox.new @form, :list => ["borodin","berlioz","bernstein","balakirev", "elgar"] , :name => "mylist"
+    lb1 = Listbox.new @form, :list => ["bach","beethoven","mozart","gorecki", "chopin","wagner","grieg","holst"] , :name => "mylist1"
+
+    lb2 = Listbox.new @form, :list => `gem list --local`.split("\n") , :name => "mylist2"
+=begin
+
+    alist = %w[ ruby perl python java jruby macruby rubinius rails rack sinatra pylons django cakephp grails] 
+    str = "Hello, people of Earth.\nI am HAL, a textbox.\nUse arrow keys, j/k/h/l/gg/G/C-a/C-e/C-n/C-p\n"
+    str << alist.join("\n")
+    tv = TextPad.new @form, :name => "text", :text => str.split("\n")
+=end
+
+    w = Ncurses.COLS-1
+    h = Ncurses.LINES-3
+    #layout = StackLayout.new :height => -1, :top_margin => 1, :bottom_margin => 1, :left_margin => 1
+    layout = FlowLayout.new :height => -1, :top_margin => 1, :bottom_margin => 1, :left_margin => 1
+    layout.form = @form
+    @form.layout_manager = layout
+    layout.cset lb, :weight, 15
+    layout.cset lb1, :weight, 25
+    #$status_message.value =" Flow: #{@r.components[0].orientation} | Stack #{@r.components[1].orientation}. Use Ctrl-Space to change "
+
+
+    st = status_line :row => -1
+  end # app
+end # if 

data/examples/testkeypress.rb

@@ -0,0 +1,98 @@
+# 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'.
+# # see window.rb for keycodes related to shift+F C_LEFT C_RIGHT etc.
+require 'logger'
+require 'canis'
+#require 'canis/core/widgets/rtextview'
+if $0 == __FILE__
+  include Canis
+  include Canis::Utils
+
+  dumpfile = "dump.yml"
+
+  begin
+  # Initialize curses
+    Canis::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"canis14.log")))
+
+    $log.level = Logger::DEBUG
+
+    @window = Canis::Window.root_window
+
+    catch(:close) do
+      colors = Ncurses.COLORS
+      $log.debug "START #{colors} colors  ---------"
+      @form = Form.new @window
+      r = 1; c = 1;
+      w = Ncurses.COLS - c
+      h = Ncurses.LINES - 4
+      FFI::NCurses.set_escdelay(500)
+      nd = Ncurses.ESCDELAY
+
+      # please use a hash to pass these values, avoid this old style
+      # i want to move away from it as it comlpicates code
+        texta = TextPad.new @form do
+          name   "mytext" 
+          row  r
+          col  c
+          width w
+          height h
+          #editable false
+          focusable false
+          title "[ Keypresses ]"
+          #title_attrib (Ncurses::A_REVERSE | Ncurses::A_BOLD)
+          title_attrib (Ncurses::A_BOLD)
+        end
+      help = "q to quit. escdelay is #{nd}. 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."  
+      Canis::Label.new @form, {'text' => help, "row" => r+h+1, "col" => 2, "color" => "yellow"}
+      Canis::Label.new @form, {'text' => help1, "row" => r+h+2, "col" => 2, "color" => "green"}
+      texta.text = ["Press any key, Function, control, alt etc to see ","if it works.",
+        "See window.rb for keycodes if something is not being trapped properly"]
+
+      @form.repaint
+      @window.wrefresh
+      Ncurses::Panel.update_panels
+      while((ch = @window.getchar()) != 999 )
+        str = keycode_tos ch if ch.is_a? Fixnum
+        #str1 = @window.key_tos ch if ch.is_a? Fixnum
+        str1 = $key_chr
+        $log.debug  "#{ch} got (#{str} #{str1})"
+        texta << "#{ch} got (#{str}) #{str1}"
+        if ch == 99999
+          name = get_string "Add a name for #{$key_chr}?"
+          if name
+            texta << "setting #{name} for #{str1} "
+            $kh[str1] = name
+            _name = $kh[str1]
+            texta << "set #{_name} for #{str1} "
+            $kh.each_pair { |name, val| $log.debug " MMMAP #{name} : #{val}" }
+            File.open(dumpfile, 'w' ) do |f|
+              f << YAML::dump($kh)
+            end
+            texta << "Written new keys to #{dumpfile}. Pls copy over ~/ncurses-keys.yml"
+          end
+        end
+        texta.goto_end
+        texta.repaint
+        @form.repaint
+        @window.wrefresh
+        break if ch == ?\q.getbyte(0)
+        #break if ch == "q"
+      end
+    end
+  rescue => ex
+  ensure
+    @window.destroy if !@window.nil?
+    Canis::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,187 @@
+# 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.
+# NOTE : this is the new listbox (based on Textpad version, the original
+#  version has been moved to deprecated. 2014-04-08 - 18:32 
+require 'logger'
+require 'canis'
+require 'canis/core/widgets/listbox'
+require 'canis/core/include/vieditable'
+#require 'canis/experimental/widgets/undomanager'
+class Canis::Listbox
+  # 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 get_data str
+        #lines = `ri -f bs #{str}`.split("\n")
+  lines = `ri -f ansi #{str} 2>&1`.gsub('','').split("\n")
+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 box, navigate to a method name, and press <ENTER> on a method 
+name, to see its details in a popup screen.
+Press */* <slash> in any box to search. e.g "/String" will take you to the
+first occurrence of "String". <n> will take you to the next match.
+
+To go quickly to the 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 [[textpad]] 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", [[index]]
+
+    eos
+  end
+if $0 == __FILE__
+  include Canis
+
+  begin
+  # Initialize curses
+    Canis::start_ncurses  # this is initializing colors via ColorMap.setup
+    path = File.join(ENV["LOGDIR"] || "./" ,"canis14.log")
+    logfilename   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(logfilename)
+    $log.level = Logger::DEBUG
+
+    @window = Canis::Window.root_window
+    $log.debug "  WINDOW #{FFI::NCurses.LINES} "
+    $catch_alt_digits = true; # emacs like alt-1..9 numeric arguments
+    # 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.help_manager.help_text = my_help_text
+      #@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 = Canis::Label.new @form, {'text' => v, "row" => FFI::NCurses.LINES-2, 
+        "col" => fc, "width" => 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 = Listbox.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.current_value}`.split("\n")
+        #lines = `ri -f ansi #{listb.current_value} 2>&1`.gsub('','').split("\n")
+        lines = get_data listb.current_value
+        #w.set_content(lines, :ansi)
+        w.add_content(lines, {:content_type => :ansi, :title => listb.current_value})
+        w.buffer_last
+        #w.title = listb.current_value
+      }
+
+      tv = Canis::TextPad.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 'canis/core/include/multibuffer'
+      tv.extend(Canis::MultiBuffers)
+      # with format 'bs' we had a '=' but now it is colored so we've lost section.
+      tv.text_patterns[:section] = Regexp.new(/^= /)
+      tv.bind_key(?s, "goto section") { tv.next_regex(:section) }
+
+      # 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")
+          _text = get_data "#{tv.title}.#{w}"
+          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?
+  Canis::stop_ncurses
+  p ex if ex
+  p(ex.backtrace.join("\n")) if ex
+end
+end

data/examples/testlistbox1.rb

@@ -0,0 +1,199 @@
+require 'canis/core/util/app'
+require 'canis/core/include/appmethods'
+require 'canis/core/widgets/listbox'
+require 'canis/core/util/promptmenu'
+require './common/devel.rb'
+
+  def my_help_text
+    <<-eos
+    |abasiclist.rb|
+    =========================================================================
+    **Basic Usage**
+
+    This simple example shows 2 lists inside a "flow". Each takes 50 percent
+    of the screen's width. 
+
+    If you have brew installed, you can refresh the list to show actual
+    brew packages on your system, using ':r'. Then you can view info, edit,
+    or see the man page for that program.
+
+    In the second list, you can refresh the list with your gems using ":r".
+    Place cursor on any gem, and execute any of the ":" commands to see the 
+    output. "edit" shells out to your EDITOR.
+
+    You can try multiple selection using <v> and <V> for range 
+    select. Check the general help screen for more [[list]] commands. The selections
+    are not mapped to any command.
+
+    =========================================================================
+    :n or Alt-n for next buffer. 'q' to quit. [[index]]
+
+    eos
+  end
+
+
+
+# just a simple test to ensure that rbasiclistbox is running inside a container.
+App.new do 
+  devel_bindings
+  def disp_menu
+    # ideally this shuld get action_manager and add_action so these are added to widgets actions
+    f = @form.get_current_field
+
+    if f.name == "lb1"
+      menu = PromptMenu.new self do
+        item :r, :refresh
+        item :i, :info
+        item :m, :brew_man
+        item :e, :edit
+      end
+    else
+      menu = PromptMenu.new self do
+        item :r, :refresh
+        item :e, :edit
+        item :d, :dependency
+        item :s, :specification
+        item :w, :which
+      end
+    end
+    menu.display_new :title => "Menu"
+  end
+  # fill list with actual gems available on your system
+  def refresh
+    f = @form.get_current_field
+    if f.name == "lb2"
+      l = %x[gem list --local].split("\n")
+      w = @form.by_name['lb2']
+      w.list l
+    else
+      l = %x[brew list].split("\n")
+      w = @form.by_name['lb1']
+      w.list l
+    end
+  end
+  def specification
+    w = @form.by_name['lb2']
+    name = w.current_value.split()[0]
+    textdialog(%x[ gem specification #{name} ].split("\n") , :title => 'Specification')
+  end
+
+  # execute just man for the brew package
+  def brew_man
+    w = @form.by_name['lb1']
+    #name = w.text.split()[0]
+    name = w.current_value.split()[0]
+    shell_out "man #{name}"
+  end
+
+  # using gem which to get path, and then shelling out to EDITOR
+  def edit
+    f = @form.get_current_field
+    if f.name == "lb2"
+      name = f.current_value.split()[0]
+      shell_out "gem edit #{name}"
+    else
+      name = f.current_value.split()[0]
+      shell_out "brew edit #{name}"
+    end
+    return
+
+    # this is our own home-cooked version which opens the actual file in your editor
+    res = %x[ gem which #{name} ].split("\n")
+    res = res[0]
+    if File.exists? res
+      require './common/file.rb'
+      file_edit res
+    end
+  end
+  #
+  # general purpose command to catch miscellaneous actions that can be 
+  # executed in the same way. Or even take complex command lines
+  # such as what vim has.
+  def execute_this *cmd
+    f = @form.get_current_field
+    if f.name == "lb2"
+      m = "gem"
+    else
+      m = "brew"
+    end
+    w = f
+    # textpad returns array not just line DARN
+    #name = w.text.split()[0]
+    name = w.current_value.split()[0]
+    cmd = cmd[0].to_s
+    res = %x[ #{m} #{cmd} #{name}].split("\n")
+    res ||= "Error in command [#{cmd}] [#{name}] "
+    textdialog( res, :title => cmd ) if res
+  end
+  # handle resizing, sadly I am not sure flow and stack can do a resize, i am sure the xperimental one can.
+  def resize
+    lb1 = @form.by_name["lb1"]
+    lb2 = @form.by_name["lb2"]
+    maxc = Ncurses.COLS
+    maxr = Ncurses.LINES
+    lb1.height = maxr-2
+    lb2.height = maxr-2
+    lb1.width = ((lb1.width_pc * maxc) / 100).floor
+    lb2.width = ((lb2.width_pc * maxc) / 100).floor
+    lb2.col   = lb1.col + lb1.width
+    lab = @form.by_name["lab"]
+    lab.row = maxr-1
+  end
+
+  colors = Ncurses.COLORS
+  back = :blue
+  back = 234 if colors >= 256
+  header = app_header "canis #{Canis::VERSION}", :text_center => "Basic List Demo", :text_right =>"New Improved!", :color => :white, :bgcolor => back #, :attr => :bold 
+  message "Press F10 to escape from here"
+  #install_help_text my_help_text
+  @form.help_manager.help_text = my_help_text
+
+  @form.define_prefix_command :csmap, :scope => self
+  #@form.define_key(:csmap, "r", 'refresh') { refresh }
+  @form.define_key(:csmap, "r", 'refresh', :refresh )
+  @form.define_key(:csmap, "s", 'specification') { specification }
+  @form.bind_key ?\C-s, :csmap
+  #pm = PrefixCommand.new :csmap, self do |p|
+    #p.key("r", 'refresh', :refresh )
+    #p.key("s", 'specification'){ specification }
+  #end
+  #@form.bind_key(?\C-x){ pm.call }
+  # testing that 'q' works along with 'qq'
+  @form.bind_key(?q){ ht = @form.current_widget.help_text || "No help for this widget"; alert ht }
+
+  # testing triple bindings, along with a fall-back with only two bindings.
+  @form.bind_key([?\\, ?\\, ?h]){ ht = @form.current_widget.help_text || "No help for this widget"; alert ht }
+  @form.bind_key([?\\, ?\\, ?H]){ ht = @form.current_widget.help_text || "No help for this widget"; 
+                                  str = get_string("Enter help text:", :default => ht);
+                                  @form.current_widget.help_text = str
+                                  }
+  @form.bind_key([?\\, ?\\]){ alert "Enter h for seeing helptext on this widget, H for setting it"; }
+
+  alist = File.open("data/brew.txt",'r').readlines
+  list2 = File.open("data/gemlist.txt",'r').readlines
+  lb = nil
+
+  flow :margin_top => 1, :height => FFI::NCurses.LINES-2 do
+    lb = listbox :list => alist, :suppress_borders => false, :title => "[ brew packages ]",
+      :left_margin => 0, :width_pc => 50, :name => 'lb1', :selection_mode => :single
+    lb.show_selector = false
+    lb.help_text = "Brew packages on your system. Use vim keys to navigate, or : to run a command"
+    
+    lb2 = listbox :list => list2, :justify => :left, :title => "[ gems ]", :suppress_borders => false,
+      :left_margin => 0, :width_pc => 50, :name => 'lb2'
+    end
+  
+ 
+  label({:text => "F1 Help, F10 Quit. : for menu. Press F4 and F5 to test popup, v to select", :row => Ncurses.LINES-1, :col => 0, :name => 'lab'})
+
+  @form.bind(:RESIZE) { resize() }
+  @form.bind_key(FFI::NCurses::KEY_F4, "Popup") { row = lb.visual_index+lb.row; col=lb.col+lb.current_value.length+1;  
+                                         
+                                         row = [row, FFI::NCurses.LINES - 8].min
+                                         ret = popuplist(%w[ chopin berlioz strauss tchaiko matz beethoven], :row => row, :col => col, :title => "Names", :bgcolor => :blue, :color => :white) ; alert "got #{ret} "}
+
+  @form.bind_key(FFI::NCurses::KEY_F5, "Popup") {  list = %x[ls].split("\n");ret = popuplist(list, :title => "Files"); alert "Got #{ret} #{list[ret]} " }
+
+  @form.bind_key(?:, "Menu") { disp_menu; 
+  }
+end # app