gtk_paradise 0.9.120 → 0.12.25

data/lib/gtk_paradise/widgets/gtk3/editor/editor.rb

@@ -3,6 +3,12 @@
 # frozen_string_literal: true
 # =========================================================================== #
 # === Gtk::Editor
+#
+# This is an editor in ruby-gtk3, which should one day replace my old
+# gtk2-based editor that I am still using (bluefish).
+#
+# The very first ruby-gtk2 editor that I wrote was created on
+# 20.03.2006, based mostly on vim.
 # =========================================================================== #
 # require 'gtk_paradise/widgets/gtk3/editor/editor.rb'
 # Gtk::Editor.run
@@ -13,10 +19,7 @@ require 'gtk_paradise/widgets/gtk3/editor/misc.rb'
 
 module Gtk
 
-class Editor < ::Gtk::Box # === Gtk::Editor
-
-  require 'gtk_paradise/requires/require_the_base_module.rb'
-  include ::Gtk::BaseModule
+class Editor < ::Gtk::BaseModuleBox # === Gtk::Editor
 
   begin
     require 'save_file'
@@ -64,7 +67,7 @@ class Editor < ::Gtk::Box # === Gtk::Editor
   # ========================================================================= #
   def handle_CSS_rules
     use_gtk_paradise_project_css_file
-    more_CSS_then_apply_it '
+    more_CSS '
 #colour_palette_text {
   color: darkblue;
   border-bottom: 1px solid darkgreen;
@@ -135,13 +138,6 @@ notebook {
     }
   end
 
-  # ========================================================================= #
-  # === set_save_into_this_local_file
-  # ========================================================================= #
-  def set_save_into_this_local_file(i)
-    @entry_save_into_this_local_file.set_text(i.to_s)
-  end
-
   # ========================================================================= #
   # === entry_for_insert_this_text?
   #
