mrdialog 1.0.1 → 1.0.4

data/lib/mrdialog/mrdialog.rb

@@ -39,6 +39,9 @@ class MRDialog
     # All accessors are boolean unless otherwise noted.
     #
 
+	# Specify the rc file to use for dialog.  Default is $HOME/.dialogrc
+    attr_accessor :rc_file
+
     #
     # This gives you some control over the box dimensions when 
     # using auto sizing (specifying 0 for height and width). 
@@ -94,6 +97,9 @@ class MRDialog
     # 
     attr_accessor :shadow
 
+    # MMM
+    attr_accessor :notags
+
     #
     # Sleep (delay) for the given integer of seconds after processing 
     # a dialog box.
@@ -129,9 +135,12 @@ class MRDialog
   attr_accessor :dialog_ok
   attr_accessor :dialog_cancel
   attr_accessor :dialog_help
-  attr_accessor :dialog_extra
   attr_accessor :dialog_item_help
   attr_accessor :dialog_esc
+  attr_accessor :dialog_extra
+
+  # pass dialog's option exactly
+  attr_accessor :dialog_options
 
   #
   # ruby logger
@@ -140,6 +149,27 @@ class MRDialog
   # Override the label used for "OK" buttons
   attr_accessor :ok_label
 
+  # Override the label used for "Cancel" buttons
+  attr_accessor :cancel_label
+
+  # Override the label used for "Yes" buttons
+  attr_accessor :yes_label
+
+  # Override the label used for "No" buttons
+  attr_accessor :no_label
+
+  # Add a "Help" button
+  attr_accessor :help_button
+
+  # Override the label used for the "Help" button
+  attr_accessor :help_label
+
+  # Add an "Extra" button
+  attr_accessor :extra_button
+
+  # Override the label used for the "Extra" button
+  attr_accessor :extra_label
+
   # clear screen
   attr_accessor :clear
 
@@ -166,6 +196,7 @@ class MRDialog
         # muquit@muquit.com mod starts--
         $stdout.sync = true
         $stderr.sync = true
+#        @tags = true
         @dialog_ok = DIALOG_OK
         @dialog_cancel = DIALOG_CANCEL
         @dialog_help = DIALOG_HELP
@@ -411,11 +442,12 @@ class MRDialog
     @exit_code = $?.exitstatus
     log_debug "Exit code: #{exit_code}"
     tag = ''
-    if @exit_code == 0
+    if @exit_code != 1
       tag = tmp.read
     end
-    tmp.close!
     return tag
+  ensure
+    tmp.close!
   end
    
   #
@@ -494,7 +526,7 @@ class MRDialog
     system(cmd)
     @exit_code = $?.exitstatus
     log_debug "Exit code: #{exit_code}"
-    if @exit_code == 0
+    if @exit_code != 1
       lines = tmp.read
       log_debug "lines: #{lines} #{lines.class}"
       sep = Shellwords.escape(@separator)
@@ -504,8 +536,9 @@ class MRDialog
         selected_tags << tag if tag.to_s.length > 0
       end
     end
-    tmp.close!
     return selected_tags
+  ensure
+    tmp.close!
   end
 
   # A  pause  box displays a meter along the bottom of the box.  The
@@ -573,8 +606,9 @@ class MRDialog
     if @exit_code == 0
       result = tmp.read
     end
-    tmp.close!
     return result
+  ensure
+    tmp.close!
   end
 
   #
@@ -662,7 +696,7 @@ class MRDialog
     @exit_code = $?.exitstatus
     log_debug "Exit code: #{exit_code}"
 
-    if @exit_code == 0
+    if @exit_code != 1
       lines = tmp.readlines
       lines.each_with_index do |val, idx|
           key = items[idx][0]
@@ -670,8 +704,9 @@ class MRDialog
       end
     end
 
-    tmp.close!
     return res_hash
+  ensure
+    tmp.close!
   end
 
   #
@@ -722,15 +757,15 @@ class MRDialog
       day.to_i.to_s + " " + month.to_i.to_s + " " + year.to_i.to_s + 
       " 2> " + tmp.path
     success = system(command)
