glimmer-dsl-tk 0.0.35 → 0.0.39

data/lib/glimmer/tk/menu_item_proxy.rb

@@ -0,0 +1,202 @@
+# 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk
+    class MenuItemProxy < WidgetProxy
+      ACCELERATOR_MODIFIER_EVENT_MAP = {
+        'Command' => 'Command',
+        'Cmd' => 'Command',
+        'Meta' => 'Command',
+        'Option' => 'Option',
+        'Opt' => 'Option',
+        'Alt' => 'Option',
+        'Shift' => 'Shift',
+        'Ctrl' => 'Control',
+        'Control' => 'Control',
+      }
+      
+      attr_reader :options
+    
+      def initialize(underscored_widget_name, parent_proxy, args, &block)
+        @options = args.last.is_a?(Hash) ? args.last : {}
+        super
+      end
+    
+      def accelerator=(value)
+        @accelerator = value
+        configure_menu_item_attribute(accelerator: value)
+        root_parent_proxy.bind(accelerator_event) do |event|
+          @command_block&.call(event)
+        end
+      end
+      
+      def accelerator
+        @accelerator
+      end
+      
+      def accelerator_event
+        accelerator_parts = @accelerator.split('+')
+        accelerator_parts.map do |accelerator_part|
+          ACCELERATOR_MODIFIER_EVENT_MAP[accelerator_part.capitalize] || accelerator_part.downcase
+        end.join('-')
+      end
+      
+      def state=(value)
+        @state = value
+        configure_menu_item_attribute(state: value)
+      end
+      
+      def state
+        @state
+      end
+      
+      def label
+        @options[:label]
+      end
+      
+      def image=(*args)
+        @image = image_argument(args)
+        configure_menu_item_attribute(image: @image)
+      end
+      
+      def image
+        @image
+      end
+      
+      def compound=(value)
+        @compound = value
+        configure_menu_item_attribute(compound: @compound)
+      end
+      
+      def compound
+        @compound
+      end
+      
+      def command_block=(proc)
+        @command_block = proc
+        configure_menu_item_attribute(command: @command_block)
+      end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s.downcase
+        when 'command'
+          self.command_block = listener
+        else
+          super
+        end
+      end
+      
+      def command?
+        @args.first.nil? || @args.first == :command || @args.first.is_a?(Hash)
+      end
+      
+      def radiobutton?
+        @args.first == :radiobutton
+      end
+      
+      def checkbutton?
+        @args.first == :radiobutton
+      end
+      
+      def separator?
+        @args.first == :separator
+      end
+      
+      def about?
+        @args.first == :about
+      end
+      
+      def preferences?
+        @args.first == :preferences
+      end
+      
+      def help?
+        @args.first == :help
+      end
+      
+      def quit?
+        @args.first == :quit
+      end
+      
+      def variable(auto_create: true)
+        if @variable.nil? && auto_create
+          sibling_variable = sibling_radio_menu_items.map {|mi| mi.variable(auto_create: false)}.compact.first
+          @variable = sibling_variable.nil? ? ::TkVariable.new : sibling_variable
+        else
+          @variable
+        end
+        @variable
+      end
+      
+      def selection=(value)
+        if value
+          variable.value = label
+        elsif checkbutton?
+          variable.value = ''
+        end
+      end
+      
+      def selection
+        variable.value == label
+      end
+      
+      # configures menu item attribute through parent menu
+      def configure_menu_item_attribute(attribute_value_hash)
+        if preferences? && attribute_value_hash[:command]
+          ::Tk.ip_eval("proc ::tk::mac::ShowPreferences {} {#{::Tk.install_cmd(attribute_value_hash[:command])}}")
+        elsif help? && attribute_value_hash[:command]
+          ::Tk.ip_eval("proc ::tk::mac::ShowHelp {} {#{::Tk.install_cmd(attribute_value_hash[:command])}}")
+        elsif quit? && attribute_value_hash[:command]
+          ::Tk.ip_eval("proc ::tk::mac::Quit {} {#{::Tk.install_cmd(attribute_value_hash[:command])}}")
+        else
+          @parent_proxy.tk.entryconfigure label, attribute_value_hash
+        end
+      end
+      
+      private
+      
+      def sibling_radio_menu_items
+        @parent_proxy.children.select {|child| child.is_a?(MenuItemProxy) && radiobutton? && child != self}
+      end
+      
+      def build_widget
+        @args.prepend(:command) if @args.first.is_a?(Hash)
+        @args.append({}) if !@args.last.is_a?(Hash)
+        @args.last.merge!(variable: variable, value: label) if radiobutton? || checkbutton?
+        case @parent_proxy
+        when MenuProxy
+          if @parent_proxy.application?
+            if OS.mac?
+              if about?
+                @parent_proxy.tk.add :command, :label => label
+              end
+            end
+          else
+            @parent_proxy.tk.add(*@args) unless help?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/menu_proxy.rb

@@ -0,0 +1,88 @@
+# 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk
+    class MenuProxy < WidgetProxy
+      attr_reader :options
+      
+      def initialize(underscored_widget_name, parent_proxy, args, &block)
+        @options = args.last.is_a?(Hash) ? args.last : {}
+        super
+      end
+      
+      def post_add_content
+        case @parent_proxy
+        when ToplevelProxy
+          @parent_proxy.tk['menu'] = @tk
+        end
+      end
+      
+      def label
+        @options[:label]
+      end
+      
+      def help?
+        label == 'Help'
+      end
+      
+      def window?
+        label == 'Window'
+      end
+      
+      def system?
+        label == 'System'
+      end
+      
+      def application?
+        @args.first == :application
+      end
+      
+      private
+      
+      def build_widget
+        if application?
+          if OS.mac?
+            @tk = ::TkSysMenu_Apple.new(@parent_proxy.tk)
+            @parent_proxy.tk.add :cascade, :menu => @tk
+          end
+        else
+          if @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && (OS.mac? || OS.linux?) && help?
+            @tk = ::TkSysMenu_Help.new(@parent_proxy.tk)
+          elsif @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && OS.mac? && window?
+            @tk = ::Tk::TkSysMenu_Window.new(@parent_proxy.tk)
+          elsif @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && OS.windows? && system?
+            @tk = ::TkSysMenu_System.new(@parent_proxy.tk)
+          else
+            tk_widget_class = self.class.tk_widget_class_for(@keyword)
+            @tk = tk_widget_class.new(@parent_proxy.tk)
+          end
+          case @parent_proxy
+          when MenuProxy
+            @parent_proxy.tk.add(:cascade, {menu: @tk}.merge(@options))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/root_proxy.rb

@@ -36,6 +36,7 @@ module Glimmer
 
       def post_add_content
         set_attribute('iconphoto', File.expand_path('../../../icons/glimmer.png', __dir__)) if @tk.iconphoto.nil?
+        super
       end
       
       def open
@@ -46,22 +47,6 @@ module Glimmer
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::RootExpression.new, keyword, *args, &block)
       end
       
-      def set_attribute(attribute, *args)
-        case attribute.to_s
-        when 'iconphoto'
-          args[0..-1] = [image_argument(args)]
-          super
-        when 'resizable'
-          if args.size == 1 && !args.first.is_a?(Array)
-            self.resizable = [args.first]*2
-          else
-            super
-          end
-        else
-          super
-        end
-      end
-      
       def handle_listener(listener_name, &listener)
         case listener_name.to_s.upcase
         when 'WM_OPEN_WINDOW', 'OPEN_WINDOW'

data/lib/glimmer/tk/text_proxy.rb

@@ -92,31 +92,31 @@ module Glimmer
         end
       end
       
-      def add_selection_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| add_format(range_start, range_end, option, value) }
+      def add_selection_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| add_format(range_start, range_end, option, value) }
       end
       
-      def remove_selection_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| remove_format(range_start, range_end, option, value) }
+      def remove_selection_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| remove_format(range_start, range_end, option, value) }
       end
       
-      def toggle_selection_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| toggle_format(range_start, range_end, option, value) }
+      def toggle_selection_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| toggle_format(range_start, range_end, option, value) }
       end
       
