rbcurse 1.4.0 → 1.4.1.pre2

data/NOTES

@@ -2044,3 +2044,71 @@ Sean is coming out with a version 0.4.0 which I am using. rbcurse 1.3.0
 onwards uses ffi-ncurses. 
 
 * * * * * * * *
+
+Subject: color formatting
+-------------------------
+Date: 2011-11-03 15:03
+
+Alot has happened since moving to ffi. New widgets and containers, a new
+tabbedpane that hopefully doesn't suck and is more rubyesque. However,
+its amazing how simple the color formatting issue was. Took me only a
+few minutes to get working with a good regular expression.
+
+The motivation is to be able to have a document with color formatting. I
+am using the color formatting code of tmux, i.e., #[fg=green, bg=blue,
+bold] etc. However, I added an "#[end]" tag which pops the previous
+color, so now its more like html's span, than the terminal escape
+sequences which just override the previous.
+
+I'll ofcourse use this in the statusline, in help screens, and also in
+some way in textview, and somehow even in messages, alerts, messageboxes
+etc. It's still rough, does no checking for mistakes and I don't have a
+routine to wrap text ignoring the color stuff. That will be needed soon.
+
+* * * * * * * *
+
+Subject: bifurcating into core and others
+-----------------------------------------
+Date: 2011-11-08 18:30
+
+Perhaps it would be better to divide rbcurse into rbcurse-core and then
+other packages or gems.
+This way *core* can remain more or less frozen and bug fixes can be
+released quickly without waiting for other features to stabilize.
+
+Changes in other packages can be made without disturbing core. Core can
+be kept backward compatible. And it can remain light with just form,
+window, field, buttons, list and perhaps textview. 
+
+Other widgets can be put in other gems. The entire extras, UI patterns,
+experimental work. There could be a *rbcurse-experimental* which moves to
+either core or standard as and when it stabilizes.
+
+1. rbcurse-core - form, field, label, buttons, dialogs, basiclist, messagebox
+   viewer, menus? , combo - basically whatever is required to run test2 and
+   test1.rb. We must have a minimal number of programs to test for this.
+   Actually, test2 incorporates a lot!
+
+2. rbcurse-util
+   menus?, textarea?, tabbedpane, tree
+   tables, tabular, keylabel, progress, scrollbar, statusline,
+
+3. rbcurse-extras 
+   vimsplit, multi-containers, masterdetail, directorylist etc
+   statuswindow, rcommandwindow
+   link, menulink, container
+
+4. rbcurse-experimental
+   resultset, 
+   Pad, subwin,derwin from window class, scrollform, app, stack/flow
+   gmailfield
+
+5. rbcurse-demos
+   rfe, sqlc/m, dbdemo which can be installed and run from anywhere
+   appemail
+   This must be dependent on a specific version of core and util.
+
+6. rbcurse-db
+    database related work - resultsetview etc
+
+* * * * * * * *

data/README.markdown

@@ -1,72 +1,82 @@
 # rbcurse (for ruby 1.9.x)
 
-* Migrating from ncurses-ruby to ffi-ncurses
+*  News!! Migrated from ncurses-ruby to ffi-ncurses since 1.3.0
 
-I have moved rbcurse to ffi-ncurses (earlier ncurses gem) since 1.3.0.
+* After releasing 1.4.1, I will be separating this gem into core, extras and experimental.
+  Until now the basic widgets have often been volatile, with sudden changes coming in minor
+  versions or patch versions. With 1.5.0, I hope to keep the core stable and back-compat.
 
-Please report bugs on github/rkumar/rbcurse mentioning version. Your program dependency
-should be an explicit rbcurse version since I am doing a lot of improvements, cleaning up
-etc in the code base.
+  I've totally rewritten tabbedpane and messagebox. Much simpler now. Will substitute this with 
+  existing one in 1.5.0 and push the existing ones into /deprecated. There is now support for
+  printing colored text in ansi-escape format or a better format based on tmux's status-line 
+  config, which allows for nesting of colors. I need to iron out the interface.
 
-If you are looking for the ncurses version, please goto
-branch rbcurse1.2.0. I am not likely to support that henceforth due to the difficulty in installing ncurses gem.
+## DESCRIPTION:
 
-Thanks a lot to Sean O'Halpin for the ffi-ncurses gem and immediately responding 
-to my queries. I am testing on OSX Snow Leopard with ruby 1.9.2, TERM=screen on zsh.
+A small but comprehensive widget library written in ruby for creating ncurses
+applications. Tested on 1.9.1/2, compatible with 1.8.7.
 