-    if success
+    @exit_code = $?.exitstatus
+    if @exit_code != 1
       date = Date::civil(*tmp.readline.split('/').collect {|i| i.to_i}.reverse)
-      tmp.close!
       return date
     else
-      tmp.close!
       return success
     end  
-    
+  ensure    
+    tmp.close!
   end
 
   # A  checklist  box  is similar to a menu box; there are multiple
@@ -766,10 +801,10 @@ class MRDialog
       tmp.path 
       log_debug "Command:\n#{command}"
     success = system(command)
-  selected_array = []
-    if success
+    @exit_code = $?.exitstatus
+    selected_array = []
+    if @exit_code != 1
       selected_string = tmp.readline
-      tmp.close!
       log_debug "Separator: #{@separator}"
 
       sep = Shellwords.escape(@separator)
@@ -780,10 +815,10 @@ class MRDialog
       end
       return selected_array
     else
-      tmp.close!
       return success
     end
-
+  ensure    
+    tmp.close!
   end
 
   #      The file-selection dialog displays a text-entry window in which
@@ -807,27 +842,28 @@ class MRDialog
   #      value in the text-entry window and exit.
 
   def fselect(path, height=0, width=0)
-                tmp = Tempfile.new('tmp')
+    tmp = Tempfile.new('tmp')
 
-                command = option_string() + "--fselect \"" + path.to_s +
-                "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
+    command = option_string() + "--fselect \"" + path.to_s +
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
+
+    command += "2> " + tmp.path
 
-                command += "2> " + tmp.path
-
-                success = system(command)
-
-                if success
-                        begin
-                                selected_string = tmp.readline
-                        rescue EOFError
-                                selected_string = ""
-                        end
-                        tmp.close!
-                        return selected_string
-                else
-                        tmp.close!
-                        return success
-                end
+    success = system(command)
+    @exit_code = $?.exitstatus
+
+    if @exit_code != 1
+      begin
+        selected_string = tmp.readline
+      rescue EOFError
+        selected_string = ""
+      end
+      return selected_string
+    else
+      return success
+    end
+  ensure
+    tmp.close!
   end
 
 
@@ -845,49 +881,49 @@ class MRDialog
     command = option_string() + "--infobox \"" + text.to_s +
                 "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
     success = system(command)
+    @exit_code = $?.exitstatus
     return success
   end
 
-        #      A  radiolist box is similar to a menu box.  The only difference
-        #      is that you can indicate which entry is currently selected,  by
-        #      setting its status to true.
-
-        def radiolist(text, items, height=0, width=0, listheight=0)
+  #      A  radiolist box is similar to a menu box.  The only difference
+  #      is that you can indicate which entry is currently selected,  by
+  #      setting its status to true.
+  def radiolist(text, items, height=0, width=0, listheight=0)
 
-                tmp = Tempfile.new('tmp')
+    tmp = Tempfile.new('tmp')
 
-                itemlist = String.new
+    itemlist = String.new
 
-                for item in items
-                        if item[2]
-                                item[2] = "on"
-                        else
-                                item[2] = "off"
-                        end
-                        itemlist += "\"" + item[0].to_s + "\" \"" + item[1].to_s +
-                        "\" " + item[2] + " "
+    for item in items
+      if item[2]
+        item[2] = "on"
+      else
+        item[2] = "off"
+      end
+      itemlist += "\"" + item[0].to_s + "\" \"" + item[1].to_s +
+                  "\" " + item[2] + " "
 
-                        if @itemhelp
-                                itemlist += "\"" + item[3].to_s + "\" "
-                        end
-                end
+      if @itemhelp
+        itemlist += "\"" + item[3].to_s + "\" "
+      end
+    end
 
