glimmer-dsl-libui 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab738eba1965fffc98860a23a44f2e1ed15c0c426ba4d21bcbb3fc4812ecde5
-  data.tar.gz: 2d5c195882767b63d941d9b8bad8338bc5d5ce160e97f34a9f57f5631c833fac
+  metadata.gz: a9821169ec1b82253239d5169165c94c76e8b4efa407c27ccf4e73eae25cd68f
+  data.tar.gz: 47b312e49da5f6acf1011d1e45283d1b6d9cb2f8a03d37e218fba794e07990d9
 SHA512:
-  metadata.gz: 23e1de3b8f30f90abb605a351e6cd9302dd778da2e711f7c72c4ad39b267090bab324bd056ca3855c343781c53757af320ca67c0d4aacac4c6351f7cf4a646e8
-  data.tar.gz: 18f3d9b8d48bc15a342efeb38f6979e1b2516b5144a790876d931c28a2803da840f980d0d9b9cd4c96484817d4cf241d19b7b64c751229fa1ae6a236029545ac
+  metadata.gz: 326d75305142c5773a9dfd487fb595e7271c26a003ff1db10771a5e805e8c77eb567f6f56b54ac7ab721e2ed532f70ccdd9fa42437f6fd12c616f98d28c91f0e
+  data.tar.gz: a60432231078bf85d00e8882657eae577eeb99cf0b71a57f12c485c933577f8f4f7d98ec1cb6337f4ab4f1d02bf0c0061a618b9f998c16dc05641ad6efc8352f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.17
+
+- Support examples/basic_table.rb
+- Support non-editable `table` control
+- Support table `text_column`
+- Support table `cell_rows` property as an `Array` (rows) of `Array`s (row columns) of cell values
+
 ## 0.0.16
 
 - Support ability to instantiate without args and set args as properties afterwards inside block (e.g. `window { title 'Greeter'; content_size 300, 400; button {text 'Greet'; on_clicked {puts 'Hi'}} }`)

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.16
+# [<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.17
 ## 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.16](#-glimmer-dsl-for-libui-0016)
