glimmer-dsl-swt 4.18.4.10 → 4.18.5.3

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

@@ -0,0 +1,115 @@
+# 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/swt/custom/shape'
+require 'glimmer/swt/swt_proxy'
+require 'glimmer/swt/display_proxy'
+require 'glimmer/swt/color_proxy'
+require 'glimmer/swt/font_proxy'
+require 'glimmer/swt/transform_proxy'
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents a shape (graphics) to be drawn on a control/widget/canvas/display
+      # That is because Shape is drawn on a parent as graphics and doesn't have an SWT widget for itself
+      class Shape
+        class Polyline < Shape
+          def parameter_names
+            [:point_array]
+          end
+          
+          def location_parameter_names
+            parameter_names
+          end
+          
+          def point_count
+            point_array.count / 2
+          end
+          
+          def [](index)
+            index = 0 if index == point_count
+            org.eclipse.swt.graphics.Point.new(point_array[index * 2], point_array[index * 2 + 1])
+          end
+          
+          def x_array
+            point_array.each_with_index.select {|pair| pair.last.even?}.map(&:first)
+          end
+          
+          def y_array
+            point_array.each_with_index.select {|pair| pair.last.odd?}.map(&:first)
+          end
+          
+          def point_xy_array
+            x_array.zip(y_array)
+          end
+          
+          # Logical x coordinate. Always assumes the first point in the polyline to be the x coordinate.
+          def x
+            x_array.first
+          end
+           
+          # Logical y coordinate. Always assumes the first point in the polyline to be the y coordinate.
+          def y
+            y_array.first
+          end
+          
+          def absolute_point_array
+            if parent.is_a?(Shape)
+              point_array.each_with_index.map do |coordinate, i|
+                if i.even?
+                  parent.absolute_x + coordinate
+                else
+                  parent.absolute_y + coordinate
+                end
+              end
+            else
+              point_array
+            end
+          end
+          
+          def absolute_x_array
+            absolute_point_array.each_with_index.select {|pair| pair.last.even?}.map(&:first)
+          end
+          
+          def absolute_y_array
+            absolute_point_array.each_with_index.select {|pair| pair.last.odd?}.map(&:first)
+          end
+          
+          def absolute_point_xy_array
+            absolute_x_array.zip(absolute_y_array)
+          end
+                    
+          def include?(x, y)
+            comparison_lines = absolute_point_xy_array.zip(absolute_point_xy_array.rotate(1))
+            comparison_lines.pop # ignore last pair since you don't want to compare last point with first point
+            comparison_lines.any? {|line| Line.include?(line.first.first, line.first.last, line.last.first, line.last.last, x, y)}
+          end
+          alias contain? include?
+          
+          def move_by(x_delta, y_delta)
+            self.point_array = point_array.each_with_index.map {|coordinate, i| i.even? ? coordinate + x_delta : coordinate + y_delta}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# 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/swt/custom/shape'
+require 'glimmer/swt/swt_proxy'
+require 'glimmer/swt/display_proxy'
+require 'glimmer/swt/color_proxy'
+require 'glimmer/swt/font_proxy'
+require 'glimmer/swt/transform_proxy'
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents a shape (graphics) to be drawn on a control/widget/canvas/display
+      # That is because Shape is drawn on a parent as graphics and doesn't have an SWT widget for itself
+      class Shape
+        class Rectangle < Shape
+          def parameter_names
+            if @args.to_a.size >= 6
+              rectangle_round_parameter_names
+            elsif @args.to_a.size == 5
+              rectangle_gradient_parameter_names
+            elsif @args.to_a.size == 1
+              rectangle_rectangle_parameter_names
+            else
+              rectangle_parameter_names
+            end
+          end
+          
+          def possible_parameter_names
+            # TODO refactor and improve this method through meta-programming (and share across other shapes)
+            (rectangle_round_parameter_names + rectangle_gradient_parameter_names + rectangle_parameter_names + rectangle_rectangle_parameter_names).uniq
+          end
+          
+          def rectangle_round_parameter_names
+            [:x, :y, :width, :height, :arc_width, :arc_height]
+          end
+          
+          def rectangle_gradient_parameter_names
+            [:x, :y, :width, :height, :vertical]
+          end
+          
+          def rectangle_parameter_names
+            [:x, :y, :width, :height]
+          end
+          
+          def rectangle_rectangle_parameter_names
+            # this receives a Rectangle object
+            [:rectangle]
+          end
+          
+          def parameter_index(attribute_name)
+            ####TODO refactor and improve this method through meta-programming (and share across other shapes)
+            if rectangle_round_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              rectangle_round_parameter_names.map(&:to_s).index(attribute_name.to_s)
+            elsif rectangle_gradient_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              rectangle_gradient_parameter_names.map(&:to_s).index(attribute_name.to_s)
+            elsif rectangle_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              rectangle_parameter_names.map(&:to_s).index(attribute_name.to_s)
+            elsif rectangle_rectangle_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              rectangle_rectangle_parameter_names.map(&:to_s).index(attribute_name.to_s)
+            end
+          end
+          
+          def point_xy_array
+            [[x, y], [x + width, y], [x + width, y + height], [x, y + height]]
+          end
+          
+          def absolute_point_xy_array
+            [[absolute_x, absolute_y], [absolute_x + width, absolute_y], [absolute_x + width, absolute_y + height], [absolute_x, absolute_y + height]]
+          end
+          
+          # checks if drawn or filled rectangle includes the point denoted by x and y (if drawn, it only returns true if point lies on the edge)
+          def include?(x, y)
+            if filled?
+              contain?(x, y)
+            else
+              comparison_lines = absolute_point_xy_array.zip(absolute_point_xy_array.rotate(1))
+              comparison_lines.any? {|line| Line.include?(line.first.first, line.first.last, line.last.first, line.last.last, x, y)}
+            end
+          end
+          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# 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/swt/custom/shape'
+require 'glimmer/swt/swt_proxy'
+require 'glimmer/swt/display_proxy'
+require 'glimmer/swt/color_proxy'
+require 'glimmer/swt/font_proxy'
+require 'glimmer/swt/transform_proxy'
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents a shape (graphics) to be drawn on a control/widget/canvas/display
+      # That is because Shape is drawn on a parent as graphics and doesn't have an SWT widget for itself
+      class Shape
+        class Text < Shape
+          attr_accessor :extent
+        
+          def parameter_names
+            @parameter_names || text_parameter_names
+          end
+          
+          def possible_parameter_names
+            # TODO refactor and improve this method through meta-programming (and share across other shapes)
+            (text_parameter_names + text_transparent_parameter_names + text_flags_parameter_names).uniq
+          end
+          
+          def text_parameter_names
+            [:string, :x, :y]
+          end
+          
+          def text_transparent_parameter_names
+            [:string, :x, :y, :is_transparent]
+          end
+          
+          def text_flags_parameter_names
+            [:string, :x, :y, :flags]
+          end
+          
+          def set_parameter_attribute(attribute_name, *args)
+            return super if @parameter_names.to_a.map(&:to_s).include?(attribute_name.to_s)
+            if text_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              @parameter_names = text_parameter_names
+            elsif text_transparent_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              @parameter_names = text_transparent_parameter_names
+            elsif text_flags_parameter_names.map(&:to_s).include?(attribute_name.to_s)
+              @parameter_names = text_flags_parameter_names
+            end
+            super
+          end
+          
+          def width
+            extent&.x
+          end
+          
+          def height
+            extent&.y
+          end
+          
+        end
+        
+        String = Text
+      end
+    end
+  end
+end

data/lib/glimmer/swt/date_time_proxy.rb

@@ -43,7 +43,9 @@ module Glimmer
       end
       
       def date=(date_value)
-        swt_widget.setDate(date_value.year, date_value.month - 1, date_value.day)
+        auto_exec do
+          swt_widget.setDate(date_value.year, date_value.month - 1, date_value.day)
+        end
       end
       
       def time
@@ -58,11 +60,15 @@ module Glimmer
       end
       
       def month
-        swt_widget.month + 1
+        auto_exec do
+          swt_widget.month + 1
+        end
       end
       
       def month=(new_value)
-        swt_widget.month = new_value - 1
+        auto_exec do
+          swt_widget.month = new_value - 1
+        end
       end
       
       def set_attribute(attribute_name, *args)

data/lib/glimmer/swt/dialog_proxy.rb

@@ -0,0 +1,92 @@
+# 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/swt/swt_proxy'
+require 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/display_proxy'
+require 'glimmer/swt/proxy_properties'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.widgets.Dialog superclass
+    # of dialogs like FileDialog, DirectoryDialog, ColorDialog, and FontDialog
+    #
+    # (if you're seeking the `dialog` keyword, that's just a `shell` variation
+    # under ShellProxy instead.
+    #
+    # Automatically uses the current shell if one is open.
+    # Otherwise, it instantiates a new shell parent
+    #
+    # Optionally takes a shell as an argument
+    #
+    # Follows the Proxy Design Pattern
+    class DialogProxy
+      # TODO write rspec tests
+      include ProxyProperties
+      
+      include_package 'org.eclipse.swt.widgets'
+      include_package 'org.eclipse.swt.printing'
+      
+      class << self
+        include_package 'org.eclipse.swt.widgets'
+        include_package 'org.eclipse.swt.printing'
+        
+        def dialog_class(keyword)
+          the_class = eval(keyword.camelcase(:upper))
+          the_class if the_class.ancestors.include?(org.eclipse.swt.widgets.Dialog)
+        end
+      end
+
+      attr_reader :swt_dialog
+      
+      def initialize(keyword, *args, swt_dialog: nil)
+        DisplayProxy.instance.auto_exec do
+          dialog_class = self.class.dialog_class(keyword)
+          if swt_dialog
+            @swt_dialog = swt_dialog
+          else
+            style_args = args.select {|arg| arg.is_a?(Symbol) || arg.is_a?(String)}
+            if style_args.any?
+              style_arg_start_index = args.index(style_args.first)
+              style_arg_last_index = args.index(style_args.last)
+              args[style_arg_start_index..style_arg_last_index] = SWTProxy[style_args]
+            end
+            if args.first.respond_to?(:swt_widget) && args.first.swt_widget.is_a?(Shell)
+              args[0] = args[0].swt_widget
+            end
+            if !args.first.is_a?(Shell)
+              current_shell = DisplayProxy.instance.swt_display.shells.first
+              args.unshift(current_shell.nil? ? ShellProxy.new : current_shell)
+            end
+            parent = args[0]
+            @parent_proxy = parent.is_a?(Shell) ? ShellProxy.new(swt_widget: parent) : parent
+            @swt_dialog = dialog_class.new(*args)
+          end
+        end
+      end
+      
+      def proxy_source_object
+        @swt_dialog
+      end
+
+    end
+  end
+end

