glimmer-dsl-libui 0.4.14 → 0.4.18

data/lib/glimmer/libui/control_proxy/column/text_color_column_proxy.rb

@@ -32,6 +32,12 @@ module Glimmer
         #
         # Follows the Proxy Design Pattern
         class TextColorColumnProxy < ControlProxy
+          class << self
+            def default_value
+              ['', :black]
+            end
+          end
+          
           include Column
           include DualColumn
           include EditableColumn

data/lib/glimmer/libui/control_proxy/column/text_column_proxy.rb

@@ -31,6 +31,12 @@ module Glimmer
         #
         # Follows the Proxy Design Pattern
         class TextColumnProxy < ControlProxy
+          class << self
+            def default_value
+              ''
+            end
+          end
+          
           include Column
           include EditableColumn
               

data/lib/glimmer/libui/control_proxy/column.rb

@@ -24,6 +24,13 @@ module Glimmer
     class ControlProxy
       # Common logic for all column proxy objects
       module Column
+        class << self
+          # subclasses may override to provide a valid default value like a blank image for image columns and false for checkbox
+          def default_value
+            nil
+          end
+        end
+
         def initialize(keyword, parent, args, &block)
           @keyword = keyword
           @parent_proxy = parent

data/lib/glimmer/libui/control_proxy/form_proxy.rb

@@ -39,6 +39,7 @@ module Glimmer
         end
         
         def destroy_child(child)
+          child.deregister_all_custom_listeners
           ::LibUI.send("form_delete", @libui, children.index(child))
           ControlProxy.control_proxies.delete(child)
         end

data/lib/glimmer/libui/control_proxy/image_proxy.rb

@@ -52,6 +52,7 @@ module Glimmer
         
         include Parent
         prepend Transformable
+        include Equalizer.new(:options, :data)
         
         attr_reader :data, :pixels, :shapes, :options
         
@@ -179,6 +180,8 @@ module Glimmer
         end
         
         def destroy
+          return if ControlProxy.main_window_proxy&.destroying?
+          deregister_all_custom_listeners
           @parent_proxy&.children&.delete(self)
           ControlProxy.control_proxies.delete(self)
         end

data/lib/glimmer/libui/control_proxy/menu_item_proxy/quit_menu_item_proxy.rb

@@ -35,29 +35,38 @@ module Glimmer
         
           def handle_listener(listener_name, &listener)
             if listener_name == 'on_clicked'
-              @default_behavior_listener = Proc.new do
-                return_value = listener.call(self)
+              @on_clicked_listeners ||= []
+              @on_clicked_listeners << listener
+              @default_behavior_listener ||= Proc.new do
+                return_value = nil
+                @on_clicked_listeners.each do |l|
+                  return_value = l.call(self)
+                  break if return_value.is_a?(Numeric)
+                end
                 if return_value.is_a?(Numeric)
                   return_value
                 else
-                  destroy
+                  ControlProxy.main_window_proxy&.destroy
                   ::LibUI.quit
                   0
                 end
+              end.tap do |default_behavior_listener|
+                ::LibUI.on_should_quit(&default_behavior_listener)
               end
-              ::LibUI.on_should_quit(&@default_behavior_listener)
             end
           end
+          
+          def destroy
+            @on_clicked_listeners&.clear
+            super
+          end
         
           private
           
           def build_control
             @libui = @parent_proxy.append_quit_item(*@args)
-            handle_listener('on_clicked') do
-              ControlProxy.main_window_proxy&.destroy
-              ::LibUI.quit
-              0
-            end
+            # setup default on_clicked listener if no on_clicked listeners are setup
+            handle_listener('on_clicked') {} if @on_clicked_listeners.nil? || @on_clicked_listeners.empty?
           end
         end
       end

data/lib/glimmer/libui/control_proxy/open_type_features_proxy.rb

@@ -33,15 +33,24 @@ module Glimmer
         include Parent
       
         def destroy
+          return if ControlProxy.main_window_proxy&.destroying?
+          return if @destroying
+          @destroying = true
+          deregister_all_custom_listeners
           ::LibUI.free_open_type_features(@libui)
-          @parent_proxy&.children&.delete(self)
+          @parent_proxy&.remove_open_type_features
           ControlProxy.control_proxies.delete(self)
