libui 0.0.5.alpha → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9942c95097af2b3c542472fa3e144e040cf3f9c0ef253e891d87b79b93070e77
-  data.tar.gz: a69a733f1cd1dd2274c601422a2cb3a5b91d762055d73fc3e9e9f59e6f11c919
+  metadata.gz: dbb5362886495f17bf74055bf1ad4cbc96bb7f0e4518e8db0b18f9572559adf2
+  data.tar.gz: 19040d301c6cb135a3e5ef1270f211f48f007f02ec3e5fe7edcbc3be03f275da
 SHA512:
-  metadata.gz: 47d42cfbc47996ad411f0ba9e6634378fa2bd088d84bc4179698c4ad3c049a7ce8e75218c8fd93538362d01961c9ca4d278aa2c60a5074a1fea532d4b22841b8
-  data.tar.gz: 25c390450f42ff51ee05a9f5c7c9409c16860ac1ae3351e0d85aa30ad1d753f7cad2e1091ff9193bdf85cb21d77c344fbe1acdb5e429746e9d69574b59388379
+  metadata.gz: 27a0c320d8592b2e6a6531b66ed0de3a83a3f606058d16469af530d0633a02d2d13e848e5ca4dd8d6c184015449a2ba56b4eb6c7e63ede1ccb7bfa6d447b5f1b
+  data.tar.gz: '033190ef229e3f567db9c7a7d338da4107072a6120e79c928a5e03dffcca922ffe75ac76f631fda810133cd6316d6af55ea234eb3fce214540fe1e92fd7d6eaf'

data/README.md

@@ -1,37 +1,182 @@
-# libui
+# 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)
 
-: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
 
 ```sh
-gem install libui --pre
+gem install libui
 ```
 
-The libui gem package contains the official release of the libui shared library version 4.1 for Windows, Mac, and Linux.
+* 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.4MB in total).
+* No dependency
+  * 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">|
+
+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', 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
+
+UI.window_set_child(main_window, button)
+UI.control_show(main_window)
+
+UI.main
+UI.quit
+```
+
 See [examples](https://github.com/kojix2/libui/tree/main/examples) directory.
 
+### General Rules
+
+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. 
+  * 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.
+  
+### Not object oriented?
+
+* At the moment, it is not object-oriented.
+  * Instead of providing a half-baked object-oriented approach, leave it as is.
+
+### How to use fiddle pointers?
+
+```ruby
+require 'libui'
+UI = LibUI
+UI.init
+```
+
+Convert a pointer to a string.
+
+```ruby
+label = UI.new_label("Ruby")
+p pointer = UI.label_text(label) # #<Fiddle::Pointer>
+p pointer.to_s # Ruby
+```
+
+If you need to use C structs, you can do the following.
+
+```ruby
+font_button = UI.new_font_button
+
+# Allocate memory 
+font_descriptor = UI::FFI::FontDescriptor.malloc
+
+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
+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
 ```
 
-* Keep it simple.
+You can use the following rake tasks to download the shared library required for your platform.
+
+`rake -T`
+
+```
+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/ffi.rb

@@ -4,60 +4,53 @@ require 'fiddle/import'
 
 module Fiddle
   # Change the Function to hold a little more information.
-  # FIXME: Give inner_function a better name.
   class Function
-    attr_accessor :inner_functions, :argtype
+    # Note:
+    # Ruby 2.7 Fiddle::Function dose not have @argument_types
+    # Ruby 3.0 Fiddle::Function has @argument_types
+    attr_accessor :callback_argument_types, :argument_types
   end
 
   module Importer
     def parse_signature(signature, tymap = nil)
       tymap ||= {}
-      ret, func, args = split_signature(signature)
+      ctype, func, args = case compact(signature)
+                          when /^(?:[\w\*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
+                            [TYPE_VOIDP, Regexp.last_match(1), Regexp.last_match(2)]
+                          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}")
+                          end
       symname = func
-      ctype   = parse_ctype(ret, tymap)
-      inner_funcs = []                                                    # Added
-      argtype = split_arguments(args).collect.with_index do |arg, idx|    # Added with_index
+      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.
-          inner_funcs[idx] = parse_signature(func_arg)                    # Added
-        end                                                               # Added
+          callback_argument_types[idx] = parse_signature(func_arg)              # Added
+        end
         parse_ctype(arg, tymap)
       end
-      # Added inner_funcs. Original method return only 3 values.
-      [symname, ctype, argtype, inner_funcs]
-    end
-
-    # refactored
-    def split_signature(signature)
-      case compact(signature)
-      when /^(?:[\w*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
-        func = Regexp.last_match(1)
-        args = Regexp.last_match(2)
-        [TYPE_VOIDP, func, args]
-      when /^([\w*\s]+[*\s])(\w+)\((.*?)\);?$/
-        ret  = Regexp.last_match(1).strip
-        func = Regexp.last_match(2)
-        args = Regexp.last_match(3)
-        [ret, func, args]
-      else
-        raise("can't parse the function prototype: #{signature}")
-      end
+      # Added callback_argument_types. Original method return only 3 values.
+      [symname, ctype, argtype, callback_argument_types]
     end
 
     def extern(signature, *opts)
-      symname, ctype, argtype, inner_funcs = parse_signature(signature, type_alias)
+      symname, ctype, argtype, callback_argument_types = parse_signature(signature, type_alias)
       opt = parse_bind_options(opts)
-      f = import_function(symname, ctype, argtype, opt[:call_type])
+      func = import_function(symname, ctype, argtype, opt[:call_type])
 
-      f.inner_functions = inner_funcs # Added
-      f.argtype         = argtype     # Added
+      func.callback_argument_types = callback_argument_types                    # Added
+      # Ruby 2.7 Fiddle::Function dose not have @argument_types
+      # Ruby 3.0 Fiddle::Function has @argument_types
+      func.argument_types = argtype
 
       name = symname.gsub(/@.+/, '')
-      @func_map[name] = f
+      @func_map[name] = func
       # define_method(name){|*args,&block| f.call(*args,&block)}
       begin
         /^(.+?):(\d+)/ =~ caller.first
@@ -72,7 +65,7 @@ module Fiddle
         end
       EOS
       module_function(name)
-      f
+      func
     end
   end
 end
@@ -95,6 +88,10 @@ module LibUI
       rescue StandardError => e
         warn "#{e.class.name}: #{e.message}"
       end
+
+      def ffi_methods
+        @ffi_methods ||= func_map.each_key.to_a
+      end
     end
 
     typealias('uint32_t', 'unsigned int')
@@ -280,7 +277,20 @@ module LibUI
     try_extern 'void uiRadioButtonsOnSelected(uiRadioButtons *r, void (*f)(uiRadioButtons *, void *), void *data)'
     try_extern 'uiRadioButtons *uiNewRadioButtons(void)'
 
-    # uiDateTimePicker # Fixme: struct tm
+    # uiDateTimePicker
+
+    # time.h
+    TM = struct [
+      'int tm_sec',
+      'int tm_min',
+      'int tm_hour',
+      'int tm_mday',
+      'int tm_mon',
+      'int tm_year',
+      'int tm_wday',
+      'int tm_yday',
+      'int tm_isdst'
+    ]
 
     try_extern 'void uiDateTimePickerTime(uiDateTimePicker *d, struct tm *time)'
     try_extern 'void uiDateTimePickerSetTime(uiDateTimePicker *d, const struct tm *time)'

data/lib/libui/utils.rb

@@ -0,0 +1,19 @@
+module LibUI
+  module Utils
+    class << self
+      def convert_to_ruby_method(original_method_name)
+        underscore(original_method_name.delete_prefix('ui'))
+      end
+
+      # 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(/::/, '/') # Maybe we don't need it.
+           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+           .tr('-', '_')
+           .downcase
+      end
+    end
+  end
+end

data/lib/libui/version.rb

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

data/lib/libui.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'libui/version'
+require_relative 'libui/utils'
 
 module LibUI
   class Error < StandardError; end
@@ -9,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'])
@@ -28,14 +22,7 @@ module LibUI
 
   class << self
     FFI.func_map.each_key do |original_method_name|
-      # Convert snake_case to CamelCase.
-      name = original_method_name.delete_prefix('ui')
-                                 .gsub(/::/, '/')
-                                 .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-                                 .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-                                 .tr('-', '_')
-                                 .downcase
-
+      name = Utils.convert_to_ruby_method(original_method_name)
       func = FFI.func_map[original_method_name]
 
       define_method(name) do |*args, &blk|
@@ -47,14 +34,25 @@ module LibUI
           if arg.is_a?(Proc)
             # The types of the function arguments are recorded beforehand.
             # See the monkey patch in ffi.rb.
-            Fiddle::Closure::BlockCaller.new(*func.inner_functions[idx][1..2], &arg)
+            callback = Fiddle::Closure::BlockCaller.new(
+              *func.callback_argument_types[idx][1..2], &arg
+            )
+            # Protect from GC
+            # See https://github.com/kojix2/LibUI/issues/8
+            receiver = args[0]
+            if receiver.instance_variable_defined?(:@callbacks)
+              receiver.instance_variable_get(:@callbacks) << callback
+            else
+              receiver.instance_variable_set(:@callbacks, [callback])
+            end
+            callback
           else
             arg
           end
         end
 
         # Make it possible to omit the last nil. This may be an over-optimization.
-        siz = func.argtype.size - 1
+        siz = func.argument_types.size - 1
         args[siz] = nil if args.size == siz
 
         FFI.public_send(original_method_name, *args)
@@ -64,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.5.alpha
+  version: 0.0.9
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - README.md
 - lib/libui.rb
 - lib/libui/ffi.rb
+- lib/libui/utils.rb
 - lib/libui/version.rb
 - vendor/LICENSE
 - vendor/README.md
@@ -112,11 +113,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to libui