final case class Rep(language: RegularLanguage, min: Option[Int], max: Option[Int]) extends RegularLanguage with Product with Serializable
Rep(language, min, max) represents the repetition of language. The
number of repetitions can be bounded via min and max. Setting max=None
represents the "Kleene star" of language.
- Alphabetic
- By Inheritance
- Rep
- RegularLanguage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def *: RegularLanguage
- Definition Classes
- RegularLanguage
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ?: Alt
- Definition Classes
- RegularLanguage
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def contains(tokens: List[String]): URIO[CliConfig, Boolean]
Checks to see if the input token list is a member of the language.
Checks to see if the input token list is a member of the language.
- returns
true if and only if
tokensis in the language.
- Definition Classes
- RegularLanguage
- def derive(token: String): URIO[CliConfig, RegularLanguage]
Calculate the Brzozowski derivative of this language with respect to the given string.
Calculate the Brzozowski derivative of this language with respect to the given string. This is an effectful function because it can call PrimType.validate (e.g., when validating file paths, etc.).
- token
The string to use for calculation of the Brzozowski derivative.
- returns
Brzozowski derivative wrapped in an UIO instance.
- Definition Classes
- Rep → RegularLanguage
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def firstTokens(prefix: String, compgen: Compgen): UIO[Set[String]]
Returns a set consisting of the first token of all strings in this language that are useful for CLI tab completion.
Returns a set consisting of the first token of all strings in this language that are useful for CLI tab completion. For infinite or unwieldly languages, it is perfectly fine to return the empty set: This will simply not display any completions to the user.
If you'd like the cursor to advance to the next word when tab completion unambiguously matches the prefix to a token, append a space (" ") character to the end of the returned token. Otherwise, the cursor will skip to the end of the completed token in the terminal.
Some examples of different use cases:
- Completing file/directory names:
- Append a space to the ends of file names (e.g., "bippy.pdf"). This is because we want the cursor to jump to the next argument position if tab completion unambiguously succeeds.
- Do not append a space to the end of a directory name (e.g., "foo/"). This is because we want the user to be able to press tab again to gradually complete a lengthy file path.
- Append a space to the ends of string tokens.
You may be asking why we don't try to use the
-o nospacesetting ofcompgenandcomplete. The answer is they appear to be all or nothing: For a given tab completion execution, you have to choose one behavior or the other. This does not work well when completing both file names and directory names at the same time.- Definition Classes
- Rep → RegularLanguage
- Completing file/directory names:
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNullable: Boolean
This is the delta (δ) predicate from "Parsing With Derivatives", indicating whether this language contains the empty string.
This is the delta (δ) predicate from "Parsing With Derivatives", indicating whether this language contains the empty string.
- returns
true if and only if this language contains the empty string.
- Definition Classes
- Rep → RegularLanguage
- val language: RegularLanguage
- val max: Option[Int]
- val min: Option[Int]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def rep(min: Option[Int] = None, max: Option[Int] = None): RegularLanguage
- Definition Classes
- RegularLanguage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def |(other: String): RegularLanguage
- Definition Classes
- RegularLanguage
- def |(other: RegularLanguage): RegularLanguage
- Definition Classes
- RegularLanguage
- def ~(other: String): RegularLanguage
- Definition Classes
- RegularLanguage
- def ~(other: RegularLanguage): RegularLanguage
- Definition Classes
- RegularLanguage