glimmer-dsl-swt 0.1.0 → 0.2.1

data/lib/glimmer/swt/packages.rb

@@ -1,13 +1,16 @@
+require 'ext/glimmer/config'
+
 module Glimmer
   module SWT
     # This contains Java imports of SWT Java packages
     module Packages
-      include_package 'org.eclipse.swt'
-      include_package 'org.eclipse.swt.widgets'
-      include_package 'org.eclipse.swt.layout'
-      include_package 'org.eclipse.swt.graphics'
-      include_package 'org.eclipse.swt.browser'
-      include_package 'org.eclipse.swt.custom'
+      class << self
+        def included(klass)
+          Glimmer::Config.import_swt_packages.to_a.each do |package|
+            include_package(package) if package.is_a?(String)
+          end
+        end    
+      end
     end
   end
 end

data/lib/glimmer/swt/style_constantizable.rb

@@ -0,0 +1,120 @@
+require 'glimmer/error'
+
+module Glimmer
+  module SWT
+    # Mixin for all proxy classes that manage style constants (e.g. SWT, DND, etc...)
+    module StyleConstantizable
+      include SuperModule
+      
+      class << self
+        REGEX_SYMBOL_NEGATIVITY = /^([^!]+)(!)?$/
+      
+        def constant_java_import
+          raise 'Not implemented! Mixer must implement!'
+        end
+ 
+        def constant_source_class
+          raise 'Not implemented! Mixer must implement!'
+        end
+ 
+        def constant_value_none
+          raise 'Not implemented! Mixer must implement!'
+        end
+        
+        # hash of extra styles (i.e. new style combinations)
+        def extra_styles
+          raise 'Not implemented! Mixer must implement!'
+        end
+                
+        def error_message_invalid_style
+          " is an invalid #{constant_source_class.name.split(':').last} style! Please choose a style from #{constant_java_import} class constants." # TODO parameterize
+        end
+
+        # Gets constants (e.g. SWT::CONSTANT) where constant is
+        # passed in as a lower case symbol
+        def [](*symbols)
+          symbols = symbols.first if symbols.size == 1 && symbols.first.is_a?(Array)
+          result = symbols.compact.map do |symbol|
+            constant(symbol).tap do |constant_value|
+              raise Glimmer::Error, symbol.to_s + error_message_invalid_style unless constant_value.is_a?(Integer)
+            end
+          end.reduce do |output, constant_value|
+            if constant_value < 0
+              output & constant_value
+            else
+              output | constant_value
+            end
+          end
+          result.nil? ? constant_value_none : result
+        end
+
+        # Returns style integer value for passed in symbol or allows
+        # passed in object to pass through (e.g. Integer). This makes is convenient
+        # to use symbols or actual style integers in Glimmer
+        # Does not raise error for invalid values. Just lets them pass as is.
+        # (look into [] operator if you want an error raised on invalid values)
+        def constant(symbol)
+          return symbol unless symbol.is_a?(Symbol) || symbol.is_a?(String)
+          symbol_string, negative = extract_symbol_string_negativity(symbol)
+          swt_constant_symbol = symbol_string.downcase == symbol_string ? symbol_string.upcase.to_sym : symbol_string.to_sym
+          bit_value = constant_source_class.const_get(swt_constant_symbol)
+          negative ? ~bit_value : bit_value
+        rescue => e
+          begin
+#             Glimmer::Config.logger&.debug(e.full_message)
+            alternative_swt_constant_symbol = constant_source_class.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s.upcase}
+            bit_value = constant_source_class.const_get(alternative_swt_constant_symbol)
+            negative ? ~bit_value : bit_value
+          rescue => e
+#             Glimmer::Config.logger&.debug(e.full_message)
+            bit_value = extra_styles[swt_constant_symbol]
+            if bit_value
+              negative ? ~bit_value : bit_value
+            else
+              symbol
+            end
+          end
+        end
+
+        def extract_symbol_string_negativity(symbol)
+          if symbol.is_a?(Symbol) || symbol.is_a?(String)
+            symbol_negativity_match = symbol.to_s.match(REGEX_SYMBOL_NEGATIVITY)
+            symbol = symbol_negativity_match[1]
+            negative = !!symbol_negativity_match[2]
+            [symbol, negative]
+          else
+            negative = symbol < 0
+            [symbol, negative]
+          end
+         end
+
+        def negative?(symbol)
+          extract_symbol_string_negativity(symbol)[1]
+        end
+
+        def has_constant?(symbol)
+          return false unless symbol.is_a?(Symbol) || symbol.is_a?(String)
+          constant(symbol).is_a?(Integer)
+        end
+
+        def constantify_args(args)
+          args.map {|arg| constant(arg)}
+        end
+
+        # Deconstructs a style integer into symbols
+        # Useful for debugging
+        def deconstruct(integer)
+          constant_source_class.constants.reduce([]) do |found, c|
+            constant_value = constant_source_class.const_get(c) rescue -1
+            is_found = constant_value.is_a?(Integer) && (constant_value & integer) == constant_value
+            is_found ? found += [c] : found
+          end
+        end
+
+        def include?(swt_constant, *symbols)
+          swt_constant & self[symbols] == self[symbols]
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/swt_proxy.rb

@@ -1,106 +1,38 @@
-require 'glimmer/error'
+require 'glimmer/swt/style_constantizable'
 
 module Glimmer
-  module SWT # TODO Consider making this the class below to ease calling it
+  module SWT
     # Proxy for org.eclipse.swt.SWT
     #
     # Follows the Proxy Design Pattern
-    class SWTProxy
-      class << self
-        java_import 'org.eclipse.swt.SWT'
-
-        ERROR_INVALID_STYLE = " is an invalid SWT style! Please choose a style from org.eclipse.swt.SWT class constants."
-        REGEX_SYMBOL_NEGATIVITY = /^([^!]+)(!)?$/
-
-        # Gets SWT constants as if calling SWT::CONSTANT where constant is
-        # passed in as a lower case symbol
-        def [](*symbols)
-          symbols = symbols.first if symbols.size == 1 && symbols.first.is_a?(Array)
-          result = symbols.compact.map do |symbol|
-            constant(symbol).tap do |constant_value|
-              raise Error, symbol.to_s + ERROR_INVALID_STYLE unless constant_value.is_a?(Integer)
-            end
-          end.reduce do |output, constant_value|
-            if constant_value < 0
-              output & constant_value
-            else
-              output | constant_value
-            end
-          end
-          result.nil? ? SWT::NONE : result
-        end
-
-        # Returns SWT style integer value for passed in symbol or allows
-        # passed in object to pass through (e.g. Integer). This makes is convenient
-        # to use symbols or actual SWT style integers in Glimmer
-        # Does not raise error for invalid values. Just lets them pass as is.
-        # (look into [] operator if you want an error raised on invalid values)
-        def constant(symbol)
-          return symbol unless symbol.is_a?(Symbol) || symbol.is_a?(String)
-          symbol_string, negative = extract_symbol_string_negativity(symbol)
-          swt_constant_symbol = symbol_string.downcase == symbol_string ? symbol_string.upcase.to_sym : symbol_string.to_sym
-          bit_value = SWT.const_get(swt_constant_symbol)
-          negative ? ~bit_value : bit_value
-        rescue => e
-          begin
-#             Glimmer::Config.logger&.debug(e.full_message)
-            alternative_swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s.upcase}
-            bit_value = SWT.const_get(alternative_swt_constant_symbol)
-            negative ? ~bit_value : bit_value
-          rescue => e
-#             Glimmer::Config.logger&.debug(e.full_message)
-            bit_value = Glimmer::SWT::SWTProxy::EXTRA_STYLES[swt_constant_symbol]
-            if bit_value
-              negative ? ~bit_value : bit_value
-            else
-              symbol
-            end
-          end
-        end
+    class SWTProxy            
+      include StyleConstantizable      
 
-        def extract_symbol_string_negativity(symbol)
-          if symbol.is_a?(Symbol) || symbol.is_a?(String)
-            symbol_negativity_match = symbol.to_s.match(REGEX_SYMBOL_NEGATIVITY)
-            symbol = symbol_negativity_match[1]
-            negative = !!symbol_negativity_match[2]
-            [symbol, negative]
-          else
-            negative = symbol < 0
-            [symbol, negative]
-          end
-         end
-
-        def negative?(symbol)
-          extract_symbol_string_negativity(symbol)[1]
-        end
-
-        def has_constant?(symbol)
-          return false unless symbol.is_a?(Symbol) || symbol.is_a?(String)
-          constant(symbol).is_a?(Integer)
+      class << self
+        JAVA_IMPORT = 'org.eclipse.swt.SWT'
+        
+        java_import JAVA_IMPORT
+        
+        def constant_java_import 
+          JAVA_IMPORT
         end
 
-        def constantify_args(args)
-          args.map {|arg| constant(arg)}
+        def constant_source_class
+          SWT
         end
 
-        # Deconstructs a style integer into symbols
-        # Useful for debugging
-        def deconstruct(integer)
-          SWT.constants.reduce([]) do |found, c|
-            constant_value = SWT.const_get(c) rescue -1
-            is_found = constant_value.is_a?(Integer) && (constant_value & integer) == constant_value
-            is_found ? found += [c] : found
-          end
+        def constant_value_none
+          SWT::NONE
         end
-
-        def include?(swt_constant, *symbols)
-          swt_constant & self[symbols] == self[symbols]
+        
+        def extra_styles
+          EXTRA_STYLES
         end
       end
-
+      
       EXTRA_STYLES = {
         NO_RESIZE: self[:shell_trim, :resize!, :max!]
-      }
+      }            
     end
   end
 end

data/lib/glimmer/swt/table_proxy.rb

@@ -68,6 +68,21 @@ module Glimmer
         })
       end
       
+      # Indicates if table is in edit mode, thus displaying a text widget for a table item cell
+      def edit_mode?
+        !!@edit_mode
+      end
+      
+      def cancel_edit!
+        @cancel_edit&.call if @edit_mode
+      end
+
+      def finish_edit!
+        @finish_edit&.call if @edit_mode
+      end
+
+      # Indicates if table is editing a table item because the user hit ENTER or focused out after making a change in edit mode to a table item cell.
+      # It is set to false once change is saved to model
       def edit_in_progress?
         !!@edit_in_progress
       end
@@ -78,24 +93,32 @@ module Glimmer
             
       def edit_table_item(table_item, column_index, before_write: nil, after_write: nil, after_cancel: nil)
         return if table_item.nil?
+        @cancel_edit&.call if @edit_mode
+        @edit_mode = true
         content {
           @table_editor_text_proxy = text {
             focus true
             text table_item.getText(column_index)
             action_taken = false
-            cancel = lambda {
-              @table_editor_text_proxy.swt_widget.dispose
+            @cancel_edit = lambda do
+              @cancel_in_progress = true
+              @table_editor_text_proxy&.swt_widget&.dispose
               @table_editor_text_proxy = nil
               after_cancel&.call
               @edit_in_progress = false
-            }
-            action = lambda { |event|
-              if !action_taken && !@edit_in_progress
+              @cancel_in_progress = false
+              @cancel_edit = nil
+              @edit_mode = false
+            end
+            @finish_edit = lambda do |event=nil|
+              if table_item.isDisposed
+                @cancel_edit.call
+              elsif !action_taken && !@edit_in_progress && !@cancel_in_progress
                 action_taken = true
                 @edit_in_progress = true
                 new_text = @table_editor_text_proxy.swt_widget.getText
                 if new_text == table_item.getText(column_index)
-                  cancel.call
+                  @cancel_edit.call
                 else
                   before_write&.call
                   table_item.setText(column_index, new_text)
@@ -103,19 +126,19 @@ module Glimmer
                   model.send("#{column_properties[column_index]}=", new_text) # makes table update itself, so must search for selected table item again
                   edited_table_item = search { |ti| ti.getData == model }.first
                   swt_widget.showItem(edited_table_item)
-                  @table_editor_text_proxy.swt_widget.dispose
+                  @table_editor_text_proxy&.swt_widget&.dispose
                   @table_editor_text_proxy = nil
                   after_write&.call(edited_table_item)
                   @edit_in_progress = false
                 end
               end
-            }
-            on_focus_lost(&action)
+            end
+            on_focus_lost(&@finish_edit)
             on_key_pressed { |key_event|
               if key_event.keyCode == swt(:cr)
-                action.call(key_event)
+                @finish_edit.call(key_event)
               elsif key_event.keyCode == swt(:esc)
-                cancel.call
+                @cancel_edit.call
               end
             }
           }

data/lib/glimmer/swt/widget_proxy.rb

@@ -1,8 +1,8 @@
-require 'glimmer'
 require 'glimmer/swt/widget_listener_proxy'
 require 'glimmer/swt/color_proxy'
 require 'glimmer/swt/font_proxy'
 require 'glimmer/swt/swt_proxy'
+require 'glimmer/swt/dnd_proxy'
 require 'glimmer/data_binding/observable_widget'
 
 # TODO refactor to make file smaller and extract sub-widget-proxies out of this
@@ -31,6 +31,8 @@ module Glimmer
         "list"        => [:border, :v_scroll],
         "button"      => [:push],
         "menu_item"   => [:push],
+        "drag_source" => [:drop_copy],
+        "drop_target" => [:drop_copy],
       }
 
       DEFAULT_INITIALIZERS = {
@@ -49,7 +51,7 @@ module Glimmer
         end,
       }
 
-      attr_reader :swt_widget
+      attr_reader :swt_widget, :drag_source_proxy, :drop_target_proxy, :drag_source_style, :drag_source_transfer, :drop_target_transfer
 
       # Initializes a new SWT Widget
       #
@@ -73,7 +75,18 @@ module Glimmer
         if @arg_extractor_mapping[underscored_widget_name]
           @arg_extractor_mapping[underscored_widget_name].call(args)
         else
-          [args, []]
+          extra_options = []
+          style_args = args.select {|arg| arg.is_a?(Symbol) || arg.is_a?(String)}
+          if style_args.any?
+            style_arg_start_index = args.index(style_args.first)
+            style_arg_last_index = args.index(style_args.last)
+            extra_options = args[style_arg_last_index+1..-1]
+            args = args[style_arg_start_index..style_arg_last_index]
+          elsif args.first.is_a?(Integer)
+            extra_options = args[1..-1]
+            args = args[0..0]
+          end
+          [args, extra_options]
         end
       end
 
@@ -82,7 +95,7 @@ module Glimmer
         if widget_custom_attribute
           @swt_widget.respond_to?(widget_custom_attribute[:setter][:name])
         else
-          @swt_widget.respond_to?(attribute_setter(attribute_name), args)
+          @swt_widget.respond_to?(attribute_setter(attribute_name), args) || respond_to?(ruby_attribute_setter(attribute_name), args)
         end
       end
 
@@ -90,9 +103,11 @@ module Glimmer
         widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
         if widget_custom_attribute
           widget_custom_attribute[:setter][:invoker].call(@swt_widget, args)
-        else
+        elsif @swt_widget.respond_to?(attribute_setter(attribute_name), args)
           apply_property_type_converters(attribute_name, args)
           @swt_widget.send(attribute_setter(attribute_name), *args) unless @swt_widget.send(attribute_getter(attribute_name)) == args.first
+        else
+          send(ruby_attribute_setter(attribute_name), args)
         end
       end
 
@@ -252,7 +267,12 @@ module Glimmer
       end
 
       def has_style?(style)
-        (@swt_widget.style & SWTProxy[style]) == SWTProxy[style]
+        begin
+          comparison = SWTProxy[style]
+        rescue
+          comparison = DNDProxy[style]
+        end
+        (@swt_widget.style & comparison) == comparison
       end
 
       def dispose
@@ -278,6 +298,21 @@ module Glimmer
         # TODO consider implementing if remove_observer is needed (consumers can remove listener via SWT API)
       end
 
+      def ensure_drag_source_proxy(style=[])
+        @drag_source_proxy ||= self.class.new('drag_source', self, style).tap do |proxy|
+          proxy.set_attribute(:transfer, :text)
+        end
+      end
+      
+      def ensure_drop_target_proxy(style=[])
+        @drop_target_proxy ||= self.class.new('drop_target', self, style).tap do |proxy|
+          proxy.set_attribute(:transfer, :text)
+          proxy.on_drag_enter { |event|
+            event.detail = DNDProxy[:drop_copy]
+          }          
+        end
+      end
+      
       # TODO eliminate duplication in the following methods perhaps by relying on exceptions
 
       def can_handle_observation_request?(observation_request)
@@ -287,9 +322,31 @@ module Glimmer
           SWTProxy.has_constant?(constant_name)
         elsif observation_request.start_with?('on_')
           event = observation_request.sub(/^on_/, '')
-          can_add_listener?(event)
-        else
-          false
+          can_add_listener?(event) || can_handle_drag_observation_request?(observation_request) || can_handle_drop_observation_request?(observation_request)
+        end
+      end
+      
+      def can_handle_drag_observation_request?(observation_request)
+        return false unless swt_widget.is_a?(Control)
+        potential_drag_source = @drag_source_proxy.nil?
+        ensure_drag_source_proxy
+        @drag_source_proxy.can_handle_observation_request?(observation_request).tap do |result|
+          if potential_drag_source && !result
+            @drag_source_proxy.swt_widget.dispose
+            @drag_source_proxy = nil
+          end
+        end
+      end
+
+      def can_handle_drop_observation_request?(observation_request)
+        return false unless swt_widget.is_a?(Control)
+        potential_drop_target = @drop_target_proxy.nil?
+        ensure_drop_target_proxy
+        @drop_target_proxy.can_handle_observation_request?(observation_request).tap do |result|
+          if potential_drop_target && !result
+            @drop_target_proxy.swt_widget.dispose
+            @drop_target_proxy = nil
+          end
         end
       end
 
@@ -299,7 +356,14 @@ module Glimmer
           add_swt_event_listener(constant_name, &block)
         elsif observation_request.start_with?('on_')
           event = observation_request.sub(/^on_/, '')
