Type Members

1.  case class AnyDot(location: Location) extends Leaf[Char] with Product with Serializable

   Any dot . predefined character class leaf node

   Any dot . predefined character class leaf node

   location

   The weaponregex.model.Location of the node in the regex string

   Note

   This is technically a predefined character class, but because it cannot be negated nor has a \ prefix, it is handled separately here

2.  case class AtomicGroup(expr: RegexTree, location: Location) extends Node with Product with Serializable

   Atomic (independent, non-capturing) group node

   Atomic (independent, non-capturing) group node

   expr

   The regex inside the group

   location

   The weaponregex.model.Location of the node in the regex string

3.  case class BOL(location: Location) extends Leaf[Char] with Product with Serializable

   Beginning of Line (BOL) leaf node

   Beginning of Line (BOL) leaf node

   location

   The weaponregex.model.Location of the node in the regex string

4.  case class Boundary(boundary: String, location: Location) extends Leaf[String] with Product with Serializable

   Boundary meta character leaf node

   Boundary meta character leaf node

   boundary

   The literal boundary character without the \

   location

   The weaponregex.model.Location of the node in the regex string

5.  case class CharClassIntersection(nodes: Seq[RegexTree], location: Location) extends Node with Product with Serializable

   Character class intersection used inside a character class

   Character class intersection used inside a character class

   nodes

   The nodes that are being "or-ed"

   location

   The weaponregex.model.Location of the node in the regex string

6.  case class Character(char: Char, location: Location) extends Leaf[Char] with Product with Serializable

   Character literal leaf node

   Character literal leaf node

   char

   The character literal value

   location

   The weaponregex.model.Location of the node in the regex string

7.  case class CharacterClass(nodes: Seq[RegexTree], location: Location, isPositive: Boolean = true) extends Node with Product with Serializable

   Character class node

   Character class node

   nodes

   The child nodes contained in the character class

   location

   The weaponregex.model.Location of the node in the regex string

   isPositive

   true if the character class is positive, false otherwise

8.  case class CharacterClassNaked(nodes: Seq[RegexTree], location: Location) extends Node with Product with Serializable

   Character class node without the surround syntactical symbols, i.e.

   Character class node without the surround syntactical symbols, i.e. "naked"

   nodes

   The child nodes contained in the character class

   location

   The weaponregex.model.Location of the node in the regex string

9.  case class Concat(nodes: Seq[RegexTree], location: Location) extends Node with Product with Serializable

   Concatenation node

   Concatenation node

   nodes

   The nodes that are being concatenated

   location

   The weaponregex.model.Location of the node in the regex string

10.  case class ControlChar(controlChar: String, location: Location) extends Leaf[String] with Product with Serializable

    Control meta-characters leaf node corresponding to a given character

    Control meta-characters leaf node corresponding to a given character

    controlChar

    Any character in a-z or A-Z

    location

    weaponregex.model.Location of the token in the regex string

    Note

    This is technically a meta-character, but because it has an additional target character and a \c prefix, it is handled separately here

11.  case class EOL(location: Location) extends Leaf[Char] with Product with Serializable

    End of Line (EOL) leaf node

    End of Line (EOL) leaf node

    location

    The weaponregex.model.Location of the node in the regex string

12.  case class Empty(location: Location) extends Leaf[String] with Product with Serializable

    Empty string (nothing, null) leaf

    Empty string (nothing, null) leaf

    location

    The weaponregex.model.Location of the node in the regex string

13.  case class FlagNCGroup(flagToggle: FlagToggle, expr: RegexTree, location: Location) extends Node with Product with Serializable

    Non-capturing group with flags

    Non-capturing group with flags

    flagToggle

    The weaponregex.internal.model.regextree.FlagToggle object associated with the group

    expr

    The regex inside the group

    location

    The weaponregex.model.Location of the node in the regex string

14.  case class FlagToggle(onFlags: Flags, hasDash: Boolean, offFlags: Flags, location: Location) extends Node with Product with Serializable

    Flag toggle node that describes which flags are toggled on and/or off

    Flag toggle node that describes which flags are toggled on and/or off

    onFlags

    The flags that are toggled on

    hasDash

    true if there is a dash character - between the onFlags and offFlags, false otherwise

    offFlags

    The flags that are toggled off

    location

    The weaponregex.model.Location of the node in the regex string

15.  case class FlagToggleGroup(flagToggle: FlagToggle, location: Location) extends Node with Product with Serializable

    Flag toggle group node

    Flag toggle group node

    flagToggle

    The weaponregex.internal.model.regextree.FlagToggle object associated with the group

    location

    The weaponregex.model.Location of the node in the regex string

16.  case class Flags(flags: Seq[Character], location: Location) extends Node with Product with Serializable

    A sequence of flags for use in weaponregex.internal.model.regextree.FlagToggle

    A sequence of flags for use in weaponregex.internal.model.regextree.FlagToggle

    flags

    The sequence of flag weaponregex.internal.model.regextree.Character s

    location

    The weaponregex.model.Location of the node in the regex string

17.  case class Group(expr: RegexTree, isCapturing: Boolean, location: Location) extends Node with Product with Serializable

    (Non-)capturing group node

    (Non-)capturing group node

    expr

    The regex inside the group

    isCapturing

    true if group is capturing, false otherwise

    location

    The weaponregex.model.Location of the node in the regex string

18.  abstract class Leaf[A] extends RegexTree

    The leaf of the weaponregex.internal.model.regextree.RegexTree (terminal node) that have no children node

19.  case class Lookaround(expr: RegexTree, isPositive: Boolean, isLookahead: Boolean, location: Location) extends Node with Product with Serializable

    The umbrella node for positive/negative lookahead/lookbehind

    The umbrella node for positive/negative lookahead/lookbehind

    expr

    The regex inside the lookaround

    isPositive

    true if the lookaround is positive, false otherwise

    isLookahead

    true if this is a lookahead, false if this is a lookbehind

    location

    The weaponregex.model.Location of the node in the regex string

20.  case class MetaChar(metaChar: String, location: Location) extends Leaf[String] with Product with Serializable

    Meta-characters leaf node

    Meta-characters leaf node

    metaChar

    Can be any meta character as defined in the grammar

    location

    weaponregex.model.Location of the token in the regex string

21.  case class NameReference(name: String, location: Location) extends Leaf[String] with Product with Serializable

    Reference to a named capturing group leaf node

    Reference to a named capturing group leaf node

    name

    The name of the capturing group being referenced

    location

    The weaponregex.model.Location of the node in the regex string

22.  case class NamedGroup(expr: RegexTree, name: String, location: Location) extends Node with Product with Serializable

    Named capturing group node

    Named capturing group node

    expr

    The regex inside the group

    name

    The name of the group

    location

    The weaponregex.model.Location of the node in the regex string

23.  abstract class Node extends RegexTree

    The non-terminal node of the weaponregex.internal.model.regextree.RegexTree that have at least one child node

24.  case class NumberReference(num: Int, location: Location) extends Leaf[Int] with Product with Serializable

    Reference to a numbered capturing group leaf node

    Reference to a numbered capturing group leaf node

    num

    The order number of the capturing group being referenced

    location

    The weaponregex.model.Location of the node in the regex string

25.  case class OneOrMore(expr: RegexTree, location: Location, quantifierType: QuantifierType) extends Node with Product with Serializable

    Shorthand notation one or more + quantifier node

    Shorthand notation one or more + quantifier node

    expr

    The regex that is being quantified

    location

    The weaponregex.model.Location of the node in the regex string

    quantifierType

    The type of the quantifier: greedy, reluctant, or possessive

26.  case class Or(nodes: Seq[RegexTree], location: Location) extends Node with Product with Serializable

    Or node (e.g.

    Or node (e.g. a|b|c)

    nodes

    The nodes that are being "or-ed"

    location

    The weaponregex.model.Location of the node in the regex string

27.  case class PredefinedCharClass(charClass: String, location: Location) extends Leaf[String] with Product with Serializable

    Predefined character class leaf node

    Predefined character class leaf node

    charClass

    The literal class character without the \

    location

    The weaponregex.model.Location of the node in the regex string

28.  case class Quantifier(expr: RegexTree, min: Int, max: Int, location: Location, quantifierType: QuantifierType, isExact: Boolean) extends Node with Product with Serializable

    Long quantifier node

    Long quantifier node

    expr

    The regex that is being quantified

    min

    The minimum number of repetition

    max

    The maximum number of repetitions

    location

    The weaponregex.model.Location of the node in the regex string

    quantifierType

    The type of the quantifier: greedy, reluctant, or possessive

    isExact

    true if used to represent an exact number of repetitions (e.g. {1}), false otherwise (e.g. {1,2} or {1,})

    Note

    This class constructor is private, instances must be created using the companion weaponregex.internal.model.regextree.Quantifier object

29.  sealed abstract class QuantifierType extends AnyRef

    The enumeration of the quantifier type

30.  case class Quote(quote: String, hasEnd: Boolean, location: Location) extends Leaf[String] with Product with Serializable

    Quote from \Q to an optional \E

    Quote from \Q to an optional \E

    quote

    The string being quoted

    hasEnd

    true if quote has an end symbol \E, false otherwise

    location

    The weaponregex.model.Location of the node in the regex string

31.  case class QuoteChar(char: Char, location: Location) extends Leaf[Char] with Product with Serializable

    Quote for the following single character

    Quote for the following single character

    char

    The character being quoted

    location

    The weaponregex.model.Location of the node in the regex string

32.  case class Range(from: Character, to: Character, location: Location) extends Node with Product with Serializable

    Character range that is used inside of a character class

    Character range that is used inside of a character class

    from

    The left bound of the range

    to

    The right bound of the range

    location

    The weaponregex.model.Location of the node in the regex string

33.  sealed trait RegexTree extends AnyRef

    The abstraction of a RegexTree node

34.  case class UnicodeCharClass(property: String, location: Location, isPositive: Boolean = true, propValue: Option[String] = None) extends Leaf[String] with Product with Serializable

    Unicode character class leaf node

    Unicode character class leaf node

    property

    The class character property

    location

    The weaponregex.model.Location of the node in the regex string

    propValue

    The value of the property

35.  case class ZeroOrMore(expr: RegexTree, location: Location, quantifierType: QuantifierType) extends Node with Product with Serializable

    Shorthand notation zero or more * quantifier node

    Shorthand notation zero or more * quantifier node

    expr

    The regex that is being quantified

    location

    The weaponregex.model.Location of the node in the regex string

    quantifierType

    The type of the quantifier: greedy, reluctant, or possessive

36.  case class ZeroOrOne(expr: RegexTree, location: Location, quantifierType: QuantifierType) extends Node with Product with Serializable

    Shorthand notation zero or one ? quantifier node

    Shorthand notation zero or one ? quantifier node

    expr

    The regex that is being quantified

    location

    The weaponregex.model.Location of the node in the regex string

    quantifierType

    The type of the quantifier: greedy, reluctant, or possessive