ffi-gdal 0.0.4 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfa34b84ed0070848c6fde3721e8ef247a0c6ff9
-  data.tar.gz: f458c3e3f8c0f9d4e3ff0381f75017b6e123e03e
+  metadata.gz: b085e002a7e05915f5335245a0a316090d927c38
+  data.tar.gz: c5e22d016ba55c3c421c03ad2e043befba56b8e6
 SHA512:
-  metadata.gz: d337efd0962ecf22a455026cdafcf76ea97ab12b173d270763d5eb9bce592778b61ce43b72ea932b380b926a0f77dd5091bb834a42dc7d41780ec1a9d6668b7e
-  data.tar.gz: dd9f8ecd705648a22a5a480b9b8f6e0a34a90eda87da49f95d9298b8989b1171f648878a32c12640d6103aa42cff788823cdb378f6caa8fb423b58f73b836d9d
+  metadata.gz: ebeace61156bee523ef19aa7d4babd67fc0274e85b105d9bf54b5086c886615bcee9532c1e5b238dd611bcaac2e6eb209276da046a99581511e35a8aeecbaed0
+  data.tar.gz: d0586998a7010b8f41d20018764f6daa06e0be1a3f563d5ad4e7dc6251ef7d2b5d38238e7b4d80203fff21f4eed4f11e1a14dbb9679e909927c9dcd049f9919f

data/.gitignore

@@ -22,4 +22,10 @@ tmp
 mkmf.log
 .idea/
 spec/support/images
-tags
+tags
+*.sqlite
+vendor/bundle
+*.tif
+*.xml
+*.dbf
+*.shx

data/Rakefile

@@ -54,4 +54,15 @@ def files_and_dirs(in_dir, ftp)
 end
 
 
-RSpec::Core::RakeTask.new
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**/*_spec.rb'
+  end
+end
+
+task spec: 'spec:unit'
+task default: 'spec:unit'

data/TODO.md

@@ -0,0 +1,11 @@
+* Use autoload for C wrappers
+* Documentation
+* add more OGR::StyleTable
+* normalize c_pointer instance variable names
+* set attributes to instance variables
+* more GDALDriver
+* Finish MajorObject
+* Make object attributes that behave like Hashes be hashes
+    * MajorObject#metadata
+    * ColorTable color entries
+    * Raster bands in a dataset

data/ffi-gdal.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency 'ffi'
-  spec.add_dependency 'log_switch'
+  spec.add_dependency 'log_switch', '~> 1.0.0'
   spec.add_dependency 'multi_xml'
   spec.add_dependency 'narray', '~> 0.6.0'
-  spec.add_dependency 'ruby-progressbar'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'ruby-progressbar'
 end

data/lib/ext/error_symbols.rb

@@ -0,0 +1,59 @@
+require_relative '../gdal/exceptions'
+
+
+class ::Symbol
+
+  # When FFI interfaces with a GDAL CPLError, it returns a Symbol that
+  # maps to the CPLErr enum (see GDAL's cpl_error.h or cpl_error.rb docs). Since
+  # many of the GDAL C API's functions return these symbols _and_ because the
+  # symbols have some functional implications, this wrapping here is simply for
+  # returning Ruby-esque values when the GDAL API returns one of these symbols.
+  #
+  # The optional params let you override behavior.  Passing in a block instead
+  # will call the block.  Ex.
+  #
+  #   cpl_err = GDALCopyDatasetFiles(@gdal_driver_handle, new_name, old_name)
+  #   cpl_err.to_ruby      # returns the default value
+  #   cpl_err.to_ruby { raise 'Crap!' }
+  def to_ruby(none: :none, debug: :debug, warning: :warning, failure: :failure, fatal: :fatal)
+    case self
+    when :CE_None then none
+    when :CE_Debug then debug
+    when :CE_Warning then warning
+    when :CE_Failure then failure
+    when :CE_Fatal then fatal
+    when :OGRERR_NONE then none
+    when :OGRERR_NOT_ENOUGH_DATA then fail(OGR::NotEnoughData)
+    when :OGRERR_NOT_ENOUGH_MEMORY then fail(OGR::NotEnoughMemory)
+    when :OGRERR_UNSUPPORTED_GEOMETRY_TYPE then fail(OGR::UnsupportedGeometryType)
+    when :OGRERR_UNSUPPORTED_OPERATION then fail(OGR::UnsupportedOperation)
+    when :OGRERR_CORRUPT_DATA then fail(OGR::CorruptData)
+    when :OGRERR_FAILURE then fail(OGR::Failure)
+    when :OGRERR_UNSUPPORTED_SRS then fail(OGR::UnsupportedSRS)
+    when :OGRERR_INVALID_HANDLE then fail(OGR::InvalidHandle)
+    else
+      raise "Unknown CPLErr/OGRErr type: #{self}"
+    end
+  end
+
+  def to_bool
+    case self
+    when :CE_None then true
+    when :CE_Debug then true
+    when :CE_Warning then false
+    when :CE_Failure then raise GDAL::CPLErrFailure
+    when :CE_Fatal then raise GDAL::CPLErrFailure
+    when :OGRERR_NONE then true
+    when :OGRERR_NOT_ENOUGH_DATA then fail(OGR::NotEnoughData)
+    when :OGRERR_NOT_ENOUGH_MEMORY then fail(OGR::NotEnoughMemory)
+    when :OGRERR_UNSUPPORTED_GEOMETRY_TYPE then fail(OGR::UnsupportedGeometryType)
+    when :OGRERR_UNSUPPORTED_OPERATION then fail(OGR::UnsupportedOperation)
+    when :OGRERR_CORRUPT_DATA then fail(OGR::CorruptData)
+    when :OGRERR_FAILURE then fail(OGR::Failure)
+    when :OGRERR_UNSUPPORTED_SRS then fail(OGR::UnsupportedSRS)
+    when :OGRERR_INVALID_HANDLE then fail(OGR::InvalidHandle)
+    else
+      raise "Unknown CPLError type: #{self}"
+    end
+  end
+end

data/lib/ext/float_ext.rb

@@ -0,0 +1,15 @@
+class Float
+  # Converts a packed DMS value (DDDMMMSSS.SS) into decimal degress.
+  #
+  # @return [Float]
+  def to_decimal_degress
+    FFI::GDAL.GDALPackedDMSToDec(self)
+  end
+
+  # Converts decimal degrees int a packed DMS value (DDDMMMSSS.SS).
+  #
+  # @return [Float]
+  def to_dms
+    FFI::GDAL.GDALDecToPackedDMS(self)
+  end
+end

data/lib/ext/narray_ext.rb

@@ -0,0 +1,16 @@
+require 'narray'
+
+class NArray
+  def type
+    case typecode
+    when 1 then :byte
+    when 2 then :sint
+    when 3 then :int
+    when 4 then :sfloat
+    when 5 then :float
+    when 6 then :scomplex
+    when 7 then :complex
+    when 8 then :object
+    end
+  end
+end

data/lib/ext/to_bool.rb

@@ -2,6 +2,7 @@ class Fixnum
   def to_bool
     return true if self == 1
     return false if self == 0
+    raise "Fixnum '#{self}' can't be converted to Boolean."
   end
 end
 
@@ -9,5 +10,6 @@ class String
   def to_bool
     return true if self.to_i == 1
     return false if self.to_i == 0
+    raise "String '#{self}' can't be converted to Boolean."
   end
 end

data/lib/ffi-gdal.rb

@@ -1,12 +1,147 @@
 require 'log_switch'
-require_relative 'ffi-gdal/version_info'
+require_relative 'ext/narray_ext'
+require_relative 'gdal/version_info'
+require_relative 'gdal/environment_methods'
 
 module GDAL
   extend VersionInfo
-  extend LogSwitch
+  extend EnvironmentMethods
+
+  module Logger
+    include LogSwitch
+  end
+
+  autoload :ColorEntry,
+    File.expand_path('gdal/color_entry', __dir__)
+  autoload :ColorInterpretation,
+    File.expand_path('gdal/color_interpretation', __dir__)
+  autoload :ColorTable,
+    File.expand_path('gdal/color_table', __dir__)
+  autoload :DataType,
+    File.expand_path('gdal/data_type', __dir__)
+  autoload :Dataset,
+    File.expand_path('gdal/dataset', __dir__)
+  autoload :Driver,
+    File.expand_path('gdal/driver', __dir__)
+  autoload :GeoTransform,
+    File.expand_path('gdal/geo_transform', __dir__)
+  autoload :MajorObject,
+    File.expand_path('gdal/major_object', __dir__)
+  autoload :Options,
+    File.expand_path('gdal/options', __dir__)
+  autoload :RasterAttributeTable,
+    File.expand_path('gdal/raster_attribute_table', __dir__)
+  autoload :Utils,
+    File.expand_path('gdal/utils', __dir__)
+  autoload :WarpOperation,
+    File.expand_path('gdal/warp_operation', __dir__)
+
+  # Register all drivers!
+  FFI::GDAL.GDALAllRegister
+
+  # Internal factory method for returning a pointer from +variable+, which could
+  # be either of +klass+ class or a type of FFI::Pointer.
+  def self._pointer(klass, variable, warn_on_nil=true)
+    if variable.kind_of?(klass)
+      variable.c_pointer
+    elsif variable.kind_of? FFI::Pointer
+      variable
+    elsif warn_on_nil
+      Logger.log "<#{name}._pointer> #{variable.inspect} is not a valid #{klass} or FFI::Pointer."
+      Logger.log "<#{name}._pointer> Called at: #{caller(1, 1).first}"
+    else
+      nil
+    end
+  end
+
+  # @param data_type [FFI::GDAL::GDALDataType]
+  # @return [Symbol] The FFI Symbol that represents a data type.
+  def self._pointer_from_data_type(data_type, size=nil)
+    pointer_type = _gdal_data_type_to_ffi(data_type)
+
+    if size
+      FFI::MemoryPointer.new(pointer_type, size)
+    else
+      FFI::MemoryPointer.new(pointer_type)
+    end
+  end
+
+  # Maps GDAL DataTypes to FFI types.
+  #
+  # @param data_type [FFI::GDAL::GDALDataType]
+  def self._gdal_data_type_to_ffi(data_type)
+    case data_type
+    when :GDT_Byte then :uchar
+    when :GDT_UInt16 then :uint16
+    when :GDT_Int16 then :int16
+    when :GDT_UInt32 then :uint32
+    when :GDT_Int32 then :int32
+    when :GDT_Float32 then :float
+    when :GDT_Float64 then :double
+    else
+      :float
+    end
+  end
+
+  # Check to see if the function is supported in the version of GDAL that we're
+  # using.
+  #
+  # @param function_name [Symbol]
+  # @return [Boolean]
+  def self._supported?(function_name)
+    !FFI::GDAL.unsupported_gdal_functions.include?(function_name)
+  end
 end
 
-GDAL.log_class_name = true
+module OGR
+  autoload :CoordinateTransformation,
+    File.expand_path('ogr/coordinate_transformation', __dir__)
+  autoload :DataSource,
+    File.expand_path('ogr/data_source', __dir__)
+  autoload :Driver,
+    File.expand_path('ogr/driver', __dir__)
+  autoload :Envelope,
+    File.expand_path('ogr/envelope', __dir__)
+  autoload :Feature,
+    File.expand_path('ogr/feature', __dir__)
+  autoload :FeatureDefinition,
+    File.expand_path('ogr/feature_definition', __dir__)
+  autoload :GeocodingSession,
+    File.expand_path('ogr/geocoding_session', __dir__)
+  autoload :Geometry,
+    File.expand_path('ogr/geometry', __dir__)
+  autoload :Layer,
+    File.expand_path('ogr/layer', __dir__)
+  autoload :LineString,
+    File.expand_path('ogr/line_string', __dir__)
+  autoload :LinearRing,
+    File.expand_path('ogr/linear_ring', __dir__)
+  autoload :MultiLineString,
+    File.expand_path('ogr/multi_line_string', __dir__)
+  autoload :MultiPoint,
+    File.expand_path('ogr/multi_point', __dir__)
+  autoload :MultiPolygon,
+    File.expand_path('ogr/multi_polygon', __dir__)
+  autoload :Point,
+    File.expand_path('ogr/point', __dir__)
+  autoload :Polygon,
+    File.expand_path('ogr/polygon', __dir__)
+  autoload :SpatialReference,
+    File.expand_path('ogr/spatial_reference', __dir__)
+  autoload :StyleTable,
+    File.expand_path('ogr/style_table', __dir__)
+
+  FFI::GDAL.OGRRegisterAll
+
+  def self._boolean_access_flag(flag)
+    case flag
+    when 'w' then true
+    when 'r' then false
+    else raise "Invalid access_flag '#{access_flag}'.  Use 'r' or 'w'."
+    end
+  end
+end
 
 require_relative 'ffi/gdal'
-require_relative 'ffi-gdal/dataset'
+require_relative 'ffi/ogr'
+require_relative 'ext/float_ext'

data/lib/ffi/{gdal/cpl_conv.rb → cpl/conv_h.rb}

@@ -1,10 +1,9 @@
-require_relative 'cpl_error'
-require_relative 'cpl_vsi'
+require_relative 'error_h'
+require_relative 'vsi_h'
 
 
 module FFI
   module GDAL
-
     def CPLFree(pointer)
       extend CPLVSI
       VSIFree(pointer)

data/lib/ffi/{gdal/cpl_error.rb → cpl/error_h.rb}

@@ -1,33 +1,9 @@
-require_relative '../../ext/cpl_error_symbols'
+require_relative '../../ext/error_symbols'
 
 
 module FFI
   module GDAL
 
-    #------------------------------------------------------------------------
-    # Defines
-    #------------------------------------------------------------------------
-    None = 0
-    AppDefined = 1
-    OutOfMemory = 2
-    FileIO = 3
-    OpenFailed = 4
-    IllegalArg = 5
-    NotSupported = 6
-    AssertionFailed = 7
-    NoWriteAccess = 8
-    UserInterrupt = 9
-    ObjectNull = 10
-
-    def cpla_assert(exp)
-    end
-    def validate_pointer_err(ce_failure)
-    end
-    def validate_pointer0(ptr, func)
-    end
-    def validate_pointer1(ptr, func, rc)
-    end
-
     #------------------------------------------------------------------------
     # Enums
     #------------------------------------------------------------------------

data/lib/ffi/cpl/minixml_h.rb

@@ -0,0 +1,14 @@
+module FFI
+  module GDAL
+    #--------------------------------------------------------------------------
+    # Enums
+    #--------------------------------------------------------------------------
+    CPLXMLNodeType = enum :CXT_Element, 0,
+      :CXT_Text, 1,
+      :CXT_Attribute, 2,
+      :CXT_Comment, 3,
+      :CXT_Literal, 4
+  end
+end
+
+require_relative 'xml_node'

data/lib/ffi/{gdal/cpl_string.rb → cpl/string_h.rb}

@@ -1,31 +1,6 @@
 module FFI
   module GDAL
 
-    #------------------------------------------------------------------------
-    # Defines
-    #------------------------------------------------------------------------
-    CSLT_HONOURSTRINGS    = 0x0001
-    CSLT_ALLOWEMPTYTOKENS = 0x0002
-    CSLT_PRESERVEQUOTES   = 0x0004
-    CSLT_PRESERVEESCAPES  = 0x0008
-    CSLT_STRIPLEADSPACES  = 0x0010
-    CSLT_STRIPENDSPACES   = 0x0020
-
-    CPLES_BackslashQuotable = 0
-    CPLES_XML               = 1
-    CPLES_URL               = 2
-    CPLES_SQL               = 3
-    CPLES_CSV               = 4
-    CPLES_XML_BUT_QUOTES    = 5
-
-    CPL_ENC_LOCALE = ''
-    CPL_ENC_UTF8 = 'UTF-8'
-    CPL_ENC_UTF16 = 'UTF-16'
-    CPL_ENC_UCS2 = 'UCS-2'
-    CPL_ENC_UCS4 = 'UCS-4'
-    CPL_ENC_ASCII = 'ASCII'
-    CPL_ENC_ISO8859_1 = 'ISO-8859-1'
-
     typedef :string, :CPLString
 
     #------------------------------------------------------------------------

data/lib/ffi/cpl/xml_node.rb

@@ -0,0 +1,13 @@
+require 'ffi'
+require_relative 'minixml_h'
+
+module FFI
+  module GDAL
+    class CPLXMLNode < FFI::Struct
+      layout :type, CPLXMLNodeType,
+        :value, :string,
+        :next, CPLXMLNode.ptr,
+        :child, CPLXMLNode.ptr
+    end
+  end
+end