d1f780df0b
also gets the tests running Changes to scripts: * pkg/pkg.gyp: add 'third_party' to list of folders to search * tools/publish_pkg.py: update copyright year * tools/publish_all_pkgs.py: also include pkg/third_party Changes to html5lib: * pubspec.yaml -- removed versions * README.md -- removed some historical notes * added html5lib.status * test/browser -- rename browser_tests to browser_test so test framework finds it * test/parser_test.dart, test/parser_feature_test.dart -- moved dart:io test into parser_test so parser_feature_test can work in browser * test/support.dart -- now finds the data folder relative to entry point script * test/support.dart -- rename "pathos" import to "path" Not changed: * ./test/run.sh still works for testing, in addition to ./tools/test.dart R=dgrove@google.com, ricow@google.com, sigmund@google.com Review URL: https://codereview.chromium.org//22375011 git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@26152 260f80e4-7a28-3924-810f-c04153c831b5
872 lines
25 KiB
Dart
872 lines
25 KiB
Dart
/**
|
|
* A simple tree API that results from parsing html. Intended to be compatible
|
|
* with dart:html, but right now it resembles the classic JS DOM.
|
|
*/
|
|
library dom;
|
|
|
|
import 'dart:collection';
|
|
import 'package:source_maps/span.dart' show FileSpan;
|
|
|
|
import 'src/constants.dart';
|
|
import 'src/list_proxy.dart';
|
|
import 'src/token.dart';
|
|
import 'src/tokenizer.dart';
|
|
import 'src/treebuilder.dart';
|
|
import 'src/utils.dart';
|
|
import 'dom_parsing.dart';
|
|
import 'parser.dart';
|
|
|
|
// TODO(jmesserly): this needs to be replaced by an AttributeMap for attributes
|
|
// that exposes namespace info.
|
|
class AttributeName implements Comparable {
|
|
/** The namespace prefix, e.g. `xlink`. */
|
|
final String prefix;
|
|
|
|
/** The attribute name, e.g. `title`. */
|
|
final String name;
|
|
|
|
/** The namespace url, e.g. `http://www.w3.org/1999/xlink` */
|
|
final String namespace;
|
|
|
|
const AttributeName(this.prefix, this.name, this.namespace);
|
|
|
|
String toString() {
|
|
// Implement:
|
|
// http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#serializing-html-fragments
|
|
// If we get here we know we are xml, xmlns, or xlink, because of
|
|
// [HtmlParser.adjustForeignAttriubtes] is the only place we create
|
|
// an AttributeName.
|
|
return prefix != null ? '$prefix:$name' : name;
|
|
}
|
|
|
|
int get hashCode {
|
|
int h = prefix.hashCode;
|
|
h = 37 * (h & 0x1FFFFF) + name.hashCode;
|
|
h = 37 * (h & 0x1FFFFF) + namespace.hashCode;
|
|
return h & 0x3FFFFFFF;
|
|
}
|
|
|
|
int compareTo(other) {
|
|
// Not sure about this sort order
|
|
if (other is! AttributeName) return 1;
|
|
int cmp = (prefix != null ? prefix : "").compareTo(
|
|
(other.prefix != null ? other.prefix : ""));
|
|
if (cmp != 0) return cmp;
|
|
cmp = name.compareTo(other.name);
|
|
if (cmp != 0) return cmp;
|
|
return namespace.compareTo(other.namespace);
|
|
}
|
|
|
|
bool operator ==(x) {
|
|
if (x is! AttributeName) return false;
|
|
return prefix == x.prefix && name == x.name && namespace == x.namespace;
|
|
}
|
|
}
|
|
|
|
/** Really basic implementation of a DOM-core like Node. */
|
|
abstract class Node {
|
|
static const int ATTRIBUTE_NODE = 2;
|
|
static const int CDATA_SECTION_NODE = 4;
|
|
static const int COMMENT_NODE = 8;
|
|
static const int DOCUMENT_FRAGMENT_NODE = 11;
|
|
static const int DOCUMENT_NODE = 9;
|
|
static const int DOCUMENT_TYPE_NODE = 10;
|
|
static const int ELEMENT_NODE = 1;
|
|
static const int ENTITY_NODE = 6;
|
|
static const int ENTITY_REFERENCE_NODE = 5;
|
|
static const int NOTATION_NODE = 12;
|
|
static const int PROCESSING_INSTRUCTION_NODE = 7;
|
|
static const int TEXT_NODE = 3;
|
|
|
|
// TODO(jmesserly): this should be on Element
|
|
/** The tag name associated with the node. */
|
|
final String tagName;
|
|
|
|
/** The parent of the current node (or null for the document node). */
|
|
Node parent;
|
|
|
|
// TODO(jmesserly): should move to Element.
|
|
/**
|
|
* A map holding name, value pairs for attributes of the node.
|
|
*
|
|
* Note that attribute order needs to be stable for serialization, so we use a
|
|
* LinkedHashMap. Each key is a [String] or [AttributeName].
|
|
*/
|
|
LinkedHashMap<dynamic, String> attributes = new LinkedHashMap();
|
|
|
|
/**
|
|
* A list of child nodes of the current node. This must
|
|
* include all elements but not necessarily other node types.
|
|
*/
|
|
final NodeList nodes = new NodeList._();
|
|
|
|
List<Element> _elements;
|
|
|
|
// TODO(jmesserly): consider using an Expando for this, and put it in
|
|
// dom_parsing. Need to check the performance affect.
|
|
/** The source span of this node, if it was created by the [HtmlParser]. */
|
|
FileSpan sourceSpan;
|
|
|
|
/** The attribute spans if requested. Otherwise null. */
|
|
LinkedHashMap<dynamic, FileSpan> _attributeSpans;
|
|
LinkedHashMap<dynamic, FileSpan> _attributeValueSpans;
|
|
|
|
Node(this.tagName) {
|
|
nodes._parent = this;
|
|
}
|
|
|
|
/**
|
|
* If [sourceSpan] is available, this contains the spans of each attribute.
|
|
* The span of an attribute is the entire attribute, including the name and
|
|
* quotes (if any). For example, the span of "attr" in `<a attr="value">`
|
|
* would be the text `attr="value"`.
|
|
*/
|
|
LinkedHashMap<dynamic, FileSpan> get attributeSpans {
|
|
_ensureAttributeSpans();
|
|
return _attributeSpans;
|
|
}
|
|
|
|
/**
|
|
* If [sourceSpan] is available, this contains the spans of each attribute's
|
|
* value. Unlike [attributeSpans], this span will inlcude only the value.
|
|
* For example, the value span of "attr" in `<a attr="value">` would be the
|
|
* text `value`.
|
|
*/
|
|
LinkedHashMap<dynamic, FileSpan> get attributeValueSpans {
|
|
_ensureAttributeSpans();
|
|
return _attributeValueSpans;
|
|
}
|
|
|
|
List<Element> get children {
|
|
if (_elements == null) {
|
|
_elements = new FilteredElementList(this);
|
|
}
|
|
return _elements;
|
|
}
|
|
|
|
// TODO(jmesserly): needs to support deep clone.
|
|
/**
|
|
* Return a shallow copy of the current node i.e. a node with the same
|
|
* name and attributes but with no parent or child nodes.
|
|
*/
|
|
Node clone();
|
|
|
|
String get namespace => null;
|
|
|
|
// TODO(jmesserly): do we need this here?
|
|
/** The value of the current node (applies to text nodes and comments). */
|
|
String get value => null;
|
|
|
|
// TODO(jmesserly): this is a workaround for http://dartbug.com/4754
|
|
int get $dom_nodeType => nodeType;
|
|
|
|
int get nodeType;
|
|
|
|
String get outerHtml {
|
|
var str = new StringBuffer();
|
|
_addOuterHtml(str);
|
|
return str.toString();
|
|
}
|
|
|
|
String get innerHtml {
|
|
var str = new StringBuffer();
|
|
_addInnerHtml(str);
|
|
return str.toString();
|
|
}
|
|
|
|
set innerHtml(String value) {
|
|
nodes.clear();
|
|
// TODO(jmesserly): should be able to get the same effect by adding the
|
|
// fragment directly.
|
|
nodes.addAll(parseFragment(value, container: tagName).nodes);
|
|
}
|
|
|
|
void _addOuterHtml(StringBuffer str);
|
|
|
|
void _addInnerHtml(StringBuffer str) {
|
|
for (Node child in nodes) child._addOuterHtml(str);
|
|
}
|
|
|
|
String toString() => tagName;
|
|
|
|
Node remove() {
|
|
// TODO(jmesserly): is parent == null an error?
|
|
if (parent != null) {
|
|
parent.nodes.remove(this);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Insert [node] as a child of the current node, before [refNode] in the
|
|
* list of child nodes. Raises [UnsupportedOperationException] if [refNode]
|
|
* is not a child of the current node. If refNode is null, this adds to the
|
|
* end of the list.
|
|
*/
|
|
void insertBefore(Node node, Node refNode) {
|
|
if (refNode == null) {
|
|
nodes.add(node);
|
|
} else {
|
|
nodes.insert(nodes.indexOf(refNode), node);
|
|
}
|
|
}
|
|
|
|
/** Replaces this node with another node. */
|
|
Node replaceWith(Node otherNode) {
|
|
if (parent == null) {
|
|
throw new UnsupportedError('Node must have a parent to replace it.');
|
|
}
|
|
parent.nodes[parent.nodes.indexOf(this)] = otherNode;
|
|
return this;
|
|
}
|
|
|
|
// TODO(jmesserly): should this be a property or remove?
|
|
/** Return true if the node has children or text. */
|
|
bool hasContent() => nodes.length > 0;
|
|
|
|
Pair<String, String> get nameTuple {
|
|
var ns = namespace != null ? namespace : Namespaces.html;
|
|
return new Pair(ns, tagName);
|
|
}
|
|
|
|
/**
|
|
* Move all the children of the current node to [newParent].
|
|
* This is needed so that trees that don't store text as nodes move the
|
|
* text in the correct way.
|
|
*/
|
|
void reparentChildren(Node newParent) {
|
|
newParent.nodes.addAll(nodes);
|
|
nodes.clear();
|
|
}
|
|
|
|
/**
|
|
* Seaches for the first descendant node matching the given selectors, using a
|
|
* preorder traversal. NOTE: right now, this supports only a single type
|
|
* selectors, e.g. `node.query('div')`.
|
|
*/
|
|
Element query(String selectors) => _queryType(_typeSelector(selectors));
|
|
|
|
/**
|
|
* Returns all descendant nodes matching the given selectors, using a
|
|
* preorder traversal. NOTE: right now, this supports only a single type
|
|
* selectors, e.g. `node.queryAll('div')`.
|
|
*/
|
|
List<Element> queryAll(String selectors) {
|
|
var results = new List<Element>();
|
|
_queryAllType(_typeSelector(selectors), results);
|
|
return results;
|
|
}
|
|
|
|
bool hasChildNodes() => !nodes.isEmpty;
|
|
|
|
bool contains(Node node) => nodes.contains(node);
|
|
|
|
String _typeSelector(String selectors) {
|
|
selectors = selectors.trim();
|
|
if (!_isTypeSelector(selectors)) {
|
|
throw new UnimplementedError('only type selectors are implemented');
|
|
}
|
|
return selectors;
|
|
}
|
|
|
|
/**
|
|
* Checks if this is a type selector.
|
|
* See <http://www.w3.org/TR/CSS2/grammar.html>.
|
|
* Note: this doesn't support '*', the universal selector, non-ascii chars or
|
|
* escape chars.
|
|
*/
|
|
bool _isTypeSelector(String selector) {
|
|
// Parser:
|
|
|
|
// element_name
|
|
// : IDENT | '*'
|
|
// ;
|
|
|
|
// Lexer:
|
|
|
|
// nmstart [_a-z]|{nonascii}|{escape}
|
|
// nmchar [_a-z0-9-]|{nonascii}|{escape}
|
|
// ident -?{nmstart}{nmchar}*
|
|
// nonascii [\240-\377]
|
|
// unicode \\{h}{1,6}(\r\n|[ \t\r\n\f])?
|
|
// escape {unicode}|\\[^\r\n\f0-9a-f]
|
|
|
|
// As mentioned above, no nonascii or escape support yet.
|
|
int len = selector.length;
|
|
if (len == 0) return false;
|
|
|
|
int i = 0;
|
|
const int DASH = 45;
|
|
if (selector.codeUnitAt(i) == DASH) i++;
|
|
|
|
if (i >= len || !isLetter(selector[i])) return false;
|
|
i++;
|
|
|
|
for (; i < len; i++) {
|
|
if (!isLetterOrDigit(selector[i]) && selector.codeUnitAt(i) != DASH) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
Element _queryType(String tag) {
|
|
for (var node in nodes) {
|
|
if (node is! Element) continue;
|
|
if (node.tagName == tag) return node;
|
|
var result = node._queryType(tag);
|
|
if (result != null) return result;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
void _queryAllType(String tag, List<Element> results) {
|
|
for (var node in nodes) {
|
|
if (node is! Element) continue;
|
|
if (node.tagName == tag) results.add(node);
|
|
node._queryAllType(tag, results);
|
|
}
|
|
}
|
|
|
|
/** Initialize [attributeSpans] using [sourceSpan]. */
|
|
void _ensureAttributeSpans() {
|
|
if (_attributeSpans != null) return;
|
|
|
|
_attributeSpans = new LinkedHashMap<dynamic, FileSpan>();
|
|
_attributeValueSpans = new LinkedHashMap<dynamic, FileSpan>();
|
|
|
|
if (sourceSpan == null) return;
|
|
|
|
var tokenizer = new HtmlTokenizer(sourceSpan.text, generateSpans: true,
|
|
attributeSpans: true);
|
|
|
|
tokenizer.moveNext();
|
|
var token = tokenizer.current as StartTagToken;
|
|
|
|
if (token.attributeSpans == null) return; // no attributes
|
|
|
|
for (var attr in token.attributeSpans) {
|
|
var offset = sourceSpan.start.offset;
|
|
_attributeSpans[attr.name] = sourceSpan.file.span(
|
|
offset + attr.start, offset + attr.end);
|
|
if (attr.startValue != null) {
|
|
_attributeValueSpans[attr.name] = sourceSpan.file.span(
|
|
offset + attr.startValue, offset + attr.endValue);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
class Document extends Node {
|
|
Document() : super(null);
|
|
factory Document.html(String html) => parse(html);
|
|
|
|
int get nodeType => Node.DOCUMENT_NODE;
|
|
|
|
// TODO(jmesserly): optmize this if needed
|
|
Element get head => query('html').query('head');
|
|
Element get body => query('html').query('body');
|
|
|
|
String toString() => "#document";
|
|
|
|
void _addOuterHtml(StringBuffer str) => _addInnerHtml(str);
|
|
|
|
Document clone() => new Document();
|
|
}
|
|
|
|
class DocumentFragment extends Document {
|
|
DocumentFragment();
|
|
factory DocumentFragment.html(String html) => parseFragment(html);
|
|
|
|
int get nodeType => Node.DOCUMENT_FRAGMENT_NODE;
|
|
|
|
String toString() => "#document-fragment";
|
|
|
|
DocumentFragment clone() => new DocumentFragment();
|
|
}
|
|
|
|
class DocumentType extends Node {
|
|
final String publicId;
|
|
final String systemId;
|
|
|
|
DocumentType(String name, this.publicId, this.systemId) : super(name);
|
|
|
|
int get nodeType => Node.DOCUMENT_TYPE_NODE;
|
|
|
|
String toString() {
|
|
if (publicId != null || systemId != null) {
|
|
// TODO(jmesserly): the html5 serialization spec does not add these. But
|
|
// it seems useful, and the parser can handle it, so for now keeping it.
|
|
var pid = publicId != null ? publicId : '';
|
|
var sid = systemId != null ? systemId : '';
|
|
return '<!DOCTYPE $tagName "$pid" "$sid">';
|
|
} else {
|
|
return '<!DOCTYPE $tagName>';
|
|
}
|
|
}
|
|
|
|
|
|
void _addOuterHtml(StringBuffer str) {
|
|
str.write(toString());
|
|
}
|
|
|
|
DocumentType clone() => new DocumentType(tagName, publicId, systemId);
|
|
}
|
|
|
|
class Text extends Node {
|
|
// TODO(jmesserly): this should be text?
|
|
String value;
|
|
|
|
Text(this.value) : super(null);
|
|
|
|
int get nodeType => Node.TEXT_NODE;
|
|
|
|
String toString() => '"$value"';
|
|
|
|
void _addOuterHtml(StringBuffer str) {
|
|
// Don't escape text for certain elements, notably <script>.
|
|
if (rcdataElements.contains(parent.tagName) ||
|
|
parent.tagName == 'plaintext') {
|
|
str.write(value);
|
|
} else {
|
|
str.write(htmlSerializeEscape(value));
|
|
}
|
|
}
|
|
|
|
Text clone() => new Text(value);
|
|
}
|
|
|
|
class Element extends Node {
|
|
final String namespace;
|
|
|
|
// TODO(jmesserly): deprecate in favor of Element.tag? Or rename?
|
|
Element(String name, [this.namespace]) : super(name);
|
|
|
|
Element.tag(String name) : namespace = null, super(name);
|
|
|
|
static final _START_TAG_REGEXP = new RegExp('<(\\w+)');
|
|
|
|
static final _CUSTOM_PARENT_TAG_MAP = const {
|
|
'body': 'html',
|
|
'head': 'html',
|
|
'caption': 'table',
|
|
'td': 'tr',
|
|
'colgroup': 'table',
|
|
'col': 'colgroup',
|
|
'tr': 'tbody',
|
|
'tbody': 'table',
|
|
'tfoot': 'table',
|
|
'thead': 'table',
|
|
'track': 'audio',
|
|
};
|
|
|
|
// TODO(jmesserly): this is from dart:html _ElementFactoryProvider...
|
|
// TODO(jmesserly): have a look at fixing some things in dart:html, in
|
|
// particular: is the parent tag map complete? Is it faster without regexp?
|
|
// TODO(jmesserly): for our version we can do something smarter in the parser.
|
|
// All we really need is to set the correct parse state.
|
|
factory Element.html(String html) {
|
|
|
|
// TODO(jacobr): this method can be made more robust and performant.
|
|
// 1) Cache the dummy parent elements required to use innerHTML rather than
|
|
// creating them every call.
|
|
// 2) Verify that the html does not contain leading or trailing text nodes.
|
|
// 3) Verify that the html does not contain both <head> and <body> tags.
|
|
// 4) Detatch the created element from its dummy parent.
|
|
String parentTag = 'div';
|
|
String tag;
|
|
final match = _START_TAG_REGEXP.firstMatch(html);
|
|
if (match != null) {
|
|
tag = match.group(1).toLowerCase();
|
|
if (_CUSTOM_PARENT_TAG_MAP.containsKey(tag)) {
|
|
parentTag = _CUSTOM_PARENT_TAG_MAP[tag];
|
|
}
|
|
}
|
|
|
|
var fragment = parseFragment(html, container: parentTag);
|
|
Element element;
|
|
if (fragment.children.length == 1) {
|
|
element = fragment.children[0];
|
|
} else if (parentTag == 'html' && fragment.children.length == 2) {
|
|
// You'll always get a head and a body when starting from html.
|
|
element = fragment.children[tag == 'head' ? 0 : 1];
|
|
} else {
|
|
throw new ArgumentError('HTML had ${fragment.children.length} '
|
|
'top level elements but 1 expected');
|
|
}
|
|
element.remove();
|
|
return element;
|
|
}
|
|
|
|
int get nodeType => Node.ELEMENT_NODE;
|
|
|
|
String toString() {
|
|
if (namespace == null) return "<$tagName>";
|
|
return "<${Namespaces.getPrefix(namespace)} $tagName>";
|
|
}
|
|
|
|
void _addOuterHtml(StringBuffer str) {
|
|
// http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#serializing-html-fragments
|
|
// Element is the most complicated one.
|
|
if (namespace == null ||
|
|
namespace == Namespaces.html ||
|
|
namespace == Namespaces.mathml ||
|
|
namespace == Namespaces.svg) {
|
|
str.write('<$tagName');
|
|
} else {
|
|
// TODO(jmesserly): the spec doesn't define "qualified name".
|
|
// I'm not sure if this is correct, but it should parse reasonably.
|
|
str.write('<${Namespaces.getPrefix(namespace)}:$tagName');
|
|
}
|
|
|
|
if (attributes.length > 0) {
|
|
attributes.forEach((key, v) {
|
|
// Note: AttributeName.toString handles serialization of attribute
|
|
// namespace, if needed.
|
|
str.write(' $key="${htmlSerializeEscape(v, attributeMode: true)}"');
|
|
});
|
|
}
|
|
|
|
str.write('>');
|
|
|
|
if (nodes.length > 0) {
|
|
if (tagName == 'pre' || tagName == 'textarea' || tagName == 'listing') {
|
|
if (nodes[0] is Text && nodes[0].value.startsWith('\n')) {
|
|
// These nodes will remove a leading \n at parse time, so if we still
|
|
// have one, it means we started with two. Add it back.
|
|
str.write('\n');
|
|
}
|
|
}
|
|
|
|
_addInnerHtml(str);
|
|
}
|
|
|
|
// void elements must not have an end tag
|
|
// http://dev.w3.org/html5/markup/syntax.html#void-elements
|
|
if (!isVoidElement(tagName)) str.write('</$tagName>');
|
|
}
|
|
|
|
Element clone() => new Element(tagName, namespace)
|
|
..attributes = new LinkedHashMap.from(attributes);
|
|
|
|
String get id {
|
|
var result = attributes['id'];
|
|
return result != null ? result : '';
|
|
}
|
|
|
|
set id(String value) {
|
|
if (value == null) {
|
|
attributes.remove('id');
|
|
} else {
|
|
attributes['id'] = value;
|
|
}
|
|
}
|
|
}
|
|
|
|
class Comment extends Node {
|
|
final String data;
|
|
|
|
Comment(this.data) : super(null);
|
|
|
|
int get nodeType => Node.COMMENT_NODE;
|
|
|
|
String toString() => "<!-- $data -->";
|
|
|
|
void _addOuterHtml(StringBuffer str) {
|
|
str.write("<!--$data-->");
|
|
}
|
|
|
|
Comment clone() => new Comment(data);
|
|
}
|
|
|
|
|
|
// TODO(jmesserly): fix this to extend one of the corelib classes if possible.
|
|
// (The requirement to remove the node from the old node list makes it tricky.)
|
|
// TODO(jmesserly): is there any way to share code with the _NodeListImpl?
|
|
class NodeList extends ListProxy<Node> {
|
|
// Note: this is conceptually final, but because of circular reference
|
|
// between Node and NodeList we initialize it after construction.
|
|
Node _parent;
|
|
|
|
NodeList._();
|
|
|
|
Node get first => this[0];
|
|
|
|
Node _setParent(Node node) {
|
|
// Note: we need to remove the node from its previous parent node, if any,
|
|
// before updating its parent pointer to point at our parent.
|
|
node.remove();
|
|
node.parent = _parent;
|
|
return node;
|
|
}
|
|
|
|
void add(Node value) {
|
|
super.add(_setParent(value));
|
|
}
|
|
|
|
void addLast(Node value) => add(value);
|
|
|
|
void addAll(Iterable<Node> collection) {
|
|
// Note: we need to be careful if collection is another NodeList.
|
|
// In particular:
|
|
// 1. we need to copy the items before updating their parent pointers,
|
|
// 2. we should update parent pointers in reverse order. That way they
|
|
// are removed from the original NodeList (if any) from the end, which
|
|
// is faster.
|
|
var list = (collection is NodeList || collection is! List)
|
|
? collection.toList() : collection as List;
|
|
for (var node in list.reversed) _setParent(node);
|
|
super.addAll(list);
|
|
}
|
|
|
|
void insert(int index, Node value) {
|
|
super.insert(index, _setParent(value));
|
|
}
|
|
|
|
Node removeLast() => super.removeLast()..parent = null;
|
|
|
|
Node removeAt(int i) => super.removeAt(i)..parent = null;
|
|
|
|
void clear() {
|
|
for (var node in this) node.parent = null;
|
|
super.clear();
|
|
}
|
|
|
|
void operator []=(int index, Node value) {
|
|
this[index].parent = null;
|
|
super[index] = _setParent(value);
|
|
}
|
|
|
|
// TODO(jmesserly): These aren't implemented in DOM _NodeListImpl, see
|
|
// http://code.google.com/p/dart/issues/detail?id=5371
|
|
void setRange(int start, int rangeLength, List<Node> from,
|
|
[int startFrom = 0]) {
|
|
if (from is NodeList) {
|
|
// Note: this is presumed to make a copy
|
|
from = from.sublist(startFrom, startFrom + rangeLength);
|
|
}
|
|
// Note: see comment in [addAll]. We need to be careful about the order of
|
|
// operations if [from] is also a NodeList.
|
|
for (int i = rangeLength - 1; i >= 0; i--) {
|
|
this[start + i].parent = null;
|
|
super[start + i] = _setParent(from[startFrom + i]);
|
|
}
|
|
}
|
|
|
|
void replaceRange(int start, int end, Iterable<Node> newContents) {
|
|
removeRange(start, end);
|
|
insertAll(start, newContents);
|
|
}
|
|
|
|
void removeRange(int start, int rangeLength) {
|
|
for (int i = start; i < rangeLength; i++) this[i].parent = null;
|
|
super.removeRange(start, rangeLength);
|
|
}
|
|
|
|
void removeWhere(bool test(Element e)) {
|
|
for (var node in where(test)) {
|
|
node.parent = null;
|
|
}
|
|
super.removeWhere(test);
|
|
}
|
|
|
|
void retainWhere(bool test(Element e)) {
|
|
for (var node in where((n) => !test(n))) {
|
|
node.parent = null;
|
|
}
|
|
super.retainWhere(test);
|
|
}
|
|
|
|
void insertAll(int index, List<Node> nodes) {
|
|
for (var node in nodes) _setParent(node);
|
|
super.insertAll(index, nodes);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* An indexable collection of a node's descendants in the document tree,
|
|
* filtered so that only elements are in the collection.
|
|
*/
|
|
// TODO(jmesserly): this was copied from dart:html
|
|
// TODO(jmesserly): "implements List<Element>" is a workaround for analyzer bug.
|
|
class FilteredElementList extends IterableBase<Element> with ListMixin<Element>
|
|
implements List<Element> {
|
|
|
|
final Node _node;
|
|
final List<Node> _childNodes;
|
|
|
|
/**
|
|
* Creates a collection of the elements that descend from a node.
|
|
*
|
|
* Example usage:
|
|
*
|
|
* var filteredElements = new FilteredElementList(query("#container"));
|
|
* // filteredElements is [a, b, c].
|
|
*/
|
|
FilteredElementList(Node node): _childNodes = node.nodes, _node = node;
|
|
|
|
// We can't memoize this, since it's possible that children will be messed
|
|
// with externally to this class.
|
|
//
|
|
// TODO(nweiz): we don't always need to create a new list. For example
|
|
// forEach, every, any, ... could directly work on the _childNodes.
|
|
List<Element> get _filtered =>
|
|
new List<Element>.from(_childNodes.where((n) => n is Element));
|
|
|
|
void forEach(void f(Element element)) {
|
|
_filtered.forEach(f);
|
|
}
|
|
|
|
void operator []=(int index, Element value) {
|
|
this[index].replaceWith(value);
|
|
}
|
|
|
|
void set length(int newLength) {
|
|
final len = this.length;
|
|
if (newLength >= len) {
|
|
return;
|
|
} else if (newLength < 0) {
|
|
throw new ArgumentError("Invalid list length");
|
|
}
|
|
|
|
removeRange(newLength, len);
|
|
}
|
|
|
|
String join([String separator = ""]) => _filtered.join(separator);
|
|
|
|
void add(Element value) {
|
|
_childNodes.add(value);
|
|
}
|
|
|
|
void addAll(Iterable<Element> iterable) {
|
|
for (Element element in iterable) {
|
|
add(element);
|
|
}
|
|
}
|
|
|
|
bool contains(Element element) {
|
|
return element is Element && _childNodes.contains(element);
|
|
}
|
|
|
|
Iterable<Element> get reversed => _filtered.reversed;
|
|
|
|
void sort([int compare(Element a, Element b)]) {
|
|
throw new UnsupportedError('TODO(jacobr): should we impl?');
|
|
}
|
|
|
|
void setRange(int start, int end, Iterable<Element> iterable,
|
|
[int skipCount = 0]) {
|
|
throw new UnimplementedError();
|
|
}
|
|
|
|
void fillRange(int start, int end, [Element fillValue]) {
|
|
throw new UnimplementedError();
|
|
}
|
|
|
|
void replaceRange(int start, int end, Iterable<Element> iterable) {
|
|
throw new UnimplementedError();
|
|
}
|
|
|
|
void removeRange(int start, int end) {
|
|
_filtered.sublist(start, end).forEach((el) => el.remove());
|
|
}
|
|
|
|
void clear() {
|
|
// Currently, ElementList#clear clears even non-element nodes, so we follow
|
|
// that behavior.
|
|
_childNodes.clear();
|
|
}
|
|
|
|
Element removeLast() {
|
|
final result = this.last;
|
|
if (result != null) {
|
|
result.remove();
|
|
}
|
|
return result;
|
|
}
|
|
|
|
Iterable map(f(Element element)) => _filtered.map(f);
|
|
Iterable<Element> where(bool f(Element element)) => _filtered.where(f);
|
|
Iterable expand(Iterable f(Element element)) => _filtered.expand(f);
|
|
|
|
void insert(int index, Element value) {
|
|
_childNodes.insert(index, value);
|
|
}
|
|
|
|
void insertAll(int index, Iterable<Element> iterable) {
|
|
_childNodes.insertAll(index, iterable);
|
|
}
|
|
|
|
Element removeAt(int index) {
|
|
final result = this[index];
|
|
result.remove();
|
|
return result;
|
|
}
|
|
|
|
bool remove(Object element) {
|
|
if (element is! Element) return false;
|
|
for (int i = 0; i < length; i++) {
|
|
Element indexElement = this[i];
|
|
if (identical(indexElement, element)) {
|
|
indexElement.remove();
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
Element reduce(Element combine(Element value, Element element)) {
|
|
return _filtered.reduce(combine);
|
|
}
|
|
|
|
dynamic fold(dynamic initialValue,
|
|
dynamic combine(dynamic previousValue, Element element)) {
|
|
return _filtered.fold(initialValue, combine);
|
|
}
|
|
|
|
bool every(bool f(Element element)) => _filtered.every(f);
|
|
bool any(bool f(Element element)) => _filtered.any(f);
|
|
List<Element> toList({ bool growable: true }) =>
|
|
new List<Element>.from(this, growable: growable);
|
|
Set<Element> toSet() => new Set<Element>.from(this);
|
|
Element firstWhere(bool test(Element value), {Element orElse()}) {
|
|
return _filtered.firstWhere(test, orElse: orElse);
|
|
}
|
|
|
|
Element lastWhere(bool test(Element value), {Element orElse()}) {
|
|
return _filtered.lastWhere(test, orElse: orElse);
|
|
}
|
|
|
|
Element singleWhere(bool test(Element value)) {
|
|
return _filtered.singleWhere(test);
|
|
}
|
|
|
|
Element elementAt(int index) {
|
|
return this[index];
|
|
}
|
|
|
|
bool get isEmpty => _filtered.isEmpty;
|
|
int get length => _filtered.length;
|
|
Element operator [](int index) => _filtered[index];
|
|
Iterator<Element> get iterator => _filtered.iterator;
|
|
List<Element> sublist(int start, [int end]) =>
|
|
_filtered.sublist(start, end);
|
|
Iterable<Element> getRange(int start, int end) =>
|
|
_filtered.getRange(start, end);
|
|
int indexOf(Element element, [int start = 0]) =>
|
|
_filtered.indexOf(element, start);
|
|
|
|
int lastIndexOf(Element element, [int start = null]) {
|
|
if (start == null) start = length - 1;
|
|
return _filtered.lastIndexOf(element, start);
|
|
}
|
|
|
|
Element get first => _filtered.first;
|
|
|
|
Element get last => _filtered.last;
|
|
|
|
Element get single => _filtered.single;
|
|
}
|