glimmer-dsl-swt 4.18.4.4 → 4.18.4.5

data/docs/reference/GLIMMER_STYLE_GUIDE.md

@@ -0,0 +1,14 @@
+## Glimmer Style Guide
+
+- Widgets are declared with underscored lowercase versions of their SWT names minus the SWT package name.
+- Widget declarations may optionally have arguments and be followed by a block (to contain properties and content)
+- Widget blocks are always declared with curly braces
+- Widget arguments are always wrapped inside parentheses
+- Widget properties are declared with underscored lowercase versions of the SWT properties
+- Widget property declarations always have arguments and never take a block
+- Widget property arguments are never wrapped inside parentheses
+- Widget listeners are always declared starting with `on_` prefix and affixing listener event method name afterwards in underscored lowercase form
+- Widget listeners are always followed by a block using curly braces (Only when declared in DSL. When invoked on widget object directly outside of GUI declarations, standard Ruby conventions apply)
+- Data-binding is done via `bind` keyword, which always takes arguments wrapped in parentheses
+- Custom widget body, before_body, and after_body blocks open their blocks and close them with curly braces.
+- Custom widgets receive additional arguments to SWT style called options. These are passed as the last argument inside the parentheses, a hash of option names pointing to values.

data/glimmer-dsl-swt.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-swt 4.18.4.4 ruby lib
+# stub: glimmer-dsl-swt 4.18.4.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-swt".freeze
-  s.version = "4.18.4.4"
+  s.version = "4.18.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -29,6 +29,13 @@ Gem::Specification.new do |s|
     "bin/girb",
     "bin/girb_runner.rb",
     "bin/glimmer",
+    "docs/reference/GLIMMER_COMMAND.md",
+    "docs/reference/GLIMMER_CONFIGURATION.md",
+    "docs/reference/GLIMMER_GIRB.md",
+    "docs/reference/GLIMMER_GUI_DSL_SYNTAX.md",
+    "docs/reference/GLIMMER_PACKAGING_AND_DISTRIBUTION.md",
+    "docs/reference/GLIMMER_SAMPLES.md",
+    "docs/reference/GLIMMER_STYLE_GUIDE.md",
     "glimmer-dsl-swt.gemspec",
     "icons/scaffold_app.icns",
     "icons/scaffold_app.ico",

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

