ffi-gdal 1.0.0.beta5 → 1.0.0.beta6

data/lib/ogr/spatial_reference_mixins/coordinate_system_getter_setters.rb

@@ -10,7 +10,7 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :local_cs=, :set_local_cs
+      alias local_cs= set_local_cs
 
       # Set the user-visible PROJCS name.
       #
@@ -21,7 +21,7 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :proj_cs=, :set_proj_cs
+      alias proj_cs= set_proj_cs
 
       # Set the user-visible PROJCS name.
       #
@@ -32,7 +32,7 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :geoc_cs=, :set_geoc_cs
+      alias geoc_cs= set_geoc_cs
 
       # Set the GEOGCS based on a well-known name.
       #
@@ -45,7 +45,7 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :well_known_geog_cs=, :set_well_known_geog_cs
+      alias well_known_geog_cs= set_well_known_geog_cs
 
       # @param definition [String]
       def set_from_user_input(definition)
@@ -71,9 +71,7 @@ module OGR
       # @param z_rotation [Float] (In arc seconds.)
       # @param scaling_factor [Float] (In parts-per-million.)
       def set_towgs84(x_distance: nil, y_distance: nil, z_distance: nil,
-                      x_rotation: 0.0, y_rotation: 0.0, z_rotation: 0.0,
-                      scaling_factor: 0.0)
-
+        x_rotation: 0.0, y_rotation: 0.0, z_rotation: 0.0, scaling_factor: 0.0)
         ogr_err = FFI::OGR::SRSAPI.OSRSetTOWGS84(
           @c_pointer,
           x_distance, y_distance, z_distance,
@@ -216,7 +214,7 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :projection=, :set_projection
+      alias projection= set_projection
 
       # @param param_name [String]
       # @param value [Float]
@@ -264,7 +262,7 @@ module OGR
           case hemisphere
           when :north then 1
           when :south then 0
-          else fail "Unknown hemisphere type #{hemisphere}. Please choose :north or :south."
+          else raise "Unknown hemisphere type #{hemisphere}. Please choose :north or :south."
           end
         north_ptr = FFI::MemoryPointer.new(:bool)
         north_ptr.write_bytes(north.to_s)
@@ -298,156 +296,156 @@ module OGR
       end
 
       def set_albers_conic_equal_area
-        fail NotImplementedError
+        raise NotImplementedError
       end
-      alias_method :set_acea, :set_albers_conic_equal_area
+      alias set_acea set_albers_conic_equal_area
 
       def set_ae
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_bonne
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_cea
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_cs
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_ec
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_eckert
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_eckert_iv
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_eckert_vi
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_equirectangular
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_equirectangular2
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_gc
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_gh
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_igh
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_geos
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_gauss_schreiber_transverse_mercator
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_gnomonic
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_om
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_hom
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_hom_2_pno
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_iwm_polyconic
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_krovak
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_laea
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_lcc
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_lcc_1sp
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_lccb
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_mc
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_mercator
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_mollweide
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_nzmg
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_os
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_orthographic
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_polyconic
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_ps
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_robinson
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_sinusoidal
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_stereographic
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_soc
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       # @param center_lat [Float]
@@ -464,30 +462,30 @@ module OGR
 
         ogr_err.handle_result
       end
-      alias_method :set_tm, :set_transverse_mercator
+      alias set_tm set_transverse_mercator
 
       def set_tm_variant
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_tmg
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_tmso
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_vdg
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_wagner
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def set_qsc
-        fail NotImplementedError
+        raise NotImplementedError
       end
     end
   end

data/lib/ogr/spatial_reference_mixins/exporters.rb

@@ -8,8 +8,7 @@ module OGR
         datum_name = FFI::MemoryPointer.new(:string)
         units = FFI::MemoryPointer.new(:string)
 
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToERM(@c_pointer, projection_name,
-          datum_name, units)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToERM(@c_pointer, projection_name, datum_name, units)
         ogr_err.handle_result 'Required parameters (name, datum name, units) are not defined'
 
         {
@@ -21,12 +20,8 @@ module OGR
 
       # @return [Array<String>]
       def to_mapinfo
-        return_ptr = FFI::MemoryPointer.new(:string)
-        return_ptr_ptr = FFI::MemoryPointer.new(:pointer)
-        return_ptr_ptr.write_pointer(return_ptr)
-
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToMICoordSys(@c_pointer,
-          return_ptr_ptr)
+        return_ptr_ptr = GDAL._pointer_pointer(:string)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToMICoordSys(@c_pointer, return_ptr_ptr)
         ogr_err.handle_result
 
         return_ptr_ptr.get_array_of_string(0)
@@ -34,20 +29,11 @@ module OGR
 
       # @return [Hash]
       def to_pci
-        proj = FFI::MemoryPointer.new(:string)
-        proj_ptr = FFI::MemoryPointer.new(:pointer)
-        proj_ptr.write_pointer(proj)
-
-        units = FFI::MemoryPointer.new(:string)
-        units_ptr = FFI::MemoryPointer.new(:pointer)
-        units_ptr.write_pointer(units)
-
-        prj_params = FFI::MemoryPointer.new(:double)
-        prj_params_ptr = FFI::MemoryPointer.new(:pointer)
-        prj_params_ptr.write_pointer(prj_params)
+        proj_ptr = GDAL._pointer_pointer(:string)
+        units_ptr = GDAL._pointer_pointer(:string)
+        prj_params_ptr = GDAL._pointer_pointer(:double)
 
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToPCI(@c_pointer, proj_ptr,
-          units_ptr, prj_params_ptr)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToPCI(@c_pointer, proj_ptr, units_ptr, prj_params_ptr)
         ogr_err.handle_result
 
         {
@@ -60,14 +46,11 @@ module OGR
       # @return [String]
       # @raise [GDAL::UnsupportedOperation] If empty definition.
       def to_proj4
-        proj4 = FFI::MemoryPointer.new(:string)
-        proj4_ptr = FFI::MemoryPointer.new(:pointer)
-        proj4_ptr.write_pointer(proj4)
-
+        proj4_ptr = GDAL._pointer_pointer(:string)
         ogr_err = FFI::OGR::SRSAPI.OSRExportToProj4(@c_pointer, proj4_ptr)
         ogr_err.handle_result
 
-        proj4_ptr.read_pointer.read_string
+        GDAL._read_pointer_pointer_safely(proj4_ptr, :string)
       end
 
       # @return [Hash]
@@ -75,12 +58,9 @@ module OGR
         proj_sys = FFI::MemoryPointer.new(:long)
         zone = FFI::MemoryPointer.new(:long)
         datum = FFI::MemoryPointer.new(:long)
-        prj_params = FFI::MemoryPointer.new(:double)
-        prj_params_ptr = FFI::MemoryPointer.new(:pointer)
-        prj_params_ptr.write_pointer(prj_params)
+        prj_params_ptr = GDAL._pointer_pointer(:double)
 
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToUSGS(@c_pointer, proj_sys,
-          zone, prj_params_ptr, datum)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToUSGS(@c_pointer, proj_sys, zone, prj_params_ptr, datum)
         ogr_err.handle_result
 
         {
@@ -93,38 +73,27 @@ module OGR
 
       # @return [String]
       def to_wkt
-        wkt_ptr = FFI::MemoryPointer.new(:string)
-        wkt_ptr_ptr = FFI::MemoryPointer.new(:pointer)
-        wkt_ptr_ptr.write_pointer(wkt_ptr)
-
+        wkt_ptr_ptr = GDAL._pointer_pointer(:string)
         ogr_err = FFI::OGR::SRSAPI.OSRExportToWkt(@c_pointer, wkt_ptr_ptr)
         ogr_err.handle_result
 
-        wkt_ptr_ptr.read_pointer.read_string
+        GDAL._read_pointer_pointer_safely(wkt_ptr_ptr, :string)
       end
 
       # @param simplify [Boolean] +true+ strips off +AXIS+, +AUTHORITY+ and
       #   +EXTENSION+ nodes.
       def to_pretty_wkt(simplify = false)
-        wkt_ptr = FFI::MemoryPointer.new(:string)
-        wkt_ptr_ptr = FFI::MemoryPointer.new(:pointer)
-        wkt_ptr_ptr.write_pointer(wkt_ptr)
-
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToPrettyWkt(@c_pointer,
-          wkt_ptr_ptr, simplify)
+        wkt_ptr_ptr = GDAL._pointer_pointer(:string)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToPrettyWkt(@c_pointer, wkt_ptr_ptr, simplify)
         ogr_err.handle_result
 
-        wkt_ptr_ptr.read_pointer.read_string
+        GDAL._read_pointer_pointer_safely(wkt_ptr_ptr, :string)
       end
 
       # @return [String]
       def to_xml(dialect = nil)
-        xml_ptr = FFI::MemoryPointer.new(:string)
-        xml_ptr_ptr = FFI::MemoryPointer.new(:pointer)
-        xml_ptr_ptr.write_pointer(xml_ptr)
-
-        ogr_err = FFI::OGR::SRSAPI.OSRExportToXML(@c_pointer, xml_ptr_ptr,
-          dialect)
+        xml_ptr_ptr = GDAL._pointer_pointer(:string)
+        ogr_err = FFI::OGR::SRSAPI.OSRExportToXML(@c_pointer, xml_ptr_ptr, dialect)
         ogr_err.handle_result
 
         xml_ptr_ptr.get_array_of_string(0).join

data/lib/ogr/spatial_reference_mixins/parameter_getter_setters.rb

@@ -22,13 +22,10 @@ module OGR
       #   of the unit type ("degree" or "radian").  +value+ is the number to
       #   multiply angular distances to transform them to radians.
       def angular_units
-        name = FFI::MemoryPointer.new(:string)
-        name_ptr = FFI::MemoryPointer.new(:pointer)
-        name_ptr.write_pointer(name)
-
+        name_ptr = GDAL._pointer_pointer(:string)
         value = FFI::OGR::SRSAPI.OSRGetAngularUnits(@c_pointer, name_ptr)
 
-        { unit_name: name_ptr.read_pointer.read_string, value: value }
+        { unit_name: GDAL._read_pointer_pointer_safely(name_ptr, :string), value: value }
       end
 
       # @param unit_label [String]
@@ -44,13 +41,10 @@ module OGR
       #   of the unit type (e.g. "Meters"). +value+ is the number to multiply
       #   linear distances to transform them to meters.
       def linear_units
-        name = FFI::MemoryPointer.new(:string)
-        name_ptr = FFI::MemoryPointer.new(:pointer)
-        name_ptr.write_pointer(name)
-
+        name_ptr = GDAL._pointer_pointer(:string)
         value = FFI::OGR::SRSAPI.OSRGetLinearUnits(@c_pointer, name_ptr)
 
-        { unit_name: name_ptr.read_pointer.read_string, value: value }
+        { unit_name: GDAL._read_pointer_pointer_safely(name_ptr, :string), value: value }
       end
 
       # @param unit_label [String]
@@ -69,9 +63,7 @@ module OGR
       # @param transform_to_meters [Float] The value to multiply a length to
       #   transform the value to meters.
       def set_linear_units_and_update_parameters(unit_label, transform_to_meters)
-        ogr_err = FFI::OGR::SRSAPI.OSRSetLinearUnitsAndUpdateParameters(
-          @c_pointer,
-          unit_label,
+        ogr_err = FFI::OGR::SRSAPI.OSRSetLinearUnitsAndUpdateParameters(@c_pointer, unit_label,
           transform_to_meters.to_f)
 
         ogr_err.handle_result
@@ -82,13 +74,10 @@ module OGR
       # @param target_key [String] I.e. "PROJCS" or "VERT_CS".
       # @return [Hash]
       def target_linear_units(target_key)
-        name = FFI::MemoryPointer.new(:string)
-        name_ptr = FFI::MemoryPointer.new(:pointer)
-        name_ptr.write_pointer(name)
-
+        name_ptr = GDAL._pointer_pointer(:string)
         value = FFI::OGR::SRSAPI.OSRGetTargetLinearUnits(@c_pointer, target_key, name_ptr)
 
-        { unit_name: name_ptr.read_pointer.read_string, value: value }
+        { unit_name: GDAL._read_pointer_pointer_safely(name_ptr, :string), value: value }
       end
 
       # @param target_key [String] The keyword to set linear units for ("PROJCS",
@@ -97,25 +86,17 @@ module OGR
       # @param transform_to_meters [Float] The value to multiple a length to
       #   transform the value to meters.
       def set_target_linear_units(target_key, unit_label, transform_to_meters)
-        ogr_err = FFI::OGR::SRSAPI.OSRSetTargetLinearUnits(
-          @c_pointer,
-          target_key,
-          unit_label,
-          transform_to_meters
-        )
+        ogr_err = FFI::OGR::SRSAPI.OSRSetTargetLinearUnits(@c_pointer, target_key, unit_label, transform_to_meters)
 
         ogr_err.handle_result
       end
 
       # @return [Hash]
       def prime_meridian
-        pm = FFI::MemoryPointer.new(:string)
-        pm_ptr = FFI::MemoryPointer.new(:pointer)
-        pm_ptr.write_pointer(pm)
-
+        pm_ptr = GDAL._pointer_pointer(:string)
         value = FFI::OGR::SRSAPI.OSRGetPrimeMeridian(@c_pointer, pm_ptr)
 
-        { name: pm_ptr.read_pointer.read_string, value: value }
+        { name: GDAL._read_pointer_pointer_safely(pm_ptr, :string), value: value }
       end
     end
   end

data/lib/ogr/style_table.rb

@@ -1,4 +1,4 @@
-require_relative '../ffi/ogr'
+require_relative '../ogr'
 require_relative 'style_table_extensions'
 
 module OGR
@@ -12,7 +12,7 @@ module OGR
     def initialize(c_pointer = nil)
       @c_pointer = c_pointer ? c_pointer : FFI::OGR::API.OGR_STBL_Create
 
-      fail 'Unable to create StyleTable' if @c_pointer.null?
+      raise 'Unable to create StyleTable' if @c_pointer.null?
     end
 
     def destroy!

data/lib/ogr/style_table_extensions.rb

@@ -10,7 +10,9 @@ module OGR
       styles = {}
       reset_style_string_reading
 
-      while style = next_style
+      loop do
+        style = next_style
+        break unless style
         styles[last_style_name] = style
       end
 

data/lib/ogr/style_tool.rb

@@ -1,4 +1,4 @@
-require_relative '../ffi/ogr'
+require_relative '../ogr'
 
 module OGR
   class StyleTool
@@ -11,7 +11,7 @@ module OGR
       @c_pointer = FFI::OGR::API.OGR_ST_Create(style_tool_class)
       return if @c_pointer && !@c_pointer.null?
 
-      fail OGR::CreateFailure, "Unable to create StyleTool using class #{style_tool_class}"
+      raise OGR::CreateFailure, "Unable to create StyleTool using class #{style_tool_class}"
     end
 
     # @return [String, nil]
@@ -43,14 +43,14 @@ module OGR
 
       value_is_null_ptr.read_int.to_bool ? nil : value
     end
-    alias_method :param_as_float, :param_as_double
+    alias param_as_float param_as_double
 
     # @param param_number [Fixnum]
     # @param value [Float]
     def set_param_as_double(param_number, value)
       FFI::OGR::API.OGR_ST_SetParamDbl(@c_pointer, param_number, value)
     end
-    alias_method :set_param_as_float, :set_param_as_double
+    alias set_param_as_float set_param_as_double
 
     # @param param_number [Fixnum]
     # @return [Fixnum, nil]
@@ -60,14 +60,14 @@ module OGR
 
       value_is_null_ptr.read_int.to_bool ? nil : value
     end
-    alias_method :param_as_integer, :param_as_number
+    alias param_as_integer param_as_number
 
     # @param param_number [Fixnum]
     # @param value [Fixnum]
     def set_param_as_number(param_number, value)
       FFI::OGR::API.OGR_ST_SetParamNum(@c_pointer, param_number, value)
     end
-    alias_method :set_param_as_integer, :set_param_as_number
+    alias set_param_as_integer set_param_as_number
 
     # @param param_number [Fixnum]
     # @return [String, nil]
@@ -94,14 +94,8 @@ module OGR
       blue_ptr = FFI::MemoryPointer.new(:int)
       alpha_ptr = FFI::MemoryPointer.new(:int)
 
-      boolean_result = FFI::OGR::API.OGR_ST_GetRGBFromString(
-        @c_pointer,
-        color_string,
-        red_ptr,
-        green_ptr,
-        blue_ptr,
-        alpha_ptr
-      )
+      boolean_result = FFI::OGR::API.OGR_ST_GetRGBFromString(@c_pointer,
+        color_string, red_ptr, green_ptr, blue_ptr, alpha_ptr)
 
       if boolean_result
         {

data/lib/ogr.rb

@@ -1,8 +1,46 @@
-require_relative 'ffi/ogr'
+require_relative 'ffi-gdal'
 require_relative 'ogr/internal_helpers'
+require_relative 'ogr/exceptions'
 
 module OGR
   include InternalHelpers
 
   FFI::OGR::API.OGRRegisterAll
+
+  def self.ogr_require(path)
+    File.expand_path(path, __dir__)
+  end
+
+  # Autoload OGR Geometry object types.
+  autoload :GeometryCollection,     ogr_require('ogr/geometries/geometry_collection')
+  autoload :GeometryCollection25D,  ogr_require('ogr/geometries/geometry_collection_25d')
+  autoload :LineString,             ogr_require('ogr/geometries/line_string')
+  autoload :LineString25D,          ogr_require('ogr/geometries/line_string_25d')
+  autoload :LinearRing,             ogr_require('ogr/geometries/linear_ring')
+  autoload :MultiLineString,        ogr_require('ogr/geometries/multi_line_string')
+  autoload :MultiLineString25D,     ogr_require('ogr/geometries/multi_line_string_25d')
+  autoload :MultiPoint,             ogr_require('ogr/geometries/multi_point')
+  autoload :MultiPoint25D,          ogr_require('ogr/geometries/multi_point_25d')
+  autoload :MultiPolygon,           ogr_require('ogr/geometries/multi_polygon')
+  autoload :MultiPolygon25D,        ogr_require('ogr/geometries/multi_polygon_25d')
+  autoload :NoneGeometry,           ogr_require('ogr/geometries/none_geometry')
+  autoload :Point,                  ogr_require('ogr/geometries/point')
+  autoload :Point25D,               ogr_require('ogr/geometries/point_25d')
+  autoload :Polygon,                ogr_require('ogr/geometries/polygon')
+  autoload :Polygon25D,             ogr_require('ogr/geometries/polygon_25d')
+  autoload :UnknownGeometry,        ogr_require('ogr/geometries/unknown_geometry')
+
+  # Autoload core OGR types
+  autoload :CoordinateTransformation, ogr_require('ogr/coordinate_transformation')
+  autoload :DataSource,               ogr_require('ogr/data_source')
+  autoload :Driver,                   ogr_require('ogr/driver')
+  autoload :Envelope,                 ogr_require('ogr/envelope')
+  autoload :Feature,                  ogr_require('ogr/feature')
+  autoload :FeatureDefinition,        ogr_require('ogr/feature_definition')
+  autoload :FieldDefinition,          ogr_require('ogr/field_definition')
+  autoload :Geometry,                 ogr_require('ogr/geometry')
+  autoload :GeometryFieldDefinition,  ogr_require('ogr/geometry_field_definition')
+  autoload :Layer,                    ogr_require('ogr/layer')
+  autoload :SpatialReference,         ogr_require('ogr/spatial_reference')
+  autoload :StyleTable,               ogr_require('ogr/style_table')
 end

data/spec/ffi-gdal_spec.rb

@@ -1,5 +1,22 @@
 require 'spec_helper'
 require 'ffi-gdal'
 
-RSpec.describe GDAL do
+RSpec.describe FFI do
+  describe 'autoload CPL' do
+    it 'can call CPL functions' do
+      expect { FFI::CPL }.to_not raise_exception
+    end
+  end
+
+  describe 'autoload GDAL' do
+    it 'can call GDAL functions' do
+      expect { FFI::GDAL }.to_not raise_exception
+    end
+  end
+
+  describe 'autoload OGR' do
+    it 'can call OGR functions' do
+      expect { FFI::OGR }.to_not raise_exception
+    end
+  end
 end