-                command = option_string() + "--radiolist \"" + text.to_s +
-                        "\" " + height.to_i.to_s + " " + width.to_i.to_s +
-                        " " + listheight.to_i.to_s + " " + itemlist + "2> " +
-                        tmp.path
-                log_debug("Command:\n#{command}")
-                success = system(command)
-
-                if success
-                  selected_string = tmp.readline
-                   tmp.close!
-                        return selected_string
-                else
-      tmp.close!
-                        return success
-                end
+    command = option_string() + "--radiolist \"" + text.to_s +
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s +
+              " " + listheight.to_i.to_s + " " + itemlist + "2> " +
+              tmp.path
+    log_debug("Command:\n#{command}")
+    success = system(command)
+    @exit_code = $?.exitstatus
 
+    if @exit_code != 1
+      selected_string = tmp.readline
+      return selected_string
+    else
+      return success
+    end
+  ensure    
+    tmp.close!
   end
 
         #      As  its  name  suggests, a menu box is a dialog box that can be
@@ -905,43 +941,43 @@ class MRDialog
         #      Returns a string containing the tag of the chosen menu entry.
 
   def menu(text="Text Goes Here", items=nil, height=0, width=0, listheight=0)
-                tmp = Tempfile.new('tmp')
+    tmp = Tempfile.new('tmp')
 
-                itemlist = String.new
+    itemlist = String.new
+
+    for item in items
+      itemlist += "\"" + item[0].to_s + "\" \"" + item[1].to_s +  "\" "
+
+      if @itemhelp
+        itemlist += "\"" + item[2].to_s + "\" "
+      end
+    end
 
-                for item in items
-                        itemlist += "\"" + item[0].to_s + "\" \"" + item[1].to_s +  "\" "
+    command = option_string() + "--menu \"" + text.to_s +
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s +
+              " " + listheight.to_i.to_s + " " + itemlist + "2> " +
+              tmp.path
 
-                        if @itemhelp
-                                itemlist += "\"" + item[2].to_s + "\" "
-                        end
-                end
+    log_debug("Command:\n#{command}")
+    success = system(command)
+    @exit_code = $?.exitstatus
 
-                command = option_string() + "--menu \"" + text.to_s +
-                        "\" " + height.to_i.to_s + " " + width.to_i.to_s +
-                        " " + listheight.to_i.to_s + " " + itemlist + "2> " +
-                        tmp.path
-
-                log_debug("Command:\n#{command}")
-                success = system(command)
-
-                if success
-                        selected_string = tmp.readline
-                        tmp.close!
-                        return selected_string
-                else
-                        tmp.close!
-                        return success
-                end
-    
+    if @exit_code != 1
+      selected_string = tmp.readline
+      return selected_string
+    else
+      return success
+    end
+  ensure    
+    tmp.close!
   end
 
-        #      A message box is very similar to a yes/no box.  The  only  dif-
-        #      ference  between  a message box and a yes/no box is that a mes-
-        #      sage box has only a single OK button.  You can use this  dialog
-        #      box  to  display  any message you like.  After reading the mes-
-        #      sage, the user can press the ENTER key so that dialog will exit
-        #      and the calling shell script can continue its operation.
+  #      A message box is very similar to a yes/no box.  The  only  dif-
+  #      ference  between  a message box and a yes/no box is that a mes-
+  #      sage box has only a single OK button.  You can use this  dialog
+  #      box  to  display  any message you like.  After reading the mes-
+  #      sage, the user can press the ENTER key so that dialog will exit
+  #      and the calling shell script can continue its operation.
 
   def msgbox(text="Text Goes Here", height=0, width=0)
     command = option_string() + "--msgbox \"" + text.to_s +
@@ -949,44 +985,46 @@ class MRDialog
 
     log_debug "Command\n#{command}"
     success = system(command)
+    @exit_code = $?.exitstatus
     return success
   end
 
-        #      A password box is similar to an input box, except that the text
-        #      the user enters is not displayed.  This is useful when  prompt-
-        #      ing  for  passwords  or  other sensitive information.  Be aware
-        #      that if anything is passed in "init", it will be visible in the
-        #      system's  process  table  to casual snoopers.  Also, it is very
-        #      confusing to the user to provide them with a  default  password
-        #      they  cannot  see.   For  these reasons, using "init" is highly
-        #      discouraged.
+  #      A password box is similar to an input box, except that the text
+  #      the user enters is not displayed.  This is useful when  prompt-
+  #      ing  for  passwords  or  other sensitive information.  Be aware
+  #      that if anything is passed in "init", it will be visible in the
+  #      system's  process  table  to casual snoopers.  Also, it is very
+  #      confusing to the user to provide them with a  default  password
+  #      they  cannot  see.   For  these reasons, using "init" is highly
+  #      discouraged.
 
   def passwordbox(text="Please enter some text", height=0, width=0, init="")
