ruby-gr 0.0.13 → 0.0.18

data/lib/gr3.rb

@@ -2,43 +2,48 @@
 
 # OverView of GR.rb
 #
-#                            +--------------------+
-#     +-------------------+  | GR3 module         |
-#     | GR module         |  | +----------------+ |
-#     | +---------------+ |  | | GR3::FFI       | |
-#     | | GR::FFI       | |  | | +    libGR3.so | |
-#     | | +   libGR.so  | |  | +----------------+ |
-#     | +---------------+ |  |   | define_method  |
-#     |   | define_method |  | +----------------+ |
-#     | +---------------+ |  | | | GR3::GR3Base | |
-#     | | | GR::GRBase  | |  | | v  (Private)   | |
-#     | | v  (Private)  | |  | +++--------------+ |
-#     | +++-------------+ |  |  | Extend          |
-#     |  | Extend         |  |  v        +------+ |
-#     |  v                |  |           |Check | |
-#     |                   |  |        <--+Error | |
-#     +-------+-----------+  |           +------+ |
-#             ^              +---------+----------+
-#             |  +------------------+  ^
-#      Extend |  | GRCommons module |  | Extend
-#             |  | +--------------+ |  |
-#             |  | |    Fiddley   | |  |
-#             |  | +--------------+ |  |
-#             |  | +--------------+ |  |
-#             +----+ CommonUtils  +----+
-#             |  | +--------------+ |  |
-#             |  | +--------------+ |  |
-#             +----+    Version   +----+
-#             |  | +--------------+ |
-#             |  | +--------------+ |
-#             +----+JupyterSupport| |
-#                | +--------------+ |
-#                +------------------+
+#  +--------------------+  +--------------------+
+#  | GR module          |  | GR3 module         |
+#  | +----------------+ |  | +----------------+ |
+#  | | GR::FFI        | |  | | GR3::FFI       | |
+#  | | +   libGR.so   | |  | | +    libGR3.so | |
+#  | +----------------+ |  | +----------------+ |
+#  |   | define_method  |  |   | define_method  |
+#  | +----------------+ |  | +----------------+ |
+#  | | | GR::GRBase   | |  | | | GR3::GR3Base | |
+#  | | v  (Pri^ate)   | |  | | v  (Pri^ate)   | |
+#  | +++--------------+ |  | +++--------------+ |
+#  |  | Extend          |  |  | Extend          |
+#  |  v                 |  |  v       +-------+ |
+#  |      +-----------+ |  |          | Check | |
+#  |      | GR::Plot  | |  |       <--+ Error | |
+#  |      +-----------+ |  |          +-------+ |
+#  +--------------------+  +----------+---------+
+#            ^                        ^
+#            |  +------------------+  |
+#     Extend |  | GRCommons module |  | Extend
+#            |  | +--------------+ |  |
+#            |  | |    Fiddley   | |  |
+#            |  | +--------------+ |  |
+#            |  | +--------------+ |  |
+#            +----+ CommonUtils  +----+
+#            |  | +--------------+ |  |
+#            |  | +--------------+ |  |
+#            +----+    Version   +----+
+#            |  | +--------------+ |
+#            |  | +--------------+ |
+#            +----+JupyterSupport| |
+#               | +--------------+ |
+#               +------------------+
+#
+# (You can edit the above AA diagram with http://asciiflow.com/)
+#
+# Fiddley is Ruby-FFI compatible API layer for Fiddle.
 #
 # Why not GR::GR3?
 # * kojix2 did not want to force gr3 to be loaded when gr is loaded.
 # * kojix2 did not want to write `GR3 = GR::GR3` or something.
-# * This is a opinion of kojix2 and may be changed in the future.
+# * This is a opinion of kojix2 and may be changed by future maintainers.
 #
 # GR3 uses Numo::Narrray.
 # * It is difficult to write GR3 modules with only Ruby arrays.
@@ -55,20 +60,24 @@ module GR3
     attr_accessor :ffi_lib
   end
 
-  raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
   # 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
 
-  # change the default encoding to UTF-8
+  # change the default encoding to UTF-8.
   ENV['GKS_ENCODING'] ||= 'utf8'
 
   require_relative 'gr_commons/gr_commons'
@@ -76,12 +85,15 @@ module GR3
   require_relative 'gr3/ffi'
   require_relative 'gr3/gr3base'
 
-  # `float` is the default type in GR3
+  # `inquiry` methods etc. are defined here.
+  extend GRCommons::GRCommonUtils
+
+  # `float` is the default type in GR3.
   # A Ruby array or NArray passed to GR3 method is automatically converted to
-  # a FFI::MemoryPointer in the GR3Base class.
+  # a Fiddley::MemoryPointer in the GR3Base class.
   extend GR3Base
 
-  # This module is for adding error checking to all methods in GR3
+  # This module is for adding error checking to all methods in GR3.
   module CheckError
     def geterror
       line = GRCommons::Fiddley::MemoryPointer.new(:int)
@@ -113,8 +125,7 @@ module GR3
   extend CheckError
 
   # Now you can see a lot of methods just calling super here.
-  # Why? Do they really need?
-  # Yes. They are written to help the yard generate the documentation.
+  # They are written to help the yard generate the documentation.
   class << self
     # This method initializes the gr3 context.
     # @return [Integer]

data/lib/gr3/ffi.rb

@@ -3,7 +3,9 @@
 require 'fiddle/import'
 
 module GR3
-  # FFI Wrapper module for GR3
+  # FFI Wrapper module for GR3.
+  # The functions for GR3 are listed here.
+  # Add functions here when a new version of GR is released.
   module FFI
     extend Fiddle::Importer
 
@@ -16,8 +18,7 @@ module GR3
     extend GRCommons::Extern
 
     # https://github.com/sciapp/gr/blob/master/lib/gr3/gr3.h
-    # Order is important.
-
+    # keep same order
     try_extern 'int gr3_init(int *attrib_list)'
     try_extern 'void gr3_free(void *pointer)'
     try_extern 'void gr3_terminate(void)'
@@ -72,8 +73,17 @@ module GR3
     try_extern 'void gr3_setviewmatrix(const float *m)'
     try_extern 'int gr3_getprojectiontype(void)'
     try_extern 'void gr3_setprojectiontype(int type)'
-    # try_extern 'unsigned int gr3_triangulate(const unsigned short *data, unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, gr3_triangle_t **triangles_p)'
-    # try_extern 'void gr3_triangulateindexed(const unsigned short *data, unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, unsigned int *num_vertices, gr3_coord_t **vertices, gr3_coord_t **normals, unsigned int *num_indices, unsigned int **indices)'
+    # try_extern 'unsigned int gr3_triangulate(const unsigned short *data, ' \
+    #      'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
+    #      'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \
+    #      'double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, ' \
+    #      'gr3_triangle_t **triangles_p)'
+    # try_extern 'void gr3_triangulateindexed(const unsigned short *data, ' \
+    #      'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
+    #      'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \
+    #      'double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, ' \
+    #      'unsigned int *num_vertices, gr3_coord_t **vertices, gr3_coord_t **normals, ' \
+    #      'unsigned int *num_indices, unsigned int **indices)'
     try_extern 'int gr3_createisosurfacemesh(int *mesh, unsigned short *data, ' \
            'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
            'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \

data/lib/gr3/gr3base.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module GR3
-  # This module automatically converts Ruby arrays and Numo::Narray into pointers.
+  # This module automatically converts Ruby arrays and Numo::Narray into
+  # Fiddley::MemoryPointer.
   module GR3Base
     extend GRCommons::DefineMethods
     define_ffi_methods(FFI,
@@ -15,6 +16,4 @@ module GR3
                        default_type: :double)
   end
   private_constant :GR3Base
-
-  extend GRCommons::GRCommonUtils
 end

data/lib/gr_commons/define_methods.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module GRCommons
-  # This module adds methods to the GRBase and GR3Base modules.
+  # This module provides a way to add FFI methods to the GRBase and GR3Base modules.
   module DefineMethods
     private
 
     def define_ffi_methods(ffi_class, prefix: '', default_type: :double)
       ffi_class.ffi_methods.each do |method|
