canis 0.0.4

data/examples/teststacklayout.rb

@@ -0,0 +1,48 @@
+# #!/usr/bin/env ruby -w
+# ----------------------------------------------------------------------------- #
+#         File: teststacklayout.rb
+#  Description: 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-05-08 - 23:34
+#      License: MIT
+#  Last update: 2014-05-28 22:09
+# ----------------------------------------------------------------------------- #
+
+if __FILE__ == $PROGRAM_NAME
+  require 'canis/core/util/app'
+  require 'canis/core/widgets/listbox'
+  require 'canis/core/include/layouts/stacklayout'
+  App.new do
+
+
+      @form.bind_key(FFI::NCurses::KEY_F3,'view log') { 
+        require 'canis/core/util/viewer'
+        Canis::Viewer.view("canis14.log", :close_key => KEY_ENTER, :title => "<Enter> to close")
+      }
+    # 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 = StackLayout.new :height_pc => 1.0, :top_margin => 1, :bottom_margin => 1, :left_margin => 1
+    layout.form = @form
+    @form.layout_manager = layout
+    layout.weightage lb, 7
+    #layout.weightage lb1, 9
+    #$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/testwsshortcuts.rb

@@ -0,0 +1,68 @@
+# this is a test program, tests out tabbed panes. type F1 to exit
+#
+require 'canis'
+require 'canis/core/util/widgetshortcuts'
+
+include Canis
+
+class SetupMessagebox
+  include Canis::WidgetShortcuts
+  def initialize config={}, &block
+    @window = Canis::Window.root_window
+    @form = Form.new @window
+  end
+  def run
+    _create_form
+    @form.repaint
+    @window.wrefresh
+    while ((ch = @window.getchar()) != 999)
+      break if ch == ?\C-q.getbyte(0)
+      @form.handle_key ch
+      @window.wrefresh
+    end
+  end
+  def _create_form
+    widget_shortcuts_init
+    stack :margin_top => 2, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+      label :text => " Details ", :color => :blue, :attr => :reverse, :width => :expand, :justify => :center
+      blank
+      field :text => "john", :attr => :reverse, :label => "%15s" % ["Name: "]
+      field :label => "%15s" % ["Address: "], :width => 15, :attr => :reverse
+      check :text => "Using version control", :value => true, :onvalue => "yes", :offvalue => "no"
+      check :text => "Upgraded to Lion", :value => false, :onvalue => "yes", :offvalue => "no"
+      blank
+      radio :text => "Linux", :value => "LIN", :group => :os
+      radio :text => "OSX", :value => "OSX", :group => :os
+      radio :text => "Window", :value => "Win", :group => :os
+      flow :margin_top => 2, :margin_left => 4, :item_width => 15  do
+        button :text => "Ok", :default_button => true do throw :close; end
+        button :text => "Cancel"
+        button :text => "Apply"
+      end
+    end
+  end
+
+end
+if $0 == __FILE__
+  # Initialize curses
+  begin
+    # XXX update with new color and kb
+    Canis::start_ncurses  # this is initializing colors via ColorMap.setup
+    path = File.join(ENV["LOGDIR"] || "./" ,"canis14.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+    catch(:close) do
+    tp = SetupMessagebox.new()
+    buttonindex = tp.run
+    $log.debug "XXX:  MESSAGEBOX retirned #{buttonindex} "
+    end
+  rescue => ex
+  ensure
+    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/testwsshortcuts2.rb

@@ -0,0 +1,129 @@
+# this is a test program, tests out widget shortcuts. type C-q to exit
+#
+require 'canis'
+require 'canis/core/util/widgetshortcuts'
+
+include Canis
+include Canis::Utils
+
+class SetupMessagebox
+  include Canis::WidgetShortcuts
+  def initialize config={}, &block
+    @window = Canis::Window.root_window
+    @form = Form.new @window
+  end
+  def run
+    _create_form
+    @form.repaint
+    @window.wrefresh
+    catch(:close) do
+    while ((ch = @window.getchar()) != 999)
+      break if ch == ?\C-q.getbyte(0)
+      @form.handle_key ch
+      @window.wrefresh
+    end
+    end # catch
+  end
+  def _create_form
+    widget_shortcuts_init
+    stack :margin_top => 1, :width => :expand do
+      label :text => " Details ", :color => :cyan, :attr => :reverse, :width => :expand, :justify => :center
+      flow :margin_top => 1, :margin_left => 4, :item_width => 50   do
+        stack :margin_top => 0, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+          box do
+            field :text => "steve", :attr => :reverse, :label => "%15s" % ["Name: "]
+            field :label => "%15s" % ["Address: "], :width => 15, :attr => :reverse
+            blank
+            check :text => "Using version control", :value => true, :onvalue => "yes", :offvalue => "no" do |eve|
+              unless eve.item.value 
+                alert "NO VC! We need to talk"
+              end
+            end
+            check :text => "Upgraded to Mavericks", :value => false, :onvalue => "yes", :offvalue => "no" do |eve|
+              unless eve.item.value
+                alert "You goin back to Snow Leopard?"
+              end
+            end
+          end # box
+        end
+        stack :margin_top => 0, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+          box :title => "OS Maintenance", :margin_left => 2 do
+            radio :text => "Linux", :value => "LIN", :group => :os
+            radio :text => "OSX", :value => "OSX", :group => :os
+            radio :text => "Window", :value => "Win", :group => :os
+            blank
+          flow  :item_width => 15 do
+            button :text => "Install" do 
+              # you can avoid this by giving the radio buttons your own Variable (see test2.rb)
+              choice = @variables[:os].value
+              case choice
+              when ""
+                alert "Select an OS"
+              when "OSX", "LIN"
+                alert "Good choice"
+              else
+                alert "Pfft !"
+              end
+            end
+            button :text => "Uninstall"
+            button :text => "Delete"
+          end
+          end # box
+        end
+      end # flow
+      #button :text => "Execute"
+      text = ["      #[reverse]Unix Philosophy #[end]  ", 
+        "#[fg=green, underline]Eric Raymond#[end] in his book, #[fg=green, underline]The Art of Unix Programming#[end] summarized the Unix philosophy.",
+      "  ",
+        "Rule of #[fg=yellow]Modularity#[end]: Write simple parts connected by clean interfaces.",
+        "Rule of #[fg=blue]Clarity#[end]: #[bold]Clarity#[end] is better than cleverness.",
+        "Rule of #[fg=red]Separation#[end]: Separate #[bold]policy#[end] from mechanism; separate interfaces from engines.",
+          "Rule of #[fg=green]Simplicity#[end]: Design for #[bold]simplicity;#[end] add complexity only where you must.",
+        "Rule of #[fg=magenta]Parsimony#[end]: Write a big program only when it is clear by demonstration that nothing else will do.",
+        "Rule of #[fg=cyan]Representation#[end]: Fold knowledge into #[bold]data#[end] so program logic can be stupid and robust"]
+        text << "For more check: #[underline]http://en.wikipedia.org/wiki/Unix_philosophy#Eric_Raymond#[end]"
+        formatted = []
+        #text.each { |line| formatted << @window.convert_to_chunk(line) }
+
+      #textview :text => formatted
+        #textview do |t| t.formatted_text(text, :tmux) end
+        t = textview :title => 'tmux format'
+        #t.formatted_text(text, :tmux)
+        t.text(text, :content_type => :tmux)
+        t1 = textview :title => 'ansi formatted document'
+        text = File.open("data/color.2","r").readlines
+        #text = `ri -f bs String`.split("\n")
+        #t1.formatted_text(text, :ansi)
+        t1.text(text, :content_type => :ansi)
+
+      flow do
+        #box do
+          button :text => "  Ok  " do  alert "Pressed okay"  end
+          button :text => "Cancel" do  throw :close if(confirm "Do you wish to Quit?") ; end
+          button :text => "Apply "
+        #end
+      end
+
+    end
+
+  end
+end
+if $0 == __FILE__
+  # Initialize curses
+  begin
+    # XXX update with new color and kb
+    Canis::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"canis14.log")))
+    $log.level = Logger::DEBUG
+    tp = SetupMessagebox.new()
+    buttonindex = tp.run
+    $log.debug "XXX:  MESSAGEBOX retirned #{buttonindex} "
+  rescue => ex
+  ensure
+    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/lib/canis.rb

@@ -0,0 +1,16 @@
+require "canis/version"
+require 'ffi-ncurses' 
+require 'canis/core/system/ncurses'
+require 'canis/core/system/window'
+require 'canis/core/widgets/rwidget'
+# added textpad here since it is now the basis of so many others 2014-04-09 - 12:57 
+require 'canis/core/widgets/textpad'
+require 'canis/core/util/rdialogs'
+
+module Canis
+  # key used to select a row in multiline widgets (earlier was SPACE but conflicted with paging)
+  $row_selector = 'v'.ord
+  # key used to range-select rows in multiline widgets (earlier was CTRL_SPACE )
+  $range_selector = 'V'.ord
+  # Your code goes here...
+end

data/lib/canis/core/docs/index.txt

@@ -0,0 +1,104 @@
+# G E N E R A L   H E L P
+=======================
+              <q> to quit this window. <Space> to scroll. 
+    <TAB> goes to next link in help file. Press <ENTER> to open link.
+
+_____________________________________________________________________
+## 1. General Help 
+
+          F10         - exit application. Also, <C-q>
+          F1          - Help
+
+          In some applications, the following may have been provided:
+
+          ?           - Should display all the key bindings available
+                        for that widget. Alternatively, <M-?>
+
+          Alt-x       - additional commands
+          :           - additional commands
+          :!          - system command
+          <C-x>c      - system command
+
+
+_____________________________________________________________________
+## 2. Form
+
+  <Tab> and <backtab> navigate between widgets.
+
+_____________________________________________________________________
+## 3. Multiline widgets
+
+In most widgets such as [[list]], [[textpad]], [[table]], and [[tree]] the
+following vim-bindings are applicable.
+
+          j,k,l,h, gg, G, C-d, C-b, C-e, C-y, w, b, /
+
+          <space> scrolls 
+          <Ctrl-Space> scroll up (aka C-@)
+
+In multiline widgets such as _list_ and _tree_ to move to first item
+starting with a character, press "f" followed by that character.
+
+
+_____________________________________________________________________
+## 4. Editable Widgets
+
+In _field_ and editable _textarea_, some emacs/Pine keys such as C-e,
+C-a, C-k (delete till end) are available.
+
+        <C-a>   -  start of line
+        <C-e>   -  end of line
+        <C-k>   -  delete till end of line
+        <M-i>   -  toggle overwrite mode
+
+_____________________________________________________________________
+## 5. Buttons
+
+_Button_ can be fired using <space>. The default button, if
+declared, is shown with as > Ok < as against other buttons, shown as [
+Cancel ]. This can be fired by hitting <ENTER> anywhere on the form
+(unless the current widget traps <ENTER>).
+
+Pressing <ENTER> will trigger the default button, even if you are on
+another button. 
+
+Hotkeys are available using Alt-<key> and will be displayed with an 
+underline if the TERM displays underlines.
+
+_____________________________________________________________________
+## 6. Others
+
+### 6.1 Selection in lists
+
+Please note that in earlier versions, <SPACE> was used for selection.
+However, since this conflicts with the scrolling behavior in most
+multiline widgtes, <SPACE> and <C-SPACE> are now exclusively used for
+scrolling down and up. The characters "v" and "V" are used for
+selection. This may be altered by setting "`$row_selector`".
+
+          v       -   toggle selection
+          V       -   range select
+          a       -   select all
+          u       -   unselect all (should be changed, as conflicts with
+                        vim undo)
+          *       -   invert selection
+
+          -       -   `ask_unselect`
+          +       -   `ask_select`
+
+### 6.2 Terminal (TERM) settings
+
+Some terminals (such as xterm) show underlines , however the 256color ones
+do not. 
+
+Some terminals mess the screen output such as `xterm-256color`. At least
+while working under `tmux` in `iTerm` (with solarized), this terminal was 
+messing the output. 
+Things are fine with `screen-256color`.
+
+### 6.3 Other components
+
+-  [[tabbedpane]]
+_____________________________________________________________________
+q to quit, gg to goto top. <TAB> goes to next link in help file
+Press <ENTER> to open link.

data/lib/canis/core/docs/list.txt

@@ -0,0 +1,16 @@
+# Help for Lists
+
+Lists support selection, either single or multiple. 
+
+Single selecion is done using "v" which is the visual mark key in vim.
+In multiple selection, the "v" may be used to select multiple rows. 
+The "V" character may be used for range selection.
+
+Lists also provide for inversion of selection (*), select all (a) and clear selection  (u). 
+These bindings may have been modified by your individual application.
+
+*Ask_select* and *Ask_Unselect* may be mapped for certain applications
+allowing a user to give a pattern to select or unselect. 
+
+Lists support all other motion commands of [[Textpad]].
+

data/lib/canis/core/docs/style_help.yml

@@ -0,0 +1,34 @@
+---
+link:
+    :color: :yellow
+    :bgcolor: :black
+    :attr: :underline
+bold:
+    :attr: :bold
+em: 
+    :color: :blue
+    :attr: :bold
+strong: 
+    :color: :yellow
+    :attr: :bold
+code: 
+    :color: :cyan
+    :bgcolor: 236
+h1: 
+    :attr: :reverse
+h2: 
+    :color: :green
+    :attr: :bold
+h3: 
+    :color: :yellow
+key: 
+    :color: :red
+    :attr: :bold
+ul:
+    :color: :blue
+    :bgcolor: :black
+    :attr: :underline
+wb:
+    :color: :white
+    :_bgcolor: :black
+    :attr: :bold