-* 2011-09-14 : I am thinking of using the 1.2.x version for ncurses-ruby - any final
-bug fixes etc, and releasing a 1.2.x gem. See the rbcurse1.2.0 branch for more updates.
-Also, using 1.3.x and beyond for the ffi-ncurses version. Will start with a pre-release gem and
-then do a final after some testing.
+## FEATURES
 
-* Version that works with ruby 1.9 (backward compatible with 1.8.7)
+* Field : text/entry fields in pure ruby (not ncurses)
+* scrollable list box (also editable lists with Field, checkbox and combos)
+* Textarea : multi-line editable area 
+* Textview - read-only textarea with vim keys for navigation 
+* togglebutton, radio and check buttons (with mnemonics)
+* message box
+* menubar - with submenus
+* popup list
+* tabbedpane (multiple forms using tabbed metaphor)
+* combobox
+* labels with mnemonics
+* Table: multi-column table - with cell selection and editing, horizontal and
+  vertical scrolling
+* MultiContainer = add any number of objects to it (such as tables or text objects) and cycle through them
+  (saves screen estate)
+* MultiTextView - have multiple files open for viewing in one component. Since these are readonly files, one can map a lot of single-keys as in vim for operating and cycling through buffers.
+* PromptMenu - A simple interactive menu like the `most` application. Saves on allocating keybindings and memorizing them.
+* multiple key bindings for Procs, block and symbols (as in vim and emacs: `C-x C-f` or `15dd`)
+* Kill-ring concept of emacs for cut-paste operations
+* Unlimited undo and redo in TextArea/Lists (needs to be switched on at present on instance basis)
+* Numeric arguments. (vim: 25dd etc. Or in an editable box, emacs's C-u or Alt-1..9)
+* ScrollForm (testscroller.rb) - a form that takes more fields/objects than can be viewed at a go. Meta keys scroll the form.
+* Many more.
 
-* 1.3.1: Rework of some classes - see CHANGELOG
-* 1.3.0: ffi-ification of rbcurses with some minor bug-fixes, deprecations
-* 1.2.0: many additions (See CHANGELOG for details)
-  - App class that wraps the environment and makes application development very easy
-  - New controls such as:
-    - vimsplit: allows multiple vertical and horizontal splits in one component
-    - progress bar
-    - Tree control
-    - Divider (can grab and move, so as to visually resize components)
-    - Scrollbar class that can be easily attached to lists, tables etc
-    - Tabular data widgets and data converters
+Above may be created using DSL like syntax, or hashes, and modified at
+runtime. Very flexible unlike ncurses forms and fields.
 
-  Please see CHANGELOG for changes.
 
-* rbcurse 1.1.4 works with 1.9.2 and also contains some files that got missed out in gemspec.
+## Download rbcurse
 
-* Corrections due to 1.9.2:
-  - hash_update: rwidget.rb and rtable.rb
-    Please report any more errors due to this
-  - $: does not contain "." (affects some examples only)
+* <https://rubygems.org/gems/rbcurse>
 
-Check downloads at <http://github.com/rkumar/rbcurse/downloads>
+* <http://github.com/rkumar/rbcurse>
 
-test2.rb works - i always give it a quick run after making changes. If using ruby1.9.2, you might say: `ruby -I. test2.rb`.
+## Screenshots
 
-* <http://totalrecall.wordpress.com>  - always has some status posted.
+*  <http://www.benegal.org/files/screen/?M=D>  
+*  <http://totalrecall.wordpress.com>   
+*  <http://github.com/rkumar/rbcurse/wikis/screenshots>
 
-* <http://rdoc.info/github/rkumar/rbcurse/master> - rdoc
+## Other links
+
+* rbcurse tutorial (WIP - please review and give feedback)
+ <http://rbcurse.rubyforge.org/tut0.html>
 
-* Notes/thoughts/ideas on rbcurse - <http://rbcurse.tumblr.com/>
+* <http://totalrecall.wordpress.com>  - blog, status, screenshots
 
-* rbcurse on rubyforge: <http://rbcurse.rubyforge.org/> - Occasionally updated.
+* <http://rdoc.info/github/rkumar/rbcurse/master> - rdoc
 
-* See changes on (not updated often)
- <http://github.com/rkumar/rbcurse/tree/master/CHANGELOG>
 
 * Many working demos in examples folder, such as:
 
-   * test2.rb (exit with F1, Or Cancel button/Alt-C) contains various
-    widgets. F2 for menubar toggling
+   * test2.rb - original test program containing various widgets, menu bar and tabbed pane
 
    * rfe.rb is a ruby file explorer demo.
 
-   * sqlm.rb is a ruby sql client _demo_ (using testd.db at
+   * sqlt.rb is a ruby sql client _demo_ (using testd.db at
      <http://www.benegal.org/files/screen/testd.db>)
-    (requires gem sqlite3-ruby)
+    (requires gem sqlite3)
     sqlm.rb: uses a multi-container - each query opens a new table in the multicontainer
 
    * alpmenu.rb - an alpine like menu screen that calls the following 2 programs
@@ -81,83 +91,25 @@ test2.rb works - i always give it a quick run after making changes. If using rub
 
    * appdirtree - demo of file browser using Tree on left and list on right.
 
+   * dbdemo.rb - sqlite database query program
 
-* Screenshots on 
-  <http://www.benegal.org/files/screen/?M=D>   (new)
-  and on blog, <http://totalrecall.wordpress.com>   
-  and http://github.com/rkumar/rbcurse/wikis/screenshots (old)
-
-* Todo (for 0.1.2):
- <http://rubyforge.org/pm/task.php?group_id=7775&group_project_id=13812&func=browse>
-
-  See [TODO2.txt](https://github.com/rkumar/rbcurse/blob/master/TODO2.txt) (created and maintained by [todo.rb](https://github.com/rkumar/todorb), also hosted here)
-
-* rbcurse tutorial (WIP - please review and give feedback)
- <http://rbcurse.rubyforge.org/tut0.html>
-
-## DESCRIPTION:
-
-A small but comprehensive widget library written in ruby for creating ncurses
-applications.
-
-## FEATURES
-
-* Field : text/entry fields in pure ruby (not ncurses)
-* scrollable list box (also editable lists with Field, checkbox and combos)
-* Textarea : multi-line editable area 
-* togglebutton, radio and check buttons (with mnemonics)
-* message box
-* menubar - with submenu and CheckBoxMenuItem
-* popup list
-* tabbedpane (multiple forms using tabbed metaphor)
-* combobox
-* labels with mnemonics (hotkeys)
-* Table: multi-column table - with cell selection and editing, horizontal and
-  vertical scrolling
-* Scrollpanes which can contain textviews, textareas, listboxes. (Avoid using).
-* Splitpanes which can contain scrollpanes, textviews/areas, listboxes or splitpanes ... DEPRECATED. Pls use vimplit.
-* MultiContainer = add any number of objects to it (such as tables or text objects) and cycle through them
-  (saves screen estate)
-* MultiTextView - have multiple files open for viewing in one component. Since these are readonly files, one can map a lot of single-keys as in vim for operating and cycling through buffers.
-* Textview - editable option using vim like keys.
-* PromptMenu - A simple interactive menu like the `most` application. Saves on allocating keybindings and memorizing them.
-* multiple key bindings for Procs, block and symbols (as in vim and emacs: `C-x C-f` or `15dd`)
-* Kill-ring concept of emacs for cut-paste operations
-* Unlimited undo and redo in TextArea (needs to be switched on at present on instance basis)
-* Numeric arguments. (vim: 25dd etc. Or in an editable box, emacs's C-u or Alt-1..9)
-* ScrollForm (testscroller.rb) - a form that takes more fields/objects than can be viewed at a go. Meta keys scroll the form.
-* Various others, too
-
-Above may be created using DSL like syntax, or hashes, and modified at
-runtime. Very flexible unlike ncurses forms and fields.
-
-## Current work
-
-* 2011-09-21 : I intend to rewrite the following widgets: tabbedpane, menu, messagebox. These were some of the earliest programs and the code is a mess. I need to work on KEY-RESIZE, too. Catching Ctrl-arrow keys and shift function keys is required.
+## Recent news
 
-Old:
-I've just added vi and emacs key bindings to some classes, multiple object containers such as MultiContainer
-and MultiTextView. Emacs like kill-ring in TextArea and TextView. Tabbedpane can have unlimited tabs, we can scroll the tabs. Bunch of other stuff. Multiple keys can be bound to a Proc or symbol as in emacs and vim (dd or C-x C-f).
-
-
-## Sample programs:
-
-*  test2.rb  most basic widgets (including menus)
-*  sqlm.rb is a ruby sql client demo (using sqlite3-ruby)
-*  rfe : file explorer or Finder like app
-*  testcombo.rb  combos with various insert policies and vertical
-   alignments
-*  testtodo.rb  : a todo app based on a yaml file (now csv)
-*  testmenu.rb  : popup menu with multiple levels
-*  testtabp.rb  tabbed pane
-*  test1.rb  various kinds of messageboxes (input, list, custom)
-   pass 1,2,3,4, or 5 as argument on command line
-   ruby test1.rb 1
-   ruby test1.rb 2
+* 1.4.0: Cleanup, some small new features, deprecated stuff, added StatusLine. 
+         Improvements to 'app'.
+* 1.3.0: ffi-ification of rbcurses with some minor bug-fixes, deprecations
+* 1.2.0: many additions (See CHANGELOG for details)
+  - App class that wraps the environment and makes application development very easy
+  - New controls such as:
+    - vimsplit: allows multiple vertical and horizontal splits in one component
+    - progress bar
+    - Tree control
+    - Divider (can grab and move, so as to visually resize components)
+    - Scrollbar class that can be easily attached to lists, tables etc
+    - Tabular data widgets and data converters
 
-   See screenshots on blog.
+  Please see CHANGELOG for changes.
 
-*  testtpane.rb  - tabbedpane sample with a scrollpane and a textobject. 
 
 ## PROBLEMS, ISSUES
 
@@ -176,236 +128,27 @@ The following are issues with terminals (or with ncurses-ruby in some cases) not
 
 * Some terminals may not show underlines (e.g screen).
 
-* Some terminals (xterm-color) do not process Function keys, avoid declaring F1 etc if
+* Some terminals do not process Function keys, avoid declaring F1 etc if
   unsure of client terminals. I have put in fixes for xterm-color F1 and
   backtab.
 
 * To use ALT/META keys on a Mac OS X, in Terminal preferences, under
   Keyboard, select
   "use Option as Meta key". All hotkeys are automatically, ALT combinations.
+  In Iterm2 also, go to Preferences and select "Esc" for keys.
 
 * Some screens do not display window background color under spaces.
-  This is okay under "screen" and "xterm-color" but not under "xterm". You will notice
+  This is okay under "screen" and "xterm-color" but not under "xterm" and "xterm-256color". You will notice
   this in the message box samples.
 
-I am developing and testing under "screen" under OS X Snow Leopard.
-
-## SYNOPSIS:
-
-See lib/rbcurse/rwidgets.rb.
-For test programs, see test1, test2, testcombo etc in examples folder.
-
-This depends only on "window" provided by ncurses. Does not use forms
-and fields. Minor changes and improvements may have happened to sample
-code below. **See test programs for latest, working code.**
-
-THE following samples are only demonstrative of how widgets are built. See samples in examples folder for initialization of ncurses etc which is necessary before the following code can be run. The following samples may be slightly obsolete.
+I am developing and testing under "screen" (compiled with 256 colors) under OSX Lion, using zsh)
 
-### create a window and a form based on window
-
-      @layout = { :height => 0, :width => 0, :top => 0, :left => 0 } 
-      @win = VER::Window.new(@layout)
-
-      @form = Form.new @win
-
-
-### create a bunch of fields with dependent labels
-
-      r = 1; c = 22;
-      %w[ name age company].each do |w|
-        field = Field.new @form do
-          name   w 
-          row  r 
-          col  c 
-          display_length  30
-          set_buffer "abcd #{w}" 
-          set_label Label.new @form, {'text' => w}
-        end
-        r += 1
-      end
-
-### create a variable (like TkVariable) and tie a label to it.
-
-      $results = Variable.new
-      $results.value = "A variable"
-      var = RubyCurses::Label.new @form, {'text_variable' => $results, "row" => r, "col" => 22}
-        r += 1
-
-### create a list and a list box based on the list.
-
-        mylist = []
-        0.upto(100) { |v| mylist << "#{v} scrollable data" }
-
-        field = Listbox.new @form do
-          name   "mylist" 
-          row  r 
-          col  1 
-          width 40
-          height 10
-          list mylist
-        end
-        field.insert 5, "hello ruby", "so long python", "farewell java", "RIP .Net"
-
-### create a textarea for entry 
-
-        texta = TextArea.new @form do
-          name   "mytext" 
-          row  1 
-          col  52 
-          width 40
-          height 20
-        end
-        texta << "hello there" << "Some text to go into textarea."
-        texta << "HELLO ruby" << "Some text to go into textarea."
-
-### create a check box, updates a Variable
-
-      checkbutton = CheckBox.new @form do
-        text_variable $results
-        #value = true
-        onvalue "selected cb"
-        offvalue "UNselected cb"
-        text "Please click me"
-        row 17
-        col 22
-      end
-
-### change field properties at any time by referring to them by name
-
-      @form.by_name["age"].display_length = 3
-      @form.by_name["age"].maxlen = 3
-      @form.by_name["age"].set_buffer  "24"
-      @form.by_name["name"].set_buffer  "Not focusable"
-      @form.by_name["age"].chars_allowed = /\d/
-      @form.by_name["company"].type(:ALPHA)
-      @form.by_name["name"].set_focusable(false)
-
-      @form.by_name["password"].color 'red'
-      @form.by_name["password"].bgcolor 'blue'
-
-      # restrict entry to some values
-      password.values(%w[ scotty tiger secret qwerty])
-
-      # validation using ruby's regular expressions
-
-      field.valid_regex(/^[A-Z]\d+/)
-
-### bind events to forms, and fields
-
-      @form.bind(:ENTER) { |f|   f.label.bgcolor = $promptcolor if f.instance_of? RubyCurses::Field}
-      @form.bind(:LEAVE) { |f|  f.label.bgcolor = $datacolor  if f.instance_of? RubyCurses::Field}
-
-### create buttons
-
-      ok_button = Button.new @form do
-        text "OK"
-        name "OK"
-        row 18
-        col 22
-      end
-      ok_button.command { |form| $results.value = "OK PRESS:";form.printstr(@window, 23,45, "OK CALLED") }
-        #text "Cancel"
-      cancel_button = Button.new @form do
-        text_variable $results
-        row 18
-        col 28
-      end
-      cancel_button.command { |form| form.printstr(@window, 23,45, "Cancel CALLED"); throw(:close); }
-
-### create radio buttons
-
-      colorlabel = Label.new @form, {'text' => "Select a color:", "row" => 20,
-          "col" => 22, "color"=> "cyan"}
-      $radio = Variable.new
-      radio1 = RadioButton.new @form do
-        text_variable $radio
-        text "red"
-        value "red"
-        color "red"
-        row 21
-        col 22
-      end
-      radio2 = RadioButton.new @form do
-        text_variable $radio
-        text  "green"
-        value  "green"
-        color "green"
-        row 22
-        col 22
-      end
-
-### create a messagebox 
-
-      @mb = RubyCurses::MessageBox.new do
-        title "Enter your name"
-        message "Enter your name"
-        type :input
-        default_value "rahul"
-        default_button 0
-      end
-        #title "Color selector"
-        #type :custom
-        #buttons %w[red green blue yellow]
-        #underlines [0,0,0,0]
-      
-     $log.debug "MBOX : #{@mb.selected_index} "
-     $log.debug "MBOX : #{@mb.input_value} "
-
-### create a read-only scrollable view of data
- 
-        @textview = TextView.new @form do
-          name   "myView" 
-          row  16 
-          col  52 
-          width 40
-          height 7
-        end
-        content = File.open("../../README.markdown","r").readlines
-        @textview.set_content content
-
-        ## set it to point to row 21
-        @textview.top_row 21
-
-
-        # lets scroll the text view as we scroll the listbox
-
-        listb.bind(:ENTER_ROW, @textview) { |arow, tview| tview.top_row arow }
-        
-        # lets scroll the text view to the line you enter in the numeric
-        # field
-        @form.by_name["line"].bind(:LEAVE, @textview) { |fld, tv| tv.top_row(fld.getvalue.to_i) }
-
-        # lets scroll the text view to the first match of the regex you
-        # enter
-        @form.by_name["regex"].bind(:LEAVE, @textview) { |fld, tv| tv.top_row(tv.find_first_match(fld.getvalue)) }
-
-        # change the value of colorlabel to the selected radiobutton
-        # (red or green)
-
-        $radio.update_command(colorlabel) {|tv, label|  label.color tv.value}
-
-        # change the attribute of colorlabel to bold or normal
-
-        $results.update_command(colorlabel,checkbutton) {|tv, label, cb| 
-            attrs =  cb.value ? 'bold' : nil; label.attrs(attrs)}
-
-      # during menu creation, create a checkboxmenuitem
-
-      item = RubyCurses::CheckBoxMenuItem.new "CheckMe"
-
-      # when selected, make colorlabel attribute reverse.
-
-      item.command(colorlabel){|it, label| att = it.getvalue ? 'reverse' :
-          nil; label.attrs(att); label.repaint}
 
 ## REQUIREMENTS:
 
 * ruby 1.9.1, 1.9.2 (I believe it is working on 1.8.7, 1.8.6 as well).
 
-* ffi-ncurses (>= 0.4.0)
-
-(Note: 1.8.6 users: pls report any issues and suggest a fix or alternative if you encounter a method_missing)
-
+* ffi-ncurses (>= 0.4.0) Thanks Sean !
 
 ## INSTALL: