A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on Chat (such as one of these permanent autoconfirmed members).

DOM XPath: Difference between revisions

From WHATWG Wiki
Jump to navigation Jump to search
(Match Chrome in making loads of stuff optional, which seems better from an ergonomics point-of-view)
(add class="idl" to allow IDL crawlers crawl this)
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
* Integrate the XPath part of the section [http://www.whatwg.org/C#interactions-with-xpath-and-xslt Interactions with XPath and XSLT] from HTML.
* Integrate the XPath part of the section [http://www.whatwg.org/C#interactions-with-xpath-and-xslt Interactions with XPath and XSLT] from HTML.
* Make it clear that contrary to XPath 1.0 multiple Text nodes can indeed be returned, even if they are siblings. The DOM is not the XML InfoSet. (As is the case in WebKit and Gecko today.)
* Make it clear that contrary to XPath 1.0 multiple Text nodes can indeed be returned, even if they are siblings. The DOM is not the XML InfoSet. (As is the case in WebKit and Gecko today.)
* Make it clear that contrary to XPath 1.0 the root of the tree is the Document (and not the root element). This means you can return the parent of the root element (can you get all types of siblings? comments, PIs, doctypes? probably, but untested).
* Simplifications: http://lists.w3.org/Archives/Public/public-webapps/2011AprJun/0310.html
* Simplifications: http://lists.w3.org/Archives/Public/public-webapps/2011AprJun/0310.html
* Exceptions: https://bugzilla.mozilla.org/show_bug.cgi?id=743888
* Exceptions: https://bugzilla.mozilla.org/show_bug.cgi?id=743888


== WebIDL interfaces ==
== WebIDL interfaces ==
<pre>
<pre class="idl">
[Exposed=Window]
interface XPathResult {
interface XPathResult {
   const unsigned short      ANY_TYPE                      = 0;
   const unsigned short      ANY_TYPE                      = 0;
Line 32: Line 34:
};
};


[Exposed=Window]
interface XPathExpression {
interface XPathExpression {
   XPathResult evaluate(Node contextNode,
   XPathResult evaluate(Node contextNode,
Line 38: Line 41:
};
};


callback interface XPathNSResolver
callback interface XPathNSResolver {
{
   DOMString? lookupNamespaceURI(DOMString? prefix);
   DOMString? lookupNamespaceURI(DOMString? prefix);
};
};


[Constructor]
interface mixin XPathEvaluatorBase {
interface XPathEvaluator {
   XPathExpression    createExpression(DOMString expression,  
   XPathExpression    createExpression(DOMString expression,  
                                       optional XPathNSResolver? resolver);
                                       optional XPathNSResolver? resolver);
Line 54: Line 55:
                               optional object? result);
                               optional object? result);
};
};
Document implements XPathEvaluator;
 
[Exposed=Window, Constructor]
interface XPathEvaluator {};
 
XPathEvaluator includes XPathEvaluatorBase;
Document includes XPathEvaluatorBase;
</pre>
</pre>



Revision as of 16:15, 1 February 2019

If someone ever decides to write down DOM XPath (i.e. a proper version of the DOM3XPath note), take this into account:

WebIDL interfaces

[Exposed=Window]
interface XPathResult {
  const unsigned short      ANY_TYPE                       = 0;
  const unsigned short      NUMBER_TYPE                    = 1;
  const unsigned short      STRING_TYPE                    = 2;
  const unsigned short      BOOLEAN_TYPE                   = 3;
  const unsigned short      UNORDERED_NODE_ITERATOR_TYPE   = 4;
  const unsigned short      ORDERED_NODE_ITERATOR_TYPE     = 5;
  const unsigned short      UNORDERED_NODE_SNAPSHOT_TYPE   = 6;
  const unsigned short      ORDERED_NODE_SNAPSHOT_TYPE     = 7;
  const unsigned short      ANY_UNORDERED_NODE_TYPE        = 8;
  const unsigned short      FIRST_ORDERED_NODE_TYPE        = 9;

  readonly attribute unsigned short resultType;
  readonly attribute unrestricted double numberValue;
  // Maybe "DOMString?".
  readonly attribute DOMString stringValue;
  readonly attribute boolean booleanValue;
  readonly attribute Node singleNodeValue;
  readonly attribute boolean          invalidIteratorState;
  readonly attribute unsigned long    snapshotLength;
  Node?               iterateNext();
  Node?               snapshotItem(unsigned long index);
};

[Exposed=Window]
interface XPathExpression {
  XPathResult evaluate(Node contextNode,
                       optional unsigned short type,
                       optional object? result);
};

callback interface XPathNSResolver {
  DOMString? lookupNamespaceURI(DOMString? prefix);
};

interface mixin XPathEvaluatorBase {
  XPathExpression    createExpression(DOMString expression, 
                                      optional XPathNSResolver? resolver);
  XPathNSResolver    createNSResolver(Node nodeResolver);
  XPathResult        evaluate(DOMString expression, 
                              Node contextNode, 
                              optional XPathNSResolver? resolver, 
                              optional unsigned short type, 
                              optional object? result);
};

[Exposed=Window, Constructor]
interface XPathEvaluator {};

XPathEvaluator includes XPathEvaluatorBase;
Document includes XPathEvaluatorBase;

Indeed, you can both construct this object and access its methods on Document. Isn't the world wonderful?