gtk_paradise 0.9.120 → 0.11.19

data/lib/gtk_paradise/toplevel_methods/css.rb

@@ -8,26 +8,154 @@
 module Gtk
 
   require 'gtk_paradise/project/project.rb'
-  require 'gtk_paradise/constants/misc.rb'
+  require 'gtk_paradise/constants/constants.rb'
+  # ========================================================================= #
+  # The next line is useful for ruby-gtk3 and ruby-gtk4. It is not so
+  # useful on ruby-gtk2.
+  # ========================================================================= #
+  require 'gtk_paradise/gtk_classes/style_context.rb'
+
+  # ========================================================================= #
+  # === @provider
+  # ========================================================================= #
+  @provider = nil
+
+  # ========================================================================= #
+  # === Gtk.css_provider
+  #
+  # This method is not allowed to have a default dataset.
+  #
+  # Be careful when using this, though, because it will set @provider
+  # globally, which may not always be what you want to have.
+  # ========================================================================= #
+  def self.css_provider(
+      dataset_to_use
+    )
+    # ======================================================================= #
+    # === @provider
+    # ======================================================================= #
+    @provider = ::Gtk::CssProvider.new
+    @provider.load(data: dataset_to_use)
+    # ======================================================================= #
+    # The next method will work for both ruby-gtk3 and ruby-gtk4. It will
+    # not work for ruby-gtk2.
+    # ======================================================================= #
+    style_context_provider(@provider)
+    return @provider # Return it just in case.
+  end; self.instance_eval { alias add_these_css_rules css_provider } # === Gtk.add_these_css_rules
+
+  # ========================================================================= #
+  # === @css_classes
+  #
+  # This variable will keep track of all CSS classes in use. The user
+  # can not modify this Array directly - at the least not via a
+  # guaranteed API.
+  # ========================================================================= #
+  @css_classes = []
+
+  # ========================================================================= #
+  # === @string_additional_css_rules
+  # ========================================================================= #
+  @string_additional_css_rules = ''.dup
+
+  # ========================================================================= #
+  # === Gtk.reset_css_rules
+  #
+  # This method will reset the toplevel-defined CSS rules.
+  # ========================================================================= #
+  def self.reset_css_rules
+    # ======================================================================= #
+    # === @string_additional_css_rules
+    # ======================================================================= #
+    @string_additional_css_rules = ''.dup
+    # ======================================================================= #
+    # === @css_classes
+    # ======================================================================= #
+    @css_classes = [] # The Array will be reset as well.
+  end
+
+  # ========================================================================= #
+  # === Gtk.return_default_CSS_rules
+  #
+  # This method will return all CSS rules that the gtk-paradise gem
+  # uses, as a String.
+  # ========================================================================= #
+  def self.return_default_CSS_rules(
+      i = :project_internal_files
+    )
+    dataset = ''.dup # This is the dataset that will be returned.
+    case i
+    # ======================================================================= #
+    # === :project_internal_files
+    #
+    # All gtk-paradise internal CSS files should be listed here. This
+    # provides the general entry point for CSS files used in the
+    # gtk-paradise gem.
+    # ======================================================================= #
+    when :project_internal_files,
+         :default
+      i = ARRAY_CSS_FILES
+    end
+    # ======================================================================= #
+    # Operate on an Array always.
+    # ======================================================================= #
+    [i].flatten.compact.each {|this_css_file|
+      if File.exist? this_css_file # Must check whether the file exists first.
+        dataset << File.read(this_css_file)
+        dataset << "\n"
+      end
+    }
+    return dataset
+  end; self.instance_eval { alias return_gtk_paradise_css_rules return_default_CSS_rules } # === Gtk.return_gtk_paradise_css_rules
 
   # ========================================================================= #
-  # === @array_css_classes_in_use
+  # === Gtk.append_css
   # ========================================================================= #
