gmt 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bd263857b8e0886bb910ffeac0d6a69b29a2569
-  data.tar.gz: 81efc5d5c6d2caa706e90486102005a4febcfb00
+  metadata.gz: f1348e925157b856022bda1c2f6c83a848be3972
+  data.tar.gz: f935f6dab2efd89e6129b9846596adc72373fa06
 SHA512:
-  metadata.gz: d0cbd09d398bd8f9534ce68b72dc8b51bee0b13969fd2dd634ce8feed02c7063f59a237ec64eb8f1d35d762ff93a2696ce207b067d8192b594a6772c63d21773
-  data.tar.gz: 6a4a3314e51e2430a447168d2acce445bb654c452ea3591924ced674a3ed4570d861a0fc582d8302545331f6cff420f8d216645313f679fe4226150303025740
+  metadata.gz: bec6cdaf7e5fe4e47435154e10e3186fd019bf5d7aaacd18ebbc195eef642d476c3a5fdf2ef2c66a7afb2249af68da01503025c71d795ac02cbaa98a45aa6f1a
+  data.tar.gz: 5a90a50514f7715956e8e1e57bd0a4c8d6059341e98a9185b16d0e8af99bc756fd0bceca45035db6bd3753f30f180b890547196d19494f1ec770e422004eda95

data/ext/gmt/gmt.c

@@ -0,0 +1,124 @@
+#include <ruby.h>
+#include <gmt.h>
+
+#include "option.h"
+
+typedef struct
+{
+  void *session;
+} gmt_t;
+
+static void raise_unless_class_data(gmt_t *gmt)
+{
+  if (gmt == NULL)
+    rb_raise(rb_eRuntimeError, "failed fetch of GMT class data");
+}
+
+static void raise_if_error(int err, const char *module)
+{
+  if (err)
+    rb_raise(rb_eRuntimeError, "failed call to GMT module %s", module);
+}
+
+static VALUE gmt_simple(const char *name, int argc, VALUE *argv, VALUE self)
+{
+  VALUE files, opts;
+  rb_scan_args(argc, argv, "*:", &files, &opts);
+  if (TYPE(opts) == T_NIL) opts = rb_hash_new();
+
+  gmt_t *gmt;
+  Data_Get_Struct(self, gmt_t, gmt);
+  raise_unless_class_data(gmt);
+
+  void *session = gmt->session;
+
+  gmt_option_t *gmt_opts;
+  gmt_opts = ruby_hash_to_gmt_options(opts, session);
+  gmt_opts = append_inputs_to_gmt_options(files, gmt_opts, session);
+
+  int err = GMT_Call_Module(session, name, -1, gmt_opts);
+
+  GMT_Destroy_Options(session, &gmt_opts);
+  raise_if_error(err, name);
+
+  return Qtrue;
+}
+
+static VALUE gmt_makecpt(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("makecpt", argc, argv, self);
+}
+
+static VALUE gmt_pstext(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("pstext", argc, argv, self);
+}
+
+static VALUE gmt_psxy(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("psxy", argc, argv, self);
+}
+
+static void gmt_free(void *p)
+{
+  gmt_t *gmt = p;
+
+  if (gmt->session)
+    {
+      GMT_Destroy_Session(gmt->session);
+      gmt->session = NULL;
+    }
+}
+
+static VALUE gmt_alloc(VALUE klass)
+{
+  gmt_t *gmt;
+
+  VALUE obj = Data_Make_Struct(klass, gmt_t, NULL, gmt_free, gmt);
+
+  gmt->session = NULL;
+
+  return obj;
+}
+
+static VALUE gmt_init(VALUE self)
+{
+  gmt_t *gmt;
+
+  Data_Get_Struct(self, gmt_t, gmt);
+
+  gmt->session =
+    GMT_Create_Session("Session name", 2, 0, NULL);
+
+  if (gmt->session == NULL)
+    rb_raise(rb_eNoMemError, "failed to create GMT session");
+
+  return self;
+}
+
+static VALUE gmt_release(VALUE self)
+{
+  gmt_t *gmt;
+
+  Data_Get_Struct(self, gmt_t, gmt);
+
+  if (gmt->session)
+    {
+      GMT_Destroy_Session(gmt->session);
+      gmt->session = NULL;
+    }
+
+  return self;
+}
+
+void Init_gmt(void)
+{
+  VALUE cGMT = rb_const_get(rb_cObject, rb_intern("GMT"));
+
+  rb_define_alloc_func(cGMT, gmt_alloc);
+  rb_define_method(cGMT, "initialize", gmt_init, 0);
+  rb_define_method(cGMT, "free", gmt_release, 0);
+  rb_define_method(cGMT, "makecpt", gmt_makecpt, -1);
+  rb_define_method(cGMT, "pstext", gmt_pstext, -1);
+  rb_define_method(cGMT, "psxy", gmt_psxy, -1);
+}