+- [Glimmer DSL for LibUI 0.0.17](#-glimmer-dsl-for-libui-0017)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -69,6 +69,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Date Time Picker](#date-time-picker)
     - [Grid](#grid)
     - [Form](#form)
+    - [Basic Table](#basic-table)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -156,7 +157,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.16'
+gem 'glimmer-dsl-libui', '~> 0.0.17'
 ```
 
 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.
@@ -241,9 +242,11 @@ Control(Args) | Properties | Listeners
 `spinbox(min as Numeric, max as Numeric)` | `value` (`Numeric`) | `on_changed`
 `tab` | `margined` (Boolean), `num_pages` (`Integer`) | None
 `tab_item(name as String)` | `index` [read-only] (`Integer`), `margined` (Boolean), `name` [read-only] (`String`) | None
+`table` | `cell_rows` (`Array` (rows) of `Arrays` (row columns) of cell values (e.g. `String` values)) | None
+`text_column(name as String)` | None | None
 `time_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`
 `vertical_box` | `padded` (Boolean) | None
-`window(title as String, width as Integer, height as Integer, has_menubar as Boolean)` | `borderless` (Boolean), `content_size` (width `Numeric`, height `Numeric`), `fullscreen` (Boolean), `margined` (Boolean), `title` (`String`) | `on_closing`, `on_content_size_changed`
+`window(title as String, width as Integer, height as Integer, has_menubar as Boolean)` | `borderless` (Boolean), `content_size` (width `Numeric`, height `Numeric`), `fullscreen` (Boolean), `margined` (Boolean), `title` (`String`) | `on_closing`, `on_content_size_changed`, `on_destroy`
 
 ### Common Control Properties
 - `enabled` (Boolean)
@@ -303,6 +306,7 @@ Control(Args) | Properties | Listeners
 - When destroying a control nested under a `window` or `group`, it is automatically unset as their child to allow successful destruction
 - For `date_time_picker`, `date_picker`, and `time_picker`, make sure `time` hash values for `mon`, `wday`, and `yday` are 1-based instead of [libui](https://github.com/andlabs/libui) original 0-based values, and return `dst` as Boolean instead of `isdst` as `1`/`0`
 - Smart defaults for `grid` child attributes are `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`0`), `vexpand` (`false`), and `valign` (`0`)
+- The `table` control automatically constructs required `TableModelHandler`, `TableModel`, and `TableParams`, calculating all their arguments from `cell_rows` property (e.g. `NumRows`)
 
 ### API Gotchas
 
@@ -1629,8 +1633,8 @@ window('Grid') {
   tab {
     tab_item('Spanning') {
       grid {
-        4.times { |left_value|
-          4.times { |top_value|
+        4.times { |top_value|
+          4.times { |left_value|
             label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
               left left_value
               top top_value
@@ -1749,6 +1753,126 @@ window('Form') { |w|
 }.show
 ```
 
+### Basic Table
+
+[examples/basic_table.rb](examples/basic_table.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_table.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_table'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-basic-table.png](images/glimmer-dsl-libui-mac-basic-table.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-basic-table.png](images/glimmer-dsl-libui-linux-basic-table.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+require 'libui'
+
+UI = LibUI
+
+UI.init
+
+main_window = UI.new_window('Animal sounds', 300, 200, 1)
+
+hbox = UI.new_horizontal_box
+UI.window_set_child(main_window, hbox)
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[checken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+# Protects BlockCaller objects from garbage collection.
+@blockcaller = []
+def rbcallback(*args, &block)
+  args << [0] if args.size == 1 # Argument types are ommited
+  blockcaller = Fiddle::Closure::BlockCaller.new(*args, &block)
+  @blockcaller << blockcaller
+  blockcaller
+end
+
+model_handler = UI::FFI::TableModelHandler.malloc
+model_handler.NumColumns   = rbcallback(4) { 2 }
+model_handler.ColumnType   = rbcallback(4) { 0 }
+model_handler.NumRows      = rbcallback(4) { 5 }
+model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+  UI.new_table_value_string(data[row][column])
+end
+model_handler.SetCellValue = rbcallback(0, [0]) {}
+
+model = UI.new_table_model(model_handler)
+
+table_params = UI::FFI::TableParams.malloc
+table_params.Model = model
+table_params.RowBackgroundColorModelColumn = -1
+
+table = UI.new_table(table_params)
+UI.table_append_text_column(table, 'Animal', 0, -1)
+UI.table_append_text_column(table, 'Description', 1, -1)
+
+UI.box_append(hbox, table, 1)
+UI.control_show(main_window)
+
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.free_table_model(model)
+  UI.quit
+  0
+end
+
+UI.main
+UI.quit
+```
+
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.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.16
+0.0.17

data/examples/basic_table.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/grid.rb

@@ -8,8 +8,8 @@ window('Grid') {
   tab {
     tab_item('Spanning') {
       grid {
-        4.times { |left_value|
-          4.times { |top_value|
+        4.times { |top_value|
+          4.times { |left_value|
             label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
               left left_value
               top top_value

data/lib/glimmer/libui/table_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'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI table objects
+    #
+    # Follows the Proxy Design Pattern
+    class TableProxy < ControlProxy
+      attr_reader :model_handler, :model, :table_params, :columns
+    
+      def initialize(keyword, parent, args, &block)
+        @keyword = keyword
+        @parent_proxy = parent
+        @args = args
+        @block = block
+        @enabled = true
+        @columns = []
+        @cell_rows = []
+        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?(Glimmer::LibUI::Box)
+        end
+      end
+      
+      def post_add_content
+        build_control
+        super
+      end
+      
+      def post_initialize_child(child)
+        @columns << child
+      end
+      
+      def destroy
+        super
+        @destroyed = true
+      end
+      
+      def cell_rows(rows = nil)
+        if rows.nil?
+          @cell_rows
+        else
+          @cell_rows = rows
+        end
+      end
+      alias cell_rows= cell_rows
+      alias set_cell_rows cell_rows
+      
+      private
+      
+      def build_control
+        @model_handler = ::LibUI::FFI::TableModelHandler.malloc
+        @model_handler.NumColumns   = rbcallback(4) { @columns.count }
+        @model_handler.ColumnType   = rbcallback(4) { 0 } # TODO derive from @columns when supporting multiple column types in the future
+        @model_handler.NumRows      = rbcallback(4) { cell_rows.count }
+        @model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+          ::LibUI.new_table_value_string((@cell_rows[row] && @cell_rows[row][column]).to_s)
+        end
+        
+        @model = ::LibUI.new_table_model(@model_handler)
+        
+        @table_params = ::LibUI::FFI::TableParams.malloc
+        @table_params.Model = @model
+        @table_params.RowBackgroundColorModelColumn = -1
+        
+        @libui = ControlProxy.new_control(@keyword, [@table_params])
+        @libui.tap do
+          @columns.each {|column| column.send(:build_control) }
+        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
+      
+    end
+  end
+end

data/lib/glimmer/libui/text_column_proxy.rb

@@ -0,0 +1,51 @@
+# 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 text column objects
+    #
+    # Follows the Proxy Design Pattern
+    class TextColumnProxy < ControlProxy
+      def initialize(keyword, parent, args, &block)
+        # TODO eventually move this to a supermodule ColumnProxy
+        @keyword = keyword
+        @parent_proxy = parent
+        @args = args
+        @block = block
+        @enabled = true
+        post_add_content if @block.nil?
+      end
+    
+      def name
+        @args.first
+      end
+      
+      private
+      
+      def build_control
+        @libui = @parent_proxy.append_text_column(name, @parent_proxy.columns.map(&:libui).compact.count, -1) # -1 for non-editable for now until editing is supported
+      end
+    end
+  end
+end

data/lib/glimmer/libui/window_proxy.rb

@@ -40,6 +40,16 @@ module Glimmer
         ::LibUI.send("window_set_child", @libui, nil)
         super
       end
+      
+      def destroy
+        super
+        @on_destroy_procs&.each { |on_destroy_proc| on_destroy_proc.call(self)}
+      end
+      
+      def on_destroy(&block)
+        @on_destroy_procs ||= []
+        @on_destroy_procs << block
+      end
     
       def show
         super

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Andy Maleh
@@ -182,6 +182,7 @@ files:
 - bin/girb_runner.rb
 - examples/basic_button.rb
 - examples/basic_entry.rb
+- examples/basic_table.rb
 - examples/basic_window.rb
 - examples/basic_window2.rb
 - examples/color_button.rb
@@ -229,6 +230,8 @@ files:
 - lib/glimmer/libui/radio_buttons_proxy.rb
 - lib/glimmer/libui/separator_menu_item_proxy.rb
 - lib/glimmer/libui/tab_item_proxy.rb
+- lib/glimmer/libui/table_proxy.rb
+- lib/glimmer/libui/text_column_proxy.rb
 - lib/glimmer/libui/time_picker_proxy.rb
 - lib/glimmer/libui/vertical_box_proxy.rb
 - lib/glimmer/libui/window_proxy.rb