OLD | NEW |
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * A script to assist in documenting the difference between the dart:html API | 6 * A script to assist in documenting the difference between the dart:html API |
7 * and the old DOM API. | 7 * and the old DOM API. |
8 */ | 8 */ |
9 #library('html_diff'); | 9 #library('html_diff'); |
10 | 10 |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
44 final Map<Member, Set<Member>> htmlToDom; | 44 final Map<Member, Set<Member>> htmlToDom; |
45 | 45 |
46 /** A map from `dart:dom` types to corresponding `dart:html` types. */ | 46 /** A map from `dart:dom` types to corresponding `dart:html` types. */ |
47 final Map<Type, Set<Type>> domTypesToHtml; | 47 final Map<Type, Set<Type>> domTypesToHtml; |
48 | 48 |
49 /** A map from `dart:html` types to corresponding `dart:dom` types. */ | 49 /** A map from `dart:html` types to corresponding `dart:dom` types. */ |
50 final Map<Type, Set<Type>> htmlTypesToDom; | 50 final Map<Type, Set<Type>> htmlTypesToDom; |
51 | 51 |
52 final CommentMap comments; | 52 final CommentMap comments; |
53 | 53 |
| 54 /** If true, then print warning messages. */ |
| 55 final bool _printWarnings; |
| 56 |
54 static Library dom; | 57 static Library dom; |
55 | 58 |
56 /** | 59 /** |
57 * Perform static initialization of [world]. This should be run before | 60 * Perform static initialization of [world]. This should be run before |
58 * calling [HtmlDiff.run]. | 61 * calling [HtmlDiff.run]. |
59 */ | 62 */ |
60 static void initialize() { | 63 static void initialize() { |
61 world.getOrAddLibrary('dart:dom'); | 64 world.getOrAddLibrary('dart:dom'); |
62 world.getOrAddLibrary('dart:html'); | 65 world.getOrAddLibrary('dart:html'); |
63 world.process(); | 66 world.process(); |
64 | 67 |
65 dom = world.libraries['dart:dom']; | 68 dom = world.libraries['dart:dom']; |
66 } | 69 } |
67 | 70 |
68 HtmlDiff() : | 71 HtmlDiff([bool printWarnings = false]) : |
| 72 _printWarnings = printWarnings, |
69 domToHtml = new Map<Member, Set<Member>>(), | 73 domToHtml = new Map<Member, Set<Member>>(), |
70 htmlToDom = new Map<Member, Set<Member>>(), | 74 htmlToDom = new Map<Member, Set<Member>>(), |
71 domTypesToHtml = new Map<Type, Set<Type>>(), | 75 domTypesToHtml = new Map<Type, Set<Type>>(), |
72 htmlTypesToDom = new Map<Type, Set<Type>>(), | 76 htmlTypesToDom = new Map<Type, Set<Type>>(), |
73 comments = new CommentMap(); | 77 comments = new CommentMap(); |
74 | 78 |
| 79 void warn(String s) { |
| 80 if (_printWarnings) { |
| 81 print('Warning: ' + s); |
| 82 } |
| 83 } |
| 84 |
75 /** | 85 /** |
76 * Computes the `dart:dom` to `dart:html` mapping, and places it in | 86 * Computes the `dart:dom` to `dart:html` mapping, and places it in |
77 * [domToHtml], [htmlToDom], [domTypesToHtml], and [htmlTypesToDom]. Before | 87 * [domToHtml], [htmlToDom], [domTypesToHtml], and [htmlTypesToDom]. Before |
78 * this is run, Frog should be initialized (via [parseOptions] and | 88 * this is run, Frog should be initialized (via [parseOptions] and |
79 * [initializeWorld]) and [HtmlDiff.initialize] should be called. | 89 * [initializeWorld]) and [HtmlDiff.initialize] should be called. |
80 */ | 90 */ |
81 void run() { | 91 void run() { |
82 final htmlLib = world.libraries['dart:html']; | 92 final htmlLib = world.libraries['dart:html']; |
83 for (Type htmlType in htmlLib.types.getValues()) { | 93 for (Type htmlType in htmlLib.types.getValues()) { |
84 final domTypes = htmlToDomTypes(htmlType); | 94 final domTypes = htmlToDomTypes(htmlType); |
(...skipping 17 matching lines...) Expand all Loading... |
102 * [implMember]'s defining [Type]. | 112 * [implMember]'s defining [Type]. |
103 */ | 113 */ |
104 void _addMemberDiff(Member htmlMember, List<Type> domTypes) { | 114 void _addMemberDiff(Member htmlMember, List<Type> domTypes) { |
105 if (htmlMember.isProperty) { | 115 if (htmlMember.isProperty) { |
106 if (htmlMember.canGet) _addMemberDiff(htmlMember.getter, domTypes); | 116 if (htmlMember.canGet) _addMemberDiff(htmlMember.getter, domTypes); |
107 if (htmlMember.canSet) _addMemberDiff(htmlMember.setter, domTypes); | 117 if (htmlMember.canSet) _addMemberDiff(htmlMember.setter, domTypes); |
108 } | 118 } |
109 | 119 |
110 var domMembers = htmlToDomMembers(htmlMember, domTypes); | 120 var domMembers = htmlToDomMembers(htmlMember, domTypes); |
111 if (htmlMember == null && !domMembers.isEmpty()) { | 121 if (htmlMember == null && !domMembers.isEmpty()) { |
112 print('Warning: dart:html member ${htmlMember.declaringType.name}.' + | 122 warn('dart:html member ${htmlMember.declaringType.name}.' + |
113 '${htmlMember.name} has no corresponding dart:html member.'); | 123 '${htmlMember.name} has no corresponding dart:html member.'); |
114 } | 124 } |
115 | 125 |
116 if (htmlMember == null) return; | 126 if (htmlMember == null) return; |
117 if (!domMembers.isEmpty()) htmlToDom[htmlMember] = domMembers; | 127 if (!domMembers.isEmpty()) htmlToDom[htmlMember] = domMembers; |
118 domMembers.forEach((m) => | 128 domMembers.forEach((m) => |
119 domToHtml.putIfAbsent(m, () => new Set()).add(htmlMember)); | 129 domToHtml.putIfAbsent(m, () => new Set()).add(htmlMember)); |
120 } | 130 } |
121 | 131 |
122 /** | 132 /** |
123 * Returns the `dart:dom` [Type]s that correspond to [htmlType] from | 133 * Returns the `dart:dom` [Type]s that correspond to [htmlType] from |
124 * `dart:html`. This can be the empty list if no correspondence is found. | 134 * `dart:html`. This can be the empty list if no correspondence is found. |
125 */ | 135 */ |
126 List<Type> htmlToDomTypes(Type htmlType) { | 136 List<Type> htmlToDomTypes(Type htmlType) { |
127 if (htmlType.name == null) return []; | 137 if (htmlType.name == null) return []; |
128 final tags = _getTags(comments.find(htmlType.span)); | 138 final tags = _getTags(comments.find(htmlType.span)); |
129 | 139 |
130 if (tags.containsKey('domName')) { | 140 if (tags.containsKey('domName')) { |
131 var domNames = map(tags['domName'].split(','), (s) => s.trim()); | 141 var domNames = map(tags['domName'].split(','), (s) => s.trim()); |
132 if (domNames.length == 1 && domNames[0] == 'none') return []; | 142 if (domNames.length == 1 && domNames[0] == 'none') return []; |
133 return map(domNames, (domName) { | 143 return map(domNames, (domName) { |
134 final domType = dom.types[domName]; | 144 final domType = dom.types[domName]; |
135 if (domType == null) print('Warning: no dart:dom type named $domName'); | 145 if (domType == null) warn('no dart:dom type named $domName'); |
136 return domType; | 146 return domType; |
137 }); | 147 }); |
138 } | 148 } |
139 return <Type>[]; | 149 return <Type>[]; |
140 } | 150 } |
141 | 151 |
142 /** | 152 /** |
143 * Returns the `dart:dom` [Member]s that correspond to [htmlMember] from | 153 * Returns the `dart:dom` [Member]s that correspond to [htmlMember] from |
144 * `dart:html`. This can be the empty set if no correspondence is found. | 154 * `dart:html`. This can be the empty set if no correspondence is found. |
145 * [domTypes] are the `dart:dom` [Type]s that correspond to [implMember]'s | 155 * [domTypes] are the `dart:dom` [Type]s that correspond to [implMember]'s |
146 * defining [Type]. | 156 * defining [Type]. |
147 */ | 157 */ |
148 Set<Member> htmlToDomMembers(Member htmlMember, List<Type> domTypes) { | 158 Set<Member> htmlToDomMembers(Member htmlMember, List<Type> domTypes) { |
149 if (htmlMember.isPrivate) return new Set(); | 159 if (htmlMember.isPrivate) return new Set(); |
150 final tags = _getTags(comments.find(htmlMember.span)); | 160 final tags = _getTags(comments.find(htmlMember.span)); |
151 if (tags.containsKey('domName')) { | 161 if (tags.containsKey('domName')) { |
152 final domNames = map(tags['domName'].split(','), (s) => s.trim()); | 162 final domNames = map(tags['domName'].split(','), (s) => s.trim()); |
153 if (domNames.length == 1 && domNames[0] == 'none') return new Set(); | 163 if (domNames.length == 1 && domNames[0] == 'none') return new Set(); |
154 final members = new Set(); | 164 final members = new Set(); |
155 domNames.forEach((name) { | 165 domNames.forEach((name) { |
156 var nameMembers = _membersFromName(name, domTypes); | 166 var nameMembers = _membersFromName(name, domTypes); |
157 if (nameMembers.isEmpty()) { | 167 if (nameMembers.isEmpty()) { |
158 if (name.contains('.')) { | 168 if (name.contains('.')) { |
159 print('Warning: no member $name'); | 169 warn('no member $name'); |
160 } else { | 170 } else { |
161 final options = Strings.join( | 171 final options = Strings.join( |
162 map(domTypes, (t) => "${t.name}.$name"), ' or '); | 172 map(domTypes, (t) => "${t.name}.$name"), ' or '); |
163 print('Warning: no member $options'); | 173 warn('no member $options'); |
164 } | 174 } |
165 } | 175 } |
166 members.addAll(nameMembers); | 176 members.addAll(nameMembers); |
167 }); | 177 }); |
168 return members; | 178 return members; |
169 } | 179 } |
170 | 180 |
171 return new Set(); | 181 return new Set(); |
172 } | 182 } |
173 | 183 |
174 /** | 184 /** |
175 * Returns the `dart:dom` [Member]s that are indicated by [name]. [name] can | 185 * Returns the `dart:dom` [Member]s that are indicated by [name]. [name] can |
176 * be either an unqualified member name (e.g. `createElement`), in which case | 186 * be either an unqualified member name (e.g. `createElement`), in which case |
177 * it's treated as the name of a member of one of [defaultTypes], or a | 187 * it's treated as the name of a member of one of [defaultTypes], or a |
178 * fully-qualified member name (e.g. `Document.createElement`), in which case | 188 * fully-qualified member name (e.g. `Document.createElement`), in which case |
179 * it's looked up in `dart:dom` and [defaultTypes] is ignored. | 189 * it's looked up in `dart:dom` and [defaultTypes] is ignored. |
180 */ | 190 */ |
181 Set<Member> _membersFromName(String name, List<Type> defaultTypes) { | 191 Set<Member> _membersFromName(String name, List<Type> defaultTypes) { |
182 if (!name.contains('.', 0)) { | 192 if (!name.contains('.', 0)) { |
183 if (defaultTypes.isEmpty()) { | 193 if (defaultTypes.isEmpty()) { |
184 print('Warning: no default type for ${name}'); | 194 warn('no default type for ${name}'); |
185 return new Set(); | 195 return new Set(); |
186 } | 196 } |
187 final members = new Set<Member>(); | 197 final members = new Set<Member>(); |
188 defaultTypes.forEach((t) { | 198 defaultTypes.forEach((t) { |
189 if (t.members.containsKey(name)) members.add(t.members[name]); | 199 if (t.members.containsKey(name)) members.add(t.members[name]); |
190 }); | 200 }); |
191 return members; | 201 return members; |
192 } | 202 } |
193 | 203 |
194 final splitName = name.split('.'); | 204 final splitName = name.split('.'); |
195 if (splitName.length != 2) { | 205 if (splitName.length != 2) { |
196 print('Warning: invalid member name ${name}'); | 206 warn('invalid member name ${name}'); |
197 return new Set(); | 207 return new Set(); |
198 } | 208 } |
199 | 209 |
200 var typeName = splitName[0]; | 210 var typeName = splitName[0]; |
201 | 211 |
202 final type = dom.types[typeName]; | 212 final type = dom.types[typeName]; |
203 if (type == null) return new Set(); | 213 if (type == null) return new Set(); |
204 | 214 |
205 final member = type.members[splitName[1]]; | 215 final member = type.members[splitName[1]]; |
206 if (member == null) return new Set(); | 216 if (member == null) return new Set(); |
(...skipping 12 matching lines...) Expand all Loading... |
219 Map<String, String> _getTags(String comment) { | 229 Map<String, String> _getTags(String comment) { |
220 if (comment == null) return const <String>{}; | 230 if (comment == null) return const <String>{}; |
221 final re = const RegExp("@([a-zA-Z]+) ([^;]+)(?:;|\$)"); | 231 final re = const RegExp("@([a-zA-Z]+) ([^;]+)(?:;|\$)"); |
222 final tags = <String>{}; | 232 final tags = <String>{}; |
223 for (var m in re.allMatches(comment.trim())) { | 233 for (var m in re.allMatches(comment.trim())) { |
224 tags[m[1]] = m[2]; | 234 tags[m[1]] = m[2]; |
225 } | 235 } |
226 return tags; | 236 return tags; |
227 } | 237 } |
228 } | 238 } |
OLD | NEW |