data/ext/gmt/option.c

@@ -0,0 +1,161 @@
+/*
+  option.c
+
+  GMT expects arguments to be in a linked-list format and provides
+  some library support for creating these.  We here convert a hash
+  to this linked-list format.
+*/
+
+#include "option.h"
+
+typedef struct {
+  void *session;
+  gmt_option_t *gmt_opts;
+} rhtgo_cb_arg_t;
+
+static void rhtgo_cb_arg_free(void *arg){ };
+
+static VALUE rhtgo_cb_arg_class;
+
+static ID append_id(void)
+{
+  static ID cached = 0;
+
+  if (! cached)
+    cached = rb_intern(">>");
+
+  return cached;
+}
+
+static ID id_of_key(VALUE key)
+{
+  if (TYPE(key) != T_SYMBOL)
+    rb_raise(rb_eArgError, "option keys should be symbols");
+
+  return SYM2ID(key);
+}
+
+static char char_of_key_id(ID key_id)
+{
+  const char *key_s = rb_id2name(key_id);
+
+  if (key_s == NULL || *key_s == '\0')
+    rb_raise(rb_eRuntimeError, "problem getting name of option");
+
+  return *key_s;
+}
+
+static gmt_option_t* append_option(void *session,
+				   char option_name,
+				   const char *option_arg,
+				   gmt_option_t *gmt_opts)
+{
+  gmt_option_t *gmt_opt = GMT_Make_Option(session, option_name, option_arg);
+  return GMT_Append_Option(session, gmt_opt, gmt_opts);
+}
+
+static int rhtgo_cb(VALUE key, VALUE value, VALUE arg)
+{
+  rhtgo_cb_arg_t *rhtgo_cb_arg;
+
+  Data_Get_Struct(arg, rhtgo_cb_arg_t, rhtgo_cb_arg);
+
+  void *session = rhtgo_cb_arg->session;
+  gmt_option_t *gmt_opt, *gmt_opts = rhtgo_cb_arg->gmt_opts;
+
+  ID key_id = id_of_key(key);
+
+  if (key_id == append_id())
+    {
+      /*
+	the append key (>>) is a special case, since this needs to be converted
+	to the (option, argument) pair ('>', '>filename'), see the discussion at
+	http://gmt.soest.hawaii.edu/boards/1/topics/3665?r=3677
+      */
+
+      if (TYPE(value) != T_STRING)
+	rb_raise(rb_eArgError, "argument for >> option must be a string");
+
+      const char *filename = StringValueCStr(value);
+      size_t len = strlen(filename);
+      char option_arg[len+2];
+      snprintf(option_arg, len+2, ">%s", filename);
+
+      gmt_opts = append_option(session, '>', option_arg, gmt_opts);
+    }
+  else
+    {
+      char option_name = char_of_key_id(key_id);
+
+      switch (TYPE(value))
+	{
+	  const char *option_arg;
+
+	case T_STRING:
+	  option_arg = StringValueCStr(value);
+	  gmt_opts = append_option(session, option_name, option_arg, gmt_opts);
+	  break;
+
+	case T_NIL:
+	  gmt_opts = append_option(session, option_name, NULL, gmt_opts);
+	  break;
+
+	case T_ARRAY:
+	  for (size_t i = 0 ; i < RARRAY_LEN(value) ; i++)
+	    {
+	      VALUE item = RARRAY_PTR(value)[i];
+	      if (TYPE(item) != T_STRING)
+		rb_raise(rb_eArgError, "option arguments should be strings");
+	      option_arg = StringValueCStr(item);
+	      gmt_opts = append_option(session, option_name, option_arg, gmt_opts);
+	    }
+	  break;
+
+	default:
+	  rb_raise(rb_eArgError, "option arguments should be strings or arrays");
+	}
+    }
+
+  rhtgo_cb_arg->gmt_opts = gmt_opts;
+
+  return ST_CONTINUE;
+}
+
+extern gmt_option_t* ruby_hash_to_gmt_options(VALUE opts, void *session)
+{
+  gmt_option_t *gmt_opt, *gmt_opts = NULL;
+  rhtgo_cb_arg_t *rhtgo_cb_arg = ALLOC(rhtgo_cb_arg_t);
+
+  rhtgo_cb_arg->session = session;
+  rhtgo_cb_arg->gmt_opts = NULL;
+
+  VALUE arg =
+    Data_Wrap_Struct(rhtgo_cb_arg_class,
+		     NULL,
+		     rhtgo_cb_arg_free,
+		     rhtgo_cb_arg);
+
+
+  rb_hash_foreach(opts, rhtgo_cb, arg);
+
+  return rhtgo_cb_arg->gmt_opts;
+}
+
+extern gmt_option_t* append_inputs_to_gmt_options(VALUE files,
+						  gmt_option_t* gmt_opts,
+						  void *session)
+{
+  if (TYPE(files) != T_ARRAY)
+    rb_raise(rb_eArgError, "inputs should be an array");
+
+  for (size_t i = 0 ; i < RARRAY_LEN(files) ; i++)
+    {
+      VALUE file = RARRAY_PTR(files)[i];
+      if (TYPE(file) != T_STRING)
+	rb_raise(rb_eArgError, "each input should be a string");
+      const char *option_arg = StringValueCStr(file);
+      gmt_opts = append_option(session, '<', option_arg, gmt_opts);
+    }
+
+  return gmt_opts;
+}

data/ext/gmt/option.h

@@ -0,0 +1,20 @@
+/*
+  option.h
+
+  handle the conversion to GMT linked-list arguments
+
+  Copyright (c) J.J. Green 2016
+*/
+
+#ifndef OPTION_H
+#define OPTION_H
+
+#include <ruby.h>
+#include <gmt.h>
+
+typedef struct GMT_OPTION gmt_option_t;
+
+extern gmt_option_t* ruby_hash_to_gmt_options(VALUE, void*);
+extern gmt_option_t* append_inputs_to_gmt_options(VALUE, gmt_option_t*, void*);
+
+#endif

data/lib/gmt.rb

@@ -0,0 +1,20 @@
+class GMT
+
+  def self.psopt(file, position, options)
+    file_options =
+      case position
+      when :first
+        { :K => nil, :> => file }
+      when :middle
+        { :O => nil, :K => nil, :>> => file }
+      when :last
+        { :O => nil, :>> => file }
+      else
+        raise ArguemntError, 'position should be :first, :miidle or :last'
+      end
+    options.merge(file_options)
+  end
+
+end
+
+require 'gmt/gmt'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gmt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - J.J. Green
@@ -54,7 +54,9 @@ dependencies:
         version: '3.4'
 description: |
   A Ruby extension for the Generic Mapping Tools (GMT)
-  cartographic toolset (work-in-progress)
+  cartographic toolset (work-in-progress).
+
+  Requires the GMT5 development libraries.
 email: j.j.green@gmx.co.uk
 executables: []
 extensions:
@@ -62,6 +64,10 @@ extensions:
 extra_rdoc_files: []
 files:
 - ext/gmt/extconf.rb
+- ext/gmt/gmt.c
+- ext/gmt/option.c
+- ext/gmt/option.h
+- lib/gmt.rb
 homepage: https://github.com/jjgreen/ruby-gmt
 licenses:
 - MIT
@@ -70,6 +76,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="