Files
mono/mcs/class/System.XML/System.Xml/XmlWriter.cs
T
Atsushi Eno 1331b09b01 2004-08-03 Atsushi Enomoto <[email protected]>
* XmlWriter.cs : implemented settings-less Create().
	* XmlWriterSettings.cs : added some comments.

svn path=/trunk/mcs/; revision=31781
2004-08-03 06:49:58 +00:00

580 lines
14 KiB
C#

//
// System.Xml.XmlWriter
//
// Authors:
// Kral Ferch <[email protected]>
// Atsushi Enomoto <[email protected]>
//
// (C) 2002 Kral Ferch
// (C) 2002-2003 Atsushi Enomoto
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.IO;
using System.Text;
#if NET_2_0
using System.Xml.XPath;
using MS.Internal.Xml;
#endif
namespace System.Xml
{
#if NET_2_0
public abstract class XmlWriter : IDisposable
#else
public abstract class XmlWriter
#endif
{
#if NET_2_0
XmlWriterSettings settings;
#endif
#region Constructors
protected XmlWriter () { }
#endregion
#region Properties
#if NET_2_0
public XmlWriterSettings Settings {
get {
if (settings == null)
settings = new XmlWriterSettings ();
return settings;
}
}
#endif
public abstract WriteState WriteState { get; }
#if NET_2_0
public virtual string XmlLang {
get { return null; }
}
public virtual XmlSpace XmlSpace {
get { return XmlSpace.None; }
}
#else
public abstract string XmlLang { get; }
public abstract XmlSpace XmlSpace { get; }
#endif
#endregion
#region Methods
public abstract void Close ();
#if NET_2_0
[MonoTODO]
public static XmlWriter Create (Stream stream)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (string file)
{
return new XmlTextWriter (file, null);
}
[MonoTODO]
public static XmlWriter Create (TextWriter writer)
{
return new XmlTextWriter (writer);
}
[MonoTODO]
public static XmlWriter Create (StringBuilder builder)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (Stream stream, XmlWriterSettings settings)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (string file, XmlWriterSettings settings)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (StringBuilder builder, XmlWriterSettings settings)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (TextWriter writer, XmlWriterSettings settings)
{
throw new NotImplementedException ();
}
[MonoTODO]
public static XmlWriter Create (XmlWriter writer, XmlWriterSettings settings)
{
throw new NotImplementedException ();
}
[MonoTODO]
public virtual void Dispose ()
{
Close ();
}
#endif
public abstract void Flush ();
public abstract string LookupPrefix (string ns);
private void WriteAttribute (XmlReader reader, bool defattr)
{
if (!defattr && reader.IsDefault)
return;
WriteStartAttribute (reader.Prefix, reader.LocalName, reader.NamespaceURI);
while (reader.ReadAttributeValue ()) {
switch (reader.NodeType) {
case XmlNodeType.Text:
WriteString (reader.Value);
break;
case XmlNodeType.EntityReference:
WriteEntityRef (reader.Name);
break;
}
}
WriteEndAttribute ();
}
public virtual void WriteAttributes (XmlReader reader, bool defattr)
{
if(reader == null)
throw new ArgumentException("null XmlReader specified.", "reader");
switch (reader.NodeType) {
case XmlNodeType.XmlDeclaration:
WriteAttributeString ("version", reader ["version"]);
if (reader ["encoding"] != null)
WriteAttributeString ("encoding", reader ["encoding"]);
if (reader ["standalone"] != null)
WriteAttributeString ("standalone", reader ["standalone"]);
break;
case XmlNodeType.Element:
if (reader.MoveToFirstAttribute ())
goto case XmlNodeType.Attribute;
break;
case XmlNodeType.Attribute:
do {
WriteAttribute (reader, defattr);
} while (reader.MoveToNextAttribute ());
break;
default:
throw new XmlException("NodeType is not one of Element, Attribute, nor XmlDeclaration.");
}
}
public void WriteAttributeString (string localName, string value)
{
WriteAttributeString ("", localName, null, value);
}
public void WriteAttributeString (string localName, string ns, string value)
{
WriteAttributeString ("", localName, ns, value);
}
public void WriteAttributeString (string prefix, string localName, string ns, string value)
{
// In MS.NET (1.0), this check is done *here*, not at WriteStartAttribute.
// (XmlTextWriter.WriteStartAttribute("xmlns", "anyname", null) throws an exception.
#if NET_1_0
if ((prefix == "xmlns" || (prefix == "" && localName == "xmlns")) && ns == null)
ns = "http://www.w3.org/2000/xmlns/";
#endif
WriteStartAttribute (prefix, localName, ns);
WriteString (value);
WriteEndAttribute ();
}
public abstract void WriteBase64 (byte[] buffer, int index, int count);
#if NET_2_0
public virtual void WriteBinHex (byte [] buffer, int index, int count)
{
StringWriter sw = new StringWriter ();
XmlConvert.WriteBinHex (buffer, index, count, sw);
WriteString (sw.ToString ());
}
#else
public abstract void WriteBinHex (byte[] buffer, int index, int count);
#endif
public abstract void WriteCData (string text);
public abstract void WriteCharEntity (char ch);
public abstract void WriteChars (char[] buffer, int index, int count);
public abstract void WriteComment (string text);
public abstract void WriteDocType (string name, string pubid, string sysid, string subset);
public void WriteElementString (string localName, string value)
{
WriteStartElement(localName);
WriteString(value);
WriteEndElement();
}
public void WriteElementString (string localName, string ns, string value)
{
WriteStartElement(localName, ns);
WriteString(value);
WriteEndElement();
}
#if NET_2_0
public void WriteElementString (string prefix, string localName, string ns, string value)
{
WriteStartElement(prefix, localName, ns);
WriteString(value);
WriteEndElement();
}
#endif
public abstract void WriteEndAttribute ();
public abstract void WriteEndDocument ();
public abstract void WriteEndElement ();
public abstract void WriteEntityRef (string name);
public abstract void WriteFullEndElement ();
#if NET_2_0
public virtual void WriteName (string name)
{
WriteNameInternal (name);
}
public virtual void WriteNmToken (string name)
{
WriteNmTokenInternal (name);
}
public virtual void WriteQualifiedName (string localName, string ns)
{
WriteQualifiedNameInternal (localName, ns);
}
#else
public abstract void WriteName (string name);
public abstract void WriteNmToken (string name);
public abstract void WriteQualifiedName (string localName, string ns);
#endif
internal void WriteNameInternal (string name)
{
#if NET_2_0
switch (Settings.ConformanceLevel) {
case ConformanceLevel.Document:
case ConformanceLevel.Fragment:
XmlConvert.VerifyName (name);
break;
}
#else
XmlConvert.VerifyName (name);
#endif
WriteString (name);
}
internal virtual void WriteNmTokenInternal (string name)
{
#if NET_2_0
switch (Settings.ConformanceLevel) {
case ConformanceLevel.Document:
case ConformanceLevel.Fragment:
XmlConvert.VerifyNMTOKEN (name);
break;
}
#else
XmlConvert.VerifyNMTOKEN (name);
#endif
WriteString (name);
}
internal void WriteQualifiedNameInternal (string localName, string ns)
{
if (localName == null || localName == String.Empty)
throw new ArgumentException ();
#if NET_2_0
switch (Settings.ConformanceLevel) {
case ConformanceLevel.Document:
case ConformanceLevel.Fragment:
XmlConvert.VerifyNCName (localName);
break;
}
#else
XmlConvert.VerifyNCName (localName);
#endif
string prefix = LookupPrefix (ns);
if (prefix != String.Empty) {
WriteString (prefix);
WriteString (":");
WriteString (localName);
}
else
WriteString (localName);
}
#if NET_2_0
[MonoTODO ("defattr handling")]
public virtual void WriteNode (XPathNavigator navigator, bool defattr)
{
WriteNode (navigator.ReadSubtree (), defattr);
}
#endif
public virtual void WriteNode (XmlReader reader, bool defattr)
{
if (reader == null)
throw new ArgumentException ();
if (reader.ReadState == ReadState.Initial) {
reader.Read ();
do {
WriteNode (reader, defattr);
} while (!reader.EOF);
return;
}
switch (reader.NodeType) {
case XmlNodeType.Element:
WriteStartElement (reader.Prefix, reader.LocalName, reader.NamespaceURI);
#if false
WriteAttributes (reader, defattr);
reader.MoveToElement ();
#else
// Well, I found that MS.NET took this way, since
// there was a error-prone SgmlReader that fails
// MoveToNextAttribute().
if (reader.HasAttributes) {
for (int i = 0; i < reader.AttributeCount; i++) {
reader.MoveToAttribute (i);
WriteAttribute (reader, defattr);
}
reader.MoveToElement ();
}
#endif
if (reader.IsEmptyElement)
WriteEndElement ();
else {
int depth = reader.Depth;
reader.Read ();
if (reader.NodeType != XmlNodeType.EndElement) {
do {
WriteNode (reader, defattr);
} while (depth < reader.Depth);
}
WriteFullEndElement ();
}
break;
// In case of XmlAttribute, don't proceed reader.
case XmlNodeType.Attribute:
return;
case XmlNodeType.Text:
WriteString (reader.Value);
break;
case XmlNodeType.CDATA:
WriteCData (reader.Value);
break;
case XmlNodeType.EntityReference:
WriteEntityRef (reader.Name);
break;
case XmlNodeType.XmlDeclaration:
// LAMESPEC: It means that XmlWriter implementation _must not_ check
// whether PI name is "xml" (it is XML error) or not.
case XmlNodeType.ProcessingInstruction:
WriteProcessingInstruction (reader.Name, reader.Value);
break;
case XmlNodeType.Comment:
WriteComment (reader.Value);
break;
case XmlNodeType.DocumentType:
WriteDocType (reader.Name,
reader ["PUBLIC"], reader ["SYSTEM"], reader.Value);
break;
case XmlNodeType.SignificantWhitespace:
goto case XmlNodeType.Whitespace;
case XmlNodeType.Whitespace:
WriteWhitespace (reader.Value);
break;
case XmlNodeType.EndElement:
WriteFullEndElement ();
break;
case XmlNodeType.EndEntity:
break;
case XmlNodeType.None:
return; // Do nothing, nor reporting errors.
default:
throw new XmlException ("Unexpected node " + reader.Name + " of type " + reader.NodeType);
}
reader.Read ();
}
public abstract void WriteProcessingInstruction (string name, string text);
public abstract void WriteRaw (string data);
public abstract void WriteRaw (char[] buffer, int index, int count);
#if NET_2_0
public void WriteStartAttribute (string localName)
{
WriteStartAttribute (null, localName, null);
}
#endif
public void WriteStartAttribute (string localName, string ns)
{
WriteStartAttribute (null, localName, ns);
}
public abstract void WriteStartAttribute (string prefix, string localName, string ns);
public abstract void WriteStartDocument ();
public abstract void WriteStartDocument (bool standalone);
public void WriteStartElement (string localName)
{
WriteStartElement (null, localName, null);
}
public void WriteStartElement (string localName, string ns)
{
WriteStartElement (null, localName, ns);
}
public abstract void WriteStartElement (string prefix, string localName, string ns);
public abstract void WriteString (string text);
public abstract void WriteSurrogateCharEntity (char lowChar, char highChar);
public abstract void WriteWhitespace (string ws);
#if NET_2_0
[MonoTODO]
public virtual void WriteFromObject (object value)
{
throw new NotImplementedException ();
}
[MonoTODO]
public virtual void WriteValue (bool value)
{
WriteString (XQueryConvert.BooleanToString (value));
}
[MonoTODO]
public virtual void WriteValue (DateTime value)
{
WriteString (XmlConvert.ToString (value));
}
[MonoTODO]
public virtual void WriteValue (Decimal value)
{
WriteString (XQueryConvert.DecimalToString (value));
}
[MonoTODO]
public virtual void WriteValue (double value)
{
WriteString (XQueryConvert.DoubleToString (value));
}
[MonoTODO]
public virtual void WriteValue (int value)
{
WriteString (XQueryConvert.IntToString (value));
}
[MonoTODO]
public virtual void WriteValue (long value)
{
WriteString (XQueryConvert.IntegerToString (value));
}
[MonoTODO]
public virtual void WriteValue (Stream value)
{
throw new NotImplementedException ();
}
[MonoTODO]
public virtual void WriteValue (TextReader value)
{
throw new NotImplementedException ();
}
[MonoTODO]
public virtual void WriteValue (object value)
{
throw new NotImplementedException ();
}
[MonoTODO]
public virtual void WriteValue (float value)
{
WriteString (XQueryConvert.FloatToString (value));
}
[MonoTODO]
public virtual void WriteValue (string value)
{
WriteString (value);
}
#endif
#endregion
}
}