schleyfox-rgeo 0.2.5

data/lib/rgeo/wkrep/wkb_parser.rb

@@ -0,0 +1,315 @@
+# -----------------------------------------------------------------------------
+# 
+# Well-known binary 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 WKRep
+    
+    
+    # This class provides the functionality of parsing a geometry from
+    # WKB (well-known binary) format. You may also customize the parser
+    # to recognize PostGIS EWKB extensions to the input, or Simple
+    # Features Specification 1.2 extensions for Z and M coordinates.
+    # 
+    # To use this class, create an instance with the desired settings and
+    # customizations, and call the parse method.
+    # 
+    # === Configuration options
+    # 
+    # You must provide each parser with an RGeo::Feature::FactoryGenerator.
+    # It should understand the configuration options <tt>:srid</tt>,
+    # <tt>:has_z_coordinate</tt>, and <tt>:has_m_coordinate</tt>.
+    # You may also pass a specific RGeo::Feature::Factory, or nil to
+    # specify the default Cartesian FactoryGenerator.
+    # 
+    # The following additional options are recognized. These can be passed
+    # to the constructor, or set on the object afterwards.
+    # 
+    # [<tt>:support_ewkb</tt>]
+    #   Activate support for PostGIS EWKB type codes, which use high
+    #   order bits in the type code to signal the presence of Z, M, and
+    #   SRID values in the data. Default is false.
+    # [<tt>:support_wkb12</tt>]
+    #   Activate support for SFS 1.2 extensions to the type codes, which
+    #   use values greater than 1000 to signal the presence of Z and M
+    #   values in the data. SFS 1.2 types such as triangle, tin, and
+    #   polyhedralsurface are NOT yet supported. Default is false.
+    # [<tt>:ignore_extra_bytes</tt>]
+    #   If true, extra bytes at the end of the data are ignored. If
+    #   false (the default), extra bytes will trigger a parse error.
+    # [<tt>:default_srid</tt>]
+    #   A SRID to pass to the factory generator if no SRID is present in
+    #   the input. Defaults to nil (i.e. don't specify a SRID).
+    
+    class WKBParser
+      
+      
+      # Create and configure a WKB parser. See the WKBParser
+      # documentation for the options that can be passed.
+      
+      def initialize(factory_generator_=nil, opts_={})
+        self.factory_generator = factory_generator_
+        @support_ewkb = opts_[:support_ewkb] ? true : false
+        @support_wkb12 = opts_[:support_wkb12] ? true : false
+        @ignore_extra_bytes = opts_[:ignore_extra_bytes] ? true : false
+        @default_srid = opts_[:default_srid]
+      end
+      
+      
+      # Returns the factory generator. See WKBParser for details.
+      def factory_generator
+        @factory_generator
+      end
+      
+      # If this parser was given an exact factory, returns it; otherwise
+      # returns nil.
+      def exact_factory
+        @exact_factory
+      end
+      
+      # Sets the factory_generator. See WKBParser for details.
+      def factory_generator=(value_)
+        if value_.kind_of?(Feature::Factory::Instance)
+          @factory_generator = Feature::FactoryGenerator.single(value_)
+          @exact_factory = value_
+        elsif value_.respond_to?(:call)
+          @factory_generator = value_
+          @exact_factory = nil
+        else
+          @factory_generator = Cartesian.method(:preferred_factory)
+          @exact_factory = nil
+        end
+      end
+      
+      # Sets the factory_generator to the given block.
+      # See WKBParser for details.
+      def to_generate_factory(&block_)
+        @factory_generator = block_
+      end
+      
+      # Returns true if this parser supports EWKB.
+      # See WKBParser for details.
+      def support_ewkb?
+        @support_ewkb
+      end
+      
+      # Sets the the support_ewkb flag. See WKBParser for details.
+      def support_ewkb=(value_)
+        @support_ewkb = value_ ? true : false
+      end
+      
+      # Returns true if this parser supports SFS 1.2 extensions.
+      # See WKBParser for details.
+      def support_wkb12?
+        @support_wkb12
+      end
+      
+      # Sets the the support_wkb12 flag. See WKBParser for details.
+      def support_wkb12=(value_)
+        @support_wkb12 = value_ ? true : false
+      end
+      
+      # Returns true if this parser ignores extra bytes.
+      # See WKBParser for details.
+      def ignore_extra_bytes?
+        @ignore_extra_bytes
+      end
+      
+      # Sets the the ignore_extra_bytes flag. See WKBParser for details.
+      def ignore_extra_bytes=(value_)
+        @ignore_extra_bytes = value_ ? true : false
+      end
+      
+      
+      # Parse the given hex string, and return a geometry object.
+      
+      def parse_hex(str_)
+        parse([str_].pack('H*'))
+      end
+      
+      
+      # Parse the given binary data, and return a geometry object.
+      
+      def parse(data_)
+        @cur_has_z = nil
+        @cur_has_m = nil
+        @cur_srid = nil
+        @cur_dims = 2
+        @cur_factory = nil
+        begin
+          _start_scanner(data_)
+          obj_ = _parse_object(false)
+          unless @ignore_extra_bytes
+            bytes_ = _bytes_remaining
+            if bytes_ > 0
+              raise Error::ParseError, "Found #{bytes_} extra bytes at the end of the stream."
+            end
+          end
+        ensure
+          _clean_scanner
+        end
+        obj_
+      end
+      
+      
+      def _parse_object(contained_)  # :nodoc:
+        little_endian_ = _get_byte == 1
+        type_code_ = _get_integer(little_endian_)
+        has_z_ = false
+        has_m_ = false
+        srid_ = contained_ ? nil : @default_srid
+        if @support_ewkb
+          has_z_ ||= type_code_ & 0x80000000 != 0
+          has_m_ ||= type_code_ & 0x40000000 != 0
+          srid_ = _get_integer(little_endian_) if type_code_ & 0x20000000 != 0
+          type_code_ &= 0x0fffffff
+        end
+        if @support_wkb12
+          has_z_ ||= (type_code_ / 1000) & 1 != 0
+          has_m_ ||= (type_code_ / 1000) & 2 != 0
+          type_code_ %= 1000
+        end
+        if contained_
+          if contained_ != true && contained_ != type_code_
+            raise Error::ParseError, "Enclosed type=#{type_code_} is different from container constraint #{contained_}"
+          end
+          if has_z_ != @cur_has_z
+            raise Error::ParseError, "Enclosed hasZ=#{has_z_} is different from toplevel hasZ=#{@cur_has_z}"
+          end
+          if has_m_ != @cur_has_m
+            raise Error::ParseError, "Enclosed hasM=#{has_m_} is different from toplevel hasM=#{@cur_has_m}"
+          end
+          if srid_ && srid_ != @cur_srid
+            raise Error::ParseError, "Enclosed SRID #{srid_} is different from toplevel srid #{@cur_srid || '(unspecified)'}"
+          end
+        else
+          @cur_has_z = has_z_
+          @cur_has_m = has_m_
+          @cur_dims = 2 + (@cur_has_z ? 1 : 0) + (@cur_has_m ? 1 : 0)
+          @cur_srid = srid_
+          @cur_factory = @factory_generator.call(:srid => @cur_srid, :has_z_coordinate => has_z_, :has_m_coordinate => has_m_)
+          if @cur_has_z && !@cur_factory.property(:has_z_coordinate)
+            raise Error::ParseError, "Data has Z coordinates but the factory doesn't have Z coordinates"
+          end
+          if @cur_has_m && !@cur_factory.property(:has_m_coordinate)
+            raise Error::ParseError, "Data has M coordinates but the factory doesn't have M coordinates"
+          end
+        end
+        case type_code_
+        when 1
+          coords_ = _get_doubles(little_endian_, @cur_dims)
+          @cur_factory.point(*coords_)
+        when 2
+          _parse_line_string(little_endian_)
+        when 3
+          interior_rings_ = (1.._get_integer(little_endian_)).map{ _parse_line_string(little_endian_) }
+          exterior_ring_ = interior_rings_.shift || @cur_factory.linear_ring([])
+          @cur_factory.polygon(exterior_ring_, interior_rings_)
+        when 4
+          @cur_factory.multi_point((1.._get_integer(little_endian_)).map{ _parse_object(1) })
+        when 5
+          @cur_factory.multi_line_string((1.._get_integer(little_endian_)).map{ _parse_object(2) })
+        when 6
+          @cur_factory.multi_polygon((1.._get_integer(little_endian_)).map{ _parse_object(3) })
+        when 7
+          @cur_factory.collection((1.._get_integer(little_endian_)).map{ _parse_object(true) })
+        else
+          raise Error::ParseError, "Unknown type value: #{type_code_}."
+        end
+      end
+      
+      
+      def _parse_line_string(little_endian_)  # :nodoc:
+        count_ = _get_integer(little_endian_)
+        coords_ = _get_doubles(little_endian_, @cur_dims * count_)
+        @cur_factory.line_string((0...count_).map{ |i_| @cur_factory.point(*coords_[@cur_dims*i_,@cur_dims]) })
+      end
+      
+      
+      def _start_scanner(data_)  # :nodoc:
+        @_data = data_
+        @_len = data_.length
+        @_pos = 0
+      end
+      
+      
+      def _clean_scanner  # :nodoc:
+        @_data = nil
+      end
+      
+      
+      def _bytes_remaining  # :nodoc:
+        @_len - @_pos
+      end
+      
+      
+      def _get_byte  # :nodoc:
+        if @_pos + 1 > @_len
+          raise Error::ParseError, "Not enough bytes left to fulfill 1 byte"
+        end
+        str_ = @_data[@_pos, 1]
+        @_pos += 1
+        str_.unpack("C").first
+      end
+      
+      
+      def _get_integer(little_endian_)  # :nodoc:
+        if @_pos + 4 > @_len
+          raise Error::ParseError, "Not enough bytes left to fulfill 1 integer"
+        end
+        str_ = @_data[@_pos, 4]
+        @_pos += 4
+        str_.unpack("#{little_endian_ ? 'V' : 'N'}").first
+      end
+      
+      
+      def _get_doubles(little_endian_, count_)  # :nodoc:
+        len_ = 8 * count_
+        if @_pos + len_ > @_len
+          raise Error::ParseError, "Not enough bytes left to fulfill #{count_} doubles"
+        end
+        str_ = @_data[@_pos, len_]
+        @_pos += len_
+        str_.unpack("#{little_endian_ ? 'E' : 'G'}*")
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/wkrep/wkt_generator.rb

