Merged in development from the main REXML repository.

* Fixed bug #34, typo in xpath_parser.
* Previous fix, (include? -> includes?) was incorrect.
* Added another test for encoding
* Started AnyName support in RelaxNG
* Added Element#Attributes#to_a, so that it does something intelligent.
  This was needed by XPath, for '@*'
* Fixed XPath so that @* works.
* Added xmlgrep to the bin/ directory.  A little tool allowing you to grep
  for XPaths in an XML document.
* Fixed a CDATA pretty-printing bug. (#39)
* Fixed a buffering bug in Source.rb that affected the SAX parser
  This bug was related to how REXML determines the encoding of a file, and
  evinced itself by hanging on input when using the SAX parser.
* The unit test for the previous patch.  Forgot to commit it.
* Minor pretty printing fix.
* Applied Curt Sampson's optimization improvements
* Issue #9; 3.1.3: The SAX parser was not denormalizing entity references
  in incoming text.  All declared internal entities, as well as numeric
  entities, should now be denormalized.  There was a related bug in that the
  SAX parser was actually double-encoding entities; this is also fixed.
* bin/* programs should now be executable.  Setting bin apps to executable
* Issue 14; 3.1.3: DTD events are now all being passed by StreamParser
  Some of the DTD events were not being passed through by the stream parser.
* #26: Element#add_element(nil) now raises an error Changed XPath searches so
  that if a non-Hash is passed, an error is raised Fixed a spurrious undefined
  method error in encoding.  #29: XPath ordering bug fixed by Mark Williams.
  Incidentally, Mark supplied a superlative bug report, including a full unit
  test.  Then he went ahead and fixed the bug.  It doesn't get any better than
  this, folks.
* Fixed a broken link.  Thanks to Dick Davies for pointing it out.  Added
  functions courtesy of Michael Neumann <mneumann@xxxx.de>.
  Example code to follow.
* Added Michael's sample code.  Merged the changes in from branches/xpath_V
* Fixed preceding:: and following:: axis Fixed the ordering bug that Martin
  Fowler reported.
* Uncommented some code commented for testing Applied Nobu's changes to the
  Encoding infrastructure, which should fix potential threading issues.
* Added more tests, and the missing syncenumerator class.  Fixed the
  inheritance bug in the pull parser that James Britt found.  Indentation
  changes, and changed some exceptions to runtime
  exceptions.
* Changes by Matz, mostly of indent -> indent_level, to avoid
  function/variable naming conflicts
* Tabs -> spaces (whitespace)

Note the addition of syncenumerator.rb.  This is a stopgap, until I can work on
the class enough to get it accepted as a replacement for the SyncEnumerator
that comes with the Generator class.  My version is orders of magnitude faster
than the Generator SyncEnumerator, but is currently missing a couple of
features of the original.  Eventually, I expect this class to migrate to
another part of the source tree.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@8483 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 32 insertions, 7 deletions

diff --git a/lib/rexml/element.rb b/lib/rexml/element.rb
index e18f0b28c7..7f578ecb3d 100644
--- a/lib/rexml/element.rb
+++ b/lib/rexml/element.rb
@@ -6,6 +6,14 @@ require "rexml/xpath"
 require "rexml/parseexception"
 
 module REXML
+  # An implementation note about namespaces:
+  # As we parse, when we find namespaces we put them in a hash and assign
+  # them a unique ID.  We then convert the namespace prefix for the node
+  # to the unique ID.  This makes namespace lookup much faster for the
+  # cost of extra memory use.  We save the namespace prefix for the
+  # context node and convert it back when we write it.
+  @@namespaces = {}
+
 	# Represents a tagged XML element.  Elements are characterized by
 	# having children, attributes, and names, and can themselves be
 	# children.
@@ -91,19 +99,35 @@ module REXML
 			Element.new self
 		end
 
-		# Evaluates to the root element of the document that this element 
+		# Evaluates to the root node of the document that this element 
 		# belongs to. If this element doesn't belong to a document, but does
 		# belong to another Element, the parent's root will be returned, until the
 		# earliest ancestor is found.
+    #
+    # Note that this is not the same as the document element.
+    # In the following example, <a> is the document element, and the root
+    # node is the parent node of the document element.  You may ask yourself
+    # why the root node is useful: consider the doctype and XML declaration,
+    # and any processing instructions before the document element... they
+    # are children of the root node, or siblings of the document element.
+    # The only time this isn't true is when an Element is created that is
+    # not part of any Document.  In this case, the ancestor that has no
+    # parent acts as the root node.
 		#  d = Document.new '<a><b><c/></b></a>'
 		#  a = d[1] ; c = a[1][1]
-		#  d.root        # These all evaluate to the same Element,
-		#  a.root        # namely, <a>
-		#  c.root        #
-		def root
-			parent.nil? ? self : parent.root
+		#  d.root_node == d   # TRUE
+		#  a.root_node        # namely, d
+		#  c.root_node        # again, d
+		def root_node
+			parent.nil? ? self : parent.root_node
 		end
 
+    def root
+      return elements[1] if self.kind_of? Document
+      return self if parent.kind_of? Document or parent.nil?
+      return parent.root
+    end
+
 		# Evaluates to the document to which this element belongs, or nil if this
 		# element doesn't belong to a document.
 		def document
@@ -270,7 +294,8 @@ module REXML
 		#  el = doc.add_element 'my-tag', {'attr1'=>'val1', 'attr2'=>'val2'}
 		#  el = Element.new 'my-tag'
 		#  doc.add_element el
-		def add_element element=nil, attrs=nil
+		def add_element element, attrs=nil
+      raise "First argument must be either an element name, or an Element object" if element.nil?
 			el = @elements.add(element)
 			if attrs.kind_of? Hash
 				attrs.each do |key, value|