Packages

package ast

Abstract syntax tree of XPath expressions, as produced by the parsers specified in the 'parse' package.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ast
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait AbbrevForwardStep extends ForwardStep
  2. sealed trait AdditionOp extends XPathElem with LeafElem
  3. final case class AdditiveExpr (firstExpr: MultiplicativeExpr, operatorExprPairs: IndexedSeq[(AdditionOp, MultiplicativeExpr)]) extends XPathElem with Product with Serializable
  4. final case class AndExpr (comparisonExprs: IndexedSeq[ComparisonExpr]) extends XPathElem with Product with Serializable
  5. sealed trait Argument extends XPathElem
  6. final case class ArgumentList (arguments: IndexedSeq[Argument]) extends PredicateOrArgumentList with Product with Serializable
  7. final case class AtomicOrUnionType (tpe: EQName) extends ItemType with LeafElem with Product with Serializable
  8. final case class AttributeAxisAbbrevForwardStep (nodeTest: NodeTest) extends AbbrevForwardStep with Product with Serializable
  9. final case class AttributeNameAndTypeTest (name: EQName, tpe: EQName) extends AttributeTest with LeafElem with Product with Serializable
  10. final case class AttributeNameTest (name: EQName) extends AttributeTest with LeafElem with Product with Serializable
  11. sealed trait AttributeTest extends KindTest
  12. final case class AttributeTypeTest (tpe: EQName) extends AttributeTest with LeafElem with Product with Serializable
  13. sealed trait AxisStep extends StepExpr
  14. final case class BracedUriLiteral (namespaceOption: Option[String]) extends Product with Serializable

    Braced URI literal.

  15. final case class CastExpr (unaryExpr: UnaryExpr, singleTypeOption: Option[SingleType]) extends XPathElem with Product with Serializable
  16. final case class CastableExpr (castExpr: CastExpr, singleTypeOption: Option[SingleType]) extends XPathElem with Product with Serializable
  17. sealed trait Comp extends XPathElem with LeafElem
  18. sealed trait ComparisonExpr extends XPathElem
  19. final case class CompoundComparisonExpr (stringConcatExpr1: StringConcatExpr, comp: Comp, stringConcatExpr2: StringConcatExpr) extends ComparisonExpr with Product with Serializable
  20. final case class CompoundRangeExpr (additiveExpr1: AdditiveExpr, additiveExpr2: AdditiveExpr) extends RangeExpr with Product with Serializable
  21. final case class DataPITest (data: StringLiteral) extends PITest with Product with Serializable
  22. final case class DecimalLiteral (value: BigDecimal) extends NumericLiteral with LeafElem with Product with Serializable
  23. sealed trait DocumentTest extends KindTest
  24. final case class DocumentTestContainingElementTest (elementTest: ElementTest) extends DocumentTest with Product with Serializable
  25. final case class DocumentTestContainingSchemaElementTest (schemaElementTest: SchemaElementTest) extends DocumentTest with Product with Serializable
  26. final case class DoubleLiteral (value: Double) extends NumericLiteral with LeafElem with Product with Serializable
  27. sealed trait EQName extends AnyRef

    EQName, so either a URIQualifiedName or a QName.

  28. final case class ElementNameAndTypeTest (name: EQName, tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
  29. final case class ElementNameTest (name: EQName) extends ElementTest with LeafElem with Product with Serializable
  30. sealed trait ElementTest extends KindTest
  31. final case class ElementTypeTest (tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
  32. final case class EnclosedExpr (expr: Expr) extends XPathElem with Product with Serializable
  33. final case class ExactlyOneSequenceType (itemType: ItemType) extends SequenceType with Product with Serializable
  34. final case class Expr (exprSingleSeq: IndexedSeq[ExprSingle]) extends XPathElem with Product with Serializable
  35. sealed trait ExprSingle extends XPathElem
  36. final case class ExprSingleArgument (exprSingle: ExprSingle) extends Argument with Product with Serializable
  37. final case class ForExpr (simpleForBindings: IndexedSeq[SimpleForBinding], returnExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
  38. sealed trait ForwardAxis extends XPathElem with LeafElem
  39. final case class ForwardAxisStep (step: ForwardStep, predicateList: IndexedSeq[Predicate]) extends AxisStep with Product with Serializable
  40. sealed trait ForwardStep extends XPathElem
  41. final case class FunctionCall (functionName: EQName, argumentList: ArgumentList) extends PrimaryExpr with Product with Serializable
  42. sealed trait FunctionItemExpr extends PrimaryExpr
  43. sealed trait FunctionTest extends ItemType
  44. sealed trait GeneralComp extends Comp
  45. final case class IfExpr (condition: Expr, thenExpr: ExprSingle, elseExpr: ExprSingle) extends ExprSingle with Product with Serializable
  46. final case class InlineFunctionExpr (paramListOption: Option[ParamList], resultTypeOption: Option[SequenceType], body: EnclosedExpr) extends FunctionItemExpr with Product with Serializable
  47. final case class InstanceOfExpr (treatExpr: TreatExpr, sequenceTypeOption: Option[SequenceType]) extends XPathElem with Product with Serializable
  48. final case class IntegerLiteral (value: BigInt) extends NumericLiteral with LeafElem with Product with Serializable
  49. final case class IntersectExceptExpr (firstExpr: InstanceOfExpr, operatorExprPairs: IndexedSeq[(IntersectExceptOp, InstanceOfExpr)]) extends XPathElem with Product with Serializable
  50. sealed trait IntersectExceptOp extends XPathElem with LeafElem
  51. sealed trait ItemType extends XPathElem
  52. sealed trait KindTest extends NodeTest
  53. final case class KindTestItemType (kindTest: KindTest) extends ItemType with Product with Serializable
  54. sealed trait LeafElem extends XPathElem
  55. final case class LetExpr (simpleLetBindings: IndexedSeq[SimpleLetBinding], returnExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
  56. sealed trait Literal extends PrimaryExpr
  57. final case class LocalNameWildcard (localName: NCName) extends Wildcard with LeafElem with Product with Serializable
  58. final case class MultiplicativeExpr (firstExpr: UnionExpr, operatorExprPairs: IndexedSeq[(MultiplicativeOp, UnionExpr)]) extends XPathElem with Product with Serializable
  59. sealed trait MultiplicativeOp extends XPathElem with LeafElem
  60. final case class NCName (name: String) extends Product with Serializable

    NCName, that is, a non-colon name.

  61. sealed trait NameTest extends NodeTest
  62. final case class NamedFunctionRef (functionName: EQName, arity: BigInt) extends FunctionItemExpr with LeafElem with Product with Serializable
  63. final case class NamespaceWildcard (bracedUriLiteral: BracedUriLiteral) extends Wildcard with LeafElem with Product with Serializable
  64. final case class NillableElementNameAndTypeTest (name: EQName, tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
  65. final case class NillableElementTypeTest (tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
  66. sealed trait NodeComp extends Comp
  67. sealed trait NodeTest extends XPathElem
  68. final case class NonAbbrevForwardStep (forwardAxis: ForwardAxis, nodeTest: NodeTest) extends ForwardStep with Product with Serializable
  69. final case class NonAbbrevReverseStep (reverseAxis: ReverseAxis, nodeTest: NodeTest) extends ReverseStep with Product with Serializable
  70. final case class NonEmptySingleType (name: EQName) extends SingleType with LeafElem with Product with Serializable
  71. sealed trait NumericLiteral extends Literal
  72. final case class OneOrMoreSequenceType (itemType: ItemType) extends SequenceType with Product with Serializable
  73. final case class OrExpr (andExprs: IndexedSeq[AndExpr]) extends ExprSingle with Product with Serializable
  74. sealed trait PITest extends KindTest
  75. final case class Param (paramName: EQName, typeDeclarationOption: Option[TypeDeclaration]) extends XPathElem with Product with Serializable
  76. final case class ParamList (params: IndexedSeq[Param]) extends XPathElem with Product with Serializable
  77. final case class ParenthesizedExpr (exprOption: Option[Expr]) extends PrimaryExpr with Product with Serializable
  78. final case class ParenthesizedItemType (itemType: ItemType) extends ItemType with Product with Serializable
  79. sealed trait PathExpr extends XPathElem
  80. final case class PathExprStartingWithDoubleSlash (relativePathExpr: RelativePathExpr) extends PathExpr with Product with Serializable
  81. final case class PathExprStartingWithSingleSlash (relativePathExpr: RelativePathExpr) extends PathExpr with Product with Serializable
  82. final case class PostfixExpr (primaryExpr: PrimaryExpr, predicatesAndArgumentLists: IndexedSeq[PredicateOrArgumentList]) extends StepExpr with Product with Serializable
  83. final case class PotentiallyEmptySingleType (name: EQName) extends SingleType with LeafElem with Product with Serializable
  84. final case class Predicate (expr: Expr) extends PredicateOrArgumentList with Product with Serializable
  85. sealed trait PredicateOrArgumentList extends XPathElem
  86. final case class PrefixWildcard (prefix: NCName) extends Wildcard with LeafElem with Product with Serializable
  87. sealed trait PrimaryExpr extends XPathElem
  88. final case class QuantifiedExpr (quantifier: Quantifier, simpleBindings: IndexedSeq[SimpleBindingInQuantifiedExpr], satisfiesExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
  89. sealed trait Quantifier extends XPathElem with LeafElem
  90. sealed trait RangeExpr extends XPathElem
  91. final case class RelativePathExpr (firstExpr: StepExpr, operatorExprPairs: IndexedSeq[(StepOp, StepExpr)]) extends PathExpr with Product with Serializable
  92. sealed trait ReverseAxis extends XPathElem with LeafElem
  93. final case class ReverseAxisStep (step: ReverseStep, predicateList: IndexedSeq[Predicate]) extends AxisStep with Product with Serializable
  94. sealed trait ReverseStep extends XPathElem
  95. final case class SchemaAttributeTest (name: EQName) extends KindTest with LeafElem with Product with Serializable
  96. final case class SchemaElementTest (name: EQName) extends KindTest with LeafElem with Product with Serializable
  97. sealed trait SequenceType extends XPathElem
  98. final case class SimpleAbbrevForwardStep (nodeTest: NodeTest) extends AbbrevForwardStep with Product with Serializable
  99. final case class SimpleBindingInQuantifiedExpr (varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
  100. final case class SimpleComparisonExpr (stringConcatExpr: StringConcatExpr) extends ComparisonExpr with Product with Serializable
  101. final case class SimpleForBinding (varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
  102. final case class SimpleLetBinding (varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
  103. final case class SimpleMapExpr (pathExprs: IndexedSeq[PathExpr]) extends XPathElem with Product with Serializable
  104. final case class SimpleNameTest (name: EQName) extends NameTest with LeafElem with Product with Serializable
  105. final case class SimpleRangeExpr (additiveExpr: AdditiveExpr) extends RangeExpr with Product with Serializable
  106. sealed trait SingleType extends XPathElem
  107. sealed trait StepExpr extends XPathElem
  108. sealed trait StepOp extends XPathElem with LeafElem
  109. final case class StringConcatExpr (rangeExprs: IndexedSeq[RangeExpr]) extends XPathElem with Product with Serializable
  110. final case class StringLiteral (value: String) extends Literal with LeafElem with Product with Serializable
  111. final case class TargetPITest (target: NCName) extends PITest with LeafElem with Product with Serializable
  112. final case class TreatExpr (castableExpr: CastableExpr, sequenceTypeOption: Option[SequenceType]) extends XPathElem with Product with Serializable
  113. final case class TypeDeclaration (tpe: SequenceType) extends XPathElem with Product with Serializable
  114. final case class TypedFunctionTest (argumentTypes: IndexedSeq[SequenceType], resultType: SequenceType) extends FunctionTest with Product with Serializable
  115. final case class UnaryExpr (ops: IndexedSeq[UnaryOp], valueExpr: ValueExpr) extends XPathElem with Product with Serializable
  116. sealed trait UnaryOp extends XPathElem with LeafElem
  117. final case class UnionExpr (intersectExceptExprs: IndexedSeq[IntersectExceptExpr]) extends XPathElem with Product with Serializable
  118. sealed trait ValueComp extends Comp
  119. final case class ValueExpr (expr: SimpleMapExpr) extends XPathElem with Product with Serializable
  120. final case class VarRef (varName: EQName) extends PrimaryExpr with LeafElem with Product with Serializable
  121. sealed trait VariableBinding extends XPathElem

    Binding of a variable name to an expression.

  122. sealed trait VariableIntroducingExpr extends XPathElem

    XPathElem that can introduce one or more variable bindings.

  123. sealed trait Wildcard extends NameTest
  124. sealed trait XPathElem extends ElemLike[XPathElem]

    XPath 3.0 AST.

    XPath 3.0 AST. The root of the type hierarchy is XPathElem. It offers the ElemApi query API.

    The purpose of this AST is as follows:

    • It must represent the syntax tree of a successfully parsed XPath expression
    • It is not annotated with more semantic information, like type information that is not included in the XPath expression
    • It does not know anything about the context in which it runs, like bound namespaces etc.
    • It is rich enough to be able to serialize the AST back to XPath, knowing exactly where to place parentheses, braces, etc.
    • It is rich enough to contain operator precedence in the AST itself
    • Serialization of the AST to XPath may lead to differences in whitespace (and operator aliases), but other than that the result must be the same
    • The AST class hierarchy does not have to use the exact same names as the XPath grammar

    Having such an AST of a successfully parsed XPath expression, it must be easy to reliably find used namespace prefixes, for example.

    TODO Improve several class names.

    TODO XPath 3.1.

  125. final case class XPathExpr (expr: Expr) extends XPathElem with Product with Serializable
  126. final case class ZeroOrMoreSequenceType (itemType: ItemType) extends SequenceType with Product with Serializable
  127. final case class ZeroOrOneSequenceType (itemType: ItemType) extends SequenceType with Product with Serializable

Value Members

  1. object AbbrevReverseStep extends ReverseStep with Product with Serializable
  2. object AdditionOp
  3. object AnyAttributeTest extends AttributeTest with LeafElem with Product with Serializable
  4. object AnyElementTest extends ElementTest with LeafElem with Product with Serializable
  5. object AnyFunctionTest extends FunctionTest with LeafElem with Product with Serializable
  6. object AnyItemType extends ItemType with LeafElem with Product with Serializable
  7. object AnyKindTest extends KindTest with LeafElem with Product with Serializable
  8. object AnyWildcard extends Wildcard with LeafElem with Product with Serializable
  9. object ArgumentPlaceholder extends Argument with LeafElem with Product with Serializable
  10. object BracedUriLiteral extends Serializable
  11. object CommentTest extends KindTest with LeafElem with Product with Serializable
  12. object ContextItemExpr extends PrimaryExpr with LeafElem with Product with Serializable
  13. object EQName
  14. object EmptySequenceType extends SequenceType with LeafElem with Product with Serializable
  15. object ForwardAxis
  16. object GeneralComp
  17. object IntersectExceptOp
  18. object MultiplicativeOp
  19. object NCName extends Serializable
  20. object Names

    Names, as per the XML specification.

    Names, as per the XML specification. See for example https://www.w3.org/TR/REC-xml/#NT-Name.

    Only characters in the Unicode BMP (max. ￿) are considered. So the range from #x10000 to #xEFFFF is not recognized as valid name characters in this implementation.

    The functions of this class must be fast, because they are typically called very many times during parsing of XPath expressions.

    Classes like NCName lean on this object. An NCName is an XML name without colon.

  21. object NamespaceNodeTest extends KindTest with LeafElem with Product with Serializable
  22. object NodeComp
  23. object Quantifier
  24. object ReverseAxis
  25. object SimpleDocumentTest extends DocumentTest with LeafElem with Product with Serializable
  26. object SimplePITest extends PITest with LeafElem with Product with Serializable
  27. object SlashOnlyPathExpr extends PathExpr with LeafElem with Product with Serializable
  28. object StepOp
  29. object TextTest extends KindTest with LeafElem with Product with Serializable
  30. object UnaryOp
  31. object ValueComp

Inherited from AnyRef

Inherited from Any

Ungrouped