+          @destroying = false
         end
         
         def redraw
-          @parent_proxy.redraw
+          @parent_proxy&.redraw
         end
         
+        def request_auto_redraw
+          @parent_proxy&.request_auto_redraw
+        end
+                        
         private
         
         def build_control

data/lib/glimmer/libui/control_proxy/open_type_tag_proxy.rb

@@ -31,6 +31,8 @@ module Glimmer
       # Follows the Proxy Design Pattern
       class OpenTypeTagProxy < ControlProxy
         def destroy
+          return if ControlProxy.main_window_proxy&.destroying?
+          deregister_all_custom_listeners
           @parent_proxy&.children&.delete(self)
           ControlProxy.control_proxies.delete(self)
         end

data/lib/glimmer/libui/control_proxy/path_proxy.rb

@@ -70,7 +70,8 @@ module Glimmer
           else
             new_color = Glimmer::LibUI.interpret_color(args)
             if new_color != @fill
-              @fill_observer&.unobserve(@fill) if @fill
+              # TODO consider replacing unobserve with observer_registration.deregister
+              @fill_observer&.unobserve(@fill, attribute_writer_type: [:attribute=, :set_attribute]) if @fill
               @fill = new_color
               request_auto_redraw
             end
@@ -79,7 +80,7 @@ module Glimmer
             @fill_observer ||= Glimmer::DataBinding::Observer.proc do
               request_auto_redraw
             end
-            @fill_observer.observe(@fill)
+            @fill_observer.observe(@fill, attribute_writer_type: [:attribute=, :set_attribute])
           end
         end
         alias fill= fill
@@ -98,7 +99,8 @@ module Glimmer
           else
             new_color = Glimmer::LibUI.interpret_color(args)
             if new_color != @stroke
-              @stroke_observer&.unobserve(@stroke) if @stroke
+              # TODO consider replacing unobserve with observer_registration.deregister
+              @stroke_observer&.unobserve(@stroke, attribute_writer_type: [:attribute=, :set_attribute]) if @stroke
               @stroke = Glimmer::LibUI.interpret_color(args)
               request_auto_redraw
             end
@@ -107,7 +109,7 @@ module Glimmer
             @stroke_observer ||= Glimmer::DataBinding::Observer.proc do
               request_auto_redraw
             end
-            @stroke_observer.observe(@stroke)
+            @stroke_observer.observe(@stroke, attribute_writer_type: [:attribute=, :set_attribute])
           end
         end
         alias stroke= stroke
@@ -140,6 +142,8 @@ module Glimmer
         end
         
         def destroy
+          return if ControlProxy.main_window_proxy&.destroying?
+          deregister_all_custom_listeners
           @parent_proxy&.children&.delete(self)
           ControlProxy.control_proxies.delete(self)
         end

data/lib/glimmer/libui/control_proxy/table_proxy.rb

@@ -36,7 +36,7 @@ module Glimmer
       class TableProxy < ControlProxy
         include Glimmer::FiddleConsumer
         
-        LISTENERS = ['on_changed', 'on_edited']
+        CUSTOM_LISTENER_NAMES = ['on_changed', 'on_edited']
         
         attr_reader :model_handler, :model, :table_params, :columns, :column_attributes
       
@@ -48,6 +48,8 @@ module Glimmer
           @enabled = true
           @columns = []
           @cell_rows = []
+          @last_cell_rows = []
+          register_cell_rows_observer
           window_proxy.on_destroy do
             # the following unless condition is an exceptional condition stumbled upon that fails freeing the table model
             ::LibUI.free_table_model(@model) unless @destroyed && parent_proxy.is_a?(Box)
@@ -75,7 +77,8 @@ module Glimmer
         
         def destroy
           super
-          @cell_rows_observer&.unobserve(self, :cell_rows, recursive: true)
+          # TODO consider replacing unobserve with observer_registration.deregister
+          @cell_rows_observer&.unobserve(self, :cell_rows, recursive: true, ignore_frozen: true, attribute_writer_type: [:attribute=, :set_attribute])
           @destroyed = true
         end
         
@@ -86,31 +89,6 @@ module Glimmer
             if rows != @cell_rows
               @cell_rows = rows
               @cell_rows = @cell_rows.to_a if @cell_rows.is_a?(Enumerator)
-              @last_cell_rows ||= array_deep_clone(@cell_rows)
-              @cell_rows_observer ||= Glimmer::DataBinding::Observer.proc do |new_cell_rows|
-                if @cell_rows.size < @last_cell_rows.size && @last_cell_rows.include_all?(*@cell_rows)
-                  @last_cell_rows.array_diff_indexes(@cell_rows).reverse.each do |row|
-                    ::LibUI.table_model_row_deleted(model, row)
-                    on_changed.each {|listener| listener.call(row, :deleted, @last_cell_rows[row])}
-                  end
-                elsif @cell_rows.size > @last_cell_rows.size && @cell_rows.include_all?(*@last_cell_rows)
-                  @cell_rows.array_diff_indexes(@last_cell_rows).each do |row|
-                    ::LibUI.table_model_row_inserted(model, row)
-                    on_changed.each {|listener| listener.call(row, :inserted, @cell_rows[row])}
-                  end
-                else
-                  @cell_rows.each_with_index do |new_row_data, row|
-                    if new_row_data != @last_cell_rows[row]
-                      ::LibUI.table_model_row_changed(model, row)
-                      on_changed.each {|listener| listener.call(row, :changed, @cell_rows[row])}
-                    end
-                  end
-                end
-                @last_last_cell_rows = array_deep_clone(@last_cell_rows)
-                @last_cell_rows = array_deep_clone(@cell_rows)
-              end.tap do |cell_rows_observer|
-                cell_rows_observer.observe(self, :cell_rows, recursive: true)
-              end
             end
             @cell_rows
           end
@@ -153,13 +131,13 @@ module Glimmer
             new_value = new_value.to_a if new_value.is_a?(Enumerator)
             if model_binding.binding_options[:column_attributes] || (!new_value.empty? && !new_value.first.is_a?(Array))
               @model_attribute_array_observer_registration&.deregister
-              @model_attribute_array_observer_registration = model_attribute_observer.observe(new_value, @column_attributes)
+              @model_attribute_array_observer_registration = model_attribute_observer.observe(new_value, @column_attributes, ignore_frozen: true, attribute_writer_type: [:attribute=, :set_attribute])
               model_attribute_observer.add_dependent(model_attribute_observer_registration => @model_attribute_array_observer_registration)
             end
             # TODO look if multiple notifications are happening as a result of observing array and observing model binding
             send("#{property}=", new_value) unless @last_cell_rows == new_value
           end
-          model_attribute_observer_registration = model_attribute_observer.observe(model_binding)
+          model_attribute_observer_registration = model_attribute_observer.observe(model_binding, attribute_writer_type: [:attribute=, :set_attribute])
           model_attribute_observer.call # initial update
           data_binding_model_attribute_observer_registrations << model_attribute_observer_registration
           model_attribute_observer
@@ -208,9 +186,11 @@ module Glimmer
             when Column::TextColumnProxy, Column::ButtonColumnProxy, Column::TextColorColumnProxy, :text
               ::LibUI.new_table_value_string((expanded_cell_rows[row] && expanded_cell_rows[row][column]).to_s)
             when Column::ImageColumnProxy, Column::ImageTextColumnProxy, Column::ImageTextColorColumnProxy
-              # TODO refactor to eliminate redundancy and share similar code
-              row = row - 1 if OS.windows? && row == cell_rows.count
-              img = expanded_cell_rows[row][column]
+              if OS.windows? && row == cell_rows.count
+                img = Glimmer::LibUI::ICON
+              else
+                img = expanded_cell_rows[row][column]
+              end
               img = ControlProxy::ImageProxy.create('image', nil, img) if img.is_a?(Array)
               img = ControlProxy::ImageProxy.create('image', nil, [img]) if img.is_a?(String)
               img = img.respond_to?(:libui) ? img.libui : img
@@ -270,7 +250,7 @@ module Glimmer
                 @cell_rows[row].send(attribute)[1] = ::LibUI.table_value_string(val).to_s
               end
             when Column::ButtonColumnProxy
