mcs/class/System.XML/System.Xml/XmlNodeReader2.cs

   1 //
   2 // System.Xml.XmlNodeReader2.cs - splitted XmlNodeReader that manages entities.
   3 //
   4 // Author:
   5 //      Duncan Mak  (duncan@ximian.com)
   6 //      Atsushi Enomoto  (ginga@kit.hi-ho.ne.jp)
   7 //
   8 // (C) Ximian, Inc.
   9 // (C) Atsushi Enomoto
  10 //
  11
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System;
  34 #if NET_2_0
  35 using System.Collections.Generic;
  36 #endif
  37 using System.Xml;
  38 using System.Xml.Schema;
  39 using System.Text;
  40 using Mono.Xml;
  41
  42 namespace System.Xml
  43 {
  44 #if NET_2_0
  45         public class XmlNodeReader : XmlReader, IHasXmlParserContext, IXmlNamespaceResolver
  46 #else
  47         public class XmlNodeReader : XmlReader, IHasXmlParserContext
  48 #endif
  49         {
  50                 XmlReader entity;
  51                 XmlNodeReaderImpl source;
  52                 bool entityInsideAttribute;
  53                 bool insideAttribute;
  54
  55                 #region Constructor
  56
  57                 public XmlNodeReader (XmlNode node)
  58                 {
  59                         source = new XmlNodeReaderImpl (node);
  60                 }
  61
  62                 private XmlNodeReader (XmlNodeReaderImpl entityContainer, bool insideAttribute)
  63                 {
  64                         source = new XmlNodeReaderImpl (entityContainer);
  65                         this.entityInsideAttribute = insideAttribute;
  66                 }
  67
  68                 #endregion
  69
  70                 #region Properties
  71
  72                 private XmlReader Current {
  73                         get { return entity != null && entity.ReadState != ReadState.Initial ? entity : source; }
  74                 }
  75
  76                 public override int AttributeCount {
  77                         get { return Current.AttributeCount; }
  78                 }
  79
  80                 public override string BaseURI {
  81                         get { return Current.BaseURI; }
  82                 }
  83
  84 #if NET_2_0
  85                 public override bool CanReadBinaryContent {
  86                         get { return true; }
  87                 }
  88
  89 /*
  90                 public override bool CanReadValueChunk {
  91                         get { return true; }
  92                 }
  93 */
  94 #else
  95                 internal override bool CanReadBinaryContent {
  96                         get { return true; }
  97                 }
  98
  99 /*
 100                 internal override bool CanReadValueChunk {
 101                         get { return true; }
 102                 }
 103 */
 104 #endif
 105
 106                 public override bool CanResolveEntity {
 107                         get { return true; }
 108                 }
 109
 110                 public override int Depth {
 111                         get {
 112                                 // On EndEntity, depth is the same as that
 113                                 // of EntityReference.
 114                                 if (entity != null && entity.ReadState == ReadState.Interactive)
 115                                         return source.Depth + entity.Depth + 1;
 116                                 else
 117                                         return source.Depth;
 118                         }
 119                 }
 120
 121                 public override bool EOF {
 122                         get { return source.EOF; }
 123                 }
 124
 125                 public override bool HasAttributes {
 126                         get { return Current.HasAttributes; }
 127                 }
 128
 129                 public override bool HasValue {
 130                         get { return Current.HasValue; }
 131                 }
 132
 133                 public override bool IsDefault {
 134                         get { return Current.IsDefault; }
 135                 }
 136
 137                 public override bool IsEmptyElement {
 138                         get { return Current.IsEmptyElement; }
 139                 }
 140
 141 #if NET_2_0
 142 #else
 143                 public override string this [int i] {
 144                         get { return GetAttribute (i); }
 145                 }
 146
 147                 public override string this [string name] {
 148                         get { return GetAttribute (name); }
 149                 }
 150
 151                 public override string this [string name, string namespaceURI] {
 152                         get { return GetAttribute (name, namespaceURI); }
 153                 }
 154 #endif
 155
 156                 public override string LocalName {
 157                         get { return Current.LocalName; }
 158                 }
 159
 160                 public override string Name {
 161                         get { return Current.Name; }
 162                 }
 163
 164                 public override string NamespaceURI {
 165                         get { return Current.NamespaceURI; }
 166                 }
 167
 168                 public override XmlNameTable NameTable {
 169                         get { return Current.NameTable; }
 170                 }
 171
 172                 public override XmlNodeType NodeType {
 173                         get {
 174                                 if (entity != null)
 175                                         return entity.ReadState == ReadState.Initial ?
 176                                                 source.NodeType :
 177                                                 entity.EOF ? XmlNodeType.EndEntity :
 178                                                 entity.NodeType;
 179                                 else
 180                                         return source.NodeType;
 181                         }
 182                 }
 183
 184                 XmlParserContext IHasXmlParserContext.ParserContext {
 185                         get { return ((IHasXmlParserContext) Current).ParserContext; }
 186                 }
 187
 188                 public override string Prefix {
 189                         get { return Current.Prefix; }
 190                 }
 191
 192 #if NET_2_0
 193 #else
 194                 public override char QuoteChar {
 195                         get { return '"'; }
 196                 }
 197 #endif
 198
 199                 public override ReadState ReadState {
 200                         get { return entity != null ? ReadState.Interactive : source.ReadState; }
 201                 }
 202
 203 #if NET_2_0
 204                 public override IXmlSchemaInfo SchemaInfo {
 205                         get { return entity != null ? entity.SchemaInfo : source.SchemaInfo; }
 206                 }
 207 #endif
 208
 209                 public override string Value {
 210                         get { return Current.Value; }
 211                 }
 212
 213                 public override string XmlLang {
 214                         get { return Current.XmlLang; }
 215                 }
 216
 217                 public override XmlSpace XmlSpace {
 218                         get { return Current.XmlSpace; }
 219                 }
 220                 #endregion
 221
 222                 #region Methods
 223
 224                 // If current entityReference is a child of an attribute,
 225                 // then MoveToAttribute simply means that we no more need this entity Current.
 226                 // Otherwise, this invokation means that
 227                 // it is expected to move to resolved (maybe) element's attribute.
 228                 //
 229                 // This rule applies to many methods like MoveTo*Attribute().
 230
 231                 public override void Close ()
 232                 {
 233                         if (entity != null)
 234                                 entity.Close ();
 235                         source.Close ();
 236                 }
 237
 238                 public override string GetAttribute (int attributeIndex)
 239                 {
 240                         return Current.GetAttribute (attributeIndex);
 241                 }
 242
 243                 public override string GetAttribute (string name)
 244                 {
 245                         return Current.GetAttribute (name);
 246                 }
 247
 248                 public override string GetAttribute (string name, string namespaceURI)
 249                 {
 250                         return Current.GetAttribute (name, namespaceURI);
 251                 }
 252
 253 #if NET_2_0
 254                 IDictionary<string, string> IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
 255                 {
 256                         return ((IXmlNamespaceResolver) Current).GetNamespacesInScope (scope);
 257                 }
 258 #endif
 259
 260                 public override string LookupNamespace (string prefix)
 261                 {
 262                         return Current.LookupNamespace (prefix);
 263                 }
 264
 265 #if NET_2_0
 266                 string IXmlNamespaceResolver.LookupPrefix (string ns)
 267                 {
 268                         return ((IXmlNamespaceResolver) Current).LookupPrefix (ns);
 269                 }
 270 #endif
 271
 272                 public override void MoveToAttribute (int i)
 273                 {
 274                         if (entity != null && entityInsideAttribute) {
 275                                 entity.Close ();
 276                                 entity = null;
 277                         }
 278                         Current.MoveToAttribute (i);
 279                         insideAttribute = true;
 280                 }
 281
 282                 public override bool MoveToAttribute (string name)
 283                 {
 284                         if (entity != null && !entityInsideAttribute)
 285                                 return entity.MoveToAttribute (name);
 286                         if (!source.MoveToAttribute (name))
 287                                 return false;
 288                         if (entity != null && entityInsideAttribute) {
 289                                 entity.Close ();
 290                                 entity = null;
 291                         }
 292                         insideAttribute = true;
 293                         return true;
 294                 }
 295
 296                 public override bool MoveToAttribute (string localName, string namespaceURI)
 297                 {
 298                         if (entity != null && !entityInsideAttribute)
 299                                 return entity.MoveToAttribute (localName, namespaceURI);
 300                         if (!source.MoveToAttribute (localName, namespaceURI))
 301                                 return false;
 302                         if (entity != null && entityInsideAttribute) {
 303                                 entity.Close ();
 304                                 entity = null;
 305                         }
 306                         insideAttribute = true;
 307                         return true;
 308                 }
 309
 310                 public override bool MoveToElement ()
 311                 {
 312                         if (entity != null && entityInsideAttribute)
 313                                 entity = null;
 314                         if (!Current.MoveToElement ())
 315                                 return false;
 316                         insideAttribute = false;
 317                         return true;
 318                 }
 319
 320                 public override bool MoveToFirstAttribute ()
 321                 {
 322                         if (entity != null && !entityInsideAttribute)
 323                                 return entity.MoveToFirstAttribute ();
 324                         if (!source.MoveToFirstAttribute ())
 325                                 return false;
 326                         if (entity != null && entityInsideAttribute) {
 327                                 entity.Close ();
 328                                 entity = null;
 329                         }
 330                         insideAttribute = true;
 331                         return true;
 332                 }
 333
 334                 public override bool MoveToNextAttribute ()
 335                 {
 336                         if (entity != null && !entityInsideAttribute)
 337                                 return entity.MoveToNextAttribute ();
 338                         if (!source.MoveToNextAttribute ())
 339                                 return false;
 340                         if (entity != null && entityInsideAttribute) {
 341                                 entity.Close ();
 342                                 entity = null;
 343                         }
 344                         insideAttribute = true;
 345                         return true;
 346                 }
 347
 348                 public override bool Read ()
 349                 {
 350                         insideAttribute = false;
 351                         if (entity != null && (entityInsideAttribute || entity.EOF))
 352                                 entity = null;
 353                         if (entity != null) {
 354                                 entity.Read ();
 355                                 return true; // either success or EndEntity
 356                         }
 357                         else
 358                                 return source.Read ();
 359                 }
 360
 361                 public override bool ReadAttributeValue ()
 362                 {
 363                         if (entity != null && entityInsideAttribute) {
 364                                 if (entity.EOF)
 365                                         entity = null;
 366                                 else {
 367                                         entity.Read ();
 368                                         return true; // either success or EndEntity
 369                                 }
 370                         }
 371                         return Current.ReadAttributeValue ();
 372                 }
 373
 374 #if NET_2_0
 375                 public override int ReadContentAsBase64 (
 376                         byte [] buffer, int offset, int length)
 377                 {
 378 //                      return base.ReadContentAsBase64 (
 379 //                              buffer, offset, length);
 380                         // FIXME: This is problematic wrt end of entity.
 381                         if (entity != null)
 382                                 return entity.ReadContentAsBase64 (
 383                                         buffer, offset, length);
 384                         else
 385                                 return source.ReadContentAsBase64 (
 386                                         buffer, offset, length);
 387                 }
 388
 389                 public override int ReadContentAsBinHex (
 390                         byte [] buffer, int offset, int length)
 391                 {
 392 //                      return base.ReadContentAsBinHex (
 393 //                              buffer, offset, length);
 394                         // FIXME: This is problematic wrt end of entity.
 395                         if (entity != null)
 396                                 return entity.ReadContentAsBinHex (
 397                                         buffer, offset, length);
 398                         else
 399                                 return source.ReadContentAsBinHex (
 400                                         buffer, offset, length);
 401                 }
 402
 403                 public override int ReadElementContentAsBase64 (
 404                         byte [] buffer, int offset, int length)
 405                 {
 406 //                      return base.ReadElementContentAsBase64 (
 407 //                              buffer, offset, length);
 408                         // FIXME: This is problematic wrt end of entity.
 409                         if (entity != null)
 410                                 return entity.ReadElementContentAsBase64 (
 411                                         buffer, offset, length);
 412                         else
 413                                 return source.ReadElementContentAsBase64 (
 414                                         buffer, offset, length);
 415                 }
 416
 417                 public override int ReadElementContentAsBinHex (
 418                         byte [] buffer, int offset, int length)
 419                 {
 420 //                      return base.ReadElementContentAsBinHex (
 421 //                              buffer, offset, length);
 422                         // FIXME: This is problematic wrt end of entity.
 423                         if (entity != null)
 424                                 return entity.ReadElementContentAsBinHex (
 425                                         buffer, offset, length);
 426                         else
 427                                 return source.ReadElementContentAsBinHex (
 428                                         buffer, offset, length);
 429                 }
 430 #endif
 431
 432                 public override string ReadString ()
 433                 {
 434                         return base.ReadString ();
 435                 }
 436
 437                 public override void ResolveEntity ()
 438                 {
 439                         if (entity != null)
 440                                 entity.ResolveEntity ();
 441                         else {
 442                                 if (source.NodeType != XmlNodeType.EntityReference)
 443                                         throw new InvalidOperationException ("The current node is not an Entity Reference");
 444                                 entity = new XmlNodeReader (source, insideAttribute);
 445                         }
 446                 }
 447
 448                 public override void Skip ()
 449                 {
 450                         if (entity != null && entityInsideAttribute)
 451                                 entity = null;
 452                         Current.Skip ();
 453                 }
 454                 #endregion
 455         }
 456 }