glimmer-dsl-libui 0.0.28 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54faaec785d114536e8b747aa55f7d7bd043339e99f041722d60d70623a9b648
-  data.tar.gz: 9391f99834f34e2b878b2dbf41b7a8ff3f1ab58daf003acdf33a4f93a2e0777c
+  metadata.gz: f0e5255370f70684a7f60de75fe52399f604761996059b23370ce53c4e11cdd1
+  data.tar.gz: 00fe32154a83c206843d2386406cde3841da5296cb432585d8aedf421578c47c
 SHA512:
-  metadata.gz: 8f2d65ebb19e77c5fab1e037c751af43635a03b07671c8e03ac507bf4e01c04e37c083ffe91a4b18796505801e0d77d84770d0aa13951785422db6ae3c11830f
-  data.tar.gz: 34965b3e01a55733b767dccb4356b4902627a55fd6843295c76fc473a4b049456c7ee59df12bfc9f61541668b763a394d1fb43955f057f6cc8f6a4f72a2ae6b3
+  metadata.gz: 92ef8efbe6d9563dcf20affce754ea4f8fd6ee3eceec014f7499a8ea15631e0127877526ca313513129aee506dc9b363651dde235e2e965a456ddcb2df29c7ae
+  data.tar.gz: 9ceec5135f065862bfc7590883346dc0930380da5e12f6b575a5c4a6c1c6d45e7d575392daf0b003cf78889a5c90cc4033cd48783e1a6c2cd5f4e53d4814b009

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.1.0
+
+- Support examples/basic_area.rb
+- Support `area` control
+- Support `path(fill_mode)` control
+- Support `rectangle(x, y, width, height)` figure
+- Support `path` `fill` property
+- Support `path` `stroke` property
+
 ## 0.0.28
 
 - Support automatic table row change when updating a row in `cell_rows` (e.g. `data[3] = ['new', 'row', 'cell', 'values']`)

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.0.28
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.1.0
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ce2853efdbecf6ebdc73/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-libui/maintainability)
@@ -43,7 +43,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.0.28](#-glimmer-dsl-for-libui-0028)
+  - [Glimmer DSL for LibUI 0.1.0](#-glimmer-dsl-for-libui-010)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -53,6 +53,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Extra Dialogs](#extra-dialogs)
     - [Extra Operations](#extra-operations)
     - [Table API](#table-api)
+    - [Area API](#area-api)
     - [Smart Defaults and Conventions](#smart-defaults-and-conventions)
     - [API Gotchas](#api-gotchas)
     - [Original API](#original-api)
@@ -80,6 +81,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Basic Table Checkbox Text](#basic-table-checkbox-text)
     - [Basic Table Progress Bar](#basic-table-progress-bar)
     - [Form Table](#form-table)
+    - [Basic Area](#basic-area)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -167,7 +169,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.28'
+gem 'glimmer-dsl-libui', '~> 0.1.0'
 ```
 
 Add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
@@ -223,11 +225,12 @@ w.libui # => #<Fiddle::Pointer:0x00007fde53997980 ptr=0x00007fde51352a60 size=0
 Control(Args) | Properties | Listeners
 ------------- | ---------- | ---------
 `about_menu_item` | None | `on_clicked`
+`area` | None | None
 `button(text as String)` | `text` (`String`) | `on_clicked`
 `button_column(name as String)` | `enabled` (Boolean) | None
 `checkbox(text as String)` | `checked` (Boolean), `text` (`String`) | `on_toggled`
-`checkbox_column(name as String)` | `editable` (Boolean) [Windows-only due to a current libui limitation] | None
-`checkbox_text_column(name as String)` | `editable` (Boolean) [Windows-only due to a current libui limitation], `editable_checkbox` (Boolean) [Windows-only due to a current libui limitation], `editable_text` (Boolean) | None
+`checkbox_column(name as String)` | `editable` (Boolean) | None
+`checkbox_text_column(name as String)` | `editable` (Boolean), `editable_checkbox` (Boolean), `editable_text` (Boolean) | None
 `combobox` | `items` (`Array` of `String`), `selected` (`Integer`) | `on_selected`
 `color_button` | `color` (Array of `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float`), `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float` | `on_changed`
 `date_picker` | `time` (`Hash` of keys: `sec` as `Integer`, `min` as `Integer`, `hour` as `Integer`, `mday` as `Integer`, `mon` as `Integer`, `year` as `Integer`, `wday` as `Integer`, `yday` as `Integer`, `dst` as Boolean) | `on_changed`
@@ -251,11 +254,13 @@ Control(Args) | Properties | Listeners
 `msg_box(window as Glimmer::LibUI::WindowProxy, title as String, description as String)` | None | None
 `msg_box_error(window as Glimmer::LibUI::WindowProxy, title as String, description as String)` | None | None
 `non_wrapping_multiline_entry` | `read_only` (Boolean), `text` (`String`) | `on_changed`
+`path` | `fill` (`Hash` of `:r` as `0`-`255`, `:g` as `0`-`255`, `:b` as `0`-`255`, `:a` as `0.0`-`1.0`), `stroke` (`Hash` of `:r` as `0`-`255`, `:g` as `0`-`255`, `:b` as `0`-`255`, `:a` as `0.0`-`1.0`, `:cap` as `Numeric`, `:join` as `Numeric`, `:thickness` as `Numeric`, `:miter_limit` as `Numeric` ) | None
 `preferences_menu_item` | None | `on_clicked`
 `progress_bar` | `value` (`Numeric`) | None
 `progress_bar_column(name as String)` | None | None
 `quit_menu_item` | None | `on_clicked`
 `radio_buttons` | `selected` (`Integer`) | `on_selected`
+`rectangle(x as Numeric, y as Numeric, width as Numeric, height as Numeric)` | None | None
 `slider(min as Numeric, max as Numeric)` | `value` (`Numeric`) | `on_changed`
 `spinbox(min as Numeric, max as Numeric)` | `value` (`Numeric`) | `on_changed`
 `tab` | `margined` (Boolean), `num_pages` (`Integer`) | None
@@ -321,6 +326,10 @@ Note that the `cell_rows` property declaration results in "implicit data-binding
 - Inserting cell rows: Calling `Array#<<`, `Array#push`, `Array#prepend`, or any insertion/addition `Array` method automatically inserts rows in actual `table` control
 - Changing cell rows: Calling `Array#[]=`, `Array#map!`, or any update `Array` method automatically updates rows in actual `table` control
 
+### Area API
+
+The `area` control can have a `path` nested underneath declaratively, containing figures like `rectangle`, and all the drawing logic is generated automatically from that.
+
 ### Smart Defaults and Conventions
 
 - `horizontal_box`, `vertical_box`, `grid`, and `form` controls have `padded` as `true` upon instantiation to ensure more user-friendly GUI by default
@@ -349,11 +358,12 @@ Note that the `cell_rows` property declaration results in "implicit data-binding
 - Table `cell_rows` data has implicit data-binding to table cell values for deletion, insertion, and change (done by diffing `cell_rows` value before and after change and auto-informing `table` of deletions [`LibUI.table_model_row_deleted`], insertions [`LibUI.table_model_row_deleted`], and changes [`LibUI.table_model_row_changed`]). When deleting data rows from `cell_rows` array, then actual rows from the `table` are automatically deleted. When inserting data rows into `cell_rows` array, then actual `table` rows are automatically inserted. When updating data rows in `cell_rows` array, then actual `table` rows are automatically updated.
 - `image` instances are automatically freed from memory after `window` is destroyed.
 - `image` `width` and `height` can be left off if it has one `image_part` only as they default to the same `width` and `height` of the `image_part`
+- `area` paths are specified declaratively with figures underneath (e.g. `rectangle`) and `area` draw listener is automatically generated
 
 ### API Gotchas
 
 - There is no proper way to destroy `grid` children due to [libui](https://github.com/andlabs/libui) not offering any API for deleting them from `grid` (no `grid_delete` similar to `box_delete` for `horizontal_box` and `vertical_box`).
-- `table` `checkbox_column` and `checkbox_text_column` checkbox editing currently only works in Windows due to a current limitation in [libui](https://github.com/andlabs/libui).
+- `table` `checkbox_column` and `checkbox_text_column` checkbox editing only works on Windows and Linux (not Mac) due to a current limitation in [libui](https://github.com/andlabs/ui/issues/357).
 
 ### Original API
 
@@ -2581,6 +2591,104 @@ window('Contacts', 600, 600) { |w|
 }.show
 ```
 
+### Basic Area
+
+[examples/basic_area.rb](examples/basic_area.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_area.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_area'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-basic-area.png](images/glimmer-dsl-libui-mac-basic-area.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-basic-area.png](images/glimmer-dsl-libui-linux-basic-area.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+require 'libui'
+
+UI = LibUI
+
+UI.init
+
+handler = UI::FFI::AreaHandler.malloc
+area    = UI.new_area(handler)
+brush   = UI::FFI::DrawBrush.malloc
+
+handler_draw_event = Fiddle::Closure::BlockCaller.new(0, [1, 1, 1]) do |_, _, area_draw_params|
+  path = UI.draw_new_path(0)
+  UI.draw_path_add_rectangle(path, 0, 0, 400, 400)
+  UI.draw_path_end(path)
+  brush.Type = 0
+  brush.R = 0.4
+  brush.G = 0.4
+  brush.B = 0.8
+  brush.A = 1.0
+  area_draw_params = UI::FFI::AreaDrawParams.new(area_draw_params)
+  UI.draw_fill(area_draw_params.Context, path, brush.to_ptr)
+  UI.draw_free_path(path)
+end
+
+handler.Draw         = handler_draw_event
+handler.MouseEvent   = Fiddle::Closure::BlockCaller.new(0, [0]) {}
+handler.MouseCrossed = Fiddle::Closure::BlockCaller.new(0, [0]) {}
+handler.DragBroken   = Fiddle::Closure::BlockCaller.new(0, [0]) {}
+handler.KeyEvent     = Fiddle::Closure::BlockCaller.new(0, [0]) {}
+
+box = UI.new_vertical_box
+UI.box_set_padded(box, 1)
+UI.box_append(box, area, 1)
+
+main_window = UI.new_window('Basic Area', 400, 400, 1)
+UI.window_set_margined(main_window, 1)
+UI.window_set_child(main_window, box)
+
+UI.window_on_closing(main_window) do
+  UI.control_destroy(main_window)
+  UI.quit
+  0
+end
+UI.control_show(main_window)
+
+UI.main
+UI.quit
+```
+
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Basic Area', 400, 400) {
+  margined true
+  
+  vertical_box {
+    area {
+      path { # a stable path is added declaratively
+        rectangle(0, 0, 400, 400)
+        
+        fill r: 102, g: 102, b: 204, a: 1.0
+      }
+    }
+  }
+}.show
+```
+
 ## Contributing to glimmer-dsl-libui
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.0.28
+0.1.0

data/examples/basic_area.rb

@@ -0,0 +1,17 @@
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Basic Area', 400, 400) {
+  margined true
+  
+  vertical_box {
+    area {
+      path { # a stable path is added declaratively
+        rectangle(0, 0, 400, 400)
+        
+        fill r: 102, g: 102, b: 204, a: 1.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,68 @@
+# 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
+      
+      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)
+          children.each {|child| child.draw(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
+    end
+  end
+end

data/lib/glimmer/libui/path_proxy.rb

@@ -0,0 +1,141 @@
+# 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 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
+        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
+        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
+    
+      def destroy
+        if @parent_proxy
+          @parent_proxy.children.delete(self)
+        end
+      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,56 @@
+# 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)
+      end
+      
+      def destroy
+        if @parent_proxy
+          @parent_proxy.children.delete(self)
+        end
+      end
+      
+      private
+      
+      def build_control
+        # No Op
+      end
+    end
+  end
+end

data/lib/glimmer/libui/table_proxy.rb

@@ -21,6 +21,7 @@
 
 require 'glimmer/libui/control_proxy'
 require 'glimmer/data_binding/observer'
+require 'glimmer/fiddle_consumer'
 
 using ArrayIncludeMethods
 
@@ -30,6 +31,8 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class TableProxy < ControlProxy
+      include Glimmer::FiddleConsumer
+      
       attr_reader :model_handler, :model, :table_params, :columns
     
       def initialize(keyword, parent, args, &block)
@@ -112,8 +115,8 @@ module Glimmer
       
       def build_control
         @model_handler = ::LibUI::FFI::TableModelHandler.malloc
-        @model_handler.NumColumns   = rbcallback(4) { @columns.map {|c| c.is_a?(DualColumn) ? 2 : 1}.sum }
-        @model_handler.ColumnType   = rbcallback(4, [1, 1, 4]) do |_, _, column|
+        @model_handler.NumColumns   = fiddle_closure_block_caller(4) { @columns.map {|c| c.is_a?(DualColumn) ? 2 : 1}.sum }
+        @model_handler.ColumnType   = fiddle_closure_block_caller(4, [1, 1, 4]) do |_, _, column|
           case @columns[column]
           when TextColumnProxy, ButtonColumnProxy, NilClass
             0
@@ -123,8 +126,8 @@ module Glimmer
             2
           end
         end
-        @model_handler.NumRows      = rbcallback(4) { cell_rows.count }
-        @model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+        @model_handler.NumRows      = fiddle_closure_block_caller(4) { cell_rows.count }
+        @model_handler.CellValue    = fiddle_closure_block_caller(1, [1, 1, 4, 4]) do |_, _, row, column|
           the_cell_rows = expanded_cell_rows
           case @columns[column]
           when TextColumnProxy, ButtonColumnProxy, NilClass
@@ -137,7 +140,7 @@ module Glimmer
             ::LibUI.new_table_value_int((expanded_cell_rows[row] && (expanded_cell_rows[row][column].to_i)))
           end
         end
-        @model_handler.SetCellValue = rbcallback(0, [1, 1, 4, 4, 1]) do |_, _, row, column, val|
+        @model_handler.SetCellValue = fiddle_closure_block_caller(0, [1, 1, 4, 4, 1]) do |_, _, row, column, val|
           case @columns[column]
           when TextColumnProxy
             column = @columns[column].index
@@ -167,16 +170,6 @@ module Glimmer
         end
       end
       
-      def rbcallback(*args, &block)
-        # TODO consider moving to a more general reusable location in the future (e.g. when used with `AreaProxy`)
-        # Protects BlockCaller objects from garbage collection.
-        @blockcaller ||= []
-        args << [0] if args.size == 1 # Argument types are ommited
-        blockcaller = Fiddle::Closure::BlockCaller.new(*args, &block)
-        @blockcaller << blockcaller
-        blockcaller
-      end
-      
       def next_column_index
         @next_column_index ||= -1
         @next_column_index += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.1.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -194,6 +194,7 @@ files:
 - VERSION
 - bin/girb
 - bin/girb_runner.rb
+- examples/basic_area.rb
 - examples/basic_button.rb
 - examples/basic_entry.rb
 - examples/basic_table.rb
@@ -227,7 +228,9 @@ files:
 - lib/glimmer/dsl/libui/property_expression.rb
 - lib/glimmer/dsl/libui/save_file_expression.rb
 - lib/glimmer/dsl/libui/tab_item_expression.rb
+- lib/glimmer/fiddle_consumer.rb
 - lib/glimmer/libui/about_menu_item_proxy.rb
+- lib/glimmer/libui/area_proxy.rb
 - lib/glimmer/libui/box.rb
 - lib/glimmer/libui/button_column_proxy.rb
 - lib/glimmer/libui/button_proxy.rb
@@ -259,10 +262,12 @@ files:
 - lib/glimmer/libui/menu_proxy.rb
 - lib/glimmer/libui/multiline_entry_proxy.rb
 - lib/glimmer/libui/non_wrapping_multiline_entry_proxy.rb
+- lib/glimmer/libui/path_proxy.rb
 - lib/glimmer/libui/preferences_menu_item_proxy.rb
 - lib/glimmer/libui/progress_bar_column_proxy.rb
 - lib/glimmer/libui/quit_menu_item_proxy.rb
 - lib/glimmer/libui/radio_buttons_proxy.rb
+- lib/glimmer/libui/rectangle_proxy.rb
 - lib/glimmer/libui/separator_menu_item_proxy.rb
 - lib/glimmer/libui/tab_item_proxy.rb
 - lib/glimmer/libui/table_proxy.rb