bioroebe 0.12.24 → 0.13.31

data/lib/bioroebe/gui/{shared_code/levensthein_distance/levensthein_distance_module.rb → universal_widgets/levensthein_distance/levensthein_distance.rb}

@@ -2,47 +2,78 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === Bioroebe::GUI::LevenstheinDistanceModule
+# === Bioroebe::GUI::UniversalWidgets::LevenstheinDistance
+#
+# This is just a small widget that bundles together a GUI component
+# towards the Levensthein class.
+#
+# Usage example:
+#
+#   Bioroebe::GUI::UniversalWidgets::LevenstheinDistance.new(ARGV)
+#
 # =========================================================================== #
-# require 'bioroebe/gui/shared_code/levensthein_distance/levensthein_distance_module.rb'
-# include Bioroebe::GUI::LevenstheinDistanceModule
-# Bioroebe::GUI::LevenstheinDistanceModule::TEXT_COMPARE_THE_TWO_SEQUENCES
+# require 'bioroebe/gui/universal_widgets/hamming_distance/hamming_distance.rb'
 # =========================================================================== #
+require 'universal_widgets/base/base.rb'
+
 module Bioroebe
 
 module GUI
 
-module LevenstheinDistanceModule
+module UniversalWidgets
+
+class LevenstheinDistance < ::UniversalWidgets::Base # === Bioroebe::GUI::UniversalWidgets::LevenstheinDistance
 
-  alias e puts
+  require 'bioroebe/base/commandline_application/commandline_arguments.rb'
+  include ::Bioroebe::CommandlineArguments
 
   require 'bioroebe/constants/GUIs.rb'
+  include Bioroebe::GUI
+
   require 'bioroebe/string_matching/levensthein.rb'
+  require 'bioroebe/toplevel_methods/toplevel_methods.rb'
 
   # ========================================================================= #
   # === TITLE
+  #
+  # Specify which title to use for this widget.
   # ========================================================================= #
   TITLE = 'Levensthein Distance'
 
   # ========================================================================= #
   # === WIDTH
   # ========================================================================= #
-  WIDTH = 900
+  WIDTH = '75% or 900px minimum'
 
   # ========================================================================= #
   # === HEIGHT
   # ========================================================================= #
-  HEIGHT = 440
+  HEIGHT = '55% or 440px minimum'
 
   # ========================================================================= #
-  # === USE_THIS_FONT
+  # === FONT_LARGE
   # ========================================================================= #
-  USE_THIS_FONT = :dejavu_condensed_21
+  FONT_LARGE = 'Calibri 32'
 
   # ========================================================================= #
-  # === USE_THIS_MONOFONT
+  # === MONOSPACED_FONT
+  #
+  # When this font is changed, don't forget to also change the font
+  # at SMALLER_FONT.
   # ========================================================================= #
-  USE_THIS_MONOFONT = :hack_16
+  MONOSPACED_FONT = :hack_22
+    USE_THIS_FONT = MONOSPACED_FONT
+    USE_THIS_MONOFONT = MONOSPACED_FONT
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT = :hack_16
+
+  # ========================================================================= #
+  # === USE_THIS_SLIGHTLY_SMALLER_FONT
+  # ========================================================================= #
+  USE_THIS_SLIGHTLY_SMALLER_FONT = :hack_16
 
   # ========================================================================= #
   # === USE_THIS_AS_BACKGROUND_COLOUR_FOR_THE_WIDGET
@@ -64,6 +95,124 @@ module LevenstheinDistanceModule
   # ========================================================================= #
   TEXT_COMPARE_THE_TWO_SEQUENCES = '_Compare the two sequences'
 
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    determine_the_GUI_to_be_used(commandline_arguments)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    reset_the_internal_variables
+    reset_the_base_module # This must come after reset_the_internal_variables().
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    handle_CSS if use_gtk3?
+    instantiate_a_new_levensthein_object
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    12
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    4
+  end
+
+  # ========================================================================= #
+  # === create_the_grid                                            (grid tag)
+  # ========================================================================= #
+  def create_the_grid
+    # ======================================================================= #
+    # === @grid
+    # ======================================================================= #
+    @grid = create_grid
+    @grid.set_column_spacing(4)
+    @grid.set_row_spacing(4)
+  end
+
+  # ========================================================================= #
+  # === populate_the_grid
+  # ========================================================================= #
+  def populate_the_grid
+    @grid.left(@text1)
+    @grid.right(@input_field_for_matches)
+    @grid.left(@text2)
+    @grid.right(@input_field_for_mismatches)
+    @grid.left(@text3)
+    @grid.right(@input_field_for_gap_cost)
+  end
+
+  # ========================================================================= #
+  # === main_font?
+  # ========================================================================= #
+  def main_font?
+    USE_THIS_FONT
+  end
+
+  # ========================================================================= #
+  # === slightly_smaller_font?
+  # ========================================================================= #
+  def slightly_smaller_font?
+    USE_THIS_SLIGHTLY_SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                   (CSS tag, css tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    add_these_custom_CSS_rules '
+'
+    apply_the_CSS_rules
+  end; alias handle_CSS handle_CSS_rules # === handle_CSS
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_entries
+    create_the_labels
+    create_the_grid
+    create_the_first_row
+    create_the_second_row
+    create_the_third_row
+    create_the_buttons
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
   # ========================================================================= #
   # === instantiate_a_new_levensthein_object
   # ========================================================================= #
@@ -124,8 +273,10 @@ module LevenstheinDistanceModule
     # === @button_compare_the_two_strings
     # ======================================================================= #
     @button_compare_the_two_strings = bold_button(
-      TEXT_COMPARE_THE_TWO_SEQUENCES
-    )
+      TEXT_COMPARE_THE_TWO_SEQUENCES, self, :use_mnemonics
+    ) {
+      do_compare_the_two_strings
+    }
     @button_compare_the_two_strings.clear_background
     @button_compare_the_two_strings.set_size_request(200, 40)
     @button_compare_the_two_strings.set_border_width(4)
