ruby-gr 0.0.1

data/lib/gr/ffi.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module GR
+  module FFI
+    extend ::FFI::Library
+
+    ffi_lib GR.ffi_lib
+
+    extend GRCommons::AttachFunction
+
+    # https://github.com/sciapp/gr/blob/master/lib/gr/gr.c
+
+    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
+    attach_function :gr_deactivatews, %i[int], :void
+    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
+    attach_function :gr_inqtext, %i[double double string pointer pointer], :void
+    attach_function :gr_fillarea, %i[int pointer pointer], :void
+    attach_function :gr_cellarray, %i[double double double double int int int int int int pointer], :void
+    attach_function :gr_nonuniformcellarray, %i[pointer pointer int int int int int int pointer], :void
+    attach_function :gr_polarcellarray, %i[double double double double double double int int int int int int pointer], :void
+    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
+    attach_function :gr_inqlinewidth, %i[pointer], :void
+    attach_function :gr_setlinecolorind, %i[int], :void
+    attach_function :gr_inqlinecolorind, %i[pointer], :void
+    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
+    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
+    attach_function :gr_settextcolorind, %i[int], :void
+    attach_function :gr_setcharheight, %i[double], :void
+    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
+    attach_function :gr_copysegws, %i[int], :void
+    attach_function :gr_redrawsegws, %i[], :void
+    attach_function :gr_setsegtran, %i[int double double double double double double double], :void
+    attach_function :gr_closeseg, %i[], :void
+    attach_function :gr_emergencyclosegks, %i[], :void
+    attach_function :gr_updategks, %i[], :void
+    attach_function :gr_setspace, %i[double double int int], :void
+    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_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
+    attach_function :gr_hexbin, %i[int pointer pointer int], :int
+    attach_function :gr_setcolormap, %i[int], :void
+    attach_function :gr_inqcolormap, %i[pointer], :void
+    attach_function :gr_setcolormapfromrgb, %i[int pointer pointer pointer pointer], :void
+    attach_function :gr_colorbar, %i[], :void
+    attach_function :gr_inqcolor, %i[int pointer], :void
+    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_adjustrange, %i[pointer pointer], :void
+    attach_function :gr_beginprint, %i[string], :void
+    attach_function :gr_beginprintext, %i[string string string string], :void
+    attach_function :gr_endprint, %i[], :void
+    attach_function :gr_ndctowc, %i[pointer pointer], :void
+    attach_function :gr_wctondc, %i[pointer pointer], :void
+    attach_function :gr_wc3towc, %i[pointer pointer pointer], :void
+    attach_function :gr_drawrect, %i[double double double double], :void
+    attach_function :gr_fillrect, %i[double double double double], :void
+    attach_function :gr_drawarc, %i[double double double double double double], :void
+    attach_function :gr_fillarc, %i[double double double double double double], :void
+    attach_function :gr_drawpath, %i[int pointer pointer int], :void
+    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_drawimage, %i[double double double double int int pointer int], :void
+    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_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
+    attach_function :gr_endselection, %i[], :void
+    attach_function :gr_moveselection, %i[double double], :void
+    attach_function :gr_resizeselection, %i[int double double], :void
+    attach_function :gr_inqbbox, %i[pointer pointer pointer pointer], :void
+    attach_function :gr_precision, %i[], :void
+    attach_function :gr_setregenflags, %i[int], :void
+    attach_function :gr_inqregenflags, %i[], :void
+    attach_function :gr_savestate, %i[], :void
+    attach_function :gr_restorestate, %i[], :void
+    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_reducepoints, %i[int pointer pointer int pointer pointer], :void
+    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
+    # attach_function :gr_findboundary
+  end
+end

data/lib/gr/grbase.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GR
+  module GRBase
+    extend GRCommons::DefineMethods
+    define_ffi_methods(FFI,
+                       prefix: 'gr_',
+                       default_type: :double)
+  end
+  private_constant :GRBase
+
+  extend GRCommons::GRCommonUtils
+end