-      def add_selection_font_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| add_font_format(range_start, range_end, option, value) }
+      def add_selection_font_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| add_font_format(range_start, range_end, option, value) }
       end
       
-      def remove_selection_font_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| remove_font_format(range_start, range_end, option, value) }
+      def remove_selection_font_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| remove_font_format(range_start, range_end, option, value) }
       end
       
-      def toggle_selection_font_format(option, value, no_selection_default: :insert_word)
-        process_selection_ranges(no_selection_default: no_selection_default) { |range_start, range_end| toggle_font_format(range_start, range_end, option, value) }
+      def toggle_selection_font_format(option, value, no_selection_default: :insert_word, focus: true)
+        process_selection_ranges(no_selection_default: no_selection_default, focus: focus) { |range_start, range_end| toggle_font_format(range_start, range_end, option, value) }
       end
       
-      def process_selection_ranges(no_selection_default: :insert_word, &processor)
+      def process_selection_ranges(no_selection_default: :insert_word, focus: true, &processor)
         regions = @tk.tag_ranges('sel')
         if regions.empty?
           case no_selection_default
@@ -131,6 +131,11 @@ module Glimmer
           range_end = region.last
           processor.call(range_start, range_end)
         end
+        if focus == true
+          @tk.focus
+        elsif focus.is_a?(Integer)
+          ::Tk.after(focus) { @tk.focus }
+        end
       end
       
       def applied_format?(region_start, region_end, option, value)
@@ -432,16 +437,11 @@ module Glimmer
         self.wrap = 'none'
         self.padx = 5
         self.pady = 5
-#         on('Modified') { apply_all_tag }
       end
       
       def clone_font(font)
         ::TkFont.new(Hash[font.actual])
       end
-      
-#       def apply_all_tag
-#         @tk.tag_add(ALL_TAG, '1.0', 'end')
-#       end
     end
   end
 end

data/lib/glimmer/tk/toplevel_proxy.rb

@@ -32,11 +32,40 @@ module Glimmer
       DEFAULT_HEIGHT = 95
       
       attr_reader :tk
+      attr_accessor :escapable
+      alias escapable? escapable
+      
+      def post_add_content
+        if escapable?
+           on('KeyPress') do |event|
+            if event.keysym == 'Escape'
+              grab_release
+              destroy
+            end
+          end
+        end
+      end
       
       def has_attribute?(attribute, *args)
         %w[width height x y].include?(attribute.to_s) || super
       end
       
+      def set_attribute(attribute, *args)
+        case attribute.to_s
+        when 'iconphoto'
+          args[0..-1] = [image_argument(args)]
+          super
+        when 'resizable'
+          if args.size == 1 && !args.first.is_a?(Array)
+            self.resizable = [args.first]*2
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+      
       def width
         geometry.split(REGEX_GEOMETRY)[0].to_i
       end
@@ -114,6 +143,17 @@ module Glimmer
           destroy
         end
       end
+      
+      def mac_style=(mac_class, mac_attribute_list = nil)
+        if OS.mac?
+          @mac_style = [mac_class, mac_attribute_list]
+          ::Tk.tk_call("::tk::unsupported::MacWindowStyle", "style", @tk, *@mac_style.compact)
+        end
+      end
+      
+      def mac_style
+        @mac_style
+      end
     end
   end
 end

data/lib/glimmer/tk/widget_proxy.rb

@@ -77,8 +77,7 @@ module Glimmer
         @args = args
         @keyword = underscored_widget_name
         @block = block
-        tk_widget_class = self.class.tk_widget_class_for(underscored_widget_name)
-        @tk = tk_widget_class.new(@parent_proxy.tk, *args)
+        build_widget
         # a common widget initializer
         @parent_proxy.post_initialize_child(self)
         initialize_defaults
@@ -121,7 +120,7 @@ module Glimmer
       end
 
       def self.widget_exists?(underscored_widget_name)
