glimmer-dsl-swt 4.18.3.5 → 4.18.4.4

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

@@ -1,253 +1,297 @@
-# 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/properties'
-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
-        include Packages
-        include Properties
-        # TODO support textExtent sized shapes nested within text/string
-        # TODO support a Pattern DSL for methods that take Pattern arguments
-        
-        class << self
-          def valid?(parent, keyword, *args, &block)
-            gc_instance_methods.include?(method_name(keyword, args))
-          end
-          
-          def gc_instance_methods
-            @gc_instance_methods ||= org.eclipse.swt.graphics.GC.instance_methods.map(&:to_s)
-          end
-          
-          def keywords
-            @keywords ||= gc_instance_methods.select do |method_name|
-              !method_name.end_with?('=') && (method_name.start_with?('draw_') || method_name.start_with?('fill_'))
-            end.reject do |method_name|
-              gc_instance_methods.include?("#{method_name}=") || gc_instance_methods.include?("set_#{method_name}")
-            end.map do |method_name|
-              method_name.gsub(/(draw|fill|gradient|round)_/, '')
-            end.uniq.compact.to_a
-          end
-          
-          def arg_options(args, extract: false)
-            arg_options_method = extract ? :pop : :last
-            options = args.send(arg_options_method) if args.last.is_a?(Hash)
-            options.nil? ? {} : options.symbolize_keys
-          end
-          
-          def method_name(keyword, args)
-            method_arg_options = arg_options(args)
-            unless flyweight_method_names.keys.include?([keyword, method_arg_options])
-              keyword = keyword.to_s
-              gradient = 'gradient_' if method_arg_options[:gradient]
-              round = 'round_' if method_arg_options[:round]
-              gc_instance_method_name_prefix = !['polyline', 'point', 'image', 'focus'].include?(keyword) && (method_arg_options[:fill] || method_arg_options[:gradient]) ? 'fill_' : 'draw_'
-              flyweight_method_names[[keyword, method_arg_options]] = "#{gc_instance_method_name_prefix}#{gradient}#{round}#{keyword}"
-            end
-            flyweight_method_names[[keyword, method_arg_options]]
-          end
-          
-          def flyweight_method_names
-            @flyweight_method_names ||= {}
-          end
-          
-          
-        end
-        
-        attr_reader :parent, :name, :args, :options, :paint_listener_proxy
-        
-        def initialize(parent, keyword, *args, &property_block)
-          @parent = parent
-          @name = keyword
-          @method_name = self.class.method_name(keyword, args)
-          @options = self.class.arg_options(args, extract: true)
-          @args = args
-          @properties = {}
-          @parent.shapes << self
-          post_add_content if property_block.nil?
-        end
-        
-        def draw?
-          !fill?
-        end
-        
-        def fill?
-          @options[:fill]
-        end
-        
-        def gradient?
-          @options[:gradient]
-        end
-        
-        def round?
-          @options[:round]
-        end
-        
-        def post_add_content
-          amend_method_name_options_based_on_properties
-          setup_painting
-          @content_added = true
-        end
-        
-        def apply_property_arg_conversions(method_name, property, args)
-          args = args.dup
-          the_java_method = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.detect {|m| m.name == method_name}
-          if (args.first.is_a?(Symbol) || args.first.is_a?(String))
-            if the_java_method.parameter_types.first == Color.java_class
-              args[0] = ColorProxy.new(args[0])
-            end
-            if the_java_method.parameter_types.first == Java::int.java_class
-              args[0] = SWTProxy.constant(args[0])
-            end
-          end
-          if args.first.is_a?(ColorProxy)
-            args[0] = args[0].swt_color
-          end
-          if args.first.is_a?(Hash) && the_java_method.parameter_types.first == Font.java_class
-            args[0] = FontProxy.new(args[0])
-          end
-          if args.first.is_a?(FontProxy)
-            args[0] = args[0].swt_font
-          end
-          if args.first.is_a?(TransformProxy)
-            args[0] = args[0].swt_transform
-          end
-          if ['setBackgroundPattern', 'setForegroundPattern'].include?(method_name.to_s)
-            args.each_with_index do |arg, i|
-              if arg.is_a?(Symbol) || arg.is_a?(String)
-                args[i] = ColorProxy.new(arg).swt_color
-              elsif arg.is_a?(ColorProxy)
-                args[i] = arg.swt_color
-              end
-            end
-            new_args = [DisplayProxy.instance.swt_display] + args
-            args[0] = org.eclipse.swt.graphics.Pattern.new(*new_args)
-            args[1..-1] = []
-          end
-          args
-        end
-        
-        def apply_shape_arg_conversions(method_name, args)
-          if args.size > 1 && (method_name.include?('polygon') || method_name.include?('polyline'))
-            args[0] = args.dup
-            args[1..-1] = []
-          end
-        end
-        
-        def apply_shape_arg_defaults(method_name, args)
-          if method_name.include?('round_rectangle') && args.size.between?(4, 5)
-            (6 - args.size).times {args << 60}
-          elsif method_name.include?('rectangle') && gradient? && args.size == 4
-            args << true
-          elsif (method_name.include?('text') || method_name.include?('string')) && !@properties.keys.map(&:to_s).include?('background') && args.size == 3
-            args << true
-          end
-          if method_name.include?('image') && args.first.is_a?(String)
-            args[0] = ImageProxy.new(args[0])
-          end
-          if method_name.include?('image') && args.first.is_a?(ImageProxy)
-            args[0] = args[0].swt_image
-          end
-        end
-                
-        # Tolerates shape extra args added by user by mistake
-        # (e.g. happens when switching from round rectangle to a standard one without removing all extra args)
-        def tolerate_shape_extra_args(method_name, args)
-          the_java_method_arg_count = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.select do |m|
-            m.name == method_name.camelcase(:lower)
-          end.map(&:parameter_types).map(&:size).max
-          if args.size > the_java_method_arg_count
-            args[the_java_method_arg_count..-1] = []
-          end
-        end
-        
-        def amend_method_name_options_based_on_properties
-          if @properties.keys.map(&:to_s).include?('background') && !@properties.keys.map(&:to_s).include?('foreground')
-            @options[:fill] = true
-          elsif @properties.keys.map(&:to_s).include?('foreground') && !@properties.keys.map(&:to_s).include?('background')
-            @options[:fill] = false
-          end
-          @method_name = self.class.method_name(@name, @args + [@options])
-        end
-                
-        def has_attribute?(attribute_name, *args)
-          self.class.gc_instance_methods.include?(attribute_setter(attribute_name))
-        end
-  
-        def set_attribute(attribute_name, *args)
-          @properties[attribute_name] = args
-          if @content_added && !@parent.is_disposed
-            @parent.resetup_shape_painting
-            @parent.redraw
-          end
-        end
-        
-        def get_attribute(attribute_name)
-          @properties.symbolize_keys[attribute_name.to_s.to_sym]
-        end
-        
-        def setup_painting
-          # TODO consider moving this method to parent (making the logic polymorphic)
-          return if @parent.is_disposed
-          if parent.respond_to?(:swt_display)
-            @paint_listener_proxy = @parent.on_swt_paint(&method(:paint))
-          elsif parent.respond_to?(:swt_image)
-            paint(parent) # treat parent as paint event since you don't do repaints with images, it's a one time deal.
-          elsif parent.respond_to?(:swt_widget)
-            @paint_listener_proxy = @parent.on_paint_control(&method(:paint))
-          end
-        end
-        
-        def paint(paint_event)
-          @properties['background'] = [@parent.background] if fill? && !@properties.keys.map(&:to_s).include?('background')
-          @properties['foreground'] = [@parent.foreground] if @parent.respond_to?(:foreground) && draw? && !@properties.keys.map(&:to_s).include?('foreground')
-          @properties['font'] = [@parent.font] if @parent.respond_to?(:font) && draw? && !@properties.keys.map(&:to_s).include?('font')
-          @properties['transform'] = [nil] if @parent.respond_to?(:transform) && !@properties.keys.map(&:to_s).include?('transform')
-          @properties.each do |property, args|
-            method_name = attribute_setter(property)
-            converted_args = apply_property_arg_conversions(method_name, property, args)
-            paint_event.gc.send(method_name, *converted_args)
-            if property == 'transform' && args.first.is_a?(TransformProxy)
-              args.first.swt_transform.dispose
-            end
-          end
-          apply_shape_arg_conversions(@method_name, @args)
-          apply_shape_arg_defaults(@method_name, @args)
-          tolerate_shape_extra_args(@method_name, @args)
-          paint_event.gc.send(@method_name, *@args)
-        end
-    
-      end
-      
-    end
-    
-  end
-  
-end
+# 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/properties'
+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
+        include Packages
+        include Properties
+        # TODO support textExtent sized shapes nested within text/string
+        # TODO support a Pattern DSL for methods that take Pattern arguments
+        
+        class << self
+          def valid?(parent, keyword, *args, &block)
+            gc_instance_methods.include?(method_name(keyword, args))
+          end
+          
+          def gc_instance_methods
+            @gc_instance_methods ||= org.eclipse.swt.graphics.GC.instance_methods.map(&:to_s)
+          end
+          
+          def keywords
+            @keywords ||= gc_instance_methods.select do |method_name|
+              !method_name.end_with?('=') && (method_name.start_with?('draw_') || method_name.start_with?('fill_'))
+            end.reject do |method_name|
+              gc_instance_methods.include?("#{method_name}=") || gc_instance_methods.include?("set_#{method_name}")
+            end.map do |method_name|
+              method_name.gsub(/(draw|fill|gradient|round)_/, '')
+            end.uniq.compact.to_a
+          end
+          
+          def arg_options(args, extract: false)
+            arg_options_method = extract ? :pop : :last
+            options = args.send(arg_options_method) if args.last.is_a?(Hash)
+            options.nil? ? {} : options.symbolize_keys
+          end
+          
+          def method_name(keyword, args)
+            method_arg_options = arg_options(args)
+            unless flyweight_method_names.keys.include?([keyword, method_arg_options])
+              keyword = keyword.to_s
+              gradient = 'gradient_' if method_arg_options[:gradient]
+              round = 'round_' if method_arg_options[:round]
+              gc_instance_method_name_prefix = !['polyline', 'point', 'image', 'focus'].include?(keyword) && (method_arg_options[:fill] || method_arg_options[:gradient]) ? 'fill_' : 'draw_'
+              flyweight_method_names[[keyword, method_arg_options]] = "#{gc_instance_method_name_prefix}#{gradient}#{round}#{keyword}"
+            end
+            flyweight_method_names[[keyword, method_arg_options]]
+          end
+          
+          def flyweight_method_names
+            @flyweight_method_names ||= {}
+          end
+          
+          def pattern(*args)
+            found_pattern = flyweigh_patterns[args]
+            if found_pattern.nil? || found_pattern.is_disposed
+              found_pattern = flyweigh_patterns[args] = org.eclipse.swt.graphics.Pattern.new(*args)
+            end
+            found_pattern
+          end
+          
+          def flyweigh_patterns
+            @flyweigh_patterns ||= {}
+          end
+        end
+        
+        attr_reader :parent, :name, :args, :options, :paint_listener_proxy
+        
+        def initialize(parent, keyword, *args, &property_block)
+          @parent = parent
+          @name = keyword
+          @method_name = self.class.method_name(keyword, args)
+          @options = self.class.arg_options(args, extract: true)
+          @args = args
+          @properties = {}
+          @parent.shapes << self
+          post_add_content if property_block.nil?
+        end
+        
+        def draw?
+          !fill?
+        end
+        
+        def fill?
+          @options[:fill]
+        end
+        
+        def gradient?
+          @options[:gradient]
+        end
+        
+        def round?
+          @options[:round]
+        end
+        
+        def has_some_background?
+          @properties.keys.map(&:to_s).include?('background') || @properties.keys.map(&:to_s).include?('background_pattern')
+        end
+        
+        def has_some_foreground?
+          @properties.keys.map(&:to_s).include?('foreground') || @properties.keys.map(&:to_s).include?('foreground_pattern')
+        end
+        
+        def post_add_content
+          amend_method_name_options_based_on_properties
+          setup_painting
+          @content_added = true
+        end
+        
+        def apply_property_arg_conversions(method_name, property, args)
+          args = args.dup
+          the_java_method = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.detect {|m| m.name == method_name}
+          if (args.first.is_a?(Symbol) || args.first.is_a?(String))
+            if the_java_method.parameter_types.first == Color.java_class
+              args[0] = ColorProxy.new(args[0])
+            end
+            if the_java_method.parameter_types.first == Java::int.java_class
+              args[0] = SWTProxy.constant(args[0])
+            end
+          end
+          if args.first.is_a?(ColorProxy)
+            args[0] = args[0].swt_color
+          end
+          if args.first.is_a?(Hash) && the_java_method.parameter_types.first == Font.java_class
+            args[0] = FontProxy.new(args[0])
+          end
+          if args.first.is_a?(FontProxy)
+            args[0] = args[0].swt_font
+          end
+          if args.first.is_a?(TransformProxy)
+            args[0] = args[0].swt_transform
+          end
+          if ['setBackgroundPattern', 'setForegroundPattern'].include?(method_name.to_s)
+            args.each_with_index do |arg, i|
+              if arg.is_a?(Symbol) || arg.is_a?(String)
+                args[i] = ColorProxy.new(arg).swt_color
+              elsif arg.is_a?(ColorProxy)
+                args[i] = arg.swt_color
+              end
+            end
+            new_args = [DisplayProxy.instance.swt_display] + args
+            args[0] = pattern(*new_args, type: method_name.to_s.match(/set(.+)Pattern/)[1])
+            args[1..-1] = []
+          end
+          args
+        end
+        
+        def apply_shape_arg_conversions(method_name, args)
+          if args.size > 1 && (method_name.include?('polygon') || method_name.include?('polyline'))
+            args[0] = args.dup
+            args[1..-1] = []
+          end
+        end
+        
+        def apply_shape_arg_defaults(method_name, args)
+          if method_name.include?('round_rectangle') && args.size.between?(4, 5)
+            (6 - args.size).times {args << 60}
+          elsif method_name.include?('rectangle') && gradient? && args.size == 4
+            args << true
+          elsif (method_name.include?('text') || method_name.include?('string')) && !@properties.keys.map(&:to_s).include?('background') && args.size == 3
+            args << true
+          end
+          if method_name.include?('image') && args.first.is_a?(String)
+            args[0] = ImageProxy.new(args[0])
+          end
+          if method_name.include?('image') && args.first.is_a?(ImageProxy)
+            @image = args[0] = args[0].swt_image
+          end
+        end
+                
+        # Tolerates shape extra args added by user by mistake
+        # (e.g. happens when switching from round rectangle to a standard one without removing all extra args)
+        def tolerate_shape_extra_args(method_name, args)
+          the_java_method_arg_count = org.eclipse.swt.graphics.GC.java_class.declared_instance_methods.select do |m|
+            m.name == method_name.camelcase(:lower)
+          end.map(&:parameter_types).map(&:size).max
+          if args.size > the_java_method_arg_count
+            args[the_java_method_arg_count..-1] = []
+          end
+        end
+        
+        def amend_method_name_options_based_on_properties
+          if has_some_background? && !has_some_foreground?
+            @options[:fill] = true
+          elsif !has_some_background? && has_some_foreground?
+            @options[:fill] = false
+          elsif @name == 'rectangle' && has_some_background? && has_some_foreground?
+            @options[:fill] = true
+            @options[:gradient] = true
+          end
+          if @name == 'rectangle' && @args.size > 4 && @args.last.is_a?(Numeric)
+            @options[:round] = true
+          end
+          @method_name = self.class.method_name(@name, @args + [@options])
+        end
+                
+        def has_attribute?(attribute_name, *args)
+          self.class.gc_instance_methods.include?(attribute_setter(attribute_name))
+        end
+  
+        def set_attribute(attribute_name, *args)
+          @properties[attribute_name] = args
+          if @content_added && !@parent.is_disposed
+            @parent.resetup_shape_painting
+            @parent.redraw
+          end
+        end
+        
+        def get_attribute(attribute_name)
+          @properties.symbolize_keys[attribute_name.to_s.to_sym]
+        end
+        
+        def pattern(*args, type: nil)
+          instance_variable_name = "@#{type}_pattern"
+          the_pattern = instance_variable_get(instance_variable_name)
+          if the_pattern.nil?
+            the_pattern = self.class.pattern(*args)
+          end
+          the_pattern
+        end
+        
+        def dispose
+          paint_listener_proxy&.unregister
+          @background_pattern&.dispose
+          @background_pattern = nil
+          @foreground_pattern&.dispose
+          @foreground_pattern = nil
+          @image&.dispose
+          @image = nil
+          @parent.shapes.delete(self)
+        end
+        
+        def setup_painting
+          # TODO consider moving this method to parent (making the logic polymorphic)
+          return if @parent.is_disposed
+          if parent.respond_to?(:swt_display)
+            @paint_listener_proxy = @parent.on_swt_paint(&method(:paint))
+          elsif parent.respond_to?(:swt_image)
+            paint(parent) # treat parent as paint event since you don't do repaints with images, it's a one time deal.
+          elsif parent.respond_to?(:swt_widget)
+            @paint_listener_proxy = @parent.on_paint_control(&method(:paint))
+          end
+        end
+        
+        def paint(paint_event)
+          @properties['background'] = [@parent.background] if fill? && !has_some_background?
+          @properties['foreground'] = [@parent.foreground] if @parent.respond_to?(:foreground) && draw? && !has_some_foreground?
+          @properties['font'] = [@parent.font] if @parent.respond_to?(:font) && draw? && !@properties.keys.map(&:to_s).include?('font')
+          @properties['transform'] = [nil] if @parent.respond_to?(:transform) && !@properties.keys.map(&:to_s).include?('transform')
+          @properties.each do |property, args|
+            method_name = attribute_setter(property)
+            converted_args = apply_property_arg_conversions(method_name, property, args)
+            paint_event.gc.send(method_name, *converted_args)
+            if property == 'transform' && args.first.is_a?(TransformProxy)
+              args.first.swt_transform.dispose
+            end
+          end
+          apply_shape_arg_conversions(@method_name, @args)
+          apply_shape_arg_defaults(@method_name, @args)
+          tolerate_shape_extra_args(@method_name, @args)
+          paint_event.gc.send(@method_name, *@args)
+        end
+    
+      end
+      
+    end
+    
+  end
+  
+end