-      tmp = Tempfile.new('tmp')
-      command = option_string() + "--passwordbox \"" + text.to_s +
-      "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
+    tmp = Tempfile.new('tmp')
+    command = option_string() + "--passwordbox \"" + text.to_s +
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
 
-      unless init.empty?
-              command += init.to_s + " "
-      end
+    unless init.empty?
+      command += init.to_s + " "
+    end
 
-      command += "2> " + tmp.path
-      log_debug(command)
-      success = system(command)
-
-      if success
-              begin
-                      selected_string = tmp.readline
-              rescue EOFError
-                      selected_string = ""
-              end
-              tmp.close!
-              return selected_string
-      else
-              tmp.close!
-              return success
+    command += "2> " + tmp.path
+    log_debug(command)
+    success = system(command)
+    @exit_code = $?.exitstatus
+
+    if @exit_code != 1
+      begin
+        selected_string = tmp.readline
+      rescue EOFError
+        selected_string = ""
       end
-        end
+      return selected_string
+    else
+      return success
+    end
+  ensure
+    tmp.close!
+  end
 
   #     The textbox method handles three similar dialog functions, textbox,
   #     tailbox, and tailboxbg. They are activated by setting type to
@@ -1030,38 +1068,39 @@ class MRDialog
                 "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
     
     success = system(command)
+    @exit_code = $?.exitstatus
 
     return success
   end
 
-    #      A dialog is displayed which allows you to select  hour,  minute
-    #      and second.  If the values for hour, minute or second are miss-
-    #      ing or negative, the current date's  corresponding  values  are
-    #      used.   You  can  increment or decrement any of those using the
-    #      left-, up-, right- and down-arrows.  Use tab or backtab to move
-    #      between windows.
-    #
-    #      On  exit, a Time object is returned.
+  #      A dialog is displayed which allows you to select  hour,  minute
+  #      and second.  If the values for hour, minute or second are miss-
+  #      ing or negative, the current date's  corresponding  values  are
+  #      used.   You  can  increment or decrement any of those using the
+  #      left-, up-, right- and down-arrows.  Use tab or backtab to move
+  #      between windows.
+  #
+  #      On  exit, a Time object is returned.
 
 ##-    def timebox(file, type="text", height=0, width=0, time=Time.now)
-    def timebox(text, height=0, width=0, time=Time.now)
-               tmp = Tempfile.new('tmp')
-
-                command = option_string() + "--timebox \"" + text.to_s +
-                        "\" " + height.to_i.to_s + " " + width.to_i.to_s + " " +
-      time.hour.to_s + " " + time.min.to_s + " " + 
-      time.sec.to_s + " 2> " + tmp.path
-        log_debug("Command:\n#{command}")
-                success = system(command)
-                if success
-                        time = Time.parse(tmp.readline)
-                        tmp.close!
-                        return time
-                else
-                        tmp.close!
-                        return success
-                end
-    
+  def timebox(text, height=0, width=0, time=Time.now)
+              tmp = Tempfile.new('tmp')
+
+    command = option_string() + "--timebox \"" + text.to_s +
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s + " " +
+    time.hour.to_s + " " + time.min.to_s + " " + 
+    time.sec.to_s + " 2> " + tmp.path
+    log_debug("Command:\n#{command}")
+    success = system(command)
+    @exit_code = $?.exitstatus
+    if @exit_code != 1
+      time = Time.parse(tmp.readline)
+      return time
+    else
+      return success
+    end
+  ensure    
+    tmp.close!
   end
 
   #      An input box is useful when you  want  to  ask  questions  that
