glimmer-dsl-swt 0.1.0

data/lib/glimmer/data_binding/tree_items_binding.rb

@@ -0,0 +1,71 @@
+require 'glimmer/data_binding/observable_array'
+require 'glimmer/data_binding/observable_model'
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
+require 'glimmer/swt/swt_proxy'
+
+module Glimmer
+  module DataBinding
+    class TreeItemsBinding
+      include DataBinding::Observable
+      include DataBinding::Observer
+
+      include_package 'org.eclipse.swt'
+      include_package 'org.eclipse.swt.widgets'
+
+      def initialize(parent, model_binding, tree_properties)
+        @tree = parent
+        @model_binding = model_binding
+        @tree_properties = [tree_properties].flatten.first.to_h
+        if @tree.respond_to?(:tree_properties=)
+          @tree.tree_properties = @tree_properties
+        else # assume custom widget
+          @tree.body_root.tree_properties = @tree_properties
+        end
+        call
+        model = model_binding.base_model
+        observe(model, model_binding.property_name_expression)
+        @tree.on_widget_disposed do |dispose_event|
+          unregister_all_observables
+        end
+      end
+
+      def call(new_value=nil)
+        @model_tree_root_node = @model_binding.evaluate_property
+        populate_tree(@model_tree_root_node, @tree, @tree_properties)
+      end
+
+      def populate_tree(model_tree_root_node, parent, tree_properties)
+        # TODO make it change things by delta instead of removing all
+        selected_tree_item_model = parent.swt_widget.getSelection.map(&:getData).first
+        old_tree_items = parent.all_tree_items
+        old_tree_item_expansion_by_data = old_tree_items.reduce({}) {|hash, ti| hash.merge(ti.getData => ti.getExpanded)}
+        old_tree_items.each do |tree_item|
+          tree_item.getData('observer_registrations').each do |key, observer_registration|
+            observer_registration.unregister
+          end          
+        end        
+        parent.swt_widget.removeAll
+        populate_tree_node(model_tree_root_node, parent.swt_widget, tree_properties)
+        parent.all_tree_items.each { |ti| ti.setExpanded(!!old_tree_item_expansion_by_data[ti.getData]) }
+        tree_item_to_select = parent.depth_first_search {|ti| ti.getData == selected_tree_item_model}
+        parent.swt_widget.setSelection(tree_item_to_select)
+      end
+
+      def populate_tree_node(model_tree_node, parent, tree_properties)
+        return if model_tree_node.nil?
+        # TODO anticipate default tree properties if none were passed (like literal values text and children)
+        tree_item = TreeItem.new(parent, SWT::SWTProxy[:none])
+        observer_registrations = @tree_properties.reduce({}) do |hash, key_value_pair|
+          hash.merge(key_value_pair.first => observe(model_tree_node, key_value_pair.last))
+        end
+        tree_item.setData('observer_registrations', observer_registrations)
+        tree_item.setData(model_tree_node)
+        tree_item.setText((model_tree_node && model_tree_node.send(tree_properties[:text])).to_s)
+        [model_tree_node && model_tree_node.send(tree_properties[:children])].flatten.to_a.compact.each do |child|
+          populate_tree_node(child, tree_item, tree_properties)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/data_binding/widget_binding.rb

@@ -0,0 +1,33 @@
+require 'glimmer'
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  module DataBinding
+    class WidgetBinding
+      include Glimmer
+      include Observable
+      include Observer
+
+      attr_reader :widget, :property
+      def initialize(model, property, translator = nil)
+        @widget = model
+        @property = property
+        @translator = translator || proc {|value| value}
+
+        if @widget.respond_to?(:dispose)
+          @widget.on_widget_disposed do |dispose_event|
+            unregister_all_observables
+          end
+        end
+      end
+      def call(value)
+        converted_value = translated_value = @translator.call(value)
+        @widget.set_attribute(@property, converted_value) unless evaluate_property == converted_value
+      end
+      def evaluate_property
+        @widget.get_attribute(@property)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/swt/exec_expression'
+
+module Glimmer
+  module DSL
+    module SWT  
+      # Asynchronously executes code block against the SWT Event Loop
+      # to manipulate SWT UI objects on the UI thread safely
+      class AsyncExecExpression < StaticExpression
+        include ExecExpression
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/data_binding/model_binding'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Responsible for setting up the return value of the bind keyword (command symbol)
+      # as a ModelBinding. It is then used by another command handler like
+      # DataBindingCommandHandler for text and selection properties on Text and Spinner
+      # or TableItemsDataBindingCommandHandler for items in a Table
+      class BindExpression < StaticExpression
+        def can_interpret?(parent, keyword, *args, &block)
+          (
+            keyword == 'bind' and
+              (
+                (
+                  (args.size == 2) and
+                    textual?(args[1])
+                ) ||
+                  (
+                    (args.size == 3) and
+                      textual?(args[1]) and
+                      (args[2].is_a?(Hash))
+                  )
+              )
+          )
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          binding_options = args[2] || {}
+          binding_options[:on_read] = binding_options.delete(:on_read) || binding_options.delete('on_read') || block
+          DataBinding::ModelBinding.new(args[0], args[1].to_s, binding_options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/swt/color_proxy'
+require 'glimmer/swt/display_proxy'
+
+module Glimmer
+  module DSL
+    module SWT
+      class ColorExpression < StaticExpression
+        include TopLevelExpression
+        include_package 'org.eclipse.swt.widgets'
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::ColorProxy.new(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'glimmer/dsl/static_expression'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Responsible for providing a readable keyword (command symbol) to capture
+      # and return column properties for use in TreeItemsDataBindingCommandHandler
+      class ColumnPropertiesExpression < StaticExpression
+        include_package 'org.eclipse.swt.widgets'
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'column_properties' and
+            block.nil? and
+            parent.respond_to?(:swt_widget) and
+            parent.swt_widget.is_a?(Table)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          args
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/widget_binding'
+
+module Glimmer
+  module DSL
+    module SWT
+      class ComboSelectionDataBindingExpression < Expression
+        include_package 'org.eclipse.swt.widgets'
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'selection' and
+            block.nil? and
+            parent.respond_to?(:swt_widget) and
+            parent.swt_widget.is_a?(Combo) and
+            args.size == 1 and
+            args[0].is_a?(DataBinding::ModelBinding) and
+            args[0].evaluate_options_property.is_a?(Array)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          model_binding = args[0]
+  
+          #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
+          # TODO consider delegating some of this work
+          widget_binding = DataBinding::WidgetBinding.new(parent, 'items')
+          widget_binding.call(model_binding.evaluate_options_property)
+          model = model_binding.base_model
+          widget_binding.observe(model, model_binding.options_property_name)
+  
+          widget_binding = DataBinding::WidgetBinding.new(parent, 'text')
+          widget_binding.call(model_binding.evaluate_property)
+          widget_binding.observe(model, model_binding.property_name_expression)
+  
+          parent.on_widget_selected do
+            model_binding.call(widget_binding.evaluate_property)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+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'
+
+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/data_binding_expression.rb

@@ -0,0 +1,34 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/widget_binding'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Responsible for wiring two-way data-binding for text and selection properties
+      # on Text, Button, and Spinner widgets.
+      # Does so by using the output of the bind(model, property) command in the form
+      # of a ModelBinding, which is then connected to an anonymous widget observer
+      # (aka widget_data_binder as per widget_data_binders array)
+      #
+      # Depends on BindCommandHandler
+      class DataBindingExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          args.size == 1 and
+            args[0].is_a?(DataBinding::ModelBinding)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          model_binding = args[0]
+          widget_binding_parameters = [parent, keyword]
+          widget_binding = DataBinding::WidgetBinding.new(*widget_binding_parameters)
+          widget_binding.call(model_binding.evaluate_property)
+          #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
+          widget_binding.observe(model_binding)
+          # TODO simplify this logic and put it where it belongs
+          parent.add_observer(model_binding, keyword) if parent.respond_to?(:add_observer, [model_binding, keyword])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/swt/shell_proxy'
+
+module Glimmer
+  module DSL
+    module SWT
+      class DialogExpression < StaticExpression
+        include TopLevelExpression
+        include ParentExpression
+
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'dialog' and
+            (parent.nil? or parent.is_a?(Glimmer::SWT::ShellProxy))
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          args = [parent] + args unless parent.nil?
+          args += [:dialog_trim, :application_modal]
+          Glimmer::SWT::ShellProxy.send(:new, *args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/swt/display_proxy'
+
+module Glimmer
+  module DSL
+    module SWT
+      class DisplayExpression < StaticExpression
+        include TopLevelExpression
+        include ParentExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::DisplayProxy.instance(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'glimmer/launcher'
+require Glimmer::Launcher.swt_jar_file
+require 'glimmer/dsl/engine'
+Dir[File.expand_path('../*_expression.rb', __FILE__)].each {|f| require f}
+
+# Glimmer DSL expression configuration module
+#
+# When DSL engine interprets an expression, it attempts to handle
+# with expressions listed here in the order specified.
+
+# Every expression has a corresponding Expression subclass
+# in glimmer/dsl
+
+module Glimmer
+  module DSL
+    module SWT
+      Engine.add_dynamic_expressions(
+        SWT,
+        %w[
+          layout
+          widget_listener
+          combo_selection_data_binding
+          list_selection_data_binding
+          tree_items_data_binding
+          table_items_data_binding
+          data_binding
+          property
+          widget
+          custom_widget
+        ]
+      )
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+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.send(exec_operation, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'glimmer'
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/swt/layout_data_proxy'
+
+# TODO consider turning static keywords like layout_data into methods
+
+module Glimmer
+  module DSL
+    module SWT
+      class LayoutDataExpression < StaticExpression
+        include ParentExpression
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'layout_data' and
+            parent.respond_to?(:swt_widget)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::LayoutDataProxy.new(parent, args)
+        end
+      end
+    end
+  end
+end