-  @array_css_classes_in_use = []
+  def self.append_css(i)
+    case i
+    # ======================================================================= #
+    # === :project_internal_files
+    # ======================================================================= #
+    when :project_internal_files
+      i = ::Gtk.return_default_CSS_rules
+    end
+    if i.is_a? Array
+      i.each {|entry| append_css(entry) }
+    else
+      if i.start_with?('.') or i.start_with?('#')
+        _ = i.dup
+        # =================================================================== #
+        # '.border12 {'
+        # =================================================================== #
+        if _.include? '{'
+          _ = _.split('{').first.strip
+        end
+        this_CSS_class_was_found = _.delete('.#')
+        # =================================================================== #
+        # Only some CSS classes are added.
+        # =================================================================== #
+        @css_classes << this_CSS_class_was_found
+      end
+      @string_additional_css_rules << i
+    end
+  end; self.instance_eval { alias register_this_css_class_is_in_use append_css } # === Gtk.register_this_css_class_is_in_use
+       self.instance_eval { alias add_to_the_toplevel_CSS_string    append_css } # === Gtk.add_to_the_toplevel_CSS_string
+       self.instance_eval { alias append_these_css_rules            append_css } # === Gtk.append_these_css_rules
+       self.instance_eval { alias append_onto_the_CSS_rules         append_css } # === Gtk.append_onto_the_CSS_rules
 
   # ========================================================================= #
   # === Gtk.css_classes_in_use?
   # ========================================================================= #
   def self.css_classes_in_use?
-    @array_css_classes_in_use
+    @css_classes
   end
 
   # ========================================================================= #
-  # === Gtk.register_this_css_class_is_in_use
+  # === Gtk.css_rules?
   # ========================================================================= #
-  def self.register_this_css_class_is_in_use(i)
-    @array_css_classes_in_use << i unless @array_css_classes_in_use.include? i
-  end
+  def self.css_rules?
+    @string_additional_css_rules
+  end; self.instance_eval { alias css_rules_to_apply? css_rules? } # === Gtk.css_rules_to_apply?
 
   # ========================================================================= #
   # === Gtk.initialize_default_css_provider
@@ -57,7 +185,7 @@ module Gtk
     # ======================================================================= #
     [i].flatten.compact.each {|this_css_file|
       dataset << File.read(this_css_file)
-      dataset << "\n"
+      dataset << "\n" # And a newline for visual beauty.
     }
     Gtk.css_provider(dataset)
   end; self.instance_eval { alias project_css_file                  initialize_default_css_provider } # === Gtk.project_css_file
@@ -101,32 +229,6 @@ module Gtk
     "#{PROJECT_BASE_DIRECTORY}css/project.css"
   end
 
-  # ========================================================================= #
-  # === @provider
-  # ========================================================================= #
-  @provider = nil
-
-  # ========================================================================= #
-  # === Gtk.css_provider
-  #
-  # This method is not allowed to have a default dataset.
-  #
-  # Be careful when using this, though, because it will set @provider
-  # globally, which may not always be what you want to have.
-  # ========================================================================= #
-  def self.css_provider(
-      dataset_to_use
-    )
-    @provider = ::Gtk::CssProvider.new
-    @provider.load(data: dataset_to_use)
-    ::Gtk::StyleContext.add_provider_for_screen(
-      Gdk::Screen.default,
-      @provider,
-      ::Gtk::StyleProvider::PRIORITY_APPLICATION
-    )
-    return @provider
-  end; self.instance_eval { alias add_these_css_rules css_provider } # === Gtk.add_these_css_rules
-
   # ========================================================================= #
   # === Gtk.css_provider?
   # ========================================================================= #
@@ -155,6 +257,52 @@ module Gtk
     return _ # Return the result here.
   end
 
