glimmer-dsl-swing 0.0.1

data/lib/glimmer/swing/component_proxy.rb

@@ -0,0 +1,242 @@
+# Copyright (c) 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/swing/packages'
+require 'glimmer/swing/component_listener_proxy'
+
+module Glimmer
+  module Swing
+    # Proxy for Swing/AWT component objects
+    #
+    # Follows the Proxy Design Pattern
+    class ComponentProxy
+      include Packages
+
+      class << self
+        def exist?(keyword)
+          !!component_proxy_class(keyword)
+        end
+        
+        def create(parent, keyword, *args, &block)
+          component_proxy_class(keyword).new(parent, keyword, *args, &block)
+        end
+        
+        def component_proxy_class(keyword)
+          begin
+            class_name = component_proxy_class_symbol(keyword)
+            Glimmer::Swing::ComponentProxy.const_get(class_name)
+          rescue => e
+            Glimmer::Config.logger.debug e.full_message
+            Glimmer::Swing::ComponentProxy
+          end
+        end
+        
+        def component_proxy_class_symbol(keyword)
+          "#{keyword.camelcase(:upper)}Proxy".to_sym
+        end
+        
+        def component_class_symbol(keyword)
+          keyword.camelcase(:upper).to_sym
+        end
+        
+        def keyword(component_proxy_class)
+          component_proxy_class.to_s.underscore.sub(/_proxy$/, '')
+        end
+        
+        def component_class_manual_entries
+          # add mappings for any classes (minus the namespace) that conflict with standard Ruby classes
+          {
+            # example:
+            # 'date_time' => Java::OrgEclipseSwtWidgets::DateTime
+          }
+        end
+          
+        def component_class(keyword)
+          unless flyweight_component_class.keys.include?(keyword)
+            begin
+              pd component_class_name = component_class_symbol(keyword).to_s
+              pd component_class = eval(component_class_name)
+              unless component_class.ancestors.include?(Java::JavaAwt::Component)
+                component_class = component_class_manual_entries[keyword]
+                if component_class.nil?
+                  Glimmer::Config.logger.debug {"Class #{component_class} matching #{keyword} is not a subclass of java.awt.Component"}
+                  return nil
+                end
+              end
+              flyweight_component_class[keyword] = component_class
+            rescue SyntaxError, NameError => e
+              Glimmer::Config.logger.debug {e.full_message}
+              nil
+            rescue => e
+              Glimmer::Config.logger.debug {e.full_message}
+              nil
+            end
+          end
+          flyweight_component_class[keyword]
+        end
+        
+        # Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.
+        def flyweight_component_class
+          @flyweight_component_class ||= {}
+        end
+      end
+      
+      attr_reader :parent_proxy, :original, :args, :keyword, :block
+      
+      def initialize(parent, keyword, *args, &block)
+        @parent_proxy = parent
+        @keyword = keyword
+        @args = args
+        @block = block
+        build_widget
+        post_add_content if @block.nil?
+      end
+      
+      # Subclasses may override to perform post add_content work (normally must call super)
+      def post_add_content
+        @parent_proxy&.post_initialize_child(self)
+      end
+      
+      # Subclasses may override to perform post initialization work on an added child (normally must also call super)
+      def post_initialize_child(child)
+        add(child)
+      end
+      
+      def respond_to?(method_name, *args, &block)
+        respond_to_original?(method_name, *args, &block) ||
+          super(method_name, true)
+      end
+      
+      def respond_to_original?(method_name, *args, &block)
+        @original.respond_to?(method_name, true) || @original.respond_to?("set_#{method_name}", true)
+      end
+      
+      def method_missing(method_name, *args, &block)
+        if @original.respond_to?("set_#{method_name}", true) && !args.empty?
+          send_to_original("set_#{method_name}", *args, &block)
+        elsif @original.respond_to?(method_name, true)
+          send_to_original(method_name, *args, &block)
+        else
+          super
+        end
+      end
+      
+      def send_to_original(method_name, *args, &block)
+        @original.send(method_name, *normalize_args(args), &block)
+      end
+      
+      def content(&block)
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Swing::ComponentExpression.new, @keyword, &block)
+      end
+      
+      def can_handle_observation_request?(observation_request)
+        if observation_request.start_with?('on_')
+          event = observation_request.sub(/^on_/, '')
+          can_add_listener?(event)
+        end
+      end
+      
+      def handle_observation_request(observation_request, &block)
+        if observation_request.start_with?('on_')
+          event = observation_request.sub(/^on_/, '')
+          if can_add_listener?(event)
+            event = observation_request.sub(/^on_/, '')
+            add_listener(event, &block)
+          end
+        end
+      end
+      
+      def can_add_listener?(underscored_listener_name)
+        @original && !self.class.find_listener(@original.getClass, underscored_listener_name).empty?
+      end
+
+      def add_listener(underscored_listener_name, &block)
+        component_add_listener_method, listener_class, listener_method = self.class.find_listener(@original.getClass, underscored_listener_name)
+        component_listener_proxy = nil
+        listener = listener_class.new(listener_method => block)
+        @original.send(component_add_listener_method, listener)
+        ComponentListenerProxy.new(component: @original, listener: listener, component_add_listener_method: component_add_listener_method, listener_class: listener_class, listener_method: listener_method)
+      end
+
+      # Looks through SWT class add***Listener methods till it finds one for which
+      # the argument is a listener class that has an event method matching
+      # underscored_listener_name
+      def self.find_listener(component_class, underscored_listener_name)
+        @listeners ||= {}
+        listener_key = [component_class.name, underscored_listener_name]
+        unless @listeners.has_key?(listener_key)
+          listener_method_name = underscored_listener_name.camelcase(:lower)
+          component_class.getMethods.each do |component_add_listener_method|
+            if component_add_listener_method.getName.match(/add.*Listener/)
+              component_add_listener_method.getParameterTypes.each do |listener_type|
+                listener_type.getMethods.each do |listener_method|
+                  if (listener_method.getName == listener_method_name)
+                    @listeners[listener_key] = [component_add_listener_method.getName, listener_class(listener_type), listener_method.getName]
+                    return @listeners[listener_key]
+                  end
+                end
+              end
+            end
+          end
+          @listeners[listener_key] = []
+        end
+        @listeners[listener_key]
+      end
+
+      # Returns a Ruby class that implements listener type Java interface with ability to easily
+      # install a block that gets called upon calling a listener event method
+      def self.listener_class(listener_type)
+        @listener_classes ||= {}
+        listener_class_key = listener_type.name
+        unless @listener_classes.has_key?(listener_class_key)
+          @listener_classes[listener_class_key] = Class.new(Object).tap do |listener_class|
+            listener_class.send :include, (eval listener_type.name.sub("interface", ""))
+            listener_class.define_method('initialize') do |event_method_block_mapping|
+              @event_method_block_mapping = event_method_block_mapping
+            end
+            listener_type.getMethods.each do |event_method|
+              listener_class.define_method(event_method.getName) do |*args|
+                @event_method_block_mapping[event_method.getName]&.call(*args)
+              end
+            end
+          end
+        end
+        @listener_classes[listener_class_key]
+      end
+
+      private
+      
+      def build_widget
+        pd keyword
+        pd ComponentProxy.component_class(keyword)
+        @original = ComponentProxy.component_class(keyword).new(*normalize_args(args))
+      end
+      
+      def normalize_args(args)
+        args.map do |arg|
+          arg.is_a?(ComponentProxy) ? arg.original : arg
+        end
+      end
+    end
+  end
+end
+
+Dir[File.expand_path("./#{File.basename(__FILE__, '.rb')}/*.rb", __dir__)].each {|f| require f}

