Class

zio.cli.completion.RegularLanguage

Alt

Related Doc: package RegularLanguage

Permalink

final case class Alt(left: RegularLanguage, right: RegularLanguage) extends RegularLanguage with Product with Serializable

Alt(left, right) represents the union of two regular languages. We call it "Alt" for consistency with the names used in the "Parsing With Derivatives" paper.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Alt
  2. RegularLanguage
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Alt(left: RegularLanguage, right: RegularLanguage)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def *: RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def ?: Alt

    Permalink
    Definition Classes
    RegularLanguage
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def contains(tokens: List[String]): URIO[CliConfig, Boolean]

    Permalink

    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 tokens is in the language.

    Definition Classes
    RegularLanguage
  9. def derive(token: String): ZIO[CliConfig, Nothing, RegularLanguage]

    Permalink

    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
    AltRegularLanguage
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def firstTokens(prefix: String, compgen: Compgen): UIO[Set[String]]

    Permalink

    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:

    1. 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 nospace setting of compgen and complete. 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
    AltRegularLanguage
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. lazy val isNullable: Boolean

    Permalink

    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
    AltRegularLanguage
  16. val left: RegularLanguage

    Permalink
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def rep(min: Option[Int] = None, max: Option[Int] = None): RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage
  21. val right: RegularLanguage

    Permalink
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def |(other: String): RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage
  27. def |(other: RegularLanguage): RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage
  28. def ~(other: String): RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage
  29. def ~(other: RegularLanguage): RegularLanguage

    Permalink
    Definition Classes
    RegularLanguage

Inherited from RegularLanguage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped