glimmer-dsl-libui 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709fb51692fedecbca6438b288711c2fb7f3a71cb5ce5f5f16e1a5c9629bc5fb
-  data.tar.gz: 2706858ead6f7bf47f042be22cc40b0546706de8c4c7cfbfdf7457aeb007fa3a
+  metadata.gz: 22947befdd94073071547600efd1434fe98babc87c1fb35a169c9133e7979653
+  data.tar.gz: c7733269d49a56c24c13c3df6df4efc680882f12e62926a9169f5114a412af0a
 SHA512:
-  metadata.gz: 8b501a86cf85fb6b1c488580b76336765cf1d2fbdf864edf16e3587bba80710a900a05186e0c9e3f67a667ab64fbaf3ebcf1ec54c4ebbfb8e41ddd7b77f93555
-  data.tar.gz: 5e1f94ad2479f71d54a163d69d6c266eac9f361909e3c305e04afc073c882178ac1dba80fbc9927a7037a93593000eb469e0c7a9e0342003ced8cf349ddfd6ae
+  metadata.gz: d0c881484a837ddc71738e8e91f75881da6de87773703d88172f6d2a13626382d7eaee749ba6ef09f175e90f937a91d248462268780783d34b1a6e65584097da
+  data.tar.gz: f484ecb4e1b16c21899b3263d18d736925752519e6271c611c8ac2ef4639884e8cc057661a7440824cc1df1dacb595226563b9a1343f2b25586358c0340c92cd

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.11
+
+- New examples/basic_color.rb
+- Support `color_button` `color` property
+- Proper destroy of controls (deleting from parent `box`, `window`, or `group` first)
+- On the Mac only, if no menu is specified, add a Quit menu item automatically to allow quitting with CMD+Q
+
 ## 0.0.10
 
 - Support examples/font_button.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.10
+# [<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.11
 ## 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.10](#-glimmer-dsl-for-libui-0010)
