glimmer 0.4.3 → 0.4.4

data/lib/glimmer/swt/g_shell.rb

@@ -0,0 +1,50 @@
+require_relative 'g_widget'
+require_relative 'g_display'
+
+module Glimmer
+  module SWT
+    class GShell < GWidget
+      WIDTH_MIN = 130
+      HEIGHT_MIN = 0
+
+      include_package 'org.eclipse.swt.layout'
+      include_package 'org.eclipse.swt.widgets'
+
+      attr_reader :display
+
+      # Instantiates shell with same arguments expected by SWT Shell
+      def initialize(*args)
+        if !args.first.is_a?(Display) && !args.first.is_a?(Shell)
+          @display = GDisplay.instance.display
+          args = [@display] + args
+        end
+        args = GSWT.constantify_args(args)
+        @widget = Shell.new(*args)
+        @display ||= @widget.getDisplay
+        @widget.setLayout(FillLayout.new)
+        @widget.setMinimumSize(WIDTH_MIN, HEIGHT_MIN)
+      end
+
+      # Centers shell within screen
+      def center
+        primary_monitor = @display.getPrimaryMonitor()
+        monitor_bounds = primary_monitor.getBounds()
+        shell_bounds = @widget.getBounds()
+        location_x = monitor_bounds.x + (monitor_bounds.width - shell_bounds.width) / 2
+        location_y = monitor_bounds.y + (monitor_bounds.height - shell_bounds.height) / 2
+        @widget.setLocation(location_x, location_y)
+      end
+
+      # Opens shell and starts SWT's UI thread event loop
+      def open
+        @widget.pack
+        center
+        @widget.open
+        until @widget.isDisposed
+          @display.sleep unless @display.readAndDispatch
+        end
+        @display.dispose
+      end
+    end
+  end
+end

data/lib/glimmer/swt/g_swt.rb

@@ -0,0 +1,65 @@
+module Glimmer
+  module SWT #TODO refactor so GSWT and SWT are one and the same
+    class GSWT
+      class << self
+        ERROR_INVALID_STYLE = " is an invalid SWT style! Please choose a style from org.eclipse.swt.SWT class constants."
+        java_import 'org.eclipse.swt.SWT'
+
+        # Gets SWT constants as if calling SWT::CONSTANT where constant is
+        # passed in as a lower case symbol
+        def [](*symbols)
+          symbols.compact.reduce(0) do |output, symbol|
+            constant_value = constant(symbol)
+            if constant_value.is_a?(Integer)
+              output | constant(symbol)
+            else
+              raise symbol.to_s + ERROR_INVALID_STYLE
+            end
+          end
+        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 = symbol.to_s
+          swt_constant_symbol = symbol_string.downcase == symbol_string ? symbol_string.upcase.to_sym : symbol_string.to_sym
+          SWT.const_get(swt_constant_symbol)
+        rescue
+          begin
+            alternative_swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s.upcase}
+            SWT.const_get(alternative_swt_constant_symbol)
+          rescue
+            EXTRA_STYLES[swt_constant_symbol] || symbol
+          end
+        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)
+          SWT.constants.reduce([]) do |found, c|
+            constant_value = SWT.const_get(c) rescue -1
+            is_found = constant_value.is_a?(Integer) && (constant_value & style) == constant_value
+            is_found ? found += [c] : found
+          end
+        end
+      end
+
+      EXTRA_STYLES = {
+        NO_RESIZE: GSWT[:shell_trim] & (~GSWT[:resize]) & (~GSWT[:max])
+      }
+    end
+  end
+end

data/lib/glimmer/swt/g_tab_item_composite.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + "/g_widget_listener"
+require File.dirname(__FILE__) + "/g_runnable"
+
+module Glimmer
+  module SWT
+    class GTabItemComposite < GWidget
+      include_package 'org.eclipse.swt.widgets'
+
+      attr_reader :tab_item
+      def initialize(tab_item, parent, style, &contents)
+        super("composite", parent, style, &contents)
+        @tab_item = tab_item
+        @tab_item.widget.control = self.widget
+      end
+
+      def has_attribute?(attribute_name, *args)
+        if attribute_name.to_s == "text"
+          true
+        else
+          super(attribute_name, *args)
+        end
+      end
+
+      def set_attribute(attribute_name, *args)
+        if attribute_name.to_s == "text"
+          text_value = args[0]
+          @tab_item.widget.text = text_value
+        else
+          super(attribute_name, *args)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/g_widget.rb

