glimmer-dsl-libui 0.1.0 → 0.1.4

data/lib/glimmer/libui/{rectangle_proxy.rb → arc.rb}

@@ -19,37 +19,22 @@
 # 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/libui/control_proxy'
+require 'glimmer/libui/shape'
 
 module Glimmer
   module LibUI
-    # Proxy for LibUI rectangle objects
-    #
-    # Follows the Proxy Design Pattern
-    class RectangleProxy < ControlProxy
-      def initialize(keyword, parent, args, &block)
-        @keyword = keyword
-        @parent_proxy = parent
-        @args = args
-        @block = block
-        @enabled = true
-        post_add_content if @block.nil?
-      end
-    
+    class Arc < Shape
+      parameters :x_center, :y_center, :radius, :start_angle, :sweep, :is_negative
+      parameter_defaults 0, 0, 0, 0, 360, false
+              
       def draw(area_draw_params)
-        ::LibUI.draw_path_add_rectangle(@parent_proxy.libui, *@args)
-      end
-      
-      def destroy
-        if @parent_proxy
-          @parent_proxy.children.delete(self)
+        @args[5] ||= ControlProxy.boolean_to_integer(@args[5], allow_nil: false)
+        if parent.is_a?(Figure) && parent.x.nil? && parent.y.nil?
+          ::LibUI.draw_path_new_figure_with_arc(path_proxy.libui, *@args)
+        else
+          ::LibUI.draw_path_arc_to(path_proxy.libui, *@args)
         end
-      end
-      
-      private
-      
-      def build_control
-        # No Op
+        super
       end
     end
   end

data/lib/glimmer/libui/area_proxy.rb

@@ -46,6 +46,29 @@ module Glimmer
         @children ||= []
       end
       
+      def on_draw(&block)
+        @on_draw_procs ||= []
+        if block.nil?
+          @on_draw_procs
+        else
+          @on_draw_procs << block
+          block
+        end
+      end
+      
+      def can_handle_listener?(listener_name)
+        listener_name == 'on_draw' || super
+      end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name
+        when 'on_draw'
+          on_draw(&listener)
+        else
+          super
+        end
+      end
+      
       private
       
       def build_control
@@ -56,13 +79,27 @@ module Glimmer
       def install_listeners
         @area_handler.Draw         = fiddle_closure_block_caller(0, [1, 1, 1]) do |_, _, area_draw_params|
           area_draw_params = ::LibUI::FFI::AreaDrawParams.new(area_draw_params)
-          children.each {|child| child.draw(area_draw_params)}
+          area_draw_params = area_draw_params_hash(area_draw_params)
+          children.dup.each {|child| child.draw(area_draw_params)}
+          on_draw.each {|listener| listener.call(area_draw_params) }
         end
         @area_handler.MouseEvent   = fiddle_closure_block_caller(0, [0]) {}
         @area_handler.MouseCrossed = fiddle_closure_block_caller(0, [0]) {}
         @area_handler.DragBroken   = fiddle_closure_block_caller(0, [0]) {}
         @area_handler.KeyEvent     = fiddle_closure_block_caller(0, [0]) {}
       end
+      
+      def area_draw_params_hash(area_draw_params)
+        {
+          context: area_draw_params.Context,
+          area_width: area_draw_params.AreaWidth,
+          area_height: area_draw_params.AreaHeight,
+          clip_x: area_draw_params.ClipX,
+          clip_y: area_draw_params.ClipY,
+          clip_width: area_draw_params.ClipWidth,
+          clip_height: area_draw_params.ClipHeight,
+        }
+      end
     end
   end
 end

data/lib/glimmer/libui/bezier.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 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/libui/shape'
+
+module Glimmer
+  module LibUI
+    class Bezier < Shape
+      parameters :c1_x, :c1_y, :c2_x, :c2_y, :end_x, :end_y
+      parameter_defaults 0, 0, 0, 0, 0, 0
+              
+      def draw(area_draw_params)
+        ::LibUI.draw_path_bezier_to(path_proxy.libui, *@args)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/button_column_proxy.rb

@@ -35,7 +35,12 @@ module Glimmer
       def on_clicked(&block)
         # TODO consider generalizing into custom listeners and moving to ControlProxy
         @on_clicked_procs ||= []
-        @on_clicked_procs << block
+        if block.nil?
+          @on_clicked_procs
+        else
+          @on_clicked_procs << block
+          block
+        end
       end
       
       def can_handle_listener?(listener_name)

data/lib/glimmer/libui/control_proxy.rb

@@ -26,7 +26,7 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class ControlProxy
       class << self
-        def control_exists?(keyword)
+        def exists?(keyword)
           ::LibUI.respond_to?("new_#{keyword}") ||
             ::LibUI.respond_to?(keyword) ||
             Glimmer::LibUI.constants.include?("#{keyword.camelcase(:upper)}Proxy".to_sym)
@@ -55,12 +55,12 @@ module Glimmer
           control_proxies.find {|c| c.is_a?(Glimmer::LibUI::WindowProxy)}
         end
         
-        def integer_to_boolean(int)
-          int.nil? ? nil : int == 1
+        def integer_to_boolean(int, allow_nil: true)
+          int.nil? ? (allow_nil ? nil : false) : int == 1
         end
         
-        def boolean_to_integer(bool)
-          bool.nil? ? nil : (bool ? 1 : 0)
+        def boolean_to_integer(bool, allow_nil: true)
+          bool.nil? ? (allow_nil ? nil : 0) : (bool ? 1 : 0)
         end
         
         def menu_proxies
@@ -92,7 +92,7 @@ module Glimmer
       ]
       
       # libui returns the contained LibUI object
-      attr_reader :parent_proxy, :libui, :args, :keyword
+      attr_reader :parent_proxy, :libui, :args, :keyword, :block
       
       def initialize(keyword, parent, args, &block)
         @keyword = keyword
@@ -258,6 +258,10 @@ module Glimmer
       alias set_visible visible
       alias visible= visible
       
+      def content(&block)
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::ControlExpression.new, @keyword, &block)
+      end
+      
       private
       
       def build_control

data/lib/glimmer/libui/figure.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 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/libui/shape'
+
+module Glimmer
+  module LibUI
+    # Represents a figure consisting of shapes (nested under path)
+    # Can optionally have `closed true` property (connecting last point to first point automatically)
+    class Figure < Shape
+      parameters :x, :y
+      parameter_defaults nil, nil
+    
+      def draw(area_draw_params)
+        ::LibUI.draw_path_new_figure(path_proxy.libui, *@args) unless @args.compact.empty? # TODO if args empty then wait till there is an arc child and it starts the figure
+        children.dup.each {|child| child.draw(area_draw_params)}
+        ::LibUI.draw_path_close_figure(path_proxy.libui) if closed?
+        super
+      end
+      
+      def closed(value = nil)
+        if value.nil?
+          @closed
+        else
+          @closed = value
+          area_proxy&.queue_redraw_all
+        end
+      end
+      alias closed= closed
+      alias set_closed closed
+      alias closed? closed
+    end
+  end
+end

data/lib/glimmer/libui/line.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 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/libui/shape'
+
+module Glimmer
+  module LibUI
+    class Line < Shape
+      parameters :x, :y
+      parameter_defaults 0, 0
+
+      def draw(area_draw_params)
+        ::LibUI.draw_path_line_to(path_proxy.libui, *@args)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/path_proxy.rb

@@ -42,16 +42,24 @@ module Glimmer
         children << child
       end
       
+      def post_add_content
+        super
+        if @parent_proxy.nil? && area_draw_params
+          draw(area_draw_params)
+          destroy
+        end
+      end
+      
       def children
         @children ||= []
       end
       
       def draw(area_draw_params)
         build_control
-        children.each {|child| child.draw(area_draw_params)}
+        children.dup.each {|child| child.draw(area_draw_params)}
         ::LibUI.draw_path_end(@libui)
-        ::LibUI.draw_fill(area_draw_params.Context, @libui, fill_draw_brush.to_ptr) unless fill.empty?
-        ::LibUI.draw_stroke(area_draw_params.Context, @libui, stroke_draw_brush, draw_stroke_params) unless stroke.empty?
+        ::LibUI.draw_fill(area_draw_params[:context], @libui, fill_draw_brush.to_ptr) unless fill.empty?
+        ::LibUI.draw_stroke(area_draw_params[:context], @libui, stroke_draw_brush, draw_stroke_params) unless stroke.empty?
         ::LibUI.draw_free_path(@libui)
       end
       
@@ -64,6 +72,14 @@ module Glimmer
           @fill ||= {}
         else
           @fill = args
+          @fill[:a] = 1.0 if @fill[:a].nil?
+          @parent_proxy&.queue_redraw_all
+        end
+        @fill.tap do
+          @fill_observer ||= Glimmer::DataBinding::Observer.proc do
+            @parent_proxy&.queue_redraw_all
+          end
+          @fill_observer.observe(@fill)
         end
       end
       alias fill= fill
@@ -80,6 +96,14 @@ module Glimmer
           @stroke ||= {}
         else
           @stroke = args
+          @stroke[:a] = 1.0 if @stroke[:a].nil?
+          @parent_proxy&.queue_redraw_all
+        end
+        @stroke.tap do
+          @stroke_observer ||= Glimmer::DataBinding::Observer.proc do
+            @parent_proxy&.queue_redraw_all
+          end
+          @stroke_observer.observe(@stroke)
         end
       end
       alias stroke= stroke
@@ -103,13 +127,17 @@ module Glimmer
         @draw_stroke_params.DashPhase = @stroke[:dash_phase] || 0
         @draw_stroke_params
       end
+      
+      # returns area_draw_params if built inside on_draw listener (not needed if declared outside)
+      def area_draw_params
+        @args[0] if @parent_proxy.nil?
+      end
     
       def destroy
-        if @parent_proxy
-          @parent_proxy.children.delete(self)
-        end
+        @parent_proxy.children.delete(self) unless @parent_proxy.nil?
+        ControlProxy.control_proxies.delete(self)
       end
-    
+      
       private
       
       def build_control

data/lib/glimmer/libui/rectangle.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 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/libui/shape'
+
+module Glimmer
+  module LibUI
+    class Rectangle < Shape
+      parameters :x, :y, :width, :height
+      parameter_defaults 0, 0, 0, 0
+    
+      def draw(area_draw_params)
+        ::LibUI.draw_path_add_rectangle(path_proxy.libui, *@args)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/shape.rb

@@ -0,0 +1,144 @@
+# Copyright (c) 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 LibUI
+    # Represents LibUI lightweight shape objects nested under path (e.g. line, rectangle, arc, bezier)
+    class Shape
+      class << self
+        def exists?(keyword)
+          Glimmer::LibUI.constants.include?(constant_symbol(keyword)) and
+            shape_class(keyword).respond_to?(:ancestors) and
+            shape_class(keyword).ancestors.include?(Shape)
+        end
+        
+        def create(keyword, parent, args, &block)
+          shape_class(keyword).new(keyword, parent, args, &block)
+        end
+        
+        def shape_class(keyword)
+          Glimmer::LibUI.const_get(constant_symbol(keyword))
+        end
+        
+        def parameters(*params)
+          if params.empty?
+            @parameters
+          else
+            @parameters = params
+          end
+        end
+        
+        def parameter_defaults(*defaults)
+          if defaults.empty?
+            @parameter_defaults
+          else
+            @parameter_defaults = defaults
+          end
+        end
+        
+        private
+        
+        def constant_symbol(keyword)
+          "#{keyword.camelcase(:upper)}".to_sym
+        end
+      end
+      
+      attr_reader :parent, :args, :keyword, :block
+      
+      def initialize(keyword, parent, args, &block)
+        @keyword = keyword
+        @parent = parent
+        @args = args
+        @block = block
+        set_parameter_defaults
+        post_add_content if @block.nil?
+      end
+      
+      # Subclasses may override to perform post add_content work (normally must call super)
+      def post_add_content
+        @parent&.post_initialize_child(self)
+      end
+      
+      # Subclasses may override to perform post initialization work on an added child (normally must call super)
+      def post_initialize_child(child)
+        children << child
+      end
+      
+      def children
+        @children ||= []
+      end
+      
+      # Subclasses must override to perform draw work and call super afterwards to ensure calling destroy when semi-declarative in an on_draw method
+      def draw(area_draw_params)
+        destroy if area_proxy.nil?
+      end
+      
+      def destroy
+        @parent.children.delete(self)
+      end
+      
+      def area_proxy
+        find_parent_in_ancestors { |parent| parent.nil? || parent.is_a?(AreaProxy) }
+      end
+      
+      def path_proxy
+        find_parent_in_ancestors { |parent| parent.nil? || parent.is_a?(PathProxy) }
+      end
+      
+      def respond_to?(method_name, *args, &block)
+        self.class.parameters.include?(method_name.to_s.sub(/=$/, '').sub(/^set_/, '').to_sym) or
+          super(method_name, true)
+      end
+      
+      def method_missing(method_name, *args, &block)
+        method_name_parameter = method_name.to_s.sub(/=$/, '').sub(/^set_/, '').to_sym
+        if self.class.parameters.include?(method_name_parameter)
+          method_name = method_name.to_s
+          parameter_index = self.class.parameters.index(method_name_parameter)
+          if method_name.start_with?('set_') || method_name.end_with?('=') || !args.empty?
+            @args[parameter_index] = args.first
+            area_proxy&.queue_redraw_all
+          else
+            @args[parameter_index]
+          end
+        else
+          super
+        end
+      end
+      
+      private
+      
+      def set_parameter_defaults
+        self.class.parameter_defaults.each_with_index do |default, i|
+          @args[i] ||= default
+        end
+      end
+      
+      def find_parent_in_ancestors(&condition)
+        found = self
+        until condition.call(found)
+          found = found.respond_to?(:parent_proxy) ? found.parent_proxy : found.parent
+        end
+        found
+      end
+    end
+  end
+end

data/lib/glimmer/libui/square.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 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/libui/shape'
+
+module Glimmer
+  module LibUI
+    class Square < Shape
+      parameters :x, :y, :length
+      parameter_defaults 0, 0, 0
+    
+      def draw(area_draw_params)
+        ::LibUI.draw_path_add_rectangle(path_proxy.libui, *@args, length)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/window_proxy.rb

@@ -48,8 +48,14 @@ module Glimmer
       end
       
       def on_destroy(&block)
+        # TODO look into a way to generalize this logic for multiple listeners
         @on_destroy_procs ||= []
-        @on_destroy_procs << block
+        if block.nil?
+          @on_destroy_procs
+        else
+          @on_destroy_procs << block
+          block
+        end
       end
     
       def show