+  # ========================================================================= #
+  # === Gtk.load_css_engine_for_gtk4
+  #
+  # This method can be specifically used for ruby-gtk4 support of
+  # CSS. The API changed between ruby-gtk3 and ruby-gtk4, so
+  # this method here was added on an ad-hoc basis.
+  #
+  # Right now this method only supports a String as main input.
+  # The CSS rules should be passed as a String to this method.
+  #
+  # Usage example:
+  #
+  #   Gtk.load_css_engine_for_gtk4(use_these_css_rules)
+  #
+  # ========================================================================= #
+  def self.load_css_engine_for_gtk4(
+      use_these_css_rules = ::Gtk.css_rules?.to_s
+    )
+    css_provider = ::Gtk::CssProvider.new
+    css_provider.load(data: use_these_css_rules)
+    ::Gtk::StyleContext.add_provider_for_display(
+      Gdk::Display.default,
+      css_provider,
+      ::Gtk::StyleProvider::PRIORITY_APPLICATION
+    )
+    return css_provider # Return it here just in case.
+  end
+
+  # ========================================================================= #
+  # === Gtk.turn_this_font_symbol_into_its_corresponding_CSS_rule
+  # ========================================================================= #
+  def self.turn_this_font_symbol_into_its_corresponding_CSS_rule(i)
+    if i.is_a? Symbol
+      string = i.to_s.tr('_',' ')
+      splitted = string.split(' ') # dejavu_condensed_20
+      font_size = splitted.last
+      splitted[0] = splitted[0].capitalize
+      first_part = splitted[0 .. -2].join(' ')
+      return '
+      .use_this_font {
+        font-family: '+first_part+';
+        font-size: '+font_size.to_s+'pt;
+      }'
+    end
+  end
+
 end
 
 if __FILE__ == $PROGRAM_NAME

data/lib/gtk_paradise/toplevel_methods/cursor.rb

@@ -44,7 +44,9 @@ def self.create_cursor(
     dimension = 50
   )
   Gtk::Cursor.create_cursor(
-    main_window, which_xbm_to_use, dimension
+    main_window,
+    which_xbm_to_use,
+    dimension
   )
 end
 
@@ -54,9 +56,16 @@ end
 # Note that this method is experimental - it may be removed at a later
 # moment in time. The idea behind this method is to make it easier
 # to grab a different cursor in ruby-gtk applications.
+#
+# Since as of January 2022 this method will default to ruby-gtk3, which
+# is indicated by the symbol :hand2. The old ruby-gtk2 variant was to
+# use Gdk::Cursor::HAND2, which became Gdk::CursorType::HAND2 in
+# ruby-gtk3 (or the symbol).
 # =========================================================================== #
-def self.hand_cursor
-  Gdk::Cursor.new(Gdk::Cursor::HAND2)
+def self.hand_cursor(
+    use_this_cursor = :hand2 # Or Gdk::Cursor::HAND2 for ruby-gtk2.
+  )
+  Gdk::Cursor.new(use_this_cursor)
 end
 
 # =========================================================================== #
@@ -66,4 +75,9 @@ def self.regular_cursor
   Gdk::Cursor.new(Gdk::Cursor::XTERM)
 end
 
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'gtk3'
+  puts Gtk.hand_cursor.class  
 end

data/lib/gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb

@@ -3,12 +3,93 @@
 # frozen_string_literal: true
 # =========================================================================== #
 # require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
-# Gtk.do_we_use_gtk2?
+# Gtk.set_we_use_this_gtk_version
+# Gtk.we_use_this_gtk_version = :gtk4
+# Gtk.we_use_this_gtk_version = :gtk2
+# Gtk.we_use_this_gtk_version = :gtk3
 # =========================================================================== #
 module Gtk
 
   # ========================================================================= #
