glimmer-dsl-swt 4.20.0.0 → 4.20.0.5

data/docs/reference/GLIMMER_STYLE_GUIDE.md

@@ -7,8 +7,9 @@
 - 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 declared starting with `on_` prefix and affixing listener event method name afterwards in underscored lowercase form. Their multi-line blocks rely on the `do; end` style.
 - 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.
+- Custom widget `body`, `before_body`, and `after_body` blocks open their blocks and close them with curly braces.
+- Custom widgets receive additional keyword arguments called options, which come after the SWT styles.
+- Pure logic multi-line blocks that do not constitute GUI DSL view elements (such as `Thread.new`, `loop`, `each` and `observe` blocks) rely on the `do; end` style to clearly separate logic code from view code.

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

@@ -70,3 +70,5 @@ require 'glimmer/swt/sash_form_proxy'
 require 'glimmer/swt/styled_text_proxy'
 require 'glimmer/swt/date_time_proxy'
 require 'glimmer/swt/tab_folder_proxy'
+require 'glimmer/swt/combo_proxy'
+require 'glimmer/swt/tool_bar_proxy'

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

@@ -1,5 +1,5 @@
 # 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
@@ -7,10 +7,10 @@
 # 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

data/lib/glimmer/rake_task/scaffold.rb

@@ -441,8 +441,6 @@ module Glimmer
             require '#{file_name(app_name)}/view/app_view'
     
             class #{class_name(app_name)}
-              include Glimmer
-            
               APP_ROOT = File.expand_path('../..', __FILE__)
               VERSION = File.read(File.join(APP_ROOT, 'VERSION'))
               LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))

data/lib/glimmer/swt/combo_proxy.rb

@@ -0,0 +1,48 @@
+# 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/widget_proxy'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.widgets.Combo
+    #
+    # Follows the Proxy Design Pattern
+    class ComboProxy < WidgetProxy
+      attr_accessor :tool_item_proxy, :swt_tool_item
+    
+      def initialize(*init_args, &block)
+        super
+        self.tool_item_proxy = WidgetProxy.new("tool_item", parent_proxy, [:separator]) if parent_proxy.swt_widget.is_a?(ToolBar)
+        self.swt_tool_item = tool_item_proxy&.swt_widget
+      end
+      
+      def post_add_content
+        if self.tool_item_proxy
+          self.swt_widget.pack
+          self.tool_item_proxy.text = 'filler' # text seems needed (any text works)
+          self.tool_item_proxy.width = swt_widget.size.x
+          self.tool_item_proxy.control = swt_widget
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/display_proxy.rb

@@ -42,7 +42,7 @@ module Glimmer
       
       OBSERVED_MENU_ITEMS = ['about', 'preferences', 'quit']
       
-      class FilterListener
+      class ConcreteListener
         include org.eclipse.swt.widgets.Listener
         
         def initialize(&listener_block)
@@ -194,15 +194,17 @@ module Glimmer
         observation_request = observation_request.to_s
         if observation_request.start_with?('on_swt_')
           constant_name = observation_request.sub(/^on_swt_/, '')
-          add_swt_event_filter(constant_name, &block)
+          swt_event_reg = add_swt_event_filter(constant_name, &block)
+          Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(swt_event_reg)
+          swt_event_reg
         elsif observation_request.start_with?('on_')
           event_name = observation_request.sub(/^on_/, '')
           if OBSERVED_MENU_ITEMS.include?(event_name) && OS.mac?
             system_menu = swt_display.getSystemMenu
             menu_item = system_menu.getItems.find {|menu_item| menu_item.getID == SWTProxy["ID_#{event_name.upcase}"]}
-            display_mac_event_registration = menu_item.addListener(SWTProxy[:Selection], &block)
-            # TODO enable this code and test on the Mac to ensure automatic cleanup of mac event registrations in custom widgets
-#             Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(display_mac_event_registration)
+            listener = ConcreteListener.new(&block)
+            display_mac_event_registration = menu_item.addListener(SWTProxy[:Selection], listener)
+            Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(display_mac_event_registration)
             display_mac_event_registration
           end
         end
@@ -210,15 +212,16 @@ module Glimmer
 
       def add_swt_event_filter(swt_constant, &block)
         event_type = SWTProxy[swt_constant]
-        @swt_display.addFilter(event_type, FilterListener.new(&block))
+        swt_listener = ConcreteListener.new(&block)
+        @swt_display.addFilter(event_type, swt_listener)
         #WidgetListenerProxy.new(@swt_display.getListeners(event_type).last)
         WidgetListenerProxy.new(
           swt_display: @swt_display,
           event_type: event_type,
           filter: true,
-          swt_listener: block,
+          swt_listener: swt_listener,
           widget_add_listener_method: 'addFilter',
-          swt_listener_class:  FilterListener,
+          swt_listener_class:  ConcreteListener,
           swt_listener_method: 'handleEvent'
         )
       end

data/lib/glimmer/swt/tool_bar_proxy.rb

@@ -0,0 +1,51 @@
+# 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/widget_proxy'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.widgets.ToolBarProxy
+    #
+    # Follows the Proxy Design Pattern
+    class ToolBarProxy < WidgetProxy
+      attr_accessor :cool_item_proxy, :swt_cool_item
+    
+      def initialize(*init_args, &block)
+        super
+        self.cool_item_proxy = WidgetProxy.new("cool_item", parent_proxy, []) if parent_proxy.swt_widget.is_a?(CoolBar)
+        self.swt_cool_item = cool_item_proxy&.swt_widget
+      end
+      
+      def post_add_content
+        apply_preferred_size if cool_item_proxy
+      end
+      
+      def apply_preferred_size
+        swt_widget.pack
+        size = swt_widget.size
+        cool_item_proxy.control = swt_widget
+        preferred = swt_cool_item.computeSize(size.x, size.y)
+        swt_cool_item.setPreferredSize(preferred)
+      end
+    end
+  end
+end

data/lib/glimmer/swt/widget_proxy.rb

@@ -838,7 +838,7 @@ module Glimmer
           widget_listener_proxy = nil
           safe_block = lambda { |*args| block.call(*args) unless @swt_widget.isDisposed }
           @swt_widget.addListener(event_type, &safe_block)
-          widget_listener_proxy = WidgetListenerProxy.new(swt_widget: @swt_widget, swt_listener: @swt_widget.getListeners(event_type).last, event_type: event_type, swt_constant: swt_constant)
+          WidgetListenerProxy.new(swt_widget: @swt_widget, swt_listener: @swt_widget.getListeners(event_type).last, event_type: event_type, swt_constant: swt_constant)
         end
       end
 
@@ -1006,6 +1006,12 @@ module Glimmer
           image: lambda do |*value|
             ImageProxy.create(*value).swt_image
           end,
+          disabled_image: lambda do |*value|
+            ImageProxy.create(*value).swt_image
+          end,
+          hot_image: lambda do |*value|
+            ImageProxy.create(*value).swt_image
+          end,
           images: lambda do |array|
             array.to_a.map do |value|
               ImageProxy.create(value).swt_image

data/lib/glimmer/ui/custom_shell.rb

@@ -31,9 +31,9 @@ module Glimmer
       class << self
         def launch(*args, &content)
           auto_exec do
-            @launched_custom_shell = send(keyword, *args, &content)
-            @launched_custom_shell.swt_widget.set_data('launched', true)
-            @launched_custom_shell.open
+            launched_custom_shell = send(keyword, *args, &content)
+            launched_custom_shell.swt_widget.set_data('launched', true)
+            launched_custom_shell.open
           end
         end
       end

data/lib/glimmer/ui/custom_widget.rb

@@ -186,8 +186,11 @@ module Glimmer
           @swt_widget.set_data('custom_widget', self)
         end
         execute_hook('after_body')
-        @dispose_listener_registration = @body_root.on_widget_disposed do
-          observer_registrations.each(&:deregister)
+        auto_exec do
+          @dispose_listener_registration = @body_root.on_widget_disposed do
+            observer_registrations.compact.each(&:deregister)
+            observer_registrations.clear
+          end
         end
       end
       

data/samples/elaborate/calculator.rb

@@ -0,0 +1,116 @@
+require 'glimmer-dsl-swt'
+require 'bigdecimal'
+
+require_relative 'calculator/model/presenter'
+
+# This sample demonstrates use of MVP (Model-View-Presenter) Architectural Pattern
+# to data-bind View widgets to object-oriented Models taking advantage of design patterns
+# like Command Design Pattern.
+class Calculator
+  include Glimmer::UI::CustomShell
+  
+  BUTTON_FONT = {height: 14}
+  BUTTON_FONT_OPERATION = {height: 18}
+  BUTTON_FONT_BIG = {height: 28}
+
+  attr_reader :presenter
+
+  before_body {
+    @presenter = Model::Presenter.new
+    
+    Display.setAppName('Glimmer Calculator')
+    
+    display {
+      on_swt_keydown { |key_event|
+        char = key_event.character.chr rescue nil
+        @presenter.press(char)
+      }
+      
+      on_about {
+        display_about_dialog
+      }
+    }
+  }
+
+  body {
+    shell {
+      grid_layout 4, true
+      
+      minimum_size (OS.mac? ? 320 : (OS.windows? ? 390 : 520)), 240
+      text "Glimmer Calculator"
+      
+      on_shell_closed do
+        @presenter.purge_command_history
+      end
+      
+      # Setting styled_text to multi in order for alignment options to activate
+      styled_text(:multi, :wrap, :border) {
+        text bind(@presenter, :result)
+        alignment swt(:right)
+        right_margin 5
+        font height: 40
+        layout_data(:fill, :fill, true, true) {
+          horizontal_span 4
+        }
+        editable false
+        caret nil
+      }
+      command_button('AC')
+      operation_button('÷')
+      operation_button('×')
+      operation_button('−')
+      (7..9).each { |number|
+        number_button(number)
+      }
+      operation_button('+', font: BUTTON_FONT_BIG, vertical_span: 2)
+      (4..6).each { |number|
+        number_button(number)
+      }
+      (1..3).each { |number|
+        number_button(number)
+      }
+      command_button('=', font: BUTTON_FONT_BIG, vertical_span: 2)
+      number_button(0, horizontal_span: 2)
+      operation_button('.')
+    }
+  }
+  
+  def number_button(number, options = {})
+    command_button(number, options)
+  end
+  
+  def operation_button(operation, options = {})
+    command_button(operation, options.merge(font: BUTTON_FONT_OPERATION))
+  end
+  
+  def command_button(command, options = {})
+    command = command.to_s
+    options[:font] ||= BUTTON_FONT
+    options[:horizontal_span] ||= 1
+    options[:vertical_span] ||= 1
+    
+    button { |proxy|
+      text command
+      font options[:font]
+      
+      layout_data(:fill, :fill, true, true) {
+        horizontal_span options[:horizontal_span]
+        vertical_span options[:vertical_span]
+      }
+      
+      on_widget_selected {
+        @presenter.press(command)
+      }
+    }
+  end
+
+  def display_about_dialog
+    message_box(body_root) {
+      text 'About'
+      message "Glimmer - Calculator\n\nCopyright (c) 2007-2021 Andy Maleh"
+    }.open
+  end
+
+end
+
+Calculator.launch

data/samples/elaborate/calculator/model/command.rb

@@ -0,0 +1,105 @@
+class Calculator
+  module Model
+    class Command
+      class << self
+        attr_accessor :number1, :number2, :operation
+           
+        # Keyword string representing calculator command (e.g. '+' for Add command)
+        # Subclasses must call to define a single keyword
+        def keyword(keyword_text)
+          Command.keyword_to_command_class_mapping[keyword_text] = self
+        end
+        
+        # Keyword string array representing calculator command (e.g. ('0'..'9').to_a)
+        # Subclasses must call to define multiple keywords
+        def keywords(*keyword_text_array)
+          keyword_text_array.flatten.each do |keyword_text|
+            keyword(keyword_text)
+          end
+        end
+        
+        def keyword_to_command_class_mapping
+          @keyword_to_command_class_mapping ||= {}
+        end
+      
+        def command_history
+          @command_history ||= []
+        end
+        
+        def purge_command_history
+          Command.command_history.clear
+          self.number1 = nil
+          self.number2 = nil
+          self.operation = nil
+        end
+      
+        def for(button)
+          command_class = keyword_to_command_class_mapping[button]
+          command_class&.new(button)&.tap do |command|
+            command.execute
+            command_history << command
+          end
+        end
+      end
+      
+      attr_reader :button
+      attr_accessor :result
+      
+      def initialize(button)
+        @button = button
+      end
+      
+      def number1
+        Command.number1
+      end
+      
+      def number1=(value)
+        Command.number1 = value.to_f
+      end
+      
+      def number2
+        Command.number2
+      end
+      
+      def number2=(value)
+        Command.number2 = value.to_f
+      end
+      
+      def operation
+        Command.operation
+      end
+      
+      def operation=(op)
+        Command.operation = op
+      end
+      
+      def last_result
+        last_command&.result
+      end
+      
+      def last_command
+        command_history.last
+      end
+      
+      def command_history
+        Command.command_history
+      end
+      
+      def execute
+        raise 'Not implemented! Please override in a subclass.'
+      end
+    end
+  end
+end
+
+# Dir[File.join(File.dirname(__FILE__), 'command', '**', '*.rb')].each {|f| require(f)} # disabled for Opal compatibility
+
+require_relative 'command/all_clear'
+require_relative 'command/equals'
+require_relative 'command/number'
+require_relative 'command/operation'
+require_relative 'command/point'
+require_relative 'command/operation/add'
+require_relative 'command/operation/divide'
+require_relative 'command/operation/multiply'
+require_relative 'command/operation/subtract'