glimmer-dsl-tk 0.0.22 → 0.0.26

data/lib/glimmer/tk/text_proxy.rb

@@ -0,0 +1,187 @@
+# 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
+    # Proxy for Tk::Text
+    #
+    # Follows the Proxy Design Pattern
+    class TextProxy < WidgetProxy
+      def handle_listener(listener_name, &listener)
+        listener_name = listener_name.to_s.downcase
+        case listener_name
+        when '<<modified>>', '<modified>', 'modified'
+          modified_listener = Proc.new do |*args|
+            listener.call(*args)
+            @tk.modified = false
+          end
+          bind('<Modified>', modified_listener)
+        when '<<selection>>', '<selection>', 'selection'
+          bind('<Selection>', listener)
+        else
+          super
+        end
+      end
+    
+      def text=(value)
+        if value != @text
+          if @text && value.start_with?(@text)
+            insert('end', value[@text.size..-1])
+          else
+            delete('1.0', 'end')
+            insert('end', value)
+          end
+          @text = value
+        end
+      end
+      
+      def text
+        @text = get("1.0", 'end')
+      end
+      
+      def add_selection_format(option, value)
+        process_selection_ranges { |range_start, range_end| add_format(range_start, range_end, option, value) }
+      end
+      
+      def remove_selection_format(option, value)
+        process_selection_ranges { |range_start, range_end| remove_format(range_start, range_end, option, value) }
+      end
+      
+      def toggle_selection_format(option, value)
+        process_selection_ranges { |range_start, range_end| toggle_format(range_start, range_end, option, value) }
+      end
+      
+      def add_selection_font_format(option, value)
+        process_selection_ranges { |range_start, range_end| add_font_format(range_start, range_end, option, value) }
+      end
+      
+      def remove_selection_font_format(option, value)
+        process_selection_ranges { |range_start, range_end| remove_font_format(range_start, range_end, option, value) }
+      end
+      
+      def toggle_selection_font_format(option, value)
+        process_selection_ranges { |range_start, range_end| toggle_font_format(range_start, range_end, option, value) }
+      end
+      
+      def process_selection_ranges(&processor)
+        @tk.tag_ranges('sel').each do |region|
+          range_start = region.first
+          range_end = region.last
+          processor.call(range_start, range_end)
+        end
+      end
+      
+      def applied_format?(region_start, region_end, option, value)
+        !applied_format_tags(region_start, region_end, option, value).empty?
+      end
+      
+      def applied_format_tags(region_start, region_end, option, value)
+        tag_names = @tk.tag_names - ['sel']
+        
+        tag_names.select do |tag_name|
+          @tk.tag_ranges(tag_name).any? do |range|
+            if range.first.to_f <= region_start.to_f && range.last.to_f >= region_end.to_f
+              @tk.tag_cget(tag_name, option) == value
+            end
+          end
+        end
+      end
+            
+      def add_format(region_start, region_end, option, value)
+        @@tag_number = 0 unless defined?(@@tag_number)
+        tag = "tag#{@@tag_number += 1}"
+        @tk.tag_configure(tag, {option => value})
+        @tk.tag_add(tag, region_start, region_end)
+        tag
+      end
+      
+      def remove_format(region_start, region_end, option, value)
+        partial_intersection_option_applied_tags = tag_names.select do |tag_name|
+          @tk.tag_ranges(tag_name).any? do |range|
+            if range.first.to_f.between?(region_start.to_f, region_end.to_f) or
+               range.last.to_f.between?(region_start.to_f, region_end.to_f) or
+               (range.first.to_f <= region_start.to_f && range.last.to_f >= region_end.to_f)
+              @tk.tag_cget(tag_name, option) == value
+            end
+          end
+        end
+        
+        partial_intersection_option_applied_tags.each do |tag_name|
+          @tk.tag_remove(tag_name, region_start, region_end)
+        end
+        
+        nil
+      end
+      
+      # toggles option/value tag (removes if already applied)
+      def toggle_format(region_start, region_end, option, value)
+        if applied_format?(region_start, region_end, option, value)
+          remove_format(region_start, region_end, option, value)
+        else
+          add_format(region_start, region_end, option, value)
+        end
+      end
+            
+#       def applied_font_format?(region_start, region_end, option, value)
+#         !applied_font_format_tags(region_start, region_end, option, value).empty?
+#       end
+#
+#       def applied_font_format_tags(region_start, region_end, option, value)
+#         tag_names = @tk.tag_names - ['sel']
+#
+#         tag_names.select do |tag_name|
+#           @tk.tag_ranges(tag_name).any? do |range|
+#             if range.first.to_f <= region_start.to_f && range.last.to_f >= region_end.to_f
+#               @tk.tag_cget(tag_name, option) == value
+#             end
+#           end
+#         end
+#       end
+#
+#       def add_font_format(region_start, region_end, option, value)
+#       end
+#
+#       def remove_font_format(region_start, region_end, option, value)
+#       end
+#
+      ### toggles option/value tag (removes if already applied)
+#       def toggle_font_format(region_start, region_end, option, value)
+#         if applied_font_format?(region_start, region_end, option, value)
+          ### ensure removing from previous font combination (perhaps checking widget font too)
+#           remove_font_format(region_start, region_end, option, value)
+#         else
+          ### ensure adding to previous font combination (perhaps checking widget font too)
+#           add_font_format(region_start, region_end, option, value)
+#         end
+#       end
+            
+      private
+      
+      def initialize_defaults
+        super
+        self.padx = 5
+        self.pady = 5
+      end
+    end
+  end
+end

