Class: REXML::Source

Inherits:
Object show all
Includes:
Encoding
Defined in:
lib/rexml/source.rb

Overview

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

Direct Known Subclasses

IOSource

Constant Summary

Constants included from Encoding

Encoding::UNILE, Encoding::UTF_16, Encoding::UTF_8

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Encoding

apply, #check_encoding, #decode_ascii, #decode_cp1252, #decode_iconv, #decode_unile, #decode_utf16, #decode_utf8, #encode_ascii, #encode_cp1252, #encode_iconv, #encode_unile, #encode_utf16, #encode_utf8, encoding_method, #from_iso_8859_15, register, #to_iso_8859_15

Constructor Details

#initialize(arg, encoding = nil) ⇒ Source

Constructor value, overriding all encoding detection

Parameters:

  • arg —

    must be a String, and should be a valid XML document

  • encoding (defaults to: nil) —

    if non-null, sets the encoding of the source to this



40
41
42
43
44
45
46
47
48
 
# File 'lib/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

Instance Attribute Details

#buffer ⇒ Object (readonly)

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



31
32
33
 
# File 'lib/rexml/source.rb', line 31

def buffer
  @buffer
end

#encoding ⇒ Object

Returns the value of attribute encoding



34
35
36
 
# File 'lib/rexml/source.rb', line 34

def encoding
  @encoding
end

#line ⇒ Object (readonly)

The line number of the last consumed text



33
34
35
 
# File 'lib/rexml/source.rb', line 33

def line
  @line
end

Instance Method Details

#consume(pattern) ⇒ Object 



90
91
92
 
# File 'lib/rexml/source.rb', line 90

def consume( pattern )
  @buffer = $' if pattern.match( @buffer )
end

#current_line ⇒ Object

Returns the current line in the source.

Returns:

  • the current line in the source



120
121
122
123
124
125
 
# File 'lib/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? ⇒ Boolean

Returns true if the Source is exhausted.

Returns:

  • (Boolean) —

    true if the Source is exhausted



111
112
113
 
# File 'lib/rexml/source.rb', line 111

def empty?
  @buffer == ""
end

#match(pattern, cons = false) ⇒ Object 



104
105
106
107
108
 
# File 'lib/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) ⇒ Object 



94
95
96
 
# File 'lib/rexml/source.rb', line 94

def match_to( char, pattern )
  return pattern.match(@buffer)
end

#match_to_consume(char, pattern) ⇒ Object 



98
99
100
101
102
 
# File 'lib/rexml/source.rb', line 98

def match_to_consume( char, pattern )
  md = pattern.match(@buffer)
  @buffer = $'
  return md
end

#position ⇒ Object 



115
116
117
 
# File 'lib/rexml/source.rb', line 115

def position
  @orig.index( @buffer )
end

#read ⇒ Object 



87
88
 
# File 'lib/rexml/source.rb', line 87

def read
end

#scan(pattern, cons = false) ⇒ Object

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. /^s*(#pattern, with no groups)(.*)/. The first group will be returned; the second group is used if the consume flag is set. everything after it in the Source. pattern is not found.

Parameters:

  • pattern —

    must be a Regexp, and must be in the form of

  • consume —

    if true, the pattern returned will be consumed, leaving

Returns:

  • the pattern, if found, or nil if the Source is empty or the



80
81
82
83
84
85
 
# File 'lib/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