glimmer-dsl-swt 4.18.4.4 → 4.18.4.9

data/lib/glimmer/swt/color_proxy.rb

@@ -1,107 +1,108 @@
-# 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/display_proxy'
-
-module Glimmer
-  module SWT
-    # Proxy for org.eclipse.swt.graphics.Color
-    #
-    # Invoking `#swt_color` returns the SWT Color object wrapped by this proxy
-    #
-    # Follows the Proxy Design Pattern and Flyweight Design Pattern (caching memoization)
-    class ColorProxy
-      include_package 'org.eclipse.swt.graphics'
-      
-      class << self
-        def flyweight(*args)
-          flyweight_color_proxies[args] ||= new(*args)
-        end
-        
-        # Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.
-        def flyweight_color_proxies
-          @flyweight_color_proxies ||= {}
-        end
-      end
-
-      # Initializes a proxy for an SWT Color object
-      #
-      # Takes a standard color single argument, rgba 3 args, or rgba 4 args
-      #
-      # A standard color is a string/symbol representing one of the
-      # SWT.COLOR_*** constants like SWT.COLOR_RED, but in underscored string
-      # format (e.g :color_red).
-      # Glimmer can also accept standard color names without the color_ prefix,
-      # and it will automatically figure out the SWT.COLOR_*** constant
-      # (e.g. :red)
-      #
-      # rgb is 3 arguments representing Red, Green, Blue numeric values
-      #
-      # rgba is 4 arguments representing Red, Green, Blue, and Alpha numeric values
-      #
-      def initialize(*args)
-        @args = args
-        ensure_arg_values_within_valid_bounds
-      end
-
-      def swt_color
-        unless @swt_color
-          case @args.size
-          when 1
-            if @args.first.is_a?(String) || @args.first.is_a?(Symbol)
-              standard_color = @args.first
-              standard_color = "color_#{standard_color}".to_sym unless standard_color.to_s.downcase.include?('color_')
-              @swt_color = DisplayProxy.instance.swt_display.getSystemColor(SWTProxy[standard_color])
-            else
-              @swt_color = @args.first
-            end
-          when 3..4
-            red, green, blue, alpha = @args
-            @swt_color = Color.new(*[red, green, blue, alpha].compact)
-          end
-        end
-        @swt_color
-      end
-      
-      def method_missing(method, *args, &block)
-        swt_color.send(method, *args, &block)
-      rescue => e
-        Glimmer::Config.logger.debug {"Neither ColorProxy nor #{swt_color.class.name} can handle the method ##{method}"}
-        super
-      end
-      
-      def respond_to?(method, *args, &block)
-        super || swt_color.respond_to?(method, *args, &block)
-      end
-      
-      private
-      
-      def ensure_arg_values_within_valid_bounds
-        if @args.to_a.size >= 3
-          @args = @args.map do |value|
-            [[value, 255].min, 0].max
-          end
-        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/swt_proxy'
+require 'glimmer/swt/display_proxy'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.graphics.Color
+    #
+    # Invoking `#swt_color` returns the SWT Color object wrapped by this proxy
+    #
+    # Follows the Proxy Design Pattern and Flyweight Design Pattern (caching memoization)
+    class ColorProxy
+      include_package 'org.eclipse.swt.graphics'
+      
+      class << self
+        def flyweight(*args)
+          flyweight_color_proxies[args] ||= new(*args)
+        end
+        
+        # Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.
+        def flyweight_color_proxies
+          @flyweight_color_proxies ||= {}
+        end
+      end
+
+      # Initializes a proxy for an SWT Color object
+      #
+      # Takes a standard color single argument, rgba 3 args, or rgba 4 args
+      #
+      # A standard color is a string/symbol representing one of the
+      # SWT.COLOR_*** constants like SWT.COLOR_RED, but in underscored string
+      # format (e.g :color_red).
+      # Glimmer can also accept standard color names without the color_ prefix,
+      # and it will automatically figure out the SWT.COLOR_*** constant
+      # (e.g. :red)
+      #
+      # rgb is 3 arguments representing Red, Green, Blue numeric values
+      #
+      # rgba is 4 arguments representing Red, Green, Blue, and Alpha numeric values
+      #
+      def initialize(*args)
+        @options = args.last.is_a?(Hash) ? args.pop : {}
+        @args = args
+        @args = @args.first if @args.first.is_a?(Array)
+        ensure_arg_values_within_valid_bounds unless @options[:ensure_bounds] == false
+      end
+
+      def swt_color
+        unless @swt_color
+          case @args.size
+          when 1
+            if @args.first.is_a?(String) || @args.first.is_a?(Symbol)
+              standard_color = @args.first
+              standard_color = "color_#{standard_color}".to_sym unless standard_color.to_s.downcase.include?('color_')
+              @swt_color = DisplayProxy.instance.swt_display.getSystemColor(SWTProxy[standard_color])
+            else
+              @swt_color = @args.first
+            end
+          when 3..4
+            @swt_color = Color.new(*@args)
+          end
+        end
+        @swt_color
+      end
+      
+      def method_missing(method, *args, &block)
+        swt_color.send(method, *args, &block)
+      rescue => e
+        Glimmer::Config.logger.debug {"Neither ColorProxy nor #{swt_color.class.name} can handle the method ##{method}"}
+        super
+      end
+      
+      def respond_to?(method, *args, &block)
+        super || swt_color.respond_to?(method, *args, &block)
+      end
+      
+      private
+      
+      def ensure_arg_values_within_valid_bounds
+        if @args.to_a.size >= 3
+          @args = @args.map do |value|
+            [[value, 255].min, 0].max
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/cursor_proxy.rb

