Ruby REXML::Source Functions

EditRocket provides the following information on REXML::Source functions in the Ruby source code builder.

consume( pattern ) -

current_line() - "@return the current line in the source"

empty?() - "@return true if the Source is exhausted"

encoding=(enc) - Inherited from Encoding Overridden to support optimized en/decoding

match(pattern, cons=false) -

match_to( char, pattern ) -

match_to_consume( char, pattern ) -

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

position() -

read() -

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.