RubyGems - libui - Versions diffs - 0.1.2 → 0.2.3 - Mend

libui 0.1.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45dcad9aff4fe01e0de0272c31622aa5fdee0cc65dfa9c53e1d5b05c6883e606
-  data.tar.gz: 744076e807fa31ce975b402506c63bb6cf1c84b28269540c25e1e2f56f2305ad
+  metadata.gz: 7e6ba214bc5ec73625a54c9ac037bd58d1123ef4d35f6578653a79b157c44758
+  data.tar.gz: a295c5651bf4f60277e1220c49780bb9746a072ccdc8faba573b4a1e61f69933
 SHA512:
-  metadata.gz: bdaee2f137c0c2eb69b38afbfb1ba1ef71cc22336ce72ee51c5686dd9a5cd4f17fa46e7f3961d5d4b3e37a983912ea1283e2a139e0b691ad4b56ec6a3cf972ca
-  data.tar.gz: 22a2d0cf2706d151ad8a63daeee94edb01d84458f17f955f0d750514067cf8bfaaa773f53ea2d1b0fa664abd8c97f3316e609e46a5c80852c8a1f545d3e7d1ba
+  metadata.gz: b8f8b8c1d5506c91ff6703f58bbfbdf129cb92e9fc6c0ff992d5faa1bc78f4a2fcf6beefc467669872f26f6d346cd2f42343882dfeeeeef6e3a92f7cc47d2fe3
+  data.tar.gz: e18b72547d935cd81ec709a319d87066fef77c88f0f0c8b3269c0ad44b617b8e3c888f16c8713558c98172363b8a09e94b62bf38a68a8673c890df4f3d32ea77

data/LICENSE.txt CHANGED Viewed

@@ -1,6 +1,6 @@
 The MIT License (MIT)
-Copyright (c) 2020 kojix2
+Copyright (c) 2020-present kojix2
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md CHANGED Viewed

@@ -1,34 +1,34 @@
 # LibUI
