mcs/tools/mono-api-html/Comparer.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.Collections.Generic;
  29 using System.IO;
  30 using System.Linq;
  31 using System.Xml.Linq;
  32
  33 namespace Xamarin.ApiDiff {
  34
  35         public abstract class Comparer {
  36
  37                 protected List<XElement> removed = new List<XElement> ();
  38                 protected ApiChanges modified = new ApiChanges ();
  39
  40                 public TextWriter Output {
  41                         get { return State.Output; }
  42                 }
  43
  44                 protected TextWriter Indent ()
  45                 {
  46                         for (int i = 0; i < State.Indent; i++)
  47                                 State.Output.Write ("\t");
  48                         return State.Output;
  49                 }
  50
  51                 public abstract void Added (XElement target, bool wasParentAdded);
  52                 public abstract void Modified (XElement source, XElement target, ApiChanges changes);
  53                 public abstract void Removed (XElement source);
  54
  55                 public virtual bool Equals (XElement source, XElement target, ApiChanges changes)
  56                 {
  57                         return XNode.DeepEquals (source, target);
  58                 }
  59
  60                 public abstract void SetContext (XElement current);
  61
  62                 public virtual void Compare (IEnumerable<XElement> source, IEnumerable<XElement> target)
  63                 {
  64                         removed.Clear ();
  65                         modified.Clear ();
  66
  67                         foreach (var s in source) {
  68                                 SetContext (s);
  69                                 string sn = s.GetAttribute ("name");
  70                                 var t = target == null ? null : target.SingleOrDefault (x => x.GetAttribute ("name") == sn);
  71                                 if (t == null) {
  72                                         // not in target, it was removed
  73                                         removed.Add (s);
  74                                 } else {
  75                                         t.Remove ();
  76                                         // possibly modified
  77                                         if (Equals (s, t, modified))
  78                                                 continue;
  79
  80                                         // still in target so will be part of Added
  81                                         Modified (s, t, modified);
  82                                 }
  83                         }
  84                         // delayed, that way we show "Modified", "Added" and then "Removed"
  85                         foreach (var item in removed) {
  86                                 SetContext (item);
  87                                 Removed (item);
  88                         }
  89                         // remaining == newly added in target
  90                         if (target != null) {
  91                                 foreach (var item in target) {
  92                                         SetContext (item);
  93                                         Added (item, false);
  94                                 }
  95                         }
  96                 }
  97         }
  98 }