ddn.data.xml.xpath

XPath engine (phased): core data model.

This module provides the XPath 1.0 value types and conversion rules.

It is intentionally separate from the legacy/minimal ddn.data.xml.query module.

enum XPathAxis XPathBinaryOp XPathNodeTestKind XPathValueKind

struct XPathExpression XPathParser XPathStep XPathValue

class XPathBinaryExpr XPathFunctionCallExpr XPathLiteralExpr XPathMapNamespaceResolver XPathPathExpr XPathUnaryMinusExpr

iface IXPathExpr XPathNamespaceResolver

fn appendAxisResults appendDescendantsOrSelf applyPredicates axisFromName childIndex collectDescendantText collectDocumentOrder compareDocumentOrder compareValues consumeCall dedupeInDocumentOrder dedupeInOrder evaluateFunctionExpr evaluatePredicate evaluateXPath indexOfNode isAncestorOf isNameChar isNameStartChar matchesTest matchKeyword nodesetStringValue nodeStringValue objectIdentityKey parseInto parseXPathNumber readNameToken rootOf skipWs splitQName

Types 16

enumXPathValueKind

XPath value kind.

NODESETNode-set value.

STRINGString value.

NUMBERNumber value (IEEE double).

BOOLEANBoolean value.

enumXPathAxis

XPath axis.

CHILD`child::` axis.

DESCENDANT_OR_SELF`descendant-or-self::` axis (`//`).

PARENT`parent::` axis (`..`).

SELF`self::` axis (`.`).

ATTRIBUTE`attribute::` axis (`@`).

ANCESTOR`ancestor::` axis.

ANCESTOR_OR_SELF`ancestor-or-self::` axis.

FOLLOWING_SIBLING`following-sibling::` axis.

PRECEDING_SIBLING`preceding-sibling::` axis.

FOLLOWING`following::` axis.

PRECEDING`preceding::` axis.

enumXPathNodeTestKind

XPath node test kind.

NAMEMatch by name.

ANY`*` wildcard.

NODE`node()`

TEXT`text()`

private interfaceIXPathExpr

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

private classXPathLiteralExpr : IXPathExpr

Fields

private XPathValue _val

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

Constructors

this(XPathValue val)

private classXPathPathExpr : IXPathExpr

Fields

private XPathExpression _path

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

Constructors

this(XPathExpression path)

private classXPathUnaryMinusExpr : IXPathExpr

Fields

private IXPathExpr _expr

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

Constructors

this(IXPathExpr expr)

private enumXPathBinaryOp

AND

NEQ

LTE

GTE

PLUS

MINUS

MUL

DIV

MOD

UNION

private classXPathBinaryExpr : IXPathExpr

Fields

private IXPathExpr _left

private XPathBinaryOp _op

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

Constructors

this(IXPathExpr left, IXPathExpr right, XPathBinaryOp op)

private classXPathFunctionCallExpr : IXPathExpr

Fields

private string _name

private IXPathExpr[] _args

Methods

XPathValue evaluate(XmlNode context, XPathNamespaceResolver resolver, size_t position, size_t last) @safe

Constructors

this(string name, IXPathExpr[] args)

structXPathStep

A single path step.

Fields

XPathAxis axis

XPathNodeTestKind testKind

string name

IXPathExpr[] predicates

structXPathExpression

A parsed XPath expression (subset).

Fields

string expressionOriginal expression string.

bool absoluteIf `true`, expression is absolute (starts with `/` or `//`).

private XPathStep[] _steps

Methods

XPathExpression parse(string expression) @safeParses an XPath expression.

XmlNode[] select(XmlNode context, XPathNamespaceResolver resolver = null) @safeSelects nodes under `context`.

XmlNode[] evaluatePath(XmlNode context, XPathNamespaceResolver resolver) @safe

private structXPathParser

Fields

string s

size_t i

Methods

IXPathExpr parseExpr() @safe

private IXPathExpr parseOrExpr() @safe

private IXPathExpr parseAndExpr() @safe

private IXPathExpr parseEqualityExpr() @safe

private IXPathExpr parseRelationalExpr() @safe

private IXPathExpr parseAdditiveExpr() @safe

private IXPathExpr parseMultiplicativeExpr() @safe

private IXPathExpr parseUnaryExpr() @safe

private IXPathExpr parseUnionExpr() @safe

private IXPathExpr parsePathExpr() @safe

private IXPathExpr parsePrimaryExpr() @safe

private bool match(string op) @safe

private bool matchKeyword(string kw) @safe

