schleyfox-rgeo 0.2.5

data/lib/rgeo/coord_sys/cs/factories.rb

@@ -0,0 +1,208 @@
+# -----------------------------------------------------------------------------
+# 
+# OGC CS factory for RGeo
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module RGeo
+  
+  module CoordSys
+    
+    
+    # This module contains an implementation of the CS (coordinate
+    # systems) package of the OGC Coordinate Transform spec. It provides
+    # classes for representing ellipsoids, datums, coordinate systems,
+    # and other related concepts, as well as a parser for the WKT format
+    # for specifying coordinate systems.
+    # 
+    # Generally, the easiest way to create coordinate system objects is
+    # to use RGeo::CoordSys::CS.create_from_wkt, which parses the WKT
+    # format. You can also use the create methods available for each
+    # object class.
+    # 
+    # Most but not all of the spec is implemented here.
+    # Currently missing are:
+    # 
+    # * XML format is not implemented. We're assuming that WKT is the
+    #   preferred format.
+    # * The PT and CT packages are not implemented.
+    # * FittedCoordinateSystem is not implemented.
+    # * The defaultEnvelope attribute of CS_CoordinateSystem is not
+    #   implemented.
+    
+    module CS
+      
+      
+      # A class implementing the CS_CoordinateSystemFactory interface.
+      # It provides methods for building up complex objects from simpler
+      # objects or values.
+      # 
+      # Note that the methods of CS_CoordinateSystemFactory do not provide
+      # facilities for setting the authority. If you need to set authority
+      # values, use the create methods for the object classes themselves.
+      
+      class CoordinateSystemFactory
+        
+        
+        # Create a CompoundCoordinateSystem from a name, and two
+        # constituent coordinate systems.
+        
+        def create_compound_coordinate_system(name_, head_, tail_)
+          CompoundCoordinateSystem.create(name_, head_, tail_)
+        end
+        
+        
+        # Create an Ellipsoid from a name, semi-major axis, and semi-minor
+        # axis. You can also provide a LinearUnit, but this is optional
+        # and may be set to nil.
+        
+        def create_ellipsoid(name_, semi_major_axis_, semi_minor_axis_, linear_unit_)
+          Ellipsoid.create_ellipsoid(name_, semi_major_axis_, semi_minor_axis_, linear_unit_)
+        end
+        
+        
+        # Create an Ellipsoid from a name, semi-major axis, and an inverse
+        # flattening factor. You can also provide a LinearUnit, but this
+        # is optional and may be set to nil.
+        
+        def create_flattened_sphere(name_, semi_major_axis_, inverse_flattening_, linear_unit_)
+          Ellipsoid.create_flattened_sphere(name_, semi_major_axis_, inverse_flattening_, linear_unit_)
+        end
+        
+        
+        # Create any object given the OGC WKT format. Raises
+        # Error::ParseError if a syntax error is encounterred.
+        
+        def create_from_wkt(str_)
+          WKTParser.new(str_).parse
+        end
+        
+        
+        # Create a GeographicCoordinateSystem, given a name, an
+        # AngularUnit, a HorizontalDatum, a PrimeMeridian, and two
+        # AxisInfo objects. The AxisInfo objects are optional and may be
+        # set to nil.
+        
+        def create_geographic_coordinate_system(name_, angular_unit_, horizontal_datum_, prime_meridian_, axis0_, axis1_)
+          GeographicCoordinateSystem.create(name_, angular_unit_, horizontal_datum_, prime_meridian_, axis0_, axis1_)
+        end
+        
+        
+        # Create a HorizontalDatum given a name, a horizontal datum type
+        # code, an Ellipsoid, and a WGS84ConversionInfo. The
+        # WGS84ConversionInfo is optional and may be set to nil.
+
+        def create_horizontal_datum(name_, horizontal_datum_type_, ellipsoid_, to_wgs84_)
+          HorizontalDatum.create(name_, horizontal_datum_type_, ellipsoid_, to_wgs84_)
+        end
+        
+        
+        # Create a LocalCoordinateSystem given a name, a LocalDatum, a
+        # Unit, and an array of at least one AxisInfo.
+        
+        def create_local_coordinate_system(name_, datum_, unit_, axes_)
+          LocalCoordinateSystem.create(name_, datum_, unit_, axes_)
+        end
+        
+        
+        # Create a LocalDatum given a name and a local datum type code.
+        
+        def create_local_datum(name_, local_datum_type_)
+          LocalDatum.create(name, local_datum_type_)
+        end
+        
+        
+        # Create a PrimeMeridian given a name, an AngularUnit, and a
+        # longitude offset.
+        
+        def create_prime_meridian(name_, angular_unit_, longitude_)
+          PrimeMeridian.create(name, angular_unit_, longitude_)
+        end
+        
+        
+        # Create a ProjectedCoordinateSystem given a name, a
+        # GeographicCoordinateSystem, and Projection, a LinearUnit, and
+        # two AxisInfo objects. The AxisInfo objects are optional and may
+        # be set to nil.
+        
+        def create_projected_coordinate_system(name_, gcs_, projection_, linear_unit_, axis0_, axis1_)
+          ProjectedCoordinateSystem.create(name_, gcs_, projection_, linear_unit_, axis0_, axis1_)
+        end
+        
+        
+        # Create a Projection given a name, a projection class, and an
+        # array of ProjectionParameter.
+        
+        def create_projection(name_, wkt_projection_class_, parameters_)
+          Projection.create(name_, wkt_projection_class_, parameters_)
+        end
+        
+        
+        # Create a VerticalCoordinateSystem given a name, a VerticalDatum,
+        # a VerticalUnit, and an AxisInfo. The AxisInfo is optional and
+        # may be nil.
+        
+        def create_vertical_coordinate_system(name_, vertical_datum_, vertical_unit_, axis_)
+          VerticalCoordinateSystem.create(name_, vertical_datum_, vertical_unit_, axis_)
+        end
+        
+        
+        # Create a VerticalDatum given a name ane a datum type code.
+        
+        def create_vertical_datum(name_, vertical_datum_type_)
+          VerticalDatum.create(name_, vertical_datum_type_)
+        end
+        
+        
+      end
+      
+      
+      class << self
+        
+        
+        # Parsees OGC WKT format and returns the object created. Raises
+        # Error::ParseError if a syntax error is encounterred.
+        
+        def create_from_wkt(str_)
+          WKTParser.new(str_).parse
+        end
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end

