glimmer-dsl-swt 4.18.0.2 → 4.18.2.2

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

@@ -0,0 +1,243 @@
+# 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'
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents an animation declaratively
+      class Animation
+        include Properties # TODO rename to Properties
+        
+        class << self
+          def schedule_frame_animation(animation, &frame_animation_block)
+            frame_animation_queue(animation).prepend(frame_animation_block)
+            swt_display.async_exec do
+              frame_animation_queue(next_animation)&.pop&.call
+            end
+          end
+          
+          def next_animation
+            animation = nil
+            while frame_animation_queues.values.reduce(:+)&.any? && (animation.nil? || frame_animation_queue(animation).last.nil?)
+              animation = frame_animation_queues.keys[next_animation_index]
+              frame_animation_queues.delete(animation) if frame_animation_queues.values.reduce(:+)&.any? && !animation.nil? && frame_animation_queue(animation).empty?
+            end
+            animation
+          end
+          
+          def next_animation_index
+            next_schedule_index % frame_animation_queues.keys.size
+          end
+          
+          def next_schedule_index
+            unless defined? @@next_schedule_index
+              @@next_schedule_index = 0
+            else
+              @@next_schedule_index += 1
+            end
+          end
+          
+          def frame_animation_queues
+            unless defined? @@frame_animation_queues
+              @@frame_animation_queues = {}
+            end
+            @@frame_animation_queues
+          end
+          
+          def frame_animation_queue(animation)
+            frame_animation_queues[animation] ||= []
+          end
+          
+          def swt_display
+            unless defined? @@swt_display
+              @@swt_display = DisplayProxy.instance.swt_display
+            end
+            @@swt_display
+          end
+        end
+        
+        attr_reader :parent, :options, :frame_index, :cycle
+        alias current_frame_index frame_index
+        attr_accessor :frame_block, :every, :cycle_count, :frame_count, :started, :duration_limit
+        alias started? started
+        # TODO consider supporting an async: false option
+        
+        def initialize(parent)
+          @parent = parent
+          @started = true
+          @frame_index = 0
+          @cycle_count_index = 0
+          @start_number = 0 # denotes the number of starts (increments on every start)
+          self.class.swt_display # ensures initializing variable to set from GUI thread
+        end
+        
+        def post_add_content
+          @parent.on_widget_disposed { stop }
+          start if started?
+        end
+        
+        # Starts an animation that is indefinite or has never been started before (i.e. having `started: false` option).
+        # Otherwise, resumes a stopped animation that has not been completed.
+        def start
+          return if @start_number > 0 && started?
+          @start_number += 1
+          @started = true
+          @start_time = Time.now
+          @original_start_time = @start_time if @duration.nil?
+          # TODO track when finished in a variable for finite animations (whether by frame count, cycle count, or duration limit)
+          Thread.new do
+            start_number = @start_number
+            if cycle_count.is_a?(Integer) && cycle.is_a?(Array)
+              (cycle_count * cycle.length).times do
+                break unless draw_frame(start_number)
+              end
+            else
+              loop do
+                # this code has to be duplicated to break from a loop (break keyword only works when literally in a loop block)
+                break unless draw_frame(start_number)
+              end
+            end
+          end
+        end
+        
+        def stop
+          return if stopped?
+          @started = false
+          @duration = (Time.now - @start_time) + @duration.to_f if duration_limited? && !@start_time.nil?
+        end
+        
+        # Restarts an animation (whether indefinite or not and whether stopped or not)
+        def restart
+          @original_start_time = @start_time = nil
+          @duration = nil
+          @frame_index = 0
+          @cycle_count_index = 0
+          stop
+          start
+        end
+        
+        def stopped?
+          !started?
+        end
+        
+        def finite?
+          frame_count_limited? || cycle_limited? || duration_limited?
+        end
+        
+        def infinite?
+          !finite?
+        end
+        alias indefinite? infinite?
+        
+        def has_attribute?(attribute_name, *args)
+          respond_to?(ruby_attribute_setter(attribute_name)) && respond_to?(ruby_attribute_getter(attribute_name))
+        end
+  
+        def set_attribute(attribute_name, *args)
+          send(ruby_attribute_setter(attribute_name), *args)
+        end
+  
+        def get_attribute(attribute_name)
+          send(ruby_attribute_getter(attribute_name))
+        end
+        
+        def cycle=(*args)
+          if args.size == 1
+            if args.first.is_a?(Array)
+              @cycle = args.first
+            else
+              @cycle = [args.first]
+            end
+          elsif args.size > 1
+            @cycle = args
+          end
+        end
+        
+        def cycle_enabled?
+          @cycle.is_a?(Array)
+        end
+        
+        def cycle_limited?
+          cycle_enabled? && @cycle_count.is_a?(Integer)
+        end
+        
+        def duration_limited?
+          @duration_limit.is_a?(Integer)
+        end
+        
+        def frame_count_limited?
+          @frame_count.is_a?(Integer)
+        end
+        
+        def surpassed_duration_limit?
+          duration_limited? && ((Time.now - @start_time) > (@duration_limit - @duration.to_f))
+        end
+        
+        def within_duration_limit?
+          !surpassed_duration_limit?
+        end
+        
+        private
+        
+        # Returns true on success of painting a frame and false otherwise
+        def draw_frame(start_number)
+          return false if stopped? ||
+                          start_number != @start_number ||
+                          (frame_count_limited? && @frame_index == @frame_count) ||
+                          (cycle_limited? && @cycle_count_index == @cycle_count) ||
+                          surpassed_duration_limit?
+          block_args = [@frame_index]
+          block_args << @cycle[@frame_index % @cycle.length] if cycle_enabled?
+          current_frame_index = @frame_index
+          current_cycle_count_index = @cycle_count_index
+          self.class.schedule_frame_animation(self) do
+            if started? && start_number == @start_number && within_duration_limit?
+              @parent.clear_shapes
+              @parent.content {
+                frame_block.call(*block_args)
+              }
+              @parent.redraw
+            else
+              if stopped? && @frame_index > current_frame_index
+                @started = false
+                @frame_index = current_frame_index
+                @cycle_count_index = current_cycle_count_index
+              end
+            end
+          end
+          @frame_index += 1
+          @cycle_count_index += 1 if cycle_limited? && (@frame_index % @cycle&.length&.to_i) == 0
+          sleep(every) if every.is_a?(Numeric)
+          true
+        rescue => e
+          Glimmer::Config.logger.error {e}
+          false
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

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

@@ -61,11 +61,12 @@ module Glimmer
         
         before_body {
           @swt_style = swt_style == 0 ? [:border, :multi, :v_scroll, :h_scroll] : swt_style
+          @font_name = display.get_font_list(nil, true).map(&:name).include?('Consolas') ? 'Consolas' : 'Courier'
         }
         
         body {
           styled_text(swt_style) {
-            font name: 'Consolas', height: 15
+            font name: @font_name, height: 15
             foreground rgb(75, 75, 75)
             left_margin 5
             top_margin 5

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

@@ -0,0 +1,43 @@
+# 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.
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents SWT drawable controls (widgets like canvas) and display
+      module Drawable
+        def shapes
+          @shapes ||= []
+        end
+        
+        def clear_shapes
+          shapes.dup.each do |shape|
+            shape.paint_listener_proxy&.unregister
+            shapes.delete(shape)
+          end
+        end
+      end
+      
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,200 @@
+# 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'
+
+module Glimmer
+  module SWT
+    module Custom
+      # Represents a shape (graphics) to be drawn on a control/widget/canvas/display
+      # swt_widget returns the parent (e.g. a `canvas` WidgetProxy), equivalent to `parent.swt_widget`
+      # 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
+            org.eclipse.swt.graphics.GC.instance_methods.map(&:to_s)
+          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)
+            keyword = keyword.to_s
+            gradient = 'gradient_' if arg_options(args)[:gradient]
+            round = 'round_' if arg_options(args)[:round]
+            gc_instance_method_name_prefix = !['polyline', 'point', 'image', 'focus'].include?(keyword) && (arg_options(args)[:fill] || arg_options(args)[:gradient]) ? 'fill_' : 'draw_'
+            "#{gc_instance_method_name_prefix}#{gradient}#{round}#{keyword}"
+          end
+        end
+        
+        attr_reader :parent, :name, :args, :options, :swt_widget, :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
+          @swt_widget = parent.respond_to?(:swt_display) ? parent.swt_display : parent.swt_widget
+          @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
+          event_handler = lambda do |event|
+            @properties['background'] = [@parent.background] if fill? && !@properties.keys.map(&:to_s).include?('background')
+            @properties['foreground'] = [@parent.foreground] if draw? && !@properties.keys.map(&:to_s).include?('foreground')
+            @properties.each do |property, args|
+              method_name = attribute_setter(property)
+              apply_property_arg_conversions(method_name, args)
+              event.gc.send(method_name, *args)
+            end
+            apply_shape_arg_conversions(@method_name, @args)
+            apply_shape_arg_defaults(@method_name, @args)
+            tolerate_shape_extra_args(@method_name, @args)
+            event.gc.send(@method_name, *@args)
+          end
+          if parent.respond_to?(:swt_display)
+            @paint_listener_proxy = @parent.on_swt_paint(&event_handler)
+          else
+            @paint_listener_proxy = @parent.on_paint_control(&event_handler)
+          end
+        end
+        
+        def apply_property_arg_conversions(method_name, args)
+          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 ['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
+        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 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
+        end
+  
+        def get_attribute(attribute_name)
+          @properties.symbolize_keys[attribute_name.to_s.to_sym]
+        end
+    
+      end
+      
+    end
+    
+  end
+  
+end