Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rexml/source.rb

Class/Module Index [+]



A Source can be searched for patterns, and wraps buffers and other objects and provides consumption of text



The current buffer (what we're going to read next)


The line number of the last consumed text

Public Class Methods

new(arg, encoding=nil) click to toggle source

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

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

Public Instance Methods

consume( pattern ) click to toggle source
               # File rexml/source.rb, line 94
def consume( pattern )
  @buffer = $' if pattern.match( @buffer )
current_line() click to toggle source

@return the current line in the source

               # File rexml/source.rb, line 124
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
empty?() click to toggle source

@return true if the Source is exhausted

               # File rexml/source.rb, line 115
def empty?
  @buffer == ""
encoding=(enc) click to toggle source

Inherited from Encoding Overridden to support optimized en/decoding

               # File rexml/source.rb, line 54
def encoding=(enc)
  return unless super
  @line_break = encode( '>' )
  if enc != UTF_8
    @buffer = decode(@buffer)
    @to_utf = true
    @to_utf = false
    if @buffer.respond_to? :force_encoding
      @buffer.force_encoding Encoding::UTF_8
match(pattern, cons=false) click to toggle source
               # File rexml/source.rb, line 108
def match(pattern, cons=false)
  md = pattern.match(@buffer)
  @buffer = $' if cons and md
  return md
match_to( char, pattern ) click to toggle source
               # File rexml/source.rb, line 98
def match_to( char, pattern )
  return pattern.match(@buffer)
match_to_consume( char, pattern ) click to toggle source
               # File rexml/source.rb, line 102
def match_to_consume( char, pattern )
  md = pattern.match(@buffer)
  @buffer = $'
  return md
position() click to toggle source
               # File rexml/source.rb, line 119
def position
  @orig.index( @buffer )
read() click to toggle source
               # File rexml/source.rb, line 91
def read
scan(pattern, cons=false) click to toggle source

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.

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