libui 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ee9e67a91414cbea40a50448a58bbb320f8962f34a35fa9c26d7ed0019878d
-  data.tar.gz: cfde88b2432abbf23f9dd0d195db0258c143bfd1ff339f51b3112ccaf4742af2
+  metadata.gz: dbb5362886495f17bf74055bf1ad4cbc96bb7f0e4518e8db0b18f9572559adf2
+  data.tar.gz: 19040d301c6cb135a3e5ef1270f211f48f007f02ec3e5fe7edcbc3be03f275da
 SHA512:
-  metadata.gz: cb131ab13e11e6573058c0ec611c7467557756904b49d4121541f4075518958d3fdf2adc74e21d52f0f433c537faeffd6a77ab4162f7d42321fdec75437d1be0
-  data.tar.gz: 0dc6139433b79bec3e0a096f376db6af7eedc6b989ccab25bf4d3a1123afc75d053d43625d5302122952b2a527a8a17665ec9bc1472c1574f5ae4262bef80197
+  metadata.gz: 27a0c320d8592b2e6a6531b66ed0de3a83a3f606058d16469af530d0633a02d2d13e848e5ca4dd8d6c184015449a2ba56b4eb6c7e63ede1ccb7bfa6d447b5f1b
+  data.tar.gz: '033190ef229e3f567db9c7a7d338da4107072a6120e79c928a5e03dffcca922ffe75ac76f631fda810133cd6316d6af55ea234eb3fce214540fe1e92fd7d6eaf'

data/README.md

@@ -3,7 +3,7 @@
 ![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)
 
-:radio_button: [libui](https://github.com/andlabs/libui) - a portable GUI library -for Ruby
+:radio_button: [libui](https://github.com/andlabs/libui) - a portable GUI library - for Ruby
 
 ## Installation
 
@@ -20,25 +20,29 @@ gem install libui
 |---------|-----|-------|
 |<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">|
 
+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).
+
 ## Usage
 
 ```ruby
 require 'libui'
+
 UI = LibUI
 
 UI.init
 
-main_window = UI.new_window('hello world', 300, 200, 1)
-UI.window_on_closing(main_window) do
-  puts 'Bye Bye'
-  UI.control_destroy(main_window)
-  UI.quit
-  0
-end
+main_window = UI.new_window('hello world', 200, 100, 1)
 
 button = UI.new_button('Button')
+
 UI.button_on_clicked(button) do
   UI.msg_box(main_window, 'Information', 'You clicked the button')
+end
+
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.quit
   0
 end
 
@@ -58,7 +62,6 @@ Compared to original libui 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. 
-  * Please return 0 explicitly in the block.
   * 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 nil.
   
@@ -101,35 +104,79 @@ UI.font_button_on_changed(font_button) do
 end
 ```
 
+* Callbacks
+  * In Ruby/Fiddle, 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.
+
+```ruby
+# 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 
 
 OCRA (One-Click Ruby Application) builds Windows executables from Ruby source code. 
 * https://github.com/larsch/ocra/
 
+In order to build a exe with Ocra, include 3 DLLs from ruby_builtin_dlls folder:
+
+```sh
+ocra examples/control_gallery.rb        ^
+  --dll ruby_builtin_dlls/libssp-0.dll  ^
+  --dll ruby_builtin_dlls/libgmp-10.dll ^
+  --dll ruby_builtin_dlls/libffi-7.dll  ^
+  --gem-all=fiddle                      ^
+```
+
+Add additional options below if necessary.
+
+```sh
+  --window                              ^
+  --add-all-core                        ^
+  --chdir-first                         ^
+  --icon assets\app.ico                 ^
+  --verbose                             ^
+  --output out\gallery.exe
+```
+
 ## Development
 
 ```sh
 git clone https://github.com/kojix2/libui
 cd libui
 bundle install
-bundle exec rake vendor:all
+bundle exec rake vendor:all_x64 # download shared libraries for all platforms
 bundle exec rake test
 ```
 
-Use the following rake tasks to download the libui binary files and save them in the vendor directory.
+You can use the following rake tasks to download the shared library required for your platform.
 
 `rake -T`
 
 ```
-rake vendor:all       # Download libui.so, libui.dylib, and libui.dll to ve...
-rake vendor:linux     # Download libui.so for Linux to vendor directory
-rake vendor:mac       # Download libui.dylib for Mac to vendor directory
-rake vendor:windows   # Download libui.dll for Windows to vendor directory
+rake vendor:all_x64      # Download libui.so, libui.dylib, and libui.dll to...
+rake vendor:linux_x64    # Download libui.so for Linux to vendor directory
+rake vendor:linux_x86    # Download libui.so for Linux to vendor directory
+rake vendor:mac_x64      # Download libui.dylib for Mac to vendor directory
+rake vendor:windows_x64  # Download libui.dll for Windows to vendor directory
+rake vendor:windows_x86  # Download libui.dll for Windows to vendor directory
 ```
 
+For example, If you are using a 32-bit (x86) version of Ruby on Windows, type `rake vendor:windows_x86`.
+
+Or Set environment variable `LIBUIDIR` to specify the path to the shared library.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/libui.
+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 typofixes, are appreciated.
+* Did you find any bugs?　Write it in the [issues](https://github.com/kojix2/LibUI/issue) section!
 
 ## Acknowledgement
 

data/lib/libui/utils.rb

@@ -8,7 +8,7 @@ module LibUI
       # Converting camel case to underscore case in ruby
       # https://stackoverflow.com/questions/1509915/converting-camel-case-to-underscore-case-in-ruby#1509939
       def underscore(str)
-        str.gsub(/::/, '/')
+        str.gsub(/::/, '/') # Maybe we don't need it.
            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
            .tr('-', '_')

data/lib/libui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LibUI
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/libui.rb

@@ -10,14 +10,7 @@ module LibUI
     attr_accessor :ffi_lib
   end
 
-  lib_name = case RbConfig::CONFIG['host_os']
-             when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-               'libui.dll'
-             when /darwin|mac os/
-               'libui.dylib'
-             else
-               'libui.so'
-             end
+  lib_name = "libui.#{RbConfig::CONFIG["SOEXT"]}"
 
   self.ffi_lib = if ENV['LIBUIDIR'] && !ENV['LIBUIDIR'].empty?
                    File.expand_path(lib_name, ENV['LIBUIDIR'])
@@ -47,9 +40,11 @@ module LibUI
             # Protect from GC
             # See https://github.com/kojix2/LibUI/issues/8
             receiver = args[0]
-            callbacks = receiver.instance_variable_get(:@callbacks) || []
-            callbacks << callback
-            receiver.instance_variable_set(:@callbacks, callback)
+            if receiver.instance_variable_defined?(:@callbacks)
+              receiver.instance_variable_get(:@callbacks) << callback
+            else
+              receiver.instance_variable_set(:@callbacks, [callback])
+            end
             callback
           else
             arg
@@ -67,10 +62,10 @@ module LibUI
     module CustomMethods
       def init(opt = FFI::InitOptions.malloc)
         i = super(opt)
-        unless i.size.zero?
-          warn 'error'
-          warn UI.free_init_error(init)
-        end
+        return if i.size.zero?
+
+        warn 'error'
+        warn UI.free_init_error(init)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libui
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to libui