@@ -0,0 +1,275 @@
+# -----------------------------------------------------------------------------
+# 
+# Well-known text generator 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 WKRep
+    
+    
+    # This class provides the functionality of serializing a geometry as
+    # WKT (well-known text) format. You may also customize the serializer
+    # to generate PostGIS EWKT extensions to the output, or to follow the
+    # Simple Features Specification 1.2 extensions for Z and M.
+    # 
+    # To use this class, create an instance with the desired settings and
+    # customizations, and call the generate method.
+    # 
+    # === Configuration options
+    # 
+    # The following options are recognized. These can be passed to the
+    # constructor, or set on the object afterwards.
+    # 
+    # [<tt>:tag_format</tt>]
+    #   The format for tags. Possible values are <tt>:wkt11</tt>,
+    #   indicating SFS 1.1 WKT (i.e. no Z or M markers in the tags) but
+    #   with Z and/or M values added in if they are present;
+    #   <tt>:wkt11_strict</tt>, indicating SFS 1.1 WKT with Z and M
+    #   dropped from the output (since WKT strictly does not support
+    #   the Z or M dimensions); <tt>:ewkt</tt>, indicating the PostGIS
+    #   EWKT extensions (i.e. "M" appended to tag names if M but not
+    #   Z is present); or <tt>:wkt12</tt>, indicating SFS 1.2 WKT
+    #   tags that indicate the presence of Z and M in a separate token.
+    #   Default is <tt>:wkt11</tt>.
+    # [<tt>:emit_ewkt_srid</tt>]
+    #   If true, embed the SRID of the toplevel geometry. Available only
+    #   if <tt>:type_format</tt> is <tt>:ewkt</tt>. Default is false.
+    # [<tt>:square_brackets</tt>]
+    #   If true, uses square brackets rather than parentheses.
+    #   Default is false.
+    # [<tt>:convert_case</tt>]
+    #   Possible values are <tt>:upper</tt>, which changes all letters
+    #   in the output to ALL CAPS; <tt>:lower</tt>, which changes all
+    #   letters to lower case; or nil, indicating no case changes from
+    #   the default (which is not specified exactly, but is chosen by the
+    #   generator to emphasize readability.) Default is nil.
+    
+    class WKTGenerator
+      
+      
+      # Create and configure a WKT generator. See the WKTGenerator
+      # documentation for the options that can be passed.
+      
+      def initialize(opts_={})
+        @tag_format = opts_[:tag_format] || :wkt11
+        @emit_ewkt_srid = opts_[:emit_ewkt_srid] ? true : false if @tag_format == :ewkt
+        @square_brackets = opts_[:square_brackets] ? true : false
+        @convert_case = opts_[:convert_case]
+      end
+      
+      
+      # Returns the format for type tags. See WKTGenerator for details.
+      def tag_format
+        @tag_format
+      end
+      
+      # Sets the format for type tags. See WKTGenerator for details.
+      def tag_format=(value_)
+        @tag_format = value_
+      end
+      
+      # Returns whether SRID is embedded. See WKTGenerator for details.
+      def emit_ewkt_srid?
+        @emit_ewkt_srid
+      end
+      
+      # Sets whether SRID is embedded. Available only when the tag_format
+      # is <tt>:ewkt</tt>. See WKTGenerator for details.
+      def emit_ewkt_srid=(value_)
+        @emit_ewkt_srid = @type_format == :ewkt && value_
+      end
+      
+      # Returns whether square brackets rather than parens are output.
+      # See WKTGenerator for details.
+      def square_brackets?
+        @square_brackets
+      end
+      
+      # Sets whether square brackets rather than parens are output.
+      # See WKTGenerator for details.
+      def square_brackets=(value_)
+        @square_brackets = value_ ? true : false
+      end
+      
+      # Returns the case for output. See WKTGenerator for details.
+      def convert_case
+        @convert_case
+      end
+      
+      # Sets the case for output. See WKTGenerator for details.
+      def convert_case=(value_)
+        @convert_case = value_
+      end
+      
+      
+      # Generate and return the WKT format for the given geometry object,
+      # according to the current settings.
+      
+      def generate(obj_)
+        @begin_bracket = @square_brackets ? '[' : '('
+        @end_bracket = @square_brackets ? ']' : ')'
+        factory_ = obj_.factory
+        if @tag_format == :wkt11_strict
+          @cur_support_z = nil
+          @cur_support_m = nil
+        else
+          @cur_support_z = factory_.property(:has_z_coordinate)
+          @cur_support_m = factory_.property(:has_m_coordinate)
+        end
+        str_ = _generate_feature(obj_, true)
+        if @convert_case == :upper
+          str_.upcase
+        elsif @convert_case == :lower
+          str_.downcase
+        else
+          str_
+        end
+      end
+      
+      
+      def _generate_feature(obj_, toplevel_=false)  # :nodoc:
+        type_ = obj_.geometry_type
+        tag_ = type_.type_name
+        if @tag_format == :ewkt
+          if @cur_support_m && !@cur_support_z
+            tag_ << 'M'
+          end
+          if toplevel_ && @emit_ewkt_srid
+            tag_ = "SRID=#{obj_.srid};#{tag_}"
+          end
+        elsif @tag_format == :wkt12
+          if @cur_support_z
+            if @cur_support_m
+              tag_ << ' ZM'
+            else
+              tag_ << ' Z'
+            end
+          elsif @cur_support_m
+            tag_ << ' M'
+          end
+        end
+        if type_ == Feature::Point
+          tag_ + _generate_point(obj_)
+        elsif type_.subtype_of?(Feature::LineString)
+          tag_ + _generate_line_string(obj_)
+        elsif type_ == Feature::Polygon
+          tag_ + _generate_polygon(obj_)
+        elsif type_ == Feature::GeometryCollection
+          tag_ + _generate_geometry_collection(obj_)
+        elsif type_ == Feature::MultiPoint
+          tag_ + _generate_multi_point(obj_)
+        elsif type_ == Feature::MultiLineString
+          tag_ + _generate_multi_line_string(obj_)
+        elsif type_ == Feature::MultiPolygon
+          tag_ + _generate_multi_polygon(obj_)
+        else
+          raise Error::ParseError, "Unrecognized geometry type: #{type_}"
+        end
+      end
+      
+      
+      def _generate_coords(obj_)  # :nodoc:
+        str_ = "#{obj_.x.to_s} #{obj_.y.to_s}"
+        str_ << " #{obj_.z.to_s}" if @cur_support_z
+        str_ << " #{obj_.m.to_s}" if @cur_support_m
+        str_
+      end
+      
+      
+      def _generate_point(obj_)  # :nodoc:
+        "#{@begin_bracket}#{_generate_coords(obj_)}#{@end_bracket}"
+      end
+      
+      
+      def _generate_line_string(obj_, contained_=false)  # :nodoc:
+        if obj_.is_empty?
+          contained_ ? 'EMPTY' : ' EMPTY'
+        else
+          "#{@begin_bracket}#{obj_.points.map{ |p_| _generate_coords(p_) }.join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+      def _generate_polygon(obj_, contained_=false)  # :nodoc:
+        if obj_.is_empty?
+          contained_ ? 'EMPTY' : ' EMPTY'
+        else
+          "#{@begin_bracket}#{([_generate_line_string(obj_.exterior_ring, true)] + obj_.interior_rings.map{ |r_| _generate_line_string(r_, true) }).join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+      def _generate_geometry_collection(obj_)  # :nodoc:
+        if obj_.is_empty?
+          ' EMPTY'
+        else
+          "#{@begin_bracket}#{obj_.map{ |f_| _generate_feature(f_) }.join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+      def _generate_multi_point(obj_)  # :nodoc:
+        if obj_.is_empty?
+          " EMPTY"
+        else
+          "#{@begin_bracket}#{obj_.map{ |f_| _generate_point(f_) }.join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+      def _generate_multi_line_string(obj_)  # :nodoc:
+        if obj_.is_empty?
+          " EMPTY"
+        else
+          "#{@begin_bracket}#{obj_.map{ |f_| _generate_line_string(f_, true) }.join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+      def _generate_multi_polygon(obj_)  # :nodoc:
+        if obj_.is_empty?
+          " EMPTY"
+        else
+          "#{@begin_bracket}#{obj_.map{ |f_| _generate_polygon(f_, true) }.join(',')}#{@end_bracket}"
+        end
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end