-        # delete_prefix (Ruby >= 2.5)
+        # Use delete_prefix (Ruby >= 2.5)
         method_name = method.to_s.sub(/^#{prefix}/, '')
 
         # FIXME: Refactoring required
@@ -16,9 +16,9 @@ module GRCommons
           args.map! do |arg|
             case arg
             when Array
-              send(default_type, arg)
+              GRCommons::GRCommonUtils.send(default_type, arg)
             when ->(x) { defined?(Numo::NArray) && x.is_a?(Numo::NArray) }
-              send(default_type, arg)
+              GRCommons::GRCommonUtils.send(default_type, arg)
             else
               arg
             end

data/lib/gr_commons/extern.rb

@@ -5,9 +5,10 @@ module GRCommons
   module Extern
     attr_reader :ffi_methods
 
+    # Improved extern method.
     # 1. Ignore functions that cannot be attached.
-    #    For compatiblity with older versions of GR.
     # 2. Available function (names) are stored in @ffi_methods.
+    # For compatiblity with older versions of GR.
     def try_extern(signature, *opts)
       @ffi_methods ||= []
       begin

data/lib/gr_commons/fiddley.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-# Fiddley v0.0.8
-# https://github.com/unak/fiddley
-#
-# Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
-#
-# Released under the 2-Clause BSD License.
-
-# NOTE: kojix2 added, removed, and modified several methods.
-
 require 'fiddle/import'
 
 module GRCommons
-  # Ruby-FFI compatible API layer for Fiddle.
+  # Fiddley v0.0.8 - Ruby-FFI compatible API layer for Fiddle
+  # https://github.com/unak/fiddley
+  #
+  # Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
+  #
+  # Released under the 2-Clause BSD License.
+  #
+  # 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.
 

data/lib/gr_commons/gr_common_utils.rb

@@ -5,7 +5,7 @@ require 'gr_commons/fiddley'
 module GRCommons
   # This module provides functionality common to GR and GR3.
   module GRCommonUtils
-    private
+    module_function
 
     def equal_length(*args)
       lengths = args.map(&:length)
@@ -17,34 +17,60 @@ module GRCommons
       lengths[0]
     end
 
+    # This constants is used in the test.
     SUPPORTED_TYPES = %i[uint8 uint16 int uint double float].freeze
 
-    # NOTE: The following method converts Ruby Array or NArray into packed string.
-    SUPPORTED_TYPES.each do |type|
-      define_method(type) do |data|
-        case data
-        when Array
-          data = data.flatten
-          Fiddley::Utils.array2str(type, data)
-        when ->(x) { narray?(x) }
-          case type
-          when :uint8
-            Numo::UInt8.cast(data).to_binary
-          when :uint16
-            Numo::UInt16.cast(data).to_binary
-          when :int
-            Numo::Int32.cast(data).to_binary
-          when :uint
-            Numo::UInt32.cast(data).to_binary
-          when :double
-            Numo::DFloat.cast(data).to_binary
-          when :float
-            Numo::SFloat.cast(data).to_binary
-          end
-        else
-          data = data.to_a.flatten
-          Fiddley::Utils.array2str(type, data)
-        end
+    # convert Ruby Array or NArray into packed string.
+    def uint8(data)
+      if narray?(data)
+        Numo::UInt8.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:uint8, data.to_a.flatten)
+      end
+    end
+
+    # convert Ruby Array or NArray into packed string.
+    def uint16(data)
+      if narray?(data)
+        Numo::UInt16.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:uint16, data.to_a.flatten)
+      end
+    end
+
+    # convert Ruby Array or NArray into packed string.
+    def int(data)
+      if narray?(data)
+        Numo::Int32.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:int32, data.to_a.flatten)
+      end
+    end
+
+    # convert Ruby Array or NArray into packed string.
+    def uint(data)
+      if narray?(data)
+        Numo::UInt32.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:uint, data.to_a.flatten)
+      end
+    end
+
+    # convert Ruby Array or NArray into packed string.
+    def double(data)
+      if narray?(data)
+        Numo::DFloat.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:double, data.to_a.flatten)
+      end
+    end
+
+    # convert Ruby Array or NArray into packed string.
+    def float(data)
+      if narray?(data)
+        Numo::SFloat.cast(data).to_binary
+      else
+        Fiddley::Utils.array2str(:float, data.to_a.flatten)
       end
     end
 

data/lib/gr_commons/gr_commons.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Module with common code for GR, GR3
+# Module with common code for GR, GR3.
 module GRCommons
 end
 

data/lib/gr_commons/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.18
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,8 @@ files:
 homepage: https://github.com/red-data-tools/GR.rb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  msys2_mingw_dependencies: gr
 post_install_message: 
 rdoc_options: []
 require_paths: