1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
//
// Authors
// Sebastien Pouliot <sebastien@xamarin.com>
//
// Copyright 2013-2014 Xamarin Inc. http://www.xamarin.com
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Xml.Linq;
namespace Xamarin.ApiDiff {
public class FieldComparer : MemberComparer {
public override string GroupName {
get { return "fields"; }
}
public override string ElementName {
get { return "field"; }
}
void RenderFieldAttributes (FieldAttributes source, FieldAttributes target, ApiChange change)
{
var srcNotSerialized = (source & FieldAttributes.NotSerialized) == FieldAttributes.NotSerialized;
var tgtNotSerialized = (target & FieldAttributes.NotSerialized) == FieldAttributes.NotSerialized;
if (srcNotSerialized != tgtNotSerialized) {
// this is not a breaking change, so only render it if it changed.
if (srcNotSerialized) {
change.AppendRemoved ("[NonSerialized]\n");
} else {
change.AppendAdded ("[NonSerialized]\n");
}
}
// the visibility values are the same for MethodAttributes and FieldAttributes, so just use the same method.
RenderVisibility ((MethodAttributes) source, (MethodAttributes) target, change);
// same for the static flag
RenderStatic ((MethodAttributes) source, (MethodAttributes) target, change);
var srcLiteral = (source & FieldAttributes.Literal) != 0;
var tgtLiteral = (target & FieldAttributes.Literal) != 0;
if (srcLiteral) {
if (tgtLiteral) {
change.Append ("const ");
} else {
change.AppendRemoved ("const", true).Append (" ");
}
} else if (tgtLiteral) {
change.AppendAdded ("const", true).Append (" ");
}
var srcInitOnly = (source & FieldAttributes.InitOnly) != 0;
var tgtInitOnly = (target & FieldAttributes.InitOnly) != 0;
if (srcInitOnly) {
if (tgtInitOnly) {
change.Append ("readonly ");
} else {
change.AppendRemoved ("readonly", false).Append (" ");
}
} else if (tgtInitOnly) {
change.AppendAdded ("readonly", true).Append (" ");
}
}
public override bool Equals (XElement source, XElement target, ApiChanges changes)
{
if (base.Equals (source, target, changes))
return true;
var name = source.GetAttribute ("name");
var srcValue = source.GetAttribute ("value");
var tgtValue = target.GetAttribute ("value");
var change = new ApiChange ();
change.Header = "Modified " + GroupName;
if (State.BaseType == "System.Enum") {
change.Append (name).Append (" = ");
if (srcValue != tgtValue) {
change.AppendModified (srcValue, tgtValue, true);
} else {
change.Append (srcValue);
}
} else {
RenderFieldAttributes (source.GetFieldAttributes (), target.GetFieldAttributes (), change);
var srcType = source.GetTypeName ("fieldtype");
var tgtType = target.GetTypeName ("fieldtype");
if (srcType != tgtType) {
change.AppendModified (srcType, tgtType, true);
} else {
change.Append (srcType);
}
change.Append (" ");
change.Append (name);
if (srcType == "string" && srcValue != null)
srcValue = "\"" + srcValue + "\"";
if (tgtType == "string" && tgtValue != null)
tgtValue = "\"" + tgtValue + "\"";
if (srcValue != tgtValue) {
change.Append (" = ");
if (srcValue == null)
srcValue = "null";
if (tgtValue == null)
tgtValue = "null";
change.AppendModified (srcValue, tgtValue, true);
} else if (srcValue != null) {
change.Append (" = ");
change.Append (srcValue);
}
change.Append (";");
}
changes.Add (source, target, change);
return false;
}
public override string GetDescription (XElement e)
{
var sb = new StringBuilder ();
string name = e.GetAttribute ("name");
string value = e.GetAttribute ("value");
if (State.BaseType == "System.Enum") {
sb.Append (name).Append (" = ").Append (value).Append (',');
} else {
var attribs = e.Attribute ("attrib");
if (attribs != null) {
var attr = (FieldAttributes)Int32.Parse (attribs.Value);
if ((attr & FieldAttributes.Public) != FieldAttributes.Public) {
sb.Append ("protected ");
} else {
sb.Append ("public ");
}
if ((attr & FieldAttributes.Static) != 0)
sb.Append ("static ");
if ((attr & FieldAttributes.Literal) != 0)
sb.Append ("const ");
}
string ftype = e.GetTypeName ("fieldtype");
sb.Append (ftype).Append (' ');
sb.Append (name);
if (ftype == "string" && e.Attribute ("value") != null) {
if (value == null)
sb.Append (" = null");
else
sb.Append (" = \"").Append (value).Append ('"');
}
sb.Append (';');
}
return sb.ToString ();
}
public override void BeforeAdding (IEnumerable<XElement> list)
{
first = true;
if (State.BaseType == "System.Enum") {
Output.WriteLine ("<div>");
Output.WriteLine ("<p>Added value{0}:</p>", list.Count () > 1 ? "s" : String.Empty);
Output.WriteLine ("<pre class='added' data-is-non-breaking>");
} else {
base.BeforeAdding (list);
}
}
public override void BeforeRemoving (IEnumerable<XElement> list)
{
first = true;
if (State.BaseType == "System.Enum") {
Output.WriteLine ("<p>Removed value{0}:</p>", list.Count () > 1 ? "s" : String.Empty);
Output.WriteLine ("<pre class='removed' data-is-breaking>");
} else {
base.BeforeRemoving (list);
}
}
}
}
|