glimmer-dsl-opal 0.10.1 → 0.13.0

data/lib/glimmer-dsl-opal/samples/hello/hello_radio_group.rb

@@ -19,12 +19,15 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# This sample demonstrates the use of a `radio_group` in Glimmer, which provides terser syntax
+# than HelloRadio for representing multiple radio buttons by relying on data-binding to
+# automatically spawn the `radio` widgets based on available options on the model.
 class HelloRadioGroup
   class Person
     attr_accessor :gender, :age_group
     
     def initialize
-      reset
+      reset!
     end
     
     def gender_options
@@ -35,17 +38,19 @@ class HelloRadioGroup
       ['Child', 'Teen', 'Adult', 'Senior']
     end
     
-    def reset
+    def reset!
       self.gender = nil
       self.age_group = 'Adult'
     end
   end
 
-  include Glimmer
+  include Glimmer::UI::CustomShell
   
-  def launch
-    person = Person.new
-    
+  before_body {
+    @person = Person.new
+  }
+  
+  body {
     shell {
       text 'Hello, Radio Group!'
       row_layout :vertical
@@ -57,7 +62,7 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :gender)
+        selection <=> [@person, :gender]
       }
             
       label {
@@ -67,18 +72,18 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :age_group)
+        selection <=> [@person, :age_group]
       }
       
       button {
         text 'Reset'
         
         on_widget_selected do
-          person.reset
+          @person.reset!
         end
       }
-    }.open
-  end
+    }
+  }
 end
 
-HelloRadioGroup.new.launch
+HelloRadioGroup.launch

data/lib/glimmer-dsl-opal/samples/hello/hello_table.rb

@@ -196,7 +196,7 @@ class HelloTable
       
       combo(:read_only) {
         layout_data :center, :center, true, false
-        selection bind(BaseballGame, :playoff_type)
+        selection <=> [BaseballGame, :playoff_type]
         font height: 16
       }
       
@@ -237,10 +237,10 @@ class HelloTable
         }
         
         # Data-bind table items (rows) to a model collection property, specifying column properties ordering per nested model
-        items bind(BaseballGame, :schedule), column_properties(:game_date, :game_time, :ballpark, :home_team, :away_team, :promotion)
+        items <=> [BaseballGame, :schedule, column_attributes: [:game_date, :game_time, :ballpark, :home_team, :away_team, :promotion]]
         
         # Data-bind table selection
-        selection bind(BaseballGame, :selected_game)
+        selection <=> [BaseballGame, :selected_game]
         
         # Default initial sort property
         sort_property :date
@@ -263,7 +263,7 @@ class HelloTable
         text 'Book Selected Game'
         layout_data :center, :center, true, false
         font height: 16
-        enabled bind(BaseballGame, :selected_game)
+        enabled <=> [BaseballGame, :selected_game]
         
         on_widget_selected {
           book_selected_game

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -11,11 +11,12 @@ module Glimmer
       include DataBinding::Observable
       include DataBinding::Observer
 
-      def initialize(parent, model_binding, column_properties)
+      def initialize(parent, model_binding, column_properties = nil)
         @last_populated_model_collection = nil
         @table = parent
         @model_binding = model_binding
-        @column_properties = column_properties
+        @column_properties = model_binding.binding_options[:column_attributes] || model_binding.binding_options[:column_properties] || column_properties # TODO
+        @table.editable = false if model_binding.binding_options[:read_only]
         @table.data = @model_binding
         ##@table.on_widget_disposed do |dispose_event| # doesn't seem needed within Opal
         ##  unregister_all_observables

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

@@ -1,36 +1,35 @@
+# Copyright (c) 2020-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/bind_expression'
 require 'glimmer/data_binding/model_binding'
 
 module Glimmer
   module DSL
     module Opal
       # 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
+      # as a ModelBinding. It is then used by other data-binding expressions
       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
+        include Glimmer::DSL::BindExpression
       end
     end
   end

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

@@ -51,7 +51,7 @@ module Glimmer
           custom_widget_class = UI::CustomWidget.for(keyword)
           # TODO clean code by extracting methods into CustomShell
           if !Glimmer::UI::CustomShell.requested? && custom_widget_class&.ancestors&.to_a.include?(Glimmer::UI::CustomShell)
-            if Glimmer::SWT::DisplayProxy.instance.shells.empty?
+            if Glimmer::SWT::DisplayProxy.instance.shells.empty? || Glimmer::SWT::DisplayProxy.open_custom_shells_in_current_window?
               custom_widget_class.new(parent, *args, {}, &block)
             else
               options = args.last.is_a?(Hash) ? args.pop : {}
@@ -80,15 +80,15 @@ module Glimmer
           end
         end
         
-        def add_content(parent, &content)
-          content.call(parent) if parent.is_a?(Glimmer::SWT::ShellProxy) || parent.is_a?(Glimmer::UI::CustomShell)
-        end
-        
+        # TODO delete if no longer needed
+#         def add_content(parent, &content)
+#           content.call(parent) if parent.is_a?(Glimmer::SWT::ShellProxy) || parent.is_a?(Glimmer::UI::CustomShell)
+#         end
   
-        def add_content(parent, &block)
+        def add_content(parent, keyword, *args, &block)
           return unless parent.is_a?(Glimmer::UI::CustomWidget)
-          # TODO consider avoiding source_location
-          if block.source_location == parent.content&.__getobj__.source_location
+          # TODO consider avoiding source_location since it does not work in Opal
+          if block.source_location && (block.source_location == parent.content&.__getobj__&.source_location)
             parent.content.call(parent) unless parent.content.called?
           else
             super

data/lib/glimmer/dsl/opal/dsl.rb

@@ -28,6 +28,8 @@ require 'glimmer/dsl/opal/checkbox_group_selection_data_binding_expression'
 require 'glimmer/dsl/opal/block_property_expression'
 require 'glimmer/dsl/opal/menu_expression'
 require 'glimmer/dsl/opal/dialog_expression'
+require 'glimmer/dsl/opal/shape_expression'
+require 'glimmer/dsl/opal/shine_data_binding_expression'
 
 module Glimmer
   module DSL
@@ -47,6 +49,8 @@ module Glimmer
          layout
          block_property
          property
+         shine_data_binding
+         shape
          widget
        ]
       )

data/lib/glimmer/dsl/opal/menu_expression.rb

@@ -47,7 +47,7 @@ module Glimmer
           Glimmer::SWT::MenuProxy.new(parent, args)
         end
         
-        def add_content(parent, &block)
+        def add_content(parent, keyword, *args, &block)
           super(parent, &block)
           parent.post_add_content
         end

data/lib/glimmer/dsl/opal/property_expression.rb

@@ -6,8 +6,9 @@ module Glimmer
       class PropertyExpression < StaticExpression
         include TopLevelExpression
 
-        def can_interpret?(parent, keyword, *args, &block)          
+        def can_interpret?(parent, keyword, *args, &block)
           parent and
+            (!args.empty?) and
             parent.respond_to?(:set_attribute) and
             parent.respond_to?(keyword, *args) and
             keyword and

data/lib/glimmer/dsl/opal/shape_expression.rb

@@ -0,0 +1,26 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/dsl/parent_expression'
+
+module Glimmer
+  module DSL
+    module Opal
+      class ShapeExpression < Expression
+        include ParentExpression
+        
+        INCLUDED_KEYWORDS = %w[rectangle polygon]
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          INCLUDED_KEYWORDS.include?(keyword)
+        end
+
+        def interpret(parent, keyword, *args, &block)
+          # TODO
+        end
+        
+        def add_content(parent, keyword, *args, &block)
+          # TODO
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/shell_expression.rb

@@ -27,7 +27,7 @@ module Glimmer
           end
         end
         
-        def add_content(parent, &block)
+        def add_content(parent, keyword, *args, &block)
           super(parent, &block)
           parent.post_add_content
         end

data/lib/glimmer/dsl/opal/shine_data_binding_expression.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2020-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/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/swt/table_proxy'
+require 'glimmer/data_binding/shine'
+
+module Glimmer
+  module DSL
+    module Opal
+      class ShineDataBindingExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          args.size == 0 and
+            block.nil? and
+            (
+              (parent.respond_to?(:set_attribute) and parent.respond_to?(keyword)) or
+              (parent.is_a?(Glimmer::SWT::TableProxy)) # TODO support tree element
+            )
+            # TODO support canvas elements
+#             and
+#             !(parent.respond_to?(:swt_widget) && parent.swt_widget.class == org.eclipse.swt.widgets.Canvas && keyword == 'image')
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::DataBinding::Shine.new(parent, keyword)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/table_items_data_binding_expression.rb

@@ -12,10 +12,10 @@ module Glimmer
           keyword == "items" and
             block.nil? and
             parent.is_a?(Glimmer::SWT::TableProxy) and
-            args.size == 2 and
+            args.size.between?(1, 2) and
             args[0].is_a?(DataBinding::ModelBinding) and
             args[0].evaluate_property.is_a?(Array) and
-            args[1].is_a?(Array)
+            (args[1].nil? or args[1].is_a?(Array))
         end
   
         def interpret(parent, keyword, *args, &block)

data/lib/glimmer/dsl/opal/widget_expression.rb

@@ -20,7 +20,7 @@ module Glimmer
           Glimmer::SWT::WidgetProxy.for(keyword, parent, args, block)
         end
         
-        def add_content(parent, &block)
+        def add_content(parent, keyword, *args, &block)
           if parent.rendered? || parent.skip_content_on_render_blocks?
             super(parent, &block)
             parent.post_add_content

data/lib/glimmer/swt/combo_proxy.rb

@@ -6,6 +6,7 @@ module Glimmer
     class ComboProxy < WidgetProxy
       include Glimmer::DataBinding::ObservableElement
       attr_reader :text, :items
+      attr_accessor :selection # virtual attribute just to pass the shine data-binding test (TODO THINK OF A BETTER WAY OF HANDLING THIS)
       
       def initialize(parent, args, block)
         super(parent, args, block)

data/lib/glimmer/swt/composite_proxy.rb

@@ -44,6 +44,8 @@ module Glimmer
             
     end
     
+    CanvasProxy = CompositeProxy # TODO implement fully eventually
+    
   end
   
 end

data/lib/glimmer/swt/dialog_proxy.rb

@@ -68,9 +68,6 @@ module Glimmer
         @block = block
         @children = Set.new
         @enabled = true
-#         on_widget_selected {
-#           hide
-#         }
         DisplayProxy.instance.opened_dialogs.last&.suspend_event_handling
         DisplayProxy.instance.dialogs << self
         @parent.post_initialize_child(self)
@@ -90,7 +87,7 @@ module Glimmer
       end
       
       def open
-        owned_proc = Glimmer::Util::ProcTracker.new(owner: self) {
+        owned_proc = Glimmer::Util::ProcTracker.new(owner: self, invoked_from: :open) {
           shell.open(async: false) unless shell.open?
           unless @init
             dom_element.remove_class('hide')
@@ -141,7 +138,7 @@ module Glimmer
       
       
       def content(&block)
-        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Opal::DialogExpression.new, &block)
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Opal::DialogExpression.new, 'dialog', &block)
       end
       
       def path

data/lib/glimmer/swt/display_proxy.rb

@@ -7,6 +7,9 @@ module Glimmer
         def instance
           @instance ||= new
         end
+        
+        attr_accessor :open_custom_shells_in_current_window
+        alias open_custom_shells_in_current_window? open_custom_shells_in_current_window
       end
       
       def initialize
@@ -62,19 +65,22 @@ module Glimmer
         # No rendering as body is rendered as part of ShellProxy.. this class only serves as an SWT Display utility
       end
       
+      def beep
+        # TODO (simulate beep from SWT display flashing the screen and making a noise if possible)
+      end
+      
       def async_exec(proc_tracker = nil, &block)
         block = proc_tracker unless proc_tracker.nil?
-        can_open_modal = !modal_open?
-        return block.call if !can_open_modal && dialog_open? && block.respond_to?(:owner) && !block.owner.nil? && block.owner.is_a?(DialogProxy) && opened_dialogs.last == WidgetProxy.widget_handling_listener&.dialog_ancestor
-        return block.call if !can_open_modal && block.respond_to?(:owner) && !block.owner.nil? && block.owner.is_a?(MessageBoxProxy)
-        executer = lambda do
-          if !modal_open?
-            block.call
-          else
-            Async::Task.new(delay: 100, &executer)
-          end
+        queue = nil # general queue
+        if !proc_tracker.nil? && proc_tracker.invoked_from.to_s == 'open' && modal_open? &&
+           (
+             proc_tracker.owner.is_a?(MessageBoxProxy) ||
+             (dialog_open? && proc_tracker.owner.is_a?(DialogProxy) && opened_dialogs.last == WidgetProxy.widget_handling_listener&.dialog_ancestor)
+           )
+          queue = WidgetProxy.widget_handling_listener
         end
-        Async::Task.new(delay: 1, &executer)
+        return block.call if !modal_open?
+        schedule_async_exec(block, queue)
       end
       # sync_exec kept for API compatibility reasons
       alias sync_exec async_exec
@@ -89,7 +95,34 @@ module Glimmer
                   event.singleton_class.define_method(:character) do
                     which || key_code
                   end
+                  event.define_singleton_method(:keyCode) {event.which}
+                  event.define_singleton_method(:key_code, &event.method(:keyCode))
+                  event.define_singleton_method(:character) {event.which.chr}
+                  event.define_singleton_method(:stateMask) do
+                    state_mask = 0
+                    state_mask |= SWTProxy[:alt] if event.alt_key
+                    state_mask |= SWTProxy[:ctrl] if event.ctrl_key
+                    state_mask |= SWTProxy[:shift] if event.shift_key
+                    state_mask |= SWTProxy[:command] if event.meta_key
+                    state_mask
+                  end
+                  event.define_singleton_method(:state_mask, &event.method(:stateMask))
+                  doit = true
+                  event.define_singleton_method(:doit=) do |value|
+                    doit = value
+                  end
+                  event.define_singleton_method(:doit) { doit }
                   event_listener.call(event)
+                  
+                    # TODO Fix doit false, it's not stopping input
+                  unless doit
+                    event.prevent
+                    event.prevent_default
+                    event.stop_propagation
+                    event.stop_immediate_propagation
+                  end
+                  
+                  doit
                 }
               }
             },
@@ -100,13 +133,74 @@ module Glimmer
                   event.singleton_class.define_method(:character) do
                     which || key_code
                   end
+                  event.define_singleton_method(:keyCode) {event.which}
+                  event.define_singleton_method(:key_code, &event.method(:keyCode))
+                  event.define_singleton_method(:character) {event.which.chr}
+                  event.define_singleton_method(:stateMask) do
+                    state_mask = 0
+                    state_mask |= SWTProxy[:alt] if event.alt_key
+                    state_mask |= SWTProxy[:ctrl] if event.ctrl_key
+                    state_mask |= SWTProxy[:shift] if event.shift_key
+                    state_mask |= SWTProxy[:command] if event.meta_key
+                    state_mask
+                  end
+                  event.define_singleton_method(:state_mask, &event.method(:stateMask))
+                  doit = true
+                  event.define_singleton_method(:doit=) do |value|
+                    doit = value
+                  end
+                  event.define_singleton_method(:doit) { doit }
                   event_listener.call(event) if event.key_code != 13 && (event.key_code == 127 || event.key_code <= 31)
+                  
+                    # TODO Fix doit false, it's not stopping input
+                  unless doit
+                    event.prevent
+                    event.prevent_default
+                    event.stop_propagation
+                    event.stop_immediate_propagation
+                  end
+                  
+                  doit
                 }
               }
             }
           ]
         }
       end
+      
+      private
+      
+      def async_exec_queues
+        @async_exec_queues ||= {}
+      end
+      
+      def async_exec_queue(widget_handling_listener = nil)
+        async_exec_queues[widget_handling_listener] ||= []
+      end
+      
+      def no_widget_handling_listener_work?
+        async_exec_queues.reject {|key, value| key.nil?}.values.reduce(:+).to_a.empty?
+      end
+      
+      def schedule_async_exec(block, queue)
+        async_exec_queue(queue).unshift(block)
+        
+        # TODO consider the need for locking to avoid race conditions (rare or impossible case)
+        if async_exec_queue(queue).size == 1
+          executer = lambda do
+            # queue could be a widget handling listener queue
+            # TODO see if there are more intricate cases of opening a dialog from a widget listener handler
+            if !message_box_open? && (!dialog_open? || queue&.dialog_ancestor == opened_dialogs.last) && ((!queue.nil? && async_exec_queues.keys.last == queue) || no_widget_handling_listener_work?)
+              block = async_exec_queue(queue).pop
+              block&.call
+              Async::Task.new(delay: 1, &executer) if async_exec_queue(queue).any?
+            else
+              Async::Task.new(delay: 100, &executer)
+            end
+          end
+          Async::Task.new(delay: 1, &executer)
+        end
+      end
     end
   end
 end