Upstream the innerText spec

zcorpan · web-flow · commit 132a55eb22d4 · 2016-08-17T23:04:21.000+02:00
From https://rocallahan.github.io/innerText-spec/ with the following normative changes: * Defined behavior for non-CSS UAs. * The setter is better defined. * Added [CEReactions, TreatNullAs=EmptyString] to the IDL. Fixes whatwg#465. Remaining issues: whatwg#1679
diff --git a/source b/source
@@ -3157,7 +3157,7 @@ a.setAttribute('href', 'http://example.com/'); // change the content attribute d
      <li>The <dfn data-x-href="https://dom.spec.whatwg.org/#in-a-document-tree">in a document tree</dfn>, <dfn data-x-href="https://dom.spec.whatwg.org/#in-a-document">in a document</dfn> (legacy), and <dfn data-x-href="https://dom.spec.whatwg.org/#connected">connected</dfn> concepts</li>
      <li>The <dfn data-noexport="" data-x="concept-slot" data-x-href="https://dom.spec.whatwg.org/#concept-slot">slot</dfn> concept, and its <dfn data-noexport="" data-x="slot-name" data-x-href="https://dom.spec.whatwg.org/#slot-name">name</dfn> and <dfn data-noexport="" data-x-href="https://dom.spec.whatwg.org/#slot-assigned-nodes">assigned nodes</dfn></li>
      <li>The <dfn data-noexport="" data-x="finding flattened slotables" data-x-href="https://dom.spec.whatwg.org/#find-flattened-slotables">find flattened slotables</dfn> algorithm</li>
-     <li>The <dfn data-noexport="" data-x-href="https://dom.spec.whatwg.org/#concept-node-pre-insert">pre-insert</dfn>, <dfn data-noexport="" data-x="concept-node-insert" data-x-href="https://dom.spec.whatwg.org/#concept-node-insert">insert</dfn>, <dfn data-noexport="" data-x="concept-node-append" data-x-href="https://dom.spec.whatwg.org/#concept-node-append">append</dfn>, <dfn data-noexport="" data-x="concept-node-replace" data-x-href="https://dom.spec.whatwg.org/#concept-node-replace">replace</dfn>, <dfn data-noexport="" data-x="concept-node-remove" data-x-href="https://dom.spec.whatwg.org/#concept-node-remove">remove</dfn>, and <dfn data-noexport="" data-x="concept-node-adopt" data-x-href="https://dom.spec.whatwg.org/#concept-node-adopt">adopt</dfn> algorithms for nodes</li>
+     <li>The <dfn data-noexport="" data-x-href="https://dom.spec.whatwg.org/#concept-node-pre-insert">pre-insert</dfn>, <dfn data-noexport="" data-x="concept-node-insert" data-x-href="https://dom.spec.whatwg.org/#concept-node-insert">insert</dfn>, <dfn data-noexport="" data-x="concept-node-append" data-x-href="https://dom.spec.whatwg.org/#concept-node-append">append</dfn>, <dfn data-noexport="" data-x="concept-node-replace" data-x-href="https://dom.spec.whatwg.org/#concept-node-replace">replace</dfn>, <dfn data-noexport="" data-x="concept-node-replace-all" data-x-href="https://dom.spec.whatwg.org/#concept-node-replace-all">replace all</dfn>, <dfn data-noexport="" data-x="concept-node-remove" data-x-href="https://dom.spec.whatwg.org/#concept-node-remove">remove</dfn>, and <dfn data-noexport="" data-x="concept-node-adopt" data-x-href="https://dom.spec.whatwg.org/#concept-node-adopt">adopt</dfn> algorithms for nodes</li>
      <li>The <dfn data-noexport="" data-x="concept-element-attributes-change" data-x-href="https://dom.spec.whatwg.org/#concept-element-attributes-change">change</dfn>, <dfn data-noexport="" data-x="concept-element-attributes-append" data-x-href="https://dom.spec.whatwg.org/#concept-element-attributes-append">append</dfn>, <dfn data-noexport="" data-x="concept-element-attributes-remove" data-x-href="https://dom.spec.whatwg.org/#concept-element-attributes-remove">remove</dfn>, <dfn data-noexport="" data-x="concept-element-attributes-replace" data-x-href="https://dom.spec.whatwg.org/#concept-element-attributes-replace">replace</dfn>, and <dfn data-noexport="" data-x="concept-element-attributes-set-value" data-x-href="https://dom.spec.whatwg.org/#concept-element-attributes-set-value">set value</dfn> algorithms for attributes</li>
      <li>The <dfn data-noexport="" data-x="concept-node-insert-ext" data-x-href="https://dom.spec.whatwg.org/#concept-node-insert-ext">insertion steps</dfn>,
              <dfn data-noexport="" data-x="concept-node-remove-ext" data-x-href="https://dom.spec.whatwg.org/#concept-node-remove-ext">removing steps</dfn>,