@@ -1,66 +1,66 @@
-# 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/error'
-require 'glimmer/swt/swt_proxy'
-require 'glimmer/swt/display_proxy'
-
-module Glimmer
-  module SWT
-    # Proxy for org.eclipse.swt.graphics.Cursor
-    #
-    # Invoking `#swt_cursor` returns the SWT Cursor object wrapped by this proxy
-    #
-    # Follows the Proxy Design Pattern
-    class CursorProxy
-      CURSOR_STYLES = org.eclipse.swt.SWT.constants.select {|c| c.to_s.downcase.start_with?('cursor_')}.map {|c| c.to_s.downcase.sub('cursor_', '').to_sym}
-      ERROR_INVALID_CURSOR_STYLE = " is an invalid cursor style! Valid values are #{CURSOR_STYLES.map(&:to_s).join(", ")}"
-
-      include_package 'org.eclipse.swt.graphics'
-
-      attr_reader :swt_cursor, :cursor_style
-
-      # Builds a new CursorProxy from passed in cursor SWT style (e.g. :appstarting, :hand, or :help)
-      #
-      # Cursor SWT styles are those that begin with "CURSOR_" prefix
-      #
-      # They are expected to be passed in in short form without the prefix (but would work with the prefix too)
-      def initialize(cursor_style)
-        @cursor_style = cursor_style
-        @cursor_style = SWTProxy.reverse_lookup(@cursor_style).detect { |symbol| symbol.to_s.downcase.start_with?('cursor_') } if cursor_style.is_a?(Integer)
-        @cursor_style = @cursor_style.to_s.downcase
-        @cursor_style = @cursor_style.sub(/^cursor\_/, '') if @cursor_style.start_with?('cursor_')
-        detect_invalid_cursor_style
-        @swt_cursor = DisplayProxy.instance.swt_display.get_system_cursor(SWTProxy[swt_style])
-      end
-      
-      def swt_style
-        @swt_style ||= @cursor_style.upcase.start_with?('CURSOR_') ? @cursor_style : "CURSOR_#{@cursor_style}"
-      end
-
-      private
-
-      def detect_invalid_cursor_style
-        raise Error, cursor_style.to_s + ERROR_INVALID_CURSOR_STYLE unless CURSOR_STYLES.include?(cursor_style.to_s.downcase.to_sym)
-      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/error'
+require 'glimmer/swt/swt_proxy'
+require 'glimmer/swt/display_proxy'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.graphics.Cursor
+    #
+    # Invoking `#swt_cursor` returns the SWT Cursor object wrapped by this proxy
+    #
+    # Follows the Proxy Design Pattern
+    class CursorProxy
+      CURSOR_STYLES = org.eclipse.swt.SWT.constants.select {|c| c.to_s.downcase.start_with?('cursor_')}.map {|c| c.to_s.downcase.sub('cursor_', '').to_sym}
+      ERROR_INVALID_CURSOR_STYLE = " is an invalid cursor style! Valid values are #{CURSOR_STYLES.map(&:to_s).join(", ")}"
+
+      include_package 'org.eclipse.swt.graphics'
+
+      attr_reader :swt_cursor, :cursor_style
+
+      # Builds a new CursorProxy from passed in cursor SWT style (e.g. :appstarting, :hand, or :help)
+      #
+      # Cursor SWT styles are those that begin with "CURSOR_" prefix
+      #
+      # They are expected to be passed in in short form without the prefix (but would work with the prefix too)
+      def initialize(cursor_style)
+        @cursor_style = cursor_style
+        @cursor_style = SWTProxy.reverse_lookup(@cursor_style).detect { |symbol| symbol.to_s.downcase.start_with?('cursor_') } if cursor_style.is_a?(Integer)
+        @cursor_style = @cursor_style.to_s.downcase
+        @cursor_style = @cursor_style.sub(/^cursor\_/, '') if @cursor_style.start_with?('cursor_')
+        detect_invalid_cursor_style
+        @swt_cursor = DisplayProxy.instance.swt_display.get_system_cursor(SWTProxy[swt_style])
+      end
+      
+      def swt_style
+        @swt_style ||= @cursor_style.upcase.start_with?('CURSOR_') ? @cursor_style : "CURSOR_#{@cursor_style}"
+      end
+
+      private
+
+      def detect_invalid_cursor_style
+        raise Error, cursor_style.to_s + ERROR_INVALID_CURSOR_STYLE unless CURSOR_STYLES.include?(cursor_style.to_s.downcase.to_sym)
+      end
+    end
+  end
+end

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

@@ -1,243 +1,245 @@
-# 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
+# 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
+        
+        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
+          @parent.requires_shape_disposal = true
+          @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
+          if @dispose_listener_registration.nil?
+            @dispose_listener_registration = @parent.on_widget_disposed { stop }
+            start if started?
+          end
+        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?
+              unless @parent.isDisposed
+                @parent.clear_shapes # TODO adjust this to clear only the shapes of this animation (not all shapes) to allow simultaneous animations to occur on the same parent
+                @parent.content { frame_block.call(*block_args) }
+              end
+            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