ruby-gr 0.0.18 → 0.0.23

data/lib/gr3.rb

@@ -60,27 +60,20 @@ module GR3
     attr_accessor :ffi_lib
   end
 
+  require_relative 'gr_commons/gr_commons'
+  extend GRCommons::SearchSharedLibrary
+
   # Platforms |  path
   # Windows   |  bin/libGR3.dll
   # MacOSX    |  lib/libGR3.so (NOT .dylib)
   # Ubuntu    |  lib/libGR3.so
-  if Object.const_defined?(:RubyInstaller)
-    ENV['GRDIR'] ||= [
-      RubyInstaller::Runtime.msys2_installation.msys_path,
-      RubyInstaller::Runtime.msys2_installation.mingwarch
-    ].join(File::ALT_SEPARATOR)
-    self.ffi_lib = File.expand_path('bin/libGR3.dll', ENV['GRDIR'])
-    RubyInstaller::Runtime.add_dll_directory(File.dirname(ffi_lib))
-  else
-    raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
-    self.ffi_lib = File.expand_path('lib/libGR3.so', ENV['GRDIR'])
-  end
+  self.ffi_lib = case RbConfig::CONFIG['host_os']
+                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                   search_shared_library('libGR3.dll', 'gr3')
+                 else
+                   search_shared_library('libGR3.so', 'gr3')
+                 end
 
-  # change the default encoding to UTF-8.
-  ENV['GKS_ENCODING'] ||= 'utf8'
-
-  require_relative 'gr_commons/gr_commons'
   require_relative 'gr3/version'
   require_relative 'gr3/ffi'
   require_relative 'gr3/gr3base'

data/lib/gr_commons/fiddley.rb

@@ -13,7 +13,7 @@ module GRCommons
   # NOTE: This module is only part of the original code.
   # kojix2 adds, deletes, and modifies several methods.
   module Fiddley
-    # NOTE: GR.rb supports 2.4 +. Unpack 1 does not work under 2.3.
+    # NOTE: GR.rb supports 2.5 +. Unpack 1 does not work under 2.3.
 
     module Utils
       # assumes short = 16bit, int = 32bit, long long = 64bit

data/lib/gr_commons/gr_commons.rb

@@ -4,6 +4,10 @@
 module GRCommons
 end
 
+# Change the default encoding to UTF-8.
+ENV['GKS_ENCODING'] ||= 'utf8'
+
+require_relative 'search_shared_library'
 require_relative 'extern'
 require_relative 'define_methods'
 require_relative 'gr_common_utils'

