rbcurse-core 0.0.0

data/README.md

@@ -0,0 +1,69 @@
+# rbcurse-core
+
+Contains core widgets and infrastructure of rbcurse ncurses toolkit. rbcurse helps to easily build
+ncurses application for text terminals.
+
+rbcurse-core contains basic widgets for constructing applications.  These include:
+
+* field
+
+* buttons - checkbox, radio, toggle
+
+* list
+
+* textview
+
+* dialogs and popup
+
+* table
+
+* menu
+
+* tabbedpane
+
+* tree
+
+* application header
+
+* status line
+
+Core intends to be : 
+
+   * stable, 
+
+   * have very few changes, 
+
+   * be backward compatible.
+
+   * simple, maintaible code
+
+I shall be standardizing core over the next one or two minor versions. I shall also be simplifying code as much as possible to make it maintainable and more bug-free.
+
+Method names in some classes may change, and one or two widget names will change. rbasiclistbox will become listbox while the old listbox that has moved to extras will become something like editlistbox. Similarly the old table will become edittable in extras, whereas tabularwidget will becoming table in core.
+The new tabbedpane and messagebox will replace the old ones, while the old ones will move to /deprecated.
+
+Color formatting needs to be standardized and a proper API firmed up for that, so user code does not get affected by internal changes. Similarly, work on textpad may get integrated into some widgets since it could simplify their code.
+
+## Install
+
+   `gem install rbcurse-core`        # just the core
+
+   To install more:
+
+   `gem install rbcurse-extras`        # the core, and extra stuff
+
+   `gem install rbcurse`             # the core, extra and experimental stuff
+
+## See also
+
+* rbcurse - <http://github.com/rkumar/rbcurse/>
+
+* rbcurse-core - <http://github.com/rkumar/rbcurse-core/>
+
+* rbcurse-experimental - <http://github.com/rkumar/rbcurse-experimental/>
+
+## License
+
+  Same as ruby license.
+
+  (c) copyright rkumar, 2008-2011.

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/abasiclist.rb