-        !!tk_widget_class_for(underscored_widget_name)
+        !!tk_widget_class_for(underscored_widget_name) || (Glimmer::Tk.constants.include?("#{underscored_widget_name.camelcase(:upper)}Proxy".to_sym) && Glimmer::Tk.const_get("#{underscored_widget_name.camelcase(:upper)}Proxy".to_sym).respond_to?(:new))
       end
 
       def tk_widget_has_attribute_setter?(attribute)
@@ -213,8 +212,8 @@ module Glimmer
             raise "#{self} cannot handle attribute #{attribute} with args #{args.inspect}"
           end
         rescue => e
-          Glimmer::Config.logger.debug {"Failed to set attribute #{attribute} with args #{args.inspect}. Attempting to set through style instead..."}
-          Glimmer::Config.logger.debug {e.full_message}
+          Glimmer::Config.logger.error {"Failed to set attribute #{attribute} with args #{args.inspect}. Attempting to set through style instead..."}
+          Glimmer::Config.logger.error {e.full_message}
           apply_style(attribute => args.first)
         end
       end
@@ -460,14 +459,20 @@ module Glimmer
           parent_proxy.handle_listener(listener_name, &listener) if parent_proxy
           # TODO return a listener registration object that has a deregister method
         else
+          @listeners ||= {}
           begin
-            @tk.bind(listener_name, &listener)
+            @listeners[listener_name] ||= []
+            @tk.bind(listener_name) { |event| @listeners[listener_name].each {|l| l.call(event)} } if @listeners[listener_name].empty?
+            @listeners[listener_name] << listener
           rescue => e
+            @listeners.delete(listener_name)
             Glimmer::Config.logger.debug {"Unable to bind to #{listener_name} .. attempting to surround with <>"}
             Glimmer::Config.logger.debug {e.full_message}
             listener_name = "<#{listener_name}" if !listener_name.start_with?('<')
             listener_name = "#{listener_name}>" if !listener_name.end_with?('>')
-            @tk.bind(listener_name, &listener)
+            @listeners[listener_name] ||= []
+            @tk.bind(listener_name) { |event| @listeners[listener_name].each {|l| l.call(event)} } if @listeners[listener_name].empty?
+            @listeners[listener_name] << listener
           end
         end
       end
@@ -501,11 +506,16 @@ module Glimmer
       
       private
       
+      def build_widget
+        tk_widget_class = self.class.tk_widget_class_for(@keyword)
+        @tk = tk_widget_class.new(@parent_proxy.tk, *args)
+      end
+      
       def initialize_defaults
         options = {}
         options[:sticky] = 'nsew'
         options[:column_weight] = 1 if @parent_proxy.children.count == 1
-        grid(options) unless @tk.is_a?(::Tk::Toplevel)
+        grid(options) unless @tk.is_a?(::Tk::Toplevel) || @tk.is_a?(::Tk::Menu) || @tk.nil? # TODO refactor by adding a griddable? method that could be overriden by subclasses to consult for this call
       end
     end
   end

data/lib/glimmer-dsl-tk.rb

@@ -29,14 +29,26 @@ require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 require 'tk'
 require 'os'
 require 'facets/hash/symbolize_keys'
+require 'facets/string/underscore'
+require 'facets/string/camelcase'
+require 'delegate'
 
 # Internal requires
 # require 'ext/glimmer/config'
 # require 'ext/glimmer'
 require 'glimmer/dsl/tk/dsl'
+
 Glimmer::Config.loop_max_count = -1
+
 Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
   method = method_symbol.to_s
   result = false
   result ||= method == 'load_iseq'
 end
+
+::TkOption.add '*tearOff', 0
+
+class ::Tk::TkSysMenu_Window < Tk::Menu
+  include Tk::SystemMenu
+  SYSMENU_NAME = 'window'
+end

data/samples/hello/hello_button.rb

@@ -81,7 +81,7 @@ class HelloButton
         ['center', 'top', 'bottom', 'left', 'right'].each do |compound_option|
           button {
             image File.expand_path('../../icons/glimmer.png', __dir__), subsample: 5
-            text 'Text Image Button'
+            text "#{compound_option.capitalize} Image"
             compound compound_option
             
             command {

data/samples/hello/hello_checkbutton.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2021 Andy Maleh
+`# 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