mcs/class/System.Xml.Linq/System.Xml.Linq/XDocument.cs

   1 //
   2 // Authors:
   3 //   Atsushi Enomoto
   4 //
   5 // Copyright 2007 Novell (http://www.novell.com)
   6 //
   7 // Permission is hereby granted, free of charge, to any person obtaining
   8 // a copy of this software and associated documentation files (the
   9 // "Software"), to deal in the Software without restriction, including
  10 // without limitation the rights to use, copy, modify, merge, publish,
  11 // distribute, sublicense, and/or sell copies of the Software, and to
  12 // permit persons to whom the Software is furnished to do so, subject to
  13 // the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be
  16 // included in all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 using System;
  28 using System.Collections;
  29 using System.Collections.Generic;
  30 using System.IO;
  31 using System.Text;
  32 using System.Xml;
  33 using System.Xml.Schema;
  34 using System.Xml.Serialization;
  35
  36 namespace System.Xml.Linq
  37 {
  38         public class XDocument : XContainer
  39         {
  40                 XDeclaration xmldecl;
  41
  42                 public XDocument ()
  43                 {
  44                 }
  45
  46                 public XDocument (params object [] content)
  47                 {
  48                         Add (content);
  49                 }
  50
  51                 public XDocument (XDeclaration xmldecl, params object [] content)
  52                 {
  53                         Declaration = xmldecl;
  54                         Add (content);
  55                 }
  56
  57                 public XDocument (XDocument other)
  58                 {
  59                         foreach (object o in other.Nodes ())
  60                                 Add (XUtil.Clone (o));
  61                 }
  62
  63                 public XDeclaration Declaration {
  64                         get { return xmldecl; }
  65                         set { xmldecl = value; }
  66                 }
  67
  68                 public XDocumentType DocumentType {
  69                         get {
  70                                 foreach (object o in Nodes ())
  71                                         if (o is XDocumentType)
  72                                                 return (XDocumentType) o;
  73                                 return null;
  74                         }
  75                 }
  76
  77                 public override XmlNodeType NodeType {
  78                         get { return XmlNodeType.Document; }
  79                 }
  80
  81                 public XElement Root {
  82                         get {
  83                                 foreach (object o in Nodes ())
  84                                         if (o is XElement)
  85                                                 return (XElement) o;
  86                                 return null;
  87                         }
  88                 }
  89
  90                 public static XDocument Load (string uri)
  91                 {
  92                         return Load (uri, LoadOptions.None);
  93                 }
  94
  95                 public static XDocument Load (string uri, LoadOptions options)
  96                 {
  97                         XmlReaderSettings s = new XmlReaderSettings ();
  98 #if !MOONLIGHT
  99                         s.ProhibitDtd = false; // see XNodeNavigatorTest.MoveToId().
 100 #endif
 101                         s.IgnoreWhitespace = (options & LoadOptions.PreserveWhitespace) == 0;
 102                         using (XmlReader r = XmlReader.Create (uri, s)) {
 103                                 return LoadCore (r, options);
 104                         }
 105                 }
 106
 107                 public static XDocument Load (Stream stream)
 108                 {
 109                         return Load (new StreamReader (stream), LoadOptions.None);
 110                 }
 111
 112                 public static XDocument Load (Stream stream, LoadOptions options)
 113                 {
 114                         return Load (new StreamReader (stream), options);
 115                 }
 116
 117                 public static XDocument Load (TextReader reader)
 118                 {
 119                         return Load (reader, LoadOptions.None);
 120                 }
 121
 122                 public static XDocument Load (TextReader reader, LoadOptions options)
 123                 {
 124                         XmlReaderSettings s = new XmlReaderSettings ();
 125 #if !MOONLIGHT
 126                         s.ProhibitDtd = false; // see XNodeNavigatorTest.MoveToId().
 127 #endif
 128                         s.IgnoreWhitespace = (options & LoadOptions.PreserveWhitespace) == 0;
 129                         using (XmlReader r = XmlReader.Create (reader, s)) {
 130                                 return LoadCore (r, options);
 131                         }
 132                 }
 133
 134                 public static XDocument Load (XmlReader reader)
 135                 {
 136                         return Load (reader, LoadOptions.None);
 137                 }
 138
 139                 public static XDocument Load (XmlReader reader, LoadOptions options)
 140                 {
 141                         XmlReaderSettings s = reader.Settings != null ? reader.Settings.Clone () : new XmlReaderSettings ();
 142                         s.IgnoreWhitespace = (options & LoadOptions.PreserveWhitespace) == 0;
 143                         using (XmlReader r = XmlReader.Create (reader, s)) {
 144                                 return LoadCore (r, options);
 145                         }
 146                 }
 147
 148                 static XDocument LoadCore (XmlReader reader, LoadOptions options)
 149                 {
 150                         XDocument doc = new XDocument ();
 151                         doc.ReadContent (reader, options);
 152                         return doc;
 153                 }
 154
 155                 void ReadContent (XmlReader reader, LoadOptions options)
 156                 {
 157                         if (reader.ReadState == ReadState.Initial)
 158                                 reader.Read ();
 159                         this.FillLineInfoAndBaseUri (reader, options);
 160                         if (reader.NodeType == XmlNodeType.XmlDeclaration) {
 161                                 Declaration = new XDeclaration (
 162                                         reader.GetAttribute ("version"),
 163                                         reader.GetAttribute ("encoding"),
 164                                         reader.GetAttribute ("standalone"));
 165                                 reader.Read ();
 166                         }
 167                         ReadContentFrom (reader, options);
 168                         if (Root == null)
 169                                 throw new InvalidOperationException ("The document element is missing.");
 170                 }
 171
 172                 static void ValidateWhitespace (string s)
 173                 {
 174                         for (int i = 0; i < s.Length; i++)
 175                                 switch (s [i]) {
 176                                 case ' ': case '\t': case '\n': case '\r':
 177                                         continue;
 178                                 default:
 179                                         throw new ArgumentException ("Non-whitespace text appears directly in the document.");
 180                                 }
 181                 }
 182
 183                 public static XDocument Parse (string s)
 184                 {
 185                         return Parse (s, LoadOptions.None);
 186                 }
 187
 188                 public static XDocument Parse (string s, LoadOptions options)
 189                 {
 190                         return Load (new StringReader (s), options);
 191                 }
 192
 193                 public void Save (string filename)
 194                 {
 195                         Save (filename, SaveOptions.None);
 196                 }
 197
 198                 public void Save (string filename, SaveOptions options)
 199                 {
 200                         XmlWriterSettings s = new XmlWriterSettings ();
 201                         if ((options & SaveOptions.DisableFormatting) == SaveOptions.None)
 202                                 s.Indent = true;
 203 #if NET_4_0
 204                         if ((options & SaveOptions.OmitDuplicateNamespaces) == SaveOptions.OmitDuplicateNamespaces)
 205                                 s.NamespaceHandling |= NamespaceHandling.OmitDuplicates;
 206 #endif
 207
 208                         using (XmlWriter w = XmlWriter.Create (filename, s)) {
 209                                 Save (w);
 210                         }
 211                 }
 212
 213                 public void Save (TextWriter tw)
 214                 {
 215                         Save (tw, SaveOptions.None);
 216                 }
 217
 218                 public void Save (TextWriter tw, SaveOptions options)
 219                 {
 220                         XmlWriterSettings s = new XmlWriterSettings ();
 221                         if ((options & SaveOptions.DisableFormatting) == SaveOptions.None)
 222                                 s.Indent = true;
 223 #if NET_4_0
 224                         if ((options & SaveOptions.OmitDuplicateNamespaces) == SaveOptions.OmitDuplicateNamespaces)
 225                                 s.NamespaceHandling |= NamespaceHandling.OmitDuplicates;
 226 #endif
 227                         using (XmlWriter w = XmlWriter.Create (tw, s)) {
 228                                 Save (w);
 229                         }
 230                 }
 231
 232                 public void Save (XmlWriter w)
 233                 {
 234                         WriteTo (w);
 235                 }
 236
 237                 public override void WriteTo (XmlWriter w)
 238                 {
 239                         if (xmldecl != null && xmldecl.Standalone != null)
 240                                 w.WriteStartDocument (xmldecl.Standalone == "yes");
 241                         else
 242                                 w.WriteStartDocument ();
 243                         foreach (XNode node in Nodes ())
 244                                 node.WriteTo (w);
 245                 }
 246
 247                 internal override bool OnAddingObject (object obj, bool rejectAttribute, XNode refNode, bool addFirst)
 248                 {
 249                         VerifyAddedNode (obj, addFirst);
 250                         return false;
 251                 }
 252
 253                 void VerifyAddedNode (object node, bool addFirst)
 254                 {
 255                         if (node == null)
 256                                 throw new InvalidOperationException ("Only a node is allowed here");
 257
 258                         if (node is string)
 259                                 ValidateWhitespace ((string) node);
 260                         if (node is XText)
 261                                 ValidateWhitespace (((XText) node).Value);
 262                         else if (node is XDocumentType) {
 263                                 if (DocumentType != null)
 264                                         throw new InvalidOperationException ("There already is another document type declaration");
 265                                 if (Root != null && !addFirst)
 266                                         throw new InvalidOperationException ("A document type cannot be added after the document element");
 267                         }
 268                         else if (node is XElement) {
 269                                 if (Root != null)
 270                                         throw new InvalidOperationException ("There already is another document element");
 271                                 if (DocumentType != null && addFirst)
 272                                         throw new InvalidOperationException ("An element cannot be added before the document type declaration");
 273                         }
 274                 }
 275 #if NET_4_0
 276                 public void Save (Stream stream)
 277                 {
 278                         Save (stream, SaveOptions.None);
 279                 }
 280
 281                 public void Save (Stream stream, SaveOptions options)
 282                 {
 283                         XmlWriterSettings s = new XmlWriterSettings ();
 284                         if ((options & SaveOptions.DisableFormatting) == SaveOptions.None)
 285                                 s.Indent = true;
 286                         if ((options & SaveOptions.OmitDuplicateNamespaces) == SaveOptions.OmitDuplicateNamespaces)
 287                                 s.NamespaceHandling |= NamespaceHandling.OmitDuplicates;
 288
 289                         using (var writer = XmlWriter.Create (stream, s)){
 290                                 Save (writer);
 291                         }
 292                 }
 293
 294 #endif
 295         }
 296 }