rbcurse 0.1.3 → 1.1.1

data/examples/viewtodo.rb

@@ -2,14 +2,16 @@ $LOAD_PATH << "/Users/rahul/work/projects/rbcurse/"
 require 'rubygems'
 require 'ncurses'
 require 'logger'
-#require 'ver/keyboard'
 require 'rbcurse'
 require 'rbcurse/rcombo'
 require 'rbcurse/rtable'
-#require 'rbcurse/table/tablecellrenderer'
 require 'rbcurse/keylabelprinter'
 require 'rbcurse/applicationheader'
 require 'rbcurse/action'
+require 'yaml'   # 1.9 2009-10-05 13:11 
+###############################
+## THIS WONT WORK SINCE I've changed to format of yaml file to array from hash
+##############################
 
 class TodoList
   def initialize file
@@ -379,7 +381,7 @@ class TodoApp
     @window.wrefresh
     Ncurses::Panel.update_panels
     begin
-    while((ch = @window.getchar()) != ?\C-q )
+    while((ch = @window.getchar()) != ?\C-q.getbyte(0) )
       colcount = tcm.column_count-1
       s = keycode_tos ch
       #status_row.text = "Pressed #{ch} , #{s}"

data/lib/rbcurse.rb

@@ -3,5 +3,5 @@ require 'ver/window'
 require 'rbcurse/rwidget'
 require 'rbcurse/rdialogs'
 class Rbcurse
-  VERSION = '0.1.3'
+  VERSION = '1.1.1'
 end

data/lib/rbcurse/celleditor.rb

@@ -11,8 +11,7 @@ require 'logger'
 # so it can display itself. Otherwise it is not added to the forms widget list, so the 
 # form has no idea tha this widget exists.
 #
-# Tested with Field, combo and checkbox
-# TODO test and integrate with tables.
+# Tested with Field, combo and checkbox, tables.
 #
 module RubyCurses
   class CellEditor
@@ -98,6 +97,7 @@ module RubyCurses
       widget.visible = true
       widget.form = parent.form
       #$log.debug " prepare editor value #{widget.display_length} displlen #{widget.maxlen}"
+      $log.debug " prepare editor form: #{widget.form} "
       #widget.display_length = widget.display_length -1
       widget.bgcolor = 'yellow'
       widget.color = 'black'

data/lib/rbcurse/colormap.rb

@@ -91,15 +91,15 @@ include ColorMap
 
       while((ch = @window.getchar()) != KEY_F1 )
         next if ch == -1
-        break if ch == ?q
+        break if ch == ?q.getbyte(0)
         case ch
-        when ?r
+        when ?r.getbyte(0)
           attr |= Ncurses::A_REVERSE
-        when ?b
+        when ?b.getbyte(0)
           attr |= Ncurses::A_BOLD
-        when ?n
+        when ?n.getbyte(0)
           attr = Ncurses::A_NORMAL
-        when ?u
+        when ?u.getbyte(0)
           attr |= Ncurses::A_UNDERLINE
         else
         i = ch.chr.to_i

data/lib/rbcurse/defaultlistselectionmodel.rb

@@ -11,7 +11,7 @@ module RubyCurses
       @selected_indices=[]
       @anchor_selection_index = -1
       @lead_selection_index = -1
-      @selection_mode = :MULTIPLE
+      @selection_mode = 'multiple'
       $log.debug " created DefaultListSelectionModel XXX"
     end
 
@@ -36,8 +36,8 @@ module RubyCurses
     end
     ## TODO should go in sorted, and no dupes
     def add_selection_interval ix0, ix1
-      $log.debug " def add_selection_interval #{ix0}, ix1"
-      if @selection_mode != :MULTIPLE
+      $log.debug " def add_selection_interval #{ix0}, #{ix1}, mode: #{@selection_mode} "
+      if @selection_mode != 'multiple'
         clear_selection
       end
       @anchor_selection_index = ix0

data/lib/rbcurse/io.rb

@@ -0,0 +1,663 @@
+#*******************************************************
+# Some common io routines for getting data or putting
+# at some point
+# Arunachalesha                       
+#  2010-03-06 12:10 
+#  Some are outdated.
+#  Current are:
+#    * rbgetstr (and those it calls)
+#    * display_cmenu and create_mitem
+#*******************************************************#
+module Io
+
+  # from which line to print in footer_win
+  LINEONE = 1
+  FOOTER_COLOR_PAIR = 6
+  MAIN_WINDOW_COLOR_PAIR = 5
+  ERROR_COLOR_PAIR = 7
+                                 
+
+# complex version of get_string that allows for trappng of control character
+# such as C-c and C-h and TAB for completion
+# validints contains int codes not chars.
+  # TODO We should put a field there, make it visible and mv it to after the prompt
+  # and handle all editing events on it.
+  # @return status_code, string (0 if okay, 7 if help asked for, -1 for abort
+  #def rbgetstr(win, r, c, prompt, maxlen, default, labels, validints=[], helptext="")
+  def rbgetstr(win, r, c, prompt, maxlen, config={})
+    #win ||= @target_window
+    $log.debug " inside rbgetstr #{win} r:#{r} c:#{c} p:#{prompt} m:#{maxlen} "
+    raise "rbgetstr got no window. io.rb" if win.nil?
+    ins_mode = false
+    default = config[:default] || ""
+    prompt = "#{prompt} [#{default}]: " unless default
+    len = prompt.length
+
+    # clear the area of len+maxlen
+    color = $datacolor
+    str = default
+    clear_this win, r, c, color, len+maxlen+1
+    print_this(win, prompt+str, color, r, c)
+    len = prompt.length + str.length
+    #x mylabels=["^G~Help  ", "^C~Cancel"]
+    #x mylabels += labels if !labels.nil?
+    begin
+      Ncurses.echo();
+    #x print_key_labels( 0, 0, mylabels)
+    #curpos = 0
+    curpos = str.length
+    prevchar = 0
+    entries = nil
+    #win.mvwgetnstr(LINEONE-3,askstr.length,yn,maxlen)
+    while true
+      #ch=win.mvwgetch(r, len) # get to right of prompt - WHY  NOT WORKING ??? 
+      ch=win.getchar()
+      $log.debug " rbgetstr got ch:#{ch}, str:#{str}. "
+      case ch
+      when 3 # -1 # C-c
+        return -1, nil
+      when 10, 13
+        break
+      when ?\C-h.getbyte(0), ?\C-?.getbyte(0), 127 # delete previous character/backspace
+        len -= 1 if len > prompt.length
+        curpos -= 1 if curpos > 0
+        str.slice!(curpos)
+        clear_this win, r, c, color, len+maxlen+1
+        #print_this(win, prompt+str, color, r, c)
+      when 330 # delete character on cursor
+        #len -= 1 if len > prompt.length
+        #curpos -= 1 if curpos > 0
+        str.slice!(curpos) #rescue next
+        clear_this win, r, c, color, len+maxlen+1
+      when ?\C-g.getbyte(0)
+        #x print_footer_help(helptext)
+        helptext = config[:helptext] || "No help provided"
+        print_help(win, r, c, color, helptext)
+        return 7, nil
+      when KEY_LEFT
+        curpos -= 1 if curpos > 0
+        len -= 1 if len > prompt.length
+        win.wmove r, c+len # since getchar is not going back on del and bs
+        next
+      when KEY_RIGHT
+        if curpos < str.length
+          curpos += 1 #if curpos < str.length
+          len += 1 
+          win.wmove r, c+len # since getchar is not going back on del and bs
+        end
+        next
+      when ?\M-i.getbyte(0) 
+        ins_mode = !ins_mode
+        next
+      when 9 # TAB
+        if config
+          if prevchar == 9
+            if !entries.nil? and !entries.empty?
+              str = entries.delete_at(0)
+            end
+          else
+            tabc = config[:tab_completion] unless tabc
+            next unless tabc
+            entries = tabc.call(str)
+            $log.debug " tab got #{entries} "
+            str = entries.delete_at(0) unless entries.nil? or entries.empty?
+          end
+        end
+      else
+        #if validints.include?ch
+          #print_status("Found in validints")
+          #return ch, nil
+        #else
+          if ch < 0 || ch > 255
+            Ncurses.beep
+            next
+          end
+          # if control char, beep
+          if ch.chr =~ /[[:cntrl:]]/
+            Ncurses.beep
+            next
+          end
+        # we need to trap KEY_LEFT and RIGHT and what of UP for history ?
+        #end
+        #str << ch.chr
+          if ins_mode
+            str[curpos] = ch.chr
+          else
+            str.insert(curpos, ch.chr)
+          end
+          len += 1
+        curpos += 1
+        break if str.length > maxlen
+      end
+      print_this(win, prompt+str, color, r, c)
+      win.wmove r, c+len # more for arrow keys, curpos may not be end
+      prevchar = ch
+    end
+    str = default if str == ""
+    ensure
+      Ncurses.noecho();
+      #x restore_application_key_labels # must be done after using print_key_labels
+    end
+    return 0, str
+  end
+  def clear_this win, r, c, color, len
+    print_this(win, "%-*s" % [len," "], color, r, c)
+  end
+  def print_help(win, r, c, color, helptext)
+    print_this(win, "%-*s" % [helptext.length+2," "], color, r, c)
+    print_this(win, "%s" % helptext, color, r, c)
+    sleep(5)
+  end
+  # @table_width is a constant in caller based on which we decide where to show
+  # key_labels and error messages.
+  # WHEN WE CREATE A PANEL BWLOW we can do away wit that. FIXME XXX
+  # return true for y, false for n
+  #  e.g.
+  #  <code>
+  #  ret =  @main.askyesno(nil, "Are you sure you wish to proceed?")
+  #  </code>
+  #   2008-10-09 18:27 added call to print_footer_help
+  def askyesno(win, askstr, default = "N", helptext="Helptext for this question")
+    win ||= @footer_win
+    askstr = "#{askstr} [#{default}]: "
+    len = askstr.length
+
+    clear_error # 2008-10-13 20:26 
+    print_this(win, askstr, 4, LINEONE, 0)
+    labels=["?~Help  "," ~      ", "N~No    ", "Y~Yes   "]
+    print_key_labels( 0, 0, labels)
+    win.refresh
+    #Ncurses.echo();
+    yn=''
+    #win.mvwgetnstr(Ncurses.LINES-3,askstr.length,yn,maxlen)
+    while true
+      ch=win.mvwgetch(LINEONE,askstr.length)
+      if ch < 0 || ch > 255
+        next
+      end
+      yn = ch.chr
+      yn = default if yn == '' or ch == 10 # KEY_ENTER
+      yn.downcase!
+      break if yn =~/[yn]/
+      if yn == '?'
+        print_footer_help(helptext) 
+        print_key_labels( 0, 0, labels)
+        next
+      end
+      Ncurses.beep
+    end
+    #Ncurses.noecho();
+    clear_error # 2008-11-06 19:27 
+    restore_application_key_labels # must be done after using print_key_labels
+    win.refresh
+    return yn == 'y' 
+  end
+
+  # return y or n or c
+  
+  def askyesnocancel(win, askstr, default = "N")
+    win ||= @footer_win
+    askstr = "#{askstr} [#{default}]: "
+    len = askstr.length
+
+    clear_error # 2008-10-13 20:26 
+    print_this(win, askstr, 4, LINEONE, 0)
+    labels=["N~No    ", "Y~Yes   ","C~Cancel"," ~    "]
+    print_key_labels( 0, 0, labels)
+    win.refresh
+    yn=''
+    #win.mvwgetnstr(LINEONE,askstr.length,yn,maxlen)
+    while true
+      ch=win.mvwgetch(LINEONE,askstr.length)
+      yn = ch.chr
+      yn = default if yn == '' or ch == 10 # KEY_ENTER
+      yn.downcase!
+      break if yn =~/[ync]/
+      Ncurses.beep
+    end
+    restore_application_key_labels # must be done after using print_key_labels
+    return yn
+  end
+
+  # return single digit from given choices
+  # e.g.
+  #  <code>
+  #  labels=["N~No    ", "Y~Yes   ","C~Cancel"," ~      ","S~SurpiseMe","G~GoAway!  "]
+  #  ret =  @main.askchoice(nil, "Are you sure you wish to proceed?","N",labels,"NYCSG")
+  #  @main.clear_error
+  #  </code>
+
+  def askchoice(win, askstr, default, labels, validchars, config={})
+    win ||= @footer_win
+    askstr = "#{askstr} [#{default}]: "
+    len = askstr.length
+    helptext = config.fetch("helptext", "No helptext provided for this action")
+
+    clear_error # 2008-10-13 20:26 
+    print_this(win, askstr, 4, LINEONE, 0)
+    #labels=["N~No    ", "Y~Yes   ","C~Cancel"," ~    "]
+    print_key_labels( 0, 0, labels)
+    yn=''
+    validchars.downcase!
+    #win.mvwgetnstr(LINEONE-3,askstr.length,yn,maxlen)
+    while true
+      ch=win.mvwgetch(LINEONE,askstr.length)
+      yn = ch.chr
+      # 2008-10-31 18:08 
+      if ch == ?\C-g or yn == '?'
+        print_footer_help(helptext)
+        print_key_labels( 0, 0, labels)
+        next
+      end
+      yn = default if yn == '' or ch == 10 # KEY_ENTER
+      yn.downcase!
+      break if validchars.include?yn
+      Ncurses.beep
+    end
+    restore_application_key_labels # must be done after using print_key_labels
+    return yn
+  end
+    def get_string(win, askstr, maxlen=20, default="", labels=nil )
+    win ||= @footer_win
+    askstr = "#{askstr} [#{default}]: "
+    len = askstr.length
+
+    clear_error #  2008-11-06 19:25 
+    print_this(win, askstr, 4, LINEONE, 0)
+    #labels=["N~No    ", "Y~Yes   ","C~Cancel"," ~    "]
+    mylabels = ["^G~Help  ", "^C~Cancel"]
+    mylabels = (mylabels + labels) if !labels.nil?
+
+    print_key_labels( 0, 0, mylabels)
+    Ncurses.echo();
+    yn=''
+    begin
+      Signal.trap("INT"){ return nil }
+      win.mvwgetnstr(LINEONE,askstr.length,yn,maxlen)
+    rescue
+      yn=''
+    ensure
+    Ncurses.noecho();
+    clear_error #  2008-11-02 11:51 
+    restore_application_key_labels # must be done after using print_key_labels
+    end
+    yn = default if yn == "" # 2008-10-31 18:59 
+    return yn
+  end
+
+
+    ##
+    # prints given text to window, in color at x and y coordinates
+    # @param [Window] window to write to
+    # @param [String] text to print
+    # @param [int] color such as $datacolor or $promptcolor
+    # @param [int] x 
+    # @param [int] y 
+    # @see Window#printstring
+    # Consider using Window#printstring
+  def print_this(win, text, color, x, y)
+    if(win == nil)
+      raise "win nil in printthis"
+    end
+    #$log.debug " printthis #{win} , #{text} , #{x} , #{y} "
+    color=Ncurses.COLOR_PAIR(color);
+    win.attron(color);
+    #win.mvprintw(x, y, "%-40s" % text);
+    win.mvprintw(x, y, "%s" % text);
+    win.attroff(color);
+    win.refresh
+  end
+  # prints error in footer_win only
+  def print_error(text)
+    clear_error
+    print_in_middle(@footer_win, LINEONE, 10, 80, text, Ncurses.COLOR_PAIR(ERROR_COLOR_PAIR))
+  end
+  # prints status in footer_win only
+  def print_status(text)
+    text = text[text.length-80..-1] if text.length > 80
+    print_error(text)
+  end
+  # clear previous error, call inside getch loop after each ch.
+  def clear_error
+    print_this(@footer_win, "%-*s" % [Ncurses.COLS," "], 5, LINEONE, 0)
+  end
+  # This is only for the menu program, in which we print current action/menu string in the
+  # key labels below.
+  # Its a dirty hack edpending on:
+  #   * String CurRow present in key labels
+  #   * field_init_proc called this method to set it.
+  def print_action(text)
+    print_this(@footer_win, " %-10s" % ("["+text+"]"), FOOTER_COLOR_PAIR, @action_posy, @action_posx)
+  end
+
+  # the old historical program which prints a string in middle of whereever
+  # thanks to this i was using stdscr which must never be used
+
+  def print_in_middle(win, starty, startx, width, string, color)
+    if(win == nil)
+       raise "window is nil"
+    end
+    x = Array.new
+    y = Array.new
+    Ncurses.getyx(win, y, x);
+    if(startx != 0)
+      x[0] = startx;
+    end
+    if(starty != 0)
+      y[0] = starty;
+    end
+    if(width == 0)
+      width = 80;
+    end
+    length = string.length;
+    temp = (width - length)/ 2;
+    x[0] = startx + temp.floor;
+    win.attron(color);
+    win.mvprintw(y[0], x[0], "%s", string);
+    win.attroff(color);
+    win.refresh();
+  end
+  # splits that bad hack array into even and odd arrays
+  # and prints on last 2 lines
+
+  def print_key_labels(posy, posx, arr)
+      ## paint so-called key bindings from key_labels
+      posx = 0
+      even = []
+      odd = []
+      arr.each_index { |i| 
+        if i % 2 == 0
+          even << arr[i]
+        else
+          odd << arr[i]
+        end
+      }
+      posy = LINEONE+1
+      print_key_labels_row(posy, posx, even)
+      posy = LINEONE+2
+      print_key_labels_row(posy, posx, odd)
+      # 2008-09-29 21:58 
+      @footer_win.wrefresh   # needed else secod row not shown after askchoice XXX
+  end
+    
+  def print_key_labels_row(posy, posx, arr)
+    #clear first
+    my_form_win = @footer_win
+    # first clear the line
+    print_this(my_form_win, "%-*s" % [Ncurses.COLS," "], FOOTER_COLOR_PAIR, posy, 0)
+    padding = 8
+    padding = 4 if arr.length > 5
+    padding = 0 if arr.length > 7
+    arr.each_index { |i| 
+          kl = arr[i].split('~')
+          if kl[0].strip !="" # don't print that white blank space for fillers
+            color_pair=2
+            my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
+            my_form_win.mvprintw(posy, posx, "%s" % kl[0] );
+            my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
+          end
+          color_pair=FOOTER_COLOR_PAIR
+          posx = posx + kl[0].length 
+          my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
+          lab = sprintf(" %s %*s" , kl[1], padding, " ");
+          # hack
+          if kl[1].strip == "CurRow"
+            @action_posx = posx
+            @action_posy = posy
+          end 
+          my_form_win.mvprintw(posy, posx, lab)
+          my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
+          posx = posx +  lab.length
+      }
+  end
+
+  # since it must always be @header_win, we should remove the first param
+  # why should user have any direct access to those 2 windows.
+  def old_print_header(win, htext, posy = 0, posx = 0)
+    win.attron(Ncurses.COLOR_PAIR(6))
+    win.mvprintw(posy, posx, "%-*s" % [Ncurses.COLS, htext] );
+    win.attroff(Ncurses.COLOR_PAIR(6))
+  end
+  def print_header(htext, posy = 0, posx = 0)
+    win = @header_win
+    win.attron(Ncurses.COLOR_PAIR(6))
+    win.mvprintw(posy, posx, "%-*s" % [Ncurses.COLS, htext] );
+    win.attroff(Ncurses.COLOR_PAIR(6))
+  end
+
+  # since it must always be @header_win, we should remove the first param
+  # why should user have any direct access to those 2 windows.
+  def old_print_top_right(win, htext)
+    hlen = htext.length
+    win.attron(Ncurses.COLOR_PAIR(6))
+    win.mvprintw(0, Ncurses.COLS-hlen, htext );
+    win.attroff(Ncurses.COLOR_PAIR(6))
+    #win.refresh
+  end
+  def print_top_right(htext)
+    hlen = htext.length
+    win = @header_win
+    win.attron(Ncurses.COLOR_PAIR(6))
+    win.mvprintw(0, Ncurses.COLS-hlen, htext );
+    win.attroff(Ncurses.COLOR_PAIR(6))
+    #win.refresh
+  end
+  # prints labels defined by user in the DSL. 
+  #
+  # Array of labels with:
+  #
+  #     * position = [y,x] i.e, row, column
+  #     * text = "label text"
+  #     * color_pair = 6 (optional, default 6)
+
+  def print_screen_labels(my_form_win, labelarr)
+    table_width = @table_width || Ncurses.LINES-1
+    return if labelarr.nil?
+      labelarr.each{ |lhash|
+        posy, posx = lhash["position"]
+        posy = table_width + posy if posy < 0
+        posx = Ncurses.COLS + posy if posx < 0
+
+        text = lhash["text"]
+        color_pair = lhash["color_pair"] || 6
+        my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
+        my_form_win.mvprintw(posy, posx, "%-s" % text );
+        my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
+      }
+  end
+
+  @deprecated
+  def print_headers(form_hash)
+    header = form_hash["header"]
+    header_top_left = form_hash["header_top_left"] || ""
+    header_top_center = form_hash["header_top_center"] || ""
+    header_top_right = form_hash["header_top_right"] || ""
+    posy = 0
+    posx = 0
+    htext = "  <APP NAME>  <VERSION>          MAIN MENU"
+
+    posy, posx, htext = header if !header.nil?
+    print_header(htext + " %15s " % header_top_left + " %20s" % header_top_center , posy, posx)
+    print_top_right(header_top_right)
+    @header_win.wrefresh();
+  end
+ 
+
+  #   2008-10-09 18:27 askyesno and ask_string can be passed some text
+  #   to be popped up when a user enters ?
+  @deprecated
+  def print_footer_help(helptext)
+    print_this(@footer_win, "%-*s" % [Ncurses.COLS," "], 6, LINEONE+1, 0)
+    print_this(@footer_win, "%-*s" % [Ncurses.COLS," "], 6, LINEONE+2, 0)
+    print_this(@footer_win, "%s" % helptext, 6, LINEONE+1, 0)
+    sleep(5)
+  end
+  def print_help_page(filename = "TODO")
+    #require 'transactionviewer'
+    #tp = TransactionViewer.new(nil)
+    #tp.run
+    require 'panelreader'
+    tp = PanelReader.new()
+    tp.view_file(filename)
+    
+    #require 'padreader'
+    #tp = PadReader.new()
+    #tp.view_file(filename)
+  end
+  #def newaskyesno(win, askstr, default = "N", helptext="Helptext for this question")
+  ## 
+  # user may pass in actions for each key along with other config values in config hash.
+  # config can contain default, helptext, labels and 'y', 'n'
+  @deprecated
+  def newaskyesno(win, askstr, config = {})
+    win ||= @footer_win
+    default = config.fetch("default", "N")
+    helptext = config.fetch("helptext", "This is helptext for this action")
+    askstr = "#{askstr} [#{default}]: "
+    len = askstr.length
+
+    clear_error # 2008-10-13 20:26 
+    print_this(win, askstr, 4, LINEONE, 0)
+    labels=config.fetch("labels", ["?~Help  "," ~      ", "N~No    ", "Y~Yes   "])
+    print_key_labels( 0, 0, labels)
+    win.refresh
+    yn=''
+    #win.mvwgetnstr(Ncurses.LINES-3,askstr.length,yn,maxlen)
+    while true
+      ch=win.mvwgetch(LINEONE,askstr.length)
+      if ch < 0 || ch > 255
+        next
+      end
+      yn = ch.chr
+      yn = default if yn == '' or ch == 10 # KEY_ENTER
+      yn.downcase!
+      break if yn =~/[yn]/
+      if yn == '?'
+        print_footer_help(helptext) 
+        print_key_labels( 0, 0, labels)
+        next
+      end
+      Ncurses.beep
+    end # while
+
+    begin
+      config[yn].call if config.include? yn 
+    ensure
+      restore_application_key_labels # must be done after using print_key_labels
+      win.refresh
+    end
+
+    return yn == 'y' 
+  end
+
+  #def add_item hotkey, label, desc,action
+  #
+  ## A *simple* way of creating menus that will appear in a single row.
+  # This copies the menu at the bottom of "most" upon pressing ":".
+  # hotkey is the key to invoke an item (a single digit letter)
+  #
+  # label is an action name
+  #
+  # desc is a description displayed after an item is chosen. Usually, its like:
+  #+ "Folding has been enabled" or "Searches will now be case sensitive"
+  #
+  # action may be a Proc or a symbol which will be called if item selected
+  #+ action may be another menu, so recursive menus can be built, but each
+  #+ should fit in a line, its a simple system.
+
+  CMenuItem = Struct.new( :hotkey, :label, :desc, :action )
+
+
+  ## An encapsulated form of yesterday's Most Menu
+  # It keeps the internals away from the user.
+  # Its not really OOP in the sense that the PromptMenu is not a MenuItem. That's how it is in
+  # our Menu system, and that led to a lot of painful coding (at least for me). This is quite
+  # simple. A submenu contains a PromptMenu in its action object and is evaluated in a switch.
+  # A recursive loop handles submenus.
+  #
+  # Prompting of menu options with suboptions etc.
+  # A block of code or symbol or proc is executed for any leaf node
+  # This allows us to define different menus for different objects on the screen, and not have to map 
+  # all kinds of control keys for operations, and have the user remember them. Only one key invokes the menu
+  # and the rest are ordinary characters.
+  class PromptMenu
+    include Io
+    attr_reader :text
+    attr_reader :options
+    def initialize caller,  text="Choose:"
+      @caller = caller
+      @text = text
+      @options = []
+    end
+    def add menuitem
+      @options << menuitem
+    end
+    def create_mitem *args
+      item = CMenuItem.new(*args.flatten)
+    end
+    # Display the top level menu and accept user input
+    # Calls actions or symbols upon selection, or traverses submenus
+    # @return retvalue of last call or send, or 0
+    # @param win window
+    # @param r, c row and col to display on
+    # @param color text color (use $datacolor if in doubt)
+    # @param menu array of CMenuItem structs
+    def display win, r, c, color
+      menu = @options
+      $log.debug " DISP MENU "
+      ret = 0
+      while true
+        str = @text.dup
+        h = {}
+        valid = []
+        menu.each{ |item|
+          str << "(%c) %s " % [ item.hotkey, item.label ]
+          h[item.hotkey] = item
+          valid << item.hotkey
+        }
+        #$log.debug " valid are #{valid} "
+        color = $datacolor
+        print_this(win, str, color, r, c)
+        ch=win.getchar()
+        #$log.debug " got ch #{ch} "
+        next if ch < 0 or ch > 255
+        ch = ch.chr
+        index = valid.index ch
+        if index.nil?
+          clear_this win, r, c, color, str.length
+          print_this(win, "Not valid. Valid are #{valid}", color, r,c)
+          sleep 1
+          next
+        end
+        #$log.debug " index is #{index} "
+        item = h[ch]
+        desc = item.desc
+        #desc ||= "Could not find desc for #{ch} "
+        desc ||= ""
+        clear_this win, r, c, color, str.length
+        print_this(win, desc, color, r,c)
+        action = item.action
+        case action
+          #when Array
+        when PromptMenu
+          # submenu
+          menu = action.options
+          str = "%s: " % action.text 
+        when Proc
+          ret = action.call
+          break
+        when Symbol
+          ret = @caller.send(action)
+          break
+        else 
+          $log.debug " Unidentified flying class #{action.class} "
+          break
+        end
+      end # while
+      return ret # ret val of last send or call
+    end
+  end # class PromptMenu
+
+  ### ADD HERE ###  
+
+end # module