data/lib/glimmer/swing/ext/glimmer/config.rb

@@ -0,0 +1,86 @@
+# 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/config'
+
+module Glimmer
+  module Config
+    DEFAULT_IMPORT_JAVA_PACKAGES = [
+      'java.awt',
+      'java.awt.color',
+      'java.awt.datatransfer',
+      'java.awt.dnd',
+      'java.awt.event',
+      'java.awt.font',
+      'java.awt.geom',
+      'java.awt.im',
+      'java.awt.im.spi',
+      'java.awt.image',
+      'java.awt.image.renderable',
+      'java.awt.print',
+      'javax.swing',
+      'javax.swing.border',
+      'javax.swing.colorchooser',
+      'javax.swing.event',
+      'javax.swing.filechooser',
+      'javax.swing.plaf',
+      'javax.swing.plaf.basic',
+      'javax.swing.plaf.metal',
+      'javax.swing.plaf.multi',
+      'javax.swing.plaf.nimbus',
+      'javax.swing.plaf.synth',
+      'javax.swing.table',
+      'javax.swing.text',
+      'javax.swing.text.html',
+      'javax.swing.text.html.parser',
+      'javax.swing.text.rtf',
+      'javax.swing.tree',
+      'javax.swing.undo',
+    ]
+    
+    class << self
+      # Tells Glimmer to import Java packages into including class (default: true)
+      def import_java_packages=(value)
+        @@import_java_packages = value
+      end
+  
+      # Returns whether Glimmer will import SWT packages into including class
+      def import_java_packages
+        @@import_java_packages = DEFAULT_IMPORT_JAVA_PACKAGES if !defined?(@@import_java_packages) || (defined?(@@import_java_packages) && @@import_java_packages == true)
+        @@import_java_packages
+      end
+      
+    end
+    
+  end
+  
+end
+
+Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
+  method = method_symbol.to_s
+  result = false
+  return true if method == 'load_iseq'
+  return true if method == 'post_initialize_child'
+  return true if method == 'handle'
+  return true if method.end_with?('=')
+end
+
+Glimmer::Config.loop_max_count = 300