@@ -0,0 +1,151 @@
+require 'rbcurse/core/util/app'
+require 'rbcurse/core/include/appmethods'
+require 'rbcurse/core/widgets/rlist'
+
+  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 <space> and <ctrl-space> 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.
+
+    eos
+  end
+
+
+
+# just a simple test to ensure that rbasiclistbox is running inside a container.
+App.new do 
+  def disp_menu
+    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.text.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]
+    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.text.split()[0]
+      shell_out "gem edit #{name}"
+    else
+      name = f.text.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
+    name = w.text.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
+
+  colors = Ncurses.COLORS
+  back = :blue
+  back = 234 if colors >= 256
+  header = app_header "rbcurse #{Rbcurse::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
+
+  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 => 1, :width_pc => 50, :name => 'lb1'
+    lb.show_selector = false
+    
+    lb2 = listbox :list => list2, :justify => :left, :title => "[ gems ]", :suppress_borders => false,
+      :left_margin => 1, :width_pc => 50, :name => 'lb2'
+    end
+  
+ 
+  label({:text => "F1 Help, F10 Quit. Press F4 and F5 to test popup, space or enter to select", :row => Ncurses.LINES-1, :col => 0})
+
+  @form.bind_key(FFI::NCurses::KEY_F4) { row = lb.current_index+lb.row; col=lb.col+lb.current_value.length+1;  ret = popuplist(%w[ andy 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) {  list = %x[ls].split("\n");ret = popuplist(list, :title => "Files"); alert "Got #{ret} #{list[ret]} " }
+
+  @form.bind_key(?:) { disp_menu; 
+  }
+end # app

data/examples/alpmenu.rb

@@ -0,0 +1,46 @@
+require 'rbcurse/core/util/app'
+
+  App.new do 
+    #title "Demo of Menu - rbcurse"
+    #subtitle "Hit F1 to quit, F2 for menubar toggle"
+    header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Alpine Menu Demo", :text_right =>""
+
+    stack :margin_top => 10, :margin_left => 15 do
+      #w = "Messages".length + 1
+      w = 60
+      menulink :text => "&View Todo", :width => w, :description => "View TODO in sqlite"  do |s|
+        message "Pressed #{s.text} "
+        load './dirtree.rb'
+        #require './viewtodo'; todo = ViewTodo::TodoApp.new; todo.run
+      end
+      blank
+      menulink :text => "&Edit Todo", :width => w, :description => "Edit TODO in CSV"  do |s|
+        message "Pressed #{s.text} "
+        load './tabular.rb'
+        #require './testtodo'; todo = TestTodo::TodoApp.new; todo.run
+      end
+      blank
+      menulink :text => "&Messages", :width => w, :description => "View messages in current folder"  do |s|
+        message "Pressed #{s.text} "
+        load './tasks.rb'
+      end
+      blank
+      menulink :text => "&Compose", :width => w, :description => "Compose a mail"  do |s|
+        message "Pressed #{s.getvalue} "
+        load './dbdemo.rb'
+      end
+      blank
+      # somehow ? in mnemonic won't work
+      menulink :text => "&Setup", :width => w, :description => "Configure Alpine options"  do |s|
+        #message "Pressed #{s.text} "
+        alert "Not done!"
+      end
+      blank
+      menulink :text => "&Quit", :width => w, :description => "Quit this application"  do |s|
+        quit
+      end
+      @form.bind(:ENTER) do |w|
+        header.text_right = w.text
+      end
+    end # stack
+  end # app

data/examples/app.sample

@@ -0,0 +1,17 @@
+require 'rbcurse/core/util/app'
+
+def help_text
+    <<-eos
+    eos
+end
+
+App.new do 
+  header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "My Demo", :text_right =>"New Improved!", 
+      :color => :black, :bgcolor => :white, :attr => :bold 
+  message "Press F10 to exit from here, F1 for help, F2 for menu"
+
+  stack :margin_top => 1, height => FFI::NCurses.LINES-3 do
+
+  end # stack
+  status_line :row => FFI::NCurses.LINES-1
+end # app

data/examples/atree.rb

@@ -0,0 +1,100 @@
+require 'rbcurse/core/util/app'
+
+App.new do 
+  var = Variable.new
+  header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Tree Demo", :text_right =>"New Improved!", :color => :black, :bgcolor => :white, :attr => :bold 
+  message "Press Enter to expand/collapse"
+
+      @form.bind_key(FFI::NCurses::KEY_F3) { 
+        require 'rbcurse/core/util/viewer'
+        RubyCurses::Viewer.view("rbc13.log", :close_key => KEY_ENTER, :title => "<Enter> to close")
+      }
+
+      ww = FFI::NCurses.COLS-0
+      flow :width => ww , :margin_top => 1, :height => FFI::NCurses.LINES-2 do
+        stack :margin_top => 0, :width_pc => "30" do
+          tm = nil
+          atree = tree :height => 10, :title => '[ ruby way ]'  do
+            root "root" do
+              branch "hello" do
+                leaf "ruby"
+              end
+              branch "goodbye" do
+                leaf "java"
+                leaf "verbosity"
+              end
+            end
+          end
+          found=atree.get_node_for_path "goodbye"
+          atree.set_expanded_state(atree.root, true)
+          atree.set_expanded_state(found,true)
+
+          # using a Hash
+          model = { :ruby => [ "jruby", {:mri => %W[ 1.8.6 1.8.7]}, {:yarv => %W[1.9.1 1.9.2]}, "rubinius", "macruby" ], :python => %W[ cpython jython laden-swallow ] }
+          tree :data => model, :title => "[ Hash ]"
+
+        end # stack
+        stack :margin_top => 0, :width_pc => "30" do
+
+          # using an Array, these would be expanded on selection, using an event
+          tree :data => Dir.glob("*"), :title=> "[ Array ]" do 
+            command do |node|
+              # insert dir entries unless done so already
+              if node.children && !node.children.empty?
+              else
+                f = node.user_object
+                if File.directory? f
+                  l = Dir.glob(f + "/*")
+                  node.add(l) if l
+                end
+              end
+            end
+            bind :ENTER_ROW do |t|
+              var.value = t.text.user_object
+            end
+          end
+
+          # long way ISO 9001 certifed, SEI CMM 5 compliant
+          #
+          root    =  TreeNode.new "ROOT"
+          subroot =  TreeNode.new "subroot"
+          leaf1   =  TreeNode.new "leaf 1"
+          leaf2   =  TreeNode.new "leaf 2"
+          model = DefaultTreeModel.new root
+          #model.insert_node_into(subroot, root,  0)  # BLEAH JAVA !!
+
+          # slightly better, since we return self in ruby
+          root << subroot
+          subroot << leaf1 << leaf2
+          leaf1 << "leaf11"
+          leaf1 << "leaf12"
+
+          # more rubyish way
+          root.add "blocky", true do 
+            add "block2"
+            add "block3" do
+              add "block31"
+            end
+          end
+
+          tree :data => model, :title => "[ legacy way ]"
+
+        end
+        #stack :margin_top => 2 do
+        stack :margin_top => 0, :width_pc => "40", :height => :expand do
+          t = textview  :suppress_borders => true, :height_pc => 100
+            var.command do |filename| 
+              filename = filename.value
+              if File.directory? filename
+                lines = Dir.entries(filename )
+                t.set_content lines
+              elsif File.exist? filename
+                lines = File.open(filename,'r').readlines 
+                t.set_content lines
+              else
+                alert " #{filename} does not appear to be a file "
+              end
+            end
+        end
+      end # flow
+end # app

data/examples/common/file.rb

@@ -0,0 +1,45 @@
+# ----------------------------------------------------------------------------- #
+#         File: file.rb
+#  Description: some common file related methods which can be used across
+#              file manager demos, since we seems to have a lot of them :)
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2011-11-15 - 19:54
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: use ,,L
+# ----------------------------------------------------------------------------- #
+#
+
+require 'rbcurse/core/include/appmethods'
+module RubyCurses
+  def file_edit fp #=@current_list.filepath
+    #$log.debug " edit #{fp}"
+    editor = ENV['EDITOR'] || 'vi'
+    vimp = %x[which #{editor}].chomp
+    shell_out "#{vimp} #{fp}"
+  end
+
+  # TODO we need to move these to some common file so differnt programs and demos
+  # can use them on pressing space or enter.
+  def file_page fp #=@current_list.filepath
+    unless File.exists? fp
+      pwd = %x[pwd]
+      alert "No such file. My pwd is #{pwd} "
+      return
+    end
+    ft=%x[file #{fp}]
+    if ft.index("text")
+      pager = ENV['PAGER'] || 'less'
+      vimp = %x[which #{pager}].chomp
+      shell_out "#{vimp} #{fp}"
+    elsif ft.index(/zip/i)
+      shell_out "tar tvf #{fp} | less"
+    elsif ft.index(/directory/i)
+      shell_out "ls -lh  #{fp} | less"
+    else
+      alert "#{fp} is not text, not paging "
+      #use_on_file "als", fp # only zip or archive
+    end
+  end
+
+end # module
+include RubyCurses

data/examples/data/README.markdown

@@ -0,0 +1,9 @@
+I've put some data here to use in programs as text for textareas, textviews or lists.
+
+brew.txt - single list, use in listboxes
+color.2  - ANSI formatted text, use in formatted textview
+gemlist.txt - single column list
+lotr.txt    - running text for text views
+ports.txt   - 3 column list, use in tables, tabular
+unix1.txt   - running text
+unix2.txt   - running text