libui 0.0.5.alpha → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9942c95097af2b3c542472fa3e144e040cf3f9c0ef253e891d87b79b93070e77
-  data.tar.gz: a69a733f1cd1dd2274c601422a2cb3a5b91d762055d73fc3e9e9f59e6f11c919
+  metadata.gz: f0214c682062d1e669d2ec2df579d91466b2d0330205231d00734e3d9b21fc57
+  data.tar.gz: 2bce2e4f6edf26bd2442e7205ef10ad59529f1e16f2a88aa0a282cb61d623ced
 SHA512:
-  metadata.gz: 47d42cfbc47996ad411f0ba9e6634378fa2bd088d84bc4179698c4ad3c049a7ce8e75218c8fd93538362d01961c9ca4d278aa2c60a5074a1fea532d4b22841b8
-  data.tar.gz: 25c390450f42ff51ee05a9f5c7c9409c16860ac1ae3351e0d85aa30ad1d753f7cad2e1091ff9193bdf85cb21d77c344fbe1acdb5e429746e9d69574b59388379
+  metadata.gz: f700b08bb46f282b7298f7530bbbade2a59fcde144e54af97bb01a1766a98b3a133b10e064cd62a69621e2d61ff9d587bff17d850f96bb23b4e5c2ee101f97a7
+  data.tar.gz: 8571472b2ceb6fa2cd5d6627fce64c896e2ae651012fd8d949f9a94a6cf70dc48df6af7f379652c956b3b1e5e6725fb14465d616abdae776e9ec635c0c4150f9

data/README.md

@@ -8,15 +8,95 @@
 ## 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 libui gem uses the standard Ruby library [Fiddle](https://github.com/ruby/fiddle) to call C functions. And this gem contains the official release of the libui shared library version 4.1 for Windows, Mac, and Linux. That means there is no need to install anything other than this gem.
 
 ## 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
+
+button = UI.new_button('Button')
+UI.button_on_clicked(button) do
+  UI.msg_box(main_window, 'Information', 'You clicked the button')
+  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
+
+* 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.
+  
+### 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
+```
+
+### 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/
+
 ## Development
 
 ```sh
@@ -27,7 +107,16 @@ bundle exec rake vendor:all
 bundle exec rake test
 ```
 
-* Keep it simple.
+Use the following rake tasks to download the libui binary files and save them in the vendor directory.
+
+`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
+```
 
 ## Contributing
 

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
@@ -28,14 +29,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|

data/lib/libui/ffi.rb

@@ -35,17 +35,17 @@ module Fiddle
     def split_signature(signature)
       case compact(signature)
       when /^(?:[\w*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
+        ret  = TYPE_VOIDP
         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
+      [ret, func, args]
     end
 
     def extern(signature, *opts)
@@ -95,6 +95,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')

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(/::/, '/')
+           .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.6'
 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.6
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2020-12-22 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,9 +113,9 @@ 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
 signing_key: