mcs/tools/corcompare/mono-api-html/FieldComparer.cs

   1 //
   2 // Authors
   3 //    Sebastien Pouliot  <sebastien@xamarin.com>
   4 //
   5 // Copyright 2013 Xamarin Inc. http://www.xamarin.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.Reflection;
  29 using System.Text;
  30 using System.Xml.Linq;
  31
  32 namespace Xamarin.ApiDiff {
  33
  34         public class FieldComparer : MemberComparer {
  35
  36                 public override string GroupName {
  37                         get { return "fields"; }
  38                 }
  39
  40                 public override string ElementName {
  41                         get { return "field"; }
  42                 }
  43
  44                 public override string GetDescription (XElement e)
  45                 {
  46                         var sb = GetObsoleteMessage (e);
  47                         bool obsolete = sb.Length > 0;
  48
  49                         string name = e.GetAttribute ("name");
  50                         string value = e.GetAttribute ("value");
  51
  52                         if (State.BaseType == "System.Enum") {
  53                                 sb.Append (name).Append (" = ").Append (value).Append (',');
  54                         } else {
  55                                 var attribs = e.Attribute ("attrib");
  56                                 if (attribs != null) {
  57                                         var attr = (FieldAttributes)Int32.Parse (attribs.Value);
  58                                         if ((attr & FieldAttributes.Public) != FieldAttributes.Public) {
  59                                                 sb.Append ("protected ");
  60                                         } else {
  61                                                 sb.Append ("public ");
  62                                         }
  63
  64                                         if ((attr & FieldAttributes.Static) != 0)
  65                                                 sb.Append ("static ");
  66
  67                                         if ((attr & FieldAttributes.Literal) != 0)
  68                                                 sb.Append ("const ");
  69                                 }
  70
  71                                 string ftype = e.GetTypeName ("fieldtype");
  72                                 sb.Append (ftype).Append (' ');
  73                                 sb.Append (name);
  74                                 if (ftype == "string")
  75                                         sb.Append (" = \"").Append (e.Attribute ("value").Value).Append ('"');
  76                                 sb.Append (';');
  77                         }
  78
  79                         if (obsolete)
  80                                 sb.AppendLine (); // more readable output
  81                         return sb.ToString ();
  82                 }
  83
  84                 public override void BeforeAdding ()
  85                 {
  86                         if (State.BaseType == "System.Enum")
  87                                 Output.WriteLine ("<p>Added values:</p><pre>");
  88                         else
  89                                 base.BeforeAdding ();
  90                 }
  91
  92                 public override void BeforeRemoving ()
  93                 {
  94                         if (State.BaseType == "System.Enum")
  95                                 Output.WriteLine ("<p>Removed values:</p><pre>");
  96                         else
  97                                 base.BeforeRemoving ();
  98                 }
  99         }
 100 }