ruby-gr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c233863f557d6d70810dbfef025d311444633b074163f3e894b01c0b9f54e52
-  data.tar.gz: c7e676efdb662b0ea85736d6b66c36e785f587f96961055c712743d79a716265
+  metadata.gz: 8fd375d6fbd9ef427ca5eeb0540bf83b456ade3dac53e48572df7b4c2b5f2466
+  data.tar.gz: 127c524864be21dac6bf57c07f61546208b95559f359edff61d82048b7e16ff9
 SHA512:
-  metadata.gz: 2e78037e8e9f2b824ec1f357e834367d696c28fce14732d1fad360c08a0005526cc757cb615d4779aa4d48d2cb05f0d853d849445c80ca7400425fc66c7b7329
-  data.tar.gz: 9ebf89a908f4141ef7a2616b7414d48616f2209e203193f8a61662cc4def5a27799425b9d5b6003f0f5ece500359c1416d64e8637ae4f1a5a3fedfddb4ee06c9
+  metadata.gz: 937b324d8199571ed75ac494889c6550bb35da07012f4770b23b37fe1b0aad0e853366c791bf1349fd96b531bf1292415925762271a8619e59aef6859ad7e6ab
+  data.tar.gz: 635b60aa7adc76b87bec35e11d419aaa402b49387b89b80534797b41f89ed8800fc3bb8e11321a6f4ea917ec2ff610c2e9c8b817ea13ed7091c78958bffdf078

data/README.md

