glimmer-dsl-libui 0.0.27 → 0.1.2

data/examples/dynamic_area.rb

@@ -0,0 +1,99 @@
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Dynamic Area', 240, 600) {
+  margined true
+  
+  vertical_box {
+    label('Rectangle Properties') {
+      stretchy false
+    }
+    
+    form {
+      stretchy false
+      
+      @x_spinbox = spinbox(0, 1000) {
+        label 'x'
+        value 25
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @y_spinbox = spinbox(0, 1000) {
+        label 'y'
+        value 25
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @width_spinbox = spinbox(0, 1000) {
+        label 'width'
+        value 150
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @height_spinbox = spinbox(0, 1000) {
+        label 'height'
+        value 150
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @red_spinbox = spinbox(0, 255) {
+        label 'red'
+        value 102
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @green_spinbox = spinbox(0, 255) {
+        label 'green'
+        value 102
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @blue_spinbox = spinbox(0, 255) {
+        label 'blue'
+        value 204
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+      
+      @alpha_spinbox = spinbox(0, 100) {
+        label 'alpha'
+        value 100
+        
+        on_changed do
+          @area.queue_redraw_all
+        end
+      }
+    }
+    
+    @area = area {
+      on_draw do |area_draw_params|
+        path(area_draw_params) { # a dynamic path is added semi-declaratively inside on_draw block
+          rectangle(@x_spinbox.value, @y_spinbox.value, @width_spinbox.value, @height_spinbox.value)
+          
+          fill r: @red_spinbox.value, g: @green_spinbox.value, b: @blue_spinbox.value, a: @alpha_spinbox.value / 100.0
+        }
+      end
+    }
+  }
+}.show

data/examples/dynamic_area2.rb

@@ -0,0 +1,97 @@
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Dynamic Area', 240, 600) {
+  margined true
+  
+  vertical_box {
+    label('Rectangle Properties') {
+      stretchy false
+    }
+    
+    form {
+      stretchy false
+      
+      @x_spinbox = spinbox(0, 1000) {
+        label 'x'
+        value 25
+        
+        on_changed do
+          @rectangle.x = @x_spinbox.value # updating properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @y_spinbox = spinbox(0, 1000) {
+        label 'y'
+        value 25
+        
+        on_changed do
+          @rectangle.y = @y_spinbox.value # updating properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @width_spinbox = spinbox(0, 1000) {
+        label 'width'
+        value 150
+        
+        on_changed do
+          @rectangle.width = @width_spinbox.value # updating properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @height_spinbox = spinbox(0, 1000) {
+        label 'height'
+        value 150
+        
+        on_changed do
+          @rectangle.height = @height_spinbox.value # updating properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @red_spinbox = spinbox(0, 255) {
+        label 'red'
+        value 102
+        
+        on_changed do
+          @path.fill[:r] = @red_spinbox.value # updating hash properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @green_spinbox = spinbox(0, 255) {
+        label 'green'
+        value 102
+        
+        on_changed do
+          @path.fill[:g] = @green_spinbox.value # updating hash properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @blue_spinbox = spinbox(0, 255) {
+        label 'blue'
+        value 204
+        
+        on_changed do
+          @path.fill[:b] = @blue_spinbox.value # updating hash properties automatically triggers area.queue_redraw_all
+        end
+      }
+      
+      @alpha_spinbox = spinbox(0, 100) {
+        label 'alpha'
+        value 100
+        
+        on_changed do
+          @path.fill[:a] = @alpha_spinbox.value / 100.0 # updating hash properties automatically triggers area.queue_redraw_all
+        end
+      }
+    }
+    
+    area {
+      @path = path { # stable path
+        @rectangle = rectangle(@x_spinbox.value, @y_spinbox.value, @width_spinbox.value, @height_spinbox.value)
+        
+        fill r: @red_spinbox.value, g: @green_spinbox.value, b: @blue_spinbox.value, a: @alpha_spinbox.value / 100.0
+      }
+    }
+  }
+}.show

data/lib/glimmer/fiddle_consumer.rb

@@ -0,0 +1,33 @@
+# 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 FiddleConsumer
+    # Protects Fiddle::Closure::BlockCaller objects from garbage collection.
+    def fiddle_closure_block_caller(*args, &block)
+      @blockcaller ||= []
+      args << [0] if args.size == 1 # Argument types are ommited
+      blockcaller = ::Fiddle::Closure::BlockCaller.new(*args, &block)
+      @blockcaller << blockcaller
+      blockcaller
+    end
+  end
+end

data/lib/glimmer/libui/area_proxy.rb

@@ -0,0 +1,105 @@
+# 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/control_proxy'
+require 'glimmer/fiddle_consumer'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI area objects
+    #
+    # Follows the Proxy Design Pattern
+    class AreaProxy < ControlProxy
+      include Glimmer::FiddleConsumer
+      
+      attr_reader :area_handler
+      
+      def post_initialize_child(child)
+        super
+        children << child
+      end
+      
+      def post_add_content
+        super
+        install_listeners
+      end
+      
+      def children
+        @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
+        @area_handler = ::LibUI::FFI::AreaHandler.malloc
+        @libui    = ::LibUI.new_area(@area_handler)
+      end
+      
+      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)
+          area_draw_params = area_draw_params_hash(area_draw_params)
+          children.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/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/checkbox_column_proxy.rb

@@ -30,12 +30,12 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class CheckboxColumnProxy < ControlProxy
       include Column
-#       include EditableColumn # TODO enable this once checkbox column becomes editable on macosx in C libui (currently has a bug)
+      include EditableColumn
       
       private
       
       def build_control
-        @parent_proxy.append_checkbox_column(name, column_index, -1)
+        @parent_proxy.append_checkbox_column(name, column_index, editable_value)
       end
     end
   end

data/lib/glimmer/libui/checkbox_text_column_proxy.rb

@@ -32,12 +32,44 @@ module Glimmer
     class CheckboxTextColumnProxy < ControlProxy
       include Column
       include DualColumn
-      include EditableColumn # TODO split into editable_checkbox and editable_text properties in the future given that checkbox and text can be edited separately
+      include EditableColumn
       
+      def editable_checkbox(value = nil)
+        if value.nil?
+          @editable_checkbox = false if @editable_checkbox.nil?
+          @editable_checkbox
+        else
+          @editable_checkbox = !!value
+        end
+      end
+      alias editable_checkbox= editable_checkbox
+      alias set_editable_checkbox editable_checkbox
+      alias editable_checkbox? editable_checkbox
+
+      def editable_text(value = nil)
+        if value.nil?
+          @editable_text = false if @editable_text.nil?
+          @editable_text
+        else
+          @editable_text = !!value
+        end
+      end
+      alias editable_text= editable_text
+      alias set_editable_text editable_text
+      alias editable_text? editable_text
+
       private
       
       def build_control
-        @parent_proxy.append_checkbox_text_column(name, column_index, -1, second_column_index, editable_value)
+        @parent_proxy.append_checkbox_text_column(name, column_index, editable_checkbox_value, second_column_index, editable_text_value)
+      end
+      
+      def editable_checkbox_value
+        (@parent_proxy.editable? || editable? || editable_checkbox?) ? -2 : -1
+      end
+      
+      def editable_text_value
+        (@parent_proxy.editable? || editable? || editable_text?) ? -2 : -1
       end
     end
   end

data/lib/glimmer/libui/control_proxy.rb

@@ -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/path_proxy.rb

@@ -0,0 +1,167 @@
+# 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/control_proxy'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI path objects
+    #
+    # Follows the Proxy Design Pattern
+    class PathProxy < ControlProxy
+      # TODO support mode without parent proxy
+      def initialize(keyword, parent, args, &block)
+        @keyword = keyword
+        @parent_proxy = parent
+        @args = args
+        @block = block
+        @enabled = true
+        post_add_content if @block.nil?
+      end
+    
+      def post_initialize_child(child)
+        super
+        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)}
+        ::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_free_path(@libui)
+      end
+      
+      def draw_fill_mode
+        @args[0].is_a?(Integer) ? @args[0] : @args[0].to_s == 'alternate' ? 1 : 0
+      end
+      
+      def fill(args = nil)
+        if args.nil?
+          @fill ||= {}
+        else
+          @fill = args
+          @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
+      alias set_fill fill
+      
+      def fill_draw_brush
+        @fill_draw_brush ||= ::LibUI::FFI::DrawBrush.malloc
+        init_draw_brush(@fill_draw_brush, @fill)
+        @fill_draw_brush
+      end
+    
+      def stroke(args = nil)
+        if args.nil?
+          @stroke ||= {}
+        else
+          @stroke = args
+          @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
+      alias set_stroke stroke
+      
+      def stroke_draw_brush
+        @stroke_draw_brush ||= ::LibUI::FFI::DrawBrush.malloc
+        init_draw_brush(@stroke_draw_brush, @stroke)
+        @stroke_draw_brush
+      end
+      
+      def draw_stroke_params
+        @draw_stroke_params ||= ::LibUI::FFI::DrawStrokeParams.malloc
+        @draw_stroke_params.Cap = @stroke[:cap] || 0 # flat
+        @draw_stroke_params.Join = @stroke[:join] || 0 # miter
+        @draw_stroke_params.Thickness = @stroke[:thickness] || 1
+        @draw_stroke_params.MiterLimit = @stroke[:miter_limit] || 10 # DEFAULT_MITER_LIMIT
+        @draw_stroke_params_dashes ||= Fiddle::Pointer.malloc(8)
+        @draw_stroke_params.Dashes = @draw_stroke_params_dashes
+        @draw_stroke_params.NumDashes = @stroke[:num_dashes] || 0 # TODO reimplement this line correctly (perhaps no need to pass num dashes, yet dashes themselves and use their count here)
+        @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
+        @parent_proxy.children.delete(self) unless @parent_proxy.nil?
+        ControlProxy.control_proxies.delete(self)
+      end
+      
+      private
+      
+      def build_control
+        @libui = ::LibUI.draw_new_path(draw_fill_mode)
+      end
+      
+      def init_draw_brush(draw_brush, draw_brush_args)
+        case draw_brush_args[:type]
+        when Integer
+          draw_brush.Type = draw_brush_args[:type]
+        when :solid, 'solid'
+          draw_brush.Type = 0
+        when :linear_gradient, 'linear_gradient'
+          draw_brush.Type = 1
+        when :radial_gradient, 'radial_gradient'
+          draw_brush.Type = 2
+        when :image, 'image'
+          draw_brush.Type = 3
+        else
+          draw_brush.Type = 0
+        end
+        draw_brush.R = (draw_brush_args[:r] || draw_brush_args[:red]).to_f / 255.0
+        draw_brush.G = (draw_brush_args[:g] || draw_brush_args[:green]).to_f / 255.0
+        draw_brush.B = (draw_brush_args[:b] || draw_brush_args[:blue]).to_f / 255.0
+        draw_brush.A = (draw_brush_args[:a] || draw_brush_args[:alpha])
+      end
+    end
+  end
+end

data/lib/glimmer/libui/rectangle_proxy.rb

@@ -0,0 +1,100 @@
+# 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/control_proxy'
+
+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
+    
+      def draw(area_draw_params)
+        ::LibUI.draw_path_add_rectangle(@parent_proxy.libui, *@args)
+        destroy if @parent_proxy.parent_proxy.nil?
+      end
+      
+      def destroy
+        @parent_proxy.children.delete(self) unless @parent_proxy.nil?
+        ControlProxy.control_proxies.delete(self)
+      end
+      
+      def x(value = nil)
+        if value.nil?
+          @args[0]
+        else
+          @args[0] = value
+          @parent_proxy.parent_proxy&.queue_redraw_all
+        end
+      end
+      alias x= x
+      alias set_x x
+      
+      def y(value = nil)
+        if value.nil?
+          @args[1]
+        else
+          @args[1] = value
+          @parent_proxy.parent_proxy&.queue_redraw_all
+        end
+      end
+      alias y= y
+      alias set_y y
+      
+      def width(value = nil)
+        if value.nil?
+          @args[2]
+        else
+          @args[2] = value
+          @parent_proxy.parent_proxy&.queue_redraw_all
+        end
+      end
+      alias width= width
+      alias set_width width
+      
+      def height(value = nil)
+        if value.nil?
+          @args[3]
+        else
+          @args[3] = value
+          @parent_proxy.parent_proxy&.queue_redraw_all
+        end
+      end
+      alias height= height
+      alias set_height height
+      
+      private
+      
+      def build_control
+        # No Op
+      end
+    end
+  end
+end