glimmer-dsl-libui 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f4c60e8967700c477acdd623d75af1b119ab243f90e22b4f9861d9fbde3705
-  data.tar.gz: f92952b04a511a54107114cad3b7b336b4731720b4a6844097353c97fd16f4a5
+  metadata.gz: 3a7491ce7cea65fb7025868e9fb2db5c4e6187ba269a177879e4276e50fa3d9f
+  data.tar.gz: 9b47cab46d79af36dd06b6914570f30662540b7b8c1e634dc326ed9af32ad041
 SHA512:
-  metadata.gz: 7fb3cd049cadd55cfb9750c6167804a8af54d793498bc3a67ac1efe913ec4497e2dec7ed19c176d644ecf8f49e721ad33e5b4d49fc32cafb073ccf5b0b08cc9c
-  data.tar.gz: bf246270c2651c86fa311ac72e02dd75c1ba03074286e254edfb6a99ae2dc59a1084e4317649d04cea31abf1c6b68908bf962d5b091a5a205d56830b138eb0ee
+  metadata.gz: 692870dd49de81f7d2840579f0de3b7bd414bda277db56a4c28597febd012446c6b8b098bf56e5afe8c9b17f68547bb24bceaba45e15c3e4fd3ca041e5c37d2a
+  data.tar.gz: 289ede334bc53171a6a028dca1d03e794d0e81329621f2278365bfdcb2079fd200da21161d4aed6cf8486f382c4e0b04afadf3883ba0e07790878dbfd8fad334

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.0.21
+
+- New examples/editable_column_table_image_text.rb
+- Support table `image_text_column`
+
 ## 0.0.20
 
 - New examples/editable_column_table.rb

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.20
+# [<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.21
 ## 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.20](#-glimmer-dsl-for-libui-0020)
