libui 0.1.3.pre-x86_64-linux → 0.2.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f068fcf26facd76bd1f56faeca3ac4bea3b11e872befe05447c7ecdbe33cd1c5
-  data.tar.gz: 9911c9a3488c9e0a3c50a36bedba124171a8ce6c2549fb983eee35e8f56955b5
+  metadata.gz: 6a4a93bc8fdec0c9c4e2587bb2aa99c0ac11d54e34ae9956e64a9a841a39cac5
+  data.tar.gz: 9b4caca40127dea74380e48afa011f0162e2169cdba6a4037d52ad1e38247924
 SHA512:
-  metadata.gz: 7d07e4e85f62e610d25203f3eb2c99431eac61b021f1872597b9bbba14d905d32f879598b3b9f5d0582ba73904ca5e7a27a7e8309c671cfa1e8c6605f3810fa4
-  data.tar.gz: b4195a2387afaf719b34d33742650a147041e7179ddbe71c4d926c41fb641c27eaecd8ad83a4f7da9d002fa3fd7b219fa035132dc3255512234d0a90d350f579
+  metadata.gz: 9b39de93bfeeb054f86237741ea0b072aead99d1835156fb3f4e18e73f17bbb6e2c8a2592cce0adc31f00c4c1c28d85d31c7d1564a36f074c7bd64664ce39298
+  data.tar.gz: 333a266fcec1f2108cf7443cbcc56b9f0f86d2620886bdbed5e4bd874e6b18c22a4f493c375da1f9afc38c0595baf1ee32bcc3638f6b1d6780d5e71f868ee15f

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 kojix2
+Copyright (c) 2020-2025 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

@@ -4,21 +4,32 @@
 [![Gem Version](https://badge.fury.io/rb/libui.svg)](https://badge.fury.io/rb/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>
 [![Pre-build](https://github.com/kojix2/libui-ng/actions/workflows/pre-build.yml/badge.svg?branch=pre-build)](https://github.com/kojix2/libui-ng/actions/workflows/pre-build.yml)
+[![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)
 
-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
 
+:wrench: [libui-dev](https://github.com/petabyt/libui-dev) - Native UI library for C - with some extras
+
 :radio_button: [libui](https://github.com/andlabs/libui) - Original version by andlabs.
 
 ## Installation
 
+It is recommended to use libui-ng, via the --pre commandline flag:
+
+```sh
+gem install libui --pre # libui-ng; this will fetch libui-0.1.3.pre-x86_64-linux.gem
+```
+
+If for some reason you would like to install the slightly older libui-0.1.2.gem release, issue:
+
 ```sh
 gem install libui
 ```
 
-- The gem package includes the [official release](https://github.com/andlabs/libui/releases/tag/alpha4.1) of the libui shared library version 4.1 for Windows, Mac, and Linux.
-  - Namely `libui.dll`, `libui.dylib`, and `libui.so` (only 1.8MB in total).
+- The gem package includes the libui-ng shared library for Windows, Mac, and Linux.
+  - Namely `libui.dll`, `libui.dylib`, or `libui.so`.
 - No dependencies required.
   - The libui gem uses the standard Ruby library [Fiddle](https://github.com/ruby/fiddle) to call C functions.
 
@@ -51,9 +62,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)
@@ -167,42 +177,42 @@ Add additional options below if necessary:
 git clone https://github.com/kojix2/libui
 cd libui
 bundle install
-bundle exec rake vendor:auto # vendor:build
+bundle exec rake vendor:auto
 bundle exec rake test
 ```
 
 ### Pre-built shared libraries for libui-ng
 
-Use the following rake tasks to download the shared library required for your platform:
-
-`rake -T`
+Download pre-built libui-ng shared libraries (per your current platform):
 
+```sh
+bundle exec rake vendor:auto
 ```
-rake vendor:build[hash]          # Build libui-ng latest master [commit hash]
-rake vendor:libui-ng:macos       # Download latest official pre-build for Mac to vendor directory
-rake vendor:libui-ng:ubuntu_x64  # Download latest official pre-build for Ubuntu to vendor directory
-rake vendor:macos_arm64          # Download pre-build for Mac to vendor directory
-rake vendor:macos_x64            # Download pre-build for Mac to vendor directory
-rake vendor:raspbian_aarch64     # Download pre-build for Raspbian to vendor directory
-rake vendor:ubuntu_x64           # Download pre-build for Ubuntu to vendor directory
-rake vendor:windows_x64          # Download pre-build for Windows to vendor directory
-rake vendor:windows_x86          # Download pre-build for Windows 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:windows_x86`.
-These shared libraries are [artifacts](https://github.com/kojix2/libui-ng/actions/workflows/pre-build.yml) of the [pre-build branch](https://github.com/kojix2/libui-ng/tree/pre-build) of [kojix2/libui-ng](https://github.com/kojix2/libui-ng). In that case, please let us know.
+### 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).
 
-### Using C libui compiled from source code
+### Publishing gems
 
-The following Rake task will compile libui-ng. meson or ninja is required.
+#### Automated Publishing
 
-`bundle exec rake vendor:build`
+Push a version tag to automatically publish platform-specific gems:
 
-Alternatively, you can tell Ruby LibUI the location of shared libraries. Set the 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).
+```sh
+git tag v0.1.3
+git push origin v0.1.3
+```
 
-Another simple approach is to replace the shared libraries in the gem vendor directory with the ones you have compiled.
+Requires `RUBYGEMS_API_KEY` repository secret with scoped API key.
 
-### Publishing gems
+#### Manual Publishing
 
 ```sh
 ls vendor             # check the vendor directory

data/lib/libui/error.rb

@@ -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

@@ -1,15 +1,23 @@
 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 +26,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 +37,7 @@ module LibUI
     end
 
     typealias('uint32_t', 'unsigned int')
+    typealias('uint64_t', 'unsigned long long')
 
     InitOptions = struct [
       'size_t Size'

data/lib/libui/fiddle_patch.rb

@@ -16,7 +16,7 @@ module LibUI
                           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

data/lib/libui/libui_base.rb

@@ -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/version.rb

@@ -1,3 +1,3 @@
 module LibUI
-  VERSION = '0.1.3.pre'
+  VERSION = '0.2.0'
 end

data/lib/libui.rb

@@ -1,16 +1,26 @@
 require_relative 'libui/version'
 require_relative 'libui/utils'
+require_relative 'libui/error'
 require 'rbconfig'
 
 module LibUI
-  class Error < StandardError; end
-
   class << self
     attr_accessor :ffi_lib
   end
 
+  host_cpu = case RbConfig::CONFIG['host_cpu']
+             when /i\d86/
+               'x86'
+             else
+               RbConfig::CONFIG['host_cpu']
+             end
+
   lib_name = [
+    # For libui-ng shared libraries compiled with (rake vendor:build)
     "libui.#{RbConfig::CONFIG['host_cpu']}.#{RbConfig::CONFIG['SOEXT']}",
+    # For libui-ng shared library downloaded from RubyGems.org
+    "libui.#{host_cpu}.#{RbConfig::CONFIG['SOEXT']}",
+    # For backward compatibility or manual compilation of libui-ng
     "libui.#{RbConfig::CONFIG['SOEXT']}"
   ]
 
@@ -32,15 +42,21 @@ 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
 
     # Gets the window position.

metadata

@@ -1,16 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: libui
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre
+  version: 0.2.0
 platform: x86_64-linux
 authors:
 - kojix2
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-09 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,6 +32,7 @@ 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
@@ -32,7 +45,6 @@ homepage: https://github.com/kojix2/libui
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,12 +55,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby bindings to libui
 test_files: []