data/lib/gr_commons/search_shared_library.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'pkg-config'
+
+module GRCommons
+  # This module helps GR, GR and GRM to search the shared library.
+  #
+  # The order of priority:
+  # 1. RubyInstaller ( for Windows only )
+  # 2. Environment variable GRDIR
+  # 3. pkg-config : https://github.com/ruby-gnome/pkg-config
+  # The following packages (should) support pkg-config.
+  # - Linux
+  #   - Red Data Tools https://github.com/red-data-tools/packages.red-data-tools.org
+  #     - libgr-dev
+  #     - libgr3-dev
+  #     - libgrm-dev
+  # - Mac
+  #   - Homebrew https://github.com/Homebrew/homebrew-core
+  #     - libgr
+  # - Windows
+  #   - MinGW https://github.com/msys2/MINGW-packages
+  #     - mingw-w64-gr
+  module SearchSharedLibrary
+    # Search the shared library.
+    # @note This method does not detect the Operating System.
+    #
+    # @param gr_lib_name [String] The actual file name of the shared library.
+    # @param pkg_name [String] The package name to be used when searching with pkg-configg
+    def search_shared_library(gr_lib_name, pkg_name)
+      # Windows + RubyInstaller
+      if Object.const_defined?(:RubyInstaller)
+        ENV['GRDIR'] ||= [
+          RubyInstaller::Runtime.msys2_installation.msys_path,
+          RubyInstaller::Runtime.msys2_installation.mingwarch
+        ].join(File::ALT_SEPARATOR)
+        recursive_search(gr_lib_name, ENV['GRDIR']).tap do |path|
+          RubyInstaller::Runtime.add_dll_directory(File.dirname(path))
+        end
+      # ENV['GRDIR'] (Linux, Mac, Windows)
+      elsif ENV['GRDIR']
+        begin
+          recursive_search(gr_lib_name, ENV['GRDIR'])
+        rescue StandardError => e
+          warn "\nWhile searching for #{gr_lib_name} in the directory specified " \
+               "in the GRDIR environment variable, ENV['GRDIR']=#{ENV['GRDIR']}, " \
+               "the following error occurred : #{e.message}"
+          pkg_config_search(gr_lib_name, pkg_name)
+        end
+      else
+        pkg_config_search(gr_lib_name, pkg_name)
+      end
+    end
+
+    def recursive_search(name, base_dir)
+      Dir.chdir(base_dir) do
+        if path = Dir["**/#{name}"].first # FIXME
+          File.expand_path(path)
+        else
+          raise StandardError "#{name} not found in #{base_dir}"
+        end
+      end
+    end
+
+    def pkg_config_search(gr_lib_name, pkg_name)
+      PKGConfig.variable(pkg_name, 'sopath')
+    rescue PackageConfig::NotFoundError => e
+      raise "#{e.message} Cannot find #{gr_lib_name}. " \
+            "Please Make sure that GR is installed and the environment ” \
+            ”variable GRDIR is set correctly."
+    end
+  end
+end

data/lib/gr_commons/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GRCommons
-  VERSION = '0.0.18'
+  VERSION = '0.0.23'
 end

data/lib/grm.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Check Fiddle version.
+require 'fiddle'
+
+# Check if fiddle supports variadic arguments.
+# Fiddle is a standard Gem and may not have VERSION constant.
+if !Fiddle.const_defined?(:VERSION) ||
+   (Gem::Version.new(Fiddle::VERSION) <= Gem::Version.new('1.0.0'))
+  raise LoadError, <<~MSG
+    Failed to load GRM module
+    Fiddle 1.0.1 or higher is required to run GRM.
+    See https://github.com/ruby/fiddle
+  MSG
+end
+
+module GRM
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :ffi_lib
+  end
+
+  require_relative 'gr_commons/gr_commons'
+  extend GRCommons::SearchSharedLibrary
+
+  # Platforms |  path
+  # Windows   |  bin/libGRM.dll
+  # MacOSX    |  lib/libGRM.so (NOT .dylib)
+  # Ubuntu    |  lib/libGRM.so
+  self.ffi_lib = case RbConfig::CONFIG['host_os']
+                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                   search_shared_library('libGRM.dll', 'grm')
+                 else
+                   search_shared_library('libGRM.so', 'grm')
+                 end
+
+  require_relative 'grm/version'
+  require_relative 'grm/ffi'
+  require_relative 'grm/grmbase'
+
+  # `inquiry` methods etc. are defined here.
+  extend GRCommons::GRCommonUtils
+
+  # `XXX` is the default type in GR.
+  # A Ruby array or NArray passed to GR method is automatically converted to
+  # a Fiddley::MemoryPointer in the GRBase class.
+  extend GRMBase
+
+  class << self
+  end
+end

