TRegular

java.lang.Object
- org.stekikun.dolmen.tagged.TRegular

Direct Known Subclasses:

TRegular.Action, TRegular.Alternate, TRegular.Characters, TRegular.Epsilon, TRegular.Repetition, TRegular.Sequence, TRegular.Tag
```
public abstract class TRegular
extends Object
```
Instances of TRegular represent tagged regular expressions.
Tagged regular expressions are an intermediate form of compiled regular expressions where bindings have been replaced by pair of "tags" enclosing the bound parts of regular expressions, and where character sets are replaced by indices in an external map of character sets. When a bounded expression is guaranteed to match only single characters, it is marked by a single starting tag and has no closing tag.
In a latter phase, they can also reference semantic actions to be executed at the point where they are encountered when matching the expression.
They are immutable objects, and have therefore value semantics.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TRegular.Action` Stands for a semantic action to be executed when matching reaches this regular expression.
`static class`	`TRegular.Alternate` Instances of tagged regular expressions that represent a choice `a \| b` between two regular expressions.
`static class`	`TRegular.Characters` Instances of regular expressions that match exactly one character amongst a set of possible characters.
`static class`	`TRegular.Epsilon` The singleton class that stands for the empty tagged regular expression ε, which only matches the empty string.
`static class`	`TRegular.Kind` Enumeration which describes the different kinds of concrete implementations of `TRegular`.
`static class`	`TRegular.Repetition` Instances of tagged regular expressions that represent the Kleene closure `r*` of some regular expression `r`, i.e. matching zero, one or more repetitions of `r`
`static class`	`TRegular.Sequence` Instances of tagged regular expressions that represent the concatenation `ab` of two regular expressions.
`static class`	`TRegular.Tag` Instances of tagged regular expressions that represent a tag, i.e. either the beginning or the end of some bound sub-expression
`static class`	`TRegular.TagInfo` Describes a tag, i.e. a marker used in tagged regular expressions to represent the boundaries of bound sub-expressions

Field Summary

Fields
Modifier and Type	Field and Description
`static TRegular.Epsilon`	`EPSILON` The empty tagged regular expression ε
`boolean`	`hasActions` Whether this regular expressions has any semantic actions or not
`boolean`	`hasTags` Whether this regular expressions has any tags or not
`TRegular.Kind`	`kind` Specifies what kind of regular expression `this` is
`boolean`	`nullable` Whether this tagged regular expression matches the empty string.
`int`	`size` If `size` >= 0, all strings matching this regular expression have the specified size.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static TRegular.Action`	`action(int action)`
`static TRegular`	`chars(int cset, boolean eof)` If `eof` is true, `cset` must point to a singleton end-of-input.
`TRegular.Kind`	`getKind()` Only there for the quick-assist based on `Hierarchy`.
`static TRegular`	`or(TRegular lhs, TRegular rhs)`
`static TRegular`	`seq(TRegular first, TRegular second)`
`static TRegular`	`star(TRegular reg)`
`static TRegular.Tag`	`tag(String id, boolean start, int action)`
`abstract @NonNull String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - kind
```
public final TRegular.Kind kind
```
    Specifies what kind of regular expression this is
  - size
```
public final int size
```
    If size >= 0, all strings matching this regular expression have the specified size. If size is negative, then no size is guaranteed.
  - hasTags
```
public final boolean hasTags
```
    Whether this regular expressions has any tags or not
  - hasActions
```
public final boolean hasActions
```
    Whether this regular expressions has any semantic actions or not
  - nullable
```
public final boolean nullable
```
    Whether this tagged regular expression matches the empty string.
    Note that the end-of-file regular expression does not match the empty string, it matches a special character set instead.
  - EPSILON
```
public static final TRegular.Epsilon EPSILON
```
    The empty tagged regular expression ε
- Method Detail
  - getKind
```
public final TRegular.Kind getKind()
```
    Only there for the quick-assist based on Hierarchy. You should probably use the field kind directly.
    
    Returns:
    
    kind
  - toString
```
public abstract @NonNull String toString()
```
    Overrides:
    
    toString in class Object
  - chars
```
public static TRegular chars(int cset,
                             boolean eof)
```
    If eof is true, cset must point to a singleton end-of-input. Otherwise, cset must not contain the end-of-input marker.
    
    Parameters:
    
    cset -
    
    eof -
    
    Returns:
    
    a tagged regular expression which matches exactly one character in the character set chars
  - tag
```
public static TRegular.Tag tag(String id,
                               boolean start,
                               int action)
```
    Parameters:
    
    id -
    
    start -
    
    action -
    
    Returns:
    
    the regular expression consisting of the tag described by the given parameters
    
    See Also:
    
    TRegular.TagInfo
  - or
```
public static TRegular or(TRegular lhs,
                          TRegular rhs)
```
    Parameters:
    
    lhs -
    
    rhs -
    
    Returns:
    
    the tagged regular expression representing the alternative of lhs and rhs, in this order
  - seq
```
public static TRegular seq(TRegular first,
                           TRegular second)
```
    Parameters:
    
    first -
    
    second -
    
    Returns:
    
    the tagged regular expression representing the concatenation of first and second, in this order
  - star
```
public static TRegular star(TRegular reg)
```
    Parameters:
    
    reg -
    
    Returns:
    
    the tagged regular expression representing any number of repetitions of reg
  - action
```
public static TRegular.Action action(int action)
```
    Parameters:
    
    action -
    
    Returns:
    
    a regular expression consisting of the semantic action with the specified index

Class TRegular

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kind

size

hasTags

hasActions

nullable

EPSILON

Method Detail

getKind

toString

chars

tag

or

seq

star

action