2 // System.Xml.XmlDocument
5 // Daniel Weber (daniel-weber@austin.rr.com)
6 // Kral Ferch <kral_ferch@hotmail.com>
7 // Jason Diamond <jason@injektilo.org>
8 // Miguel de Icaza (miguel@ximian.com)
9 // Duncan Mak (duncan@ximian.com)
11 // (C) 2001 Daniel Weber
12 // (C) 2002 Kral Ferch, Jason Diamond, Miguel de Icaza, Duncan Mak
18 using System.Xml.XPath;
19 using System.Diagnostics;
20 using System.Collections;
24 public class XmlDocument : XmlNode
28 XmlLinkedNode lastLinkedChild;
29 XmlNameTable nameTable;
30 string baseURI = String.Empty;
36 public XmlDocument () : base (null)
38 System.Xml.NameTable nt = new NameTable();
39 // keys below are default of MS .NET Framework
44 nt.Add("#document-fragment");
48 nt.Add("#whitespace");
49 nt.Add("http://www.w3.org/2000/xmlns/");
50 nt.Add("#cdata-section");
57 protected internal XmlDocument (XmlImplementation imp) : base (null)
59 throw new NotImplementedException ();
62 public XmlDocument (XmlNameTable nt) : base (null)
71 public event XmlNodeChangedEventHandler NodeChanged;
73 public event XmlNodeChangedEventHandler NodeChanging;
75 public event XmlNodeChangedEventHandler NodeInserted;
77 public event XmlNodeChangedEventHandler NodeInserting;
79 public event XmlNodeChangedEventHandler NodeRemoved;
81 public event XmlNodeChangedEventHandler NodeRemoving;
87 public override string BaseURI {
93 public XmlElement DocumentElement {
95 XmlNode node = FirstChild;
97 while (node != null) {
98 if (node is XmlElement)
100 node = node.NextSibling;
103 return node != null ? node as XmlElement : null;
108 public virtual XmlDocumentType DocumentType {
109 get { throw new NotImplementedException(); }
113 public XmlImplementation Implementation {
114 get { throw new NotImplementedException(); }
117 [MonoTODO ("Setter.")]
118 public override string InnerXml {
120 // Not sure why this is an override. Passing through for now.
121 return base.InnerXml;
123 set { throw new NotImplementedException(); }
126 public override bool IsReadOnly {
127 get { return false; }
130 internal override XmlLinkedNode LastLinkedChild {
132 return lastLinkedChild;
136 lastLinkedChild = value;
140 public override string LocalName {
141 get { return "#document"; }
144 public override string Name {
145 get { return "#document"; }
148 public XmlNameTable NameTable {
149 get { return nameTable; }
152 public override XmlNodeType NodeType {
153 get { return XmlNodeType.Document; }
156 public override XmlDocument OwnerDocument {
161 public bool PreserveWhitespace {
162 get { throw new NotImplementedException(); }
163 set { throw new NotImplementedException(); }
167 public virtual XmlResolver XmlResolver {
168 set { throw new NotImplementedException(); }
176 public override XmlNode CloneNode (bool deep)
178 throw new NotImplementedException ();
181 public XmlAttribute CreateAttribute (string name)
183 return CreateAttribute (name, String.Empty);
186 public XmlAttribute CreateAttribute (string qualifiedName, string namespaceURI)
191 ParseName (qualifiedName, out prefix, out localName);
193 return CreateAttribute (prefix, localName, namespaceURI);
196 public virtual XmlAttribute CreateAttribute (string prefix, string localName, string namespaceURI)
198 if ((localName == null) || (localName == String.Empty))
199 throw new ArgumentException ("The attribute local name cannot be empty.");
201 return new XmlAttribute (prefix, localName, namespaceURI, this);
204 public virtual XmlCDataSection CreateCDataSection (string data)
206 return new XmlCDataSection (data, this);
209 public virtual XmlComment CreateComment (string data)
211 return new XmlComment(data, this);
215 protected internal virtual XmlAttribute CreateDefaultAttribute (string prefix, string localName, string namespaceURI)
217 throw new NotImplementedException ();
221 public virtual XmlDocumentFragment CreateDocumentFragment ()
223 throw new NotImplementedException ();
226 public virtual XmlDocumentType CreateDocumentType (string name, string publicId,
227 string systemId, string internalSubset)
229 return new XmlDocumentType (name, publicId, systemId, internalSubset, this);
232 public XmlElement CreateElement (string name)
234 return CreateElement (name, String.Empty);
237 public XmlElement CreateElement (
238 string qualifiedName,
244 ParseName (qualifiedName, out prefix, out localName);
246 return CreateElement (prefix, localName, namespaceURI);
249 public virtual XmlElement CreateElement (
254 if ((localName == null) || (localName == String.Empty))
255 throw new ArgumentException ("The local name for elements or attributes cannot be null or an empty string.");
257 return new XmlElement (prefix != null ? prefix : String.Empty, localName, namespaceURI != null ? namespaceURI : String.Empty, this);
261 public virtual XmlEntityReference CreateEntityReference (string name)
263 throw new NotImplementedException ();
267 protected internal virtual XPathNavigator CreateNavigator (XmlNode node)
269 throw new NotImplementedException ();
272 public virtual XmlNode CreateNode (
273 string nodeTypeString,
277 return CreateNode (GetNodeTypeFromString (nodeTypeString), name, namespaceURI);
280 public virtual XmlNode CreateNode (
285 string prefix = null;
286 string localName = name;
288 if ((type == XmlNodeType.Attribute) || (type == XmlNodeType.Element) || (type == XmlNodeType.EntityReference))
289 ParseName (name, out prefix, out localName);
291 return CreateNode (type, prefix, localName, namespaceURI);
294 public virtual XmlNode CreateNode (
301 case XmlNodeType.Attribute: return CreateAttribute (prefix, name, namespaceURI);
302 case XmlNodeType.CDATA: return CreateCDataSection (null);
303 case XmlNodeType.Comment: return CreateComment (null);
304 case XmlNodeType.Document: return new XmlDocument (); // TODO - test to see which constructor to use, i.e. use existing NameTable or not.
305 case XmlNodeType.DocumentFragment: return CreateDocumentFragment ();
306 case XmlNodeType.DocumentType: return CreateDocumentType (null, null, null, null);
307 case XmlNodeType.Element: return CreateElement (prefix, name, namespaceURI);
308 case XmlNodeType.EntityReference: return CreateEntityReference (null);
309 case XmlNodeType.ProcessingInstruction: return CreateProcessingInstruction (null, null);
310 case XmlNodeType.SignificantWhitespace: return CreateSignificantWhitespace (String.Empty);
311 case XmlNodeType.Text: return CreateTextNode (null);
312 case XmlNodeType.Whitespace: return CreateWhitespace (String.Empty);
313 case XmlNodeType.XmlDeclaration: return CreateXmlDeclaration ("1.0", null, null);
314 default: throw new ArgumentOutOfRangeException(String.Format("{0}\nParameter name: {1}",
315 "Specified argument was out of the range of valid values", type.ToString ()));
319 public virtual XmlProcessingInstruction CreateProcessingInstruction (
323 return new XmlProcessingInstruction (target, data, this);
326 public virtual XmlSignificantWhitespace CreateSignificantWhitespace (string text)
328 foreach (char c in text)
329 if ((c != ' ') && (c != '\r') && (c != '\n') && (c != '\t'))
330 throw new ArgumentException ("Invalid whitespace characters.");
332 return new XmlSignificantWhitespace (text, this);
335 public virtual XmlText CreateTextNode (string text)
337 return new XmlText (text, this);
340 public virtual XmlWhitespace CreateWhitespace (string text)
342 foreach (char c in text)
343 if ((c != ' ') && (c != '\r') && (c != '\n') && (c != '\t'))
344 throw new ArgumentException ("Invalid whitespace characters.");
346 return new XmlWhitespace (text, this);
349 public virtual XmlDeclaration CreateXmlDeclaration (string version, string encoding,
352 if (version != "1.0")
353 throw new ArgumentException ("version string is not correct.");
355 if ((standalone != null) && !((standalone == "yes") || (standalone == "no")))
356 throw new ArgumentException ("standalone string is not correct.");
358 return new XmlDeclaration (version, encoding, standalone, this);
362 public virtual XmlElement GetElementById (string elementId)
364 throw new NotImplementedException ();
367 public virtual XmlNodeList GetElementsByTagName (string name)
369 ArrayList nodeArrayList = new ArrayList ();
370 this.searchNodesRecursively (this, name, nodeArrayList);
371 return new XmlNodeArrayList (nodeArrayList);
374 private void searchNodesRecursively (XmlNode argNode, string argName,
375 ArrayList argArrayList)
377 XmlNodeList xmlNodeList = argNode.ChildNodes;
378 foreach (XmlNode node in xmlNodeList){
379 if (node.Name.Equals (argName))
380 argArrayList.Add (node);
382 this.searchNodesRecursively (node, argName, argArrayList);
386 private void searchNodesRecursively (XmlNode argNode, string argName, string argNamespaceURI,
387 ArrayList argArrayList)
389 XmlNodeList xmlNodeList = argNode.ChildNodes;
390 foreach (XmlNode node in xmlNodeList){
391 if (node.LocalName.Equals (argName) && node.NamespaceURI.Equals (argNamespaceURI))
392 argArrayList.Add (node);
394 this.searchNodesRecursively (node, argName, argNamespaceURI, argArrayList);
398 public virtual XmlNodeList GetElementsByTagName (string localName, string namespaceURI)
400 ArrayList nodeArrayList = new ArrayList ();
401 this.searchNodesRecursively (this, localName, namespaceURI, nodeArrayList);
402 return new XmlNodeArrayList (nodeArrayList);
405 private XmlNodeType GetNodeTypeFromString (string nodeTypeString)
407 switch (nodeTypeString) {
408 case "attribute": return XmlNodeType.Attribute;
409 case "cdatasection": return XmlNodeType.CDATA;
410 case "comment": return XmlNodeType.Comment;
411 case "document": return XmlNodeType.Document;
412 case "documentfragment": return XmlNodeType.DocumentFragment;
413 case "documenttype": return XmlNodeType.DocumentType;
414 case "element": return XmlNodeType.Element;
415 case "entityreference": return XmlNodeType.EntityReference;
416 case "processinginstruction": return XmlNodeType.ProcessingInstruction;
417 case "significantwhitespace": return XmlNodeType.SignificantWhitespace;
418 case "text": return XmlNodeType.Text;
419 case "whitespace": return XmlNodeType.Whitespace;
421 throw new ArgumentException(String.Format("The string doesn't represent any node type : {0}.", nodeTypeString));
426 public virtual XmlNode ImportNode (XmlNode node, bool deep)
428 // How to resolve default attribute values?
429 switch(node.NodeType)
431 case XmlNodeType.Attribute:
433 XmlAttribute src_att = node as XmlAttribute;
434 XmlAttribute dst_att = this.CreateAttribute(src_att.Prefix, src_att.LocalName, src_att.NamespaceURI);
435 // TODO: resolve default attribute values
436 dst_att.Value = src_att.Value;
440 case XmlNodeType.CDATA:
441 return this.CreateCDataSection(node.Value);
443 case XmlNodeType.Comment:
444 return this.CreateComment(node.Value);
446 case XmlNodeType.Document:
447 throw new XmlException("Document cannot be imported.");
449 case XmlNodeType.DocumentFragment:
451 XmlDocumentFragment df = this.CreateDocumentFragment();
454 foreach(XmlNode n in node.ChildNodes)
456 df.AppendChild(this.ImportNode(n, deep));
462 case XmlNodeType.DocumentType:
463 throw new XmlException("DocumentType cannot be imported.");
465 case XmlNodeType.Element:
467 XmlElement src = (XmlElement)node;
468 XmlElement dst = this.CreateElement(src.Prefix, src.LocalName, src.NamespaceURI);
469 foreach(XmlAttribute attr in src.Attributes)
471 // TODO: create default attribute values
472 dst.SetAttributeNode((XmlAttribute)this.ImportNode(attr, deep));
476 foreach(XmlNode n in src.ChildNodes)
477 dst.AppendChild(this.ImportNode(n, deep));
482 case XmlNodeType.EndElement:
483 throw new XmlException ("Illegal ImportNode call for NodeType.EndElement");
484 case XmlNodeType.EndEntity:
485 throw new XmlException ("Illegal ImportNode call for NodeType.EndEntity");
486 case XmlNodeType.Entity:
487 throw new NotImplementedException ();
489 // [2002.10.14] CreateEntityReference not implemented.
490 case XmlNodeType.EntityReference:
491 throw new NotImplementedException("ImportNode of EntityReference not implemented mainly because CreateEntityReference was implemented in the meantime.");
492 // return this.CreateEntityReference(node.Name);
494 case XmlNodeType.None:
495 throw new XmlException ("Illegal ImportNode call for NodeType.None");
496 case XmlNodeType.Notation:
497 throw new NotImplementedException ();
499 case XmlNodeType.ProcessingInstruction:
500 XmlProcessingInstruction pi = node as XmlProcessingInstruction;
501 return this.CreateProcessingInstruction(pi.Target, pi.Data);
503 case XmlNodeType.SignificantWhitespace:
504 return this.CreateSignificantWhitespace(node.Value);
506 case XmlNodeType.Text:
507 return this.CreateTextNode(node.Value);
509 case XmlNodeType.Whitespace:
510 return this.CreateWhitespace(node.Value);
512 // I don't know how to test it...
513 case XmlNodeType.XmlDeclaration:
514 // return this.CreateNode(XmlNodeType.XmlDeclaration, String.Empty, node.Value);
515 throw new NotImplementedException ();
518 throw new NotImplementedException ();
522 public virtual void Load (Stream inStream)
524 XmlReader xmlReader = new XmlTextReader (inStream);
528 public virtual void Load (string filename)
531 XmlReader xmlReader = new XmlTextReader (new StreamReader (filename));
535 public virtual void Load (TextReader txtReader)
537 Load (new XmlTextReader (txtReader));
540 public virtual void Load (XmlReader xmlReader)
542 // Reset our document
543 // For now this just means removing all our children but later this
544 // may turn out o need to call a private method that resets other things
545 // like properties we have, etc.
548 XmlNode currentNode = this;
552 this.ConstructDOM(xmlReader, currentNode);
554 // Below are copied to XmlNode.Construct(currentNode, xmlReader)
555 while (xmlReader.Read ())
557 switch (xmlReader.NodeType) {
559 case XmlNodeType.CDATA:
560 newNode = CreateCDataSection(xmlReader.Value);
561 currentNode.AppendChild (newNode);
564 case XmlNodeType.Comment:
565 newNode = CreateComment (xmlReader.Value);
566 currentNode.AppendChild (newNode);
569 case XmlNodeType.Element:
570 XmlElement element = CreateElement (xmlReader.Prefix, xmlReader.LocalName, xmlReader.NamespaceURI);
571 currentNode.AppendChild (element);
573 // set the element's attributes.
574 while (xmlReader.MoveToNextAttribute ()) {
575 XmlAttribute attribute = CreateAttribute (xmlReader.Prefix, xmlReader.LocalName, xmlReader.NamespaceURI);
576 attribute.Value = xmlReader.Value;
577 element.SetAttributeNode (attribute);
580 xmlReader.MoveToElement ();
582 // if this element isn't empty, push it onto our "stack".
583 if (!xmlReader.IsEmptyElement)
584 currentNode = element;
588 case XmlNodeType.EndElement:
589 currentNode = currentNode.ParentNode;
592 case XmlNodeType.ProcessingInstruction:
593 newNode = CreateProcessingInstruction (xmlReader.Name, xmlReader.Value);
594 currentNode.AppendChild (newNode);
597 case XmlNodeType.Text:
598 newNode = CreateTextNode (xmlReader.Value);
599 currentNode.AppendChild (newNode);
606 public virtual void LoadXml (string xml)
608 XmlReader xmlReader = new XmlTextReader (new StringReader (xml));
612 internal void onNodeChanged (XmlNode node, XmlNode Parent)
614 if (NodeChanged != null)
615 NodeChanged (node, new XmlNodeChangedEventArgs
616 (XmlNodeChangedAction.Change,
617 node, Parent, Parent));
620 internal void onNodeChanging(XmlNode node, XmlNode Parent)
622 if (NodeChanging != null)
623 NodeChanging (node, new XmlNodeChangedEventArgs
624 (XmlNodeChangedAction.Change,
625 node, Parent, Parent));
628 internal void onNodeInserted (XmlNode node, XmlNode newParent)
630 if (NodeInserted != null)
631 NodeInserted (node, new XmlNodeChangedEventArgs
632 (XmlNodeChangedAction.Insert,
633 node, null, newParent));
636 internal void onNodeInserting (XmlNode node, XmlNode newParent)
638 if (NodeInserting != null)
639 NodeInserting (node, new XmlNodeChangedEventArgs
640 (XmlNodeChangedAction.Insert,
641 node, null, newParent));
644 internal void onNodeRemoved (XmlNode node, XmlNode oldParent)
646 if (NodeRemoved != null)
647 NodeRemoved (node, new XmlNodeChangedEventArgs
648 (XmlNodeChangedAction.Remove,
649 node, oldParent, null));
652 internal void onNodeRemoving (XmlNode node, XmlNode oldParent)
654 if (NodeRemoving != null)
655 NodeRemoving (node, new XmlNodeChangedEventArgs
656 (XmlNodeChangedAction.Remove,
657 node, oldParent, null));
660 private void ParseName (string name, out string prefix, out string localName)
662 int indexOfColon = name.IndexOf (':');
664 if (indexOfColon != -1) {
665 prefix = name.Substring (0, indexOfColon);
666 localName = name.Substring (indexOfColon + 1);
674 public virtual XmlNode ReadNode(XmlReader reader)
676 throw new NotImplementedException ();
679 [MonoTODO ("Verify what encoding is used by default; Should use PreserveWhiteSpace")]
680 public virtual void Save(Stream outStream)
682 XmlTextWriter xmlWriter = new XmlTextWriter (outStream, Encoding.UTF8);
683 WriteContentTo (xmlWriter);
687 [MonoTODO ("Verify what encoding is used by default; Should use PreseveWhiteSpace")]
688 public virtual void Save (string filename)
690 XmlTextWriter xmlWriter = new XmlTextWriter (filename, Encoding.UTF8);
691 WriteContentTo (xmlWriter);
696 public virtual void Save (TextWriter writer)
698 XmlTextWriter xmlWriter = new XmlTextWriter (writer);
699 WriteContentTo (xmlWriter);
703 [MonoTODO ("Should preserve white space if PreserveWhisspace is set")]
704 public virtual void Save (XmlWriter xmlWriter)
707 // This should preserve white space if PreserveWhiteSpace is true
709 WriteContentTo (xmlWriter);
713 public override void WriteContentTo (XmlWriter w)
715 foreach(XmlNode childNode in ChildNodes)
716 childNode.WriteTo(w);
719 public override void WriteTo (XmlWriter w)