data/lib/glimmer/tk/text_variable_owner.rb

@@ -0,0 +1,31 @@
+# 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.
+
+module Glimmer
+  module Tk
+    module TextVariableOwner
+      def initialize_defaults
+        super
+        tk.textvariable = ::TkVariable.new
+      end
+    end
+  end
+end

data/lib/glimmer/tk/variable_owner.rb

@@ -0,0 +1,31 @@
+# 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.
+
+module Glimmer
+  module Tk
+    module VariableOwner
+      def initialize_defaults
+        super
+        tk.variable = ::TkVariable.new
+      end
+    end
+  end
+end

data/lib/glimmer/tk/widget_proxy.rb

@@ -26,8 +26,8 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class WidgetProxy
       class << self
-        def create(keyword, parent, args)
-          widget_proxy_class(keyword).new(keyword, parent, args)
+        def create(keyword, parent, args, &block)
+          widget_proxy_class(keyword).new(keyword, parent, args, &block)
         end
         
         def widget_proxy_class(keyword)
@@ -57,45 +57,35 @@ module Glimmer
               Glimmer::Config.logger.debug e.full_message
             end
           end
-          tk_widget_class
+          tk_widget_class if tk_widget_class.respond_to?(:new)
         end
       end
       
-      attr_reader :parent_proxy, :tk, :args, :keyword
+      attr_reader :parent_proxy, :tk, :args, :keyword, :children
 
-      DEFAULT_INITIALIZERS = {
-        'checkbutton' => lambda do |tk|
-          tk.variable = ::TkVariable.new
-        end,
-        'combobox' => lambda do |tk|
-          tk.textvariable = ::TkVariable.new
-        end,
-        'label' => lambda do |tk|
-          tk.textvariable = ::TkVariable.new
-        end,
-        'entry' => lambda do |tk|
-          tk.textvariable = ::TkVariable.new
-        end,
-      }
-            
       # Initializes a new Tk Widget
       #
       # Styles is a comma separate list of symbols representing Tk styles in lower case
-      def initialize(underscored_widget_name, parent_proxy, args)
+      def initialize(underscored_widget_name, parent_proxy, args, &block)
         @parent_proxy = parent_proxy
         @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)
         # a common widget initializer
-        @tk.grid unless @tk.is_a?(::Tk::Toplevel)
-        DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@tk)
         @parent_proxy.post_initialize_child(self)
+        initialize_defaults
+        post_add_content if @block.nil?
+      end
+      
+      def children
+        @children ||= []
       end
       
       # Subclasses may override to perform post initialization work on an added child
       def post_initialize_child(child)
-        # No Op by default
+        children << child
       end
 
       # Subclasses may override to perform post add_content work
@@ -154,41 +144,55 @@ module Glimmer
           tk_widget_has_attribute_getter_setter?(attribute) or
           has_state?(attribute) or
           has_attributes_attribute?(attribute) or
-          respond_to?(attribute_setter(attribute), args)
+          respond_to?(attribute_setter(attribute), args) or
+          respond_to?(attribute_setter(attribute), *args, super_only: true) or
+          respond_to?(attribute, *args, super_only: true)
       end
 
       def set_attribute(attribute, *args)
-        widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
-        if widget_custom_attribute
-          widget_custom_attribute[:setter][:invoker].call(@tk, args)
-        elsif tk_widget_has_attribute_setter?(attribute)
-          unless args.size == 1 && @tk.send(attribute) == args.first
-            if args.size == 1
-              @tk.send(attribute_setter(attribute), *args)
+        begin
+          widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
+          if respond_to?(attribute_setter(attribute), super_only: true)
+            send(attribute_setter(attribute), *args)
+          elsif respond_to?(attribute, super_only: true) && self.class.instance_method(attribute).parameters.size > 0
+            send(attribute, *args)
+          elsif widget_custom_attribute
+            widget_custom_attribute[:setter][:invoker].call(@tk, args)
+          elsif tk_widget_has_attribute_setter?(attribute)
+            unless args.size == 1 && @tk.send(attribute) == args.first
+              if args.size == 1
+                @tk.send(attribute_setter(attribute), *args)
+              else
+                @tk.send(attribute_setter(attribute), args)
+              end
+            end
+          elsif tk_widget_has_attribute_getter_setter?(attribute)
+            @tk.send(attribute, *args)
+          elsif has_state?(attribute)
+            attribute = attribute.sub(/=$/, '')
+            if !!args.first
+              @tk.tile_state(attribute)
             else
-              @tk.send(attribute_setter(attribute), args)
+              @tk.tile_state("!#{attribute}")
             end
-          end
-        elsif tk_widget_has_attribute_getter_setter?(attribute)
-          @tk.send(attribute, *args)
-        elsif has_state?(attribute)
-          attribute = attribute.sub(/=$/, '')
-          if !!args.first
-            @tk.tile_state(attribute)
+          elsif has_attributes_attribute?(attribute)
+            attribute = attribute.sub(/=$/, '')
+            @tk.attributes(attribute, args.first)
           else
-            @tk.tile_state("!#{attribute}")
+            raise "#{self} cannot handle attribute #{attribute} with args #{args.inspect}"
           end
-        elsif has_attributes_attribute?(attribute)
-          attribute = attribute.sub(/=$/, '')
-          @tk.attributes(attribute, args.first)
-        else
-          send(attribute_setter(attribute), args)
+        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}
+          apply_style(attribute => args.first)
         end
       end
 
       def get_attribute(attribute)
         widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
-        if widget_custom_attribute
+        if respond_to?(attribute, super_only: true)
+          send(attribute)
+        elsif widget_custom_attribute
           widget_custom_attribute[:getter][:invoker].call(@tk, args)
         elsif tk_widget_has_attribute_getter_setter?(attribute)
           @tk.send(attribute)
@@ -207,7 +211,49 @@ module Glimmer
         "#{attribute}="
       end
       
+      def style=(styles)
+        styles.each do |attribute, value|
+          apply_style(attribute => value)
+        end
+      end
+      
+      def grid(options = {})
+        options = options.stringify_keys
+        index_in_parent = @parent_proxy.children.index(self)
+        options['rowweight'] = options.delete('row_weight') if options.keys.include?('row_weight')
+        options['columnweight'] = options.delete('column_weight') if options.keys.include?('column_weight')
+        options['columnweight'] = options['rowweight'] = options.delete('weight')  if options.keys.include?('weight')
+        options['rowminsize'] = options.delete('row_minsize') if options.keys.include?('row_minsize')
+        options['rowminsize'] = options.delete('minheight') if options.keys.include?('minheight')
+        options['rowminsize'] = options.delete('min_height') if options.keys.include?('min_height')
+        options['columnminsize'] = options.delete('column_minsize') if options.keys.include?('column_minsize')
+        options['columnminsize'] = options.delete('minwidth') if options.keys.include?('minwidth')
+        options['columnminsize'] = options.delete('min_width') if options.keys.include?('min_width')
+        options['columnminsize'] = options['rowminsize'] = options.delete('minsize')  if options.keys.include?('minsize')
+        TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
+        TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
+        TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
+        TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
+        @tk.grid(options)
+      end
+      
+      def font=(value)
+        @tk.font = value.is_a?(TkFont) ? value : TkFont.new(value)
+      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}
+        apply_style({"font" => value})
+      end
+      
+      def apply_style(options)
+        @@style_number = 0 unless defined?(@@style_number)
+        style = "style#{@@style_number}.#{@tk.class.name.split('::').last}"
+        ::Tk::Tile::Style.configure(style, options)
+        @tk.style = style
+      end
+      
       def widget_custom_attribute_mapping
+        # TODO consider extracting to modules/subclasses
         @widget_custom_attribute_mapping ||= {
           ::Tk::Tile::TButton => {
             'image' => {
@@ -221,10 +267,24 @@ module Glimmer
               setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
             },
             'variable' => {
-              getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value.to_i == 1 }},
+              getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value.to_s == @tk.onvalue.to_s }},
               setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.value = args.first.is_a?(Integer) ? args.first : (args.first ? 1 : 0) }},
             },
           },
+          ::Tk::Tile::TRadiobutton => {
+            'image' => {
+              getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
+              setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
+            },
+            'text' => {
+              getter: {name: 'text', invoker: lambda { |widget, args| @tk.text }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.value = @tk.text = args.first }},
+            },
+            'variable' => {
+              getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value == @tk.value }},
+              setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.value = args.first ? @tk.value : @tk.variable&.value }},
+            },
+          },
           ::Tk::Tile::TCombobox => {
             'text' => {
               getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
@@ -244,18 +304,31 @@ module Glimmer
           ::Tk::Tile::TEntry => {
             'text' => {
               getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
-              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first unless @text_variable_edit }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
+            },
+          },
+          ::Tk::Tile::TSpinbox => {
+            'text' => {
+              getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
+            },
+          },
+          ::Tk::Root => {
+            'text' => {
+              getter: {name: 'text', invoker: lambda { |widget, args| @tk.title }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.title = args.first }},
             },
           },
         }
       end
       
       def widget_attribute_listener_installers
+        # TODO consider extracting to modules/subclasses
         @tk_widget_attribute_listener_installers ||= {
           ::Tk::Tile::TCheckbutton => {
             'variable' => lambda do |observer|
               @tk.command {
-                observer.call(@tk.variable.value.to_i == 1)
+                observer.call(@tk.variable.value.to_s == @tk.onvalue.to_s)
               }
             end,
           },
@@ -273,16 +346,37 @@ module Glimmer
           },
           ::Tk::Tile::TEntry => {
             'text' => lambda do |observer|
-              tk.validate = 'key'
-              tk.validatecommand { |new_tk_variable|
-                @text_variable_edit = new_tk_variable.value != @tk.textvariable.value
-                if @text_variable_edit
-                  observer.call(new_tk_variable.value)
-                  @text_variable_edit = nil
-                  true
-                else
-                  false
-                end
+              @tk.textvariable.trace('write') {
+                observer.call(@tk.textvariable.value)
+              }
+            end,
+          },
+          ::Tk::Tile::TSpinbox => {
+            'text' => lambda do |observer|
+              @tk.command {
+                observer.call(@tk.textvariable&.value)
+              }
+              @tk.validate('key')
+              @tk.validatecommand { |validate_args|
+                observer.call(validate_args.value)
+                new_icursor = validate_args.index
+                new_icursor += validate_args.string.size if validate_args.action == 1
+                @tk.icursor = new_icursor
+                true
+              }
+            end,
+          },
+          ::Tk::Text => {
+            'text' => lambda do |observer|
+              handle_listener('modified') do
+                observer.call(text)
+              end
+            end,
+          },
+          ::Tk::Tile::TRadiobutton => {
+            'variable' => lambda do |observer|
+              @tk.command {
+                observer.call(@tk.variable.value == @tk.value)
               }
             end,
           },
@@ -341,10 +435,21 @@ module Glimmer
         super(method.to_sym, *args, &block)
       end
       
-      def respond_to?(method, *args, &block)
-        super ||
-          tk.respond_to?(method, *args, &block)
+      def respond_to?(method, *args, super_only: false, &block)
+        super(method, true) ||
+          !super_only && tk.respond_to?(method, *args, &block)
+      end
+      
+      private
+      
+      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)
       end
     end
   end
 end
+
+Dir[File.expand_path('./*_proxy.rb', __dir__)].each {|f| require f}

data/lib/glimmer-dsl-tk.rb

@@ -28,6 +28,7 @@ require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 # require 'super_module'
 require 'tk'
 require 'os'
+require 'facets/hash/symbolize_keys'
 
 # Internal requires
 # require 'ext/glimmer/config'