glimmer-dsl-swt 4.21.2.4 → 4.22.1.1

data/docs/reference/GLIMMER_SAMPLES.md

@@ -5,6 +5,7 @@
     - [Hello, Label!](#hello-label)
     - [Hello, Text!](#hello-text)
     - [Hello, Composite!](#hello-composite)
+    - [Hello, Scrolled Composite!](#hello-scrolled-composite)
     - [Hello, Layout!](#hello-layout)
     - [Hello, Shell!](#hello-shell)
     - [Hello, Tab!](#hello-tab)
@@ -77,6 +78,7 @@
     - [Stock Ticker](#stock-ticker)
     - [Metronome](#metronome)
     - [Weather](#weather)
+    - [Quarto](#quarto)
   - [External Samples](#external-samples)
     - [Glimmer Calculator](#glimmer-calculator)
     - [Gladiator](#gladiator)
@@ -178,6 +180,18 @@ Code:
 
 ![Hello Composite](/images/glimmer-hello-composite.png)
 
+#### Hello, Scrolled Composite!
+
+This sample demonstrates the `scrolled_composite` widget, which is used to add scrollbars around content that exceeds the size of the window.
+
+Code:
+
+[samples/hello/hello_scrolled_composite.rb](/samples/hello/hello_scrolled_composite.rb)
+
+![Hello Scrolled Composite](/images/glimmer-hello-scrolled-composite.png)
+
+![Hello Scrolled Composite](/images/glimmer-hello-scrolled-composite-scrolled.png)
+
 #### Hello, Layout!
 
 This sample demonstrates the standard 3 layouts in SWT (though one can write their own for very advanced applications): `fill_layout`, `row_layout`, and `grid_layout`
@@ -1356,6 +1370,18 @@ Atlanta - Fahrenheit
 
 ![Atlanta F](/images/glimmer-weather-atlanta-fahrenheit.png)
 
+#### Quarto
+
+This sample is a classic game called [Quarto](https://en.gigamic.com/game/quarto-classic), which demonstrates Canvas Drag and Drop and Custom Shapes (`cylinder`, `cube`, and `message_box_panel`) in an MVC application.
+
+Code:
+
+[samples/elaborate/quarto.rb](/samples/elaborate/quarto.rb)
+
+Quarto
+
+![Quarto](/images/glimmer-quarto.png)
+
 ### External Samples
 
 #### Glimmer Calculator

data/lib/ext/glimmer/config.rb

@@ -59,6 +59,20 @@ module Glimmer
       end
       alias auto_sync_exec? auto_sync_exec
       
+      # allowed logger types are :logger (default) and :logging (logging gem supporting async logging)
+      # updating logger type value resets logger
+      def logger_type=(logger_type_class)
+        @@logger_type = logger_type_class
+        reset_logger!
+      end
+      
+      def logger_type
+        unless defined? @@logger_type
+          @@logger_type = :logger
+        end
+        @@logger_type
+      end
+      
       # Returns Logging Devices. Default is [:stdout, :syslog]
       def logging_devices
         unless defined? @@logging_devices
@@ -112,39 +126,42 @@ module Glimmer
         reset_logger!
       end
       
+      alias reset_logger_without_glimmer_dsl_swt! reset_logger!
       def reset_logger!
-        @first_time = !defined?(@@logger)
-        old_level = logger.level unless @first_time
-        self.logger = Logging.logger['glimmer'].tap do |logger|
-          logger.level = old_level || :error
-          appenders = []
-          appenders << Logging.appenders.stdout(logging_appender_options) if logging_devices.include?(:stdout)
-          appenders << Logging.appenders.stderr(logging_appender_options) if logging_devices.include?(:stderr)
-          if logging_devices.include?(:file)
-            require 'fileutils'
-            FileUtils.mkdir_p('log')
-            appenders << Logging.appenders.rolling_file('log/glimmer.log', logging_appender_options.merge(logging_device_file_options)) if logging_devices.include?(:file)
+        if logger_type == :logger
+          reset_logger_without_glimmer_dsl_swt!
+        else
+          require 'logging'
+          @first_time = !defined?(@@logger)
+          old_level = logger.level unless @first_time
+          self.logger = Logging.logger['glimmer'].tap do |logger|
+            logger.level = old_level || :error
+            appenders = []
+            appenders << Logging.appenders.stdout(logging_appender_options) if logging_devices.include?(:stdout)
+            appenders << Logging.appenders.stderr(logging_appender_options) if logging_devices.include?(:stderr)
+            if logging_devices.include?(:file)
+              require 'fileutils'
+              FileUtils.mkdir_p('log')
+              appenders << Logging.appenders.rolling_file('log/glimmer.log', logging_appender_options.merge(logging_device_file_options)) if logging_devices.include?(:file)
+            end
+            if Object.const_defined?(:Syslog) && logging_devices.include?(:syslog)
+              Syslog.close if Syslog.opened?
+              appenders << Logging.appenders.syslog('glimmer', logging_appender_options)
+            end
+            logger.appenders = appenders
           end
-          if Object.const_defined?(:Syslog) && logging_devices.include?(:syslog)
-            Syslog.close if Syslog.opened?
-            appenders << Logging.appenders.syslog('glimmer', logging_appender_options)
-          end
-          logger.appenders = appenders
         end
-        
       end
-      
     end
-    
   end
-  
 end
 
-Glimmer::Config.reset_logger! unless ENV['GLIMMER_LOGGER_ENABLED'].to_s.downcase == 'false'
 if ENV['GLIMMER_LOGGER_LEVEL']
-  # if glimmer log level is being overridden for debugging purposes, then disable async logging making logging immediate
-  Glimmer::Config.logging_appender_options = Glimmer::Config.logging_appender_options.merge(async: false, auto_flushing: 1, immediate_at: [:unknown, :debug, :info, :error, :fatal])
-  Glimmer::Config.logging_devices = [:stdout]
+  if Glimmer::Config.logger_type == :logging
+    # if glimmer log level is being overridden for debugging purposes, then disable async logging making logging immediate
+    Glimmer::Config.logging_appender_options = Glimmer::Config.logging_appender_options.merge(async: false, auto_flushing: 1, immediate_at: [:unknown, :debug, :info, :error, :fatal])
+    Glimmer::Config.logging_devices = [:stdout]
+  end
   begin
     puts "Adjusting Glimmer logging level to #{ENV['GLIMMER_LOGGER_LEVEL']}"
     Glimmer::Config.logger.level = ENV['GLIMMER_LOGGER_LEVEL'].strip

data/lib/glimmer/data_binding/observable_widget.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2007-2021 Andy Maleh
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
@@ -7,10 +7,10 @@
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -25,9 +25,9 @@ module Glimmer
       # TODO see if it is worth it to eliminate duplication of method_missing
       # from WidgetProxy using a module
 
-      def method_missing(method, *args, &block)
-        method_name = method.to_s
-        if can_handle_observation_request?(method_name)
+      def method_missing(method_name, *args, &block)
+        method_name = method_name.to_s
+        if block && can_handle_observation_request?(method_name)
           handle_observation_request(method_name, &block)
         else
           super

data/lib/glimmer/data_binding/widget_binding.rb

@@ -38,18 +38,19 @@ module Glimmer
         @sync_exec = sync_exec
         @async_exec = async_exec
         SWT::DisplayProxy.instance.auto_exec(override_sync_exec: @sync_exec, override_async_exec: @async_exec) do
-          if @widget.respond_to?(:on_widget_disposed)
+          if @widget.is_a?(Glimmer::SWT::WidgetProxy) && @widget.respond_to?(:on_widget_disposed)
             @widget.on_widget_disposed do |dispose_event|
               deregister_all_observables unless @widget.shell_proxy.last_shell_closing?
             end
           end
+          # TODO look into hooking on_shape_disposed without slowing down shapes in samples like Tetris
         end
       end
       
       def call(value)
         SWT::DisplayProxy.instance.auto_exec(override_sync_exec: @sync_exec, override_async_exec: @async_exec) do
           if @widget.respond_to?(:disposed?) && @widget.disposed?
-            deregister_all_observables
+            deregister_all_observables unless @widget.shell_proxy.last_shell_closing?
             return
           end
           # need the rescue false for a scenario with tree items not being equal to model objects raising an exception
@@ -61,7 +62,7 @@ module Glimmer
       
       def evaluate_property
         if @widget.respond_to?(:disposed?) && @widget.disposed?
-          deregister_all_observables
+          deregister_all_observables unless @widget.shell_proxy.last_shell_closing?
           return
         end
         @widget.get_attribute(@property)

data/lib/glimmer/dsl/swt/observe_expression.rb

@@ -23,6 +23,7 @@ require 'glimmer/dsl/static_expression'
 require 'glimmer/dsl/top_level_expression'
 require 'glimmer/dsl/observe_expression'
 require 'glimmer/ui/custom_widget'
+require 'glimmer/swt/display_proxy'
 
 module Glimmer
   module DSL
@@ -33,7 +34,7 @@ module Glimmer
 
         def interpret(parent, keyword, *args, &block)
           observer_registration = super
-          Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(observer_registration)
+          Glimmer::SWT::DisplayProxy.current_custom_widgets_and_shapes.last&.observer_registrations&.push(observer_registration)
           observer_registration
         end
       end

data/lib/glimmer/dsl/swt/sync_call_expression.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/swt/exec_expression'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Synchronously executes code block against the SWT Event Loop
+      # to manipulate SWT UI objects on the UI thread safely with
+      # immediate priority when needed.
+      #
+      # Returns the value produced by evaluating the expression.
+      class SyncCallExpression < StaticExpression
+        include ExecExpression
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/swt/transform_expression.rb

@@ -34,7 +34,7 @@ module Glimmer
         
         def can_interpret?(parent, keyword, *args, &block)
           super and
-            (parent.nil? or parent.is_a?(Glimmer::SWT::Custom::Shape))
+            (parent.nil? or parent.is_a?(Glimmer::SWT::Custom::Shape) or parent.is_a?(Glimmer::UI::CustomShape))
         end
         
         def interpret(parent, keyword, *args, &block)

data/lib/glimmer/launcher.rb

@@ -89,8 +89,7 @@ module Glimmer
       def glimmer_lib
         unless @glimmer_lib
           @glimmer_lib = GLIMMER_LIB_GEM
-          glimmer_gem_listing = `jgem list #{GLIMMER_LIB_GEM}`.split("\n").map {|l| l.split.first}
-          if !glimmer_gem_listing.include?(GLIMMER_LIB_GEM) && File.exists?(GLIMMER_LIB_LOCAL)
+          if File.exists?(GLIMMER_LIB_LOCAL)
             @glimmer_lib = GLIMMER_LIB_LOCAL
             puts "[DEVELOPMENT MODE] (detected #{@glimmer_lib})"
           end
@@ -121,18 +120,21 @@ module Glimmer
           ENV[k] = v
         end
         the_glimmer_lib = glimmer_lib
-        if the_glimmer_lib == GLIMMER_LIB_LOCAL
-          require 'puts_debuggerer'
+        require 'puts_debuggerer' if the_glimmer_lib == GLIMMER_LIB_LOCAL
+        is_rake_task = !application.end_with?('.rb')
+        rake_tasks = []
+        if is_rake_task
+          load File.expand_path('./Rakefile') if File.exist?(File.expand_path('./Rakefile')) && caller.join("\n").include?('/bin/glimmer:')
+          require_relative 'rake_task'
+          rake_tasks = Rake.application.tasks.map(&:to_s).map {|t| t.sub('glimmer:', '')}
+           
+          # handle a bash quirk with calling package[msi] while there is a "packages" directory locally (it passes package[msi] as packages)
+          application = 'package[msi]' if application == 'packages'
+          
+          potential_rake_task_parts = application.match(REGEX_RAKE_TASK_WITH_ARGS)
+          application = potential_rake_task_parts[1]
+          rake_task_args = potential_rake_task_parts[2].split(',')
         end
-        require_relative 'rake_task'
-        rake_tasks = Rake.application.tasks.map(&:to_s).map {|t| t.sub('glimmer:', '')}
-         
-        # handle a bash quirk with calling package[msi] while there is a "packages" directory locally (it passes package[msi] as packages)
-        application = 'package[msi]' if application == 'packages'
-        
-        potential_rake_task_parts = application.match(REGEX_RAKE_TASK_WITH_ARGS)
-        application = potential_rake_task_parts[1]
-        rake_task_args = potential_rake_task_parts[2].split(',')
         if rake_tasks.include?(application)
           load_env_vars(glimmer_option_env_vars(glimmer_options))
           rake_task = "glimmer:#{application}"
@@ -171,7 +173,6 @@ module Glimmer
     private
 
     def launch_application
-      load File.expand_path('./Rakefile') if File.exist?(File.expand_path('./Rakefile')) && caller.join("\n").include?('/bin/glimmer_runner.rb:')
       self.class.launch(
         @application_path,
         jruby_options: @jruby_options,

data/lib/glimmer/rake_task/package.rb

@@ -25,6 +25,8 @@ require 'os'
 module Glimmer
   module RakeTask
     module Package
+      JDK_VERSION = '17.0.1'
+      
       class << self
         attr_accessor :jpackage_extra_args
         
@@ -90,10 +92,10 @@ module Glimmer
         def native(native_type=nil, native_extra_args)
           puts "Generating native executable with jpackage..."
           java_version = `jruby -v`
-          if java_version.include?('16.0.2')
-            puts "Java Version 16.0.2 Detected!"
+          if java_version.include?(JDK_VERSION)
+            puts "Java Version #{JDK_VERSION} Detected!"
           else
-            puts "WARNING! Glimmer Packaging Pre-Requisite Java Version 16.0.2 Is Not Found!"
+            puts "WARNING! Glimmer Packaging Pre-Requisite Java Version #{JDK_VERSION} Is Not Found!"
           end
           require 'facets/string/titlecase'
           require 'facets/string/underscore'

data/lib/glimmer/rake_task/scaffold.rb

@@ -429,19 +429,7 @@ module Glimmer
         end
         
         def gemfile(shell_type)
-          if shell_type == :desktopify
-            lines = APP_GEMFILE.split("\n")
-            require_glimmer_dsl_swt_index = lines.index(lines.detect {|l| l.include?("gem 'glimmer-dsl-swt'") })
-            lines[(require_glimmer_dsl_swt_index + 1)..(require_glimmer_dsl_swt_index + 1)] = [
-              "",
-              "# Enable Chromium Browser Glimmer Custom Widget gem if needed (e.g. Linux needs it to support HTML5 Video), and use `browser(:chromium)` in GUI.",
-              "# gem 'glimmer-cw-browser-chromium', '>= 0'",
-              "",
-            ]
-            lines.join("\n")
-          else
-            APP_GEMFILE
-          end
+          APP_GEMFILE
         end
     
         def app_main_file(app_name)
@@ -643,7 +631,7 @@ module Glimmer
           minimum_size #{shell_type == :desktopify ? '768, 432' : '420, 240'}
           image File.join(APP_ROOT, 'icons', 'windows', "#{human_name(shell_type == :gem ? custom_shell_name : current_dir_name)}.ico") if OS.windows?
           image File.join(APP_ROOT, 'icons', 'linux', "#{human_name(shell_type == :gem ? custom_shell_name : current_dir_name)}.png") unless OS.windows?
-          text "#{human_name(namespace)} - #{human_name(custom_shell_name)}"
+          text "#{human_name(namespace)}#{' - ' + human_name(custom_shell_name) if shell_type != :desktopify}"
         
           MULTI_LINE_STRING
             

data/lib/glimmer/swt/color_proxy.rb

@@ -83,15 +83,15 @@ module Glimmer
         @swt_color
       end
       
-      def method_missing(method, *args, &block)
-        swt_color.send(method, *args, &block)
+      def method_missing(method_name, *args, &block)
+        swt_color.send(method_name, *args, &block)
       rescue => e
-        Glimmer::Config.logger.debug {"Neither ColorProxy nor #{swt_color.class.name} can handle the method ##{method}"}
+        Glimmer::Config.logger.debug {"Neither ColorProxy nor #{swt_color.class.name} can handle the method ##{method_name}"}
         super
       end
       
-      def respond_to?(method, *args, &block)
-        super || swt_color.respond_to?(method, *args, &block)
+      def respond_to?(method_name, *args, &block)
+        super || swt_color.respond_to?(method_name, *args, &block)
       end
       
       private

data/lib/glimmer/swt/custom/drawable.rb

@@ -44,6 +44,10 @@ module Glimmer
           @image_buffered_shapes ||= []
         end
         
+        def drop_shapes
+          @drop_shapes ||= []
+        end
+        
         # TODO add a method like shapes that specifies drawable_properties to be able to adjust properties like transform in between shapes
           
         def shape_at_location(x, y)
@@ -109,8 +113,10 @@ module Glimmer
         end
         
         def deregister_shape_painting
-          @paint_listener_proxy&.deregister
-          @resize_listener_proxy&.deregister
+          unless shell_proxy.last_shell_closing?
+            @paint_listener_proxy&.deregister
+            @resize_listener_proxy&.deregister
+          end
         end
         
         def setup_shape_painting

data/lib/glimmer/swt/custom/shape/line.rb

@@ -1,5 +1,4 @@
 # Copyright (c) 2007-2021 Andy Maleh
-# Copyright (c) 2007-2021 Andy Maleh
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/glimmer/swt/custom/shape/path.rb

@@ -101,10 +101,10 @@ module Glimmer
             end
           end
           
-          def dispose(redraw: true)
+          def dispose(dispose_images: true, dispose_patterns: true, redraw: true)
             Glimmer::SWT::DisplayProxy.instance.auto_exec do
               clear if self.class == Path
-              super(redraw: redraw) if (parent.is_a?(Shape) && (!parent.is_a?(PathSegment) || !parent.part_of_path?)) || parent.is_a?(Drawable)
+              super(dispose_images: dispose_images, dispose_patterns: dispose_patterns, redraw: redraw) if (parent.is_a?(Shape) && (!parent.is_a?(PathSegment) || !parent.part_of_path?)) || parent.is_a?(Drawable)
             end
           end
           

data/lib/glimmer/swt/custom/shape/path_segment.rb

@@ -75,7 +75,7 @@ module Glimmer
             true
           end
           
-          def dispose(redraw: true)
+          def dispose(dispose_images: true, dispose_patterns: true, redraw: true)
             Glimmer::SWT::DisplayProxy.instance.auto_exec do
               # including classes could override to dispose of resources first
               # afterwards, parent removes from its path segments with post_dispose_content
@@ -83,7 +83,7 @@ module Glimmer
               if part_of_path?
                 drawable.redraw if redraw && !drawable.is_a?(ImageProxy)
               else
-                super(redraw: redraw)
+                super(dispose_images: dispose_images, dispose_patterns: dispose_patterns, redraw: redraw)
               end
             end
           end

data/lib/glimmer/swt/custom/shape/point.rb

@@ -53,7 +53,14 @@ module Glimmer
             # give it some fuzz (helps makes mouse clicking easier)
             x.to_i.between?(self.absolute_x.to_i - 2, self.absolute_x.to_i + 2) && y.to_i.between?(self.absolute_y.to_i - 2, self.absolute_y.to_i + 2)
           end
-          alias contain? include?
+          
+          def contain?(x, y)
+            include?(x, y)
+          end
+          
+          def bounds_contain?(x, y)
+            include?(x, y)
+          end
           
           def path_segment_method_name
             'addRectangle'