@@ -2,6 +2,8 @@
 
 [![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg)](LICENSE.md)
 [![Build Status](https://travis-ci.com/kojix2/GR.rb.svg?&branch=master)](https://travis-ci.org/kojix2/GR.rb)
+[![Gem Version](https://badge.fury.io/rb/ruby-gr.svg)](https://badge.fury.io/rb/ruby-gr)
+[![Gitter chat](https://badges.gitter.im/kojix2/GR.rb.svg)](https://gitter.im/kojix2/GR.rb)
 
 [GR framework](https://github.com/sciapp/gr) - the graphics library for visualisation - for Ruby
 
@@ -37,8 +39,4 @@ GR.updatews
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/GR.rb.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/GR.rb.

data/lib/gr.rb

@@ -3,6 +3,8 @@
 require 'ffi'
 
 module GR
+  class Error < StandardError; end
+
   class << self
     attr_reader :ffi_lib
   end
@@ -11,7 +13,7 @@ module GR
   # Windows   |  bin/libgr.dll
   # MacOSX    |  lib/libGR.so (NOT .dylib)
   # Ubuntu    |  lib/libGR.so
-  raise 'Please set env variable GRDIR' unless ENV['GRDIR']
+  raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
 
   ENV['GKS_FONTPATH'] ||= ENV['GRDIR']
   @ffi_lib = case RbConfig::CONFIG['host_os']
@@ -21,18 +23,18 @@ module GR
              else
                File.expand_path('lib/libGR.so', ENV['GRDIR'])
              end
-end
 
-require_relative 'gr_commons'
-require 'gr/ffi'
-require 'gr/grbase'
+  require_relative 'gr_commons'
+  require_relative 'gr/ffi'
+  require_relative 'gr/grbase'
 
-module GR
   extend GRCommons::JupyterSupport
   extend GRBase
 
-  # 1. double is the default type
-  # 2. don't check size (for now)
+  # `double` is the default type in GR
+  # A Ruby array or NArray passed to GR method is automatically converted to
+  # a FFI::MemoryPointer in the GRBase class.
+
   class << self
     def inqdspsize
       inquiry %i[double double int int] do |*pts|
@@ -345,7 +347,7 @@ module GR
     end
   end
 
-  # Constants
+  # Constants - imported from GR.jl
 
   ASF_BUNDLED = 0
   ASF_INDIVIDUAL = 1

data/lib/gr/ffi.rb

@@ -6,20 +6,20 @@ module GR
   module FFI
     extend ::FFI::Library
 
-    ffi_lib GR.ffi_lib
+    begin
+      ffi_lib GR.ffi_lib
+    rescue LoadError => e
+      raise LoadError, 'Could not find GR Framework'
+    end
 
     extend GRCommons::AttachFunction
 
-    # https://github.com/sciapp/gr/blob/master/lib/gr/gr.c
+    # https://github.com/sciapp/gr/blob/master/lib/gr/gr.h
 
     attach_function :gr_initgr, %i[], :void
-
-    # gks - graphical kernel system
     attach_function :gr_opengks, %i[], :void
     attach_function :gr_closegks, %i[], :void
     attach_function :gr_inqdspsize, %i[pointer pointer pointer pointer], :void
-
-    # ws - workstation
     attach_function :gr_openws, %i[int string int], :void
     attach_function :gr_closews, %i[int], :void
     attach_function :gr_activatews, %i[int], :void
@@ -27,7 +27,6 @@ module GR
     attach_function :gr_configurews, %i[], :void
     attach_function :gr_clearws, %i[], :void
     attach_function :gr_updatews, %i[], :void
-
     attach_function :gr_polyline, %i[int pointer pointer], :void
     attach_function :gr_polymarker, %i[int pointer pointer], :void
     attach_function :gr_text, %i[double double string], :void
@@ -39,8 +38,6 @@ module GR
     attach_function :gr_gdp, %i[int pointer pointer int int pointer], :void
     attach_function :gr_spline, %i[int pointer pointer int int], :void
     attach_function :gr_gridit, %i[int pointer pointer pointer int int pointer pointer pointer], :void
-
-    # inq - inquiry
     attach_function :gr_setlinetype, %i[int], :void
     attach_function :gr_inqlinetype, %i[pointer], :void
     attach_function :gr_setlinewidth, %i[double], :void
@@ -50,10 +47,9 @@ module GR
     attach_function :gr_setmarkertype, %i[int], :void
     attach_function :gr_inqmarkertype, %i[pointer], :void
     attach_function :gr_setmarkersize, %i[double], :void
-    # gr_inqmarkersize is not implemented
+    # gr_inqmarkersize is not implemented.
     attach_function :gr_setmarkercolorind, %i[int], :void
     attach_function :gr_inqmarkercolorind, %i[pointer], :void
-
     attach_function :gr_settextfontprec, %i[int int], :void
     attach_function :gr_setcharexpan, %i[double], :void
     attach_function :gr_setcharspace, %i[double], :void
@@ -62,25 +58,21 @@ module GR
     attach_function :gr_setcharup, %i[double double], :void
     attach_function :gr_settextpath, %i[int], :void
     attach_function :gr_settextalign, %i[int int], :void
-
     attach_function :gr_setfillintstyle, %i[int], :void
     attach_function :gr_inqfillintstyle, %i[pointer], :void
     attach_function :gr_setfillstyle, %i[int], :void
     attach_function :gr_inqfillstyle, %i[pointer], :void
     attach_function :gr_setfillcolorind, %i[int], :void
     attach_function :gr_inqfillcolorind, %i[pointer], :void
-
     attach_function :gr_setcolorrep, %i[int double double double], :void
     attach_function :gr_setscale, %i[int], :int
     attach_function :gr_inqscale, %i[pointer], :void
-
     attach_function :gr_setwindow, %i[double double double double], :void
     attach_function :gr_inqwindow, %i[pointer pointer pointer pointer], :void
     attach_function :gr_setviewport, %i[double double double double], :void
     attach_function :gr_inqviewport, %i[pointer pointer pointer pointer], :void
     attach_function :gr_selntran, %i[int], :void
     attach_function :gr_setclip, %i[int], :void
-
     attach_function :gr_setwswindow, %i[double double double double], :void
     attach_function :gr_setwsviewport, %i[double double double double], :void
     attach_function :gr_createseg, %i[int], :void
@@ -94,22 +86,17 @@ module GR
     attach_function :gr_inqspace, %i[pointer pointer pointer pointer], :void
     attach_function :gr_textext, %i[double double string], :int
     attach_function :gr_inqtextext, %i[double double string pointer pointer], :void
-
-    # attach_function :gr_axeslbl
     attach_function :gr_axes, %i[double double double double int int double], :void
+    # attach_function :gr_axeslbl
     attach_function :gr_grid, %i[double double double double int int], :void
     attach_function :gr_grid3d, %i[double double double double double double int int int], :void
     attach_function :gr_verrorbars, %i[int pointer pointer pointer pointer], :void
     attach_function :gr_herrorbars, %i[int pointer pointer pointer pointer], :void
-
     attach_function :gr_polyline3d, %i[int pointer pointer pointer], :void
     attach_function :gr_polymarker3d, %i[int pointer pointer pointer], :void
     attach_function :gr_axes3d, %i[double double double double double double int int int double], :void
     attach_function :gr_titles3d, %i[string string string], :void
     attach_function :gr_surface, %i[int int pointer pointer pointer int], :void
-    attach_function :gr_trisurface, %i[int pointer pointer pointer], :void
-    attach_function :gr_gradient, %i[int int pointer pointer pointer pointer pointer], :void
-    attach_function :gr_quiver, %i[int int pointer pointer pointer pointer int], :void
     attach_function :gr_contour, %i[int int int pointer pointer pointer pointer int], :void
     attach_function :gr_contourf, %i[int int int pointer pointer pointer pointer int], :void
     attach_function :gr_tricontour, %i[int pointer pointer pointer int pointer], :void
@@ -122,8 +109,8 @@ module GR
     attach_function :gr_inqcolorfromrgb, %i[double double double], :int
     attach_function :gr_hsvtorgb, %i[double double double pointer pointer pointer], :void
     attach_function :gr_tick, %i[double double], :double
-
     attach_function :gr_validaterange, %i[double double], :int
+    attach_function :gr_adjustlimits, %i[pointer pointer], :void
     attach_function :gr_adjustrange, %i[pointer pointer], :void
     attach_function :gr_beginprint, %i[string], :void
     attach_function :gr_beginprintext, %i[string string string string], :void
@@ -139,12 +126,16 @@ module GR
     attach_function :gr_setarrowstyle, %i[int], :void
     attach_function :gr_setarrowsize, %i[double], :void
     attach_function :gr_drawarrow, %i[double double double double], :void
+    # attach_function :gr_readimage, %i[pointer pointer pointer pointer], :int
     attach_function :gr_drawimage, %i[double double double double int int pointer int], :void
+    # attach_function :gr_importgraphics, %i[string], :int
     attach_function :gr_setshadow, %i[double double double], :void
     attach_function :gr_settransparency, %i[double], :void
     attach_function :gr_setcoordxform, %i[pointer], :void
     attach_function :gr_begingraphics, %i[string], :void
     attach_function :gr_endgraphics, %i[], :void
+    # attach_function :gr_getgraphics
+    # attach_function :gr_drawgraphics
     attach_function :gr_mathtex, %i[double double string], :void
     attach_function :gr_inqmathtex, %i[double double string pointer pointer], :void
     attach_function :gr_beginselection, %i[int int], :void
@@ -160,10 +151,41 @@ module GR
     attach_function :gr_selectcontext, %i[int], :void
     attach_function :gr_destroycontext, %i[int], :void
     attach_function :gr_uselinespec, %i[string], :void
-    attach_function :gr_adjustlimits, %i[pointer pointer], :void
-    attach_function :gr_version, %i[], :pointer
-
+    # attach_function :gr_delaunay
     attach_function :gr_reducepoints, %i[int pointer pointer int pointer pointer], :void
+    attach_function :gr_trisurface, %i[int pointer pointer pointer], :void
+    attach_function :gr_gradient, %i[int int pointer pointer pointer pointer pointer], :void
+    attach_function :gr_quiver, %i[int int pointer pointer pointer pointer int], :void
+    # attach_function :gr_interp2
+
+    # gr_newmeta
+    # attach_function :gr_deletemeta
+    # attach_function :gr_finalizemeta
+    # attach_function :gr_meta_args_push
+    # attach_function :gr_meta_args_push_buf
+    # attach_function :gr_meta_args_contains
+    # attach_function :gr_meta_args_clear
+    # attach_function :gr_meta_args_remove
+    # attach_function :gr_meta_get_box
+    # attach_function :gr_openmeta
+    # attach_function :gr_recvmeta
+    # attach_function :gr_sendmeta
+    # attach_function :gr_sendmeta_buf
+    # attach_function :gr_sendmeta_ref
+    # attach_function :gr_sendmeta_args
+    # attach_function :gr_closemeta
+    # attach_function :gr_clearmeta
+    # attach_function :gr_inputmeta
+    # attach_function :gr_mergemeta
+    # attach_function :gr_plotmeta
+    # attach_function :gr_readmeta
+    # attach_function :gr_switchmeta
+    # attach_function :gr_registermeta
+    # attach_function :gr_unregistermeta
+    # attach_function :gr_meta_max_plotid
+    # attach_function :gr_dumpmeta
+    # attach_function :gr_dumpmeta_json
+    attach_function :gr_version, %i[], :pointer
     attach_function :gr_shadepoints, %i[int pointer pointer int int int], :void
     attach_function :gr_shadelines, %i[int pointer pointer int int int], :void
     attach_function :gr_panzoom, %i[double double double double pointer pointer pointer pointer], :void

data/lib/gr3.rb

@@ -3,6 +3,8 @@
 require 'ffi'
 
 module GR3
+  class Error < StandardError; end
+
   class << self
     attr_reader :ffi_lib
   end
@@ -11,7 +13,7 @@ module GR3
   # Windows   |  bin/libgr3.dll
   # MacOSX    |  lib/libGR3.so (NOT .dylib)
   # Ubuntu    |  lib/libGR3.so
-  raise 'Please set env variable GRDIR' unless ENV['GRDIR']
+  raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
 
   ENV['GKS_FONTPATH'] ||= ENV['GRDIR']
   @ffi_lib = case RbConfig::CONFIG['host_os']
@@ -21,18 +23,17 @@ module GR3
              else
                File.expand_path('lib/libGR3.so', ENV['GRDIR'])
              end
-end
 
-require_relative 'gr_commons'
-require 'gr3/ffi'
-require 'gr3/gr3base'
+  require_relative 'gr_commons'
+  require_relative 'gr3/ffi'
+  require_relative 'gr3/gr3base'
 
-module GR3
   extend GRCommons::JupyterSupport
   extend GR3Base
 
-  # 1. double is the default type
-  # 2. don't check size (for now)
+  # `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.
 
   module CheckError
     FFI.ffi_methods.each do |method|
@@ -95,6 +96,8 @@ module GR3
     end
   end
 
+  # Constants - imported from GR.jl
+
   IA_END_OF_LIST = 0
   IA_FRAMEBUFFER_WIDTH = 1
   IA_FRAMEBUFFER_HEIGHT = 2

data/lib/gr3/ffi.rb

@@ -6,71 +6,69 @@ module GR3
   module FFI
     extend ::FFI::Library
 
-    ffi_lib GR3.ffi_lib
+    begin
+      ffi_lib GR3.ffi_lib
+    rescue LoadError => e
+      raise LoadError, 'Could not find GR Framework'
+    end
 
     extend GRCommons::AttachFunction
 
-    # gr3.c
+    # https://github.com/sciapp/gr/blob/master/lib/gr3/gr3.h
 
     attach_function :gr3_init, %i[int], :int
-    attach_function :gr3_geterror, %i[int pointer pointer], :int
+    attach_function :gr3_free, %i[pointer], :void
     attach_function :gr3_terminate, %i[], :void
+    attach_function :gr3_geterror, %i[int pointer pointer], :int
+    attach_function :gr3_getrenderpathstring, %i[], :string
+    attach_function :gr3_geterrorstring, %i[int], :string
+    # callback :gr3_log_func, %i[string], :void
+    # attach_function :gr3_setlogcallback, %i[:gr3_log_func], :void
     attach_function :gr3_clear, %i[], :int
     attach_function :gr3_usecurrentframebuffer, %i[], :void
     attach_function :gr3_useframebuffer, %i[uint], :void
-    attach_function :gr3_setbackgroundcolor, %i[float float float float], :void
-    # getbackgroundcolor not implemented
+    attach_function :gr3_setquality, %i[int], :int
+    attach_function :gr3_getimage, %i[int int int pointer], :int
+    attach_function :gr3_export, %i[pointer int int], :int
+    attach_function :gr3_drawimage, %i[float float float float int int int], :int
     attach_function :gr3_createmesh_nocopy, %i[pointer int pointer pointer pointer], :int
     attach_function :gr3_createmesh, %i[pointer int pointer pointer pointer], :int
     attach_function :gr3_createindexedmesh_nocopy, %i[pointer int pointer pointer pointer int pointer], :int
     attach_function :gr3_createindexedmesh, %i[pointer int pointer pointer pointer int pointer], :int
     attach_function :gr3_drawmesh, %i[int int pointer pointer pointer pointer pointer], :void
     attach_function :gr3_deletemesh, %i[int], :void
-    attach_function :gr3_setlightdirection, %i[float float float], :void
     attach_function :gr3_cameralookat, %i[float float float float float float float float float], :void
     attach_function :gr3_setcameraprojectionparameters, %i[float float float], :int
     attach_function :gr3_getcameraprojectionparameters, %i[pointer pointer pointer], :int
-    attach_function :gr3_drawimage, %i[float float float float int int int], :int
-    attach_function :gr3_setquality, %i[int], :int
-    attach_function :gr3_getimage, %i[int int int pointer], :int
-    attach_function :gr3_export, %i[pointer int int], :int
-    attach_function :gr3_free, %i[pointer], :void
-    # callback :gr3_log_func, %i[string], :void
-    # attach_function :gr3_setlogcallback, %i[:gr3_log_func], :void
-    attach_function :gr3_geterrorstring, %i[int], :string
-    attach_function :gr3_getrenderpathstring, %i[], :string
+    attach_function :gr3_setlightdirection, %i[float float float], :void
+    attach_function :gr3_setbackgroundcolor, %i[float float float float], :void
+    # getbackgroundcolor not implemented
+    attach_function :gr3_createheightmapmesh, %i[pointer int int], :void
+    attach_function :gr3_drawheightmap, %i[pointer int int pointer pointer], :void
+    attach_function :gr3_drawconemesh, %i[int pointer pointer pointer pointer pointer], :void
+    attach_function :gr3_drawcylindermesh, %i[int pointer pointer pointer pointer pointer], :void
+    attach_function :gr3_drawspheremesh, %i[int pointer pointer pointer], :void
+    attach_function :gr3_drawcubemesh, %i[int pointer pointer pointer pointer pointer], :void
     attach_function :gr3_setobjectid, %i[int], :void
     attach_function :gr3_selectid, %i[int int int int pointer], :int
     attach_function :gr3_getviewmatrix, %i[pointer], :void
-    # attach_function :gr3_setviewmatrix, %i[pointer], :void
+    attach_function :gr3_setviewmatrix, %i[pointer], :void
     attach_function :gr3_getprojectiontype, %i[], :int
     attach_function :gr3_setprojectiontype, %i[int], :void
-
-    # gr3_gr.c
-
+    # attach_function gr3_triangulate
+    # %i[pointer ushort uint uint uint uint uint uint double double double double double double pointer], :void
+    # attach_function gr3_triangulateindexed
+    # %i[pointer ushort uint uint uint uint uint uint double double double double double double pointer pointer pointer pointer poiter], :void
+    # attach_function :gr3_createisosurfacemesh,
+    # %i[pointer pointer ushort uint uint uint uint uint uint double double double double double double], :int
     attach_function :gr3_createsurfacemesh, %i[pointer int int pointer pointer pointer int], :int
     attach_function :gr3_drawmesh_grlike, %i[int int pointer pointer pointer pointer pointer], :void
     attach_function :gr3_drawsurface, %i[int], :void
     # attach_function gr3_surface, %i[int int pointer pointer pointer int], :void
-    # attach_function gr3_drawtrianglesurface, %i[int pointer], :void
-    # attach_function gr_volume, %i[int int int pointer int pointer pointer], :void
-
-    # gr3_convenience.c
-
-    attach_function :gr3_drawcubemesh, %i[int pointer pointer pointer pointer pointer], :void
-    attach_function :gr3_drawcylindermesh, %i[int pointer pointer pointer pointer pointer], :void
-    attach_function :gr3_drawconemesh, %i[int pointer pointer pointer pointer pointer], :void
-    attach_function :gr3_drawspheremesh, %i[int pointer pointer pointer], :void
-    attach_function :gr3_drawheightmap, %i[pointer int int pointer pointer], :void
-    attach_function :gr3_createheightmapmesh, %i[pointer int int], :void
-    # attach_function :gr3_createisosurfacemesh,
-    # %i[pointer pointer ushort uint uint uint uint uint uint double double double double double double], :int
     attach_function :gr3_drawtubemesh, %i[int pointer pointer pointer int int], :int
+    # attach_function :gr3_createtubemesh, %i[pointer int pointer pointer pointer int int], :int
     # attach_function gr3_drawspins, %i[int pointer pointer pointer float float float float], :void
     # attach_function gr3_drawmolecule, %i[int pointer pointer pointer float pointer float], :void
-
-    # gr3_slices.c
-
     # attach_function gr3_createxslicemesh,
     # %i[pointer pointer uint uint uint uint uint uint uint double double double double double double], :void
     # attach_function gr3_createyslicemesh
@@ -83,12 +81,7 @@ module GR3
     # %i[pointer uint uint uint uint uint uint uint double double double double double double], :void
     # attach_function gr3_drawzslicemesh
     # %i[pointer uint uint uint uint uint uint uint double double double double double double], :void
-
-    # gr3_mc.c
-
-    # attach_function gr3_triangulateindexed
-    # %i[pointer ushort uint uint uint uint uint uint double double double double double double pointer pointer pointer pointer poiter], :void
-    # attach_function gr3_triangulate
-    # %i[pointer ushort uint uint uint uint uint uint double double double double double double pointer], :void
+    # attach_function gr3_drawtrianglesurface, %i[int pointer], :void
+    # attach_function gr_volume, %i[int int int pointer int pointer pointer], :void
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi