rbcurse-core 0.0.0

data/lib/rbcurse/core/include/bordertitle.rb

@@ -0,0 +1,41 @@
+# I am moving the common title and border printing stuff into 
+# a separate module.
+module BorderTitle
+    dsl_accessor :suppress_borders            #to_print_borders
+    dsl_accessor :border_attrib, :border_color
+    dsl_accessor :title                       #set this on top
+    dsl_accessor :title_attrib                #bold, reverse, normal
+    dsl_accessor :border_attrib, :border_color # 
+
+    def bordertitle_init
+      @row_offset = @col_offset = 0 if @suppress_borders 
+      @internal_width = 1 if @suppress_borders
+    end
+    # why the dash does it reduce height by one.
+    def print_borders
+      raise ArgumentError, "Graphic not set" unless @graphic
+      width = @width
+      height = @height-1
+      window = @graphic
+      startcol = @col 
+      startrow = @row 
+      @color_pair = get_color($datacolor)
+      bordercolor = @border_color || @color_pair
+      borderatt = @border_attrib || Ncurses::A_NORMAL
+      window.print_border startrow, startcol, height, width, bordercolor, borderatt
+      print_title
+    end
+    def print_title
+      return unless @title
+      raise "#{self} needs width" unless @width
+      @color_pair ||= get_color($datacolor) # should we not use this ??? XXX 
+      #$log.debug " print_title #{@row}, #{@col}, #{@width}  "
+      # check title.length and truncate if exceeds width
+      _title = @title
+      if @title.length > @width - 2
+        _title = @title[0..@width-2]
+      end
+      @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, @color_pair, @title_attrib) unless @title.nil?
+    end
+
+end

data/lib/rbcurse/core/include/chunk.rb

@@ -0,0 +1,182 @@
+# ------------------------------------------------------------ #
+#         File: chunk.rb 
+#  Description: 
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 07.11.11 - 12:31 
+#  Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: use ,,L
+# ------------------------------------------------------------ #
+#
+
+module Chunks
+  extend self
+  class Chunk
+
+    # color_pair of associated text
+    # text to print
+    # attribute of associated text
+    #attr_accessor :color, :text, :attrib
+    attr_reader :chunk
+
+    def initialize color, text, attrib
+      @chunk = [ color, text, attrib ]
+      #@color = color
+      #@text  = text
+      #@attrib = attrib
+    end
+    def color
+      @chunk[0]
+    end
+    def text
+      @chunk[1]
+    end
+    def attrib
+      @chunk[2]
+    end
+  end
+
+  # consists of an array of chunks and corresponds to a line
+  # to be printed.
+  class ChunkLine
+
+    # an array of chunks
+    attr_reader :chunks
+
+    def initialize arr=nil
+      @chunks = arr.nil? ? Array.new : arr
+    end
+    def <<(chunk)
+      raise ArgumentError, "Chunk object expected. Received #{chunk.class} " unless chunk.is_a? Chunk
+      @chunks << chunk
+    end
+    alias :add :<<
+    def each &block
+      @chunks.each &block
+    end
+
+    # returns length of text in chunks
+    def row_length
+      result = 0
+      @chunks.each { |e| result += e.text.length }
+      return result
+    end
+    alias :length :row_length
+    alias :size   :row_length
+
+    # return a Chunkline containing only the text for the range requested
+    def substring start, size
+    end
+    def to_s
+      result = ""
+      @chunks.each { |e| result << e.text }
+      result
+    end
+  end
+  class ColorParser
+    def initialize cp
+      color_parser cp
+      @color_pair = $datacolor
+      @attrib     = FFI::NCurses::A_NORMAL
+      @color_array = [:white]
+      @bgcolor_array = [:black]
+      @attrib_array = [@attrib]
+      @color_pair_array = [@color_pair]
+      @color = :white
+      @bgcolor = :black
+    end
+    #
+    # Takes a formatted string and converts the parsed parts to chunks.
+    #
+    # @param [String] takes the entire line or string and breaks into an array of chunks
+    # @yield chunk if block
+    # @return [ChunkLine] # [Array] array of chunks
+    # @since 1.4.1   2011-11-3 experimental, can change
+    public
+    def convert_to_chunk s, colorp=$datacolor, att=FFI::NCurses::A_NORMAL
+      #require 'rbcurse/core/include/chunk'
+
+      @color_parser ||= get_default_color_parser()
+      ## defaults
+      color_pair = @color_pair
+      attrib = @attrib
+      #res = []
+      res = ChunkLine.new
+      color = @color
+      bgcolor = @bgcolor
+      # stack the values, so when user issues "/end" we can pop earlier ones
+
+      @color_parser.parse_format(s) do |p|
+        case p
+        when Array
+          ## got color / attrib info, this starts a new span
+
+          #color, bgcolor, attrib = *p
+          lc, lb, la = *p
+          if la
+            @attrib = get_attrib la
+          end
+          if lc || lb
+            @color = lc ? lc : @color_array.last
+            @bgcolor = lb ? lb : @bgcolor_array.last
+            @color_array << @color
+            @bgcolor_array << @bgcolor
+            @color_pair = get_color($datacolor, @color, @bgcolor)
+          end
+          @color_pair_array << @color_pair
+          @attrib_array << @attrib
+          #$log.debug "XXX: CHUNK start #{color_pair} , #{attrib} :: c:#{lc} b:#{lb} "
+          #$log.debug "XXX: CHUNK start arr #{@color_pair_array} :: #{@attrib_array} "
+
+        when :endcolor
+
+          # end the current (last) span
+          @color_pair_array.pop
+          @color_pair = @color_pair_array.last
+          @attrib_array.pop
+          @attrib = @attrib_array.last
+          #$log.debug "XXX: CHUNK end #{color_pair} , #{attrib} "
+          #$log.debug "XXX: CHUNK end arr #{@color_pair_array} :: #{@attrib_array} "
+        when :reset   # ansi has this
+          # end all previous colors
+          @color_pair = $datacolor # @color_pair_array.first
+          @color_pair_array = [@color_pair]
+          @attrib = FFI::NCurses::A_NORMAL #@attrib_array.first
+          @attrib_array = [@attrib]
+          @bgcolor_array = [@bgcolor_array.first]
+          @color_array = [@color_array.first]
+
+        when String
+
+          ## create the chunk
+          $log.debug "XXX:  CHUNK     using on #{p}  : #{@color_pair} , #{@attrib} "
+
+          #chunk =  [color_pair, p, attrib] 
+          chunk = Chunk.new @color_pair, p, @attrib
+          if block_given?
+            yield chunk
+          else
+            res << chunk
+          end
+        end
+      end # parse
+      return res unless block_given?
+    end
+    def get_default_color_parser
+      require 'rbcurse/core/util/colorparser'
+      @color_parser || DefaultColorParser.new
+    end
+    # supply with a color parser, if you supplied formatted text
+    public
+    def color_parser f
+      $log.debug "XXX:  color_parser setting in CP to #{f} "
+      if f == :tmux
+        @color_parser = get_default_color_parser()
+      elsif f == :ansi
+        require 'rbcurse/core/util/ansiparser'
+        @color_parser = AnsiParser.new
+      else
+        @color_parser = f
+      end
+    end
+  end # class
+end

data/lib/rbcurse/core/include/io.rb

@@ -0,0 +1,953 @@
+#*******************************************************
+# 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
+#*******************************************************#
+##
+# added RK 2010-11-02 18:11 so can be used in widgets too
+# maybe can be removed from app, if accessible there too.
+require 'forwardable'
+require 'rbcurse/core/util/bottomline'
+#$terminal = RubyCurses::Bottomline.new
+#$terminal.name = "$terminal io.rb"
+#module Kernel
+  #extend Forwardable
+  #def_delegators :$terminal, :agree, :ask, :choose, :say
+#end
+#$tt.window = @window; $tt.message_row = @message_row # <<-- TODO somewhere
+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
+                                 
+
+def __create_footer_window h = 2 , w = Ncurses.COLS, t = Ncurses.LINES-2, l = 0
+  ewin = VER::Window.new(h, w , t, l)
+end
+# 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.
+  # NOTE: change. C-g was help key in alpine but abort key in emacs. C-c sometimes
+  # crashes app, so i am using C-g as abort. Help on M-h
+  # 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="")
+# 2011-11-27 I have replaced the getting of chars with a field
+# Still need to handle tab-completion, can do that with horizlist !! YEAHHH !!!
+def rbgetstr(nolongerused, r, c, prompt, maxlen, config={})
+  begin
+    win = __create_footer_window
+    form = Form.new win
+    r = 0; c = 1;
+    default = config[:default] || ""
+    displen = config[:display_length] || maxlen
+    prompt = "#{prompt} [#{default}]: " unless default
+    field = Field.new form, :row => r, :col => c, :maxlen => maxlen, :default => default, :label => prompt,
+      :display_length => displen
+    #require 'rbcurse/core/include/rhistory'
+    #field.extend(FieldHistory)
+    #field.history_config :row => FFI::NCurses.LINES-12
+    #field.history %w[ jim john jack ruby jane jill just testing ]
+    form.repaint
+    win.wrefresh
+    prevchar = 0
+    entries = nil
+    while ((ch = win.getchar()) != 999)
+      break if ch == 10 || ch == 13
+      return -1, nil if ch == ?\C-c.getbyte(0) || ch == ?\C-g.getbyte(0)
+      #if ch == ?\M-h.getbyte(0) #                            HELP KEY
+        #helptext = config[:helptext] || "No help provided"
+        #color = $datacolor
+        #print_help(win, r, c, color, helptext)
+        ## this will come over our text
+      #end
+      # TODO tab completion and help_text print on F1
+      # that field objects can extend, same for tab completion and gmail completion
+      if ch == KEY_TAB
+          if config
+            str = field.text
+            if prevchar == 9
+              if !entries.nil? && !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? || entries.empty?
+            end
+            if str
+              field.text = str
+              field.set_form_col # shit why are we doign this, text sets curpos to 0
+            end
+            form.repaint
+            win.wrefresh
+          end
+
+        # tab_completion
+        # if previous char was not tab, execute tab_completion_proc and push first entry
+        # else push the next entry
+      elsif ch == KEY_F1
+        helptext = config[:helptext] || "No help provided. C-c/C-g aborts. <TAB> completion. Alt-h history. C-a/e"
+        print_status_message helptext
+      end
+      prevchar = ch
+      form.handle_key ch
+      win.wrefresh
+    end
+  rescue => err
+    Ncurses.beep
+    $log.error "EXP in rbgetsr #{err} "
+    $log.error(err.backtrace.join("\n")) 
+  ensure
+    win.destroy if win
+  end
+  return 0, field.text
+end
+  def originalrbgetstr(nolongerused, r, c, prompt, maxlen, config={})
+    #win ||= @target_window
+    win = __create_footer_window
+    $log.debug " inside io.rb rbgetstr #{win} r:#{r} c:#{c} p:#{prompt} m:#{maxlen} #{win.name} "
+    r = 0; c = 1;
+    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.noecho(); # FFI RK 2011-09-11 seems this was causing issue of writing on top
+      #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 "io.rb rbgetstr got ch:#{ch}, #{win} , str:#{str}, len: #{len} "
+        case ch
+        when 3 # -1 # C-c
+          return -1, nil
+        when ?\C-g.getbyte(0)                              # ABORT
+          return -1, nil
+        when 10, 13 # hits ENTER
+          break
+        when ?\C-h.getbyte(0), ?\C-?.getbyte(0), KEY_BSPACE, 263 # delete previous character/backspace
+          # currently hitting C-h is giving 263 instead of 8
+          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 ?\M-h.getbyte(0) #                            HELP KEY
+          #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
+          win.wrefresh # FFI 2011-09-19 otherwise not showing
+          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
+            win.wrefresh # FFI 2011-09-19 otherwise not showing
+          end
+          next
+        when ?\C-a.getbyte(0)
+          #olen = str.length
+          #clear_this win, r, c, color, len+maxlen+1
+          #clear_line len+maxlen+1, @prompt_length
+          len -= curpos
+          curpos = 0
+          win.move r, c+len # since getchar is not going back on del and bs
+          win.wrefresh # FFI 2011-09-19 otherwise not showing
+        when ?\C-e.getbyte(0)
+          olen = str.length
+          len += (olen - curpos)
+          curpos = olen
+          #clear_line len+maxlen+1, @prompt_length
+          win.move r, c+len # since getchar is not going back on del and bs
+          win.wrefresh # FFI 2011-09-19 otherwise not showing
+        when ?\M-i.getbyte(0) 
+          ins_mode = !ins_mode
+          next
+        when KEY_TAB # TAB
+          # this is where we can use the horizlist !!! TODO when he tabs !!!
+          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
+        win.wrefresh
+        prevchar = ch
+      end
+      str = default if str == ""
+    ensure
+      Ncurses.noecho();
+      win.destroy # now that we created a window 2011-11-26 
+      #x restore_application_key_labels # must be done after using print_key_labels
+    end
+    return 0, str
+  end
+
+  # This is just experimental, trying out tab_completion
+  # Prompt user for a file name, allowing him to tab to complete filenames
+  # @param [String] label to print before field
+  # @param [Fixnum] max length of field
+  # @return [String] filename or blank if user cancelled
+  def get_file prompt, maxlen=70  #:nodoc:
+    tabc = Proc.new {|str| Dir.glob(str +"*") }
+    config={}; config[:tab_completion] = tabc
+    config[:default] = "test"
+    ret, str = rbgetstr(nil,0,0, prompt, maxlen, config)
+    #$log.debug " get_file returned #{ret} , #{str} "
+    return "" if ret != 0
+    return 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 pair such as $datacolor or $promptcolor
+    # @param [int] x  row
+    # @param [int] y  col
+    # @see Window#printstring
+    # Consider using Window#printstring
+  def print_this(win, text, color, x, y)
+    if !win
+      raise "win nil in print_this"
+    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 'panelreader' obsolete used FORN and fiELD
+    #tp = PanelReader.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
+
+  #
+  # warn user: currently flashes and places error in log file
+  # experimental, may change interface later
+  # it does not say anything on screen
+  # @param [String] text of error/warning to put in log
+  # @since 1.1.5
+  def warn string
+    $log.warn string
+    Ncurses.beep
+  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.
+  # 
+  #  == Example
+  #    menu = PromptMenu.new self do
+  #      item :s, :goto_start
+  #      item :b, :goto_bottom
+  #      item :r, :scroll_backward
+  #      item :l, :scroll_forward
+  #      submenu :m, "submenu" do
+  #        item :p, :goto_last_position
+  #        item :r, :scroll_backward
+  #        item :l, :scroll_forward
+  #      end
+  #    end
+  #    menu.display @form.window, $error_message_row, $error_message_col, $datacolor #, menu
+
+  class PromptMenu
+    include Io
+    attr_reader :text
+    attr_reader :options
+    def initialize caller,  text="Choose:", &block
+      @caller = caller
+      @text = text
+      @options = []
+      instance_eval &block if block_given?
+    end
+    def add *menuitem
+      item = nil
+      case menuitem.first
+      when CMenuItem
+        item = menuitem.first
+        @options << item
+      else
+        case menuitem.size
+        when 4
+          item = CMenuItem.new(*menuitem.flatten)
+        when 2
+          # if user only sends key and symbol
+          menuitem[3] = menuitem[1]
+          item = CMenuItem.new(*menuitem.flatten)
+        end
+        @options << item
+      end
+      return item
+    end
+    alias :item :add
+    def create_mitem *args
+      item = CMenuItem.new(*args.flatten)
+    end
+    # create the whole thing using a MenuTree which has minimal information.
+    # It uses a hotkey and a code only. We are supposed to resolve the display text
+    # and actual proc from the caller using this code.
+    def menu_tree mt, pm = self
+      mt.each_pair { |ch, code| 
+        if code.is_a? RubyCurses::MenuTree
+          item = pm.add(ch, code.value, "") 
+          current = PromptMenu.new @caller, code.value
+          item.action = current
+          menu_tree code, current
+        else
+          item = pm.add(ch, code.to_s, "", code) 
+        end
+      }
+    end
+    # 
+    # To allow a more rubyesque way of defining menus and submenus
+    def submenu key, label, &block
+      item = CMenuItem.new(key, label)
+      @options << item
+      item.action = PromptMenu.new @caller, label, &block
+    end
+    #
+    # Display prompt_menu in columns using commandwindow
+    # This is an improved way of showing the "most" like menu. The earlier
+    # format would only print in one row.
+    #
+    def display_columns config={}
+      prompt = config[:prompt] || "Choose: "
+      require 'rbcurse/core/util/rcommandwindow'
+      layout = { :height => 5, :width => Ncurses.COLS-1, :top => Ncurses.LINES-6, :left => 0 }
+      rc = CommandWindow.new nil, :layout => layout, :box => true, :title => config[:title] || "Menu"
+      w = rc.window
+      r = 4
+      c = 1
+      color = $datacolor
+      begin
+        menu = @options
+        $log.debug " DISP MENU "
+        ret = 0
+        len = 80
+        while true
+          h = {}
+          valid = []
+          labels = []
+          menu.each{ |item|
+            hk = item.hotkey.to_s
+            labels << "%c. %s " % [ hk, item.label ]
+            h[hk] = item
+            valid << hk
+          }
+          #$log.debug " valid are #{valid} "
+          color = $datacolor
+          #print_this(win, str, color, r, c)
+          rc.display_menu labels, :indexing => :custom
+          ch=w.getchar()
+          rc.clear
+          #$log.debug " got ch #{ch} "
+          next if ch < 0 or ch > 255
+          if ch == 3 || ch == ?\C-g.getbyte(0)
+            clear_this w, r, c, color, len
+            print_this(w, "Aborted.", color, r,c)
+            break
+          end
+          ch = ch.chr
+          index = valid.index ch
+          if index.nil?
+            clear_this w, r, c, color, len
+            print_this(w, "Not valid. Valid are #{valid}. C-c/C-g to abort.", 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 w, r, c, color, len
+          print_this(w, desc, color, r,c)
+          action = item.action
+          case action
+            #when Array
+          when PromptMenu
+            # submenu
+            menu = action.options
+            title = rc.title
+            rc.title title +" => " + action.text # set title of window to submenu
+          when Proc
+            ret = action.call
+            break
+          when Symbol
+            if @caller.respond_to?(action, true)
+              $log.debug "XXX:  IO caller responds to action #{action} "
+              ret = @caller.send(action)
+            elsif @caller.respond_to?(:execute_this, true)
+              ret = @caller.send(:execute_this, action)
+            else
+              alert "PromptMenu: unidentified action #{action} for #{@caller.class} "
+              raise "PromptMenu: unidentified action #{action} for #{@caller.class} "
+            end
+
+            break
+          else 
+            $log.debug " Unidentified flying class #{action.class} "
+            break
+          end
+        end # while
+      ensure
+        rc.destroy
+        rc = nil
+      end
+    end
+    alias :display_new :display_columns
+
+    # 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)
+    # @see display_new - it presents in a much better manner
+    # and is not restricted to one row. Avoid this.
+    def display win, r, c, color
+      # FIXME use a oneline window, user should not have to give all this crap.
+      # What about panning if we can;t fit, should we use horiz list to show ?
+      menu = @options
+      $log.debug " DISP MENU "
+      ret = 0
+      while true
+        str = @text.dup
+        h = {}
+        valid = []
+        menu.each{ |item|
+          hk = item.hotkey.to_s
+          str << "(%c) %s " % [ hk, item.label ]
+          h[hk] = item
+          valid << hk
+        }
+        #$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
+        if ch == 3 || ch == ?\C-g.getbyte(0)
+          clear_this win, r, c, color, str.length
+          print_this(win, "Aborted.", color, r,c)
+          break
+        end
+        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