-              @columns[column].notify_listeners(:on_clicked, row)
+              @columns[column].notify_custom_listeners('on_clicked', row)
             when Column::CheckboxColumnProxy
               column = @columns[column].index
               @cell_rows[row] ||= []
@@ -292,7 +272,7 @@ module Glimmer
                 @cell_rows[row].send(attribute)[0] = ::LibUI.table_value_int(val).to_i == 1
               end
             end
-            on_edited.each {|listener| listener.call(row, @cell_rows[row])}
+            notify_custom_listeners('on_edited', row, @cell_rows[row])
           end
           
           @model = ::LibUI.new_table_model(@model_handler)
@@ -308,12 +288,57 @@ module Glimmer
           @libui.tap do
             @columns.each {|column| column.respond_to?(:build_control, true) && column.send(:build_control) }
           end
+
+          if !@applied_windows_fix && OS.windows?
+            @applied_windows_fix = true
+            apply_windows_fix
+          end
         end
         
         def next_column_index
           @next_column_index ||= -1
           @next_column_index += 1
         end
+        
+        def register_cell_rows_observer
+          @cell_rows_observer = Glimmer::DataBinding::Observer.proc do |new_cell_rows|
+            if @cell_rows.size < @last_cell_rows.size && @last_cell_rows.include_all?(*@cell_rows)
+              @last_cell_rows.array_diff_indexes(@cell_rows).reverse.each do |row|
+                ::LibUI.table_model_row_deleted(model, row) if model && row
+                notify_custom_listeners('on_changed', row, :deleted, @last_cell_rows[row])
+              end
+            elsif @cell_rows.size > @last_cell_rows.size && @cell_rows.include_all?(*@last_cell_rows)
+              @cell_rows.array_diff_indexes(@last_cell_rows).each do |row|
+                ::LibUI.table_model_row_inserted(model, row) if model && row
+                notify_custom_listeners('on_changed', row, :inserted, @cell_rows[row])
+              end
+            else
+              @cell_rows.each_with_index do |new_row_data, row|
+                if new_row_data != @last_cell_rows[row]
+                  ::LibUI.table_model_row_changed(model, row) if model && row
+                  notify_custom_listeners('on_changed', row, :changed, @cell_rows[row])
+                end
+              end
+            end
+            @last_last_cell_rows = array_deep_clone(@last_cell_rows)
+            @last_cell_rows = array_deep_clone(@cell_rows)
+            if !@applied_windows_fix_on_first_cell_rows_update && OS.windows?
+              @applied_windows_fix_on_first_cell_rows_update = true
+              apply_windows_fix
+            end
+          end
+          @cell_rows_observer_registration = @cell_rows_observer.observe(self, :cell_rows, recursive: true, ignore_frozen: true, attribute_writer_type: [:attribute=, :set_attribute])
+        end
+
+        def apply_windows_fix
+          Glimmer::LibUI.queue_main do
+            new_row = @columns&.select {|column| column.is_a?(Column)}&.map {|column| column.class.default_value}
+            if new_row
+              @cell_rows << new_row
+              @cell_rows.pop
+            end
+          end
+        end
       end
     end
   end

data/lib/glimmer/libui/control_proxy/text_proxy.rb

@@ -60,6 +60,8 @@ module Glimmer
         end
         
         def destroy
+          return if ControlProxy.main_window_proxy&.destroying?
+          deregister_all_custom_listeners
           @parent_proxy&.children&.delete(self)
           ControlProxy.control_proxies.delete(self)
         end

data/lib/glimmer/libui/control_proxy/window_proxy.rb

@@ -29,6 +29,10 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class WindowProxy < ControlProxy
+        CUSTOM_LISTENER_NAMES = ['on_destroy']
+        CUSTOM_LISTENER_NAME_ALIASES = {
+          on_destroyed: 'on_destroy',
+        }
         DEFAULT_TITLE = ''
         DEFAULT_WIDTH = 190
         DEFAULT_HEIGHT = 150
@@ -44,22 +48,20 @@ module Glimmer
         end
         
         def destroy
+          return if @destroying
+          @destroying = true
+          @on_closing_listeners&.clear
           super
           ControlProxy.image_proxies.each { |image_proxy| ::LibUI.free_image(image_proxy.libui) unless image_proxy.area_image? }
-          @on_destroy_procs&.each { |on_destroy_proc| on_destroy_proc.call(self)}
+          notify_custom_listeners('on_destroy', self)
+          deregister_custom_listeners('on_destroy')
+          @destroying = false
         end
         
-        def on_destroy(&block)
-          # TODO look into a way to generalize this logic for multiple listeners
-          @on_destroy_procs ||= []
-          if block.nil?
-            @on_destroy_procs
-          else
-            @on_destroy_procs << block
-            block
-          end
+        def destroying?
+          @destroying
         end
-      
+        
         def show
           super
           unless @shown_at_least_once
@@ -69,29 +71,29 @@ module Glimmer
           end
         end
         
-        def can_handle_listener?(listener_name)
-          listener_name == 'on_destroy' || super
-        end
-        
         def handle_listener(listener_name, &listener)
           case listener_name
-          when 'on_destroy'
-            on_destroy(&listener)
-          else
-            default_behavior_listener = nil
-            if listener_name == 'on_closing'
-              default_behavior_listener = Proc.new do
-                return_value = listener.call(self)
-                if return_value.is_a?(Numeric)
-                  return_value
-                else
-                  destroy
-                  ::LibUI.quit
-                  0
-                end
+          when 'on_closing'
+            @on_closing_listeners ||= []
+            @on_closing_listeners << listener
+            @default_behavior_listener ||= Proc.new do
+              return_value = nil
+              @on_closing_listeners.each do |l|
+                return_value = l.call(self)
+                break if return_value.is_a?(Numeric)
+              end
+              if return_value.is_a?(Numeric)
+                return_value
+              else
+                destroy
+                ::LibUI.quit
+                0
               end
+            end.tap do |default_behavior_listener|
+              super(listener_name, &default_behavior_listener)
             end
-            super(listener_name, &(default_behavior_listener || listener))
+          else
+            super
           end
         end
         
@@ -168,11 +170,8 @@ module Glimmer
           @height = construction_args[2]
           @libui = ControlProxy.new_control(@keyword, construction_args)
           @libui.tap do
-            handle_listener('on_closing') do
-              destroy
-              ::LibUI.quit
-              0
-            end
+            # setup default on_closing listener if no on_closing listeners are setup
+            handle_listener('on_closing') {} if @on_closing_listeners.nil? || @on_closing_listeners.empty?
           end
         end
       end

data/lib/glimmer/libui/control_proxy.rb

@@ -169,31 +169,49 @@ module Glimmer
       def handle_listener(listener_name, &listener)
         safe_listener = Proc.new { listener.call(self) }
         if ::LibUI.respond_to?("#{libui_api_keyword}_#{listener_name}")
-          ::LibUI.send("#{libui_api_keyword}_#{listener_name}", @libui, &safe_listener)
+          if listeners[listener_name].nil?
+            ::LibUI.send("#{libui_api_keyword}_#{listener_name}", @libui) do
+              listeners_for(listener_name).map { |listener| listener.call }.last
+            end
+          end
+          listeners_for(listener_name) << safe_listener
         elsif ::LibUI.respond_to?("control_#{listener_name}")
-          ::LibUI.send("control_#{listener_name}", @libui, &safe_listener)
+          if listeners[listener_name].nil?
+            ::LibUI.send("control_#{listener_name}", @libui) do
+              listeners_for(listener_name).map { |listener| listener.call }.last
+            end
+          end
+          listeners_for(listener_name) << safe_listener
         elsif has_custom_listener?(listener_name)
           handle_custom_listener(listener_name, &listener)
         end
       end
       
+      def listeners
+        @listeners ||= {}
+      end
+      
+      def listeners_for(listener_name)
+        listeners[listener_name] ||= []
+      end
+      
       def has_custom_listener?(listener_name)
         listener_name = listener_name.to_s
-        custom_listeners.include?(listener_name) || custom_listener_aliases.stringify_keys.keys.include?(listener_name)
+        custom_listener_names.include?(listener_name) || custom_listener_name_aliases.stringify_keys.keys.include?(listener_name)
       end
       