+- [Glimmer DSL for LibUI 0.0.11](#-glimmer-dsl-for-libui-0011)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -64,6 +64,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Midi Player](#midi-player)
     - [Control Gallery](#control-gallery)
     - [Font Button](#font-button)
+    - [Color Button](#color-button)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -151,7 +152,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.10'
+gem 'glimmer-dsl-libui', '~> 0.0.11'
 ```
 
 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.
@@ -210,12 +211,12 @@ Control(Args) | Properties | Listeners
 `button(text as String)` | `text` (`String`) | `on_clicked`
 `checkbox(text as String)` | `checked` (Boolean), `text` (`String`) | `on_toggled`
 `combobox` | `items` (`Array` of `String`), `selected` (`Integer`) | `on_selected`
-`color_button` | `color` (r `Numeric`, g `Numeric`, b `Numeric`, a `Numeric`) | `on_changed`
+`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` (`LibUI::FFI::TM`) | `on_changed`
 `date_time_picker` | `time` (`LibUI::FFI::TM`) | `on_changed`
 `editable_combobox` | `items` (`Array` of `String`), `text` (`String`) | `on_changed`
 `entry` | `read_only` (Boolean), `text` (`String`) | `on_changed`
-`font_button` | `font` [read-only] (`Hash` of keys: `:family`, `:size`, `:weight`, `:italic`, `:stretch`) | `on_changed`
+`font_button` | `font` [read-only] (`Hash` of keys: `:family`, `:size`, `:weight`, `:italic`, `:stretch`), `family` as `String`, `size` as `Float`, `weight` as `Integer`, `italic` as `Integer`, `stretch` as `Integer` | `on_changed`
 `group(text as String)` | `margined` (Boolean), `title` (`String`) | None
 `horizontal_box` | `padded` (Boolean) | None
 `horizontal_separator` | None | None
@@ -278,7 +279,11 @@ Control(Args) | Properties | Listeners
 - All boolean property readers return `true` or `false` in Ruby instead of the [libui](https://github.com/andlabs/libui) original `0` or `1` in C.
 - All boolean property writers accept `true`/`false` in addition to `1`/`0` in Ruby
 - All string property readers return a `String` object in Ruby instead of the [libui](https://github.com/andlabs/libui) Fiddle pointer object.
-- Automatically allocate font descriptors upon instantiating `font_button` controls and free font descriptors when destorying `font_button` controls
+- Automatically allocate font descriptors upon instantiating `font_button` controls and free them when destorying `font_button` controls
+- Automatically allocate color value pointers upon instantiating `color_button` controls and free them when destorying `color_button` controls
+- On the Mac, if no `menu` items were added, an automatic `quit_menu_item` is added to enable quitting with CTRL+Q
+- When destroying a control nested under a `horizontal_box` or `vertical_box`, it is automatically deleted from the box's children
+- When destroying a control nested under a `window` or `group`, it is automatically unset as their child to allow successful destruction
 
 ### Original API
 
@@ -287,7 +292,7 @@ check out the [libui C headers](https://github.com/andlabs/libui/blob/master/ui.
 
 ## Glimmer Style Guide
 
-- Control arguments are always wrapped inside parentheses
+- Control arguments are always wrapped by parentheses
 - Control blocks are always declared with curly braces to clearly visualize hierarchical view code and separate from logic code
 - Control property declarations always have arguments and never take a block
 - Control property arguments are never wrapped inside parentheses
@@ -308,7 +313,7 @@ Gotcha: On the Mac, when you close a window opened in `girb`, it remains open un
 
 ## Examples
 
-These examples include reimplementions of the examples in the [LibUI](https://github.com/kojix2/LibUI) project utilizing the [Glimmer GUI DSL](#glimmer-gui-dsl-concepts).
+These examples include reimplementions of the examples in the [LibUI](https://github.com/kojix2/LibUI) project utilizing the [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) as well as brand new examples.
 
 To browse all examples, simply launch the [Meta-Example](examples/meta_example.rb), which lists all examples and displays each example's code when selected.
 
@@ -334,7 +339,7 @@ Linux
 
 ![glimmer-dsl-libui-linux-meta-example.png](images/glimmer-dsl-libui-linux-meta-example.png)
 
-[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
 
 ```ruby
 require 'glimmer-dsl-libui'
@@ -480,7 +485,7 @@ ruby -r glimmer-dsl-libui -e "require 'examples/basic_button'"
 Mac
 
 ![glimmer-dsl-libui-mac-basic-button.png](images/glimmer-dsl-libui-mac-basic-button.png)
-![glimmer-dsl-libui-mac-basic-button-msg-box.png](images/glimmer-dsl-libui-basic-button-msg-box.png)
+![glimmer-dsl-libui-mac-basic-button-msg-box.png](images/glimmer-dsl-libui-mac-basic-button-msg-box.png)
 
 Linux
 
@@ -1422,7 +1427,51 @@ window('hello world', 300, 200) {
     puts 'Bye Bye'
   end
 }.show
+```
+
+### Color Button
+
+[examples/color_button.rb](examples/color_button.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/color_button.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/color_button'"
+```
+
+Mac
 
+![glimmer-dsl-libui-mac-color-button.png](images/glimmer-dsl-libui-mac-color-button.png)
+![glimmer-dsl-libui-mac-color-button-selection.png](images/glimmer-dsl-libui-mac-color-button-selection.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-color-button.png](images/glimmer-dsl-libui-linux-color-button.png)
+![glimmer-dsl-libui-linux-color-button-selection.png](images/glimmer-dsl-libui-linux-color-button-selection.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('color button', 230) {
+  color_button { |cb|
+    on_changed do
+      rgba = cb.color
+      p rgba
+    end
+  }
+}.show
 ```
 
 ## Contributing to glimmer-dsl-libui

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/examples/color_button.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('color button', 230) {
+  color_button { |cb|
+    on_changed do
+      rgba = cb.color
+      p rgba
+    end
+  }
+}.show

data/examples/meta_example.rb

@@ -21,10 +21,6 @@ class MetaExample
   end
   
   def launch
-    menu('File') {
-      quit_menu_item
-    }
-    
     window('Meta-Example', 700, 500) { |w|
       margined true
       

data/lib/glimmer/libui/box.rb

@@ -29,12 +29,22 @@ module Glimmer
       def post_initialize_child(child)
         child.stretchy = true if child.stretchy.nil?
         ::LibUI.box_append(@libui, child.libui, ControlProxy.boolean_to_integer(child.stretchy))
+        children << child
       end
       
       def libui_api_keyword
         'box'
       end
       
+      def children
+        @children ||= []
+      end
+      
+      def destroy_child(child)
+        ::LibUI.send("box_delete", @libui, children.index(child))
+        ControlProxy.all_control_proxies.delete(child)
+      end
+      
       private
       
       def build_control

data/lib/glimmer/libui/color_button_proxy.rb

@@ -0,0 +1,64 @@
+# 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 color button objects
+    #
+    # Follows the Proxy Design Pattern
+    class ColorButtonProxy < ControlProxy
+      def color
+        @red ||= Fiddle::Pointer.malloc(8) # double
+        @green ||= Fiddle::Pointer.malloc(8) # double
+        @blue ||= Fiddle::Pointer.malloc(8) # double
+        @alpha ||= Fiddle::Pointer.malloc(8) # double
+        ::LibUI.color_button_color(@libui, @red, @green, @blue, @alpha)
+        [@red[0, 8].unpack1('d') * 255.0, @green[0, 8].unpack1('d') * 255.0, @blue[0, 8].unpack1('d') * 255.0, @alpha[0, 8].unpack1('d')]
+      end
+      
+      def red
+        color[0]
+      end
+      
+      def green
+        color[1]
+      end
+      
+      def blue
+        color[2]
+      end
+      
+      def alpha
+        color[3]
+      end
+      
+      def destroy
+        Fiddle.free @red unless @red.nil?
+        Fiddle.free @green unless @green.nil?
+        Fiddle.free @blue unless @blue.nil?
+        Fiddle.free @alpha unless @alpha.nil?
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy.rb

@@ -52,7 +52,7 @@ module Glimmer
         end
         
         def main_window_proxy
-          all_control_proxies.find {|c| c.is_a?(WindowProxy)}
+          all_control_proxies.find {|c| c.is_a?(Glimmer::LibUI::WindowProxy)}
         end
         
         def integer_to_boolean(int)
@@ -62,6 +62,10 @@ module Glimmer
         def boolean_to_integer(bool)
           bool.nil? ? nil : (bool ? 1 : 0)
         end
+        
+        def menu_proxies
+          all_control_proxies.select {|c| c.keyword == 'menu' }
+        end
       end
       
       BOOLEAN_PROPERTIES = %w[
@@ -167,7 +171,7 @@ module Glimmer
           ::LibUI.send("#{libui_api_keyword}_#{method_name}", @libui, *args)
         elsif ::LibUI.respond_to?("control_#{method_name.to_s.sub(/\?$/, '')}") && args.empty?
           property = method_name.to_s.sub(/\?$/, '')
-          value = ::LibUI.send("control_#{method_name.to_s.sub(/\?$/, '')}", @libui, *args)
+          value = ::LibUI.send("control_#{property}", @libui, *args)
           handle_string_property(property, handle_boolean_property(property, value))
         elsif ::LibUI.respond_to?("control_set_#{method_name.to_s.sub(/=$/, '')}")
           property = method_name.to_s.sub(/=$/, '')
@@ -198,6 +202,23 @@ module Glimmer
         @keyword
       end
       
+      def destroy
+        if parent_proxy.nil?
+          default_destroy
+        else
+          parent_proxy.destroy_child(self)
+        end
+      end
+      
+      def destroy_child(child)
+        child.default_destroy
+      end
+      
+      def default_destroy
+        send_to_libui('destroy')
+        ControlProxy.all_control_proxies.delete(self)
+      end
+            
       def enabled(value = nil)
         if value.nil?
           @enabled
@@ -229,11 +250,6 @@ module Glimmer
       alias set_visible visible
       alias visible= visible
       
-      def destroy
-        send_to_libui('destroy')
-        self.class.all_control_proxies.delete(self)
-      end
-            
       private
       
       def build_control

data/lib/glimmer/libui/font_button_proxy.rb

@@ -39,6 +39,26 @@ module Glimmer
         }
       end
       
+      def family
+        font[:family]
+      end
+      
+      def size
+        font[:size]
+      end
+      
+      def weight
+        font[:weight]
+      end
+      
+      def italic
+        font[:italic]
+      end
+      
+      def stretch
+        font[:stretch]
+      end
+      
       def destroy
         ::LibUI.free_font_button_font(@font_descriptor) unless @font_descriptor.nil?
         super

data/lib/glimmer/libui/group_proxy.rb

@@ -31,6 +31,11 @@ module Glimmer
         ::LibUI.group_set_child(@libui, child.libui)
       end
       
+      def destroy_child(child)
+        ::LibUI.send("group_set_child", @libui, nil)
+        super
+      end
+    
       private
       
       def build_control

data/lib/glimmer/libui/window_proxy.rb

@@ -35,9 +35,14 @@ module Glimmer
       def post_initialize_child(child)
         ::LibUI.window_set_child(@libui, child.libui)
       end
+      
+      def destroy_child(child)
+        ::LibUI.send("window_set_child", @libui, nil)
+        super
+      end
     
       def show
-        send_to_libui('show')
+        super
         unless @shown_at_least_once
           @shown_at_least_once = true
           ::LibUI.main
@@ -64,6 +69,10 @@ module Glimmer
       private
       
       def build_control
+        if OS.mac? && ControlProxy.menu_proxies.empty?
+          menu_proxy = ControlProxy.create('menu', nil, [''])
+          quit_menu_item_proxy = ControlProxy.create('quit_menu_item', menu_proxy, [])
+        end
         construction_args = @args.dup
         construction_args[0] = DEFAULT_TITLE if construction_args.size == 0
         construction_args[1] = DEFAULT_WIDTH if construction_args.size == 1

data/lib/glimmer-dsl-libui.rb

@@ -26,6 +26,7 @@ require 'glimmer'
 # require 'logging'
 # require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 # require 'super_module'
+require 'os'
 require 'libui'
 
 # Internal requires

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: libui
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +184,7 @@ files:
 - examples/basic_entry.rb
 - examples/basic_window.rb
 - examples/basic_window2.rb
+- examples/color_button.rb
 - examples/control_gallery.rb
 - examples/font_button.rb
 - examples/meta_example.rb
@@ -182,6 +203,7 @@ files:
 - lib/glimmer/libui/about_menu_item_proxy.rb
 - lib/glimmer/libui/box.rb
 - lib/glimmer/libui/check_menu_item_proxy.rb
+- lib/glimmer/libui/color_button_proxy.rb
 - lib/glimmer/libui/combobox_proxy.rb
 - lib/glimmer/libui/control_proxy.rb
 - lib/glimmer/libui/date_picker_proxy.rb