oilleelssq-wq/moonxslt/xpath

README
V
parse_xml
V
select
V
select_string
V
transform

oilleelssq-wq/moonxslt/xpath does not have a README file

EvaluationError

pub suberror EvaluationError {
  Message(String)
}

A dynamic evaluation error, such as a variable that has no binding.

ParseError

source

pub suberror ParseError {
  Syntax(String, Int)
}

Internal parse failure.

ArithmeticOp

source

pub(all) enum ArithmeticOp {
  Add
  Subtract
  Multiply
  Divide
  Modulo
}

Arithmetic operators.

Axis

source

pub(all) enum Axis {
  Ancestor
  AncestorOrSelf
  Attribute
  Child
  Descendant
  DescendantOrSelf
  Following
  FollowingSibling
  Namespace
  Parent
  Preceding
  PrecedingSibling
  Self
}

The thirteen XPath axes.

ComparisonOp

source

pub(all) enum ComparisonOp {
  Equal
  NotEqual
  Less
  LessOrEqual
  Greater
  GreaterOrEqual
}

Relational and equality operators.

EvalContext

source

pub struct EvalContext {
  doc : @oilleelssq-wq/moonxslt/xml.Document
Document
  node : Int
  position : Int
  size : Int
  variables : Array[(String, Value)]
  namespaces : Array[(String, String)]
  user_functions : Array[(String, (Array[Expr], EvalContext) -> Value raise EvaluationError)]
}

The evaluation context: a context node, its position and size, the variable bindings and the namespace declarations of the stylesheet.

EvalContext::document

source

fn EvalContext::document(self : EvalContext) -> @oilleelssq-wq/moonxslt/xml.Document
Document

The document the context evaluates against.

EvalContext::new

source

fn EvalContext::new(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int) -> EvalContext

Create a context for a single node.

EvalContext::with_function

source

fn EvalContext::with_function(self : EvalContext, name : String, function : (Array[Expr], EvalContext) -> Value raise EvaluationError) -> EvalContext

Return a copy of the context with an extra function implementation.

EvalContext::with_namespaces

source

fn EvalContext::with_namespaces(self : EvalContext, namespaces : Array[(String, String)]) -> EvalContext

Return a copy of the context with the given stylesheet namespace bindings.

EvalContext::with_node

source

fn EvalContext::with_node(self : EvalContext, node : Int) -> EvalContext

Return a copy of the context focused on another node.

EvalContext::with_position

source

fn EvalContext::with_position(self : EvalContext, position : Int, size : Int) -> EvalContext

Return a copy of the context with the given proximity position and size.

EvalContext::with_variables

source

fn EvalContext::with_variables(self : EvalContext, variables : Array[(String, Value)]) -> EvalContext

Return a copy of the context with the given variable bindings.

Expr

source

pub(all) enum Expr {
  LocationPath(Bool, Array[Step])
  Filter(Expr, Array[Expr])
  Path(Expr, Array[Step])
  Union(Expr, Expr)
  Or(Expr, Expr)
  And(Expr, Expr)
  Comparison(ComparisonOp, Expr, Expr)
  Arithmetic(ArithmeticOp, Expr, Expr)
  Negate(Expr)
  NumberLiteral(Double)
  StringLiteral(String)
  VariableReference(String)
  FunctionCall(String, Array[Expr])
}

An XPath expression.

NodeSet

source

pub struct NodeSet {
  nodes : Array[Int]
}

An unordered set of nodes, held in document order.

Nodes are identified by their id in the arena; the document is supplied by the evaluation context so that node-sets do not need to carry it around.

NodeSet::contains

source

fn NodeSet::contains(self : NodeSet, id : Int) -> Bool

Whether a node belongs to the set.

NodeSet::empty

source

fn NodeSet::empty() -> NodeSet

The empty node-set.

NodeSet::first

source

fn NodeSet::first(self : NodeSet) -> Int?

The first node in document order, if any.

NodeSet::is_empty

source

fn NodeSet::is_empty(self : NodeSet) -> Bool

Whether the set is empty.

NodeSet::length

source

fn NodeSet::length(self : NodeSet) -> Int

Number of nodes in the set.

NodeSet::new

source

fn NodeSet::new(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, ids : Array[Int]) -> NodeSet

Create a node-set from arbitrary ids, sorting them into document order and removing duplicates.

NodeSet::nodes

source

fn NodeSet::nodes(self : NodeSet) -> ArrayView[Int]

The nodes, in document order.

NodeSet::union

source

fn NodeSet::union(self : NodeSet, doc : @oilleelssq-wq/moonxslt/xml.Document
Document, other : NodeSet) -> NodeSet

Union of two node-sets.

NodeTest

source

pub(all) enum NodeTest {
  NameTest(String, String)
  TextTest
  CommentTest
  AnyNodeTest
  ProcessingInstructionTest(String?)
}

A node test, which filters the nodes selected by an axis.

ParseErrorInfo

source

pub(all) struct ParseErrorInfo {
  message : String
  position : Int
}

A syntax error with the offset in the source expression.

Step

source

pub(all) enum Step {
  AxisStep(Axis, NodeTest, Array[Expr])
  SelfStep
  ParentStep
}

One step of a location path.

Token

source

pub struct Token {
  kind : TokenKind
  text : String
  position : Int
}

A token together with its source offset.

Token::describe

source

fn Token::describe(self : Token) -> String

Human-readable description used in parse errors.

TokenKind

source

pub(all) enum TokenKind {
  Name
  Number
  Literal
  Slash
  DoubleSlash
  Dot
  DotDot
  At
  LeftParen
  RightParen
  LeftBracket
  RightBracket
  Comma
  ColonColon
  Pipe
  Plus
  Minus
  Star
  Equal
  NotEqual
  Less
  LessOrEqual
  Greater
  GreaterOrEqual
  Dollar
  Eof
}

The lexical categories of XPath 1.0.

Operators that are spelled as names (and, or, div, mod) are lexed as Name and recognised by the parser, as required by the grammar.

Value

source

pub(all) enum Value {
  Nodes(NodeSet)
  Boolean(Bool)
  Number(Double)
  String(String)
}

The four XPath value types.

Value::boolean_value

source

fn Value::boolean_value(self : Value) -> Bool

XPath boolean conversion.

Value::node_set

source

fn Value::node_set(self : Value) -> NodeSet?

The node-set behind a value, if the value is a node-set.

Value::number_value

source

fn Value::number_value(self : Value, doc : @oilleelssq-wq/moonxslt/xml.Document
Document) -> Double

XPath number conversion.

Value::of_boolean

source

fn Value::of_boolean(flag : Bool) -> Value

Wrap a boolean as an XPath value.

Value::of_nodes

source

fn Value::of_nodes(set : NodeSet) -> Value

Wrap a node-set as an XPath value.

Value::of_number

source

fn Value::of_number(number : Double) -> Value

Wrap a number as an XPath value.

Value::of_string

source

fn Value::of_string(text : String) -> Value

Wrap a string as an XPath value.

Value::string_value

source

fn Value::string_value(self : Value, doc : @oilleelssq-wq/moonxslt/xml.Document
Document) -> String

XPath string conversion.

boolean_of

source

fn boolean_of(context : EvalContext, expression : Expr) -> Result[Bool, String]

The XPath boolean conversion of an already parsed expression.

evaluate

source

fn evaluate(expression : Expr, context : EvalContext) -> Value raise EvaluationError

Evaluate an expression against a context.

evaluate_path

source

fn evaluate_path(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, path : String) -> Result[Value, String]

Parse and evaluate an expression, returning the raw value.

evaluate_with

source

fn evaluate_with(context : EvalContext, expression : Expr) -> Result[Value, String]

Evaluate an expression against a context, returning the raw value.

format_number

source

fn format_number(value : Double) -> String

Format a number the way XPath's string() does.

Whole numbers are printed without a fractional part and infinities and NaN use their XPath spellings.

matches_node_test

source

fn matches_node_test(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, axis : Axis, node_test : NodeTest, namespaces : Array[(String, String)]) -> Bool

Whether a node matches a node node_test on a given axis.

The namespace declarations of the stylesheet are passed in so that prefixed name tests compare expanded names; when the list is empty, prefixes are compared literally, which keeps the function usable without a stylesheet.

nan

source

fn nan() -> Double

The IEEE NaN value, which XPath uses for numbers that cannot be represented.

number_of

source

fn number_of(context : EvalContext, expression : Expr) -> Result[Double, String]

The XPath number conversion of an already parsed expression.

of_boolean

source

fn of_boolean(value : Bool) -> Value

Wrap a boolean as an XPath value.

of_number

source

fn of_number(value : Double) -> Value

Wrap a number as an XPath value.

of_string

source

fn of_string(value : String) -> Value

Wrap a string as an XPath value.

parse

source

fn parse(text : String) -> Result[Expr, ParseErrorInfo]

Parse an XPath expression.

parse_expression

source

fn parse_expression(text : String) -> Expr raise ParseError

Parse an XPath expression, raising ParseError on invalid syntax.

parse_number

source

fn parse_number(text : String) -> Double

Parse an XPath number: optional surrounding whitespace, an optional minus sign, digits with an optional fractional part. Anything else is NaN.

raise_function_error

source

fn[T] raise_function_error(message : String) -> T raise EvaluationError

Raise a dynamic evaluation error with the given message.

select

source

fn select(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, path : String) -> Result[NodeSet, String]

Select the nodes matched by an expression.

select_boolean

source

fn select_boolean(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, path : String) -> Result[Bool, String]

The XPath boolean() of an expression result.

select_nodes

source

fn select_nodes(context : EvalContext, expression : Expr) -> Result[NodeSet, String]

Select the nodes matched by an already parsed expression.

select_number

source

fn select_number(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, path : String) -> Result[Double, String]

The XPath number() of an expression result.

select_string

source

fn select_string(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, node : Int, path : String) -> Result[String, String]

The XPath string() of an expression result.

string_of

source

fn string_of(context : EvalContext, expression : Expr) -> Result[String, String]

The XPath string() of an already parsed expression.

string_of_node

source

fn string_of_node(doc : @oilleelssq-wq/moonxslt/xml.Document
Document, id : Int) -> String

The string-value of a single node.

Elements and the document node yield the concatenation of their descendant text, attributes and text nodes yield their character data, and comments and processing instructions yield their content.

tokenize

source

fn tokenize(text : String) -> Array[Token]

Split an XPath expression into tokens.

Source Files

Install

Download zip

A pure MoonBit XSLT 1.0 processor with its own XML parser and XPath 1.0 engine.

xsltxpathxmltransformstylesheet

oilleelssq-wq

Apache-2.0

github.com/oilleelssq-wq/moonxslt

Updated 43 minutes ago

2 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#EvaluationError

#ParseError

#ArithmeticOp

#Axis

#ComparisonOp

#EvalContext

#EvalContext::document

#EvalContext::new

#EvalContext::with_function

#EvalContext::with_namespaces

#EvalContext::with_node

#EvalContext::with_position

#EvalContext::with_variables

#Expr

#NodeSet

#NodeSet::contains

#NodeSet::empty

#NodeSet::first

#NodeSet::is_empty

#NodeSet::length

#NodeSet::new

#NodeSet::nodes

#NodeSet::union

#NodeTest

#ParseErrorInfo

#Step

#Token

#Token::describe

#TokenKind

#Value

#Value::boolean_value

#Value::node_set

#Value::number_value

#Value::of_boolean

#Value::of_nodes

#Value::of_number

#Value::of_string

#Value::string_value

#boolean_of

#evaluate

#evaluate_path

#evaluate_with

#format_number

#matches_node_test

#nan

#number_of

#of_boolean

#of_number

#of_string

#parse

#parse_expression

#parse_number

#raise_function_error

#select

#select_boolean

#select_nodes

#select_number

#select_string

#string_of

#string_of_node

#tokenize

Source Files

EvaluationError

ParseError

ArithmeticOp

Axis

ComparisonOp

EvalContext

EvalContext::document

EvalContext::new

EvalContext::with_function

EvalContext::with_namespaces

EvalContext::with_node

EvalContext::with_position

EvalContext::with_variables

Expr

NodeSet

NodeSet::contains

NodeSet::empty

NodeSet::first

NodeSet::is_empty

NodeSet::length

NodeSet::new

NodeSet::nodes

NodeSet::union

NodeTest

ParseErrorInfo

Step

Token

Token::describe

TokenKind

Value

Value::boolean_value

Value::node_set

Value::number_value

Value::of_boolean

Value::of_nodes

Value::of_number

Value::of_string

Value::string_value

boolean_of

evaluate

evaluate_path

evaluate_with

format_number

matches_node_test

nan

number_of

of_boolean

of_number

of_string

parse

parse_expression

parse_number

raise_function_error

select

select_boolean

select_nodes

select_number

select_string

string_of

string_of_node

tokenize