Class: REXML::Source

Attributes

buffer	[R]	The current buffer (what we‘re going to read next)
encoding	[R]
line	[R]	The line number of the last consumed text

Public Class methods

new(arg, encoding=nil)

Constructor @param arg must be a String, and should be a valid XML document @param encoding if non-null, sets the encoding of the source to this value, overriding all encoding detection

[Source]

# File rexml/source.rb, line 40
    def initialize(arg, encoding=nil)
      @orig = @buffer = arg
      if encoding
        self.encoding = encoding
      else
        self.encoding = check_encoding( @buffer )
      end
      @line = 0
    end

Public Instance methods

consume( pattern )

[Source]

# File rexml/source.rb, line 90
    def consume( pattern )
      @buffer = $' if pattern.match( @buffer )
    end

current_line()

@return the current line in the source

[Source]

# File rexml/source.rb, line 120
    def current_line
      lines = @orig.split
      res = lines.grep @buffer[0..30]
      res = res[-1] if res.kind_of? Array
      lines.index( res ) if res
    end

empty?()

@return true if the Source is exhausted

[Source]

# File rexml/source.rb, line 111
    def empty?
      @buffer == ""
    end

encoding=(enc)

Inherited from Encoding Overridden to support optimized en/decoding

[Source]

# File rexml/source.rb, line 53
    def encoding=(enc)
      return unless super
      @line_break = encode( '>' )
      if enc != UTF_8
        @buffer = decode(@buffer)
        @to_utf = true
      else
        @to_utf = false
      end
    end

match(pattern, cons=false)

[Source]

# File rexml/source.rb, line 104
    def match(pattern, cons=false)
      md = pattern.match(@buffer)
      @buffer = $' if cons and md
      return md
    end

match_to( char, pattern )

[Source]

# File rexml/source.rb, line 94
    def match_to( char, pattern )
      return pattern.match(@buffer)
    end

match_to_consume( char, pattern )

[Source]

# File rexml/source.rb, line 98
    def match_to_consume( char, pattern )
      md = pattern.match(@buffer)
      @buffer = $'
      return md
    end

position()

[Source]

# File rexml/source.rb, line 115
    def position
      @orig.index( @buffer )
    end

read()

[Source]

# File rexml/source.rb, line 87
    def read
    end

scan(pattern, cons=false)

Scans the source for a given pattern. Note, that this is not your usual scan() method. For one thing, the pattern argument has some requirements; for another, the source can be consumed. You can easily confuse this method. Originally, the patterns were easier to construct and this method more robust, because this method generated search regexes on the fly; however, this was computationally expensive and slowed down the entire REXML package considerably, since this is by far the most commonly called method. @param pattern must be a Regexp, and must be in the form of /^\s*(#{your pattern, with no groups})(.*)/. The first group will be returned; the second group is used if the consume flag is set. @param consume if true, the pattern returned will be consumed, leaving everything after it in the Source. @return the pattern, if found, or nil if the Source is empty or the pattern is not found.

[Source]

# File rexml/source.rb, line 80
    def scan(pattern, cons=false)
      return nil if @buffer.nil?
      rv = @buffer.scan(pattern)
      @buffer = $' if cons and rv.size>0
      rv
    end

Methods

Included Modules

Attributes

Public Class methods

Public Instance methods