data/lib/rgeo/coord_sys/cs/wkt_parser.rb

@@ -0,0 +1,308 @@
+# -----------------------------------------------------------------------------
+# 
+# OGC CS wkt parser for RGeo
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module RGeo
+  
+  module CoordSys
+    
+    
+    module CS
+      
+      
+      class WKTParser  # :nodoc:
+        
+        def initialize(str_)
+          @scanner = ::StringScanner.new(str_)
+          next_token
+        end
+        
+        
+        def parse(containing_type_=nil)
+          if @cur_token.kind_of?(QuotedString) ||
+              @cur_token.kind_of?(::Numeric) ||
+              (containing_type_ == 'AXIS' && @cur_token.kind_of?(TypeString))
+            value_ = @cur_token
+            next_token
+            return value_
+          end
+          unless @cur_token.kind_of?(TypeString)
+            raise Error::ParseError("Found token #{@cur_token} when we expected a value")
+          end
+          type_ = @cur_token
+          next_token
+          consume_token_type(:begin)
+          args_ = ArgumentList.new
+          args_ << parse(type_)
+          loop do
+            break unless @cur_token == :comma
+            next_token
+            args_ << parse(type_)
+          end
+          consume_token_type(:end)
+          obj_ = nil
+          case type_
+          when 'AUTHORITY'
+            obj_ = AuthorityClause.new(args_.shift(QuotedString), args_.shift(QuotedString))
+          when 'AXIS'
+            obj_ = AxisInfo.create(args_.shift(QuotedString), args_.shift(TypeString))
+          when 'TOWGS84'
+            bursa_wolf_params_ = args_.find_all(::Numeric)
+            unless bursa_wolf_params_.size == 7
+              raise Error::ParseError("Expected 7 Bursa Wolf parameters but found #{bursa_wolf_params_.size}")
+            end
+            obj_ = WGS84ConversionInfo.create(*bursa_wolf_params_)
+          when 'UNIT'
+            case containing_type_
+            when 'GEOCCS', 'VERT_CS', 'PROJCS', 'SPHEROID'
+              klass_ = LinearUnit
+            when 'GEOGCS'
+              klass_ = AngularUnit
+            else
+              klass_ = Unit
+            end
+            obj_ = klass_.create(args_.shift(QuotedString), args_.shift(::Numeric), *args_.find_first(AuthorityClause).to_a)
+          when 'PARAMETER'
+            obj_ = ProjectionParameter.create(args_.shift(QuotedString), args_.shift(::Numeric))
+          when 'PRIMEM'
+            obj_ = PrimeMeridian.create(args_.shift(QuotedString), nil, args_.shift(::Numeric), *args_.find_first(AuthorityClause).to_a)
+          when 'SPHEROID'
+            obj_ = Ellipsoid.create_flattened_sphere(args_.shift(QuotedString), args_.shift(::Numeric), args_.shift(::Numeric), args_.find_first(LinearUnit), *args_.find_first(AuthorityClause).to_a)
+          when 'PROJECTION'
+            name_ = args_.shift(QuotedString)
+            obj_ = Projection.create(name_, name_, args_.find_all(ProjectionParameter), *args_.find_first(AuthorityClause).to_a)
+          when 'DATUM'
+            name_ = args_.shift(QuotedString)
+            ellipsoid_ = args_.find_first(Ellipsoid)
+            to_wgs84_ = args_.find_first(WGS84ConversionInfo)
+            obj_ = HorizontalDatum.create(name_, HD_GEOCENTRIC, ellipsoid_, to_wgs84_, *args_.find_first(AuthorityClause).to_a)
+          when 'VERT_DATUM'
+            obj_ = VerticalDatum.create(args_.shift(QuotedString), args_.shift(::Numeric), *args_.find_first(AuthorityClause).to_a)
+          when 'LOCAL_DATUM'
+            obj_ = LocalDatum.create(args_.shift(QuotedString), args_.shift(::Numeric), *args_.find_first(AuthorityClause).to_a)
+          when 'COMPD_CS'
+            obj_ = CompoundCoordinateSystem.create(args_.shift(QuotedString), args_.shift(CoordinateSystem), args_.shift(CoordinateSystem), *args_.find_first(AuthorityClause).to_a)
+          when 'LOCAL_CS'
+            name_ = args_.shift(QuotedString)
+            local_datum_ = args_.find_first(LocalDatum)
+            unit_ = args_.find_first(Unit)
+            axes_ = args_.find_all(AxisInfo)
+            unless axes_.size > 0
+              raise Error::ParseError("Expected at least one AXIS in a LOCAL_CS")
+            end
+            obj_ = LocalCoordinateSystem.create(name_, local_datum_, unit_, axes_, *args_.find_first(AuthorityClause).to_a)
+          when 'GEOCCS'
+            name_ = args_.shift(QuotedString)
+            horizontal_datum_ = args_.find_first(HorizontalDatum)
+            prime_meridian_ = args_.find_first(PrimeMeridian)
+            linear_unit_ = args_.find_first(LinearUnit)
+            axes_ = args_.find_all(AxisInfo)
+            unless axes_.size == 0 || axes_.size == 3
+              raise Error::ParseError("GEOCCS must contain either 0 or 3 AXIS parameters")
+            end
+            obj_ = GeocentricCoordinateSystem.create(name_, horizontal_datum_, prime_meridian_, linear_unit_, axes_[0], axes_[1], axes_[2], *args_.find_first(AuthorityClause).to_a)
+          when 'VERT_CS'
+            name_ = args_.shift(QuotedString)
+            vertical_datum_ = args_.find_first(VerticalDatum)
+            linear_unit_ = args_.find_first(LinearUnit)
+            axis_ = args_.find_first(AxisInfo)
+            obj_ = VerticalCoordinateSystem.create(name_, vertical_datum_, linear_unit_, axis_, *args_.find_first(AuthorityClause).to_a)
+          when 'GEOGCS'
+            name_ = args_.shift(QuotedString)
+            horizontal_datum_ = args_.find_first(HorizontalDatum)
+            prime_meridian_ = args_.find_first(PrimeMeridian)
+            angular_unit_ = args_.find_first(AngularUnit)
+            axes_ = args_.find_all(AxisInfo)
+            unless axes_.size == 0 || axes_.size == 2
+              raise Error::ParseError("GEOGCS must contain either 0 or 2 AXIS parameters")
+            end
+            obj_ = GeographicCoordinateSystem.create(name_, angular_unit_, horizontal_datum_, prime_meridian_, axes_[0], axes_[1], *args_.find_first(AuthorityClause).to_a)
+          when 'PROJCS'
+            name_ = args_.shift(QuotedString)
+            geographic_coordinate_system_ = args_.find_first(GeographicCoordinateSystem)
+            projection_ = args_.find_first(Projection)
+            parameters_ = args_.find_all(ProjectionParameter)
+            projection_.instance_variable_get(:@parameters).concat(parameters_)
+            linear_unit_ = args_.find_first(LinearUnit)
+            axes_ = args_.find_all(AxisInfo)
+            unless axes_.size == 0 || axes_.size == 2
+              raise Error::ParseError("PROJCS must contain either 0 or 2 AXIS parameters")
+            end
+            obj_ = ProjectedCoordinateSystem.create(name_, geographic_coordinate_system_, projection_, linear_unit_, axes_[0], axes_[1], *args_.find_first(AuthorityClause).to_a)
+          else
+            raise Error::ParseError, "Unrecognized type: #{type_}"
+          end
+          args_.assert_empty
+          obj_
+        end
+        
+        
+        def consume_token_type(type_)  # :nodoc:
+          expect_token_type(type_)
+          tok_ = @cur_token
+          next_token
+          tok_
+        end
+        
+        def expect_token_type(type_)  # :nodoc:
+          unless type_ === @cur_token
+            raise Error::ParseError, "#{type_.inspect} expected but #{@cur_token.inspect} found."
+          end
+        end
+        
+        def next_token  # :nodoc:
+          @scanner.skip(/\s+/)
+          case @scanner.peek(1)
+          when '"'
+            @scanner.getch
+            @cur_token = QuotedString.new(@scanner.scan(/[^"]*/))
+            @scanner.getch
+          when ','
+            @scanner.getch
+            @cur_token = :comma
+          when '(','['
+            @scanner.getch
+            @cur_token = :begin
+          when ']',')'
+            @scanner.getch
+            @cur_token = :end
+          when /[a-zA-Z]/
+            @cur_token = TypeString.new(@scanner.scan(/[a-zA-Z]\w*/))
+          when '', nil
+            @cur_token = nil
+          else
+            @scanner.scan_until(/[^\s\(\)\[\],"]+/)
+            token_ = @scanner.matched
+            if token_ =~ /^[-+]?(\d+(\.\d*)?|\.\d+)(e[-+]?\d+)?$/
+              @cur_token = token_.to_f
+            else
+              raise Error::ParseError, "Bad token: #{token_.inspect}"
+            end
+          end
+          @cur_token
+        end
+        
+        def cur_token  # :nodoc:
+          @cur_token
+        end
+        
+        
+        class QuotedString < ::String  # :nodoc:
+        end
+        
+        class TypeString < ::String  # :nodoc:
+        end
+        
+        
+        class AuthorityClause  # :nodoc:
+          
+          def initialize(name_, code_)
+            @name = name_
+            @code = code_
+          end
+          
+          def to_a
+            [@name, @code]
+          end
+          
+        end
+        
+        
+        class ArgumentList  # :nodoc:
+          
+          def initialize
+            @values = []
+          end
+          
+          def <<(value_)
+            @values << value_
+          end
+          
+          def assert_empty
+            if @values.size > 0
+              names_ = @values.map do |val_|
+                val_.kind_of?(Base) ? val_._wkt_typename : val_.inspect
+              end
+              raise Error::ParseError, "#{@remaining} unexpected arguments: #{names_.join(', ')}"
+            end
+          end
+          
+          def find_first(klass_)
+            @values.each_with_index do |val_, index_|
+              if val_.kind_of?(klass_)
+                @values.slice!(index_)
+                return val_
+              end
+            end
+            nil
+          end
+          
+          def find_all(klass_)
+            results_ = []
+            nvalues_ = []
+            @values.each do |val_|
+              if val_.kind_of?(klass_)
+                results_ << val_
+              else
+                nvalues_ << val_
+              end
+            end
+            @values = nvalues_
+            results_
+          end
+          
+          def shift(klass_=nil)
+            val_ = @values.shift
+            unless val_
+              raise Error::ParseError, "No arguments left... expected #{klass_}"
+            end
+            if klass_ && !val_.kind_of?(klass_)
+              raise Error::ParseError, "Expected #{klass_} but got #{val_.class}"
+            end
+            val_
+          end
+          
+        end
+        
+        
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end