-  # === Gtk.is_gtk2_in_use?
+  # === @we_use_this_gtk_version
+  #
+  # This must be initialized to nil, so that we allow the user to change
+  # this value at a later time, as a distinguishing 'feature'.
+  #
+  # This variable must either be a Symbol or nil.
+  # ========================================================================= #
+  @we_use_this_gtk_version = nil
+
+  # ========================================================================= #
+  # === Gtk.we_use_this_gtk_version?
+  #
+  # Query-method about the toplevel variable that keeps track as to which
+  # version is in use.
+  # ========================================================================= #
+  def self.we_use_this_gtk_version?
+    @we_use_this_gtk_version
+  end; self.instance_eval { alias we_use_which_gtk_version? we_use_this_gtk_version? } # === Gtk.we_use_which_gtk_version?
+       self.instance_eval { alias version_in_use?           we_use_this_gtk_version? } # === Gtk.version_in_use?
+
+  # ========================================================================= #
+  # === Gtk.we_use_this_gtk_version=
+  #
+  # The new default since as of April 2019 is to require gtk3.
+  #
+  # Usage examples:
+  #
+  #   Gtk.we_use_this_gtk_version = :gtk2
+  #   Gtk.we_use_this_gtk_version = :gtk3
+  #   Gtk.we_use_this_gtk_version = :gtk4
+  #
+  # ========================================================================= #
+  def self.we_use_this_gtk_version=(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      i = DEFAULT_GTK_VERSION_TO_USE
+    end
+    # ======================================================================= #
+    # puts "Debug: We now set the gtk version to: #{i}" # Some debug-line.
+    # ======================================================================= #
+    @we_use_this_gtk_version = i
+  end; self.instance_eval { alias set_we_use_this_gtk_version we_use_this_gtk_version= } # === Gtk.set_we_use_this_gtk_version
+
+  # ========================================================================= #
+  # === Gtk.do_we_use_gtk4?
+  # ========================================================================= #
+  def self.do_we_use_gtk4?
+    @we_use_this_gtk_version == :gtk4
+  end; self.instance_eval { alias are_we_using_gtk4? do_we_use_gtk4? } # === Gtk.are_we_using_gtk4
+       self.instance_eval { alias use_gtk4?          do_we_use_gtk4? } # === Gtk.use_gtk4?
+
+  # ========================================================================= #
+  # === Gtk.use_gtk3?
+  #
+  # Unfortunately MAJOR_VERSION does not exist for ruby-gtk3.
+  # ========================================================================= #
+  def self.use_gtk3?
+    @we_use_this_gtk_version == :gtk3
+  end; self.instance_eval { alias are_we_using_gtk3? use_gtk3? } # === Gtk.are_we_using_gtk3?
+       self.instance_eval { alias is_gtk3_in_use?    use_gtk3? } # === Gtk.is_gtk3_in_use?
+       self.instance_eval { alias is_gtk3?           use_gtk3? } # === Gtk.is_gtk3?
+       self.instance_eval { alias use_gtk3?          use_gtk3? } # === Gtk.use_gtk3?
+       self.instance_eval { alias do_we_use_gtk3?    use_gtk3? } # === Gtk.do_we_use_gtk3?
+
+  # ========================================================================= #
+  # === Gtk.do_we_use_gtk2?
+  # ========================================================================= #
+  def self.do_we_use_gtk2?
+    @we_use_this_gtk_version == :gtk2
+  end; self.instance_eval { alias is_gtk2_in_use?    do_we_use_gtk2? } # === Gtk.is_gtk2_in_use?
+       self.instance_eval { alias are_we_using_gtk2? do_we_use_gtk2? } # === Gtk.are_we_using_gtk2?
+
+  # ========================================================================= #
+  # === Gtk.true_query_whether_gtk2_is_in_use?
   #
   # This method can be used to determine whether gtk2 is in use.
   #
@@ -17,17 +98,18 @@ module Gtk
   #   Gtk.check_version(2, 6, 0)
   #
   # ========================================================================= #
-  def self.is_gtk2_in_use?
+  def self.true_query_whether_gtk2_is_in_use?
     Object.const_defined?(:Gtk) and
     Gtk.const_defined?(:MAJOR_VERSION) and
     (::Gtk::MAJOR_VERSION.to_i == 2) 
-  end; self.instance_eval { alias is_gtk2?           is_gtk2_in_use? } # === Gtk.is_gtk2?
-       self.instance_eval { alias use_gtk2?          is_gtk2_in_use? } # === Gtk.use_gtk2?
-       self.instance_eval { alias do_we_use_gtk2?    is_gtk2_in_use? } # === Gtk.do_we_use_gtk2?
-       self.instance_eval { alias are_we_using_gtk2? is_gtk2_in_use? } # === Gtk.are_we_using_gtk2?
+  end; self.instance_eval { alias is_gtk2?  true_query_whether_gtk2_is_in_use? } # === Gtk.is_gtk2?
+       self.instance_eval { alias use_gtk2? true_query_whether_gtk2_is_in_use? } # === Gtk.use_gtk2?
 
 end
 
 if __FILE__ == $PROGRAM_NAME
-  puts Gtk.is_gtk2_in_use?
+  alias e puts
+  require 'gtk2' # or require 'gtk3'
+  e 'is gtk2 in use: '+Gtk.is_gtk2_in_use?.to_s
+  e 'is gtk3 in use: '+Gtk.is_gtk3_in_use?.to_s
 end

data/lib/gtk_paradise/toplevel_methods/events.rb

@@ -11,6 +11,9 @@ module Gtk
   # ========================================================================= #
   def self.scroll_up_event?(event)
     case event.class.to_s
+    # ======================================================================= #
+    # === Gdk::EventScroll
+    # ======================================================================= #
     when 'Gdk::EventScroll'
       direction = event.direction
       if direction == Gdk::ScrollDirection::UP
@@ -25,6 +28,9 @@ module Gtk
   # ========================================================================= #
   def self.scroll_down_event?(event)
     case event.class.to_s
+    # ======================================================================= #
+    # === Gdk::EventScroll
+    # ======================================================================= #
     when 'Gdk::EventScroll'
       direction = event.direction
       if direction == Gdk::ScrollDirection::DOWN

data/lib/gtk_paradise/toplevel_methods/keys.rb

@@ -89,7 +89,7 @@ end
 end
 
 if __FILE__ == $PROGRAM_NAME
-  require 'gtk2'
+  require 'gtk3'
   Gtk::Keys.populate_arrow_keys
   include ::Gtk::Keys
   pp Gtk::Keys.arrow_keys?

data/lib/gtk_paradise/toplevel_methods/screen_resolution.rb

@@ -7,6 +7,8 @@
 # =========================================================================== #
 module Gtk
 
+  require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
+
   # ========================================================================= #
   # === Gtk.resolution?
   #
@@ -19,14 +21,39 @@ module Gtk
   # An Array will be returned by this method, such as [1920, 1080].
   # ========================================================================= #
   def self.resolution?
-    _ = Gdk::Screen.default
-    [_.width, _.height]
+    # ======================================================================= #
+    # The following code has been commented out on 14.09.2022 - the new code
+    # appears to work on ruby-gtk3 and ruby-gtk4 just fine. If we ever need
+    # to support ruby-gtk2 then we may have to adjust the code - but for
+    # now this shall suffice. 
+    # ======================================================================= #
+    # if use_gtk3?
+    #   _ = Gdk::Screen.default
+    #   return [_.width, _.height]
+    # elsif use_gtk4?
+    #   width  = Gdk::Display.default.primary_monitor.geometry.width
+    #   height = Gdk::Display.default.primary_monitor.geometry.height
+    #   return [width, height]
+    # else # else assume something simply for gtk4.
+    #   return [1800, 1200]
+    # end
+    # In September 2022 this was modified a bit, for ruby-gtk2 support:
+    if ::Gtk.use_gtk2?
+      _ = Gdk::Screen.default
+      return [_.width, _.height]
+    else
+      width  = Gdk::Display.default.primary_monitor.geometry.width
+      height = Gdk::Display.default.primary_monitor.geometry.height
+      return [width, height]
+    end
   end; self.instance_eval { alias screen_resolution? resolution? } # === Gtk.screen_resolution?
 
   # ========================================================================= #
   # === Gtk.max_width?
   #
-  # This is functionally equivalent to Gdk::Screen.default.width().
+  # This is functionally equivalent to Gdk::Screen.default.width(),
+  # at the least for ruby-gtk3. In ruby-gtk4 this has changed a
+  # little.
   # ========================================================================= #
   def self.max_width?
     resolution?.first
@@ -42,6 +69,6 @@ module Gtk
 end
 
 if __FILE__ == $PROGRAM_NAME
-  require 'gtk3'
-  pp Gtk.resolution?
+  require 'gtk4' # or 'gtk3'
+  pp Gtk.resolution? # => [2560, 1080]
 end

data/lib/gtk_paradise/toplevel_methods/text_buffer_tags.rb

@@ -27,6 +27,13 @@ module TextBufferTags # === Gtk::TextBufferTags
     i.create_tag('heading1', { 'font' => 'Sans 22'})
   end
 
+  # ========================================================================= #
+  # === Gtk::TextBufferTags.h2_tag
+  # ========================================================================= #
+  def self.h2_tag(i)
+    i.create_tag('heading2', { 'font' => 'Sans 20'})
+  end
+
   # ========================================================================= #
   # === Gtk::TextBufferTags.create_default_tags
   #
@@ -42,9 +49,8 @@ module TextBufferTags # === Gtk::TextBufferTags
       # =================================================================== #
       # Create some headings first:
       # =================================================================== #
-      # i.create_tag('heading1', { 'font' => 'Sans 22'})
-      Gtk::TextBufferTags.h1_tag(i)
-      i.create_tag('heading2', { 'font' => 'Sans 20'}) 
+      Gtk::TextBufferTags.h1_tag(i) # i.create_tag('heading1', { 'font' => 'Sans 22'})
+      Gtk::TextBufferTags.h2_tag(i) 
       i.create_tag('heading3', { 'font' => 'Sans 18'}) 
       i.create_tag('heading4', { 'font' => 'Sans 16'}) 
       i.create_tag('heading5', { 'font' => 'Sans 14'}) 
@@ -134,10 +140,13 @@ module TextBufferTags # === Gtk::TextBufferTags
       # === Alignments / Justifications
       # =================================================================== #
       i.create_tag('right_side', { justification: :right })
+
       # =================================================================== #
+      # === Background colours
+      #
       # Some background colours are defined next.
       # =================================================================== #
-      #
+
       # =================================================================== #
       # bg_red:
       # =================================================================== #

data/lib/gtk_paradise/toplevel_methods/tokenizer.rb

@@ -16,7 +16,7 @@
 # =========================================================================== #
 module Gtk
 
-class Tokenizer
+class Tokenizer # === Gtk::Tokenizer
 
   begin
     require 'roebe/toplevel_methods/keywords.rb'
@@ -42,13 +42,28 @@ class Tokenizer
     when /".+?"/,
          /'.+?'/
       tag = :string
-    when /#.*$/,/^=begin/,/^=end/  # ,/^\/\/.*$/
+    # ======================================================================= #
+    # === :comment
+    # ======================================================================= #
+    when /#.*$/,
+         /^=begin/,
+         /^=end/  # ,/^\/\/.*$/
       tag = :comment
-    # the first is for empty () only IF a word is before it   
+    # ======================================================================= #
+    # === :parens
+    #
+    # The first is for empty () only IF a word is before it
+    # ======================================================================= #   
     when /\(\)/ #/\w(\(\))$/ 
       tag = :parens    
+    # ======================================================================= #
+    # === :const
+    # ======================================================================= #
     when /[A-Z][A-Za-z0-9_]+/
       tag = :const
+    # ======================================================================= #
+    # === :reserved
+    # ======================================================================= #
     when RUBY_RESERVED_WORDS_PATTERN
       tag = :reserved
     else