mcs/class/Microsoft.Build/Microsoft.Build.Construction/ProjectElement.cs

   1 //
   2 // ProjectElement.cs
   3 //
   4 // Author:
   5 //   Leszek Ciesielski (skolima@gmail.com)
   6 //
   7 // (C) 2011 Leszek Ciesielski
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections.Generic;
  31 using System.Xml;
  32 using Microsoft.Build.Exceptions;
  33
  34 namespace Microsoft.Build.Construction
  35 {
  36         public abstract class ProjectElement
  37         {
  38                 internal ProjectElement () {}
  39                 public ProjectRootElement ContainingProject { get; internal set; }
  40                 public ProjectElement PreviousSibling { get; internal set; }
  41                 public ProjectElementContainer Parent { get; internal set; }
  42                 public ProjectElement NextSibling { get; internal set; }
  43                 public string Label { get; set; }
  44                 public virtual string Condition { get; set; }
  45                 public IEnumerable<ProjectElementContainer> AllParents {
  46                         get {
  47                                 var parent = Parent;
  48                                 while(parent != null) {
  49                                         yield return parent;
  50                                         parent = parent.Parent;
  51                                 }
  52                         }
  53                 }
  54                 internal virtual void Load (XmlReader reader)
  55                 {
  56                         reader.ReadToFollowing (XmlName);
  57                         while (reader.MoveToNextAttribute ()) {
  58                                 LoadAttribute (reader.Name, reader.Value);
  59                         }
  60                         LoadValue (reader);
  61                 }
  62                 internal virtual void LoadAttribute (string name, string value)
  63                 {
  64                         switch (name) {
  65                         case "xmlns":
  66                                 break;
  67                         case "Label":
  68                                 Label = value;
  69                                 break;
  70                         case "Condition":
  71                                 Condition = value;
  72                                 break;
  73                         default:
  74                                 throw new InvalidProjectFileException (string.Format (
  75                                         "Attribute \"{0}\" is not known on node \"{1}\" [type {2}].", name, XmlName,
  76                                         GetType ()));
  77                         }
  78                 }
  79                 internal virtual void LoadValue (XmlReader reader)
  80                 {
  81                 }
  82                 internal abstract string XmlName { get; }
  83                 internal virtual void Save (XmlWriter writer)
  84                 {
  85                         writer.WriteStartElement (XmlName);
  86                         SaveValue (writer);
  87                         writer.WriteEndElement ();
  88                 }
  89                 internal virtual void SaveValue (XmlWriter writer)
  90                 {
  91                         SaveAttribute (writer, "Label", Label);
  92                         SaveAttribute (writer, "Condition", Condition);
  93                 }
  94                 internal void SaveAttribute (XmlWriter writer, string attributeName, string attributeValue)
  95                 {
  96                         if (!string.IsNullOrWhiteSpace (attributeValue))
  97                                 writer.WriteAttributeString (attributeName, attributeValue);
  98                 }
  99         }
 100 }