2 // System.Xml.XmlWriter
5 // Kral Ferch <kral_ferch@hotmail.com>
6 // Atsushi Enomoto <ginga@kit.hi-ho.ne.jp>
9 // (C) 2002-2003 Atsushi Enomoto
10 // (C) 2004-2007 Novell, Inc.
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 using System.Collections;
39 using System.Xml.XPath;
44 public abstract class XmlWriter : IDisposable
47 XmlWriterSettings settings;
52 protected XmlWriter () { }
59 public virtual XmlWriterSettings Settings {
60 get { return settings; }
64 public abstract WriteState WriteState { get; }
68 public virtual string XmlLang {
72 public virtual XmlSpace XmlSpace {
73 get { return XmlSpace.None; }
76 public abstract string XmlLang { get; }
78 public abstract XmlSpace XmlSpace { get; }
85 public abstract void Close ();
88 public static XmlWriter Create (Stream stream)
90 return Create (stream, null);
93 public static XmlWriter Create (string file)
95 return Create (file, null);
98 public static XmlWriter Create (TextWriter writer)
100 return Create (writer, null);
103 public static XmlWriter Create (XmlWriter writer)
105 return Create (writer, null);
108 public static XmlWriter Create (StringBuilder builder)
110 return Create (builder, null);
113 public static XmlWriter Create (Stream stream, XmlWriterSettings settings)
115 Encoding enc = settings != null ? settings.Encoding : Encoding.UTF8;
116 return Create (new StreamWriter (stream, enc), settings);
119 public static XmlWriter Create (string file, XmlWriterSettings settings)
121 Encoding enc = settings != null ? settings.Encoding : Encoding.UTF8;
122 return CreateTextWriter (new StreamWriter (file, false, enc), settings, true);
125 public static XmlWriter Create (StringBuilder builder, XmlWriterSettings settings)
127 return Create (new StringWriter (builder), settings);
130 public static XmlWriter Create (TextWriter writer, XmlWriterSettings settings)
132 if (settings == null)
133 settings = new XmlWriterSettings ();
134 return CreateTextWriter (writer, settings, settings.CloseOutput);
137 public static XmlWriter Create (XmlWriter writer, XmlWriterSettings settings)
139 if (settings == null)
140 settings = new XmlWriterSettings ();
142 settings = settings.Clone ();
144 var src = writer.Settings;
146 settings.ConformanceLevel = ConformanceLevel.Document; // Huh? Why??
147 writer = new DefaultXmlWriter (writer);
148 writer.settings = settings;
150 ConformanceLevel dst = src.ConformanceLevel;
151 switch (src.ConformanceLevel) {
152 case ConformanceLevel.Auto:
153 dst = settings.ConformanceLevel;
155 case ConformanceLevel.Document:
156 case ConformanceLevel.Fragment:
157 if (settings.ConformanceLevel != ConformanceLevel.Auto)
158 dst = settings.ConformanceLevel;
162 settings.MergeFrom (src);
164 // It returns a new XmlWriter instance if 1) Settings is null, or 2) Settings ConformanceLevel (or might be other members as well) give significant difference.
165 if (src.ConformanceLevel != dst) {
166 writer = new DefaultXmlWriter (writer, false);
167 writer.settings = settings;
174 private static XmlWriter CreateTextWriter (TextWriter writer, XmlWriterSettings settings, bool closeOutput)
176 if (settings == null)
177 settings = new XmlWriterSettings ();
178 XmlTextWriter xtw = new XmlTextWriter (writer, settings, closeOutput);
179 return Create (xtw, settings);
182 protected virtual void Dispose (bool disposing)
187 void IDisposable.Dispose ()
193 public abstract void Flush ();
195 public abstract string LookupPrefix (string ns);
197 private void WriteAttribute (XmlReader reader, bool defattr)
199 if (!defattr && reader.IsDefault)
202 WriteStartAttribute (reader.Prefix, reader.LocalName, reader.NamespaceURI);
204 // no ReadAttributeValue() in 2.1 profile.
205 WriteString (reader.Value);
207 while (reader.ReadAttributeValue ()) {
208 switch (reader.NodeType) {
209 case XmlNodeType.Text:
210 WriteString (reader.Value);
212 case XmlNodeType.EntityReference:
213 WriteEntityRef (reader.Name);
218 WriteEndAttribute ();
221 public virtual void WriteAttributes (XmlReader reader, bool defattr)
224 throw new ArgumentException("null XmlReader specified.", "reader");
226 switch (reader.NodeType) {
227 case XmlNodeType.XmlDeclaration:
228 WriteAttributeString ("version", reader ["version"]);
229 if (reader ["encoding"] != null)
230 WriteAttributeString ("encoding", reader ["encoding"]);
231 if (reader ["standalone"] != null)
232 WriteAttributeString ("standalone", reader ["standalone"]);
234 case XmlNodeType.Element:
235 if (reader.MoveToFirstAttribute ())
236 goto case XmlNodeType.Attribute;
238 case XmlNodeType.Attribute:
240 WriteAttribute (reader, defattr);
241 } while (reader.MoveToNextAttribute ());
242 reader.MoveToElement ();
245 throw new XmlException("NodeType is not one of Element, Attribute, nor XmlDeclaration.");
249 public void WriteAttributeString (string localName, string value)
251 WriteAttributeString ("", localName, null, value);
254 public void WriteAttributeString (string localName, string ns, string value)
256 WriteAttributeString ("", localName, ns, value);
259 public void WriteAttributeString (string prefix, string localName, string ns, string value)
261 // In MS.NET (1.0), this check is done *here*, not at WriteStartAttribute.
262 // (XmlTextWriter.WriteStartAttribute("xmlns", "anyname", null) throws an exception.
264 WriteStartAttribute (prefix, localName, ns);
265 if (value != null && value.Length > 0)
267 WriteEndAttribute ();
270 public abstract void WriteBase64 (byte[] buffer, int index, int count);
273 public virtual void WriteBinHex (byte [] buffer, int index, int count)
275 StringWriter sw = new StringWriter ();
276 XmlConvert.WriteBinHex (buffer, index, count, sw);
277 WriteString (sw.ToString ());
280 public abstract void WriteBinHex (byte[] buffer, int index, int count);
283 public abstract void WriteCData (string text);
285 public abstract void WriteCharEntity (char ch);
287 public abstract void WriteChars (char[] buffer, int index, int count);
289 public abstract void WriteComment (string text);
291 public abstract void WriteDocType (string name, string pubid, string sysid, string subset);
293 public void WriteElementString (string localName, string value)
295 WriteStartElement(localName);
296 if (value != null && value.Length > 0)
301 public void WriteElementString (string localName, string ns, string value)
303 WriteStartElement(localName, ns);
304 if (value != null && value.Length > 0)
310 public void WriteElementString (string prefix, string localName, string ns, string value)
312 WriteStartElement(prefix, localName, ns);
313 if (value != null && value.Length > 0)
319 public abstract void WriteEndAttribute ();
321 public abstract void WriteEndDocument ();
323 public abstract void WriteEndElement ();
325 public abstract void WriteEntityRef (string name);
327 public abstract void WriteFullEndElement ();
330 public virtual void WriteName (string name)
332 WriteNameInternal (name);
335 public virtual void WriteNmToken (string name)
337 WriteNmTokenInternal (name);
340 public virtual void WriteQualifiedName (string localName, string ns)
342 WriteQualifiedNameInternal (localName, ns);
345 public abstract void WriteName (string name);
347 public abstract void WriteNmToken (string name);
349 public abstract void WriteQualifiedName (string localName, string ns);
352 internal void WriteNameInternal (string name)
355 switch (Settings.ConformanceLevel) {
356 case ConformanceLevel.Document:
357 case ConformanceLevel.Fragment:
358 XmlConvert.VerifyName (name);
362 XmlConvert.VerifyName (name);
367 internal virtual void WriteNmTokenInternal (string name)
371 switch (Settings.ConformanceLevel) {
372 case ConformanceLevel.Document:
373 case ConformanceLevel.Fragment:
374 valid = XmlChar.IsNmToken (name);
378 valid = XmlChar.IsNmToken (name);
381 throw new ArgumentException ("Argument name is not a valid NMTOKEN.");
385 internal void WriteQualifiedNameInternal (string localName, string ns)
387 if (localName == null || localName == String.Empty)
388 throw new ArgumentException ();
393 if (Settings != null) {
394 switch (Settings.ConformanceLevel) {
395 case ConformanceLevel.Document:
396 case ConformanceLevel.Fragment:
397 XmlConvert.VerifyNCName (localName);
402 XmlConvert.VerifyNCName (localName);
404 XmlConvert.VerifyNCName (localName);
407 string prefix = ns.Length > 0 ? LookupPrefix (ns) : String.Empty;
409 throw new ArgumentException (String.Format ("Namespace '{0}' is not declared.", ns));
411 if (prefix != String.Empty) {
412 WriteString (prefix);
414 WriteString (localName);
417 WriteString (localName);
421 public virtual void WriteNode (XPathNavigator navigator, bool defattr)
423 if (navigator == null)
424 throw new ArgumentNullException ("navigator");
425 switch (navigator.NodeType) {
426 case XPathNodeType.Attribute:
429 case XPathNodeType.Namespace:
432 case XPathNodeType.Text:
433 WriteString (navigator.Value);
435 case XPathNodeType.SignificantWhitespace:
436 WriteWhitespace (navigator.Value);
438 case XPathNodeType.Whitespace:
439 WriteWhitespace (navigator.Value);
441 case XPathNodeType.Comment:
442 WriteComment (navigator.Value);
444 case XPathNodeType.ProcessingInstruction:
445 WriteProcessingInstruction (navigator.Name, navigator.Value);
447 case XPathNodeType.Root:
448 if (navigator.MoveToFirstChild ()) {
450 WriteNode (navigator, defattr);
451 } while (navigator.MoveToNext ());
452 navigator.MoveToParent ();
455 case XPathNodeType.Element:
456 WriteStartElement (navigator.Prefix, navigator.LocalName, navigator.NamespaceURI);
457 if (navigator.MoveToFirstNamespace (XPathNamespaceScope.Local)) {
459 if (defattr || navigator.SchemaInfo == null || navigator.SchemaInfo.IsDefault)
460 WriteAttributeString (navigator.Prefix,
461 navigator.LocalName == String.Empty ? "xmlns" : navigator.LocalName,
462 "http://www.w3.org/2000/xmlns/",
464 } while (navigator.MoveToNextNamespace (XPathNamespaceScope.Local));
465 navigator.MoveToParent ();
467 if (navigator.MoveToFirstAttribute ()) {
469 if (defattr || navigator.SchemaInfo == null || navigator.SchemaInfo.IsDefault)
470 WriteAttributeString (navigator.Prefix, navigator.LocalName, navigator.NamespaceURI, navigator.Value);
472 } while (navigator.MoveToNextAttribute ());
473 navigator.MoveToParent ();
475 if (navigator.MoveToFirstChild ()) {
477 WriteNode (navigator, defattr);
478 } while (navigator.MoveToNext ());
479 navigator.MoveToParent ();
481 if (navigator.IsEmptyElement)
484 WriteFullEndElement ();
487 throw new NotSupportedException ();
492 public virtual void WriteNode (XmlReader reader, bool defattr)
495 throw new ArgumentException ();
497 if (reader.ReadState == ReadState.Initial) {
500 WriteNode (reader, defattr);
501 } while (!reader.EOF);
505 switch (reader.NodeType) {
506 case XmlNodeType.Element:
507 WriteStartElement (reader.Prefix, reader.LocalName, reader.NamespaceURI);
509 WriteAttributes (reader, defattr);
510 reader.MoveToElement ();
512 // Well, I found that MS.NET took this way, since
513 // there was a error-prone SgmlReader that fails
514 // MoveToNextAttribute().
515 if (reader.HasAttributes) {
516 for (int i = 0; i < reader.AttributeCount; i++) {
517 reader.MoveToAttribute (i);
518 WriteAttribute (reader, defattr);
520 reader.MoveToElement ();
523 if (reader.IsEmptyElement)
526 int depth = reader.Depth;
528 if (reader.NodeType != XmlNodeType.EndElement) {
530 WriteNode (reader, defattr);
531 } while (depth < reader.Depth);
533 WriteFullEndElement ();
536 // In case of XmlAttribute, don't proceed reader, and it will never be written.
537 case XmlNodeType.Attribute:
539 case XmlNodeType.Text:
540 WriteString (reader.Value);
542 case XmlNodeType.CDATA:
543 WriteCData (reader.Value);
545 case XmlNodeType.EntityReference:
546 WriteEntityRef (reader.Name);
548 case XmlNodeType.XmlDeclaration:
549 // LAMESPEC: It means that XmlWriter implementation _must not_ check
550 // whether PI name is "xml" (it is XML error) or not.
551 case XmlNodeType.ProcessingInstruction:
552 WriteProcessingInstruction (reader.Name, reader.Value);
554 case XmlNodeType.Comment:
555 WriteComment (reader.Value);
557 case XmlNodeType.DocumentType:
558 WriteDocType (reader.Name,
559 reader ["PUBLIC"], reader ["SYSTEM"], reader.Value);
561 case XmlNodeType.SignificantWhitespace:
562 goto case XmlNodeType.Whitespace;
563 case XmlNodeType.Whitespace:
564 WriteWhitespace (reader.Value);
566 case XmlNodeType.EndElement:
567 WriteFullEndElement ();
569 case XmlNodeType.EndEntity:
571 case XmlNodeType.None:
572 break; // Do nothing, nor reporting errors.
574 throw new XmlException ("Unexpected node " + reader.Name + " of type " + reader.NodeType);
579 public abstract void WriteProcessingInstruction (string name, string text);
581 public abstract void WriteRaw (string data);
583 public abstract void WriteRaw (char[] buffer, int index, int count);
586 public void WriteStartAttribute (string localName)
588 WriteStartAttribute (null, localName, null);
592 public void WriteStartAttribute (string localName, string ns)
594 WriteStartAttribute (null, localName, ns);
597 public abstract void WriteStartAttribute (string prefix, string localName, string ns);
599 public abstract void WriteStartDocument ();
601 public abstract void WriteStartDocument (bool standalone);
603 public void WriteStartElement (string localName)
605 WriteStartElement (null, localName, null);
608 public void WriteStartElement (string localName, string ns)
610 WriteStartElement (null, localName, ns);
613 public abstract void WriteStartElement (string prefix, string localName, string ns);
615 public abstract void WriteString (string text);
617 public abstract void WriteSurrogateCharEntity (char lowChar, char highChar);
619 public abstract void WriteWhitespace (string ws);
622 public virtual void WriteValue (bool value)
624 WriteString (XQueryConvert.BooleanToString (value));
627 public virtual void WriteValue (DateTime value)
629 WriteString (XmlConvert.ToString (value));
632 public virtual void WriteValue (decimal value)
634 WriteString (XQueryConvert.DecimalToString (value));
637 public virtual void WriteValue (double value)
639 WriteString (XQueryConvert.DoubleToString (value));
642 public virtual void WriteValue (int value)
644 WriteString (XQueryConvert.IntToString (value));
647 public virtual void WriteValue (long value)
649 WriteString (XQueryConvert.IntegerToString (value));
652 public virtual void WriteValue (object value)
655 throw new ArgumentNullException ("value");
658 WriteString ((string) value);
659 else if (value is bool)
660 WriteValue ((bool) value);
661 else if (value is byte)
662 WriteValue ((int) value);
663 else if (value is byte [])
664 WriteBase64 ((byte []) value, 0, ((byte []) value).Length);
665 else if (value is char [])
666 WriteChars ((char []) value, 0, ((char []) value).Length);
667 else if (value is DateTime)
668 WriteValue ((DateTime) value);
669 else if (value is decimal)
670 WriteValue ((decimal) value);
671 else if (value is double)
672 WriteValue ((double) value);
673 else if (value is short)
674 WriteValue ((int) value);
675 else if (value is int)
676 WriteValue ((int) value);
677 else if (value is long)
678 WriteValue ((long) value);
679 else if (value is float)
680 WriteValue ((float) value);
681 else if (value is TimeSpan) // undocumented
682 WriteString (XmlConvert.ToString ((TimeSpan) value));
683 else if (value is Uri)
684 WriteString (((Uri) value).ToString ());
685 else if (value is XmlQualifiedName) {
686 XmlQualifiedName qname = (XmlQualifiedName) value;
687 if (!qname.Equals (XmlQualifiedName.Empty)) {
688 if (qname.Namespace.Length > 0 && LookupPrefix (qname.Namespace) == null)
689 throw new InvalidCastException (String.Format ("The QName '{0}' cannot be written. No corresponding prefix is declared", qname));
690 WriteQualifiedName (qname.Name, qname.Namespace);
693 WriteString (String.Empty);
695 else if (value is IEnumerable) {
697 foreach (object obj in (IEnumerable) value) {
706 throw new InvalidCastException (String.Format ("Type '{0}' cannot be cast to string", value.GetType ()));
709 public virtual void WriteValue (float value)
711 WriteString (XQueryConvert.FloatToString (value));
714 public virtual void WriteValue (string value)