-![build](https://github.com/kojix2/libui/workflows/build/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/libui.svg)](https://badge.fury.io/rb/libui)
+[![test](https://github.com/kojix2/LibUI/actions/workflows/test.yml/badge.svg)](https://github.com/kojix2/LibUI/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/badge/dynamic/json?label=gem%20version&query=%24%5B0%5D.number&url=https%3A%2F%2Frubygems.org%2Fapi%2Fv1%2Fversions%2Flibui.json&color=brightgreen)](https://rubygems.org/gems/libui/versions)
+[![Lines of Code](https://img.shields.io/endpoint?url=https%3A%2F%2Ftokei.kojix2.net%2Fbadge%2Fgithub%2Fkojix2%2FLibUI%2Flines)](https://tokei.kojix2.net/github/kojix2/LibUI)
 <a href="https://github.com/AndyObtiva/glimmer-dsl-libui"><img alt="glimmer-dsl-libui" src="https://github.com/AndyObtiva/glimmer/blob/master/images/glimmer-logo-hi-res.svg" width="50" height="50" align="right"></a>
-LibUI is a Ruby wrapper for libui and libui-ng.
+LibUI is a Ruby wrapper for libui family.
-:rocket: [libui-ng](https://github.com/libui-ng/libui-ng) - A cross-platform portable GUI library
-:radio_button: [libui](https://github.com/andlabs/libui) - Original version by andlabs
+:rocket: [libui-ng](https://github.com/kojix2/libui-ng) - A cross-platform portable GUI library
 ## Installation
 ```sh
-gem install libui
+gem install libui # --pre
 ```
-* The gem package contains the [official release](https://github.com/andlabs/libui/releases/tag/alpha4.1) of the libui shared library versions 4.1 for Windows, Mac, and Linux.
-  * Namely `libui.dll`, `libui.dylib`, and `libui.so` (only 1.8MB in total).
-* No dependency
-  * The libui gem uses the standard Ruby library [Fiddle](https://github.com/ruby/fiddle) to call C functions.
+- The gem package includes the libui-ng shared library for Windows, Mac, and Linux.
+  - Namely `libui.x64.dll`/`libui.x86.dll`, `libui.x86_64.dylib`/`libui.arm64.dylib`, or `libui.x86_64.so`/`libui.aarch64.so`.
+- No dependencies required.
+  - The libui gem uses the standard Ruby library [Fiddle](https://github.com/ruby/fiddle) to call C functions.
+| Windows                                                                                                          | Mac                                                                                                              | Linux                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| <img src="https://user-images.githubusercontent.com/5798442/103118046-900ea780-46b0-11eb-81fc-32626762e4df.png"> | <img src="https://user-images.githubusercontent.com/5798442/103118059-99980f80-46b0-11eb-9d12-324ec4d297c9.png"> | <img src="https://user-images.githubusercontent.com/5798442/103118068-a0bf1d80-46b0-11eb-8c5c-3bdcc3dcfb26.png"> |
-| Windows | Mac | Linux |
-|---------|-----|-------|
-|<img src="https://user-images.githubusercontent.com/5798442/103118046-900ea780-46b0-11eb-81fc-32626762e4df.png">|<img src="https://user-images.githubusercontent.com/5798442/103118059-99980f80-46b0-11eb-9d12-324ec4d297c9.png">|<img src="https://user-images.githubusercontent.com/5798442/103118068-a0bf1d80-46b0-11eb-8c5c-3bdcc3dcfb26.png">|
+Notes:
-Note:
-* If you are using the 32-bit (x86) version of Ruby, you need to download the 32-bit (x86) native dll. See [Development](#development).
-* On Windows, libui may not work due to missing DLLs. In that case, you need to install [Visual C++ Redistributable](https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist). See ([#48](https://github.com/kojix2/LibUI/issues/48))
-* [Raspberry Pi](https://www.raspberrypi.com/) and other platform users will need to compile C libui. See [Development](#development).
+- If you are using the 32-bit (x86) version of Ruby, you need to download the 32-bit (x86) native dll. See the [Development](#development) section.
+- On Windows, libui may not work due to missing DLLs. In that case, you need to install [Visual C++ Redistributable](https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist). See ([#48](https://github.com/kojix2/LibUI/issues/48))
+- Users with [Raspberry Pi](https://www.raspberrypi.com/) or other platforms will need to compile the C libui library. See the [Development](#development) section.
 ## Usage
@@ -49,9 +49,8 @@ end
 UI.window_on_closing(main_window) do
   puts 'Bye Bye'
-  UI.control_destroy(main_window)
   UI.quit
-  0
+  1
 end
 UI.window_set_child(main_window, button)
@@ -61,30 +60,29 @@ UI.main
 UI.quit
 ```
-See [examples](https://github.com/kojix2/libui/tree/main/examples) directory.
+For more examples, see the [examples](https://github.com/kojix2/libui/tree/main/examples) directory.
 ### General Rules
-Compared to original libui written in C,
+Compared to the original libui library written in C:
-* The method names are snake_case.
-* If the last argument is nil, it can be omitted.
-* You can pass a block as a callback.
-  * The block will be converted to a Proc object and added to the last argument.
-  * Even in that case, it is possible to omit the last argument when nil.
+- Method names use snake_case.
+- The last argument can be omitted if it's nil.
+- A block can be passed as a callback.
+  - The block will be converted to a Proc object and added as the last argument.
+  - The last argument can still be omitted when nil.
-You can use [the documentation for libui's Go bindings](https://pkg.go.dev/github.com/andlabs/ui) as a reference.
+You can use [the libui-ng API documentation](https://libui-ng.github.io/libui-ng/) as a reference.
 ### DSLs for LibUI
-LibUI is intentionally not object-oriented because it is a thin Ruby wrapper (binding) for the procedural C libui library, so it mirrors its API structure.
+LibUI is not object-oriented because it is a thin Ruby wrapper (binding) for the procedural C libui library, mirroring its API structure.
-It is recommended that you build actual applications using a DSL for LibUI because DSLs enable writing object-oriented code the Ruby way (instead of procedural code the C way):
+To build actual applications, it is recommended to use a DSL for LibUI, as they enable writing object-oriented code the Ruby way (instead of procedural code the C way):
-* [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
-* [libui_paradise](https://rubygems.org/gems/libui_paradise)
+- [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
-### How to use fiddle pointers?
+### Working with fiddle pointers
 ```ruby
 require 'libui'
@@ -92,54 +90,71 @@ UI = LibUI
 UI.init
 ```
-Convert a pointer to a string.
+Text getter methods such as `label_text`, `entry_text`, and `window_title`
+return `Fiddle::Pointer` objects for strings allocated by libui. Convert the
+pointer to a Ruby string, then release it with `free_text`.
 ```ruby
 label = UI.new_label("Ruby")
-p pointer = UI.label_text(label) # #<Fiddle::Pointer>
-p pointer.to_s # Ruby
+pointer = UI.label_text(label) # #<Fiddle::Pointer>
+text = pointer.to_s
+UI.free_text(pointer)
+p text # Ruby
+```
+Use `ensure` if the code between conversion and cleanup can raise:
+```ruby
+def ui_text(text_pointer)
+  text_pointer.to_s
+ensure
+  UI.free_text(text_pointer) if text_pointer && !text_pointer.null?
+end
 ```
-If you need to use C structs, you can do the following.
+If you need to use C structs, you can do the following:
 ```ruby
 font_button = UI.new_font_button
-# Allocate memory
+# Allocate memory
 font_descriptor = UI::FFI::FontDescriptor.malloc
 font_descriptor.to_ptr.free = Fiddle::RUBY_FREE
 # font_descriptor = UI::FFI::FontDescriptor.malloc(Fiddle::RUBY_FREE) # fiddle 1.0.1 or higher
 UI.font_button_on_changed(font_button) do
   UI.font_button_font(font_button, font_descriptor)
-  p family:  font_descriptor.Family.to_s,
-    size:    font_descriptor.Size,
-    weight:  font_descriptor.Weight,
-    italic:  font_descriptor.Italic,
-    stretch: font_descriptor.Stretch
+  begin
+    p family:  font_descriptor.Family.to_s,
+      size:    font_descriptor.Size,
+      weight:  font_descriptor.Weight,
+      italic:  font_descriptor.Italic,
+      stretch: font_descriptor.Stretch
+  ensure
+    UI.free_font_button_font(font_descriptor)
+  end
 end
 ```
-* Callbacks
-  * In Ruby/Fiddle, a C callback function is written as an object of
-    `Fiddle::Closure::BlockCaller` or `Fiddle::Closure`.
-    In this case, you need to be careful about Ruby's garbage collection.
-    If the function object is collected, memory will be freed
-    and a segmentation violation will occur when the callback is invoked.
+- Callbacks
+  - In Ruby/Fiddle, a C callback function is written as an object of
+    `Fiddle::Closure::BlockCaller` or `Fiddle::Closure`.
+    Be careful about Ruby's garbage collection - if the function object is collected, memory will be freed resulting in a segmentation violation when the callback is invoked.
 ```ruby
-# to a local variable to prevent it from being collected by GC.
+# Assign to a local variable to prevent it from being collected by GC.
 handler.MouseEvent   = (c1 = Fiddle::Closure::BlockCaller.new(0, [0]) {})
 handler.MouseCrossed = (c2 = Fiddle::Closure::BlockCaller.new(0, [0]) {})
 handler.DragBroken   = (c3 = Fiddle::Closure::BlockCaller.new(0, [0]) {})
 ```
-### How to create an executable (.exe) on Windows
+### Creating a Windows executable (.exe) with OCRA
+OCRA (One-Click Ruby Application) builds Windows executables from Ruby source code.
-OCRA (One-Click Ruby Application) builds Windows executables from Ruby source code.
-* https://github.com/larsch/ocra/
+- https://github.com/larsch/ocra/
-In order to build a exe with Ocra, include 3 DLLs from ruby_builtin_dlls folder:
+To build an exe with Ocra, include 3 DLLs from the ruby_builtin_dlls folder:
 ```sh
 ocra examples/control_gallery.rb        ^
@@ -149,7 +164,7 @@ ocra examples/control_gallery.rb        ^
   --gem-all=fiddle                      ^
 ```
-Add additional options below if necessary.
+Add additional options below if necessary:
 ```sh
   --window                              ^
@@ -162,59 +177,108 @@ Add additional options below if necessary.
 ## Development
-LibUI is not object-oriented, but it provides high portability with a minimal implementation.
 ```sh
 git clone https://github.com/kojix2/libui
 cd libui
 bundle install
-bundle exec rake vendor:default # download shared libraries for all platforms
+bundle exec rake vendor:auto
 bundle exec rake test
 ```
-You can use the following rake tasks to download the shared library required for your platform.
+JRuby on macOS needs Java and AppKit must start on the first thread:
-`rake -T`
+```sh
+export JAVA_HOME=/path/to/openjdk
+export JRUBY_OPTS=-J-XstartOnFirstThread
+jruby -Ilib examples/basic_button.rb
+jruby -S rake test
+```
+Take note that, as the above code shows, LibUI works via jruby as well, so you have an additional
+GUI library (aside from jruby-swing by default) to test simple User Interfaces too.
+### Pre-built shared libraries for libui-ng
+Download pre-built libui-ng shared libraries (per your current platform):
+```sh
+bundle exec rake vendor:auto
 ```
-rake vendor:kojix2:auto           # Download kojix2 pre-build for your platform to vendor directory
-rake vendor:kojix2:mac            # Download kojix2 pre-build for Mac to vendor directory
-rake vendor:kojix2:ubuntu_x64     # Download kojix2 pre-build for Ubuntu to vendor directory
-rake vendor:kojix2:windows_x64    # Download kojix2 pre-build for Windows to vendor directory
-rake vendor:kojix2:windows_x86    # Download kojix2 pre-build for Windows to vendor directory
-rake vendor:libui-ng:build[hash]  # Build libui-ng latest master [commit hash]
-rake vendor:libui-ng:mac          # Download latest dev build for Mac to vendor directory
-rake vendor:libui-ng:ubuntu_x64   # Download latest dev build for Ubuntu to vendor directory
+Clean downloaded vendor files (keeps `vendor/{LICENSE,README}.md`):
+```sh
+bundle exec rake vendor:clean
 ```
-For example, If you are using a 32-bit (x86) version of Ruby on Windows, type `vendor:kojix2:windows_x86`.
+### Using your own libui build
+If you build libui-ng yourself, set `LIBUIDIR` to the directory containing the compiled `.so/.dylib/.dll` so LibUI can load it. You may also replace files under `vendor/` with your build if preferred. See [#46](https://github.com/kojix2/LibUI/issues/46#issuecomment-1041575792).
-### Use C libui compiled from source code
+### Publishing gems
-You can compile C libui from source code on your platform and tell ruby LibUI where to find the shared libraries. Set environment variable `LIBUIDIR` to specify the path to the shared library. (See [#46](https://github.com/kojix2/LibUI/issues/46#issuecomment-1041575792)). This is especially useful on platforms where the LibUI gem does not provide shared library, such as the ARM architecture (used in devices like Raspberry Pi).
+#### Automated Publishing
-Another simple approach is to replace the shared libraries in the gem vendor directory with the ones you have compiled.
+Push a version tag to automatically publish platform-specific gems:
+```sh
+git tag v0.2.0
+git push origin v0.2.0
+```
+Requires `RUBYGEMS_API_KEY` repository secret with scoped API key.
+#### Manual Publishing
+```sh
+ls vendor             # check the vendor directory
+rm -rf pkg            # remove previously built gems
+rake build_platform   # build gems
+# Check the contents of the gem
+find pkg -name *.gem -exec sh -c "echo; echo \# {}; tar -O -f {} -x data.tar.gz | tar zt" \;
+rake release_platform # publish gems
+```
+Windows Ruby (x64-mingw32 or x64-mingw-ucrt)
+```sh
+gem install rake rubyzip
+GEM_PLATFORM=x64-mingw32 rake vendor:clean
+GEM_PLATFORM=x64-mingw32 rake vendor:auto
+GEM_PLATFORM=x64-mingw32 gem build libui.gemspec
+gem push libui-0.2.0-x64-mingw32.gem
+```
 ### libui or libui-ng
-* From version 0.1.X, we plan to support only libui-ng/libui-ng.
-* Version 0.0.X only supports andlabs/libui.
+- From version 0.1.X, LibUI supports only libui-ng.
+- Version 0.0.X only supports andlabs/libui.
 ## Contributing
-Would you like to add your commits to libui?
-* Please feel free to send us your [pull requests](https://github.com/kojix2/libui/pulls).
-  * Small corrections, such as typo fixes, are appreciated.
-* Did you find any bugs? Enter in the [issues](https://github.com/kojix2/LibUI/issues) section!
+Would you like to contribute to LibUI?
+- Please feel free to send us your [pull requests](https://github.com/kojix2/libui/pulls).
+  - Small corrections, such as typo fixes, are appreciated.
+- Did you find any bugs? Submit them in the [issues](https://github.com/kojix2/LibUI/issues) section!
+Do you need commit rights?
+- If you need commit rights to my repository or want to get admin rights and take over the project, please feel free to contact @kojix2.
+- Many OSS projects become abandoned because only the founder has commit rights to the original repository.
+Support libui-ng development
-I have seen many OSS projects abandoned. The main reason is that no one has the right to commit to the original repository, except the founder.
-Do you need commit rights to my repository? Do you want to get admin rights and take over the project? If so, please feel free to contact me @kojix2.
+- Contributing to the development of libui-ng is a contribution to the entire libui community, including Ruby's LibUI.
+- For example, it would be easier to release LibUI in Ruby if libui-ng could be built easily and official shared libraries could be distributed.
-## Acknowledgement
+## Acknowledgements
 This project is inspired by libui-ruby.
-* https://github.com/jamescook/libui-ruby
+- https://github.com/jamescook/libui-ruby
 While libui-ruby uses [Ruby-FFI](https://github.com/ffi/ffi), this gem uses [Fiddle](https://github.com/ruby/fiddle).

data/lib/libui/error.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module LibUI
+  # base error class
+  class Error < StandardError; end
+  # LibUI shared library not found error
+  class LibraryNotFoundError < Error; end
+  # LibUI shared library load error
+  class LibraryLoadError < Error; end
+end

data/lib/libui/ffi.rb CHANGED Viewed

@@ -1,15 +1,22 @@
 require 'fiddle/import'
 require_relative 'fiddle_patch'
+require_relative 'error'
 module LibUI
   module FFI
     extend Fiddle::Importer
     extend FiddlePatch
-    begin
-      dlload LibUI.ffi_lib
-    rescue LoadError
-      raise LoadError, 'Could not find libui shared library'
+    if LibUI.ffi_lib.nil?
+      raise LibraryNotFoundError, 'Could not find libui shared library. LibUI.ffi_lib is nil.'
+    elsif !File.exist?(LibUI.ffi_lib)
+      raise LibraryNotFoundError, "Could not find libui shared library: #{LibUI.ffi_lib}"
+    else
+      begin
+        dlload LibUI.ffi_lib
+      rescue LoadError
+        raise LibraryLoadError, "Could not load libui shared library: #{LibUI.ffi_lib}"
+      end
     end
     class << self
@@ -18,6 +25,8 @@ module LibUI
       def try_extern(signature, *opts)
         extern(signature, *opts)
       rescue StandardError => e
+        # Do not raise error when the function is not found
+        # because some functions may not be available on older versions of libui.
         warn "#{e.class.name}: #{e.message}"
       end
@@ -27,6 +36,7 @@ module LibUI
     end
     typealias('uint32_t', 'unsigned int')
+    typealias('uint64_t', 'unsigned long long')
     InitOptions = struct [
       'size_t Size'
@@ -89,6 +99,9 @@ module LibUI
     try_extern 'char *uiWindowTitle(uiWindow *w)'
     try_extern 'void uiWindowSetTitle(uiWindow *w, const char *title)'
+    try_extern 'void uiWindowPosition(uiWindow *w, int *x, int *y)'
+    try_extern 'void uiWindowSetPosition(uiWindow *w, int x, int y)'
+    try_extern 'void uiWindowOnPositionChanged(uiWindow *w, void (*f)(uiWindow *sender, void *senderData), void *data)'
     try_extern 'void uiWindowContentSize(uiWindow *w, int *width, int *height)'
     try_extern 'void uiWindowSetContentSize(uiWindow *w, int width, int height)'
     try_extern 'int uiWindowFullscreen(uiWindow *w)'

data/lib/libui/fiddle_patch.rb CHANGED Viewed

@@ -1,25 +1,33 @@
 module LibUI
+  # This module overrides Fiddle's mtehods
+  # - Fiddle::Importer#extern
+  # - Fiddle::CParser#parse_signature
+  # Original methods are in
+  # - https://github.com/ruby/fiddle/blob/master/lib/fiddle/import.rb
+  # - https://github.com/ruby/fiddle/blob/master/lib/fiddle/cparser.rb
+  # These changes add the ability to parse the signatures of functions given as arguments.
   module FiddlePatch
     def parse_signature(signature, tymap = nil)
       tymap ||= {}
       ctype, func, args = case compact(signature)
-                          when /^(?:[\w\*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
+                          when /^(?:[\w*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
                             [TYPE_VOIDP, Regexp.last_match(1), Regexp.last_match(2)]
-                          when /^([\w\*\s]+[*\s])(\w+)\((.*?)\);?$/
+                          when /^([\w*\s]+[*\s])(\w+)\((.*?)\);?$/
                             [parse_ctype(Regexp.last_match(1).strip, tymap), Regexp.last_match(2), Regexp.last_match(3)]
                           else
-                            raise("can't parserake the function prototype: #{signature}")
+                            raise("can't parse the function prototype: #{signature}")
                           end
       symname = func
       callback_argument_types = {}                                              # Added
       argtype = split_arguments(args).collect.with_index do |arg, idx|          # Added with_index
         # Check if it is a function pointer or not
-        if arg =~ /\(\*.*\)\(.*\)/                                              # Added
+        if arg =~ /\(\*.*\)\(.*\)/ # Added
           # From the arguments, create a notation that looks like a function declaration
           # int(*f)(int *, void *) -> int f(int *, void *)
-          func_arg = arg.sub('(*', ' ').sub(')', '')                            # Added
+          func_arg = arg.sub('(*', ' ').sub(')', '') # Added
           # Use Fiddle's parse_signature method again.
-          callback_argument_types[idx] = parse_signature(func_arg)              # Added
+          callback_argument_types[idx] = parse_signature(func_arg) # Added
         end
         parse_ctype(arg, tymap)
       end
@@ -33,8 +41,8 @@ module LibUI
       func = import_function(symname, ctype, argtype, opt[:call_type])
       # callback_argument_types
-      func.instance_variable_set(:@callback_argument_types,
-                                   callback_argument_types) # Added
+      func.instance_variable_set(:@callback_argument_types,
+                                 callback_argument_types) # Added
       # attr_reader
       def func.callback_argument_types
         @callback_argument_types
@@ -60,9 +68,9 @@ module LibUI
       @func_map[name] = func
       # define_method(name){|*args,&block| f.call(*args,&block)}
       begin
-        /^(.+?):(\d+)/ =~ caller.first
-        file = Regexp.last_match(1)
-        line = Regexp.last_match(2).to_i
+        location = caller_locations(1, 1).first
+        file = location.path
+        line = location.lineno
       rescue StandardError
         file, line = __FILE__, __LINE__ + 3
       end

data/lib/libui/libui_base.rb CHANGED Viewed

@@ -25,11 +25,13 @@ module LibUI
           # Protect from GC
           # by giving the owner object a reference to the callback.
           # See https://github.com/kojix2/LibUI/issues/8
-          owner = if idx == 0 or   # UI.queue_main{}
-                     owner.frozen? # UI.timer(100) {}
-                    LibUIBase # or UI is better?
+          receiver = args.first
+          owner = if idx == 0 || # UI.queue_main{}
+                     receiver.nil? ||
+                     (receiver.respond_to?(:frozen?) && receiver.frozen?) # UI.timer(100) {}
+                    LibUIBase # keep a reference on an internal module to avoid GC
                   else
-                    args[0] # receiver
+                    receiver # receiver object holds the callback
                   end
           if owner.instance_variable_defined?(:@callbacks)
             owner.instance_variable_get(:@callbacks) << callback

data/lib/libui/platform.rb ADDED Viewed

@@ -0,0 +1,164 @@
+require 'rbconfig'
+module LibUI
+  module Platform
+    CONFIG = {
+      'arm64-darwin' => {
+        vendor: 'vendor/libui.arm64.dylib',
+        lib_names: ['libui.arm64.dylib', 'libui.dylib'],
+        release_zip: 'macOS-arm64-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.dylib'
+      },
+      'x86_64-darwin' => {
+        vendor: 'vendor/libui.x86_64.dylib',
+        lib_names: ['libui.x86_64.dylib', 'libui.dylib'],
+        release_zip: 'macOS-x64-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.dylib'
+      },
+      'x86_64-linux' => {
+        vendor: 'vendor/libui.x86_64.so',
+        lib_names: ['libui.x86_64.so', 'libui.so'],
+        release_zip: 'Ubuntu-x64-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.so'
+      },
+      'aarch64-linux' => {
+        vendor: 'vendor/libui.aarch64.so',
+        lib_names: ['libui.aarch64.so', 'libui.so'],
+        release_zip: 'Ubuntu-arm64-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.so'
+      },
+      'x64-mingw32' => {
+        vendor: 'vendor/libui.x64.dll',
+        lib_names: ['libui.x64.dll', 'libui.dll'],
+        release_zip: 'Windows-x64-msvc-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.dll'
+      },
+      'x86-mingw32' => {
+        vendor: 'vendor/libui.x86.dll',
+        lib_names: ['libui.x86.dll', 'libui.dll'],
+        release_zip: 'Windows-x86-msvc-shared-release.zip',
+        release_src: 'builddir/meson-out/libui.dll'
+      }
+    }.freeze
+    class << self
+      def config_keys
+        CONFIG.keys
+      end
+      def config_for(platform_key)
+        CONFIG[normalize_platform_key(platform_key)]
+      end
+      def current_config
+        config_for(detect_platform_key)
+      end
+      def detect_platform_key
+        native_platform_key || rubygems_platform_key
+      end
+      def native_platform_key
+        platform_key = case host_os
+                       when /darwin/
+                         "#{normalized_cpu}-darwin"
+                       when /linux/
+                         # libc variants (glibc vs musl) are not supported as
+                         # separate prebuilt targets yet; the shipped Linux
+                         # binaries are built on Ubuntu. Supporting musl would
+                         # require adding explicit *-linux-musl entries.
+                         "#{normalized_cpu}-linux"
+                       when /mingw|mswin/
+                         windows_platform_key
+                       end
+        CONFIG.key?(platform_key) ? platform_key : nil
+      end
+      def rubygems_platform_key
+        current_platform = Gem::Platform.local
+        platform_key = normalize_platform_key(current_platform.to_s)
+        return platform_key if CONFIG.key?(platform_key)
+        CONFIG.keys.find do |config_key|
+          config_platform = Gem::Platform.new(config_key)
+          # NOTE: match_platforms? is a private RubyGems API. It is used to
+          # reuse RubyGems' own platform matching (including the libc wildcard
+          # behaviour), but it may change or disappear across RubyGems versions.
+          if Gem::Platform.send(:match_platforms?, current_platform, [config_platform])
+            true
+          elsif config_key == 'x64-mingw32' &&
+                current_platform.os.start_with?('mingw') &&
+                %w[x64 x86_64 amd64].include?(current_platform.cpu)
+            true
+          elsif config_key == 'x86-mingw32' &&
+                current_platform.os.start_with?('mingw') &&
+                %w[x86 i386 i686].include?(current_platform.cpu)
+            true
+          else
+            false
+          end
+        end
+      end
+      # Canonicalizes alternate platform spellings to the keys used in CONFIG.
+      # Linux libc suffixes (-gnu / -musl) are intentionally not stripped here;
+      # adding libc-specific artifacts should be an explicit CONFIG change.
+      def normalize_platform_key(platform_key)
+        platform_key.to_s
+                    .sub(/\Aarm64-linux\z/, 'aarch64-linux')
+                    .sub(/\Ax64-linux\z/, 'x86_64-linux')
+                    .sub(/-mingw-ucrt\z/, '-mingw32')
+      end
+      def vendor_file_for(platform_key)
+        config = config_for(platform_key)
+        config && config[:vendor]
+      end
+      def current_lib_names
+        # host_lib_name and the bare "libui.<soext>" are fallbacks for locally
+        # built or manually placed libraries (e.g. via LIBUIDIR or a source
+        # checkout) whose file names may not match the CONFIG lib_names.
+        host_lib_name = "libui.#{host_cpu}.#{RbConfig::CONFIG['SOEXT']}"
+        names = current_config ? current_config[:lib_names] : []
+        ([host_lib_name] + names + ["libui.#{RbConfig::CONFIG['SOEXT']}"]).uniq
+      end
+      private
+      def host_cpu
+        RbConfig::CONFIG['host_cpu']
+      end
+      def host_os
+        RbConfig::CONFIG['host_os']
+      end
+      def normalized_cpu
+        case host_cpu
+        when /i\d86/
+          'x86'
+        when 'amd64', 'x64'
+          'x86_64'
+        when 'aarch64'
+          host_os =~ /darwin/ ? 'arm64' : host_cpu
+        when 'arm64'
+          host_os =~ /linux/ ? 'aarch64' : host_cpu
+        else
+          host_cpu
+        end
+      end
+      def windows_platform_key
+        case normalized_cpu
+        when 'x86_64'
+          'x64-mingw32'
+        when 'x86'
+          'x86-mingw32'
+        end
+      end
+    end
+  end
+end

data/lib/libui/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module LibUI
-  VERSION = '0.1.2'
+  VERSION = '0.2.3'
 end

data/lib/libui.rb CHANGED Viewed

@@ -1,21 +1,23 @@
 require_relative 'libui/version'
 require_relative 'libui/utils'
-require 'rbconfig'
+require_relative 'libui/error'
+require_relative 'libui/platform'
 module LibUI
-  class Error < StandardError; end
   class << self
     attr_accessor :ffi_lib
   end
-  lib_name = "libui.#{RbConfig::CONFIG['SOEXT']}"
-  self.ffi_lib = if ENV['LIBUIDIR'] && !ENV['LIBUIDIR'].empty?
-                   File.expand_path(lib_name, ENV['LIBUIDIR'])
-                 else
-                   File.expand_path("../vendor/#{lib_name}", __dir__)
-                 end
+  self.ffi_lib = \
+    if ENV['LIBUIDIR'] && !ENV['LIBUIDIR'].empty?
+      Platform.current_lib_names.lazy
+              .map { |name| File.expand_path(name, ENV['LIBUIDIR']) }
+              .find { |path| File.exist?(path) }
+    else
+      Platform.current_lib_names.lazy
+              .map { |name| File.expand_path("../vendor/#{name}", __dir__) }
+              .find { |path| File.exist?(path) }
+    end
   require_relative 'libui/ffi'
   require_relative 'libui/libui_base'
@@ -24,17 +26,142 @@ module LibUI
   class << self
     def init(opt = nil)
+      # Allocate uiInitOptions if not provided
       unless opt
         opt = FFI::InitOptions.malloc
         opt.to_ptr.free = Fiddle::RUBY_FREE
+        opt.Size = FFI::InitOptions.size
       end
-      i = super(opt)
-      return if i.size.zero?
-      warn 'error'
-      warn UI.free_init_error(init)
+      err_ptr = super(opt) # uiInit returns const char* error or NULL on success
+      return nil if err_ptr.null?
+      # Convert C string to Ruby string and free the error string per API contract
+      err_msg = err_ptr.to_s
+      free_init_error(err_ptr)
+      warn err_msg
+      nil
+    end
+    def new_button(text = '')
+      super(text)
+    end
+    def new_checkbox(text = '')
+      super(text)
     end
+    def window_set_title(window, title = '')
+      super(window, title)
+    end
+    def button_set_text(button, text = '')
+      super(button, text)
+    end
+    def checkbox_set_text(checkbox, text = '')
+      super(checkbox, text)
+    end
+    def entry_set_text(entry, text = '')
+      super(entry, text)
+    end
+    def label_set_text(label, text = '')
+      super(label, text)
+    end
+    def new_label(text = '')
+      super(text)
+    end
+    def group_set_title(group, title = '')
+      super(group, title)
+    end
+    def new_group(title = '')
+      super(title)
+    end
+    def combobox_append(combobox, text = '')
+      super(combobox, text)
+    end
+    def combobox_insert_at(combobox, index, text = '')
+      super(combobox, index, text)
+    end
+    def editable_combobox_append(combobox, text = '')
+      super(combobox, text)
+    end
+    def editable_combobox_set_text(combobox, text = '')
+      super(combobox, text)
+    end
+    def radio_buttons_append(radio_buttons, text = '')
+      super(radio_buttons, text)
+    end
+    def multiline_entry_set_text(entry, text = '')
+      super(entry, text)
+    end
+    def multiline_entry_append(entry, text = '')
+      super(entry, text)
+    end
+    def menu_append_item(menu, name = '')
+      super(menu, name)
+    end
+    def menu_append_check_item(menu, name = '')
+      super(menu, name)
+    end
+    def new_menu(name = '')
+      super(name)
+    end
+    def msg_box(parent, title, description = '')
+      super(parent, title, description)
+    end
+    def msg_box_error(parent, title, description = '')
+      super(parent, title, description)
+    end
+    def new_attributed_string(initial_string = '')
+      super(initial_string)
+    end
+    def attributed_string_append_unattributed(attributed_string, str = '')
+      super(attributed_string, str)
+    end
+    def new_table_value_string(str = '')
+      super(str)
+    end
+    # Gets the window position.
+    # Coordinates are measured from the top left corner of the screen.
+    # @param w [Fiddle::Pointer] Pointer of uiWindow instance.
+    # @return [Array] position of the window. [x, y]
+    # @note This method may return inaccurate or dummy values on Unix platforms.
+    def window_position(w)
+      x_ptr = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT, Fiddle::RUBY_FREE)
+      y_ptr = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT, Fiddle::RUBY_FREE)
+      super(w, x_ptr, y_ptr)
+      x = x_ptr[0, Fiddle::SIZEOF_INT].unpack1('i*')
+      y = y_ptr[0, Fiddle::SIZEOF_INT].unpack1('i*')
+      [x, y]
+    end
+    # FIXME: This is a workaround for a old version of Fiddle.
+    # Fiddle 1.1.2 and above should be able to handle one character string.
+    # See https://github.com/ruby/fiddle/issues/96
     def open_type_features_add(otf, a, b, c, d, value)
       a, b, c, d = [a, b, c, d].map { |s| s.is_a?(String) ? s.ord : s }
       super(otf, a, b, c, d, value)

data/vendor/README.md CHANGED Viewed

@@ -68,6 +68,16 @@ For the sake of completeness, I should note that the default value of `--layout`
 Backends other than `ninja` should work, but are untested by me.
+## Testing
+### Automated Unit Tests
+Run the included unit tests via `meson test -C build`. Alternatively you can also run the `unit` executable manually.
+### Manual Testing Suite
+Run the manual quality assurance test suite via `qa` and follow the instructions laid out within.
 ## Installation
 Meson also supports installing from source; if you use Ninja, just do
@@ -82,9 +92,13 @@ When running `meson`, the `--prefix` option will set the installation prefix. [T
 Can be built from AUR: https://aur.archlinux.org/packages/libui-ng-git/
-## Documentation
+## Documentation [WIP]
+[API](https://libui-ng.github.io/libui-ng/), check the [modules](https://libui-ng.github.io/libui-ng/modules.html) section for an overview of (nearly all) uiControls.
+Consult the `ui.h` comments for the uiControls missing in the docs.
-Needs to be written. Consult `ui.h` and the examples for details for now.
+Check the `examples` directory for fully fledged examples. Check out the `tests` directory and subdirectories for more real world usage.
 ## Language Bindings
@@ -96,7 +110,7 @@ Language | Bindings
 --- | ---
 C++ | [libui-cpp](https://github.com/billyquith/libui-cpp), [cpp-libui-qtlike](https://github.com/aoloe/cpp-libui-qtlike)
 C# / .NET Framework | [LibUI.Binding](https://github.com/NattyNarwhal/LibUI.Binding)
-C# / .NET Core | [DevZH.UI](https://github.com/noliar/DevZH.UI), [SharpUI](https://github.com/benpye/sharpui/), [SimplexiDev.UI](https://github.com/simplexidev/sdfx)
+C# / .NET Core | [DevZH.UI](https://github.com/noliar/DevZH.UI), [SharpUI](https://github.com/benpye/sharpui/)
 CHICKEN Scheme | [wasamasa/libui](https://github.com/wasamasa/libui)
 Common Lisp | [jinwoo/cl-ui](https://github.com/jinwoo/cl-ui)
 Crystal | [libui.cr](https://github.com/Fusion/libui.cr), [hedron](https://github.com/Qwerp-Derp/hedron), [iu](https://github.com/grkek/iu)
@@ -109,13 +123,13 @@ JavaScript/Node.js | [libui-node](https://github.com/parro-it/libui-node), [libu
 Julia | [Libui.jl](https://github.com/joa-quim/Libui.jl)
 Kotlin | [kotlin-libui](https://github.com/msink/kotlin-libui)
 Lua | [libuilua](https://github.com/zevv/libuilua), [libui-lua](https://github.com/mdombroski/libui-lua), [lui](http://tset.de/lui/index.html), [lui](https://github.com/zhaozg/lui)
-Nim | [ui](https://github.com/nim-lang/ui)
+Nim | [ui](https://github.com/nim-lang/ui), [uing](https://github.com/neroist/uing)
 Perl6 | [perl6-libui](https://github.com/Garland-g/perl6-libui)
-PHP | [ui](https://github.com/krakjoe/ui)
+PHP | [ui](https://github.com/krakjoe/ui), [Ardillo](https://github.com/ardillo-php/ext)
 Python | [pylibui](https://github.com/joaoventura/pylibui)
 Ring | [RingLibui](https://github.com/ring-lang/ring/tree/master/extensions/ringlibui)
 Ruby | [libui-ruby](https://github.com/jamescook/libui-ruby), [LibUI](https://github.com/kojix2/libui), [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
-Rust | [libui-ng-sys](https://github.com/norepimorphism/libui-ng-sys), [boing](https://github.com/norepimorphism/boing), [libui-rs](https://github.com/rust-native-ui/libui-rs)
+Rust | [libui-ng-sys](https://github.com/norepimorphism/libui-ng-sys), [boing](https://github.com/norepimorphism/boing), [libui-rs](https://github.com/rust-native-ui/libui-rs), [libui](https://github.com/libui-rs/libui)
 Scala | [scalaui](https://github.com/lolgab/scalaui)
 Swift | [libui-swift](https://github.com/sclukey/libui-swift)

data/vendor/libui.aarch64.so ADDED Viewed

Binary file

data/vendor/libui.arm64.dylib ADDED Viewed

Binary file

data/vendor/libui.x64.dll ADDED Viewed

Binary file

data/vendor/libui.x86.dll ADDED Viewed

Binary file

data/vendor/libui.x86_64.dylib ADDED Viewed

Binary file

data/vendor/libui.x86_64.so ADDED Viewed

Binary file

metadata CHANGED Viewed

@@ -1,16 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: libui
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - kojix2
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - 2xijok@gmail.com
 executables: []
@@ -20,21 +32,25 @@ files:
 - LICENSE.txt
 - README.md
 - lib/libui.rb
+- lib/libui/error.rb
 - lib/libui/ffi.rb
 - lib/libui/fiddle_patch.rb
 - lib/libui/libui_base.rb
+- lib/libui/platform.rb
 - lib/libui/utils.rb
 - lib/libui/version.rb
 - vendor/LICENSE.md
 - vendor/README.md
-- vendor/libui.dll
-- vendor/libui.dylib
-- vendor/libui.so
+- vendor/libui.aarch64.so
+- vendor/libui.arm64.dylib
+- vendor/libui.x64.dll
+- vendor/libui.x86.dll
+- vendor/libui.x86_64.dylib
+- vendor/libui.x86_64.so
 homepage: https://github.com/kojix2/libui
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -42,15 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby bindings to libui
 test_files: []

data/vendor/libui.dll DELETED Viewed

Binary file

data/vendor/libui.dylib DELETED Viewed

Binary file

data/vendor/libui.so DELETED Viewed

Binary file