glimmer 0.4.8 → 0.4.9

data/bin/girb_runner.rb

@@ -1 +1,3 @@
+require 'puts_debuggerer'
+
 include Glimmer

data/lib/glimmer.rb

@@ -8,6 +8,7 @@ require "facets"
 require "super_module"
 require "logger"
 require "java"
+require "nested_inherited_jruby_include_package"
 require_relative "glimmer/parent"
 require_relative "glimmer/swt_packages" #TODO move into SWT namespace
 require_relative "glimmer/swt/custom_widget"

data/lib/glimmer/command_handler.rb

@@ -1,8 +1,13 @@
 module Glimmer
+  # rename to keyword handler
+
   module CommandHandler
     def can_handle?(parent, command_symbol, *args, &block)
       raise "must be implemented by a class"
     end
+
+    # TODO rename do_handle to just handle
+
     def do_handle(parent, command_symbol, *args, &block)
       raise "must be implemented by a class"
     end

data/lib/glimmer/command_handler_chain_link.rb

@@ -14,10 +14,11 @@ module Glimmer
         return @next_chain_link.handle(parent, command_symbol, *args, &block)
       else
         # TODO see if we need a better response here (e.g. dev mode error raising vs production mode silent failure)
-        # Glimmer.logger.error "Command: #{command_symbol} cannot be handled!"
-        Glimmer.logger.debug "Command: #{command_symbol} cannot be handled!"
-        # raise "Command: #{command_symbol} cannot be handled!"
-        nil
+        message = "Glimmer keyword #{command_symbol} with args #{args} cannot be handled"
+        message += " inside parent #{parent.inspect}" if parent
+        message += "! Check the validity of the code."
+        # Glimmer.logger.error message
+        raise message
       end
     end
   end

data/lib/glimmer/command_handlers.rb

@@ -1,4 +1,5 @@
 require_relative "command_handler_chain_factory"
+require_relative "swt/command_handlers/observe_command_handler"
 require_relative "swt/command_handlers/color_command_handler"
 require_relative "swt/command_handlers/display_command_handler"
 require_relative "swt/command_handlers/shell_command_handler"
@@ -22,6 +23,7 @@ require_relative "swt/command_handlers/custom_widget_command_handler"
 module Glimmer
   # edit to add more command handlers and extend Glimmer
   CommandHandlerChainFactory.def_dsl(:swt,
+    SWT::CommandHandlers::ObserveCommandHandler.new,
     SWT::CommandHandlers::DisplayCommandHandler.new,
     SWT::CommandHandlers::ShellCommandHandler.new,
     SWT::CommandHandlers::LayoutDataCommandHandler.new,

data/lib/glimmer/swt/command_handlers/custom_widget_command_handler.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + "/../../command_handler"
 require File.dirname(__FILE__) + "/../custom_widget"
+require File.dirname(__FILE__) + "/../custom_shell"
 require File.dirname(__FILE__) + "/../g_widget"
 
 module Glimmer
@@ -9,8 +10,9 @@ module Glimmer
         include CommandHandler
 
         def can_handle?(parent, command_symbol, *args, &block)
-          (parent.is_a?(GWidget) || parent.is_a?(CustomWidget)) and
-          CustomWidget.for(command_symbol)
+          custom_widget_class = CustomWidget.for(command_symbol)
+          custom_widget_class and
+            (parent.is_a?(GWidget) || parent.is_a?(CustomWidget) || custom_widget_class.ancestors.include?(CustomShell))
         end
 
         def do_handle(parent, command_symbol, *args, &block)

data/lib/glimmer/swt/command_handlers/data_binding_command_handler.rb

@@ -16,7 +16,6 @@ module Glimmer
       #
       # Depends on BindCommandHandler
       class DataBindingCommandHandler
-        extend Glimmer
         include CommandHandler
 
         include_package 'org.eclipse.swt.widgets'

data/lib/glimmer/swt/command_handlers/observe_command_handler.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + "/../../command_handler"
+
+module Glimmer
+  module SWT
+    module CommandHandlers
+      class ObserveCommandHandler
+        REGEX_NESTED_OR_INDEXED_PROPERTY = /([^\[]+)(\[[^\]]+\])?/
+        include CommandHandler
+
+        def can_handle?(parent, command_symbol, *args, &block)
+          command_symbol.to_s == "observe" and
+          (
+            (
+              (args.size == 2) and
+                (
+                  args[1].is_a?(Symbol) or
+                  args[1].is_a?(String)
+                )
+            )
+          ) and
+            !block.nil?
+        end
+
+        def do_handle(parent, command_symbol, *args, &block)
+          observer = Observer.proc(&block)
+          if args[1].to_s.match(REGEX_NESTED_OR_INDEXED_PROPERTY)
+            observer.observe(ModelBinding.new(args[0], args[1]))
+          else
+            observer.observe(args[0], args[1])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/command_handlers/property_command_handler.rb

@@ -8,10 +8,10 @@ module Glimmer
 
         def can_handle?(parent, command_symbol, *args, &block)
           parent.respond_to?(:set_attribute) and
-          parent.respond_to?(:has_attribute?) and
-          args.size > 0 and
-          block == nil and
-          parent.has_attribute?(command_symbol, *args)
+            parent.respond_to?(:has_attribute?) and
+            args.size > 0 and
+            block == nil and
+            parent.has_attribute?(command_symbol, *args)
         end
 
         def do_handle(parent, command_symbol, *args, &block)

data/lib/glimmer/swt/command_handlers/widget_listener_command_handler.rb

@@ -5,6 +5,8 @@ require File.dirname(__FILE__) + "/../custom_widget"
 module Glimmer
   module SWT
     module CommandHandlers
+      # TODO rename to observation command handler (or keyword handler)
+
       class WidgetListenerCommandHandler
         include CommandHandler
 
@@ -14,18 +16,19 @@ module Glimmer
           widget_parentage = (parent.is_a?(GWidget) || parent.is_a?(CustomWidget))
           Glimmer.logger.debug "parent is a widget: #{widget_parentage}"
           return unless widget_parentage
-          Glimmer.logger.debug "on listener?: " + (command_symbol.to_s[0,3] == "on_").to_s
-          return unless command_symbol.to_s[0,3] == "on_"
-          Glimmer.logger.debug "command symbol is longer than 3: " + (command_symbol.to_s.length > 3).to_s
-          return unless command_symbol.to_s.length > 3
-          Glimmer.logger.debug "args are 0?: " + (args.size == 0).to_s
-          return unless args.size == 0
-          Glimmer.logger.debug "can add listener? " + (parent.can_add_listener?(command_symbol.to_s[3, command_symbol.to_s.length])).to_s
-          parent.can_add_listener?(command_symbol.to_s[3, command_symbol.to_s.length])
+          Glimmer.logger.debug "keyword starts with on_: #{command_symbol.to_s.start_with?('on_')}"
+          return unless command_symbol.to_s.start_with?('on_')
+          Glimmer.logger.debug "args are empty?: #{args.empty?}"
+          return unless args.empty?
+          Glimmer.logger.debug "block exists?: #{!block.nil?}"
+          return unless !block.nil?
+          result = parent.can_handle_observation_request?(command_symbol.to_s)
+          Glimmer.logger.debug "can add listener? #{result}"
+          result
         end
 
         def do_handle(parent, command_symbol, *args, &block)
-          parent.add_listener(command_symbol.to_s[3, command_symbol.to_s.length], &block)
+          parent.handle_observation_request(command_symbol.to_s, &block)
           ListenerParent.new #TODO refactor and move to models
         end
 

data/lib/glimmer/swt/custom_shell.rb

@@ -0,0 +1,45 @@
+require 'super_module'
+
+module Glimmer
+  module SWT
+    module CustomShell
+      include SuperModule
+      include Glimmer::SWT::CustomWidget
+
+      def initialize(parent, *swt_constants, options, &content)
+        super
+        raise 'Invalid custom shell body root! Must be a shell or another custom shell.' unless body_root.is_a?(GShell) || body_root.is_a?(CustomShell)
+      end
+
+      # Classes may override
+      def open
+        body_root.open
+      end
+
+      # DO NOT OVERRIDE. JUST AN ALIAS FOR `#open`. OVERRIDE `#open` INSTEAD.
+      def show
+        open
+      end
+
+      def close
+        body_root.close
+      end
+
+      def hide
+        body_root.hide
+      end
+
+      def visible?
+        body_root.visible?
+      end
+
+      def center
+        body_root.center
+      end
+
+      def start_event_loop
+        body_root.start_event_loop
+      end
+    end
+  end
+end

data/lib/glimmer/swt/custom_widget.rb

@@ -58,6 +58,16 @@ module Glimmer
             end_eval
           end
         end
+
+        def before_body(&block)
+          @before_body_blocks ||= []
+          @before_body_blocks << block
+        end
+
+        def after_body(&block)
+          @after_body_blocks ||= []
+          @after_body_blocks << block
+        end
       end
 
       attr_reader :body_root, :widget, :parent, :swt_style, :options, :content
@@ -68,7 +78,9 @@ module Glimmer
         options ||= {}
         @options = self.class.options.merge(options)
         @content = ProcTracker.new(content) if content
+        execute_hooks('before_body')
         @body_root = body
+        execute_hooks('after_body')
         @widget = @body_root.widget
       end
 
@@ -76,16 +88,26 @@ module Glimmer
         raise 'Not implemented!'
       end
 
-      # TODO consider using delegators
-
-      def can_add_listener?(underscored_listener_name)
-        @body_root.can_add_listener?(underscored_listener_name)
+      def can_handle_observation_request?(observation_request)
+        result = false
+        if observation_request.start_with?('on_updated_')
+          property = observation_request.sub(/^on_updated_/, '')
+          result = can_add_observer?(property)
+        end
+        result || body_root&.can_handle_observation_request?(observation_request)
       end
 
-      # TODO clean up difference between add_listener and add_observer
+      def handle_observation_request(observation_request, &block)
+        if observation_request.start_with?('on_updated_')
+          property = observation_request.sub(/^on_updated_/, '')
+          add_observer(Observer::Proc.new(&block), property) if can_add_observer?(property)
+        else
+          body_root.handle_observation_request(observation_request, &block)
+        end
+      end
 
-      def add_listener(underscored_listener_name, &block)
-        @body_root.add_listener(underscored_listener_name, &block)
+      def can_add_observer?(attribute_name)
+        respond_to?(attribute_name) || @body_root.can_add_observer?(attribute_name)
       end
 
       def add_observer(observer, attribute_name)
@@ -121,11 +143,53 @@ module Glimmer
         "#{attribute_name}="
       end
 
+      # TODO see if it is worth it to eliminate duplication of method_missing
+      # from GWidget using a module
+
+      def method_missing(method, *args, &block)
+        method_name = method.to_s
+        if can_handle_observation_request?(method_name)
+          handle_observation_request(method_name, &block)
+        else
+          super
+        end
+      end
+
       def process_block(block)
         if block.source_location == @content&.__getobj__.source_location
-          @content.call unless @content.called?
+          @content.call(self) unless @content.called?
         else
-          block.call
+          block.call(self)
+        end
+      end
+
+      def has_style?(style)
+        (swt_style & GSWT[style]) == GSWT[style]
+      end
+
+      # TODO see if it is worth it to eliminate duplication of async_exec/sync_exec
+      # delegation to GDisplay, via a module
+
+      def async_exec(&block)
+        GDisplay.instance.async_exec(&block)
+      end
+
+      def sync_exec(&block)
+        GDisplay.instance.sync_exec(&block)
+      end
+
+      def add_content(&block)
+        body_root.add_content(&block)
+      end
+
+      private
+
+      def execute_hooks(hook_name)
+        self.class.instance_variable_get("@#{hook_name}_blocks")&.each_with_index do |hook_block, i|
+          hook_block_number = i + 1
+          self.class.define_method("__#{hook_name}#{hook_block_number}", hook_block)
+          send("__#{hook_name}#{hook_block_number}")
+          self.class.send(:undef_method, "__#{hook_name}#{hook_block_number}")
         end
       end
     end

data/lib/glimmer/swt/g_display.rb

@@ -23,6 +23,14 @@ module Glimmer
       def dispose
         @display.dispose
       end
+
+      def async_exec(&block)
+        @display.asyncExec(GRunnable.new(&block))
+      end
+
+      def sync_exec(&block)
+        @display.syncExec(GRunnable.new(&block))
+      end
     end
   end
 end

data/lib/glimmer/swt/g_font.rb

@@ -7,8 +7,6 @@ module Glimmer
       FONT_STYLES = [:normal, :bold, :italic]
       include_package 'org.eclipse.swt.graphics'
 
-      extend Glimmer
-
       attr_reader :g_widget
       attr_accessor :display
 
@@ -17,11 +15,9 @@ module Glimmer
           @instances ||= {}
           unless @instances[g_widget]
             @instances[g_widget] = new(g_widget)
-            add_contents(g_widget) {
-              on_widget_disposed { |dispose_event|
-                @instances.delete(g_widget)
-              }
-            }
+            g_widget.on_widget_disposed do |dispose_event|
+              @instances.delete(g_widget)
+            end
           end
           @instances[g_widget]
         end

data/lib/glimmer/swt/g_layout.rb

@@ -46,7 +46,7 @@ module Glimmer
       end
 
       def process_block(block)
-        block.call(@layout)
+        block.call(self)
       end
 
       def has_attribute?(attribute_name, *args)

data/lib/glimmer/swt/g_layout_data.rb

@@ -24,7 +24,7 @@ module Glimmer
       end
 
       def process_block(block)
-        block.call(@layout)
+        block.call(self)
       end
 
       def swt_layout_data_class

data/lib/glimmer/swt/g_shell.rb

@@ -10,7 +10,8 @@ module Glimmer
       include_package 'org.eclipse.swt.layout'
       include_package 'org.eclipse.swt.widgets'
 
-      attr_reader :display
+      attr_reader :display, :opened_before
+      alias opened_before? opened_before
 
       # Instantiates shell with same arguments expected by SWT Shell
       def initialize(*args)
@@ -37,10 +38,44 @@ module Glimmer
 
       # Opens shell and starts SWT's UI thread event loop
       def open
-        @widget.pack
-        center
-        @widget.open
-        start_event_loop
+        if @opened_before
+          @widget.setVisible(true)
+          # notify_observers('visible')
+        else
+          @opened_before = true
+          @widget.pack
+          center
+          @widget.open
+          # NOTE: the following line runs after scheduled sync exec events,
+          # but ensures visible status is only updated upon true visibility
+          # async_exec do
+            # notify_observers('visible')
+          # end
+          start_event_loop
+        end
+      end
+      alias show open
+
+      def hide
+        @widget.setVisible(false)
+        # notify_observers('visible')
+      end
+
+      def close
+        @widget.close
+        # notify_observers('visible')
+      end
+
+      # TODO implement and notify_observers('visible') based on open and hide
+
+      def visible?
+        @widget.isDisposed ? false : @widget.isVisible
+      end
+
+      # TODO evaluate if this is needed
+
+      def visible=(visibility)
+        visibility ? show : hide
       end
 
       def start_event_loop
@@ -49,6 +84,23 @@ module Glimmer
         end
         @display.dispose
       end
+
+      def add_observer(observer, property_name)
+        case property_name.to_s
+        when 'visible?'
+          @widget.addListener(GSWT[:show]) do |event|
+            observer.call(visible?)
+          end
+          @widget.addListener(GSWT[:hide]) do |event|
+            observer.call(visible?)
+          end
+          @widget.addListener(GSWT[:close]) do |event|
+            observer.call(visible?)
+          end
+        else
+          super
+        end
+      end
     end
   end
 end