@@ -0,0 +1,213 @@
+require_relative 'g_widget_listener'
+require_relative 'g_runnable'
+require_relative 'g_color'
+require_relative 'g_font'
+require_relative 'g_swt'
+require_relative '../parent'
+
+module Glimmer
+  module SWT
+    class GWidget
+      include_package 'org.eclipse.swt'
+      include_package 'org.eclipse.swt.widgets'
+      include_package 'org.eclipse.swt.layout'
+      include_package 'org.eclipse.swt.graphics'
+      include Parent
+
+      attr_reader :widget
+
+      #TODO externalize
+      @@default_styles = {
+        "text" => GSWT[:border],
+        "table" => GSWT[:border],
+        "spinner" => GSWT[:border],
+        "list" => GSWT[:border, :v_scroll],
+        "button" => GSWT[:push],
+      }
+
+      #TODO externalize
+      @@default_initializers = {
+        "composite" => Proc.new {|composite| composite.setLayout(GridLayout.new) },
+        "table" => Proc.new do |table|
+          table.setHeaderVisible(true)
+          table.setLinesVisible(true)
+        end,
+        "table_column" => Proc.new { |table_column| table_column.setWidth(80) },
+        "group" => Proc.new {|group| group.setLayout(GridLayout.new) },
+      }
+
+      #styles is a comma separate list of symbols representing SWT styles in lower case
+      def initialize(underscored_widget_name, parent, styles, &contents)
+        @widget = self.class.swt_widget_class_for(underscored_widget_name).new(parent, style(underscored_widget_name, styles))
+        @@default_initializers[underscored_widget_name].call(@widget) if @@default_initializers[underscored_widget_name]
+      end
+
+      def has_style?(swt_style)
+        pd(pd(@widget.getStyle) & swt_style) == pd(swt_style)
+      end
+
+      def has_attribute?(attribute_name, *args)
+        @widget.respond_to?(attribute_setter(attribute_name), args)
+      end
+
+      def set_attribute(attribute_name, *args)
+        apply_property_type_converters(attribute_name, args)
+        @widget.send(attribute_setter(attribute_name), *args)
+      end
+
+      def property_type_converters
+        color_converter = Proc.new do |value|
+          if value.is_a?(Symbol) || value.is_a?(String)
+            GColor.color_for(widget.getDisplay, value)
+          else
+            value
+          end
+        end
+        @property_type_converters ||= {
+          :text => Proc.new { |value| value.to_s },
+          :items => Proc.new { |value| value.to_java :string},
+          :visible => Proc.new { |value| !!value},
+          :background => color_converter,
+          :foreground => color_converter,
+          :font => Proc.new do |value|
+            if value.is_a?(Hash)
+              font_properties = value
+              GFont.for(self).font(font_properties)
+            else
+              value
+            end
+          end,
+        }
+      end
+
+      def apply_property_type_converters(attribute_name, args)
+        if args.count == 1
+          value = args.first
+          converter = property_type_converters[attribute_name.to_sym]
+          args[0] = converter.call(value) if converter
+        end
+        if args.count == 1 && args.first.is_a?(GColor)
+          g_color = args.first
+          g_color.display = widget.display if g_color.display.nil? || g_color.display != widget.display
+          args[0] = g_color.color
+        end
+      end
+
+      def self.widget_exists?(underscored_widget_name)
+        !!swt_widget_class_for(underscored_widget_name)
+      end
+
+      # This supports widgets in and out of basic SWT
+      def self.swt_widget_class_for(underscored_widget_name)
+        swt_widget_name = underscored_widget_name.camelcase(:upper)
+        swt_widget_class = eval(swt_widget_name)
+        unless swt_widget_class.ancestors.include?(org.eclipse.swt.widgets.Widget)
+          Glimmer.logger.debug("Class #{swt_widget_class} matching #{underscored_widget_name} is not a subclass of org.eclipse.swt.widgets.Widget")
+          return nil
+        end
+        swt_widget_class
+      rescue NameError => e
+        Glimmer.logger.debug("#{e.message}\n#{e.backtrace.join("\n")}")
+        nil
+      rescue => e
+        Glimmer.logger.debug("#{e.message}\n#{e.backtrace.join("\n")}")
+        nil
+      end
+
+      def widget_listener_exists?(underscored_listener_name)
+        listener_method_name = underscored_listener_name.listener_method_name(:lower)
+        @widget.getClass.getMethods.each do |widget_method|
+          if widget_method.getName.match(/add.*Listener/)
+            widget_method.getParameterTypes.each do |listener_type|
+              listener_type.getMethods.each do |listener_method|
+                if (listener_method.getName == listener_method_name)
+                  return true
+                end
+              end
+            end
+          end
+        end
+        return false
+      end
+
+      def can_add_listener?(underscored_listener_name)
+        listener_method_name = underscored_listener_name.camelcase(:lower)
+        @widget.getClass.getMethods.each do |widget_method|
+          if widget_method.getName.match(/add.*Listener/)
+            widget_method.getParameterTypes.each do |listener_type|
+              listener_type.getMethods.each do |listener_method|
+                if (listener_method.getName == listener_method_name)
+                  return true
+                end
+              end
+            end
+          end
+        end
+        return false
+      end
+
+      def add_listener(underscored_listener_name, &block)
+        listener_method_name = underscored_listener_name.camelcase(:lower)
+        @widget.getClass.getMethods.each do |widget_method|
+          if widget_method.getName.match(/add.*Listener/)
+            widget_method.getParameterTypes.each do |listener_type|
+              listener_type.getMethods.each do |listener_method|
+                if (listener_method.getName == listener_method_name)
+                  listener_class = Class.new(Object)
+                  listener_class.send :include, (eval listener_type.to_s.sub("interface", ""))
+                  listener = listener_class.new
+                  listener_type.getMethods.each do |t_method|
+                    eval "def listener.#{t_method.getName}(event) end"
+                  end
+                  def listener.block=(block)
+                    @block = block
+                  end
+                  listener.block=block
+                  eval "def listener.#{listener_method.getName}(event) @block.call(event) if @block end"
+                  @widget.send(widget_method.getName, listener)
+                  return GWidgetListener.new(listener)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def process_block(block)
+        block.call(@widget)
+      end
+
+      def async_exec(&block)
+        @widget.getDisplay.asyncExec(GRunnable.new(&block))
+      end
+
+      def sync_exec(&block)
+        @widget.getDisplay.syncExec(GRunnable.new(&block))
+      end
+
+      def has_style?(style)
+        (widget.style & GSWT[style]) == GSWT[style]
+      end
+
+      def dispose
+        @widget.dispose
+      end
+
+      private
+
+      def style(underscored_widget_name, styles)
+        styles.empty? ? default_style(underscored_widget_name) : GSWT[*styles]
+      end
+
+      def default_style(underscored_widget_name)
+        style = @@default_styles[underscored_widget_name] if @@default_styles[underscored_widget_name]
+        style = GSWT[:none] unless style
+        style
+      end
+
+      def attribute_setter(attribute_name)
+        "set#{attribute_name.to_s.camelcase(:upper)}"
+      end
+    end
+  end
+end

data/lib/glimmer/swt/g_widget_listener.rb

@@ -0,0 +1,12 @@
+module Glimmer
+  module SWT
+    class GWidgetListener
+
+      attr_reader :listener
+
+      def initialize(listener)
+        @listener = listener
+      end      
+    end
+  end
+end

data/lib/glimmer/swt/list_selection_binding.rb

@@ -0,0 +1,49 @@
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  module SWT
+    # SWT List widget selection binding
+    class ListSelectionBinding
+      include Glimmer
+      include Observable
+      include Observer
+
+      attr_reader :widget
+      @@property_type_updaters = {
+        :string => lambda { |widget, value| widget.widget.select(widget.widget.index_of(value.to_s)) },
+        :array => lambda { |widget, value| widget.widget.selection=((value or []).to_java :string) }
+      }
+      @@property_evaluators = {
+        :string => lambda do |selection_array|
+          return nil if selection_array.empty?
+          selection_array[0]
+        end,
+        :array => lambda do |selection_array|
+          selection_array
+        end
+      }
+      # Initialize with list widget and property_type
+      # property_type :string represents default list single selection
+      # property_type :array represents list multi selection
+      def initialize(widget, property_type)
+        property_type = :string if property_type.nil? or property_type == :undefined
+        @widget = widget
+        @property_type = property_type
+        add_contents(@widget) {
+          on_widget_disposed { |dispose_event|
+            unregister_all_observables
+          }
+        }
+      end
+      def call(value)
+        @@property_type_updaters[@property_type].call(@widget, value) unless evaluate_property == value
+      end
+      def evaluate_property
+        selection_array = @widget.widget.send("selection").to_a
+        property_value = @@property_evaluators[@property_type].call(selection_array)
+        return property_value
+      end
+    end
+  end
+end

data/lib/glimmer/swt/model_binding.rb

@@ -0,0 +1,208 @@
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  module SWT
+    class ModelBinding
+      include Observable
+      include Observer
+
+      attr_reader :property_type, :binding_options
+      @@property_type_converters = {
+        :undefined => lambda { |value| value },
+        :fixnum => lambda { |value| value.to_i },
+        :array => lambda { |value| value.to_a }
+      }
+      def initialize(base_model, property_name_expression, property_type = :undefined, binding_options = nil)
+        property_type = :undefined if property_type.nil?
+        @base_model = base_model
+        @property_name_expression = property_name_expression
+        @property_type = property_type
+        @binding_options = binding_options || {}
+        if computed?
+          @computed_model_bindings = computed_by.map do |computed_by_property_expression|
+            self.class.new(base_model, computed_by_property_expression, :undefined, computed_binding_options)
+          end
+        end
+      end
+      def model
+        nested_property? ? nested_model : base_model
+      end
+      # e.g. person.address.state returns [person, person.address]
+      def nested_models
+        @nested_models = [base_model]
+        model_property_names.reduce(base_model) do |reduced_model, nested_model_property_name|
+          if reduced_model.nil?
+            nil
+          else
+            invoke_property_reader(reduced_model, nested_model_property_name).tap do |new_reduced_model|
+              @nested_models << new_reduced_model
+            end
+          end
+        end
+        @nested_models
+      end
+      def nested_model
+        nested_models.last
+      end
+      def base_model
+        @base_model
+      end
+      def property_name
+        nested_property? ? nested_property_name : property_name_expression
+      end
+      # All nested property names
+      # e.g. property name expression "address.state" gives ['address', 'state']
+      # If there are any indexed property names, this returns indexes as properties.
+      # e.g. property name expression "addresses[1].state" gives ['addresses', '[1]', 'state']
+      def nested_property_names
+        @nested_property_names ||= property_name_expression.split(".").map {|pne| pne.match(/([^\[]+)(\[[^\]]+\])?/).to_a.drop(1)}.flatten.compact
+      end
+      # Final nested property name
+      # e.g. property name expression "address.state" gives :state
+      def nested_property_name
+        nested_property_names.last
+      end
+      # Model representing nested property names
+      # e.g. property name expression "address.state" gives [:address]
+      def model_property_names
+        nested_property_names[0...-1]
+      end
+      def nested_property?
+        property_name_expression.match(/[.\[]/)
+      end
+      def property_name_expression
+        @property_name_expression
+      end
+      def computed?
+        !computed_by.empty?
+      end
+      def computed_by
+        [@binding_options[:computed_by]].flatten.compact
+      end
+      def computed_binding_options
+        @binding_options.reject {|k,v| k == :computed_by}
+      end
+      def nested_property_observers_for(observer)
+        @nested_property_observers_collection ||= {}
+        unless @nested_property_observers_collection.has_key?(observer)
+          @nested_property_observers_collection[observer] = nested_property_names.reduce({}) do |output, property_name|
+            output.merge(
+              property_name => Observer.proc do |new_value|
+                # Ensure reattaching observers when a higher level nested property is updated (e.g. person.address changes reattaches person.address.street observer)
+                add_observer(observer)
+                observer.call(evaluate_property)
+              end
+            )
+          end
+        end
+        # @nested_property_observers_collection[observer].keys.each_with_index do |property_name, i|
+        #   previous_property_name = nested_property_names[i-1]
+        #   previous_observer = @nested_property_observers_collection[observer][previous_property_name]
+        #   nested_property_observer = @nested_property_observers_collection[observer][property_name]
+        #   previous_observer.add_dependent(nested_property_observer) unless previous_observer.nil?
+        # end
+        # TODO remove this brainstorming
+        # person.addresses[1].streets[2].number
+        # person.addresses[1] = ...
+        @nested_property_observers_collection[observer]
+      end
+      def add_observer(observer)
+        if computed?
+          add_computed_observers(observer)
+        elsif nested_property?
+          add_nested_observers(observer)
+        else
+          observer.observe(model, property_name)
+          observer.add_dependent([self, nil] => [observer, model, property_name])
+        end
+      end
+      def remove_observer(observer)
+        if computed?
+          @computed_model_bindings.each do |computed_model_binding|
+            computed_observer_for(observer).unobserve(computed_model_binding)
+          end
+          @computed_observer_collection.delete(observer)
+        elsif nested_property?
+          nested_property_observers_for(observer).clear
+        else
+          observer.unobserve(model, property_name)
+        end
+      end
+      def computed_observer_for(observer)
+        @computed_observer_collection ||= {}
+        unless @computed_observer_collection.has_key?(observer)
+          @computed_observer_collection[observer] = Observer.proc do |new_value|
+            observer.call(evaluate_property)
+          end
+        end
+        @computed_observer_collection[observer]
+      end
+      def add_computed_observers(observer)
+        @computed_model_bindings.each do |computed_model_binding|
+          computed_observer_for(observer).observe(computed_model_binding)
+          observer.add_dependent([self, nil] => [computed_observer_for(observer), computed_model_binding, nil])
+        end
+      end
+      def add_nested_observers(observer)
+        nested_property_observers = nested_property_observers_for(observer)
+        nested_models.zip(nested_property_names).each_with_index do |zip, i|
+          model, property_name = zip
+          nested_property_observer = nested_property_observers[property_name]
+          previous_index = i - 1
+          parent_model = previous_index.negative? ? self : nested_models[previous_index]
+          parent_property_name = previous_index.negative? ? nil : nested_property_names[previous_index]
+          parent_observer = previous_index.negative? ? observer : nested_property_observers[parent_property_name]
+          parent_property_name = nil if parent_property_name.to_s.start_with?('[')
+          unless model.nil?
+            if property_indexed?(property_name)
+              # TODO figure out a way to deal with this more uniformly
+              nested_property_observer.observe(model)
+              parent_observer.add_dependent([parent_model, parent_property_name] => [nested_property_observer, model, nil])
+            else
+              nested_property_observer.observe(model, property_name)
+              parent_observer.add_dependent([parent_model, parent_property_name] => [nested_property_observer, model, property_name])
+            end
+          end
+        end
+      end
+      def call(value)
+        return if model.nil?
+        converted_value = @@property_type_converters[@property_type].call(value)
+        invoke_property_writer(model, "#{property_name}=", converted_value) unless evaluate_property == converted_value
+      end
+      def evaluate_property
+        invoke_property_reader(model, property_name) unless model.nil?
+      end
+      def evaluate_options_property
+        model.send(options_property_name) unless model.nil?
+      end
+      def options_property_name
+        self.property_name + "_options"
+      end
+      def property_indexed?(property_expression)
+        property_expression.start_with?('[')
+      end
+      def invoke_property_reader(object, property_expression)
+        if property_indexed?(property_expression)
+          property_method = '[]'
+          property_argument = property_expression[1...-1]
+          property_argument = property_argument.to_i if property_argument.match(/\d+/)
+          object.send(property_method, property_argument)
+        else
+          object.send(property_expression)
+        end
+      end
+      def invoke_property_writer(object, property_expression, value)
+        if property_indexed?(property_expression)
+          property_method = '[]='
+          property_argument = property_expression[1...-2]
+          property_argument = property_argument.to_i if property_argument.match(/\d+/)
+          object.send(property_method, property_argument, value)
+        else
+          object.send(property_expression, value)
+        end
+      end
+    end
+  end
+end