@@ -194,15 +190,6 @@ notebook {
     text_buffer.insert(iter, entry.text) # Put the content of the gtk-entry into the buffer.
   end
 
-  # ========================================================================= #
-  # === set_buffer
-  #
-  # This method can be used to set the content of the buffer.
-  # ========================================================================= #
-  def set_buffer(i)
-    main_text_buffer?.set_text(i.to_s)
-  end
-
   # ========================================================================= #
   # === set_colour
   # ========================================================================= #
@@ -217,31 +204,6 @@ notebook {
     @notebook.focus_on_this_tab(i.to_i - 1)
   end
 
-  # ========================================================================= #
-  # === create_the_notebook_tab
-  # ========================================================================= #
-  def create_the_notebook_tab
-    @notebook = return_default_notebook
-    respond_to_on_switched_tab_event
-    @notebook.signal_connect_after(:switch_page) { |widget, page, page_number|
-      update_the_label_showing_how_many_lines_are_in_the_current_buffer
-    }
-    # ======================================================================= #
-    # Add 5 tabs next:
-    # ======================================================================= #
-    5.times {
-      # ===================================================================== #
-      # The following is just test-code.
-      # ===================================================================== #
-      n_times = rand(5)+1
-      _ = ''.dup
-      n_times.times {
-        _ << "AHIFOUVEUHIVE\n"
-      }
-      add_a_new_tab(_)
-    }
-  end
-
   # ========================================================================= #
   # === respond_to_on_switched_tab_event
   # ========================================================================= #
@@ -285,36 +247,6 @@ notebook {
     buffer.start_iter
   end
 
-  # ========================================================================= #
-  # === current_textview?
-  # ========================================================================= #
-  def current_textview?
-    this_id = @notebook.get_nth_page(active_notebook_tab?).object_id
-    hash = @hash_all_tab_widgets
-    if hash.has_key? this_id
-      pointer = hash[this_id]
-      return pointer[:text_view]
-    end
-    return nil
-  end; alias textview?      current_textview? # === textview?
-       alias main_textview? current_textview? # === main_textview?
-
-  # ========================================================================= #
-  # === update_the_label_showing_how_many_lines_are_in_the_current_buffer
-  # ========================================================================= #
-  def update_the_label_showing_how_many_lines_are_in_the_current_buffer(
-      use_this_buffer = buffer_content?
-    )
-    if @label_n_lines_in_the_file and use_this_buffer
-      @label_n_lines_in_the_file.set_text(
-        (
-          use_this_buffer.text?.to_s.count("\n") + 1
-        ).to_s+' lines'
-      )
-      @label_n_lines_in_the_file.make_bold
-    end
-  end; alias update_n_lines update_the_label_showing_how_many_lines_are_in_the_current_buffer # === update_n_lines
-
   # ========================================================================= #
   # === do_focus_on_the_first_tab
   # ========================================================================= #
@@ -350,64 +282,6 @@ notebook {
     buffer.get_iter_at(offset: -1)
   end
 
-  # ========================================================================= #
-  # === active_notebook_tab?
-  # ========================================================================= #
-  def active_notebook_tab?
-    @notebook.page
-  end
-
-  # ========================================================================= #
-  # === Gtk::Editor.run
-  # ========================================================================= #
-  def self.run(
-      i = ARGV
-    )
-    require 'gtk_paradise/app/app.rb'
-    _ = ::Gtk::Editor.new(i)
-    r = ::Gtk.run { :add_a_new_accel_group }
-    r << _
-    _.set_parent_widget(r)
-    _.enable_these_key_combinations(HASH_DESIGNATED_KEY_COMBINATIONS)
-    r.automatic_size_then_automatic_title
-    r.on_button_press_event { |widget, event|
-      if ::Gtk.right_mouse_click?(event) # right mouse click event.
-        _.context_menu?.popup_based_on_this_event(event)
-      end
-    }
-    r.add_shortcut(1, 'focus_on_tab(1)', :strg)
-    r.add_shortcut(2, 'focus_on_tab(2)', :strg)
-    r.add_shortcut(3, 'focus_on_tab(3)', :strg)
-    r.add_shortcut(4, 'focus_on_tab(4)', :strg)
-    r.add_shortcut(5, 'focus_on_tab(5)', :strg)
-    r.add_shortcut(6, 'focus_on_tab(6)', :strg)
-    r.add_shortcut(7, 'focus_on_tab(7)', :strg)
-    r.add_shortcut(8, 'focus_on_tab(8)', :strg)
-    r.add_shortcut(9, 'focus_on_tab(9)', :strg)
-    r.maximize # It is simply more convenient that way.
-    r.top_left_then_run
-  end
-
-  # ========================================================================= #
-  # === do_save_the_buffer
-  # ========================================================================= #
-  def do_save_the_buffer(
-      what = main_text_buffer?.text.to_s
-    )
-    into = @entry_save_into_this_local_file.text?
-    # ======================================================================= #
-    # e "Storing into the file `#{sfile(into)}`."
-    # ^^^ This is no longer necessary, as we now store into the status-bar.
-    # ======================================================================= #
-    add_status_message("Saving into: #{into}")
-    SaveFile.write_what_into(what, into)
-    Thread.new {
-      sleep 2 # Sleep for 2 seconds.
-      add_status_message('') # Clear the old message again.
-    }
-  end; alias save_the_buffer       do_save_the_buffer # === save_the_buffer
-       alias do_save_into_the_file do_save_the_buffer # === do_save_into_the_file
-
   # ========================================================================= #
   # === initialize_the_hash_containing_all_buffer_tags
   # ========================================================================= #
@@ -460,15 +334,6 @@ notebook {
     )
   end; alias initialize_the_buffer_tags initialize_the_hash_containing_all_buffer_tags # === initialize_the_buffer_tags
 
-  # ========================================================================= #
-  # === main_text_buffer?
-  # ========================================================================= #
-  def main_text_buffer?
-    of_this_buffer = active_notebook_tab?
-    of_this_buffer = array_containing_the_text_buffers?[of_this_buffer]
-    return of_this_buffer
-  end; alias buffer_content?      main_text_buffer? # === buffer_content?
-
   # ========================================================================= #
   # === update_the_main_buffer
   # ========================================================================= #
@@ -567,7 +432,6 @@ notebook {
     @insert_character = ::Gtk::InsertCharacter.new
     @insert_character.css_classes('mar0px pad0px')
     @insert_character.do_delete_the_selected_text_in_the_buffer
-    @insert_character.append_this_button(' # ') # For a comment.
     this_is_now_the_main_buffer(i)
   end
 
@@ -587,49 +451,248 @@ notebook {
   end
 
   # ========================================================================= #
-  # === do_create_a_new_file_chooser_dialog                        (open tag)
+  # === this_is_now_the_main_buffer
+  # ========================================================================= #
+  def this_is_now_the_main_buffer(i)
+    if i and @insert_character
+      if i.is_a? Numeric
+        i = array_containing_the_text_buffers?[i] 
+      end
+      @insert_character.attach_to_this_buffer(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === is_it_a_ruby_file?
+  # ========================================================================= #
+  def is_it_a_ruby_file?
+    @entry_save_into_this_local_file.text?.end_with? '.rb'
+  end
+
+  # ========================================================================= #
+  # === cooldown_start?
+  # ========================================================================= #
+  def cooldown_start?
+    @cooldown_start
+  end
+
+  # ========================================================================= #
+  # === is_the_cooldown_phase_over?
   #
-  # This method is run when the user wants to open a local file.
+  # When is the cooldown phase over?
+  #
+  #   (1) when it is nil, which is the initial case
+  #   (2) when the current time is less than 0.5 seconds within the old time
+  #
+  # ========================================================================= #
+  def is_the_cooldown_phase_over?
+    _ = cooldown_start?
+    if _ and (Time.now - 0.5) > _
+      _ = nil
+    end
+    return true if _.nil?
+    return false
+  end
+
+  # ========================================================================= #
+  # === start_cooldown_phase
   # ========================================================================= #
-  def do_create_a_new_file_chooser_dialog(
-      i = main_file?.to_s
+  def start_cooldown_phase
+    @cooldown_start = ::Time.now
+  end
+
+  # ========================================================================= #
+  # === do_clear_the_textbuffer_based_on_object_id
+  # ========================================================================= #
+  def do_clear_the_textbuffer_based_on_object_id
+    current_buffer = current_buffer?
+    current_buffer.clear if current_buffer
+  end; alias clear_the_textbuffer do_clear_the_textbuffer_based_on_object_id # === clear_the_textbuffer
+
+  # ========================================================================= #
+  # === insert_this_text_at_the_cursor
+  # ========================================================================= #
+  def insert_this_text_at_the_cursor(
+      this_text
     )
-    create_a_new_file_chooser_dialog(self) {{
-      start_dir:              return_pwd,
-      show_hidden_files:      :yes,
-      current_folder:         ENV['MY_DATA'],
-      additional_directories: [
-                                ENV['PC'],
-                                ENV['MY_TEMP'],
-                                ENV['RSRC'],
-                                '/Depot/j/',
-                                '/Depot/jj/',
-                                '/Depot/jjj/',
-                                '/Depot/jjjj/'
-                              ]
+    current_buffer = current_buffer?
+    current_buffer.insert_at_cursor(this_text.to_s)
+  end; alias insert_this_text_at_the_cursor_position insert_this_text_at_the_cursor # === insert_this_text_at_the_cursor_position
+
+  # ========================================================================= #
+  # === current_buffer?
+  # ========================================================================= #
+  def current_buffer?(
+      this_id = @notebook.get_nth_page(active_notebook_tab?).object_id
+    )
+    hash = @hash_all_tab_widgets
+    if hash.has_key? this_id
+      pointer = hash[this_id]
+      return pointer[:text_buffer]
+    end
+    return nil
+  end; alias main_buffer?         current_buffer? # === main_buffer?
+       alias current_main_buffer? current_buffer? # === current_main_buffer?
+       alias current_text_buffer? current_buffer? # === current_text_buffer?
+
+  # ========================================================================= #
+  # === return_the_colour_palette
+  # ========================================================================= #
+  def return_the_colour_palette
+    # ======================================================================= #
+    # Add the Colour-Palette widget next:
+    # ======================================================================= #
+    colour_palette = ::Gtk::ColourPalette.new(:do_not_run_yet) {{
+      dimension: '3x1' # Specify the dimension to use here, via x-axis x y-axis.
     }}
-    _ = ::Gtk.main_file?.to_s
-    if _ and File.exist?(_) and current_buffer?
-      @entry_save_into_this_local_file.set_text(_) # Also sync it onto the file-path entry.
-      current_buffer?.set_text(
-        File.read(_).to_s
-      )
-      if _.end_with? '.rb'
-        treat_the_buffer_as_a_ruby_file
+    colour_palette.set_parent_widget(self)
+    colour_palette.run
+    frame = gtk_frame('Colour palette')
+    frame.use_this_font = smallest_font?
+    frame.set_name('colour_palette_text')
+    frame.make_bold
+    frame.add(colour_palette)
+    return frame
+  end
+
+  # ========================================================================= #
+  # === set_buffer
+  #
+  # This method can be used to set the content of the buffer.
+  # ========================================================================= #
+  def set_buffer(i)
+    main_text_buffer?.set_text(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === Gtk::Editor.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/app/app.rb'
+    _ = ::Gtk::Editor.new(i)
+    r = ::Gtk.run { :add_a_new_accel_group }
+    r << _
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    _.enable_these_key_combinations(HASH_DESIGNATED_KEY_COMBINATIONS)
+    r.automatic_size_then_automatic_title
+    r.on_button_press_event { |widget, event|
+      if ::Gtk.right_mouse_click?(event) # right mouse click event.
+        _.context_menu?.popup_based_on_this_event(event)
       end
+    }
+    r.add_shortcut(1, 'focus_on_tab(1)', :strg)
+    r.add_shortcut(2, 'focus_on_tab(2)', :strg)
+    r.add_shortcut(3, 'focus_on_tab(3)', :strg)
+    r.add_shortcut(4, 'focus_on_tab(4)', :strg)
+    r.add_shortcut(5, 'focus_on_tab(5)', :strg)
+    r.add_shortcut(6, 'focus_on_tab(6)', :strg)
+    r.add_shortcut(7, 'focus_on_tab(7)', :strg)
+    r.add_shortcut(8, 'focus_on_tab(8)', :strg)
+    r.add_shortcut(9, 'focus_on_tab(9)', :strg)
+    r.maximize # It is simply more convenient that way.
+    r.top_left_then_run
+  end
+
+  # ========================================================================= #
+  # === hash_all_tab_widgets?
+  # ========================================================================= #
+  def hash_all_tab_widgets?
+    @hash_all_tab_widgets
+  end; alias hash? hash_all_tab_widgets? # === hash?
+
+  # ========================================================================= #
+  # === set_save_into_this_local_file
+  # ========================================================================= #
+  def set_save_into_this_local_file(i)
+    @entry_save_into_this_local_file.set_text(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === do_save_the_buffer
+  # ========================================================================= #
+  def do_save_the_buffer(
+      what = main_text_buffer?.text.to_s
+    )
+    into = @entry_save_into_this_local_file.text?
+    # ======================================================================= #
+    # e "Storing into the file `#{sfile(into)}`."
+    # ^^^ This is no longer necessary, as we now store into the status-bar.
+    # ======================================================================= #
+    add_status_message("Saving into: #{into}")
+    SaveFile.write_what_into(what, into)
+    add_a_red_border_around_the_save_file_entry_via_a_delay
+    Thread.new {
+      sleep 2 # Sleep for 2 seconds.
+      add_status_message('') # Clear the old message again.
+    }
+  end; alias save_the_buffer       do_save_the_buffer # === save_the_buffer
+       alias do_save_into_the_file do_save_the_buffer # === do_save_into_the_file
+
+  # ========================================================================= #
+  # === add_a_red_border_around_the_save_file_entry_via_a_delay
+  # ========================================================================= #
+  def add_a_red_border_around_the_save_file_entry_via_a_delay
+    entry = @entry_save_into_this_local_file
+    entry.remove_css_class(:bblack1)
+    entry.add_css_class('border_crimson_3px')
+    Thread.new {
+      sleep 2
+      entry.remove_css_class('border_crimson_3px')
+      entry.add_css_class(:bblack1)
+    }
+  end
+
+  # ========================================================================= #
+  # === create_the_notebook_tab
+  # ========================================================================= #
+  def create_the_notebook_tab
+    @notebook = return_default_notebook
+    respond_to_on_switched_tab_event
+    # ======================================================================= #
+    # React to on-tab-switch events next:
+    # ======================================================================= #
+    @notebook.signal_connect_after(:switch_page) { |widget, page, page_number|
       update_the_label_showing_how_many_lines_are_in_the_current_buffer
-    end
-  end; alias do_open_a_local_file do_create_a_new_file_chooser_dialog # === do_open_a_local_file
+      update_the_entry_save_the_file
+    }
+    # ======================================================================= #
+    # Add 8 tabs by default next:
+    # ======================================================================= #
+    8.times {
+      # ===================================================================== #
+      # The following is just test-code. It was commented out as of
+      # February 2022, but we will keep it for the time being just
+      # in case.
+      # ===================================================================== #
+      # n_times = rand(5)+1
+      # _ = ''.dup
+      # n_times.times {
+      #   _ << "AHIFOUVEUHIVE\n"
+      # }
+      # add_a_new_tab(_)
+      add_a_new_tab
+    }
+  end
 
   # ========================================================================= #
-  # === this_is_now_the_main_buffer
+  # === update_the_entry_save_the_file
   # ========================================================================= #
-  def this_is_now_the_main_buffer(i)
-    if i and @insert_character
-      if i.is_a? Numeric
-        i = array_containing_the_text_buffers?[i] 
-      end
-      @insert_character.attach_to_this_buffer(i)
+  def update_the_entry_save_the_file
+    entry = @entry_save_into_this_local_file
+    hash = @hash_all_tab_widgets
+    this_id = return_current_notebook_tab.object_id
+    # ======================================================================= #
+    # We must obtain the current file path next.
+    # ======================================================================= #
+    file_path = nil
+    if hash.has_key? this_id
+      pointer = hash[this_id]
+      file_path = pointer[:file_path]
+    end
+    if file_path
+      entry.set_text(file_path.to_s)
     end
   end
 
@@ -646,6 +709,9 @@ notebook {
       update_the_label_indicating_the_cursor_position(
         text_buffer.cursor_position? + 1
       )
+      update_the_label_displaying_how_many_lines_are_in_the_given_file(
+        text_buffer.text?.count("\n") + 1
+      )
     }
     # ======================================================================= #
     # Let the buffer respond to certain events next; most importantly
@@ -669,7 +735,7 @@ notebook {
     text_view = gtk_text_view(text_buffer)
     text_view.left_margin = LEFT_MARGIN_TO_USE_FOR_THE_TEXTVIEW_WIDGET
     text_view.pad2px
-    text_view.set_wrap_mode(:word)
+    text_view.set_wrap_mode(:word) # Used to be :word until May 2022.
     # ======================================================================= #
     # Each such scrolled window will carry the main text-buffer in use.
     # ======================================================================= #
@@ -708,7 +774,6 @@ notebook {
       end
       false
     }
-
     title = '#'+(array_containing_the_text_buffers?.size+1).to_s
     # ======================================================================= #
     # Build up our Hash next:
@@ -718,119 +783,37 @@ notebook {
       text_buffer:     text_buffer,
       text_view:       text_view,
       scrolled_window: scrolled_window,
-      title:           title
+      title:           title,
+      file_path:       nil # This has to be filled at a later time.
     }
     return [scrolled_window, title]
   end
 
   # ========================================================================= #
-  # === is_it_a_ruby_file?
-  # ========================================================================= #
-  def is_it_a_ruby_file?
-    @entry_save_into_this_local_file.text?.end_with? '.rb'
-  end
-
-  # ========================================================================= #
-  # === cooldown_start?
-  # ========================================================================= #
-  def cooldown_start?
-    @cooldown_start
-  end
-
-  # ========================================================================= #
-  # === is_the_cooldown_phase_over?
-  #
-  # When is the cooldown phase over?
-  #
-  #   (1) when it is nil, which is the initial case
-  #   (2) when the current time is less than 0.5 seconds within the old time
-  #
-  # ========================================================================= #
-  def is_the_cooldown_phase_over?
-    _ = cooldown_start?
-    if _ and (Time.now - 0.5) > _
-      _ = nil
-    end
-    return true if _.nil?
-    return false
-  end
-
-  # ========================================================================= #
-  # === start_cooldown_phase
-  # ========================================================================= #
-  def start_cooldown_phase
-    @cooldown_start = ::Time.now
-  end
-
-  # ========================================================================= #
-  # === do_clear_the_textbuffer_based_on_object_id
+  # === main_text_buffer?
   # ========================================================================= #
-  def do_clear_the_textbuffer_based_on_object_id
-    current_buffer = current_buffer?
-    current_buffer.clear if current_buffer
-  end; alias clear_the_textbuffer do_clear_the_textbuffer_based_on_object_id # === clear_the_textbuffer
+  def main_text_buffer?
+    of_this_buffer = active_notebook_tab?
+    of_this_buffer = array_containing_the_text_buffers?[of_this_buffer]
+    return of_this_buffer
+  end; alias buffer_content? main_text_buffer? # === buffer_content?
 
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #
   def run
-    create_skeleton_then_connect_skeleton
+    super()
     sync_change_to_use_this_font
     Thread.new {
-      sleep 0.003
+      sleep 0.0015
       do_focus_on_the_first_tab
       initialize_the_hash_containing_all_buffer_tags
+      menu
     }
   end
 
-  # ========================================================================= #
-  # === insert_this_text_at_the_cursor
-  # ========================================================================= #
-  def insert_this_text_at_the_cursor(
-      this_text
-    )
-    current_buffer = current_buffer?
-    current_buffer.insert_at_cursor(this_text.to_s)
-  end; alias insert_this_text_at_the_cursor_position insert_this_text_at_the_cursor # === insert_this_text_at_the_cursor_position
-
-  # ========================================================================= #
-  # === current_buffer?
-  # ========================================================================= #
-  def current_buffer?(
-      this_id = @notebook.get_nth_page(active_notebook_tab?).object_id
-    )
-    hash = @hash_all_tab_widgets
-    if hash.has_key? this_id
-      pointer = hash[this_id]
-      return pointer[:text_buffer]
-    end
-    return nil
-  end; alias main_buffer?         current_buffer? # === main_buffer?
-       alias current_main_buffer? current_buffer? # === current_main_buffer?
-       alias current_text_buffer? current_buffer? # === current_text_buffer?
-
-  # ========================================================================= #
-  # === return_the_colour_palette
-  # ========================================================================= #
-  def return_the_colour_palette
-    # ======================================================================= #
-    # Add the Colour-Palette widget next:
-    # ======================================================================= #
-    colour_palette = ::Gtk::ColourPalette.new(:do_not_run_yet) {{
-      dimension: '3x1' # Specify the dimension to use here, via x-axis x y-axis.
-    }}
-    colour_palette.set_parent_widget(self)
-    colour_palette.run
-    frame = gtk_frame('Colour palette')
-    frame.use_this_font = smallest_font?
-    frame.set_name('colour_palette_text')
-    frame.make_bold
-    frame.add(colour_palette)
-    return frame
-  end
-
 end; end
 
 if __FILE__ == $PROGRAM_NAME
-  Gtk::Editor.run
+  Gtk::Editor.run(ARGV)
 end