data/lib/canis/core/docs/tabbedpane.txt

@@ -0,0 +1,15 @@
+# Help for TabbedPanes
+
+TabbedPanes allow multiple forms to occupy one area on the screen.
+Following are some keys useful on a tabbedpane:
+<
+
+    <TAB>   -   navigate between tabs or components
+    <DOWN>  -   navigate to the components of a tab
+    <UP>    -   navigate between components on a tab
+                or back to the the tabs
+    <SPACE> -   activate the tab under cursor
+                Earlier, <ENTER> would have worked, but now
+                <ENTER> only fires the default button an a page.
+>
+(This page needs to be completed)

data/lib/canis/core/docs/table.txt

@@ -0,0 +1,31 @@
+# Help for Tables
+
+Tables are multirow components that support columnar information.
+
+Columns may be resized, or hidden. Keys for this will have to be defined
+by the application, if appropriate.
+
+Data may be sorted on column by pressing <ENTER> on the header, if the 
+default table sorter has been enabled, or a custom sorter defined.
+
+Tables support all or most motion commands of [[Textpad]].
+
+Tables may be configured to support selection capabilities of [[List]] 
+if required.
+
+Some operations on tables are as follows:
+<
+    w      -    move to next column
+    b      -    move to previous column
+    <M-->  -    <Alt-minus> to reduce column width
+    <M-+>  -    <Alt-plus> to increase column width
+    <=>    -    press <equal> to size width of column to width of data in current column 
+
+>
+
+Some basic row addition and editing facilities are also provided, which
+must be bound to a key, if the application allows editing. It is
+expected that an application will customize the basic row editing
+feature for its needs. See |tabular.rb|.
+
+(This page needs to be completed)