@@ -3447,6 +3447,7 @@ a.setAttribute('href', 'http://example.com/'); // change the content attribute d
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css2/visudet.html#propdef-vertical-align">'vertical-align'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css2/generate.html#content">'content'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css2/visuren.html#value-def-inline-block">'inline-block'</dfn> value of the <span>'display'</span> property</li>
+      <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css2/visufx.html#propdef-visibility">'visibility'</dfn> property</li>
     </ul>
 
     <p>The CSS specification also defines the following border properties: <ref spec=CSS></p>
@@ -3541,6 +3542,10 @@ a.setAttribute('href', 'http://example.com/'); // change the content attribute d
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-backgrounds/#position">&lt;position></dfn> CSS data type</li>
     </ul>
 
+    <p>The term <dfn data-noexport=""
+    data-x-href="https://drafts.csswg.org/css-display/#block-level">block-level</dfn> is defined in
+    the <cite>CSS Display</cite> specification. <ref spec=CSSDISPLAY></p>
+
     <p>The following features are defined in the <cite>CSS Fonts</cite> specification: <ref
     spec=CSSFONTS></p>
 
@@ -3578,13 +3583,18 @@ a.setAttribute('href', 'http://example.com/'); // change the content attribute d
     <ul class="brief">
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#propdef-border-spacing">'border-spacing'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#border-collapse-property">'border-collapse'</dfn> property</li>
-      <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#table-cell">'table-cell'</dfn> value of the <span>'display'</span> property</li>
+      <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#table-cell">'table-cell'</dfn>,
+      <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#table-row">'table-row'</dfn>,
+      <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#table-caption">'table-caption'</dfn>, and
+      <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-tables/#table">'table'</dfn>
+      values of the <span>'display'</span> property</li>
     </ul>
 
     <p>The following features are defined in the <cite>CSS Text</cite> specification:
     <ref spec=CSSTEXT></p>
 
     <ul class="brief">
+      <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-text/#text-transform-property">'text-transform'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-text/#white-space-property">'white-space'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-text/#text-align-property">'text-align'</dfn> property</li>
       <li>The <dfn data-noexport="" data-x-href="https://drafts.csswg.org/css-text/#letter-spacing-property">'letter-spacing'</dfn> property</li>
@@ -9648,6 +9658,8 @@ interface <dfn>HTMLElement</dfn> : <span>Element</span> {
   [<span>CEReactions</span>] attribute <span>HTMLMenuElement</span>? <span data-x="dom-contextMenu">contextMenu</span>;
   [<span>CEReactions</span>] attribute boolean <span data-x="dom-spellcheck">spellcheck</span>;
   void <span data-x="dom-forceSpellCheck">forceSpellCheck</span>();
+
+  [<span>CEReactions</span>, TreatNullAs=EmptyString] attribute DOMString <span data-x="dom-innerText">innerText</span>;
 };
 <span>HTMLElement</span> implements <span>GlobalEventHandlers</span>;
 <span>HTMLElement</span> implements <span>DocumentAndElementEventHandlers</span>;
@@ -11959,6 +11971,180 @@ interface <dfn>DOMStringMap</dfn> {
   </div>
 
 
+  <h4>The <code data-x="dom-innerText">innerText</code> IDL attribute</h4>
+
+  <dl class="domintro">
+
+   <dt><var>element</var> . <code subdfn data-x="dom-innerText">innerText</code> [ = <var>value</var> ]</dt>
+
+   <dd>
+
+    <p>Returns the element's text content "as rendered".</p>
+
+    <p>Can be set, to replace the element's children with the given value, but with line breaks
+    converted to <code>br</code> elements.</p>
+
+  </dl>
+
+  <div w-nodev>
+
+  <p>On getting, the <dfn><code data-x="dom-innerText">innerText</code></dfn> attribute must follow
+  these steps:</p>
+
+  <ol>
+   <li><p>If this element is not <span>being rendered</span>, or if the user agent is a non-CSS user
+   agent, then return the same value as the <code>textContent</code> IDL attribute on this
+   element.</p></li>
+
+   <li>
+    <p>Compute a list of items each of which is a string or a positive integer (a <i>required line
+    break count</i>), by applying the following recursive procedure to each child node
+    <var>node</var> of this element in <span>tree order</span>, and then concatenating the results
+    to a single list of items.</p>
+
+    <p class="note">Intuitively, a <i>required line break count</i> item means that a certain number
+    of line breaks appear at that point, but they can be collapsed with the line breaks induced by
+    adjacent <i>required line break count</i> items, reminiscent to CSS margin-collapsing.</p>
+
+    <ol>
+     <li><p>Let <var>items</var> be the result of recursively applying this procedure to each child
+     of <var>node</var> in <span>tree order</span>, and then concatenating the results to a single
+     list of items.</p></li>
+
+     <li><p>If <var>node</var>'s <span>computed value</span> of <span>'visibility'</span> is not
+     'visible', then let the result of these substeps be <var>items</var> and abort these
+     substeps.</p></li>
+
+     <li>
+      <p>If <var>node</var> is a <code>Text</code> node child of an <code>rp</code> element, then
+      let the result of these substeps be a single string item containing the <span
+      data-x="concept-cd-data">text</span> of <var>node</var> and abort these substeps.</p>
+
+      <p class="note">The <code>rp</code> element is normally 'display:none' but we want to include
+      its text.</p>
+     </li>
+
+     <li>
+      <p>If <var>node</var> has no associated CSS box, then let the result of these substeps be
+      <var>items</var> and abort these substeps.</p>
+
+      <p class="note"><var>items</var> can be non-empty due to 'display:contents'.</p>
+     </li>
+
+     <li><p>If <var>node</var> is a <code>Text</code> node, then for each CSS text box produced by
+     <var>node</var>, in content order, compute the text of the box after application of the CSS
+     <span>'white-space'</span> processing rules and <span>'text-transform'</span> rules, let the
+     result of these substeps be a list of the resulting strings, and abort these substeps. The CSS
+     <span>'white-space'</span> processing rules are slightly modified: collapsible spaces at the
+     end of lines are always collapsed, but they are only removed if the line is the last line of
+     the block, or it ends with a <code>br</code> element. Soft hyphens should be preserved. <ref
+     spec=CSSTEXT></p></li>
+
+     <li><p>If <var>node</var> is a <code>br</code> element, then append a string containing a
+     single U+000A LINE FEED (LF) character to <var>items</var>.</p></li>
+
+     <li><p>If <var>node</var>'s <span>computed value</span> of <span>'display'</span> is
+     <span>'table-cell'</span>, and <var>node</var>'s CSS box is not the last
+     <span>'table-cell'</span> box of its enclosing <span>'table-row'</span> box, then append a
+     string containing a single U+0009 CHARACTER TABULATION (tab) character to
+     <var>items</var>.</p></li>
+
+     <li><p>If <var>node</var>'s <span>computed value</span> of <span>'display'</span> is
+     <span>'table-row'</span>, and <var>node</var>'s CSS box is not the last
+     <span>'table-row'</span> box of the nearest ancestor <span>'table'</span> box, then append a
+     string containing a single U+000A LINE FEED (LF) character to <var>items</var>.</p></li>
+
+     <li><p>If <var>node</var> is a <code>p</code> element, then add 2 (a <i>required line break
+     count</i>) at the beginning and end of <var>items</var>.</p></li>
+
+     <li>
+      <p>If <var>node</var>'s <span>used value</span> of <span>'display'</span> is
+      <span>block-level</span> or <span>'table-caption'</span>, then add 1 (a <i>required line break
+      count</i>) at the beginning and end of <var>items</var>. <ref spec=CSSDISPLAY></p>
+
+      <p class="note">Floats and absolutely-positioned elements fall into this category.</p>
+     </li>
+
+     <li><p>Let the result of these substeps be <var>items</var>.</p></li>
+    </ol>
+   </li>
+
+   <li><p>Delete any string items whose strings are empty.</p></li>
+
+   <li><p>Delete any runs of consecutive <i>required line break count</i> items at the start or end
+   of the list.</p></li>
+
+   <li><p>Replace each remaining run of consecutive <i>required line break count</i> items with a
+   string consisting of as many U+000A LINE FEED (LF) characters as the maximum of the values in the
+   <i>required line break count</i> items.</p></li>
+
+   <li><p>Return the concatenation of the string items.</p></li>
+  </ol>
+
+  <p class="note">Note that descendant nodes of most replaced elements (e.g., <code>textarea</code>,
+  <code>select</code>, and <code>video</code> &mdash; but not <code>button</code>) are not rendered
+  by CSS, strictly speaking, and therefore have no CSS boxes for the purposes of this algorithm.</p>
+
+  <p class="big-issue">This algorithm is amenable to being generalized to work on <span
+  data-x="concept-range">ranges</span>. Then we can use it as the basis for <code>Selection</code>'s
+  stringifier and maybe expose it directly on <span data-x="concept-range">ranges</span>. See <a
+  href="https://www.w3.org/Bugs/Public/show_bug.cgi?id=10583">Bugzilla bug 10583</a>.</p>
+
+  <p>On setting, the <code data-x="dom-innerText">innerText</code> attribute must follow these
+  steps:</p>
+
+  <ol>
+   <li><p>Let <var>document</var> be this element's <span>node document</span>.</p></li>
+
+   <li><p>Let <var>fragment</var> be a new <code>DocumentFragment</code> object whose <span>node
+   document</span> is <var>document</var>.</p></li>
+
+   <li><p>Let <var>input</var> be the given value.</p></li>
+
+   <li><p>Let <var>pointer</var> be a pointer into <var>input</var>, initially pointing at the start
+   of the string.</p></li>
+
+   <li><p>Let <var>text</var> be the empty string.</p></li>
+
+   <li>
+    <p>While <var>pointer</var> is not past the end of <var>input</var>:</p>
+
+    <ol>
+     <li><p><span>Collect a sequence of characters</span> that are not U+000A LINE FEED (LF) or
+     U+000D CARRIAGE RETURN (CR) characters. Set <var>text</var> to the collected
+     characters.</p></li>
+
+     <li><p>If <var>text</var> is not the empty string, then <span
+     data-x="concept-node-append">append</span> a new <code>Text</code> node whose <span
+     data-x="concept-cd-data">data</span> is <var>text</var> and <span>node document</span> is
+     <var>document</var> to <var>fragment</var>.</p></li>
+
+     <li>
+      <p>While <var>pointer</var> is not past the end of <var>input</var>, and the character at
+      <var>position</var> is either a U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR)
+      character:</p>
+
+      <ol>
+       <li><p>If the character at <var>position</var> is a U+000D CARRIAGE RETURN (CR) character and
+       the next character is a U+000A LINE FEED (LF) character, then advance <var>position</var> to
+       the next character in <var>input</var>.</p></li>
+
+       <li><p>Advance <var>position</var> to the next character in <var>input</var>.</p></li>
+
+       <li><p><span data-x="concept-node-append">Append</span> the result of <span
+       data-x="create an element">creating an element</span> given <var>document</var>,
+       <code>br</code>, and the <span>HTML namespace</span> to <var>fragment</var>.</p></li>
+      </ol>
+     </li>
+    </ol>
+   </li>
+
+   <li><p><span data-x="concept-node-replace-all">Replace all</span> with <var>fragment</var> within
+   this element.</p></li>
+  </ol>
+
+  </div>
+
   <h4>Requirements relating to the bidirectional algorithm</h4>
 
   <div w-nodev>
@@ -118624,6 +118810,9 @@ INSERT INTERFACES HERE
    <dt id="refsCSSCOLOR">[CSSCOLOR]</dt>
    <dd><cite><a href="https://drafts.csswg.org/css-color/">CSS Color Module Level 3</a></cite>, T. &Ccedil;elik, C. Lilley, L. Baron. W3C.</dd>
 
+   <dt id="refsCSSDISPLAY">[CSSDISPLAY]</dt>
+   <dd><cite><a href="https://drafts.csswg.org/css-font-loading/">CSS Display</a></cite>, T. Atkins, E. Etemad. W3C.</dd>
+
    <dt id="refsCSSFONTLOAD">[CSSFONTLOAD]</dt>
    <dd><cite><a href="https://drafts.csswg.org/css-font-loading/">CSS Font Loading</a></cite>, T. Atkins, J. Daggett. W3C.</dd>
 
@@ -119956,6 +120145,13 @@ INSERT INTERFACES HERE
   href="https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document">W3C Permissive
   Document License</a>.</p>
 
+  <p itemscope itemtype="http://n.whatwg.org/work">Part of the revision history of the <code
+  data-x="dom-innerText">innerText</code> IDL attribute can be found in the <a
+  href="https://github.com/rocallahan/innerText-spec"><code>rocallahan/innerText-spec</code>
+  repository</a>, which is available under the <a itemprop="license"
+  href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0
+  License</a>.</p>
+
   <p>For about ten years starting in 2003, this specification was almost entirely written by Ian
   Hickson (Google, ian@hixie.ch). More recently, Simon Pieters (Opera, simonp@opera.com), Anne van
   Kesteren (Mozilla, annevk@annevk.nl), Philip J&auml;genstedt (Google, philip@foolip.org), and
