Class: REXML::XPathParser

Inherits:
Object show all
Includes:
XMLTokens
Defined in:
lib/rexml/xpath_parser.rb

Overview

You don’t want to use this class. Really. Use XPath, which is a wrapper for this class. Believe me. You don’t want to poke around in here. There is strange, dark magic at work in this code. Beware. Go back! Go back while you still can!

Constant Summary collapse

LITERAL = 
/^'([^']*)'|^"([^"]*)"/u

Constants included from XMLTokens

REXML::XMLTokens::NAME, REXML::XMLTokens::NAMECHAR, REXML::XMLTokens::NAME_STR, REXML::XMLTokens::NCNAME_STR, REXML::XMLTokens::NMTOKEN, REXML::XMLTokens::NMTOKENS, REXML::XMLTokens::REFERENCE

Instance Method Summary collapse

Constructor Details

#initialize ⇒ XPathParser

Returns a new instance of XPathParser.



49
50
51
52
53
 
# File 'lib/rexml/xpath_parser.rb', line 49

def initialize( )
  @parser = REXML::Parsers::XPathParser.new
  @namespaces = nil
  @variables = {}
end

Instance Method Details

#[]=(variable_name, value) ⇒ Object 



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

def []=( variable_name, value )
  @variables[ variable_name ] = value
end

#first(path_stack, node) ⇒ Object

Performs a depth-first (document order) XPath search, and returns the first match. This is the fastest, lightest way to return a single result.

FIXME: This method is incomplete!



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/rexml/xpath_parser.rb', line 95

def first( path_stack, node )
  #puts "#{depth}) Entering match( #{path.inspect}, #{tree.inspect} )"
  return nil if path.size == 0

  case path[0]
  when :document
    # do nothing
    return first( path[1..-1], node )
  when :child
    for c in node.children
      #puts "#{depth}) CHILD checking #{name(c)}"
      r = first( path[1..-1], c )
      #puts "#{depth}) RETURNING #{r.inspect}" if r
      return r if r
    end
  when :qname
    name = path[2]
    #puts "#{depth}) QNAME #{name(tree)} == #{name} (path => #{path.size})"
    if node.name == name
      #puts "#{depth}) RETURNING #{tree.inspect}" if path.size == 3
      return node if path.size == 3
      return first( path[3..-1], node )
    else
      return nil
    end
  when :descendant_or_self
    r = first( path[1..-1], node )
    return r if r
    for c in node.children
      r = first( path, c )
      return r if r
    end
  when :node
    return first( path[1..-1], node )
  when :any
    return first( path[1..-1], node )
  end
  return nil
end

#get_first(path, nodeset) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/rexml/xpath_parser.rb', line 73

def get_first path, nodeset
 #puts "#"*40
 path_stack = @parser.parse( path )
 #puts "PARSE: #{path} => #{path_stack.inspect}"
 #puts "PARSE: nodeset = #{nodeset.inspect}"
 first( path_stack, nodeset )
end

#match(path_stack, nodeset) ⇒ Object 



136
137
138
139
140
141
142
 
# File 'lib/rexml/xpath_parser.rb', line 136

def match( path_stack, nodeset )
  #puts "MATCH: path_stack = #{path_stack.inspect}"
  #puts "MATCH: nodeset = #{nodeset.inspect}"
  r = expr( path_stack, nodeset )
  #puts "MAIN EXPR => #{r.inspect}"
  r
end

#namespaces=(namespaces = {}) ⇒ Object 



55
56
57
58
 
# File 'lib/rexml/xpath_parser.rb', line 55

def namespaces=( namespaces={} )
  Functions::namespace_context = namespaces
  @namespaces = namespaces
end

#parse(path, nodeset) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/rexml/xpath_parser.rb', line 65

def parse path, nodeset
 #puts "#"*40
 path_stack = @parser.parse( path )
 #puts "PARSE: #{path} => #{path_stack.inspect}"
 #puts "PARSE: nodeset = #{nodeset.inspect}"
 match( path_stack, nodeset )
end

#predicate(path, nodeset) ⇒ Object 



81
82
83
84
 
# File 'lib/rexml/xpath_parser.rb', line 81

def predicate path, nodeset
  path_stack = @parser.parse( path )
  expr( path_stack, nodeset )
end

#variables=(vars = {}) ⇒ Object 



60
61
62
63
 
# File 'lib/rexml/xpath_parser.rb', line 60

def variables=( vars={} )
  Functions::variables = vars
  @variables = vars
end