Lots of minor xpath futzing

hildjj · May 8, 2023 · f170c10 · f170c10
1 parent fe18938
commit f170c10
Show file tree

Hide file tree

Showing 51 changed files with 714 additions and 331 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ console.log(doc.root.toString())
 console.log(doc.get('//bar'))
 ```
 
-Note that there is an implementation of XPath3 included.  It is not
+Note that there is an implementation of XPath3 included.  It is not in any way
 feature-complete yet, but it has a bunch of useful features already.
 
 Full [documentation](https://hildjj.github.io/expat-wasm-dom/) is available.

diff --git a/cli/bin/ewq.js b/cli/bin/ewq.js
@@ -2,6 +2,7 @@
 
 /* eslint-disable no-console */
 import {Command} from 'commander'
+import {dom} from 'expat-wasm-dom'
 import {parse} from '../lib/entity.js'
 import {sharedOptions} from '../lib/shared.js'
 
@@ -21,7 +22,11 @@ async function main() {
     const doc = await parse(arg, opts)
     const res = doc.get(xpath)
     for (const r of res) {
-      console.log(r.toString({colors: process.stdout.isTTY, depth: Infinity}))
+      if (r instanceof dom.Node) {
+        console.log(r.toString({colors: process.stdout.isTTY, depth: Infinity}))
+      } else {
+        console.log(r)
+      }
     }
   }
 }

diff --git a/docs/AttlistDecl.html b/docs/AttlistDecl.html
diff --git a/docs/Attribute.html b/docs/Attribute.html
diff --git a/docs/AttributeDecl.html b/docs/AttributeDecl.html
diff --git a/docs/CdataSection.html b/docs/CdataSection.html
diff --git a/docs/Comment.html b/docs/Comment.html
diff --git a/docs/DoctypeDecl.html b/docs/DoctypeDecl.html
diff --git a/docs/Document.html b/docs/Document.html
diff --git a/docs/DomParser.html b/docs/DomParser.html
diff --git a/docs/Element.html b/docs/Element.html
diff --git a/docs/ElementDecl.html b/docs/ElementDecl.html
diff --git a/docs/EntityDecl.html b/docs/EntityDecl.html
diff --git a/docs/Namespace.html b/docs/Namespace.html
diff --git a/docs/Namespace_Namespace.html b/docs/Namespace_Namespace.html
diff --git a/docs/Node.html b/docs/Node.html
diff --git a/docs/NotationDecl.html b/docs/NotationDecl.html
diff --git a/docs/ParentNode.html b/docs/ParentNode.html
diff --git a/docs/ProcessingInstruction.html b/docs/ProcessingInstruction.html
diff --git a/docs/Text.html b/docs/Text.html
diff --git a/docs/XPath.html b/docs/XPath.html
diff --git a/docs/XPathSyntaxError.html b/docs/XPathSyntaxError.html
diff --git a/docs/XmlDeclaration.html b/docs/XmlDeclaration.html
diff --git a/docs/dom.js.html b/docs/dom.js.html
diff --git a/docs/domParser.js.html b/docs/domParser.js.html
diff --git a/docs/external-ConstructorParameters.html b/docs/external-ConstructorParameters.html
diff --git a/docs/external-Exclude.html b/docs/external-Exclude.html
diff --git a/docs/external-Extract.html b/docs/external-Extract.html
diff --git a/docs/external-InstanceType.html b/docs/external-InstanceType.html
diff --git a/docs/external-NonNullable.html b/docs/external-NonNullable.html
diff --git a/docs/external-Omit.html b/docs/external-Omit.html
diff --git a/docs/external-OmitThisParameter.html b/docs/external-OmitThisParameter.html
diff --git a/docs/external-Parameters.html b/docs/external-Parameters.html
diff --git a/docs/external-Partial.html b/docs/external-Partial.html
diff --git a/docs/external-Pick.html b/docs/external-Pick.html
diff --git a/docs/external-Readonly.html b/docs/external-Readonly.html
diff --git a/docs/external-Record.html b/docs/external-Record.html
diff --git a/docs/external-Required.html b/docs/external-Required.html
diff --git a/docs/external-ReturnType.html b/docs/external-ReturnType.html
diff --git a/docs/external-ThisParameterType.html b/docs/external-ThisParameterType.html
diff --git a/docs/external-ThisType.html b/docs/external-ThisType.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/xpath.js.html b/docs/xpath.js.html
diff --git a/lib/dom.js b/lib/dom.js
@@ -169,7 +169,7 @@ export class Node {
    * @param {string|XPath} pattern The pattern to match
    * @param {Node} [context=this] The context node.  Uses this node as context
    *   if none is provided.
-   * @returns {string|Node|null} The first match if one exists
+   * @returns {string|Node|number|null} The first match if one exists
    */
   first(pattern, context) {
     const res = this.get(pattern, context)
@@ -416,7 +416,7 @@ export class Document extends ParentNode {
    * @param {string|XPath} pattern The pattern to match
    * @param {Node} [context=this.root] The context node.  Uses the root element
    *   as context if none is provided.
-   * @returns {string|Node|null} The first match if one exists
+   * @returns {string|number|Node|null} The first match if one exists
    */
   first(pattern, context) {
     return super.first(pattern, context || this.root || undefined)

diff --git a/lib/xpath.js b/lib/xpath.js
@@ -44,9 +44,24 @@ export class XPathSyntaxError extends Error {
 }
 
 /**
- * @typedef {Array<string|dom.Node>} XPathResult
+ * @typedef {Array<string|number|dom.Node>} XPathResult
  */
 
+/**
+ * @callback XPathFun
+ * @param {...XPathResult} params
+ * @return {XPathResult}
+ */
+
+/**
+ * @type {Record<string,XPathFun>}
+ */
+const XPathFunctions = {
+  count(context) {
+    return [context.length]
+  },
+}
+
 /**
  * An XPath expression for querying an XML document
  */
@@ -177,12 +192,11 @@ export class XPath {
    */
   // eslint-disable-next-line class-methods-use-this
   _nameTestWildcard(num, context, star) {
-    /* c8 ignore next */
     if (star !== '*') {
       throw new Error(`Unimplemented wildcard: "${star}"`)
     }
     if (Array.isArray(context)) {
-      return context
+      return context.filter(e => e instanceof dom.Element)
     } else if (context instanceof dom.Attribute) {
       return [context]
     } else if (context instanceof dom.Element) {
@@ -355,7 +369,7 @@ export class XPath {
    *
    * @param {dom.Node} context
    * @param {Functor} expr
-   * @returns {string|dom.Node|undefined}
+   * @returns {string|number|dom.Node|undefined}
    * @private
    */
   _expr(context, expr) {
@@ -439,9 +453,7 @@ export class XPath {
    */
   // eslint-disable-next-line class-methods-use-this
   _comment(num, context) {
-    if (context instanceof dom.Comment) {
-      return [context]
-    } else if (Array.isArray(context)) {
+    if (Array.isArray(context)) {
       return context.filter(n => n instanceof dom.Comment)
     } else if (context instanceof dom.ParentNode) {
       return context.children.filter(n => n instanceof dom.Comment)
@@ -465,6 +477,29 @@ export class XPath {
     )
   }
 
+  /**
+   * Execute functions.
+   *
+   * @param {number} num
+   * @param {dom.Node} context
+   * @param {string} fn
+   * @param {Functor[]} params
+   * @returns {XPathResult}
+   * @private
+   */
+  _fn(num, context, fn, params) {
+    const fun = XPathFunctions[fn]
+    if (typeof fun !== 'function') {
+      throw new Error(`Unimplemented function: "${fn}"`)
+    }
+
+    const eparams = params.map(
+      v => this._eval([context], v)
+    )
+
+    return fun.apply(this, eparams)
+  }
+
   /**
    * Some operation that hasn't been implemented yet.
    *

diff --git a/lib/xpathPattern3.js b/lib/xpathPattern3.js