@@ -137,62 +288,6 @@ module LevenstheinDistanceModule
       'currently does NOT take the second entry into '\
       'consideration.'
     @button_compare_the_two_strings.on_hover(:lightcyan) 
-    @button_compare_the_two_strings.on_clicked {
-      do_compare_the_two_strings
-    }
-  end
-
-  # ========================================================================= #
-  # === return_hbox_containing_the_edit_distance
-  # ========================================================================= #
-  def return_hbox_containing_the_edit_distance(
-      small_label,
-      label_for_the_edit_distance
-    )
-    return hbox(
-      small_label, label_for_the_edit_distance
-    )
-  end
-
-  # ========================================================================= #
-  # === check_for_commandline_arguments
-  # ========================================================================= #
-  def check_for_commandline_arguments
-    if @commandline_arguments and @commandline_arguments.is_a?(Array)
-      unless @commandline_arguments.empty?
-        set_entry1(@commandline_arguments[0])
-        set_entry2(@commandline_arguments[1])
-      end
-    end
-  end; alias parse_the_commandline_arguments check_for_commandline_arguments # === parse_the_commandline_arguments
-
-  # ========================================================================= #
-  # === create_the_entries                           (entries tag, entry tag)
-  # ========================================================================= #
-  def create_the_entries
-    # ======================================================================= #
-    # Next, add the two input-fields for our two nucleotide sequences.
-    # ======================================================================= #
-    # ======================================================================= #
-    # === @input_for_string1
-    # ======================================================================= #
-    @input_for_string1 = input
-    @input_for_string1.light_green_background
-    @input_for_string1.bblack1
-    @input_for_string1.css_class('pad4px')
-    @input_for_string1.on_enter { do_compare_the_two_strings }
-    @input_for_string1.use_this_font = USE_THIS_MONOFONT
-    @input_for_string1.hint = INPUT_HINT
-    # ======================================================================= #
-    # === @input_for_string2
-    # ======================================================================= #
-    @input_for_string2 = input
-    @input_for_string2.light_green_background
-    @input_for_string2.bblack1
-    @input_for_string2.css_class('pad4px')
-    @input_for_string2.on_enter { do_compare_the_two_strings }
-    @input_for_string2.use_this_font = USE_THIS_MONOFONT
-    @input_for_string2.hint = INPUT_HINT
   end
 
   # ========================================================================= #
@@ -225,6 +320,7 @@ module LevenstheinDistanceModule
     # === @text1
     # ======================================================================= #
     @text1 = bold_text_left_aligned('Score for match (match cost): ')
+    @text1.make_selectable
     # ======================================================================= #
     # === @input_field_for_matches
     # ======================================================================= #
@@ -292,7 +388,8 @@ module LevenstheinDistanceModule
   # ========================================================================= #
   def entry1?
     @input_for_string1
-  end
+  end; alias entry1 entry1? # === entry1
+       alias entry? entry1? # === entry?
 
   # ========================================================================= #
   # === entry2?
@@ -307,16 +404,9 @@ module LevenstheinDistanceModule
   def let_the_fist_entry_respond_to_on_changed_events(
       widget_to_use = @input_for_string1
     )
-    if use_gtk?
-      widget_to_use.on_changed {
-        do_compare_the_two_sequences
-      }
-    else # else assume libui
-      # widget_to_use.on_changed {
-      #   do_compare_the_two_sequences
-      # }
-      # Does not work right now.
-    end
+    widget_to_use.on_changed {
+      do_compare_the_two_sequences
+    }
   end
 
   # ========================================================================= #
@@ -327,6 +417,7 @@ module LevenstheinDistanceModule
     # === Score for mismatch
     # ======================================================================= #
     @text2 = bold_text_left_aligned('Score for mismatch (mismatch cost): ')
+    @text2.make_selectable
     # ======================================================================= #
     # === @input_field_for_mismatches
     # ======================================================================= #
@@ -388,17 +479,151 @@ module LevenstheinDistanceModule
   end
 
   # ========================================================================= #
-  # === padding?
+  # === return_hbox_containing_the_edit_distance
   # ========================================================================= #
