proj4rb 4.1.0 → 5.0.0

data/lib/proj/options.rb

@@ -0,0 +1,41 @@
+module Proj
+  # Wraps a hash of key-value pairs as a null-terminated array of
+  # "KEY=VALUE" C string pointers suitable for PROJ option parameters.
+  #
+  # Many PROJ C API functions accept an optional array of "KEY=VALUE" strings
+  # to control their behavior. This class builds the required pointer array
+  # and keeps the underlying FFI memory alive so that the garbage collector
+  # cannot free it before the C call returns.
+  #
+  # @example
+  #   options = Proj::Options.new("MULTILINE": "YES", "INDENTATION_WIDTH": 4)
+  #   Api.proj_as_wkt(context, pj, :PJ_WKT2_2019, options)
+  class Options
+    # Creates a new Options instance.
+    #
+    # @param options [Hash{String, Symbol => String, Integer, nil}] Key-value pairs.
+    #   Entries with nil values are removed.
+    def initialize(options = {})
+      options = options.compact
+      @string_ptrs = options.map do |key, value|
+        FFI::MemoryPointer.from_string("#{key}=#{value}")
+      end
+
+      if @string_ptrs.empty?
+        @pointer = nil
+      else
+        @pointer = FFI::MemoryPointer.new(:pointer, options.size + 1)
+        # PROJ expects a NULL-terminated char* array.
+        @pointer.write_array_of_pointer(@string_ptrs + [FFI::Pointer::NULL])
+      end
+    end
+
+    # Returns the pointer to the null-terminated string array, or a
+    # NULL pointer if no options were provided.
+    #
+    # @return [FFI::Pointer]
+    def to_ptr
+      @pointer || FFI::Pointer::NULL
+    end
+  end
+end

data/lib/proj/parameter.rb

@@ -1,38 +1,38 @@
-module Proj
-  class Parameter
-    # @!attribute [r] name
-    #   @return [String] Param name
-    # @!attribute [r] auth_name
-    #   @return [String] Authority name
-    # @!attribute [r] code
-    #   @return [String] Authority code
-    # @!attribute [r] value
-    #   @return [String] Param value
-    # @!attribute [r] unit_conv_factor
-    #   @return [String] Param unit_conv_factor
-    # @!attribute [r] unit_name
-    #   @return [String] Param unit_name
-    # @!attribute [r] unit_type
-    #   @return [PJ_UNIT_TYPE] Unit type
-    attr_reader :name, :auth_name, :code, :value,
-                :unit_conv_factor, :unit_name, :unit_type
-
-    def initialize(name:, auth_name: nil, code: nil, value:, unit_conv_factor:, unit_name: nil, unit_type:)
-      @name = name
-      @auth_name = auth_name
-      @code = code
-      @value = value
-      @unit_conv_factor = unit_conv_factor
-      @unit_name = unit_name
-      @unit_type = unit_type
-    end
-
-    # Returns param information in PJ_PARAM_DESCRIPTION structure
-    #
-    # @return [PJ_PARAM_DESCRIPTION]
-    def to_description
-      Api::PJ_PARAM_DESCRIPTION.create(name: name, auth_name: auth_name, code: code, value: value,
-                                       unit_conv_factor: unit_conv_factor, unit_name: name, unit_type: unit_type)
-    end
-  end
+module Proj
+  class Parameter
+    # @!attribute [r] name
+    #   @return [String] Param name
+    # @!attribute [r] auth_name
+    #   @return [String] Authority name
+    # @!attribute [r] code
+    #   @return [String] Authority code
+    # @!attribute [r] value
+    #   @return [String] Param value
+    # @!attribute [r] unit_conv_factor
+    #   @return [String] Param unit_conv_factor
+    # @!attribute [r] unit_name
+    #   @return [String] Param unit_name
+    # @!attribute [r] unit_type
+    #   @return [PjUnitType] Unit type
+    attr_reader :name, :auth_name, :code, :value,
+                :unit_conv_factor, :unit_name, :unit_type
+
+    def initialize(name:, auth_name: nil, code: nil, value:, unit_conv_factor:, unit_name: nil, unit_type:)
+      @name = name
+      @auth_name = auth_name
+      @code = code
+      @value = value
+      @unit_conv_factor = unit_conv_factor
+      @unit_name = unit_name
+      @unit_type = unit_type
+    end
+
+    # Returns param information in PjParamDescription structure
+    #
+    # @return [PjParamDescription]
+    def to_description
+      Api::PjParamDescription.create(name: name, auth_name: auth_name, code: code, value: value,
+                                     unit_conv_factor: unit_conv_factor, unit_name: unit_name, unit_type: unit_type)
+    end
+  end
 end

data/lib/proj/parameters.rb

@@ -1,107 +1,106 @@
-# encoding: UTF-8
-module Proj
-  class Parameters
-    # @!visibility private
-    def self.finalize(pointer)
-      proc do
-        Api.proj_get_crs_list_parameters_destroy(pointer)
-      end
-    end
-
-    def initialize
-      pointer = Api.proj_get_crs_list_parameters_create
-      @params = Api::PROJ_CRS_LIST_PARAMETERS.new(pointer)
-      ObjectSpace.define_finalizer(self, self.class.finalize(pointer))
-    end
-
-    def to_ptr
-      @params.to_ptr
-    end
-    
-    def types
-      result = Array.new
-
-      unless @params[:types].null?
-        ints = @params[:types].read_array_of_int(@params[:types_count])
-        ints.each do |int|
-          result << Api::PJ_TYPE[int]
-        end
-      end
-      result
-    end
-
-    def types=(values)
-      ptr = FFI::MemoryPointer.new(:int, values.size)
-      ints = values.map {|symbol| Api::PJ_TYPE[symbol]}
-      ptr.write_array_of_int(ints)
-
-      @params[:types] = ptr
-      @params[:types_count] = values.size
-    end
-
-    def crs_area_of_use_contains_bbox
-      @params[:crs_area_of_use_contains_bbox]
-    end
-
-    def crs_area_of_use_contains_bbox=(value)
-      @params[:crs_area_of_use_contains_bbox] = value
-    end
-
-    def bbox_valid
-      @params[:bbox_valid] == 1 ? true : false
-    end
-
-    def bbox_valid=(value)
-      @params[:bbox_valid] = value ? 1 : 0
-    end
-
-    def west_lon_degree
-      @params[:west_lon_degree]
-    end
-
-    def west_lon_degree=(value)
-      @params[:west_lon_degree] = value
-    end
-
-    def south_lat_degree
-      @params[:south_lat_degree]
-    end
-
-    def south_lat_degree=(value)
-      @params[:south_lat_degree] = value
-    end
-
-    def east_lon_degree
-      @params[:east_lon_degree]
-    end
-
-    def east_lon_degree=(value)
-      @params[:east_lon_degree] = value
-    end
-
-    def north_lat_degree
-      @params[:north_lat_degree]
-    end
-
-    def north_lat_degree=(value)
-      @params[:north_lat_degree] = value
-    end
-
-    def allow_deprecated
-      @params[:allow_deprecated] == 1 ? true : false
-    end
-
-    def allow_deprecated=(value)
-      @params[:allow_deprecated] = value ? 1 : 0
-    end
-
-    def celestial_body_name
-      @params[:celestial_body_name].read_string_to_null
-    end
-
-    def celestial_body_name=(value)
-      ptr = FFI::MemoryPointer.from_string(value)
-      @params[:celestial_body_name] = ptr
-    end
-  end
-end
+# encoding: UTF-8
+module Proj
+  class Parameters
+    # @!visibility private
+    def self.finalize(params)
+      proc do
+        Api.proj_get_crs_list_parameters_destroy(params)
+      end
+    end
+
+    def initialize
+      @params = Api.proj_get_crs_list_parameters_create
+      ObjectSpace.define_finalizer(self, self.class.finalize(@params))
+    end
+
+    def to_ptr
+      @params.to_ptr
+    end
+    
+    def types
+      result = Array.new
+
+      unless @params[:types].null?
+        ints = @params[:types].read_array_of_int(@params[:types_count])
+        ints.each do |int|
+          result << Api::PjType[int]
+        end
+      end
+      result
+    end
+
+    def types=(values)
+      @types_ptr = FFI::MemoryPointer.new(:int, values.size)
+      ints = values.map {|symbol| Api::PjType[symbol]}
+      @types_ptr.write_array_of_int(ints)
+
+      @params[:types] = @types_ptr
+      @params[:types_count] = values.size
+    end
+
+    def crs_area_of_use_contains_bbox
+      @params[:crs_area_of_use_contains_bbox]
+    end
+
+    def crs_area_of_use_contains_bbox=(value)
+      @params[:crs_area_of_use_contains_bbox] = value
+    end
+
+    def bbox_valid
+      @params[:bbox_valid] == 1 ? true : false
+    end
+
+    def bbox_valid=(value)
+      @params[:bbox_valid] = value ? 1 : 0
+    end
+
+    def west_lon_degree
+      @params[:west_lon_degree]
+    end
+
+    def west_lon_degree=(value)
+      @params[:west_lon_degree] = value
+    end
+
+    def south_lat_degree
+      @params[:south_lat_degree]
+    end
+
+    def south_lat_degree=(value)
+      @params[:south_lat_degree] = value
+    end
+
+    def east_lon_degree
+      @params[:east_lon_degree]
+    end
+
+    def east_lon_degree=(value)
+      @params[:east_lon_degree] = value
+    end
+
+    def north_lat_degree
+      @params[:north_lat_degree]
+    end
+
+    def north_lat_degree=(value)
+      @params[:north_lat_degree] = value
+    end
+
+    def allow_deprecated
+      @params[:allow_deprecated] == 1 ? true : false
+    end
+
+    def allow_deprecated=(value)
+      @params[:allow_deprecated] = value ? 1 : 0
+    end
+
+    def celestial_body_name
+      @params[:celestial_body_name]
+    end
+
+    def celestial_body_name=(value)
+      @celestial_body_name = FFI::MemoryPointer.from_string(value)
+      @params.pointer.put_pointer(@params.offset_of(:celestial_body_name), @celestial_body_name)
+    end
+  end
+end

data/lib/proj/pj_axis_description.rb

@@ -0,0 +1,26 @@
+module Proj
+  module Api
+    class PjAxisDescription
+      attr_accessor :retained_ptrs
+
+      def self.create(name:, abbreviation:, direction:, unit_name:, unit_conv_factor:, unit_type:)
+        result = PjAxisDescription.new
+        result.retained_ptrs = []
+        result.put_string(:name, name)
+        result.put_string(:abbreviation, abbreviation)
+        result.put_string(:direction, direction)
+        result.put_string(:unit_name, unit_name)
+        result[:unit_conv_factor] = unit_conv_factor
+        result[:unit_type] = unit_type
+        result
+      end
+
+      # Write a string into a :string field and retain the pointer to prevent GC.
+      def put_string(field, value)
+        ptr = FFI::MemoryPointer.from_string(value)
+        @retained_ptrs << ptr
+        pointer.put_pointer(offset_of(field), ptr)
+      end
+    end
+  end
+end