org.kiama.util

Config

class Config extends ScallopConf

Configurations for Kiama programs. args gives the command-line arguments that are used to determine many of the configuration settings. The emitters allow the output and errors targets to be altered for testing. output defaults to

emitter allows the output target to be altered for purposes such as testing; it defaults to standard output.

Source
Config.scala
Linear Supertypes
ScallopConf, AfterInit, DelayedInit, ScallopConfValidations, AnyRef, Any
Known Subclasses
REPLConfig
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Config
  2. ScallopConf
  3. AfterInit
  4. DelayedInit
  5. ScallopConfValidations
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Config(args: Seq[String], output: Emitter, error: Emitter)

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def afterInit(): Unit

    Definition Classes
    ScallopConf → AfterInit

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def assertVerified(): Unit

    Definition Classes
    ScallopConf

  9. def banner(b: String): Unit

    Definition Classes
    ScallopConf

  10. var builder: Scallop

    Definition Classes
    ScallopConf

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def codependent(list: ScallopOption[_]*): Unit

    Definition Classes
    ScallopConf

  13. val commandname: String

    Attributes
    protected
    Definition Classes
    ScallopConf

  14. def conflicts(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

    Definition Classes
    ScallopConf

  15. val console: ScallopOption[Console]

    The console to use for reading input.

    The console to use for reading input. Defaults to a JLine console. Options are a string console where the option value specifies the contents, and a file console where the option value specifies the file name.

  16. val consoleConverter: ValueConverter[Console]

    Convertor for console options.

  17. final def delayedInit(x: ⇒ Unit): Unit

    Definition Classes
    AfterInit → DelayedInit

  18. def dependsOnAll(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

    Definition Classes
    ScallopConf

  19. def dependsOnAny(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

    Definition Classes
    ScallopConf

  20. def editBuilder(fn: (Scallop) ⇒ Scallop): Unit

    Definition Classes
    ScallopConf

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  23. val error: Emitter

  24. var errorMessageHandler: (String) ⇒ Unit

    Definition Classes
    ScallopConf

  25. val filenames: ScallopOption[List[String]]

    The zero or more filenames that were specified positionally after all of the options.

  26. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  27. def footer(f: String): Unit

    Definition Classes
    ScallopConf

  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  29. def getName(name: String): String

    Definition Classes
    ScallopConf

  30. def guessOptionName: Boolean

    Definition Classes
    ScallopConf

  31. def guessOptionName_=(v: Boolean): Unit

    Definition Classes
    ScallopConf

  32. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  33. def helpWidth(w: Int): Unit

    Definition Classes
    ScallopConf

  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  35. val logging: ScallopOption[Boolean]

    Logging option.

    Logging option. If profiling and this is set, print out events as they are generated.

  36. def mainOptions: Seq[String]

    Definition Classes
    ScallopConf

  37. def mainOptions_=(newMainOptions: ⇒ Seq[ScallopOption[_]]): Unit

    Definition Classes
    ScallopConf

  38. def mutuallyExclusive(list: ScallopOption[_]*): Unit

    Definition Classes
    ScallopConf

  39. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  40. final def notify(): Unit

    Definition Classes
    AnyRef

  41. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  42. def onError(e: Throwable): Unit

    Attributes
    protected
    Definition Classes
    ScallopConf

  43. def opt[A](name: String, short: Char, descr: String, default: ⇒ Option[A], validate: (A) ⇒ Boolean, required: Boolean, argName: String, hidden: Boolean, noshort: Boolean)(implicit conv: ValueConverter[A]): ScallopOption[A]

    Definition Classes
    ScallopConf

  44. val output: Emitter

  45. def printHelp(): Unit

    Definition Classes
    ScallopConf

  46. var printedName: String

    Definition Classes
    ScallopConf

  47. val profile: ScallopOption[String]

    Profiling dimensions.

  48. def props[A](name: Char, descr: String, keyName: String, valueName: String, hidden: Boolean)(implicit conv: ValueConverter[Map[String, A]]): Map[String, A]

    Definition Classes
    ScallopConf

  49. def propsLong[A](name: String, descr: String, keyName: String, valueName: String, hidden: Boolean)(implicit conv: ValueConverter[Map[String, A]]): Map[String, A]

    Definition Classes
    ScallopConf

  50. def requireOne(list: ScallopOption[_]*): Unit

    Definition Classes
    ScallopConf

  51. val rootConfig: ScallopConf

    Definition Classes
    ScallopConf

  52. def shortSubcommandsHelp(v: Boolean): Unit

    Definition Classes
    ScallopConf

  53. def subcommand: Option[ScallopConf]

    Definition Classes
    ScallopConf

  54. def subcommands: List[ScallopConf]

    Definition Classes
    ScallopConf

  55. var subconfigs: List[ScallopConf]

    Definition Classes
    ScallopConf

  56. def summary: String

    Definition Classes
    ScallopConf

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

    Definition Classes
    AnyRef

  58. def tally(name: String, short: Char, descr: String, hidden: Boolean, noshort: Boolean): ScallopOption[Int]

    Definition Classes
    ScallopConf

  59. val time: ScallopOption[Boolean]

    Time option.

    Time option. If set, print out execution time report.

  60. def toString(): String

    Definition Classes
    AnyRef → Any

  61. def toggle(name: String, default: ⇒ Option[Boolean], short: Char, noshort: Boolean, prefix: String, descrYes: String, descrNo: String, hidden: Boolean): ScallopOption[Boolean]

    Definition Classes
    ScallopConf

  62. def trailArg[A](name: String, descr: String, validate: (A) ⇒ Boolean, required: Boolean, default: ⇒ Option[A], hidden: Boolean)(implicit conv: ValueConverter[A]): ScallopOption[A]

    Definition Classes
    ScallopConf

  63. def validate[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (A1, A2, A3, A4, A5, A6, A7) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  64. def validate[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (A1, A2, A3, A4, A5, A6) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  65. def validate[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (A1, A2, A3, A4, A5) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  66. def validate[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (A1, A2, A3, A4) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  67. def validate[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (A1, A2, A3) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  68. def validate[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (A1, A2) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  69. def validate[A1](o1: ScallopOption[A1])(fn: (A1) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  70. def validate()(fn: () ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  71. def validateOpt[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  72. def validateOpt[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  73. def validateOpt[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  74. def validateOpt[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (Option[A1], Option[A2], Option[A3], Option[A4]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  75. def validateOpt[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (Option[A1], Option[A2], Option[A3]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  76. def validateOpt[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (Option[A1], Option[A2]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  77. def validateOpt[A1](o1: ScallopOption[A1])(fn: (Option[A1]) ⇒ Either[String, Unit]): Unit

    Definition Classes
    ScallopConfValidations

  78. var validations: List[() ⇒ Either[String, Unit]]

    Attributes
    protected
    Definition Classes
    ScallopConfValidations

  79. var verified: Boolean

    Definition Classes
    ScallopConf

  80. def version(v: String): Unit

    Definition Classes
    ScallopConf

  81. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  82. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  83. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ScallopConf

Inherited from AfterInit

Inherited from DelayedInit

Inherited from ScallopConfValidations

Inherited from AnyRef

Inherited from Any

Ungrouped