ffi-gdal 1.0.3 → 1.1.0

data/lib/ffi/gdal/version.rb

@@ -2,6 +2,6 @@
 
 module FFI
   module GDAL
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

data/lib/ffi/gdal.rb

@@ -19,9 +19,11 @@ module FFI
              File.expand_path("gdal/grid_inverse_distance_to_a_power_options.rb", __dir__)
     autoload :GridMovingAverageOptions, File.expand_path("gdal/grid_moving_average_options.rb", __dir__)
     autoload :GridNearestNeighborOptions, File.expand_path("gdal/grid_nearest_neighbor_options.rb", __dir__)
+    autoload :InternalHelpers, File.expand_path("gdal/internal_helpers.rb", __dir__)
     autoload :Matching, File.expand_path("gdal/matching.rb", __dir__)
     autoload :RPCInfo, File.expand_path("gdal/rpc_info.rb", __dir__)
     autoload :TransformerInfo, File.expand_path("gdal/transformer_info.rb", __dir__)
+    autoload :Utils, File.expand_path("gdal/utils.rb", __dir__)
     autoload :VRT, File.expand_path("gdal/vrt.rb", __dir__)
     autoload :Warper, File.expand_path("gdal/warper.rb", __dir__)
     autoload :WarpOptions, File.expand_path("gdal/warp_options.rb", __dir__)
@@ -39,7 +41,7 @@ module FFI
         ogr_core.h ogr_srs_api.h
       ]
 
-      header_search_paths = %w[/usr/local/include /usr/include /usr/include/gdal]
+      header_search_paths = %w[/usr/local/include /usr/include /usr/include/gdal /opt/homebrew/include/]
 
       header_files.map do |file|
         dir = header_search_paths.find do |d|

data/lib/ffi/ogr/core.rb

@@ -121,7 +121,7 @@ module FFI
                            :OGRSTSymbolPriority,  9,
                            :OGRSTSymbolFontName, 10,
                            :OGRSTSymbolOColor,   11,
-                           :OGRSTSymbolLast,      12
+                           :OGRSTSymbolLast,     12
 
       STLabelParam = enum :OGRSTLabelFontName, 0,
                           :OGRSTLabelSize,        1,

data/lib/ffi/ogr/srs_api.rb

@@ -38,6 +38,13 @@ module FFI
                        :ODT_LD_Min, 10_000,
                        :ODT_LD_Max, 32_767
 
+      # https://gdal.org/api/ogr_srs_api.html#_CPPv422OSRAxisMappingStrategy
+      OSRAxisMappingStrategy = enum(
+        :OAMS_TRADITIONAL_GIS_ORDER, 0,
+        :OAMS_AUTHORITY_COMPLIANT, 1,
+        :OAMS_CUSTOM, 2
+      )
+
       # -----------------------------------------------------------------------
       # Constants
       # -----------------------------------------------------------------------
@@ -125,6 +132,10 @@ module FFI
       # ~~~~~~~~~~~~~
       # SpatialReference
       # ~~~~~~~~~~~~~
+
+      # https://gdal.org/api/ogr_srs_api.html#_CPPv417OSRGetPROJVersionPiPiPi
+      attach_function :OSRGetPROJVersion, %i[pointer pointer pointer], :void
+
       attach_function :OSRNewSpatialReference, %i[string], :OGRSpatialReferenceH
       attach_function :OSRCloneGeogCS, %i[OGRSpatialReferenceH], :OGRSpatialReferenceH
       attach_function :OSRClone, %i[OGRSpatialReferenceH], :OGRSpatialReferenceH
@@ -215,6 +226,12 @@ module FFI
                       %i[OGRSpatialReferenceH string int pointer],
                       :string
 
+      # https://gdal.org/api/ogr_srs_api.html#_CPPv425OSRGetAxisMappingStrategy20OGRSpatialReferenceH
+      attach_function :OSRGetAxisMappingStrategy, %i[OGRSpatialReferenceH], OSRAxisMappingStrategy
+
+      # https://gdal.org/api/ogr_srs_api.html#_CPPv425OSRGetAxisMappingStrategy20OGRSpatialReferenceH
+      attach_function :OSRSetAxisMappingStrategy, [:OGRSpatialReferenceH, OSRAxisMappingStrategy], :void
+
       attach_function :OSRSetACEA,
                       %i[OGRSpatialReferenceH double double double double double double],
                       FFI::OGR::Core::Err

data/lib/gdal/cpl_error_handler.rb

@@ -9,19 +9,27 @@ module GDAL
   class CPLErrorHandler
     include GDAL::Logger
 