data/lib/glimmer/swing/ext/glimmer.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 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/swing/packages'
+
+module Glimmer
+  class << self
+    def included(klass)
+      if Object.const_defined?(:ActiveSupport) && ActiveSupport.const_defined?(:Dependencies)
+        begin
+          ActiveSupport::Dependencies.unhook!
+        rescue => e
+          # noop TODO support logging unimportant details below debug level
+        end
+      end
+      if Config.import_java_packages
+        klass.include(Swing::Packages)
+        klass.extend(Swing::Packages)
+      end
+      klass.extend(Glimmer)
+    end
+  end
+end

data/lib/glimmer/swing/packages.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 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/swing/ext/glimmer/config'
+
+module Glimmer
+  module Swing
+    # This contains Java imports of SWT Java packages
+    module Packages
+      class << self
+        def included(klass)
+          Glimmer::Config.import_java_packages.to_a.each do |package|
+            include_package(package) if package.is_a?(String)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swing.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 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.
+
+module Glimmer
+  module Swing
+  end
+end

data/lib/glimmer-dsl-swing.rb

@@ -0,0 +1,44 @@
+# Copyright (c) 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.
+
+$LOAD_PATH.unshift(File.expand_path('.', __dir__))
+
+# External requires
+# require 'logging'
+require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
+# require 'super_module'
+require 'java'
+require 'concurrent-ruby' # ensures glimmer relies on Concurrent data-structure classes (e.g. Concurrent::Array)
+require 'glimmer'
+require 'nested_inherited_jruby_include_package'
+require 'os'
+require 'array_include_methods'
+require 'facets/string/underscore'
+require 'facets/string/camelcase'
+require 'facets/hash/stringify_keys'
+
+# Internal requires
+# require 'ext/glimmer/config'
+# require 'ext/glimmer'
+require 'glimmer/swing'
+require 'glimmer/swing/ext/glimmer'
+require 'glimmer/swing/ext/glimmer/config'
+require 'glimmer/dsl/swing/dsl'

data/samples/hello/hello_button.rb

@@ -0,0 +1,13 @@
+require 'glimmer-dsl-swing'
+
+include Glimmer
+
+jframe('Hello, Button!') {
+  @button = jbutton('Click To Increment: 0') {
+    on_action_performed {
+      button_text_match = @button.text.match(/(.*)(\d+)$/)
+      count = button_text_match[2].to_i + 1
+      @button.text = "#{button_text_match[1]}#{count}"
+    }
+  }
+}.show

data/samples/hello/hello_world.rb

@@ -0,0 +1,7 @@
+require 'glimmer-dsl-swing'
+
+include Glimmer
+
+jframe('Hello, World!') {
+  jlabel('Hello, World!')
+}.show