private bool isNodeTest(string name) @safe pure nothrow

interfaceXPathNamespaceResolver

Namespace resolver for XPath evaluation.

Implementations map an XPath prefix to a namespace URI.

Methods

string lookupNamespaceUri(string prefix) @safe nothrow;Looks up a namespace URI for `prefix`.

classXPathMapNamespaceResolver : XPathNamespaceResolver

Simple map-backed namespace resolver.

Fields

private string[string] _map

Methods

string lookupNamespaceUri(string prefix) @safe nothrow

Constructors

this(string[string] mappings)Constructs the resolver.

structXPathValue

An XPath value (node-set, string, number, or boolean).

Fields

XPathValueKind kindValue kind discriminator.

private XmlNode[] _nodes

private string _string

private double _number

private bool _bool

Methods

XPathValue nodeset(XmlNode[] nodes) @safeCreates a node-set value.

XPathValue string_(string value) @safeCreates a string value.

XPathValue number(double value) @safeCreates a number value.

XPathValue boolean(bool value) @safeCreates a boolean value.

XmlNode[] toNodeSet() @safeReturns the value as a node-set.

bool toBoolean() const @safe nothrowConverts the value to a boolean using XPath 1.0 rules.

string toString() const @safeConverts the value to a string using XPath 1.0 rules.

double toNumber() const @safeConverts the value to a number using XPath 1.0 rules.

Functions 30

private fnXPathAxis axisFromName(string axisName) @safe

private fnbool isNameStartChar(char c) @safe pure nothrow

private fnbool isNameChar(char c) @safe pure nothrow

private fnbool compareValues(XPathValue l, XPathValue r, XPathBinaryOp op) @safe

fnXPathValue evaluateXPath(string expression, XmlNode context, XPathNamespaceResolver resolver = null) @safeEvaluates an XPath expression as an `XPathValue`.

private fnbool matchKeyword(string s, ref size_t i, string kw) @safe

private fnvoid parseInto(ref XPathExpression x, string s, ref size_t i) @safe

private fnvoid skipWs(string s, ref size_t i) @safe pure nothrow

private fnbool consumeCall(string s, ref size_t i) @safe pure nothrow

private fnstring readNameToken(string s, ref size_t i) @safe

private fnXmlNode rootOf(XmlNode n) @safe nothrow

private fnvoid collectDocumentOrder(ref XmlNode[] sink, XmlNode node) @safe

private fnbool isAncestorOf(XmlNode ancestor, XmlNode node) @safe nothrow

private fnsize_t indexOfNode(const(XmlNode)[] nodes, XmlNode target) @safe nothrow

private fn

void appendAxisResults(
       ref  XmlNode[]  sink,
       XmlNode node,
       const  ref  XPathStep step,
       XPathNamespaceResolver resolver)

@safe

private fn

void appendDescendantsOrSelf(
       ref  XmlNode[]  sink,
       XmlNode node,
       const  ref  XPathStep step,
       XPathNamespaceResolver resolver)

@safe

private fnbool matchesTest(XmlNode node, const ref XPathStep step, XPathNamespaceResolver resolver) @safe

private fnvoid splitQName(string qname, out string prefix, out string local) @safe nothrow

private fnXmlNode[] applyPredicates(XmlNode[] nodes, IXPathExpr[] preds, XPathNamespaceResolver resolver) @safe

private fnbool evaluatePredicate(IXPathExpr pred, XmlNode node, size_t position, size_t last, XPathNamespaceResolver resolver) @safe

private fn

XPathValue evaluateFunctionExpr(
       string name,
       IXPathExpr[]  args,
       XmlNode context,
       XPathNamespaceResolver resolver,
       size_t position,
       size_t last)

@safe

private fnXmlNode[] dedupeInOrder(XmlNode[] nodes) @safe

private fnXmlNode[] dedupeInDocumentOrder(XmlNode[] nodes) @safe

private fnint compareDocumentOrder(XmlNode a, XmlNode b) @safe nothrow

private fnsize_t childIndex(const(XmlParentNode) p, const(XmlNode) child) @safe nothrow

private fnconst(void) * objectIdentityKey(Object o) @trusted nothrow

private fnstring nodesetStringValue(const(XmlNode)[] nodes) @safe

private fnstring nodeStringValue(const(XmlNode) node) @safe

private fnvoid collectDescendantText(ref typeof(appender!string()) sink, const(XmlParentNode) n) @safe

private fndouble parseXPathNumber(string s) @safe nothrow