+    # NOTE: Error codes are defined in https://gdal.org/doxygen/cpl__error_8h_source.html
     CPLE_MAP = [
-      { cple: :CPLE_None,           exception: nil },
-      { cple: :CPLE_AppDefined,     exception: GDAL::Error },
-      { cple: :CPLE_OutOfMemory,    exception: ::NoMemoryError },
-      { cple: :CPLE_FileIO,         exception: ::IOError },
-      { cple: :CPLE_OpenFailed,     exception: GDAL::OpenFailure },
-      { cple: :CPLE_IllegalArg,     exception: ::ArgumentError },
-      { cple: :CPLE_NotSupported,   exception: GDAL::UnsupportedOperation },
-      { cple: :CPLE_AssertionFailed, exception: ::RuntimeError },
-      { cple: :CPLE_NoWriteAccess,  exception: GDAL::NoWriteAccess },
-      { cple: :CPLE_UserInterrupt,  exception: ::Interrupt },
-      { cple: :CPLE_ObjectNull,     exception: GDAL::NullObject }
+      { cple: :CPLE_None,                     exception: nil }.freeze,
+      { cple: :CPLE_AppDefined,               exception: GDAL::Error }.freeze,
+      { cple: :CPLE_OutOfMemory,              exception: ::NoMemoryError }.freeze,
+      { cple: :CPLE_FileIO,                   exception: ::IOError }.freeze,
+      { cple: :CPLE_OpenFailed,               exception: GDAL::OpenFailure }.freeze,
+      { cple: :CPLE_IllegalArg,               exception: ::ArgumentError }.freeze,
+      { cple: :CPLE_NotSupported,             exception: GDAL::UnsupportedOperation }.freeze,
+      { cple: :CPLE_AssertionFailed,          exception: ::RuntimeError }.freeze,
+      { cple: :CPLE_NoWriteAccess,            exception: GDAL::NoWriteAccess }.freeze,
+      { cple: :CPLE_UserInterrupt,            exception: ::Interrupt }.freeze,
+      { cple: :CPLE_ObjectNull,               exception: GDAL::NullObject }.freeze,
+      { cple: :CPLE_HttpResponse,             exception: GDAL::HttpResponse }.freeze,
+      { cple: :CPLE_AWSBucketNotFound,        exception: GDAL::AWSBucketNotFound }.freeze,
+      { cple: :CPLE_AWSObjectNotFound,        exception: GDAL::AWSObjectNotFound }.freeze,
+      { cple: :CPLE_AWSAccessDenied,          exception: GDAL::AWSAccessDenied }.freeze,
+      { cple: :CPLE_AWSInvalidCredentials,    exception: GDAL::AWSInvalidCredentials }.freeze,
+      { cple: :CPLE_AWSSignatureDoesNotMatch, exception: GDAL::AWSSignatureDoesNotMatch }.freeze
     ].freeze
+    FALLBACK_CPLE_EXCEPTION = { exception: GDAL::Error }.freeze
 
     FAIL_PROC = lambda do |exception, message|
       ex = exception ? exception.new(message) : GDAL::Error.new(message)
@@ -65,11 +73,15 @@ module GDAL
 
     def initialize
       @on_none = SUCCESS_PROC
-      @on_debug = SUCCESS_PROC
+
+      @on_debug = lambda do |_, message|
+        logger.debug(message)
+        true
+      end
 
       @on_warning = lambda do |_, message|
-        warn(message)
-        false
+        logger.warn(message)
+        true
       end
 
       @on_failure = FAIL_PROC
@@ -123,7 +135,10 @@ module GDAL
 
     # @return Whatever the Proc evaluates.
     def result(error_class, error_number, message)
-      error_class_map(error_class).call(CPLE_MAP[error_number][:exception], message)
+      error_class_map(error_class).call(
+        CPLE_MAP.fetch(error_number, FALLBACK_CPLE_EXCEPTION).fetch(:exception),
+        message
+      )
     end
 
     def error_class_map(error_class)

data/lib/gdal/exceptions.rb

@@ -1,22 +1,50 @@
 # frozen_string_literal: true
 
 module GDAL
-  class BufferTooSmall < StandardError
-  end
-
-  class CreateFail < StandardError
-  end
-
   class Error < ::RuntimeError
   end
 
-  class OpenFailure < StandardError
+  # CPLE_OpenFailed
+  class OpenFailure < ::StandardError
     def initialize(file, msg = nil)
       message = msg || "Unable to open file '#{file}'. Perhaps an unsupported file format?"
       super(message)
     end
   end
 
+  # CPLE_NotSupported
+  class UnsupportedOperation < ::StandardError; end
+
+  # CPLE_NoWriteAccess
+  class NoWriteAccess < ::RuntimeError; end
+
+  # CPLE_ObjectNull
+  class NullObject < ::TypeError; end
+
+  # CPLE_HttpResponse
+  class HttpResponse < ::RuntimeError; end
+
+  # CPLE_AWSBucketNotFound
+  class AWSBucketNotFound < ::RuntimeError; end
+
+  # CPLE_AWSObjectNotFound
+  class AWSObjectNotFound < ::RuntimeError; end
+
+  # CPLE_AWSAccessDenied
+  class AWSAccessDenied < ::RuntimeError; end
+
+  # CPLE_AWSInvalidCredentials
+  class AWSInvalidCredentials < ::RuntimeError; end
+
+  # CPLE_AWSSignatureDoesNotMatch
+  class AWSSignatureDoesNotMatch < ::RuntimeError; end
+
+  class BufferTooSmall < StandardError
+  end
+
+  class CreateFail < StandardError
+  end
+
   class InvalidAccessFlag < RuntimeError
   end
 
@@ -51,12 +79,6 @@ module GDAL
   class NoValuesToGrid < RuntimeError
   end
 
-  class NoWriteAccess < RuntimeError
-  end
-
-  class NullObject < TypeError
-  end
-
   class RequiredBandNotFound < StandardError
   end
 
@@ -69,7 +91,4 @@ module GDAL
 
   class UnknownRasterAttributeTableType < StandardError
   end
-
-  class UnsupportedOperation < StandardError
-  end
 end

data/lib/gdal/extensions/color_table/extensions.rb

@@ -10,7 +10,7 @@ module GDAL
         raise "Invalid ColorEntry number 'color#{color_number}'" unless (1..4).to_a.include? color_number
 
         Array.new(color_entry_count) do |i|
-          color_entry(i).send("color#{color_number}".to_sym)
+          color_entry(i).send(:"color#{color_number}")
         end
       end
 

data/lib/gdal/extensions/gridder.rb

@@ -4,6 +4,10 @@ require "narray"
 require "gdal"
 require "gdal/options"
 require "ogr"
+require "ogr/extensions/envelope/extensions"
+require "ogr/extensions/layer/extensions"
+require "gdal/extensions/geo_transform/extensions"
+
 require_relative "gridder_options"
 require_relative "gridder/point_extracting"
 

data/lib/gdal/geo_transform.rb

@@ -40,6 +40,19 @@ module GDAL
       self.y_rotation ||= 0.0
     end
 
+    # @param other [GDAL::GeoTransform]
+    # @return [Boolean]
+    def ==(other)
+      return false unless other.is_a?(GDAL::GeoTransform)
+
+      x_origin == other.x_origin &&
+        pixel_width == other.pixel_width &&
+        x_rotation == other.x_rotation &&
+        y_origin == other.y_origin &&
+        y_rotation == other.y_rotation &&
+        pixel_height == other.pixel_height
+    end
+
     def null?
       @c_pointer.null?
     end

data/lib/gdal/grid_algorithms/algorithm_base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GDAL
+  module GridAlgorithms
+    # Base abstract class for all grid algorithms.
+    class AlgorithmBase
+      # @return Options object.
+      attr_reader :options
+
+      def initialize
+        @options = options_class.new
+        assign_size_of_structure
+      end
+
+      # @return [Class] Options class.
+      def options_class
+        # This method must be overridden in subclasses.
+      end
+
+      # @return [Symbol] C identifier for the algorithm.
+      def c_identifier
+        # This method must be overridden in subclasses.
+      end
+
+      private
+
+      def assign_size_of_structure
+        # Starting GDAL 3.6.0 we must assign nSizeOfStructure to the size of the structure.
+        return unless @options.members.include?(:n_size_of_structure)
+
+        @options[:n_size_of_structure] = @options.size
+      end
+    end
+  end
+end

data/lib/gdal/grid_algorithms/inverse_distance_to_a_power.rb

@@ -2,15 +2,11 @@
 
 module GDAL
   module GridAlgorithms
-    class InverseDistanceToAPower
-      # @return [FFI::GDAL::GridInverseDistanceToAPowerOptions]
-      attr_reader :options
-
-      def initialize
-        @options = FFI::GDAL::GridInverseDistanceToAPowerOptions.new
+    class InverseDistanceToAPower < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridInverseDistanceToAPowerOptions
       end
 
-      # @return [Symbol]
       def c_identifier
         :GGA_InverseDistanceToAPower
       end

data/lib/gdal/grid_algorithms/metric_average_distance.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricAverageDistance < DataMetricsBase
-      # @return [Symbol]
+    class MetricAverageDistance < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricAverageDistance
       end

data/lib/gdal/grid_algorithms/metric_average_distance_pts.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricAverageDistancePts < DataMetricsBase
-      # @return [Symbol]
+    class MetricAverageDistancePts < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricAverageDistancePts
       end

data/lib/gdal/grid_algorithms/metric_count.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricCount < DataMetricsBase
-      # @return [Symbol]
+    class MetricCount < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricCount
       end

data/lib/gdal/grid_algorithms/metric_maximum.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricMaximum < DataMetricsBase
-      # @return [Symbol]
+    class MetricMaximum < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricMaximum
       end

data/lib/gdal/grid_algorithms/metric_minimum.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricMinimum < DataMetricsBase
-      # @return [Symbol]
+    class MetricMinimum < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricMinimum
       end

data/lib/gdal/grid_algorithms/metric_range.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "data_metrics_base"
-
 module GDAL
   module GridAlgorithms
-    class MetricRange < DataMetricsBase
-      # @return [Symbol]
+    class MetricRange < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridDataMetricsOptions
+      end
+
       def c_identifier
         :GGA_MetricRange
       end

data/lib/gdal/grid_algorithms/moving_average.rb

@@ -2,15 +2,11 @@
 
 module GDAL
   module GridAlgorithms
-    class MovingAverage
-      # @return [FFI::GDAL::GridMovingAverageOptions]
-      attr_reader :options
-
-      def initialize
-        @options = FFI::GDAL::GridMovingAverageOptions.new
+    class MovingAverage < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridMovingAverageOptions
       end
 
-      # @return [Symbol]
       def c_identifier
         :GGA_MovingAverage
       end

data/lib/gdal/grid_algorithms/nearest_neighbor.rb

@@ -2,15 +2,11 @@
 
 module GDAL
   module GridAlgorithms
-    class NearestNeighbor
-      # @return [FFI::GDAL::GridNearestNeighborOptions]
-      attr_reader :options
-
-      def initialize
-        @options = FFI::GDAL::GridNearestNeighborOptions.new
+    class NearestNeighbor < AlgorithmBase
+      def options_class
+        ::FFI::GDAL::GridNearestNeighborOptions
       end
 
-      # @return [Symbol]
       def c_identifier
         :GGA_NearestNeighbor
       end

data/lib/gdal/grid_algorithms.rb

@@ -2,6 +2,8 @@
 
 module GDAL
   module GridAlgorithms
+    autoload :AlgorithmBase,
+             File.expand_path("grid_algorithms/algorithm_base", __dir__)
     autoload :InverseDistanceToAPower,
              File.expand_path("grid_algorithms/inverse_distance_to_a_power", __dir__)
     autoload :MetricAverageDistance,

data/lib/gdal/internal_helpers.rb

@@ -106,7 +106,7 @@ module GDAL
       def _read_pointer_pointer_safely(pointer_ptr, type)
         return if pointer_ptr.read_pointer.null?
 
-        pointer_ptr.read_pointer.send("read_#{type}".to_sym)
+        pointer_ptr.read_pointer.send(:"read_#{type}")
       end
 
       # Convenience function for allocating a pointer to a string (**char),
@@ -141,10 +141,13 @@ module GDAL
       def _gdal_data_type_to_ffi(data_type)
         case data_type
         when :GDT_Byte                    then :uchar
+        when :GDT_Int8                    then :int8
         when :GDT_UInt16                  then :uint16
         when :GDT_Int16, :GDT_CInt16      then :int16
         when :GDT_UInt32                  then :uint32
         when :GDT_Int32, :GDT_CInt32      then :int32
+        when :GDT_UInt64                  then :uint64
+        when :GDT_Int64                   then :int64
         when :GDT_Float32, :GDT_CFloat32  then :float
         when :GDT_Float64, :GDT_CFloat64  then :double
         else
@@ -201,9 +204,9 @@ module GDAL
       # @return [Number, Array<Number>]
       def _read_pointer(pointer, data_type, length = 1)
         if length == 1
-          pointer.send("read_#{_gdal_data_type_to_ffi(data_type)}")
+          pointer.send(:"read_#{_gdal_data_type_to_ffi(data_type)}")
         else
-          pointer.send("read_array_of_#{_gdal_data_type_to_ffi(data_type)}", length)
+          pointer.send(:"read_array_of_#{_gdal_data_type_to_ffi(data_type)}", length)
         end
       end
 
@@ -217,10 +220,10 @@ module GDAL
       #   with size > 1, the "write_array_of_" method will be called.
       def _write_pointer(pointer, data_type, data)
         if data.is_a?(Array) && data.size > 1
-          pointer.send("write_array_of_#{_gdal_data_type_to_ffi(data_type)}", data)
+          pointer.send(:"write_array_of_#{_gdal_data_type_to_ffi(data_type)}", data)
         else
           data = data.first if data.is_a?(Array)
-          pointer.send("write_#{_gdal_data_type_to_ffi(data_type)}", data)
+          pointer.send(:"write_#{_gdal_data_type_to_ffi(data_type)}", data)
         end
       end
 

data/lib/gdal/major_object.rb

@@ -75,6 +75,12 @@ module GDAL
       desc
     end
 
+    # @param description [String]
+    # @return [String]
+    def description=(description)
+      FFI::GDAL::GDAL.GDALSetDescription(@c_pointer, description)
+    end
+
     def null?
       @c_pointer.null?
     end

data/lib/gdal/raster_band.rb

@@ -347,14 +347,16 @@ module GDAL
     # returned.
     #
     # @return Float
-    # @raise GDAL::Error if the underlying call fails.
     def scale
-      success = FFI::MemoryPointer.new(:bool)
-      result = FFI::GDAL::GDAL.GDALGetRasterScale(@c_pointer, success)
-
-      raise GDAL::Error, "GDALGetRasterScale failed" unless success.read_bytes(1).to_bool
+      FFI::GDAL::GDAL.GDALGetRasterScale(@c_pointer, nil)
+    end
 
-      result
+    # Check if the scale is set.
+    # @return [Boolean]
+    def scale?
+      success = FFI::MemoryPointer.new(:bool)
+      FFI::GDAL::GDAL.GDALGetRasterScale(@c_pointer, success)
+      success.read_bytes(1).to_bool
     end
 
     # @param new_scale [Float]
@@ -376,14 +378,16 @@ module GDAL
     # returned.
     #
     # @return Float
-    # @raise GDAL::Error if the underlying call fails.
     def offset
-      success = FFI::MemoryPointer.new(:bool)
-      result = FFI::GDAL::GDAL.GDALGetRasterOffset(@c_pointer, success)
-
-      raise GDAL::Error, "GDALGetRasterOffset failed" unless success.read_bytes(1).to_bool
+      FFI::GDAL::GDAL.GDALGetRasterOffset(@c_pointer, nil)
+    end
 
-      result
+    # Check if the offset is set.
+    # @return [Boolean]
+    def offset?
+      success = FFI::MemoryPointer.new(:bool)
+      FFI::GDAL::GDAL.GDALGetRasterOffset(@c_pointer, success)
+      success.read_bytes(1).to_bool
     end
 
     # Sets the scaling offset. Very few formats support this method.

data/lib/gdal/utils/dem/options.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GDAL
+  module Utils
+    class DEM
+      # Ruby wrapper for GDALDEMProcessingOptions C API (options for gdaldem utility).
+      #
+      # @see GDAL::Utils::DEM
+      # @see https://gdal.org/programs/gdaldem.html gdaldem utility documentation.
+      class Options
+        # @private
+        class AutoPointer < ::FFI::AutoPointer
+          # @param pointer [FFI::Pointer]
+          def self.release(pointer)
+            return unless pointer && !pointer.null?
+
+            ::FFI::GDAL::Utils.GDALDEMProcessingOptionsFree(pointer)
+          end
+        end
+
+        # @return [AutoPointer] C pointer to the GDALDEMProcessingOptions.
+        attr_reader :c_pointer
+
+        # @return [Array<String>] The options.
+        attr_reader :options
+
+        # Create a new instance.
+        #
+        # @see https://gdal.org/programs/gdaldem.html
+        #   List of available options could be found in gdaldem utility documentation.
+        #
+        # @example Create a new instance.
+        #  options = GDAL::Utils::DEM::Options.new(options: ["-of", "GTiff", "-co", "COMPRESS=DEFLATE"])
+        #
+        # @param options [Array<String>] The options list.
+        def initialize(options: [])
+          @options = options
+          @string_list = ::GDAL::Utils::Helpers::StringList.new(strings: options)
+          @c_pointer = AutoPointer.new(options_pointer)
+        end
+
+        private
+
+        attr_reader :string_list
+
+        def options_pointer
+          ::FFI::GDAL::Utils.GDALDEMProcessingOptionsNew(string_list.c_pointer, nil)
+        end
+      end
+    end
+  end
+end