glimmer-dsl-libui 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b691a0eeec6e7d571ac6815c272e0dd5ae48c0f0302fc11876ae373cb92cba1e
-  data.tar.gz: 576d6840f47182d0dc0bd3ccccdb301b5a9efb2f7b7038efa3e5fa8d8ea30537
+  metadata.gz: c673025a7a4676538178064f6fb3db7c98eb35f2c2b8c0bf7eb75627d4810309
+  data.tar.gz: b3c7a7c67edc0566e542cbdad854a5340cba70c61ac36611a5279095b7710248
 SHA512:
-  metadata.gz: d00b9ecc527e56e144d1baead2910e62a29f9f429af9fc57a1da05a4d590d9286f47c2fe8d840062c1a989f42183f9dfc717a0800db2ec6467acc434201d3707
-  data.tar.gz: 53dbe182b9b9607111915412af9d418571511af560dc5af83d792214139c62f91358aa5555147d962a040802852d74f581413b99d287827454ea2ca865ec110b
+  metadata.gz: 49254ae087358b968b0479dd4ccc1909e03e532e8ad3671432dedd96079d7487f9fb7bdfd3f3f20edd53475389e0553b4676f7fceacd04b130444914254afcd9
+  data.tar.gz: f40187fed7f069bf214c16b287b87848e9815a79c72ddb78dd47f9df567d40ceef432dc800ba74ee7247d6f1a0a32e81b65d863e860f2ccec7ea6c20d11a97eb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.2.6
+
+- Support `string` control property: `open_type_features`
+- Auto-free attributed string objects from memory
+
 ## 0.2.5
 
 - Support attributed `string` `underline_color` property (built-in enum symbols and custom color)
@@ -8,9 +13,9 @@
 
 - Support examples/custom_draw_text.rb
 - Support stable `text` control nestable under `area`
-- Support `string` control property `background`
-- Support `string` control property `font`
-- Support `string` control property `underline`
+- Support `string` control property: `background`
+- Support `string` control property: `font`
+- Support `string` control property: `underline`
 - Enhance `combobox` to accept `String` value for `selected` item instead of just `Integer` index
 - Add `selected_item` read-only property to `combobox` to return selected item `String` value
 - Fix `color` property support for `string` to accept 255-based rgb values
@@ -23,7 +28,7 @@
 - Support dynamic `text` control to be called in `area` `on_draw` listener
 - Support `text` control `default_font` property
 - Support `string` control nestable under `text` to represent an attributed/unattributed string (depending on nestable properties)
-- Support `string` control property `color`
+- Support `string` control property: `color`
 - Support enum symbols for `align` property of `text` control
 - Support enum symbols for `:italic` font descriptor key (in addition to numbers)
 - Support enum symbols for `:stretch` font descriptor key (in addition to numbers)

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.2.5
+# [<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.2.6
 ## 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)
@@ -197,7 +197,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.2.5](#-glimmer-dsl-for-libui-025)
+- [Glimmer DSL for LibUI 0.2.6](#-glimmer-dsl-for-libui-026)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
@@ -333,7 +333,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.2.5'
+gem 'glimmer-dsl-libui', '~> 0.2.6'
 ```
 
 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.
@@ -790,6 +790,50 @@ Check [Basic Transform](#basic-transform) example for use of [X11](https://en.wi
 
 Check [Histogram](#histogram) example for use of hex colors.
 
+To draw `text` in an `area`, you simply nest a `text(x, y, width)` control directly under `area` or inside a `on_draw` listener, and then nest attributed `string {string_value}` controls underneath it returning an actual `String` (think of them as the `<span>` element in html, which contains a string of text).
+
+`text` control can have the following properties:
+- `default_font`:
+- `align`: `:left` (default), `:center`, or `:right` (`align` currently seems not to work on the Mac)
+
+`string` can have the following properties:
+- `font`: font descriptor hash consisting of `:family`, `:size`, `:weight` (`[:minimum, :thin, :ultra_light, :light, :book, :normal, :medium, :semi_bold, :bold, :ultra_bold, :heavy, :ultra_heavy, :maximum]`), `:italic` (`[:normal, :oblique, :italic]`), and `:stretch` (`[:ultra_condensed, :extra_condensed, :condensed, :semi_condensed, :normal, :semi_expanded, :expanded, :extra_expanded, :ultra_expanded]`) key values
+- `color`: rgba, hex, or x11 color
+- `background`: rgba, hex, or x11 color
+- `underline`: one of `:none`, `:single`, `:double`, `:suggestion`, `:color_custom`, `:color_spelling`, `:color_grammar`, `:color_auxiliary`
+- `underline_color`: one of `:spelling`, `:grammar`, `:auxiliary`, rgba, hex, or x11 color
+- `open_type_features`: it must have a block containing `open_type_tag` occurrances, which take the a, b, c, d arguments plus a number at the end.
+
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
+
+```ruby
+window('area text drawing') {
+  area {
+    text {
+      default_font family: 'Helvetica', size: 12, weight: :normal, italic: :normal, stretch: :normal
+        
+      string {
+        font family: 'Georgia', size: 13, weight: :medium, italic: :normal, stretch: :normal
+        color r: 230, g: 100, b: 50, a: 0.5
+        background r: 230, g: 200, b: 250, a: 0.8
+        underline :single
+        underline_color :spelling
+        open_type_features {
+          open_type_tag 'l', 'i', 'g', 'a', 0
+          open_type_tag 'l', 'i', 'g', 'a', 1
+        }
+        
+        "This is a test\n\n"
+      }
+      
+      string {
+        'This is another test'
+      }
+    }
+  }
+}.show
+```
+
 ### 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

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/examples/custom_draw_text.rb

@@ -71,7 +71,7 @@ class CustomDrawText
         area {
           text { # default arguments for x, y, and width are (0, 0, area_draw_params[:area_width])
             # align :left # default alignment
-              
+            
             @string = string {
               '  At last Ygramul sensed that something was coming toward ' \
               'her. With the speed of lightning, she turned about, confronting ' \

data/examples/custom_draw_text2.rb

@@ -79,7 +79,7 @@ class CustomDrawText
             text { # default arguments for x, y, and width are (0, 0, area_draw_params[:area_width])
               # align :left # default alignment
                 
-              @string = string {
+              string {
                 font @font
                 color @color
                 background @background

data/lib/glimmer/libui/attributed_string.rb

@@ -94,12 +94,27 @@ module Glimmer
       alias underline_color= underline_color
       alias set_underline_color underline_color
       
+      def open_type_features(value = nil)
+        if value.nil?
+          @open_type_features
+        else
+          @open_type_features = value
+          redraw
+        end
+      end
+      alias open_type_features= open_type_features
+      alias set_open_type_features open_type_features
+      
       def post_add_content
         block_result = block&.call
         @string = block_result if block_result.is_a?(String)
         @parent_proxy&.post_initialize_child(self)
       end
       
+      def post_initialize_child(child)
+        self.open_type_features = child if child.is_a?(Glimmer::LibUI::ControlProxy::OpenTypeFeaturesProxy)
+      end
+      
       def draw(area_draw_params)
         @start = ::LibUI.attributed_string_len(@parent_proxy.attributed_string)
         ::LibUI.attributed_string_append_unattributed(@parent_proxy.attributed_string, @string)
@@ -137,10 +152,15 @@ module Glimmer
           stretch_attribute = ::LibUI.new_stretch_attribute(Glimmer::LibUI.enum_symbol_to_value(:text_stretch, font[:stretch]))
           ::LibUI.attributed_string_set_attribute(@parent_proxy.attributed_string, stretch_attribute, @start, @start + @string.size)
         end
+        unless open_type_features.nil?
+          open_type_features_attribute = ::LibUI.new_features_attribute(open_type_features.libui)
+          ::LibUI.attributed_string_set_attribute(@parent_proxy.attributed_string, open_type_features_attribute, @start, @start + @string.size)
+        end
         destroy if area_proxy.nil?
       end
       
       def destroy
+        open_type_features.destroy unless open_type_features.nil?
         @parent_proxy&.children&.delete(self)
       end
       

data/lib/glimmer/libui/control_proxy/open_type_features_proxy.rb

@@ -0,0 +1,53 @@
+# 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/control_proxy/area_proxy'
+require 'glimmer/libui/parent'
+
+module Glimmer
+  module LibUI
+    class ControlProxy
+      # Proxy for LibUI open type features objects
+      #
+      # Follows the Proxy Design Pattern
+      class OpenTypeFeaturesProxy < ControlProxy
+        include Parent
+      
+        def destroy
+          ::LibUI.free_open_type_features(@libui)
+          @parent_proxy&.children&.delete(self)
+          ControlProxy.control_proxies.delete(self)
+        end
+        
+        def redraw
+          @parent_proxy.redraw
+        end
+        
+        private
+        
+        def build_control
+          @libui = ::LibUI.new_open_type_features
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy/open_type_tag_proxy.rb

@@ -0,0 +1,59 @@
+# 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/control_proxy/area_proxy'
+require 'glimmer/libui/parent'
+
+module Glimmer
+  module LibUI
+    class ControlProxy
+      # Proxy for LibUI open type tag objects
+      #
+      # Follows the Proxy Design Pattern
+      class OpenTypeTagProxy < ControlProxy
+        def destroy
+          @parent_proxy&.children&.delete(self)
+          ControlProxy.control_proxies.delete(self)
+        end
+        
+        def redraw
+          @parent_proxy.redraw
+        end
+        
+        private
+        
+        def build_control
+          tag_args = @args.dup
+          tag_args[0] = ordinalize(tag_args[0])
+          tag_args[1] = ordinalize(tag_args[1])
+          tag_args[2] = ordinalize(tag_args[2])
+          tag_args[3] = ordinalize(tag_args[3])
+          ::LibUI.open_type_features_add(@parent_proxy.libui, *tag_args)
+        end
+        
+        def ordinalize(arg)
+          arg.is_a?(String) ? arg.ord : arg
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy/text_proxy.rb

@@ -56,6 +56,7 @@ module Glimmer
           build_control
           ::LibUI.draw_text(area_draw_params[:context], @libui, x, y)
           ::LibUI.draw_free_text_layout(@libui)
+          ::LibUI.free_attributed_string(@attributed_string)
         end
         
         def destroy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -312,6 +312,8 @@ files:
 - lib/glimmer/libui/control_proxy/message_box/msg_box_proxy.rb
 - lib/glimmer/libui/control_proxy/multiline_entry_proxy.rb
 - lib/glimmer/libui/control_proxy/multiline_entry_proxy/non_wrapping_multiline_entry_proxy.rb
+- lib/glimmer/libui/control_proxy/open_type_features_proxy.rb
+- lib/glimmer/libui/control_proxy/open_type_tag_proxy.rb
 - lib/glimmer/libui/control_proxy/path_proxy.rb
 - lib/glimmer/libui/control_proxy/radio_buttons_proxy.rb
 - lib/glimmer/libui/control_proxy/tab_item_proxy.rb