+- [Glimmer DSL for LibUI 0.0.21](#-glimmer-dsl-for-libui-0021)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -73,6 +73,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Editable Table](#editable-table)
     - [Editable Column Table](#editable-column-table)
     - [Basic Table Image](#basic-table-image)
+    - [Basic Table Image Text](#basic-table-image-text)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -160,7 +161,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.20'
+gem 'glimmer-dsl-libui', '~> 0.0.21'
 ```
 
 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.
@@ -233,6 +234,7 @@ Control(Args) | Properties | Listeners
 `image(width as Numeric, height as Numeric)` | None | None
 `image_part(pixels as String [encoded image rgba byte array], width as Numeric, height as Numeric, byte_stride as Numeric [usually width*4])` | None | None
 `image_column(name as String)` | None | None
+`image_text_column(name as String)` | None | None
 `label(text as String)` | `text` (`String`) | None
 `menu(text as String)` | None | None
 `menu_item(text as String)` | `checked` (Boolean) | `on_clicked`
@@ -248,7 +250,7 @@ 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)), `editable` as Boolean | None
+`table` | `cell_rows` (`Array` (rows) of `Arrays` (row columns) of cell values (e.g. `String` values for `text_column` cells or `Array` of `image`/`String` for `image_text_column`)), `editable` as Boolean | None
 `text_column(name as String)` | `editable` as Boolean | 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
@@ -2161,6 +2163,88 @@ window('The Red Turtle', 310, 350, false) {
 }.show
 ```
 
+### Basic Table Image Text
+
+This example has a prerequisite of installing `chunky_png` Ruby gem:
+
+```
+gem install chunky_png -v1.4.0
+```
+
+Also, note that behavior varies per platform (i.e. how `table` chooses to size images by default).
+
+[examples/basic_table_image_text.rb](examples/basic_table_image_text.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_image_text.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_image_text'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-basic-table-image-text.png](images/glimmer-dsl-libui-mac-basic-table-image-text.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-basic-table-image-text.png](images/glimmer-dsl-libui-linux-basic-table-image-text.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+# NOTE:
+# This example displays images that can be freely downloaded from the Studio Ghibli website.
+
+require 'glimmer-dsl-libui'
+require 'chunky_png'
+require 'open-uri'
+
+include Glimmer
+
+IMAGE_ROWS = []
+
+5.times do |i|
+  url = format('https://www.ghibli.jp/gallery/thumb-redturtle%03d.png', (i + 1))
+  puts "Processing Image: #{url}"
+  f = URI.open(url)
+  canvas = ChunkyPNG::Canvas.from_io(f)
+  f.close
+  data = canvas.to_rgba_stream
+  width = canvas.width
+  height = canvas.height
+  img = image(width, height) {
+    image_part(data, width, height, width * 4)
+  }
+  text = url.sub('https://www.ghibli.jp/gallery/thumb-redturtle', '').sub('.png', '')
+  IMAGE_ROWS << [[img, text], text, text, [img, text]]
+rescue StandardError => e
+  warn url, e.message
+end
+
+window('The Red Turtle', 900, 350) {
+  horizontal_box {
+    table {
+      image_text_column('image/number')
+      text_column('number')
+      text_column('number (editable)') {
+        editable true
+      }
+      image_text_column('image/number (editable)') {
+        editable true
+      }
+      
+      cell_rows IMAGE_ROWS
+    }
+  }
+}.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.20
+0.0.21

data/examples/basic_table_image_text.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# NOTE:
+# This example displays images that can be freely downloaded from the Studio Ghibli website.
+
+require 'glimmer-dsl-libui'
+require 'chunky_png'
+require 'open-uri'
+
+include Glimmer
+
+IMAGE_ROWS = []
+
+5.times do |i|
+  url = format('https://www.ghibli.jp/gallery/thumb-redturtle%03d.png', (i + 1))
+  puts "Processing Image: #{url}"
+  f = URI.open(url)
+  canvas = ChunkyPNG::Canvas.from_io(f)
+  f.close
+  data = canvas.to_rgba_stream
+  width = canvas.width
+  height = canvas.height
+  img = image(width, height) {
+    image_part(data, width, height, width * 4)
+  }
+  text = url.sub('https://www.ghibli.jp/gallery/thumb-redturtle', '').sub('.png', '')
+  IMAGE_ROWS << [[img, text], text, text, [img, text]]
+rescue StandardError => e
+  warn url, e.message
+end
+
+window('The Red Turtle', 900, 350) {
+  horizontal_box {
+    table {
+      image_text_column('image/number')
+      text_column('number')
+      text_column('number (editable)') {
+        editable true
+      }
+      image_text_column('image/number (editable)') {
+        editable true
+      }
+      
+      cell_rows IMAGE_ROWS
+    }
+  }
+}.show

data/lib/glimmer/libui/column.rb

@@ -25,9 +25,6 @@ module Glimmer
   module LibUI
     # Common logic for all column proxy objects
     module Column
-      attr_reader :appended
-      alias appended? appended
-    
       def initialize(keyword, parent, args, &block)
         @keyword = keyword
         @parent_proxy = parent
@@ -41,14 +38,15 @@ module Glimmer
         @args.first
       end
       
-      private
-      
-      def build_control
-        @appended = true
+      # column index used in table append column API call
+      # expanded to ensure DualColumn index accounts for two columns acting as one
+      def column_index
+        @column_index ||= @parent_proxy.send(:next_column_index)
       end
       
-      def next_column_index
-        @parent_proxy.columns.map(&:appended?).compact.count
+      # actual index within table columns (disregarding nil fillings that account for DualColumn instances)
+      def index
+        @parent_proxy.columns.compact.index(self)
       end
     end
   end

data/lib/glimmer/libui/dual_column.rb

@@ -0,0 +1,40 @@
+# 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
+    # A dual column is one that represents two values (e.g. image and text or checkbox and text)
+    # It is meant to be included in a column proxy class that already includes Column
+    module DualColumn
+      def second_column_index
+        column_index + 1
+      end
+      
+      def column_index
+        @column_index ||= @parent_proxy.send(:next_column_index).tap do
+          @parent_proxy.send(:next_column_index)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/libui/editable_column.rb

@@ -0,0 +1,45 @@
+# 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
+    module EditableColumn
+      def editable(value = nil)
+        if value.nil?
+          @editable
+        else
+          @editable = !!value
+        end
+      end
+      alias editable= editable
+      alias set_editable editable
+      alias editable? editable
+
+      private
+      
+      def editable_value
+        (@parent_proxy.editable? || editable?) ? -2 : -1
+      end
+    end
+  end
+end

data/lib/glimmer/libui/image_column_proxy.rb

@@ -33,8 +33,7 @@ module Glimmer
       private
       
       def build_control
-        @parent_proxy.append_image_column(name, next_column_index)
-        super
+        @parent_proxy.append_image_column(name, column_index)
       end
     end
   end

data/lib/glimmer/libui/image_text_column_proxy.rb

@@ -0,0 +1,42 @@
+# 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/libui/column'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI image text column objects
+    #
+    # Follows the Proxy Design Pattern
+    class ImageTextColumnProxy < ControlProxy
+      include Column
+      include DualColumn
+      include EditableColumn
+    
+      private
+      
+      def build_control
+        @parent_proxy.append_image_text_column(name, column_index, second_column_index, editable_value)
+      end
+    end
+  end
+end

data/lib/glimmer/libui/table_proxy.rb

@@ -50,6 +50,8 @@ module Glimmer
       
       def post_initialize_child(child)
         @columns << child
+        # add an extra complementary nil column if it is a dual column (i.e. ImageTextColumnProxy or CheckboxTextColumnProxy
+        @columns << nil if child.is_a?(DualColumn)
       end
       
       def destroy
@@ -61,13 +63,29 @@ module Glimmer
         if rows.nil?
           @cell_rows
         else
-          rows = rows.map {|row| row.map {|cell| cell.respond_to?(:libui) ? cell.libui : cell }}
+          rows = rows.map do |row|
+            row.map do |cell|
+              if cell.respond_to?(:libui)
+                cell.libui
+              elsif cell.is_a?(Array)
+                cell.map { |inner_cell| inner_cell.respond_to?(:libui) ? inner_cell.libui : inner_cell }
+              else
+                cell
+              end
+            end
+          end
           @cell_rows = rows
         end
       end
       alias cell_rows= cell_rows
       alias set_cell_rows cell_rows
       
+      def expanded_cell_rows
+        cell_rows.map do |row|
+          row.flatten(1)
+        end
+      end
+      
       def editable(value = nil)
         if value.nil?
           @editable
@@ -83,31 +101,43 @@ module Glimmer
       
       def build_control
         @model_handler = ::LibUI::FFI::TableModelHandler.malloc
-        @model_handler.NumColumns   = rbcallback(4) { @columns.count }
-        @model_handler.ColumnType   = rbcallback(4) do
-          # Note: this assumes all columns are the same type
-          # TODO support different values per different columns
-          case @columns.first
-          when TextColumnProxy
+        @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|
+          case @columns[column]
+          when TextColumnProxy, NilClass
             0
-          when ImageColumnProxy
+          when ImageColumnProxy, ImageTextColumnProxy
             1
+#           when CheckboxColumnProxy
+#             2
+#           when CheckboxTextColumnProxy
+#             2
+#           when ProgressBarColumnProxy
+#             2
+#           when ButtonColumnProxy
+#             0
           end
         end
         @model_handler.NumRows      = rbcallback(4) { cell_rows.count }
         @model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+          the_cell_rows = expanded_cell_rows
           case @columns[column]
-          when TextColumnProxy
-            ::LibUI.new_table_value_string((@cell_rows[row] && @cell_rows[row][column]).to_s)
-          when ImageColumnProxy
-            ::LibUI.new_table_value_image((@cell_rows[row] && @cell_rows[row][column]))
+          when TextColumnProxy, NilClass
+            ::LibUI.new_table_value_string((expanded_cell_rows[row] && expanded_cell_rows[row][column]).to_s)
+          when ImageColumnProxy, ImageTextColumnProxy
+            ::LibUI.new_table_value_image((expanded_cell_rows[row] && expanded_cell_rows[row][column]))
           end
         end
         @model_handler.SetCellValue = rbcallback(0, [1, 1, 4, 4, 1]) do |_, _, row, column, val|
           case @columns[column]
           when TextColumnProxy
+            column = @columns[column].index
             @cell_rows[row] ||= []
             @cell_rows[row][column] = ::LibUI.table_value_string(val).to_s
+          when NilClass
+            # TODO ensure this works for editable table
+            column = @columns[column - 1].index
+            @cell_rows[row][column][1] = ::LibUI.table_value_string(val).to_s
           end
         end
         
@@ -119,7 +149,7 @@ module Glimmer
         
         @libui = ControlProxy.new_control(@keyword, [@table_params])
         @libui.tap do
-          @columns.each {|column| column.send(:build_control) }
+          @columns.each {|column| column&.send(:build_control) }
         end
       end
       
@@ -133,6 +163,11 @@ module Glimmer
         blockcaller
       end
       
+      def next_column_index
+        @next_column_index ||= -1
+        @next_column_index += 1
+      end
+      
     end
   end
 end

data/lib/glimmer/libui/text_column_proxy.rb

@@ -29,23 +29,12 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class TextColumnProxy < ControlProxy
       include Column
-          
-      def editable(value = nil)
-        if value.nil?
-          @editable
-        else
-          @editable = !!value
-        end
-      end
-      alias editable= editable
-      alias set_editable editable
-      alias editable? editable
+      include EditableColumn
           
       private
       
       def build_control
-        @parent_proxy.append_text_column(name, next_column_index, @parent_proxy.editable? || editable? ? -2 : -1)
-        super
+        @parent_proxy.append_text_column(name, column_index, editable_value)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2021-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -198,6 +198,7 @@ files:
 - examples/basic_entry.rb
 - examples/basic_table.rb
 - examples/basic_table_image.rb
+- examples/basic_table_image_text.rb
 - examples/basic_window.rb
 - examples/basic_window2.rb
 - examples/color_button.rb
@@ -232,6 +233,8 @@ files:
 - lib/glimmer/libui/control_proxy.rb
 - lib/glimmer/libui/date_picker_proxy.rb
 - lib/glimmer/libui/date_time_picker_proxy.rb
+- lib/glimmer/libui/dual_column.rb
+- lib/glimmer/libui/editable_column.rb
 - lib/glimmer/libui/editable_combobox_proxy.rb
 - lib/glimmer/libui/font_button_proxy.rb
 - lib/glimmer/libui/form_proxy.rb
@@ -240,6 +243,7 @@ files:
 - lib/glimmer/libui/horizontal_box_proxy.rb
 - lib/glimmer/libui/image_column_proxy.rb
 - lib/glimmer/libui/image_part_proxy.rb
+- lib/glimmer/libui/image_text_column_proxy.rb
 - lib/glimmer/libui/label_proxy.rb
 - lib/glimmer/libui/menu_item_proxy.rb
 - lib/glimmer/libui/menu_proxy.rb