Contents

require_relative '../ffi-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
    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
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
ffi-gdal-0.0.4	lib/ext/cpl_error_symbols.rb
ffi-gdal-0.0.3	lib/ext/cpl_error_symbols.rb
ffi-gdal-0.0.2	lib/ext/cpl_error_symbols.rb
ffi-gdal-0.0.1	lib/ext/cpl_error_symbols.rb