-  def padding?
-    12
+  def return_hbox_containing_the_edit_distance(
+      small_label,
+      label_for_the_edit_distance
+    )
+    return hbox(
+      small_label, label_for_the_edit_distance
+    )
   end
 
   # ========================================================================= #
-  # === border_size?
+  # === check_for_commandline_arguments
   # ========================================================================= #
-  def border_size?
-    4
+  def check_for_commandline_arguments(
+      commandline_arguments = commandline_arguments?
+    )
+    if commandline_arguments and commandline_arguments.is_a?(Array)
+      unless commandline_arguments.empty?
+        set_entry1(commandline_arguments[0])
+        set_entry2(commandline_arguments[1])
+      end
+    end
+  end; alias parse_the_commandline_arguments check_for_commandline_arguments # === parse_the_commandline_arguments
+
+  # ========================================================================= #
+  # === create_the_entries                           (entries tag, entry tag)
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # Next, add the two input-fields for our two nucleotide sequences.
+    # ======================================================================= #
+    # ======================================================================= #
+    # === @input_for_string1
+    # ======================================================================= #
+    @input_for_string1 = input
+    @input_for_string1.light_green_background
+    @input_for_string1.bblack1
+    @input_for_string1.css_class('pad4px')
+    @input_for_string1.on_enter { do_compare_the_two_strings }
+    @input_for_string1.use_this_font = USE_THIS_MONOFONT
+    @input_for_string1.hint = INPUT_HINT
+    # ======================================================================= #
+    # === @input_for_string2
+    # ======================================================================= #
+    @input_for_string2 = input
+    @input_for_string2.light_green_background
+    @input_for_string2.bblack1
+    @input_for_string2.css_class('pad4px')
+    @input_for_string2.on_enter { do_compare_the_two_strings }
+    @input_for_string2.use_this_font = USE_THIS_MONOFONT
+    @input_for_string2.hint = INPUT_HINT
   end
 
-end; end; end
+  # ========================================================================= #
+  # === connect_the_skeleton                      (connect tag, skeleton tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    vbox1 = create_vbox
+    populate_the_grid
+    vbox1.minimal(@grid, 4)
+    if levensthein_object?.sequence1?
+      unless levensthein_object?.sequence1?.empty?
+        @input_for_string1.set_text(levensthein_object?.sequence1?)
+      end
+    end
+    if levensthein_object?.sequence2?
+      unless levensthein_object?.sequence2?.empty?
+        @input_for_string2.set_text(levensthein_object?.sequence2?)
+      end
+    end
+    vbox1.minimal(@input_for_string1, 4)
+    vbox1.minimal(@input_for_string2, 4)
+    # ======================================================================= #
+    # Next below these two input-fields we will add more info:
+    # ======================================================================= #
+    small_label = return_the_edit_distance_label
+    @hbox_with_the_label_for_the_edit_distance = return_hbox_containing_the_edit_distance(
+      small_label, @label_for_the_edit_distance
+    )
+    @hbox4 = return_hbox4(
+      @label_for_the_total_score
+    )
+    vbox1.minimal(@hbox_with_the_label_for_the_edit_distance, 4)
+    vbox1.minimal(@hbox4, 4)
+    button_box = create_button_box(
+      @button_compare_the_two_strings
+    ) { :spread }
+    vbox1.minimal(button_box, 4)
+
+    window = runner_widget(nil, width?, height?, title?)
+    window << vbox1
+    
+    check_for_commandline_arguments
+    do_compare_the_two_sequences
+    let_the_fist_entry_respond_to_on_changed_events
+
+    ::UniversalWidgets.set_main_window(window)
+    jump_into_the_first_entry
+    upon_delete_event_quit_the_application
+    window.use_this_font = font?
+    window.show_all
+    window.set_size_request(width?, height?)
+    window.set_default_size(width?, height?)
+    window.set_padding(padding?)
+    window.set_border_size(border_size?)
+    window.modify_background(
+      :normal, USE_THIS_AS_BACKGROUND_COLOUR_FOR_THE_WIDGET
+    )
+    window.top_left
+    run_main
+  end
+
+  # ========================================================================= #
+  # === jump_into_the_first_entry
+  # ========================================================================= #
+  def jump_into_the_first_entry
+    entry1?.do_focus
+  end
+
+  # ========================================================================= #
+  # === Bioroebe::GUI::UniversalWidgets::LevenstheinDistance[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === Bioroebe::GUI::Gtk::LevenstheinDistance.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    r = ::Gtk.runner_factory(
+      ::Bioroebe::GUI::Gtk::LevenstheinDistance.new(i)
+    )
+    r.modify_background(:normal, :mintcream)
+    return r
+  end; self.instance_eval { alias run_gtk3_widget       run } # === Bioroebe::GUI::Gtk::LevenstheinDistance.run_gtk3_widget
+       self.instance_eval { alias start_gui_application run } # === Bioroebe::GUI::Gtk::LevenstheinDistance.start_gui_application
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Bioroebe::GUI::UniversalWidgets::LevenstheinDistance.new(ARGV)
+end # gtkproteintodna