@@ -1077,7 +1116,7 @@ class MRDialog
     tmp = Tempfile.new('tmp')
 
     command = option_string() + "--inputbox \"" + text.to_s +
-    "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
+              "\" " + height.to_i.to_s + " " + width.to_i.to_s + " "
 
     unless init.empty?
       command += init.to_s + " "
@@ -1086,32 +1125,33 @@ class MRDialog
     command += "2> " + tmp.path
 
     log_debug(command)
-                success = system(command)
+    success = system(command)
+    @exit_code = $?.exitstatus
 
-                if success
+    if @exit_code != 1
       begin
-                          selected_string = tmp.readline
+        selected_string = tmp.readline
       rescue EOFError
         selected_string = ""
       end
-      tmp.close!      
-                        return selected_string
-                else
-                        tmp.close!
-                        return success
-                end
+      return selected_string
+    else
+      return success
+    end
+  ensure
+    tmp.close!
   end
 
-    #      A yes/no dialog box of size height rows by width  columns  will
-    #      be displayed.  The string specified by text is displayed inside
-    #      the dialog box.  If this string is too long to fit in one line,
-    #      it  will be automatically divided into multiple lines at appro-
-    #      priate places.  The text string can also contain the sub-string
-    #      "\n"  or  newline  characters  '\n'  to  control  line breaking
-    #      explicitly.  This dialog box is  useful  for  asking  questions
-    #      that  require  the user to answer either yes or no.  The dialog
-    #      box has a Yes button and a No button, in  which  the  user  can
-    #      switch between by pressing the TAB key.
+  #      A yes/no dialog box of size height rows by width  columns  will
+  #      be displayed.  The string specified by text is displayed inside
+  #      the dialog box.  If this string is too long to fit in one line,
+  #      it  will be automatically divided into multiple lines at appro-
+  #      priate places.  The text string can also contain the sub-string
+  #      "\n"  or  newline  characters  '\n'  to  control  line breaking
+  #      explicitly.  This dialog box is  useful  for  asking  questions
+  #      that  require  the user to answer either yes or no.  The dialog
+  #      box has a Yes button and a No button, in  which  the  user  can
+  #      switch between by pressing the TAB key.
 
   # changing --inputbox to --yesno
   #  muquit@muquit.com Apr-01-2014 
@@ -1137,6 +1177,7 @@ class MRDialog
 
     log_debug("Command:\n#{command}")
     success = system(command)
+    @exit_code = $?.exitstatus
     return success
   end
 
@@ -1159,10 +1200,14 @@ class MRDialog
           end
         end
         raise "'dialog' executable not found in path" unless exe_loc
+
+		# if an rc file was specified, set DIALOGRC to that file
+		ENV["DIALOGRC"] = @rc_file if @rc_file
+
         ostring = exe_loc + " "
 
         if @aspect
-          ostring += "--aspect " + aspect + " "
+          ostring += "--aspect " + @aspect + " "
         end
         
         if @beep
@@ -1189,6 +1234,16 @@ class MRDialog
           end
         end
 
+        unless @notags == nil
+          if @notags == true
+            ostring += "--no-tags "
+          end
+        end
+
+        if @dialog_options
+          ostring += " #{@dialog_options} "
+        end
+
         if @sleep
           ostring += "--sleep " + @sleep.to_s + " "
         end
@@ -1224,6 +1279,34 @@ class MRDialog
             ostring += "--ok-label #{@ok_label} "
         end
 
+        if @cancel_label
+            ostring += "--cancel-label #{@cancel_label} "
+        end
+
+        if @yes_label
+            ostring += "--yes-label #{@yes_label} "
+        end
+
+        if @no_label
+            ostring += "--no-label #{@no_label} "
+        end
+
+        if @extra_button
+            ostring += "--extra-button "
+        end
+
+        if @extra_label
+            ostring += "--extra-label #{@extra_label} "
+        end
+
+        if @help_button
+            ostring += "--help-button "
+        end
+
+        if @help_label
+            ostring += "--help-label #{@help_label} "
+        end
+
         if @separator
             ostring += "--separator \"#{@separator}\" "
         end