@@ -1,63 +1,63 @@
-# 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'
-require 'glimmer/dsl/expression'
-require 'glimmer/dsl/parent_expression'
-require 'glimmer/dsl/top_level_expression'
-require 'glimmer/ui/custom_widget'
-require 'glimmer/ui/custom_shell'
-require 'glimmer/swt/custom/code_text'
-require 'glimmer/swt/custom/radio_group'
-require 'glimmer/swt/custom/checkbox_group'
-
-module Glimmer
-  module DSL
-    module SWT
-      class CustomWidgetExpression < Expression
-        # TODO Make custom widgets automatically generate static expressions
-        include ParentExpression
-        include TopLevelExpression
-
-        def can_interpret?(parent, keyword, *args, &block)
-          custom_widget_class = UI::CustomWidget.for(keyword)
-          custom_widget_class and
-            (parent.respond_to?(:swt_widget) or
-            custom_widget_class.ancestors.include?(UI::CustomShell))
-        end
-  
-        def interpret(parent, keyword, *args, &block)
-          options = args.last.is_a?(Hash) ? args.pop : {}
-          UI::CustomWidget.for(keyword).new(parent, *args, options, &block)
-        end
-  
-        def add_content(parent, &block)
-          # TODO consider avoiding source_location
-          if block.source_location == parent.content&.__getobj__.source_location
-            parent.content.call(parent) unless parent.content.called?
-          else
-            super
-          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'
+require 'glimmer/dsl/expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/ui/custom_widget'
+require 'glimmer/ui/custom_shell'
+require 'glimmer/swt/custom/code_text'
+require 'glimmer/swt/custom/radio_group'
+require 'glimmer/swt/custom/checkbox_group'
+
+module Glimmer
+  module DSL
+    module SWT
+      class CustomWidgetExpression < Expression
+        # TODO Make custom widgets automatically generate static expressions
+        include ParentExpression
+        include TopLevelExpression
+
+        def can_interpret?(parent, keyword, *args, &block)
+          custom_widget_class = UI::CustomWidget.for(keyword)
+          custom_widget_class and
+            (parent.respond_to?(:swt_widget) or
+            custom_widget_class.ancestors.include?(UI::CustomShell))
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          options = args.last.is_a?(Hash) ? args.pop : {}
+          UI::CustomWidget.for(keyword).new(parent, *args, options, &block)
+        end
+  
+        def add_content(parent, &block)
+          # TODO consider avoiding source_location
+          if block.source_location == parent.content&.__getobj__.source_location
+            parent.content.call(parent) unless parent.content.called?
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# Copyright (c) 2007-2021 Andy Maleh
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'glimmer/dsl/top_level_expression'
-require 'glimmer/swt/display_proxy'
-
-module Glimmer
-  module DSL
-    module SWT
-      # Mixin for common code in async_exec and sync_exec expressions
-      # Uses name in subclass to auto-derive exec_operation
-      module ExecExpression
-        include TopLevelExpression
-
-        def exec_operation
-          @exec_operation ||= self.class.name.split(/::/).last.sub(/Expression$/, '').underscore
-        end
-  
-        def can_interpret?(parent, keyword, *args, &block)
-          keyword == exec_operation and
-            block_given? and
-            args.empty?
-        end
-  
-        def interpret(parent, keyword, *args, &block)
-          Glimmer::SWT::DisplayProxy.instance.swt_display.send(exec_operation) do |*args|
-            begin
-              block.call(*args)
-            rescue => e
-              Glimmer::Config.logger.error {e.full_message}
-            end
-          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/dsl/top_level_expression'
+require 'glimmer/swt/display_proxy'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Mixin for common code in async_exec and sync_exec expressions
+      # Uses name in subclass to auto-derive exec_operation
+      module ExecExpression
+        include TopLevelExpression
+
+        def exec_operation
+          @exec_operation ||= self.class.name.split(/::/).last.sub(/Expression$/, '').underscore
+        end
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == exec_operation and
+            block_given? and
+            args.empty?
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::DisplayProxy.instance.swt_display.send(exec_operation, *args) do |*args|
+            begin
+              block.call(*args)
+            rescue => e
+              Glimmer::Config.logger.error {e.full_message}
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,56 @@
-# Copyright (c) 2007-2021 Andy Maleh
-# 
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-# 
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'glimmer/dsl/static_expression'
-require 'glimmer/dsl/top_level_expression'
-require 'glimmer/data_binding/observer'
-require 'glimmer/data_binding/model_binding'
-
-module Glimmer
-  module DSL
-    module SWT
-      class ObserveExpression < StaticExpression
-        include TopLevelExpression
-
-        REGEX_NESTED_OR_INDEXED_PROPERTY = /([^\[]+)(\[[^\]]+\])?/
-  
-        def can_interpret?(parent, keyword, *args, &block)
-          keyword == 'observe' and
-            block_given? and
-            (args.size == 2) and
-            textual?(args[1])
-        end
-  
-        def interpret(parent, keyword, *args, &block)
-          observer = DataBinding::Observer.proc(&block)
-          if args[1].to_s.match(REGEX_NESTED_OR_INDEXED_PROPERTY)
-            observer.observe(DataBinding::ModelBinding.new(args[0], args[1]))
-          else
-            observer.observe(args[0], args[1])
-          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/dsl/static_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/data_binding/observer'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/ui/custom_widget'
+
+module Glimmer
+  module DSL
+    module SWT
+      class ObserveExpression < StaticExpression
+        include TopLevelExpression
+
+        REGEX_NESTED_OR_INDEXED_PROPERTY = /([^\[]+)(\[[^\]]+\])?/
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'observe' and
+            block_given? and
+            (args.size == 2) and
+            textual?(args[1])
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          observer = DataBinding::Observer.proc(&block)
+          if args[1].to_s.match(REGEX_NESTED_OR_INDEXED_PROPERTY)
+            observer_registration = observer.observe(DataBinding::ModelBinding.new(args[0], args[1]))
+          else
+            observer_registration = observer.observe(args[0], args[1])
+          end
+          Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(observer_registration)
+          observer_registration
+        end
+      end
+    end
+  end
+end

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

@@ -1,243 +1,247 @@
-# 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
+          @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
+                @parent.content {
+                  frame_block.call(*block_args)
+                }
+                @parent.redraw
+              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