data/lib/glimmer/swt/display_proxy.rb

@@ -58,10 +58,16 @@ module Glimmer
         # Returns singleton instance
         def instance(*args)
           if @instance.nil? || @instance.swt_display.nil? || @instance.swt_display.isDisposed
+            @thread = Thread.current
             @instance = new(*args)
           end
           @instance
         end
+        
+        def thread
+          instance # ensure instance
+          @thread
+        end
       end
 
       # SWT Display object wrapped
@@ -71,6 +77,7 @@ module Glimmer
         Display.app_name ||= 'Glimmer'
         @swt_display = Display.new(*args)
         @swt_display.set_data('proxy', self)
+        @execs_in_progress = {}
         on_swt_Dispose {
           clear_shapes
         }
@@ -80,18 +87,71 @@ module Glimmer
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::SWT::DisplayExpression.new, &block)
       end
       
+      # asynchronously executes the block (required from threads other than first GUI thread)
+      # does not return the value produced by the block since it is async, running after the return
       def async_exec(&block)
-        @swt_display.asyncExec(&block)
+        @swt_display.asyncExec do
+          execs_in_progress << :async_exec
+          begin
+            result = block.call
+          ensure
+            execs_in_progress.pop
+          end
+        end
       end
 
+      # synchronously executes the block (required from threads other than first GUI thread)
+      # returns the value produced by the block
       def sync_exec(&block)
-        @swt_display.syncExec(&block)
+        result = nil
+        @swt_display.syncExec do
+          execs_in_progress << :sync_exec
+          begin
+            result = block.call
+          ensure
+            execs_in_progress.pop
+          end
+        end
+        result
       end
 
       def timer_exec(delay_in_millis, &block)
         @swt_display.timerExec(delay_in_millis, &block)
       end
       
+      # Indicates whether `sync_exec` is required because of running in a different thread from the GUI thread
+      # `async_exec` could be used as an alternative to `sync_exec` when required.
+      def sync_exec_required?
+        Thread.current != DisplayProxy.thread
+      end
+      
+      def async_exec_in_progress?
+        execs_in_progress.last == :async_exec
+      end
+      
+      def sync_exec_in_progress?
+        execs_in_progress.include?(:sync_exec)
+      end
+      
+      def execs_in_progress
+        @execs_in_progress[Thread.current] ||= []
+      end
+      
+      # Invoke block with `sync_exec` only when necessary (running from a separate thread)
+      # Override sync_exec as `true` to force using or `false` to force avoiding
+      # Override async_exec as `true` to force using or `:unless_in_progress` to force using only if no `async_exec` is in progress
+      # Disable auto execution of `sync_exec` via `Glimmer::Config.auto_sync_exec = false`
+      # Otherwise, runs normally, thus allowing SWT to decide how to batch/optimize GUI updates
+      def auto_exec(override_sync_exec: nil, override_async_exec: nil, &block)
+        if override_sync_exec || override_sync_exec.nil? && !override_async_exec && sync_exec_required? && Config.auto_sync_exec? && !sync_exec_in_progress? && !async_exec_in_progress?
+          sync_exec(&block)
+        elsif override_async_exec || override_async_exec.to_s == 'unless_in_progress' && !async_exec_in_progress?
+          async_exec(&block)
+        else
+          block.call
+        end
+      end
+
       def on_widget_disposed(&block)
         on_swt_Dispose(&block)
       end