data/lib/grm/ffi.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'fiddle/import'
+
+module GRM
+  # FFI Wrapper module for GRM.
+  # The functions for GRM are listed here.
+  # Add functions here when a new version of GR is released.
+  module FFI
+    extend Fiddle::Importer
+
+    begin
+      dlload GRM.ffi_lib
+    rescue LoadError
+      raise LoadError, 'Could not find GR Framework'
+    end
+
+    extend GRCommons::Extern
+
+    # Currently, the declarations of GRM functions are distributed in several
+    # header files.
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/args.h
+    try_extern 'grm_args_t *grm_args_new(void)'
+    try_extern 'void grm_args_delete(grm_args_t *args)'
+    try_extern 'int grm_args_push(grm_args_t *args, const char *key, const char *value_format, ...)'
+    try_extern 'int grm_args_push_buf(grm_args_t *args, const char *key, const char *value_format, const void *buffer, int apply_padding)'
+    try_extern 'int grm_args_contains(const grm_args_t *args, const char *keyword)'
+    try_extern 'void grm_args_clear(grm_args_t *args)'
+    try_extern 'void grm_args_remove(grm_args_t *args, const char *key)'
+    try_extern 'grm_args_ptr_t grm_length(double value, const char *unit)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/dump.h
+    try_extern 'void grm_dump(const grm_args_t *args, FILE *f)'
+    try_extern 'void grm_dump_json(const grm_args_t *args, FILE *f)'
+    try_extern 'char *grm_dump_json_str(void)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/event.h
+    try_extern 'int grm_register(grm_event_type_t type, grm_event_callback_t callback)'
+    try_extern 'int grm_unregister(grm_event_type_t type)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/interaction.h
+    try_extern 'int grm_input(const grm_args_t *input_args)'
+    try_extern 'int grm_get_box(const int x1, const int y1, const int x2, const int y2, const int keep_aspect_ratio, int *x, int *y, int *w, int *h)'
+    try_extern 'grm_input(const grm_args_t *input_args)'
+    try_extern 'grm_tooltip_info_t *grm_get_tooltip(const int, const int)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/net.h
+    try_extern 'void *grm_open(int is_receiver, const char *name, unsigned int id,
+                               const char *(*custom_recv)(const char *, unsigned int),
+                               int (*custom_send)(const char *, unsigned int, const char *))'
+    try_extern 'grm_args_t *grm_recv(const void *p, grm_args_t *args)'
+    try_extern 'int grm_send(const void *p, const char *data_desc, ...)'
+    try_extern 'int grm_send_buf(const void *p, const char *data_desc, const void *buffer, int apply_padding)'
+    try_extern 'int grm_send_ref(const void *p, const char *key, char format, const void *ref, int len)'
+    try_extern 'int grm_send_args(const void *p, const grm_args_t *args)'
+    try_extern 'void grm_close(const void *p)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/plot.h
+    try_extern 'void grm_finalize(void)'
+    try_extern 'int grm_clear(void)'
+    try_extern 'unsigned int grm_max_plotid(void)'
+    try_extern 'int grm_merge(const grm_args_t *args)'
+    try_extern 'int grm_merge_extended(const grm_args_t *args, int hold, const char *identificator)'
+    try_extern 'int grm_merge_hold(const grm_args_t *args)'
+    try_extern 'int grm_merge_named(const grm_args_t *args, const char *identificator)'
+    try_extern 'int grm_plot(const grm_args_t *args)'
+    try_extern 'int grm_switch(unsigned int id)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/util.h
+    try_extern 'FILE *grm_get_stdout(void)'
+  end
+end

data/lib/grm/grmbase.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GRM
+  # This module automatically converts Ruby arrays and Numo::Narray into
+  # Fiddley::MemoryPointer.
+  module GRMBase
+    extend GRCommons::DefineMethods
+    define_ffi_methods(FFI,
+                       prefix: 'grm_',
+                       default_type: :float) # FIXME!
+  end
+  private_constant :GRMBase
+end

data/lib/grm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GRM
+  VERSION = GRCommons::VERSION
+end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.23
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: histogram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: histogram
+  name: numo-narray
+  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'
+- !ruby/object:Gem::Dependency
+  name: pkg-config
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: numo-narray
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,7 +174,12 @@ files:
 - lib/gr_commons/gr_common_utils.rb
 - lib/gr_commons/gr_commons.rb
 - lib/gr_commons/jupyter_support.rb
+- lib/gr_commons/search_shared_library.rb
 - lib/gr_commons/version.rb
+- lib/grm.rb
+- lib/grm/ffi.rb
+- lib/grm/grmbase.rb
+- lib/grm/version.rb
 homepage: https://github.com/red-data-tools/GR.rb
 licenses:
 - MIT
@@ -160,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="