libui_paradise 0.3.9 → 0.4.13

data/lib/libui_paradise/libui_classes/msg_box.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/msg_box.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.msg_box
+  #
+  # Official API documentation for dialogs in libui-ng can be found here:
+  #
+  #   https://raw.githubusercontent.com/libui-ng/libui-ng/master/unix/stddialogs.c
+  #
+  # The API signature for msg_box() in LibUI is as follows:
+  #
+  #   GtkWindow *parent
+  #   const char *title
+  #   const char *description
+  #   GtkMessageType type
+  #   GtkButtonsType buttons
+  #
+  # So the first string is the title and the second string is the
+  # description that will be shown to the user.
+  #
+  # The following method is a convenience-wrapper over LibUI.msg_box().
+  #
+  # A Hash can also be passed into this method, to allow for more
+  # flexibility. The following line of code will demonstrate how
+  # this can then be used, via a Hash:
+  #
+  #   message_box(
+  #      text: 'Hello world!'
+  #   )
+  #
+  # Or more verbose:
+  #
+  #   LibuiParadise.message_box(text: 'Hello world!')
+  #
+  # ========================================================================= #
+  def self.msg_box(
+      main_window        = :default_window,
+      title_to_use       = '',
+      description_to_use = ''
+    )
+    # ======================================================================= #
+    # === Handle Hashes first
+    # ======================================================================= #
+    if main_window.is_a? Hash
+      # ===================================================================== #
+      # === :text
+      # ===================================================================== #
+      if main_window.has_key? :text
+        description_to_use = main_window.delete(:text)
+      end
+      # ===================================================================== #
+      # === :title_to_use
+      # ===================================================================== #
+      if main_window.has_key? :title_to_use
+        title_to_use = main_window.delete(:title_to_use)
+      end
+      if main_window and main_window.empty? # Handle empty Hashes as well here.
+        main_window = :default_window
+      end
+    # ======================================================================= #
+    # === Handle Strings next
+    # ======================================================================= #
+    elsif main_window.is_a?(String) and
+          title_to_use.is_a?(String) and
+          title_to_use.empty?
+      title_to_use = main_window.dup
+      main_window = :default_window # And re-set it here.
+    end
+    case main_window
+    # ======================================================================= #
+    # === :default_window
+    #
+    # Note that LibuiParadise.main_window? may be nil.
+    # ======================================================================= #
+    when :default_window,
+         :default
+      main_window = main_window?
+    end
+    if description_to_use.is_a? Array
+      description_to_use = description_to_use.join(' ').strip
+    end
+    # ======================================================================= #
+    # Next delegate towards LibUI.msg_box():
+    # ======================================================================= #
+    _ = ::LibUI.msg_box(
+      main_window,
+      title_to_use,
+      description_to_use
+    )
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_msg_box             msg_box } # === LibuiParadise.ui_msg_box
+       self.instance_eval { alias message_to_the_user    msg_box } # === LibuiParadise.message_to_the_user
+       self.instance_eval { alias message_box            msg_box } # === LibuiParadise.message_box
+       self.instance_eval { alias popup_over_this_widget msg_box } # === LibuiParadise.popup_over_this_widget
+       self.instance_eval { alias popup_message          msg_box } # === LibuiParadise.popup_message
+
+  # ========================================================================= #
+  # === LibuiParadise.notification
+  #
+  # This method can be used to show a quick message box to the end
+  # user.
+  # ========================================================================= #
+  def self.notification(
+      text         = 'Backup complete!',
+      title_to_use = ''
+    )
+    ::LibuiParadise.message_box(
+      window:       :default_window,
+      text:         text,
+      title_to_use: title_to_use
+    )
+  end
+
+end

data/lib/libui_paradise/libui_classes/msg_box_error.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/msg_box_error.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.msg_box_error
+  # ========================================================================= #
+  def self.msg_box_error(
+      main_window  = LibuiParadise.main_window?,
+      title_to_use = '',
+      whatever     = ''
+    )
+    case main_window
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      main_window = LibuiParadise.main_window?
+    end
+    # ======================================================================= #
+    # Delegate towards LibUI.msg_box_error() next:
+    # ======================================================================= #
+    _ = ::LibUI.msg_box_error(
+      main_window,
+      title_to_use,
+      whatever
+    )
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_msg_box_error          msg_box_error } # === LibuiParadise.ui_msg_box_error
+       self.instance_eval { alias ui_error_msg              msg_box_error } # === LibuiParadise.ui_error_msg
+       self.instance_eval { alias ui_error_message          msg_box_error } # === LibuiParadise.ui_error_message
+       self.instance_eval { alias error_message_to_the_user msg_box_error } # === LibuiParadise.error_message_to_the_user
+       self.instance_eval { alias error_msg                 msg_box_error } # === LibuiParadise.error_msg
+       self.instance_eval { alias message_box_error         msg_box_error } # === LibuiParadise.message_box_error
+
+end

data/lib/libui_paradise/libui_classes/slider.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/slider.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  require 'libui_paradise/toplevel_methods/add_to_the_registered_widgets.rb'
+
+  # ========================================================================= #
+  # === LibuiParadise.slider
+  #
+  # This method will return a slider widget.
+  # ========================================================================= #
+  def self.slider(
+      start_value =   0,
+      end_value   = 100
+    )
+    _ = ::LibUI.new_slider(start_value, end_value)
+    # ======================================================================= #
+    # Register it at once:
+    # ======================================================================= #
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_slider slider } # === LibuiParadise.ui_slider
+
+end

data/lib/libui_paradise/libui_classes/spinbox.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/spinbox.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.spinbox
+  #
+  # This method will return a spin-button, also called a spin-box.
+  #
+  # The first argument is the start value; the second argument is the end
+  # value.
+  #
+  # The source code can be found here:
+  #
+  #   https://raw.githubusercontent.com/libui-ng/libui-ng/master/unix/spinbox.c
+  #
+  # ========================================================================= #
+  def self.spinbox(
+      start_point =   0,
+      end_point   = 100,
+      increment   =   1 # This is currently ignored.
+    )
+    if start_point.is_a? Hash
+      # ===================================================================== #
+      # === :end
+      # ===================================================================== #
+      if start_point.has_key? :end
+        end_point = start_point[:end]
+      end
+      # ===================================================================== #
+      # === :start
+      # ===================================================================== #
+      if start_point.has_key? :start
+        start_point = start_point[:start]
+      end
+    end
+    _ = ::LibUI.new_spinbox(start_point.to_i, end_point.to_i)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_spinbox    spinbox } # === LibuiParadise.ui_spinbox
+       self.instance_eval { alias ui_spinbutton spinbox } # === LibuiParadise.ui_spinbutton
+       self.instance_eval { alias spinbutton    spinbox } # === LibuiParadise.spinbutton
+
+end

data/lib/libui_paradise/libui_classes/vbox.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/vbox.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.vbox                                         (vbox tag)
+  #
+  # This method will create a vertical box.
+  # ========================================================================= #
+  def self.vbox(*optional_widgets)
+    _ = ::LibUI.new_vertical_box
+    add_to_the_registered_widgets(_, __method__)
+    if optional_widgets and !optional_widgets.empty?
+      optional_widgets.flatten.each {|this_widget| _ << this_widget }
+    end
+    return _
+  end; self.instance_eval { alias ui_vbox      vbox } # === LibuiParadise.ui_vbox
+       self.instance_eval { alias vertical_box vbox } # === LibuiParadise.vertical_box
+       self.instance_eval { alias create_vbox  vbox } # === LibuiParadise.create_vbox
+       self.instance_eval { alias libui_vbox   vbox } # === LibuiParadise.libui_vbox
+
+  # ========================================================================= #
+  # === LibuiParadise.ui_padded_vbox
+  #
+  # This method will call .is_padded on the vbox after it has been
+  # initialized.
+  # ========================================================================= #
+  def self.ui_padded_vbox(*optional_widgets)
+    _ = ::LibuiParadise.vbox(optional_widgets)
+    _.is_padded
+    return _
+  end; self.instance_eval { alias padded_vbox ui_padded_vbox } # === LibuiParadise.padded_vbox
+
+end

data/lib/libui_paradise/project/project.rb

@@ -28,5 +28,6 @@ module LibuiParadise
 end
 
 if __FILE__ == $PROGRAM_NAME
-  puts LibuiParadise.project_base_dir?  
+  alias e puts
+  e LibuiParadise.project_base_dir?  
 end

data/lib/libui_paradise/prototype/prototype.rb

@@ -4,16 +4,15 @@
 # =========================================================================== #
 # === LibuiParadise::GUI::LibUI::Prototype
 # =========================================================================== #
+require 'libui_paradise/base/base.rb'
+
 module LibuiParadise
 
 module GUI
 
 module LibUI
 
-class Prototype # === LibuiParadise::GUI::LibUI::Prototype
-
-  require 'libui_paradise/extensions/extensions.rb'
-  include LibuiParadise::Extensions
+class Prototype < LibuiParadise::Base # === LibuiParadise::GUI::LibUI::Prototype
 
   # require 'bioroebe/gui/shared_code/levensthein_distance/levensthein_distance_module.rb'
   # include Bioroebe::GUI::LevenstheinDistanceModule
@@ -21,7 +20,7 @@ class Prototype # === LibuiParadise::GUI::LibUI::Prototype
   # ========================================================================= #
   # === TITLE
   # ========================================================================= #
-  TITLE = 'A prototype for LibUI'
+  TITLE = 'A prototype GUI for LibUI'
 
   # ========================================================================= #
   # === WIDTH
@@ -47,6 +46,7 @@ class Prototype # === LibuiParadise::GUI::LibUI::Prototype
   # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
+    reset_the_internal_hash
     title_width_height(TITLE, WIDTH, HEIGHT)
   end
 
@@ -57,11 +57,11 @@ class Prototype # === LibuiParadise::GUI::LibUI::Prototype
     # ======================================================================= #
     # === @window
     # ======================================================================= #
-    @window = ui_padded_main_window(title?, width?, height?, 0)
+    @window = padded_main_window(title?, width?, height?, 0)
   end
 
   # ========================================================================= #
-  # === run
+  # === run                                                         (run tag)
   # ========================================================================= #
   def run
     create_skeleton_then_connect_skeleton
@@ -70,7 +70,7 @@ class Prototype # === LibuiParadise::GUI::LibUI::Prototype
     # First add the two buttons on top:
     # ======================================================================= #
     hbox_on_top = padded_hbox
-    button_refresh = ui_button('Refresh')
+    button_refresh = create_button('Refresh')
     button_refresh.on_clicked {
       e 'TODO: Refresh this ... or add any other functionality.'
     }

data/lib/libui_paradise/requires/require_the_libui_classes.rb

@@ -11,8 +11,8 @@ module LibuiParadise
   # ========================================================================= #
   # === LibuiParadise.do_require_the_libui_classes
   #
-  # This method will batch-require all libui-paradise classes under
-  # the libui_classes/ subdirectory.
+  # This method will batch-require all libui-paradise classes residing
+  # under the libui_classes/ subdirectory.
   # ========================================================================= #
   def self.do_require_the_libui_classes
     target = LibuiParadise.project_base_dir?+'libui_classes/*.rb'

data/lib/libui_paradise/requires/require_the_libui_paradise_project.rb

@@ -4,9 +4,11 @@
 # =========================================================================== #
 # require 'libui_paradise/requires/require_the_libui_paradise_project.rb'
 # =========================================================================== #
-require 'libui_paradise/extensions/extensions.rb' # This also pulls in another file, called pointer.rb.
+require 'libui_paradise/base_module/base_module.rb' # This also pulls in another file, called pointer.rb.
 require 'libui_paradise/project/project.rb'
 require 'libui_paradise/requires/require_the_libui_classes.rb'
 require 'libui_paradise/colours/colours.rb'
 
-LibuiParadise.do_require_the_libui_classes
+LibuiParadise.do_require_the_libui_classes
+
+LibuiParadise.init # This is the new default since as of December 2023.

data/lib/libui_paradise/toplevel_methods/add_to_the_registered_widgets.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/toplevel_methods/add_to_the_registered_widgets.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === @hash_fiddle_pointer_widgets
+  # ========================================================================= #
+  @hash_fiddle_pointer_widgets = {}
+
+  # ========================================================================= #
+  # === LibuiParadise.register_this_fiddle_pointer_widget
+  #
+  # This method registers the particular widget in use.
+  #
+  # Every new_* method available via LibUI.new* that creates a new widget
+  # has to be registered via this method here, by calling it.
+  #
+  # That way we have a main Hash that contains lots of Fiddle::Pointers
+  # and we can, at a later time, modify these Fiddle::Pointer or call
+  # toplevel methods with these registered pointers. This will only
+  # work if we have registered these pointers, though, which is why
+  # each method that creates a new libui-widget has to make use of
+  # this method here.
+  #
+  # Since as of November 2022, the main window is also handled by
+  # this method here. The proper way to refer to it is now via
+  # LibuiParadise.main_window?.
+  #
+  # The mandatory entries given to this method must conform to the
+  # following format:
+  #
+  #   object_id -> [:the_fiddle_pointer_widget, :the_type]
+  #
+  # In other words, a key (as an Integer), and an Array as
+  # its primary value.
+  #
+  # The object_id will be determined automatically, so it can
+  # be omitted. It is the value that is simply returned by
+  # calling the .object_id method, so we do not have to do
+  # anything else here.
+  #
+  # The very last argument of the two-member Array should be a
+  # symbol, such as :grid. This is automatically ensured via a
+  # call to __method__ which will return a Symbol. That way we
+  # can then call the correct method internally, once we know
+  # we have a :grid or any other widget.
+  # ========================================================================= #
+  def self.register_this_fiddle_pointer_widget(
+      the_fiddle_pointer_widget,
+      the_type_of_the_widget = nil # such as :grid or :entry
+    )
+    # ======================================================================= #
+    # Determine the object-id automatically next:
+    # ======================================================================= #
+    object_id_to_use = the_fiddle_pointer_widget.object_id
+    # ======================================================================= #
+    # Then, store it on the main Hash.
+    # ======================================================================= #
+    @hash_fiddle_pointer_widgets[object_id_to_use] =
+      [
+        the_fiddle_pointer_widget,
+        the_type_of_the_widget
+      ]
+  end; self.instance_eval { alias add_to_the_registered_widgets register_this_fiddle_pointer_widget } # === LibuiParadise::Extensions.add_to_the_registered_widgets
+
+end

data/lib/libui_paradise/toplevel_methods/hash_fiddle_pointer_widgets.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/toplevel_methods/hash_fiddle_pointer_widgets.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === @hash_fiddle_pointer_widgets
+  #
+  # This hash will contain all widgets, via pointer.
+  # ========================================================================= #
+  @hash_fiddle_pointer_widgets = {}
+
+  # ========================================================================= #
+  # === LibuiParadise.hash_fiddle_pointer_widgets?
+  # ========================================================================= # 
+  def self.hash_fiddle_pointer_widgets?
+    @hash_fiddle_pointer_widgets
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise.current_widget_pointer?
+  #
+  # This method will always point to the last widget element that was
+  # added.
+  # ========================================================================= #
+  def self.current_widget_pointer?
+    hash_fiddle_pointer_widgets?.values.last.first
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+end

data/lib/libui_paradise/{extensions → toplevel_methods}/toplevel_counters.rb

@@ -2,7 +2,7 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'libui_paradise/extensions/toplevel_counters.rb'
+# require 'libui_paradise/toplevel_methods/toplevel_counters.rb'
 # =========================================================================== #
 module LibuiParadise
 
@@ -16,6 +16,16 @@ module LibuiParadise
   # ========================================================================= #
   @counter_left = 0
 
+  # ========================================================================= #
+  # === LibuiParadise.reset_the_counters
+  #
+  # This method can be used to reset the two counters defined above.
+  # ========================================================================= #
+  def self.reset_the_counters
+    @counter_top  = 0
+    @counter_left = 0
+  end; self.instance_eval { alias reset_the_grid_counter reset_the_counters } # === LibuiParadise.reset_the_grid_counter
+
   # ========================================================================= #
   # === LibuiParadise.counter_left?
   # ========================================================================= #
@@ -25,6 +35,13 @@ module LibuiParadise
        self.instance_eval { alias left_counter  counter_left? } # === LibuiParadise.left_counter
        self.instance_eval { alias left_counter? counter_left? } # === LibuiParadise.left_counter?
 
+  # ========================================================================= #
+  # === LibuiParadise.increment_counter_left
+  # ========================================================================= #
+  def self.increment_counter_left
+    @counter_left += 1
+  end; self.instance_eval { alias increment_the_left_counter increment_counter_left } # === LibuiParadise.increment_the_left_counter
+
   # ========================================================================= #
   # === LibuiParadise.counter_left=
   # ========================================================================= #
@@ -55,4 +72,12 @@ module LibuiParadise
     return [@counter_left, @counter_top]
   end
 
+  # ========================================================================= #
+  # === LibuiParadise.new_row
+  # ========================================================================= #
+  def self.new_row
+    ::LibuiParadise.counter_left = 0 # Reset towards 0, which means "very left".
+    ::LibuiParadise.counter_top += 1 # And we go down to the next row here.
+  end
+
 end