data/lib/gr3.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module GR3
+  class << self
+    attr_reader :ffi_lib
+  end
+
+  # Platforms |  path
+  # Windows   |  bin/libgr3.dll
+  # MacOSX    |  lib/libGR3.so (NOT .dylib)
+  # Ubuntu    |  lib/libGR3.so
+  raise 'Please set env variable GRDIR' unless ENV['GRDIR']
+
+  ENV['GKS_FONTPATH'] ||= ENV['GRDIR']
+  @ffi_lib = case RbConfig::CONFIG['host_os']
+             when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+               File.expand_path('bin/libgr3.dll', ENV['GRDIR'])
+                   .gsub('/', '\\') # windows backslash
+             else
+               File.expand_path('lib/libGR3.so', ENV['GRDIR'])
+             end
+end
+
+require_relative 'gr_commons'
+require 'gr3/ffi'
+require 'gr3/gr3base'
+
+module GR3
+  extend GRCommons::JupyterSupport
+  extend GR3Base
+
+  # 1. double is the default type
+  # 2. don't check size (for now)
+
+  module CheckError
+    FFI.ffi_methods.each do |method|
+      method_name = method.to_s.sub(/^gr3_/, '')
+      next if method_name == 'geterror'
+
+      define_method(method_name) do |*args|
+        values = super(*args)
+        GR3Base.check_error
+        values
+      end
+    end
+  end
+  extend CheckError
+
+  class << self
+    def createmesh_nocopy(_n, vertices, normals, colors)
+      inquiry_int do |mesh|
+        super(mesh, vertices, normals, colors)
+      end
+    end
+
+    def createmesh(_n, vertices, normals, colors)
+      inquiry_int do |mesh|
+        super(mesh, vertices, normals, colors)
+      end
+    end
+
+    def createindexedmesh_nocopy(num_vertices, vertices, normals, colors, num_indices, indices)
+      inquiry_int do |mesh|
+        super(mesh, num_vertices, vertices, normals, colors, num_indices, indices)
+      end
+    end
+
+    def createindexedmesh(num_vertices, vertices, normals, colors, num_indices, indices)
+      inquiry_int do |mesh|
+        super(mesh, num_vertices, vertices, normals, colors, num_indices, indices)
+      end
+    end
+
+    def getimage(width, height, use_alpha = true)
+      bpp = use_alpha ? 4 : 3
+      inquiry(uint8: width * height * bpp) do |bitmap|
+        super(width, height, (use_alpha ? 1 : 0), bitmap)
+      end
+    end
+
+    # gr3_gr
+
+    def createsurfacemesh(nx, ny, px, py, pz, option = 0)
+      inquiry_int do |mesh|
+        super(mesh, nx, ny, px, py, pz, option)
+      end
+    end
+
+    # gr3_convenience
+
+    def drawtubemesh(n, points, colors, radii, num_steps = 10, num_segments = 20)
+      super(n, points, colors, radii, num_steps, num_segments)
+    end
+  end
+
+  IA_END_OF_LIST = 0
+  IA_FRAMEBUFFER_WIDTH = 1
+  IA_FRAMEBUFFER_HEIGHT = 2
+
+  ERROR_NONE = 0
+  ERROR_INVALID_VALUE = 1
+  ERROR_INVALID_ATTRIBUTE = 2
+  ERROR_INIT_FAILED = 3
+  ERROR_OPENGL_ERR = 4
+  ERROR_OUT_OF_MEM = 5
+  ERROR_NOT_INITIALIZED = 6
+  ERROR_CAMERA_NOT_INITIALIZED = 7
+  ERROR_UNKNOWN_FILE_EXTENSION = 8
+  ERROR_CANNOT_OPEN_FILE = 9
+  ERROR_EXPORT = 10
+
+  QUALITY_OPENGL_NO_SSAA  = 0
+  QUALITY_OPENGL_2X_SSAA  = 2
+  QUALITY_OPENGL_4X_SSAA  = 4
+  QUALITY_OPENGL_8X_SSAA  = 8
+  QUALITY_OPENGL_16X_SSAA = 16
+  QUALITY_POVRAY_NO_SSAA  = 0 + 1
+  QUALITY_POVRAY_2X_SSAA  = 2 + 1
+  QUALITY_POVRAY_4X_SSAA  = 4 + 1
+  QUALITY_POVRAY_8X_SSAA  = 8 + 1
+  QUALITY_POVRAY_16X_SSAA = 16 + 1
+
+  DRAWABLE_OPENGL = 1
+  DRAWABLE_GKS = 2
+
+  SURFACE_DEFAULT     =  0
+  SURFACE_NORMALS     =  1
+  SURFACE_FLAT        =  2
+  SURFACE_GRTRANSFORM =  4
+  SURFACE_GRCOLOR     =  8
+  SURFACE_GRZSHADED   = 16
+end

data/lib/gr3/ffi.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module GR3
+  module FFI
+    extend ::FFI::Library
+
+    ffi_lib GR3.ffi_lib
+
+    extend GRCommons::AttachFunction
+
+    # gr3.c
+
+    attach_function :gr3_init, %i[int], :int
+    attach_function :gr3_geterror, %i[int pointer pointer], :int
+    attach_function :gr3_terminate, %i[], :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_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_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_getprojectiontype, %i[], :int
+    attach_function :gr3_setprojectiontype, %i[int], :void
+
+    # gr3_gr.c
+
+    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_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
+    # %i[pointer pointer uint uint uint uint uint uint uint double double double double double double], :void
+    # attach_function gr3_createzslicemesh
+    # %i[pointer pointer uint uint uint uint uint uint uint double double double double double double], :void
+    # attach_function gr3_drawxslicemesh
+    # %i[pointer uint uint uint uint uint uint uint double double double double double double], :void
+    # attach_function gr3_drawyslicemesh
+    # %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
+  end
+end

data/lib/gr3/gr3base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GR3
+  module GR3Base
+    extend GRCommons::DefineMethods
+    define_ffi_methods(FFI,
+                       prefix: 'gr3_',
+                       default_type: :float)
+
+    def self.check_error
+      line = ::FFI::MemoryPointer.new(:int)
+      file = ::FFI::MemoryPointer.new(:string, 100)
+      e = FFI.gr3_geterror(1, line, file)
+      return if e == 0
+
+      mesg = FFI.gr3_geterrorstring(e)
+      raise "GR3 error #{file} #{line} #{mesg}"
+    end
+  end
+  private_constant :GR3Base
+
+  extend GRCommons::GRCommonUtils
+end

data/lib/gr_commons.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GRCommons
+end
+
+require 'gr_commons/attach_function'
+require 'gr_commons/define_methods'
+require 'gr_commons/gr_common_utils'
+require 'gr_commons/jupyter_support'