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) { }
39 protected internal XmlDocument (XmlImplementation imp) : base (null)
41 throw new NotImplementedException ();
44 public XmlDocument (XmlNameTable nt) : base (null)
53 public event XmlNodeChangedEventHandler NodeChanged;
55 public event XmlNodeChangedEventHandler NodeChanging;
57 public event XmlNodeChangedEventHandler NodeInserted;
59 public event XmlNodeChangedEventHandler NodeInserting;
61 public event XmlNodeChangedEventHandler NodeRemoved;
63 public event XmlNodeChangedEventHandler NodeRemoving;
69 public override string BaseURI {
75 public XmlElement DocumentElement {
77 XmlNode node = FirstChild;
79 while (node != null) {
80 if (node is XmlElement)
82 node = node.NextSibling;
85 return node != null ? node as XmlElement : null;
90 public virtual XmlDocumentType DocumentType {
91 get { throw new NotImplementedException(); }
95 public XmlImplementation Implementation {
96 get { throw new NotImplementedException(); }
99 [MonoTODO ("Setter.")]
100 public override string InnerXml {
102 // Not sure why this is an override. Passing through for now.
103 return base.InnerXml;
105 set { throw new NotImplementedException(); }
108 public override bool IsReadOnly {
109 get { return false; }
112 internal override XmlLinkedNode LastLinkedChild {
114 return lastLinkedChild;
118 lastLinkedChild = value;
122 public override string LocalName {
123 get { return "#document"; }
126 public override string Name {
127 get { return "#document"; }
130 public XmlNameTable NameTable {
131 get { return nameTable; }
134 public override XmlNodeType NodeType {
135 get { return XmlNodeType.Document; }
138 public override XmlDocument OwnerDocument {
143 public bool PreserveWhitespace {
144 get { throw new NotImplementedException(); }
145 set { throw new NotImplementedException(); }
149 public virtual XmlResolver XmlResolver {
150 set { throw new NotImplementedException(); }
158 public override XmlNode CloneNode (bool deep)
160 throw new NotImplementedException ();
163 public XmlAttribute CreateAttribute (string name)
165 return CreateAttribute (name, String.Empty);
168 public XmlAttribute CreateAttribute (string qualifiedName, string namespaceURI)
173 ParseName (qualifiedName, out prefix, out localName);
175 return CreateAttribute (prefix, localName, namespaceURI);
178 public virtual XmlAttribute CreateAttribute (string prefix, string localName, string namespaceURI)
180 if ((localName == null) || (localName == String.Empty))
181 throw new ArgumentException ("The attribute local name cannot be empty.");
183 return new XmlAttribute (prefix, localName, namespaceURI, this);
186 public virtual XmlCDataSection CreateCDataSection (string data)
188 return new XmlCDataSection (data, this);
191 public virtual XmlComment CreateComment (string data)
193 return new XmlComment(data, this);
197 protected internal virtual XmlAttribute CreateDefaultAttribute (string prefix, string localName, string namespaceURI)
199 throw new NotImplementedException ();
203 public virtual XmlDocumentFragment CreateDocumentFragment ()
205 throw new NotImplementedException ();
208 public virtual XmlDocumentType CreateDocumentType (string name, string publicId,
209 string systemId, string internalSubset)
211 return new XmlDocumentType (name, publicId, systemId, internalSubset, this);
214 public XmlElement CreateElement (string name)
216 return CreateElement (name, String.Empty);
219 public XmlElement CreateElement (
220 string qualifiedName,
226 ParseName (qualifiedName, out prefix, out localName);
228 return CreateElement (prefix, localName, namespaceURI);
231 public virtual XmlElement CreateElement (
236 if ((localName == null) || (localName == String.Empty))
237 throw new ArgumentException ("The local name for elements or attributes cannot be null or an empty string.");
239 return new XmlElement (prefix != null ? prefix : String.Empty, localName, namespaceURI != null ? namespaceURI : String.Empty, this);
243 public virtual XmlEntityReference CreateEntityReference (string name)
245 throw new NotImplementedException ();
249 protected internal virtual XPathNavigator CreateNavigator (XmlNode node)
251 throw new NotImplementedException ();
254 public virtual XmlNode CreateNode (
255 string nodeTypeString,
259 return CreateNode (GetNodeTypeFromString (nodeTypeString), name, namespaceURI);
262 public virtual XmlNode CreateNode (
267 string prefix = null;
268 string localName = name;
270 if ((type == XmlNodeType.Attribute) || (type == XmlNodeType.Element) || (type == XmlNodeType.EntityReference))
271 ParseName (name, out prefix, out localName);
273 return CreateNode (type, prefix, localName, namespaceURI);
276 public virtual XmlNode CreateNode (
283 case XmlNodeType.Attribute: return CreateAttribute (prefix, name, namespaceURI);
284 case XmlNodeType.CDATA: return CreateCDataSection (null);
285 case XmlNodeType.Comment: return CreateComment (null);
286 case XmlNodeType.Document: return new XmlDocument (); // TODO - test to see which constructor to use, i.e. use existing NameTable or not.
287 case XmlNodeType.DocumentFragment: return CreateDocumentFragment ();
288 case XmlNodeType.DocumentType: return CreateDocumentType (null, null, null, null);
289 case XmlNodeType.Element: return CreateElement (prefix, name, namespaceURI);
290 case XmlNodeType.EntityReference: return CreateEntityReference (null);
291 case XmlNodeType.ProcessingInstruction: return CreateProcessingInstruction (null, null);
292 case XmlNodeType.SignificantWhitespace: return CreateSignificantWhitespace (String.Empty);
293 case XmlNodeType.Text: return CreateTextNode (null);
294 case XmlNodeType.Whitespace: return CreateWhitespace (String.Empty);
295 case XmlNodeType.XmlDeclaration: return CreateXmlDeclaration ("1.0", null, null);
296 default: throw new ArgumentOutOfRangeException(String.Format("{0}\nParameter name: {1}",
297 "Specified argument was out of the range of valid values", type.ToString ()));
301 public virtual XmlProcessingInstruction CreateProcessingInstruction (
305 return new XmlProcessingInstruction (target, data, this);
308 public virtual XmlSignificantWhitespace CreateSignificantWhitespace (string text)
310 foreach (char c in text)
311 if ((c != ' ') && (c != '\r') && (c != '\n') && (c != '\t'))
312 throw new ArgumentException ("Invalid whitespace characters.");
314 return new XmlSignificantWhitespace (text, this);
317 public virtual XmlText CreateTextNode (string text)
319 return new XmlText (text, this);
322 public virtual XmlWhitespace CreateWhitespace (string text)
324 foreach (char c in text)
325 if ((c != ' ') && (c != '\r') && (c != '\n') && (c != '\t'))
326 throw new ArgumentException ("Invalid whitespace characters.");
328 return new XmlWhitespace (text, this);
331 public virtual XmlDeclaration CreateXmlDeclaration (string version, string encoding,
334 if (version != "1.0")
335 throw new ArgumentException ("version string is not correct.");
337 if ((standalone != null) && !((standalone == "yes") || (standalone == "no")))
338 throw new ArgumentException ("standalone string is not correct.");
340 return new XmlDeclaration (version, encoding, standalone, this);
344 public virtual XmlElement GetElementById (string elementId)
346 throw new NotImplementedException ();
349 public virtual XmlNodeList GetElementsByTagName (string name)
351 ArrayList nodeArrayList = new ArrayList ();
352 this.searchNodesRecursively (this, name, String.Empty, nodeArrayList);
353 return new XmlNodeArrayList (nodeArrayList);
356 private void searchNodesRecursively (XmlNode argNode, string argName, string argNamespaceURI,
357 ArrayList argArrayList)
359 XmlNodeList xmlNodeList = argNode.ChildNodes;
360 foreach (XmlNode node in xmlNodeList){
361 if (node.LocalName.Equals (argName) && node.NamespaceURI.Equals (argNamespaceURI))
362 argArrayList.Add (node);
364 this.searchNodesRecursively (node, argName, argNamespaceURI, argArrayList);
368 public virtual XmlNodeList GetElementsByTagName (string localName, string namespaceURI)
370 ArrayList nodeArrayList = new ArrayList ();
371 this.searchNodesRecursively (this, localName, namespaceURI, nodeArrayList);
372 return new XmlNodeArrayList (nodeArrayList);
375 private XmlNodeType GetNodeTypeFromString (string nodeTypeString)
377 switch (nodeTypeString) {
378 case "attribute": return XmlNodeType.Attribute;
379 case "cdatasection": return XmlNodeType.CDATA;
380 case "comment": return XmlNodeType.Comment;
381 case "document": return XmlNodeType.Document;
382 case "documentfragment": return XmlNodeType.DocumentFragment;
383 case "documenttype": return XmlNodeType.DocumentType;
384 case "element": return XmlNodeType.Element;
385 case "entityreference": return XmlNodeType.EntityReference;
386 case "processinginstruction": return XmlNodeType.ProcessingInstruction;
387 case "significantwhitespace": return XmlNodeType.SignificantWhitespace;
388 case "text": return XmlNodeType.Text;
389 case "whitespace": return XmlNodeType.Whitespace;
391 throw new ArgumentException(String.Format("The string doesn't represent any node type : {0}.", nodeTypeString));
396 public virtual XmlNode ImportNode (XmlNode node, bool deep)
398 // How to resolve default attribute values?
399 switch(node.NodeType)
401 case XmlNodeType.Attribute:
403 XmlAttribute src_att = node as XmlAttribute;
404 XmlAttribute dst_att = this.CreateAttribute(src_att.Prefix, src_att.LocalName, src_att.NamespaceURI);
405 // TODO: resolve default attribute values
406 dst_att.Value = src_att.Value;
410 case XmlNodeType.CDATA:
411 return this.CreateCDataSection(node.Value);
413 case XmlNodeType.Comment:
414 return this.CreateComment(node.Value);
416 case XmlNodeType.Document:
417 throw new XmlException("Document cannot be imported.");
419 case XmlNodeType.DocumentFragment:
421 XmlDocumentFragment df = this.CreateDocumentFragment();
424 foreach(XmlNode n in node.ChildNodes)
426 df.AppendChild(this.ImportNode(n, deep));
432 case XmlNodeType.DocumentType:
433 throw new XmlException("DocumentType cannot be imported.");
435 case XmlNodeType.Element:
437 XmlElement src = (XmlElement)node;
438 XmlElement dst = this.CreateElement(src.Prefix, src.LocalName, src.NamespaceURI);
439 foreach(XmlAttribute attr in src.Attributes)
441 // TODO: create default attribute values
442 dst.SetAttributeNode((XmlAttribute)this.ImportNode(attr, deep));
446 foreach(XmlNode n in src.ChildNodes)
447 dst.AppendChild(this.ImportNode(n, deep));
452 case XmlNodeType.EndElement:
453 throw new XmlException ("Illegal ImportNode call for NodeType.EndElement");
454 case XmlNodeType.EndEntity:
455 throw new XmlException ("Illegal ImportNode call for NodeType.EndEntity");
456 case XmlNodeType.Entity:
457 throw new NotImplementedException ();
459 // [2002.10.14] CreateEntityReference not implemented.
460 case XmlNodeType.EntityReference:
461 throw new NotImplementedException("ImportNode of EntityReference not implemented mainly because CreateEntityReference was implemented in the meantime.");
462 // return this.CreateEntityReference(node.Name);
464 case XmlNodeType.None:
465 throw new XmlException ("Illegal ImportNode call for NodeType.None");
466 case XmlNodeType.Notation:
467 throw new NotImplementedException ();
469 case XmlNodeType.ProcessingInstruction:
470 XmlProcessingInstruction pi = node as XmlProcessingInstruction;
471 return this.CreateProcessingInstruction(pi.Target, pi.Data);
473 case XmlNodeType.SignificantWhitespace:
474 return this.CreateSignificantWhitespace(node.Value);
476 case XmlNodeType.Text:
477 return this.CreateTextNode(node.Value);
479 case XmlNodeType.Whitespace:
480 return this.CreateWhitespace(node.Value);
482 // I don't know how to test it...
483 case XmlNodeType.XmlDeclaration:
484 // return this.CreateNode(XmlNodeType.XmlDeclaration, String.Empty, node.Value);
485 throw new NotImplementedException ();
488 throw new NotImplementedException ();
492 public virtual void Load (Stream inStream)
494 XmlReader xmlReader = new XmlTextReader (inStream);
498 public virtual void Load (string filename)
501 XmlReader xmlReader = new XmlTextReader (new StreamReader (filename));
505 public virtual void Load (TextReader txtReader)
507 Load (new XmlTextReader (txtReader));
510 public virtual void Load (XmlReader xmlReader)
512 // Reset our document
513 // For now this just means removing all our children but later this
514 // may turn out o need to call a private method that resets other things
515 // like properties we have, etc.
518 XmlNode currentNode = this;
521 while (xmlReader.Read ())
523 switch (xmlReader.NodeType) {
525 case XmlNodeType.CDATA:
526 newNode = CreateCDataSection(xmlReader.Value);
527 currentNode.AppendChild (newNode);
530 case XmlNodeType.Comment:
531 newNode = CreateComment (xmlReader.Value);
532 currentNode.AppendChild (newNode);
535 case XmlNodeType.Element:
536 XmlElement element = CreateElement (xmlReader.Prefix, xmlReader.LocalName, xmlReader.NamespaceURI);
537 currentNode.AppendChild (element);
539 // set the element's attributes.
540 while (xmlReader.MoveToNextAttribute ()) {
541 XmlAttribute attribute = CreateAttribute (xmlReader.Prefix, xmlReader.LocalName, xmlReader.NamespaceURI);
542 attribute.Value = xmlReader.Value;
543 element.SetAttributeNode (attribute);
546 xmlReader.MoveToElement ();
548 // if this element isn't empty, push it onto our "stack".
549 if (!xmlReader.IsEmptyElement)
550 currentNode = element;
554 case XmlNodeType.EndElement:
555 currentNode = currentNode.ParentNode;
558 case XmlNodeType.ProcessingInstruction:
559 newNode = CreateProcessingInstruction (xmlReader.Name, xmlReader.Value);
560 currentNode.AppendChild (newNode);
563 case XmlNodeType.Text:
564 newNode = CreateTextNode (xmlReader.Value);
565 currentNode.AppendChild (newNode);
571 public virtual void LoadXml (string xml)
573 XmlReader xmlReader = new XmlTextReader (new StringReader (xml));
577 internal void onNodeChanged (XmlNode node, XmlNode Parent)
579 if (NodeChanged != null)
580 NodeChanged (node, new XmlNodeChangedEventArgs
581 (XmlNodeChangedAction.Change,
582 node, Parent, Parent));
585 internal void onNodeChanging(XmlNode node, XmlNode Parent)
587 if (NodeChanging != null)
588 NodeChanging (node, new XmlNodeChangedEventArgs
589 (XmlNodeChangedAction.Change,
590 node, Parent, Parent));
593 internal void onNodeInserted (XmlNode node, XmlNode newParent)
595 if (NodeInserted != null)
596 NodeInserted (node, new XmlNodeChangedEventArgs
597 (XmlNodeChangedAction.Insert,
598 node, null, newParent));
601 internal void onNodeInserting (XmlNode node, XmlNode newParent)
603 if (NodeInserting != null)
604 NodeInserting (node, new XmlNodeChangedEventArgs
605 (XmlNodeChangedAction.Insert,
606 node, null, newParent));
609 internal void onNodeRemoved (XmlNode node, XmlNode oldParent)
611 if (NodeRemoved != null)
612 NodeRemoved (node, new XmlNodeChangedEventArgs
613 (XmlNodeChangedAction.Remove,
614 node, oldParent, null));
617 internal void onNodeRemoving (XmlNode node, XmlNode oldParent)
619 if (NodeRemoving != null)
620 NodeRemoving (node, new XmlNodeChangedEventArgs
621 (XmlNodeChangedAction.Remove,
622 node, oldParent, null));
625 private void ParseName (string name, out string prefix, out string localName)
627 int indexOfColon = name.IndexOf (':');
629 if (indexOfColon != -1) {
630 prefix = name.Substring (0, indexOfColon);
631 localName = name.Substring (indexOfColon + 1);
639 public virtual XmlNode ReadNode(XmlReader reader)
641 throw new NotImplementedException ();
644 [MonoTODO ("Verify what encoding is used by default; Should use PreserveWhiteSpace")]
645 public virtual void Save(Stream outStream)
647 XmlTextWriter xmlWriter = new XmlTextWriter (outStream, Encoding.UTF8);
648 WriteContentTo (xmlWriter);
652 [MonoTODO ("Verify what encoding is used by default; Should use PreseveWhiteSpace")]
653 public virtual void Save (string filename)
655 XmlTextWriter xmlWriter = new XmlTextWriter (filename, Encoding.UTF8);
656 WriteContentTo (xmlWriter);
661 public virtual void Save (TextWriter writer)
663 XmlTextWriter xmlWriter = new XmlTextWriter (writer);
664 WriteContentTo (xmlWriter);
668 [MonoTODO ("Should preserve white space if PreserveWhisspace is set")]
669 public virtual void Save (XmlWriter xmlWriter)
672 // This should preserve white space if PreserveWhiteSpace is true
674 WriteContentTo (xmlWriter);
678 public override void WriteContentTo (XmlWriter w)
680 foreach(XmlNode childNode in ChildNodes)
681 childNode.WriteTo(w);
684 public override void WriteTo (XmlWriter w)