Skip to content

Commit dae77f1

Browse files
stereotype441kevmoo
stereotype441
authored and
kevmoo
committedOct 27, 2015
Begin moving code generation tools from analysis_server to analyzer.
This CL introduces the code generation tools in analyzer, but leaves analysis_server untouched. In a later CL, after a new version of analyzer has been published, I'll refactor analysis_server to point to these tools and remove the corresponding code from analysis_server. R=scheglov@google.com Review URL: https://codereview.chromium.org/1411153007 . (cherry picked from commit 9efcce0)
1 parent 9b96eb3 commit dae77f1

File tree

3 files changed

+942
-0
lines changed

3 files changed

+942
-0
lines changed
 

‎pkg/analyzer/lib/src/codegen/html.dart

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
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.
4+
5+
/**
6+
* Tools for manipulating HTML during code generation of analyzer and analysis
7+
* server.
8+
*/
9+
library analyzer.src.codegen.html;
10+
11+
import 'package:html/dom.dart' as dom;
12+
13+
/**
14+
* Make a deep copy of the given HTML nodes.
15+
*/
16+
List<dom.Node> cloneHtmlNodes(List<dom.Node> nodes) =>
17+
nodes.map((dom.Node node) => node.clone(true)).toList();
18+
19+
/**
20+
* Return true if the given iterable contains only whitespace text nodes.
21+
*/
22+
bool containsOnlyWhitespace(Iterable<dom.Node> nodes) {
23+
for (dom.Node node in nodes) {
24+
if (!isWhitespaceNode(node)) {
25+
return false;
26+
}
27+
}
28+
return true;
29+
}
30+
31+
/**
32+
* Get the text contents of the element, ignoring all markup.
33+
*/
34+
String innerText(dom.Element parent) {
35+
StringBuffer buffer = new StringBuffer();
36+
void recurse(dom.Element parent) {
37+
for (dom.Node child in parent.nodes) {
38+
if (child is dom.Text) {
39+
buffer.write(child.text);
40+
} else if (child is dom.Element) {
41+
recurse(child);
42+
}
43+
}
44+
}
45+
recurse(parent);
46+
return buffer.toString();
47+
}
48+
49+
/**
50+
* Return true if the given node is a text node containing only whitespace, or
51+
* a comment.
52+
*/
53+
bool isWhitespaceNode(dom.Node node) {
54+
if (node is dom.Element) {
55+
return false;
56+
} else if (node is dom.Text) {
57+
return node.text.trim().isEmpty;
58+
}
59+
// Treat all other types of nodes (e.g. comments) as whitespace.
60+
return true;
61+
}
62+
63+
/**
64+
* Create an HTML element with the given name, attributes, and child nodes.
65+
*/
66+
dom.Element makeElement(
67+
String name, Map<dynamic, String> attributes, List<dom.Node> children) {
68+
dom.Element result = new dom.Element.tag(name);
69+
result.attributes.addAll(attributes);
70+
for (dom.Node child in children) {
71+
result.append(child);
72+
}
73+
return result;
74+
}
75+
76+
/**
77+
* Mixin class for generating HTML.
78+
*/
79+
class HtmlGenerator {
80+
List<dom.Node> _html;
81+
82+
/**
83+
* Add the given [node] to the HTML output.
84+
*/
85+
void add(dom.Node node) {
86+
_html.add(node);
87+
}
88+
89+
/**
90+
* Add the given [nodes] to the HTML output.
91+
*/
92+
void addAll(Iterable<dom.Node> nodes) {
93+
for (dom.Node node in nodes) {
94+
add(node);
95+
}
96+
}
97+
98+
/**
99+
* Execute [callback], collecting any code that is output using [write],
100+
* [writeln], [add], [addAll] or [element], and return the result as a list
101+
* of HTML nodes.
102+
*/
103+
List<dom.Node> collectHtml(void callback()) {
104+
List<dom.Node> oldHtml = _html;
105+
try {
106+
_html = <dom.Node>[];
107+
if (callback != null) {
108+
callback();
109+
}
110+
return _html;
111+
} finally {
112+
_html = oldHtml;
113+
}
114+
}
115+
116+
/**
117+
* Execute [callback], wrapping its output in an element with the given
118+
* [name] and [attributes].
119+
*/
120+
void element(String name, Map<dynamic, String> attributes,
121+
[void callback()]) {
122+
add(makeElement(name, attributes, collectHtml(callback)));
123+
}
124+
125+
/**
126+
* Output text without ending the current line.
127+
*/
128+
void write(String text) {
129+
_html.add(new dom.Text(text));
130+
}
131+
132+
/**
133+
* Output text, ending the current line.
134+
*/
135+
void writeln([Object obj = '']) {
136+
write('$obj\n');
137+
}
138+
}

‎pkg/analyzer/lib/src/codegen/text_formatter.dart

+247
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
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.
4+
5+
/**
6+
* Code for converting HTML into text, for use during code generation of
7+
* analyzer and analysis server.
8+
*/
9+
library analyzer.src.codegen.text_formatter;
10+
11+
import 'package:html/dom.dart' as dom;
12+
13+
import 'tools.dart';
14+
15+
final RegExp whitespace = new RegExp(r'\s');
16+
17+
/**
18+
* Convert the HTML in [desc] into text, word wrapping at width [width].
19+
*
20+
* If [javadocStyle] is true, then the output is compatable with Javadoc,
21+
* which understands certain HTML constructs.
22+
*/
23+
String nodesToText(List<dom.Node> desc, int width, bool javadocStyle,
24+
{bool removeTrailingNewLine: false}) {
25+
_TextFormatter formatter = new _TextFormatter(width, javadocStyle);
26+
return formatter.collectCode(() {
27+
formatter.addAll(desc);
28+
formatter.lineBreak(false);
29+
}, removeTrailingNewLine: removeTrailingNewLine);
30+
}
31+
32+
/**
33+
* Engine that transforms HTML to text. The input HTML is processed one
34+
* character at a time, gathering characters into words and words into lines.
35+
*/
36+
class _TextFormatter extends CodeGenerator {
37+
/**
38+
* Word-wrapping width.
39+
*/
40+
final int width;
41+
42+
/**
43+
* The word currently being gathered.
44+
*/
45+
String word = '';
46+
47+
/**
48+
* The line currently being gathered.
49+
*/
50+
String line = '';
51+
52+
/**
53+
* True if a blank line should be inserted before the next word.
54+
*/
55+
bool verticalSpaceNeeded = false;
56+
57+
/**
58+
* True if no text has been output yet. This suppresses blank lines.
59+
*/
60+
bool atStart = true;
61+
62+
/**
63+
* True if we are processing a <pre> element, thus whitespace should be
64+
* preserved.
65+
*/
66+
bool preserveSpaces = false;
67+
68+
/**
69+
* True if the output should be Javadoc compatible.
70+
*/
71+
final bool javadocStyle;
72+
73+
_TextFormatter(this.width, this.javadocStyle);
74+
75+
/**
76+
* Process an HTML node.
77+
*/
78+
void add(dom.Node node) {
79+
if (node is dom.Text) {
80+
for (String char in node.text.split('')) {
81+
if (preserveSpaces) {
82+
wordBreak();
83+
write(escape(char));
84+
} else if (whitespace.hasMatch(char)) {
85+
wordBreak();
86+
} else {
87+
resolveVerticalSpace();
88+
word += escape(char);
89+
}
90+
}
91+
} else if (node is dom.Element) {
92+
switch (node.localName) {
93+
case 'br':
94+
lineBreak(false);
95+
break;
96+
case 'dl':
97+
case 'dt':
98+
case 'h1':
99+
case 'h2':
100+
case 'h3':
101+
case 'h4':
102+
case 'p':
103+
lineBreak(true);
104+
addAll(node.nodes);
105+
lineBreak(true);
106+
break;
107+
case 'div':
108+
lineBreak(false);
109+
if (node.classes.contains('hangingIndent')) {
110+
resolveVerticalSpace();
111+
indentSpecial('', ' ', () {
112+
addAll(node.nodes);
113+
lineBreak(false);
114+
});
115+
} else {
116+
addAll(node.nodes);
117+
lineBreak(false);
118+
}
119+
break;
120+
case 'ul':
121+
lineBreak(false);
122+
addAll(node.nodes);
123+
lineBreak(false);
124+
break;
125+
case 'li':
126+
lineBreak(false);
127+
resolveVerticalSpace();
128+
indentSpecial('- ', ' ', () {
129+
addAll(node.nodes);
130+
lineBreak(false);
131+
});
132+
break;
133+
case 'dd':
134+
lineBreak(true);
135+
indent(() {
136+
addAll(node.nodes);
137+
lineBreak(true);
138+
});
139+
break;
140+
case 'pre':
141+
lineBreak(false);
142+
resolveVerticalSpace();
143+
if (javadocStyle) {
144+
writeln('<pre>');
145+
}
146+
bool oldPreserveSpaces = preserveSpaces;
147+
try {
148+
preserveSpaces = true;
149+
addAll(node.nodes);
150+
} finally {
151+
preserveSpaces = oldPreserveSpaces;
152+
}
153+
writeln();
154+
if (javadocStyle) {
155+
writeln('</pre>');
156+
}
157+
lineBreak(false);
158+
break;
159+
case 'a':
160+
case 'b':
161+
case 'body':
162+
case 'html':
163+
case 'i':
164+
case 'span':
165+
case 'tt':
166+
addAll(node.nodes);
167+
break;
168+
case 'head':
169+
break;
170+
default:
171+
throw new Exception('Unexpected HTML element: ${node.localName}');
172+
}
173+
} else {
174+
throw new Exception('Unexpected HTML: $node');
175+
}
176+
}
177+
178+
/**
179+
* Process a list of HTML nodes.
180+
*/
181+
void addAll(List<dom.Node> nodes) {
182+
for (dom.Node node in nodes) {
183+
add(node);
184+
}
185+
}
186+
187+
/**
188+
* Escape the given character for HTML.
189+
*/
190+
String escape(String char) {
191+
if (javadocStyle) {
192+
switch (char) {
193+
case '<':
194+
return '&lt;';
195+
case '>':
196+
return '&gt;';
197+
case '&':
198+
return '&amp;';
199+
}
200+
}
201+
return char;
202+
}
203+
204+
/**
205+
* Terminate the current word and/or line, if either is in progress.
206+
*/
207+
void lineBreak(bool gap) {
208+
wordBreak();
209+
if (line.isNotEmpty) {
210+
writeln(line);
211+
line = '';
212+
}
213+
if (gap && !atStart) {
214+
verticalSpaceNeeded = true;
215+
}
216+
}
217+
218+
/**
219+
* Insert vertical space if necessary.
220+
*/
221+
void resolveVerticalSpace() {
222+
if (verticalSpaceNeeded) {
223+
writeln();
224+
verticalSpaceNeeded = false;
225+
}
226+
}
227+
228+
/**
229+
* Terminate the current word, if a word is in progress.
230+
*/
231+
void wordBreak() {
232+
if (word.isNotEmpty) {
233+
atStart = false;
234+
if (line.isNotEmpty) {
235+
if (indentWidth + line.length + 1 + word.length <= width) {
236+
line += ' $word';
237+
} else {
238+
writeln(line);
239+
line = word;
240+
}
241+
} else {
242+
line = word;
243+
}
244+
word = '';
245+
}
246+
}
247+
}

0 commit comments

Comments
 (0)