Trait

org.bitbucket.inkytonik.kiama.util

REPLBase

Related Doc: package util

Permalink

trait REPLBase[C <: REPLConfig] extends PositionStore with Messaging with Profiler

General support for applications that implement read-eval-print loops (REPLs).

Source
REPL.scala
Linear Supertypes
Profiler, dsprofile.Profiler, Values, Messaging, PositionStore, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. REPLBase
  2. Profiler
  3. Profiler
  4. Values
  5. Messaging
  6. PositionStore
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Child(i: Int) extends Step with Product with Serializable

    Permalink

    A step to child i of the current node, counting from zero.

    A step to child i of the current node, counting from zero.

    Definition Classes
    Profiler
  2. case class Dep(step: Step, tipe: Value, attribute: Value) extends Product with Serializable

    Permalink

    Dependence record saying that the source attribute depends on attribute of a node with type type that is the given step away.

    Dependence record saying that the source attribute depends on attribute of a node with type type that is the given step away.

    Definition Classes
    Profiler
  3. case class Record extends Product with Serializable

    Permalink
    Definition Classes
    Values
  4. abstract class Step extends AnyRef

    Permalink

    A single step in the evaluation of an attribute.

    A single step in the evaluation of an attribute.

    Definition Classes
    Profiler

Abstract Value Members

  1. abstract def banner: String

    Permalink

    Banner message that is printed before the REPL starts.

  2. abstract def createConfig(args: Seq[String]): C

    Permalink

    Create the configuration for a particular run of the REPL.

    Create the configuration for a particular run of the REPL. If supplied, use emitter instead of a standard output emitter.

  3. abstract def processline(source: Source, console: Console, config: C): Option[C]

    Permalink

    Process user input from the given source.

    Process user input from the given source. The return value allows the processing to optionally return a new configuration that will be used in subsequent processing. A return value of None indicates that no more lines from the current console should be processed.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Next extends Step with Product with Serializable

    Permalink

    A step to the previous node in a sequence.

    A step to the previous node in a sequence.

    Definition Classes
    Profiler
  5. object Other extends Step with Product with Serializable

    Permalink

    A step to a node that doesn't fit into any of the other categories.

    A step to a node that doesn't fit into any of the other categories. This category will be used for nodes that were obtained as the result of reference attributes or as values that sit outside the main tree.

    Definition Classes
    Profiler
  6. object Parent extends Step with Product with Serializable

    Permalink

    A step to the parent of the current node.

    A step to the parent of the current node.

    Definition Classes
    Profiler
  7. object Prev extends Step with Product with Serializable

    Permalink

    A step to the previous node in a sequence.

    A step to the previous node in a sequence.

    Definition Classes
    Profiler
  8. object Self extends Step with Product with Serializable

    Permalink

    A step nowhere.

    A step nowhere. I.e., the dependent attribute is evaluated at the current node.

    Definition Classes
    Profiler
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def checkFor(record: Record, dim: Dimension, eventtype: String, needed: Dimension)(f: (Value) ⇒ Value): Value

    Permalink
    Definition Classes
    Values
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def column(message: Message): Option[Int]

    Permalink

    Return the optional column number of a message.

    Return the optional column number of a message.

    Definition Classes
    Messaging
  13. def createAndInitConfig(args: Seq[String]): C

    Permalink

    Create and initialise the configuration for a particular run of the REPL.

    Create and initialise the configuration for a particular run of the REPL. Default: call createConfig and then initialise the resulting configuration.

  14. def dimValue(record: Record, dim: Dimension): Value

    Permalink

    Support Kiama-specific profiling dimensions.

    Support Kiama-specific profiling dimensions.

    Definition Classes
    Profiler → Profiler → Values
  15. def driver(args: Seq[String]): Unit

    Permalink

    Driver for this REPL.

    Driver for this REPL. First, use the argument list to create a configuration for this execution. If the arguments parse ok, then print the REPL banner. Read lines from the console and pass non-null ones to processline. If ignoreWhitespaceLines is true, do not pass lines that contain just whitespace, otherwise do. Continue until processline returns false. Call prompt each time input is about to be read.

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

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def finishReport(): Unit

    Permalink
    Definition Classes
    Values
  20. def formatMessage(message: Message): String

    Permalink

    Format the message for reporting as a line containing the position and label, the input text line and line(s) containing the context of the position.

    Format the message for reporting as a line containing the position and label, the input text line and line(s) containing the context of the position. If no position is associated with this message just format as a line containing the label.

    Definition Classes
    Messaging
  21. def formatMessages(messages: Messages): String

    Permalink

    Return a string containing all the given messages sorted and formatted.

    Return a string containing all the given messages sorted and formatted.

    Definition Classes
    Messaging
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. def includeTimings: Boolean

    Permalink
    Definition Classes
    Profiler
  25. def isEventType(record: Record, eventtype: String): Boolean

    Permalink
    Definition Classes
    Values
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def line(message: Message): Option[Int]

    Permalink

    Return the optional line number of a message.

    Return the optional line number of a message.

    Definition Classes
    Messaging
  28. def main(args: Array[String]): Unit

    Permalink

    The entry point for this REPL.

  29. implicit object messageOrdering extends Ordering[Message]

    Permalink

    An ordering on messages that prioritises line over column.

    An ordering on messages that prioritises line over column.

    Definition Classes
    Messaging
  30. def nanoToMs(nano: Long): Long

    Permalink
    Definition Classes
    Profiler
  31. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  34. def output(str: String): Unit

    Permalink
    Definition Classes
    Values
  35. def outputln(str: String): Unit

    Permalink
    Definition Classes
    Values
  36. def parseProfileOption(value: String): Seq[Dimension]

    Permalink
    Definition Classes
    Profiler
  37. def percent(v: Long, total: Long): String

    Permalink
    Definition Classes
    Profiler
  38. def positionOf(message: Message): Option[Position]

    Permalink

    A message's starting position as determined from the starting position of the message's value.

    A message's starting position as determined from the starting position of the message's value. Will be None if the value has no position.

    Definition Classes
    Messaging
  39. val positions: Positions

    Permalink
    Definition Classes
    PositionStore
  40. def printDependencyGraph(record: Record, dim: Dimension): Unit

    Permalink

    Print the dependency graph for the attribute evaluation represented by record.

    Print the dependency graph for the attribute evaluation represented by record. The output is in dot form.

    Definition Classes
    Profiler
  41. def printReports(totalTime: Long, dimensionNames: Seq[Dimension], records: List[Record]): Unit

    Permalink
    Definition Classes
    Profiler
  42. var printTables: Boolean

    Permalink
    Definition Classes
    Values
  43. final def processconsole(console: Console, prompt: String, config: C): C

    Permalink

    Process interactively entered lines, one by one, until end of file.

    Process interactively entered lines, one by one, until end of file.

    Annotations
    @tailrec()
  44. def processfile(filename: String, config: C): C

    Permalink

    Process a file argument by passing its contents line-by-line to processline.

  45. final def processfiles(config: C): C

    Permalink

    Process the files one by one, allowing config to be updated each time and updated config to be used by the next file.

  46. def processlines(config: C): Unit

    Permalink

    Process interactively entered lines, one by one, until end of file.

    Process interactively entered lines, one by one, until end of file. Prompt with the given prompt.

  47. def profile[T](computation: ⇒ T, dimensionNames: Seq[Dimension], logging: Boolean): T

    Permalink
    Definition Classes
    Profiler
  48. def profileStart(logging: Boolean): Unit

    Permalink
    Definition Classes
    Profiler
  49. def profileStop(): (Seq[Dimension]) ⇒ Unit

    Permalink
    Definition Classes
    Profiler
  50. def profileStop(dimensionNames: Seq[Dimension]): Unit

    Permalink
    Definition Classes
    Profiler
  51. def profileStopInteractive(): Unit

    Permalink
    Definition Classes
    Profiler
  52. def prompt: String

    Permalink

    Define the prompt (default: "> ").

  53. def report(messages: Messages, emitter: Emitter = new OutputEmitter): Unit

    Permalink

    Output the messages in order of position using the given emitter, which defaults to terminal output.

    Output the messages in order of position using the given emitter, which defaults to terminal output.

    Definition Classes
    Messaging
  54. def startReport(dimensionNames: Seq[Dimension]): Unit

    Permalink

    Take any actions that need to be done at the start of reporting.

    Take any actions that need to be done at the start of reporting.

    Definition Classes
    Profiler → Values
  55. var startTime: Long

    Permalink
    Definition Classes
    Profiler
  56. def summariseAlongDims(dimensionNames: Seq[Dimension], records: List[Record], nrecords: Int, profiledTime: Long): Unit

    Permalink
    Definition Classes
    Profiler
  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  58. def time[T](computation: ⇒ T, warmup: Int, n: Int, discard: Int): Unit

    Permalink
    Definition Classes
    Profiler
  59. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  60. def trace(predicate: (Event) ⇒ Boolean): Unit

    Permalink
    Definition Classes
    Profiler
  61. def valueToString(a: Value): String

    Permalink
    Definition Classes
    Values
  62. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Profiler

Inherited from dsprofile.Profiler

Inherited from Values

Inherited from Messaging

Inherited from PositionStore

Inherited from AnyRef

Inherited from Any

Ungrouped