glimmer-dsl-tk 0.0.30 → 0.0.34

data/lib/glimmer/tk/root_proxy.rb

@@ -19,18 +19,14 @@
 # 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'
+require 'glimmer/tk/toplevel_proxy'
 
 module Glimmer
   module Tk
     # Proxy for TkRoot
     #
     # Follows the Proxy Design Pattern
-    class RootProxy < WidgetProxy
-      REGEX_GEOMETRY = /[x+-]/
-      DEFAULT_WIDTH = 190
-      DEFAULT_HEIGHT = 95
-      
+    class RootProxy < ToplevelProxy
       def initialize(*args, &block)
         @tk = ::TkRoot.new
         @tk.minsize = DEFAULT_WIDTH, DEFAULT_HEIGHT
@@ -50,10 +46,6 @@ module Glimmer
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::RootExpression.new, keyword, *args, &block)
       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'
@@ -70,45 +62,8 @@ module Glimmer
         end
       end
       
-      def width
-        geometry.split(REGEX_GEOMETRY)[0].to_i
-      end
-      
-      def height
-        geometry.split(REGEX_GEOMETRY)[1].to_i
-      end
-      
-      def x
-        sign_number(x_sign, geometry.split(REGEX_GEOMETRY)[2].to_i)
-      end
-      
-      def y
-        sign_number(y_sign, geometry.split(REGEX_GEOMETRY)[3].to_i)
-      end
-      
-      def width=(value)
-        @width = value.to_i
-        self.geometry = "#{value.to_i}x#{@height || DEFAULT_HEIGHT}#{x_sign}#{abs_x}#{y_sign}#{abs_y}"
-      end
-      
-      def height=(value)
-        @height = value.to_i
-        self.geometry = "#{@width || DEFAULT_WIDTH}x#{value.to_i}#{x_sign}#{abs_x}#{y_sign}#{abs_y}"
-      end
-      
-      def x=(value)
-        self.geometry = "#{@width || DEFAULT_WIDTH}x#{@height || DEFAULT_HEIGHT}#{value.to_i > 0 ? '+' : '-'}#{value.to_i.abs}#{y_sign}#{abs_y}"
-      end
-      
-      def y=(value)
-        self.geometry = "#{@width || DEFAULT_WIDTH}x#{@height || DEFAULT_HEIGHT}#{x_sign}#{abs_x}#{value.to_i > 0 ? '+' : '-'}#{value.to_i.abs}"
-      end
-      
       def handle_listener(listener_name, &listener)
         case listener_name.to_s.upcase
-        when 'WM_DELETE_WINDOW', 'DELETE_WINDOW'
-          listener_name = 'WM_DELETE_WINDOW'
-          @tk.protocol(listener_name, &listener)
         when 'WM_OPEN_WINDOW', 'OPEN_WINDOW'
           @on_open_window_procs ||= []
           @on_open_window_procs << listener
@@ -128,36 +83,6 @@ module Glimmer
         end
         ::Tk.mainloop
       end
-      
-      private
-      
-      def sign_number(sign, number)
-        "#{sign}1".to_i * number
-      end
-      
-      def abs_x
-        geometry.split(REGEX_GEOMETRY)[2].to_i
-      end
-      
-      def abs_y
-        geometry.split(REGEX_GEOMETRY)[3].to_i
-      end
-      
-      def x_sign
-        geometry_signs[0]
-      end
-      
-      def y_sign
-        geometry_signs[1]
-      end
-      
-      def geometry_signs
-        geometry.chars.select {|char| char.match(/[+-]/)}
-      end
-      
-      def initialize_defaults
-        self.background = '#ececec' if OS.mac?
-      end
     end
   end
 end

data/lib/glimmer/tk/text_proxy.rb

@@ -27,48 +27,118 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class TextProxy < WidgetProxy
+      ALL_TAG = '__all__'
+      FORMAT_DEFAULT_MAP = {
+        'justify' => 'left',
+      }
+    
       def handle_listener(listener_name, &listener)
-        listener_name = listener_name.to_s.downcase
-        case listener_name
+        case listener_name.to_s.downcase
         when '<<modified>>', '<modified>', 'modified'
           modified_listener = Proc.new do |*args|
+            @modified_count ||= 0
+            @modified_count += 1
             listener.call(*args)
+            apply_all_tag
+            @insert_mark_moved_proc&.call
             @tk.modified = false
           end
-          bind('<Modified>', modified_listener)
+          @tk.bind('<Modified>', modified_listener)
         when '<<selection>>', '<selection>', 'selection'
-          bind('<Selection>', listener)
-        else
+          @tk.bind('<Selection>', listener)
+        when 'destroy'
           super
+        when 'insertmarkmove', 'insertmarkmoved', 'insert_mark_move', 'insert_mark_moved'
+          if @insert_mark_moved_proc.nil?
+            handle_listener('KeyPress') do |event|
+              @insert_mark_moved_proc&.call
+            end
+            handle_listener('KeyRelease') do |event|
+              @insert_mark_moved_proc&.call
+            end
+            handle_listener('ButtonPress') do |event|
+              @insert_mark_moved_proc&.call
+            end
+            handle_listener('ButtonRelease') do |event|
+              @insert_mark_moved_proc&.call
+            end
+          end
+          @insert_mark = @tk.index('insert')
+          @insert_mark_moved_proc = Proc.new do
+            new_insert_mark = @tk.index('insert')
+            if new_insert_mark != @insert_mark
+              @insert_mark = new_insert_mark
+              listener.call(new_insert_mark)
+            end
+          end
+        else
+          apply_all_tag
+          # TODO make listener pass an event that has a modifiers attribute for easy representation of :shift, :meta, :control, etc... while a letter button is pressed
+          @listeners ||= {}
+          begin
+            @listeners[listener_name] ||= []
+            @tk.tag_bind(ALL_TAG, 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?('>')
+            @listeners[listener_name] ||= []
+            @tk.tag_bind(ALL_TAG, listener_name) { |event| @listeners[listener_name].each {|l| l.call(event)} } if @listeners[listener_name].empty?
+            @listeners[listener_name] << listener
+          end
         end
       end
-    
-      def add_selection_format(option, value)
-        process_selection_ranges { |range_start, range_end| add_format(range_start, range_end, option, value) }
+      
+      def edit_undo
+        @tk.edit_undo if @modified_count.to_i > 2 # <Modified> fires twice the first time, which is equivalent to one change.
       end
       
-      def remove_selection_format(option, value)
-        process_selection_ranges { |range_start, range_end| remove_format(range_start, range_end, option, value) }
+      def edit_redo
+        begin
+          @tk.edit_redo
+        rescue => e
+          # No Op
+        end
       end
       
-      def toggle_selection_format(option, value)
-        process_selection_ranges { |range_start, range_end| toggle_format(range_start, range_end, option, value) }
+      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) }
       end
       
-      def add_selection_font_format(option, value)
-        process_selection_ranges { |range_start, range_end| add_font_format(range_start, range_end, option, value) }
+      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) }
       end
       
-      def remove_selection_font_format(option, value)
-        process_selection_ranges { |range_start, range_end| remove_font_format(range_start, range_end, option, value) }
+      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) }
       end
       
-      def toggle_selection_font_format(option, value)
-        process_selection_ranges { |range_start, range_end| toggle_font_format(range_start, range_end, option, value) }
+      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) }
       end
       
-      def process_selection_ranges(&processor)
-        @tk.tag_ranges('sel').each do |region|
+      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) }
+      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) }
+      end
+      
+      def process_selection_ranges(no_selection_default: :insert_word, &processor)
+        regions = @tk.tag_ranges('sel')
+        if regions.empty?
+          case no_selection_default
+          when :insert_word
+            regions = [[@tk.index('insert wordstart'), @tk.index('insert wordend + 1 char')]]
+          when :insert_letter
+            regions = [[@tk.index('insert'), @tk.index('insert + 1 char')]]
+          end
+        end
+        regions.each do |region|
           range_start = region.first
           range_end = region.last
           processor.call(range_start, range_end)
@@ -80,7 +150,7 @@ module Glimmer
       end
       
       def applied_format_tags(region_start, region_end, option, value)
-        tag_names = @tk.tag_names - ['sel']
+        tag_names = @tk.tag_names - ['sel', ALL_TAG]
         
         tag_names.select do |tag_name|
           @tk.tag_ranges(tag_name).any? do |range|
@@ -91,9 +161,26 @@ module Glimmer
         end
       end
             
+      def applied_format_value(text_index = nil, option)
+        text_index ||= @tk.index('insert')
+        region_start = text_index
+        region_end = text_index
+        tag_names = @tk.tag_names - ['sel', ALL_TAG]
+        
+        values = tag_names.map do |tag_name|
+          @tk.tag_ranges(tag_name).map do |range|
+            if text_index_less_than_or_equal_to_other_text_index?(range.first, region_start) && text_index_greater_than_or_equal_to_other_text_index?(range.last, region_end)
+              @tk.tag_cget(tag_name, option)
+            end
+          end
+        end.flatten.reject {|value| value.to_s.empty?}
+        
+        values.last || (@tk.send(option) rescue FORMAT_DEFAULT_MAP[option])
+      end
+            
       def add_format(region_start, region_end, option, value)
         @@tag_number = 0 unless defined?(@@tag_number)
-        tag = "tag#{@@tag_number += 1}"
+        tag = "tag_#{option}_#{@@tag_number += 1}"
         @tk.tag_configure(tag, {option => value})
         @tk.tag_add(tag, region_start, region_end)
         tag
@@ -144,15 +231,14 @@ module Glimmer
       def applied_font_format_tags_and_regions(region_start, region_end)
         lines = value.split("\n")
         tags_and_regions = []
-        all_tag_names = @tk.tag_names - ['sel']
+        all_tag_names = (@tk.tag_names - ['sel', ALL_TAG]).select {|tag_name| tag_name.include?('_font_')}
         (region_start.to_i..region_end.to_i).each do |line_number|
           start_character_index = 0
           start_character_index = region_start.to_s.split('.').last.to_i if line_number == region_start.to_i
-          end_character_index = lines[line_number - 1].size
+          end_character_index = lines[line_number - 1].to_s.size
           end_character_index = region_end.to_s.split('.').last.to_i if line_number == region_end.to_i
           (start_character_index...end_character_index).each do |character_index|
             text_index = "#{line_number}.#{character_index}"
-            # TODO reimplement the following using @tk.tag_names without arg since passing an arg seems broken and returns inaccurate results
             region_tag = all_tag_names.reverse.find do |tag|
               @tk.tag_cget(tag, 'font') && @tk.tag_ranges(tag).any? do |range_start, range_end|
                 text_index_less_than_or_equal_to_other_text_index?(range_start, text_index) && text_index_greater_than_or_equal_to_other_text_index?(range_end, text_index)
@@ -168,6 +254,27 @@ module Glimmer
         end
         tags_and_regions
       end
+      
+      def applied_font_format_value(text_index = nil, font_option)
+        text_index ||= @tk.index('insert')
+        region_start = text_index
+        region_end = @tk.index("#{text_index} + 1 chars")
+        tag_names = applied_font_format_tags_and_regions(region_start, region_end).map(&:first)
+        
+        values = tag_names.map do |tag_name|
+          @tk.tag_ranges(tag_name).map do |range|
+            if text_index_less_than_or_equal_to_other_text_index?(range.first, region_start) && text_index_greater_than_or_equal_to_other_text_index?(range.last, region_end)
+              @tk.tag_cget(tag_name, 'font')
+            end
+          end
+        end.flatten.reject {|value| value.to_s.empty?}
+        
+        font = values.last
+        
+        value = font && font.send(font_option)
+        
+        value || Hash[@tk.font.actual][font_option]
+      end
 
       def add_font_format(region_start, region_end, font_option, value)
         applied_font_format_tags_and_regions(region_start, region_end).each do |tag, tag_region_start, tag_region_end|
@@ -337,11 +444,16 @@ 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

@@ -0,0 +1,119 @@
+# 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 TkToplevel
+    #
+    # Follows the Proxy Design Pattern
+    class ToplevelProxy < WidgetProxy
+      REGEX_GEOMETRY = /[x+-]/
+      DEFAULT_WIDTH = 190
+      DEFAULT_HEIGHT = 95
+      
+      attr_reader :tk
+      
+      def has_attribute?(attribute, *args)
+        %w[width height x y].include?(attribute.to_s) || super
+      end
+      
+      def width
+        geometry.split(REGEX_GEOMETRY)[0].to_i
+      end
+      
+      def height
+        geometry.split(REGEX_GEOMETRY)[1].to_i
+      end
+      
+      def x
+        sign_number(x_sign, geometry.split(REGEX_GEOMETRY)[2].to_i)
+      end
+      
+      def y
+        sign_number(y_sign, geometry.split(REGEX_GEOMETRY)[3].to_i)
+      end
+      
+      def width=(value)
+        @width = value.to_i
+        self.geometry = "#{value.to_i}x#{@height || DEFAULT_HEIGHT}#{x_sign}#{abs_x}#{y_sign}#{abs_y}"
+      end
+      
+      def height=(value)
+        @height = value.to_i
+        self.geometry = "#{@width || DEFAULT_WIDTH}x#{value.to_i}#{x_sign}#{abs_x}#{y_sign}#{abs_y}"
+      end
+      
+      def x=(value)
+        self.geometry = "#{@width || DEFAULT_WIDTH}x#{@height || DEFAULT_HEIGHT}#{value.to_i > 0 ? '+' : '-'}#{value.to_i.abs}#{y_sign}#{abs_y}"
+      end
+      
+      def y=(value)
+        self.geometry = "#{@width || DEFAULT_WIDTH}x#{@height || DEFAULT_HEIGHT}#{x_sign}#{abs_x}#{value.to_i > 0 ? '+' : '-'}#{value.to_i.abs}"
+      end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s.upcase
+        when 'WM_DELETE_WINDOW', 'DELETE_WINDOW'
+          listener_name = 'WM_DELETE_WINDOW'
+          @tk.protocol(listener_name, &listener)
+        else
+          super
+        end
+      end
+      
+      private
+      
+      def sign_number(sign, number)
+        "#{sign}1".to_i * number
+      end
+      
+      def abs_x
+        geometry.split(REGEX_GEOMETRY)[2].to_i
+      end
+      
+      def abs_y
+        geometry.split(REGEX_GEOMETRY)[3].to_i
+      end
+      
+      def x_sign
+        geometry_signs[0]
+      end
+      
+      def y_sign
+        geometry_signs[1]
+      end
+      
+      def geometry_signs
+        geometry.chars.select {|char| char.match(/[+-]/)}
+      end
+      
+      def initialize_defaults
+        self.background = '#ececec' if OS.mac?
+        on('DELETE_WINDOW') do
+          grab_release
+          destroy
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/widget_proxy.rb

@@ -19,6 +19,8 @@
 # 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/data_binding/tk/one_time_observer'
+
 module Glimmer
   module Tk
     # Proxy for Tk Widget objects
@@ -83,6 +85,27 @@ module Glimmer
         post_add_content if @block.nil?
       end
       
+      def root_parent_proxy
+        current = self
+        current = current.parent_proxy while current.parent_proxy
+        current
+      end
+      
+      def toplevel_parent_proxy
+        ancestor_proxies.find {|widget_proxy| widget_proxy.is_a?(ToplevelProxy)}
+      end
+      
+      # returns list of ancestors ordered from direct parent to root parent
+      def ancestor_proxies
+        ancestors = []
+        current = self
+        while current.parent_proxy
+          ancestors << current.parent_proxy
+          current = current.parent_proxy
+        end
+        ancestors
+      end
+      
       def children
         @children ||= []
       end
@@ -227,7 +250,7 @@ module Glimmer
       
       def grid(options = {})
         options = options.stringify_keys
-        index_in_parent = @parent_proxy.children.index(self)
+        index_in_parent = @parent_proxy&.children&.index(self)
         options['rowspan'] = options.delete('row_span') if options.keys.include?('row_span')
         options['columnspan'] = options.delete('column_span') if options.keys.include?('column_span')
         options['rowweight'] = options.delete('row_weight') if options.keys.include?('row_weight')
@@ -240,10 +263,12 @@ module Glimmer
         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')
+        if index_in_parent
+          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')
+        end
         @tk.grid(options)
       end
       
@@ -259,6 +284,11 @@ module Glimmer
         apply_style({"font" => value})
       end
       
+      def destroy
+        @tk.destroy
+        @on_destroy_procs&.each {|p| p.call(@tk)}
+      end
+      
       def apply_style(options)
         @@style_number = 0 unless defined?(@@style_number)
         style = "style#{@@style_number += 1}.#{@tk.class.name.split('::').last}"
@@ -421,17 +451,31 @@ module Glimmer
       
       def handle_listener(listener_name, &listener)
         listener_name = listener_name.to_s
-        begin
-          @tk.bind(listener_name, &listener)
-        rescue => e
-          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)
+        if listener_name == 'destroy'
+          # 'destroy' is a more reliable alternative listener binding to '<Destroy>'
+          @on_destroy_procs ||= []
+          listener.singleton_class.include(Glimmer::DataBinding::Tk::OneTimeObserver) unless listener.is_a?(Glimmer::DataBinding::Tk::OneTimeObserver)
+          @on_destroy_procs << listener
+          @tk.bind('<Destroy>', listener)
+          parent_proxy.handle_listener(listener_name, &listener) if parent_proxy
+          # TODO return a listener registration object that has a deregister method
+        else
+          begin
+            @tk.bind(listener_name, &listener)
+          rescue => e
+            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)
+          end
         end
       end
       
+      def on(listener_name, &listener)
+        handle_listener(listener_name, &listener)
+      end
+      
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
       end