-      def custom_listeners
-        self.class.constants.include?(:LISTENERS) ? self.class::LISTENERS : []
+      def custom_listener_names
+        self.class.constants.include?(:CUSTOM_LISTENER_NAMES) ? self.class::CUSTOM_LISTENER_NAMES : []
       end
       
-      def custom_listener_aliases
-        self.class.constants.include?(:LISTENER_ALIASES) ? self.class::LISTENER_ALIASES : {}
+      def custom_listener_name_aliases
+        self.class.constants.include?(:CUSTOM_LISTENER_NAME_ALIASES) ? self.class::CUSTOM_LISTENER_NAME_ALIASES : {}
       end
       
       def handle_custom_listener(listener_name, &listener)
         listener_name = listener_name.to_s
-        listener_name = custom_listener_aliases.stringify_keys[listener_name] || listener_name
-        instance_variable_name = "@#{listener_name}_procs"
+        listener_name = custom_listener_name_aliases.stringify_keys[listener_name] || listener_name
+        instance_variable_name = "@#{listener_name}_procs" # TODO ensure clearing custom listeners on destroy of a control
         instance_variable_set(instance_variable_name, []) if instance_variable_get(instance_variable_name).nil?
         if listener.nil?
           instance_variable_get(instance_variable_name)
@@ -203,6 +221,21 @@ module Glimmer
         end
       end
       
+      def notify_custom_listeners(listener_name, *args)
+        handle_custom_listener(listener_name).each do |listener|
+          listener.call(*args)
+        end
+      end
+      
+      def deregister_custom_listeners(listener_name)
+        handle_custom_listener(listener_name).clear
+      end
+      
+      # deregisters all custom listeners except on_destroy, which can only be deregistered after destruction of a control, using deregister_custom_listeners
+      def deregister_all_custom_listeners
+        (custom_listener_names - ['on_destroy']).each { |listener_name| deregister_custom_listeners(listener_name) }
+      end
+      
       def respond_to?(method_name, *args, &block)
         respond_to_libui?(method_name, *args, &block) ||
           (
@@ -289,6 +322,8 @@ module Glimmer
       end
       
       def destroy
+        # TODO exclude menus from this initial return
+        return if !is_a?(ControlProxy::WindowProxy) && ControlProxy.main_window_proxy&.destroying?
         data_binding_model_attribute_observer_registrations.each(&:deregister)
         if parent_proxy.nil?
           default_destroy
@@ -302,6 +337,7 @@ module Glimmer
       end
       
       def default_destroy
+        deregister_all_custom_listeners
         send_to_libui('destroy')
         ControlProxy.control_proxies.delete(self)
       end

data/lib/glimmer/libui/data_bindable.rb

@@ -46,7 +46,7 @@ module Glimmer
           new_value = model_binding.evaluate_property
           send("#{property}=", new_value) unless send(property) == new_value
         end
-        observer_registration = model_attribute_observer.observe(model_binding)
+        observer_registration = model_attribute_observer.observe(model_binding, attribute_writer_type: [:attribute=, :set_attribute])
         model_attribute_observer.call # initial update
         data_binding_model_attribute_observer_registrations << observer_registration
         observer_registration

data/lib/glimmer/libui/shape.rb

@@ -116,6 +116,7 @@ module Glimmer
       end
       
       def destroy
+        return if ControlProxy.main_window_proxy&.destroying?
         @parent.children.delete(self)
       end
       

data/lib/glimmer/libui.rb

@@ -23,6 +23,7 @@ require 'glimmer/fiddle_consumer'
 
 module Glimmer
   module LibUI
+    ICON = File.expand_path('../../icons/blank.png', __dir__)
     class << self
       include Glimmer::FiddleConsumer
       

data/lib/glimmer-dsl-libui.rb

@@ -28,6 +28,7 @@ require 'glimmer'
 # require 'super_module'
 require 'color'
 require 'os'
+require 'equalizer'
 require 'array_include_methods'
 require 'facets/hash/stringify_keys'
 require 'facets/string/underscore'
@@ -46,3 +47,8 @@ Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
 end
 
 ::LibUI.init
+# begin
+#   PutsDebuggerer.printer = lambda { |m| puts m; $stdout.flush}
+# rescue
+  ##### No Op if puts_debuggerer is not loaded
+# end