glimmer-dsl-tk 0.0.27 → 0.0.31

data/VERSION

@@ -1 +1 @@
-0.0.27
+0.0.31

data/lib/glimmer/data_binding/tk/one_time_observer.rb

@@ -0,0 +1,39 @@
+# 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/data_binding/observer'
+
+module Glimmer
+  module DataBinding
+    module Tk
+      # Decorator for Observer that ensures it is only called once
+      # (subsequent invocations of call method do nothing)
+      module OneTimeObserver
+        def call(value)
+          unless @called
+            super
+            @called = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/tk/built_in_dialog_expression.rb

@@ -0,0 +1,57 @@
+# 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'
+require 'glimmer/dsl/expression'
+
+module Glimmer
+  module DSL
+    module Tk
+      class BuiltInDialogExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword = "get_#{keyword}" if keyword.start_with?('open')
+          (keyword.start_with?('get') or keyword.start_with?('choose')) and
+          (
+            (block.nil? and ::Tk.respond_to?(keyword.camelcase)) or
+            keyword == 'choose_font'
+          )
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          if args.first.is_a?(Hash)
+            options = args.first.symbolize_keys
+            options[:filetypes] = options.delete(:file_types) if options.keys.include?(:file_types)
+            options[:filetypes] = options[:filetypes].map { |key, value| "{#{key}} {#{value}}" } if options[:filetypes].is_a?(Hash)
+            options[:parent] = options[:parent].tk if options[:parent].is_a?(Glimmer::Tk::RootProxy)
+            args[0] = options
+          end
+          keyword = "get_#{keyword}" if keyword.start_with?('open') || keyword.start_with?('save') || keyword.start_with?('multiple')
+          if keyword == 'choose_font'
+            TkFont::Fontchooser.configure(:font => args, :command => block)
+            TkFont::Fontchooser.show
+          else
+            ::Tk.send(keyword.camelcase, *args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/tk/data_binding_expression.rb

@@ -38,12 +38,13 @@ module Glimmer
         end
   
         def interpret(parent, keyword, *args, &block)
-          parent.class
           model_binding = args[0]
           widget_binding_parameters = [parent, keyword]
           widget_binding = DataBinding::Tk::WidgetBinding.new(*widget_binding_parameters)
           #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
-          widget_binding.observe(model_binding)
+          registration = widget_binding.observe(model_binding)
+          parent.on('destroy') { registration.deregister }
+
           # TODO simplify this logic and put it where it belongs
           parent.add_observer(model_binding, keyword) if parent.respond_to?(:add_observer, [model_binding, keyword])
           widget_binding.call(model_binding.evaluate_property)

data/lib/glimmer/dsl/tk/dsl.rb

@@ -42,6 +42,7 @@ module Glimmer
           attribute
           shine_data_binding
           widget
+          built_in_dialog
         ]
       )
     end

data/lib/glimmer/dsl/tk/widget_expression.rb

@@ -33,11 +33,15 @@ module Glimmer
   
         def can_interpret?(parent, keyword, *args, &block)
           !EXCLUDED_KEYWORDS.include?(keyword) and
-            parent.respond_to?(:tk) and
             Glimmer::Tk::WidgetProxy.widget_exists?(keyword)
+            (parent.respond_to?(:tk) or args.first.respond_to?(:tk))
         end
   
         def interpret(parent, keyword, *args, &block)
+          if keyword == 'toplevel' && args.first.respond_to?(:tk)
+            parent = args.first
+            args[0] = args.first.tk
+          end
           Glimmer::Tk::WidgetProxy.create(keyword, parent, args, &block)
         end
         

data/lib/glimmer/tk/drag_and_drop_extension.rb

@@ -0,0 +1,112 @@
+require "json"
+
+module Glimmer
+  module Tk
+    class WidgetProxy
+      attr_accessor :on_drag_motion_block
+
+      def drag_source=(value)
+        @drag_source = value
+        if @drag_source
+          make_draggable
+        else
+          make_non_draggable
+        end
+      end
+
+      def on_drag_start_block=(block)
+        @on_drag_start_block = block
+        make_draggable
+      end
+
+      def on_drop_block=(value)
+        @on_drop_block = value
+        self.tk.bind("<DropEvent>", proc { |tk_event|
+          drop_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
+          @on_drop_block.call(drop_event) if self.tk == drop_event.target
+        })
+        self.tk.bind("<DropCheckEvent>", proc { |tk_event|
+          drop_check_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
+          drop_check_event.source.event_generate("<DropAcceptedEvent>")
+        })
+      end
+
+      def textvariable_defined?
+        tk_widget_has_attribute_setter?(:textvariable) && !tk.textvariable.nil?
+      end
+
+      def make_draggable
+        drag_event = nil
+        bind("<DropAcceptedEvent>", proc { |event| drag_event.drop_accepted = true })
+        bind("B1-Motion", proc { |tk_event|
+          if drag_event.nil?
+            tooltip = TkToplevel.new(root).overrideredirect(1) #create tooltip window to display dragged data
+            tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
+            drag_event = DragAndDropEvent.new(self.tk, nil, tooltip, tk_event.x_root, tk_event.y_root, nil, false)
+            if @drag_source
+              tk_event.widget.configure(:cursor => "hand2")
+              # Default data to drag is text
+              drag_event.data = if textvariable_defined? then tk.textvariable.value elsif has_attribute?(:text) then tk.text end
+              TkLabel.new(tooltip) { text drag_event.data }.pack
+            elsif !@on_drag_start_block.nil?
+              @on_drag_start_block.call(drag_event)
+              TkLabel.new(tooltip) { text drag_event.data }.pack if tooltip.winfo_children().length == 0
+            end
+          else
+            drag_event.x_root, drag_event.y_root = tk_event.x_root, tk_event.y_root
+            drag_event.drop_accepted = false
+            move_over_widget = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root)
+            drag_event.target = move_over_widget
+            move_over_widget.event_generate("<DropCheckEvent>", :data => drag_event.to_json)
+            if @on_drag_motion_block.nil?
+              # Default motion behavior:
+              # 1.Change cursor to show whether text can be dropped.
+              # 2.Move tooltip with dragged data.
+              if drag_event.drop_accepted
+                tk_event.widget.configure(:cursor => "hand1")
+              else
+                tk_event.widget.configure(:cursor => "hand2")
+              end
+              drag_event.tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
+            else
+              @on_drag_motion_block.call(drag_event)
+            end
+          end
+        })
+        bind("ButtonRelease-1", proc { |tk_event|
+          if drag_event
+            drag_event.target = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root)
+            drag_event.source.configure(:cursor => "")
+            drag_event.target.event_generate("<DropEvent>", :data => drag_event.to_json)
+            drag_event.tooltip.destroy
+            drag_event = nil
+          end
+        })
+      end
+
+      def make_non_draggable
+        @tk.bind_remove("B1-Motion")
+        @tk.bind_remove("ButtonRelease-1")
+        @tk.bind_remove("<DropAcceptedEvent>")
+      end
+
+      DragAndDropEvent = Struct.new(:source, :target, :tooltip, :x_root, :y_root, :data, :drop_accepted) do
+        def as_json(*)
+          klass = self.class.name
+          {
+            JSON.create_id => klass,
+            "v" => [values[0].object_id, values[1].object_id, values[2].object_id].concat(values.drop 3),
+          }
+        end
+
+        def to_json(*args)
+          as_json.to_json(*args)
+        end
+
+        def self.json_create(object)
+          new(*[ObjectSpace._id2ref(object["v"][0]), ObjectSpace._id2ref(object["v"][1]), ObjectSpace._id2ref(object["v"][2])].concat(object["v"].drop 3))
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/label_proxy.rb

@@ -29,16 +29,6 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class LabelProxy < WidgetProxy
       include TextVariableOwner
-      
-      FONTS_PREDEFINED = %w[default text fixed menu heading caption small_caption icon tooltip]
-      
-      def font=(value)
-        if (value.is_a?(Symbol) || value.is_a?(String)) && FONTS_PREDEFINED.include?(value.to_s.downcase)
-          @tk.font = "tk_#{value}_font".camelcase(:upper)
-        else
-          super
-        end
-      end
     end
   end
 end

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

@@ -28,8 +28,7 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class TextProxy < WidgetProxy
       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|
             listener.call(*args)
@@ -38,27 +37,23 @@ module Glimmer
           bind('<Modified>', modified_listener)
         when '<<selection>>', '<selection>', 'selection'
           bind('<Selection>', listener)
-        else
+        when 'destroy'
           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)
+        else
+          @tk.tag_add('__all__', '1.0', 'end') unless @tk.tag_names.include?('__all__')
+          # 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
+          begin
+            @tk.tag_bind('__all__', 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.tag_bind('__all__', listener_name, &listener)
           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
@@ -158,7 +153,7 @@ module Glimmer
       end
 
       def applied_font_format_tags_and_regions(region_start, region_end)
-        lines = text.split("\n")
+        lines = value.split("\n")
         tags_and_regions = []
         all_tag_names = @tk.tag_names - ['sel']
         (region_start.to_i..region_end.to_i).each do |line_number|
@@ -332,10 +327,19 @@ module Glimmer
         region1_parts.last.to_i >= region2_parts.last.to_i
       end
       
-      def clone_font(font)
-        ::TkFont.new(Hash[font.actual])
+      def insert_image(text_index, *image_args)
+        TkTextImage.new(@tk, 'insert', :image => image_argument(image_args))
       end
-            
+      
+      def get_open_file_to_insert_image(text_index = 'insert')
+        image_filename = Glimmer::DSL::Tk::BuiltInDialogExpression.new.interpret(nil, 'get_open_file', filetypes: {
+          'PNG Images' => '.png',
+          'Gif Images' => '.gif',
+          'PPM Images' => '.ppm'
+        })
+        insert_image('insert', image_filename) unless image_filename.nil? || image_filename.to_s.empty?
+      end
+      
       private
       
       def initialize_defaults
@@ -345,6 +349,10 @@ module Glimmer
         self.padx = 5
         self.pady = 5
       end
+      
+      def clone_font(font)
+        ::TkFont.new(Hash[font.actual])
+      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