-          add_listener(event, &block)
+          if can_add_listener?(event)
+            event = observation_request.sub(/^on_/, '')
+            add_listener(event, &block)
+          elsif can_handle_drag_observation_request?(observation_request)
+            @drag_source_proxy&.handle_observation_request(observation_request, &block)
+          elsif can_handle_drop_observation_request?(observation_request)
+            @drop_target_proxy&.handle_observation_request(observation_request, &block)
+          end
         end
       end
 
@@ -311,12 +375,24 @@ module Glimmer
 
       def style(underscored_widget_name, styles)
         styles = [styles].flatten.compact
-        styles.empty? ? default_style(underscored_widget_name) : SWTProxy[*styles]
+        if styles.empty?
+          default_style(underscored_widget_name) 
+        else         
+          begin
+            SWTProxy[*styles]
+          rescue
+            DNDProxy[*styles]
+          end
+        end
       end
 
       def default_style(underscored_widget_name)
         styles = DEFAULT_STYLES[underscored_widget_name] || [:none]
-        SWTProxy[styles]
+        SWTProxy[styles] rescue DNDProxy[styles]
+      end
+
+      def ruby_attribute_setter(attribute_name)
+        "#{attribute_name}="
       end
 
       def attribute_setter(attribute_name)
@@ -340,7 +416,7 @@ module Glimmer
       def add_listener(underscored_listener_name, &block)
         widget_add_listener_method, listener_class, listener_method = self.class.find_listener(@swt_widget.getClass, underscored_listener_name)        
         widget_listener_proxy = nil
-        safe_block = lambda { |event| block.call(event) unless @swt_widget.isDisposed }
+        safe_block = lambda { |event| block.call(event) unless @swt_widget.isDisposed }        
         listener = listener_class.new(listener_method => safe_block)
         @swt_widget.send(widget_add_listener_method, listener)
         widget_listener_proxy = WidgetListenerProxy.new(swt_widget: @swt_widget, swt_listener: listener, widget_add_listener_method: widget_add_listener_method, swt_listener_class: listener_class, swt_listener_method: listener_method)
@@ -417,6 +493,38 @@ module Glimmer
         }
       end
 
+      def drag_source_style=(style)
+        ensure_drag_source_proxy(style)
+      end
+
+      def drop_target_style=(style)
+        ensure_drop_target_proxy(style)
+      end
+
+      def drag_source_transfer=(args)
+        args = args.first if !args.empty? && args.first.is_a?(ArrayJavaProxy)
+        ensure_drag_source_proxy
+        @drag_source_proxy.set_attribute(:transfer, args)
+      end
+
+      def drop_target_transfer=(args)
+        args = args.first if !args.empty? && args.first.is_a?(ArrayJavaProxy)
+        ensure_drop_target_proxy
+        @drop_target_proxy.set_attribute(:transfer, args)
+      end
+
+      def drag_source_effect=(args)
+        args = args.first if args.is_a?(Array)
+        ensure_drag_source_proxy
+        @drag_source_proxy.set_attribute(:drag_source_effect, args)
+      end
+
+      def drop_target_effect=(args)
+        args = args.first if args.is_a?(Array)
+        ensure_drop_target_proxy
+        @drop_target_proxy.set_attribute(:drop_target_effect, args)
+      end
+
       def apply_property_type_converters(attribute_name, args)
         if args.count == 1
           value = args.first
@@ -479,6 +587,25 @@ module Glimmer
               value.to_s
             end
           end,
+          :transfer => lambda do |value|
+            value = value.first if value.is_a?(Array) && value.size == 1 && value.first.is_a?(Array)
+            transfer_object_extrapolator = lambda do |transfer_name|
+              transfer_type = "#{transfer_name.to_s.camelcase(:upper)}Transfer".to_sym
+              transfer_type_alternative = "#{transfer_name.to_s.upcase}Transfer".to_sym
+              transfer_class = org.eclipse.swt.dnd.const_get(transfer_type) rescue org.eclipse.swt.dnd.const_get(transfer_type_alternative)
+              transfer_class.getInstance
+            end
+            result = value
+            if value.is_a?(Symbol) || value.is_a?(String)
+              result = [transfer_object_extrapolator.call(value)]
+            elsif value.is_a?(Array)
+              result = value.map do |transfer_name|
+                transfer_object_extrapolator.call(transfer_name)
+              end
+            end
+            result = result.to_java(Transfer) unless result.is_a?(ArrayJavaProxy)
+            result
+          end,
           :visible => lambda do |value|
             !!value
           end,