Compiler

Type Members

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

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
case class Dep(step: Step, tipe: Value, attribute: Value) extends Product with Serializable

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
case class Record extends Product with Serializable

Definition Classes
Values
abstract class Step extends AnyRef

A single step in the evaluation of an attribute.
A single step in the evaluation of an attribute.

Definition Classes
Profiler

Abstract Value Members

abstract def format(ast: T): Document

Format an abstract syntax tree for printing.
Format an abstract syntax tree for printing. Default: return an empty document.

Definition Classes
CompilerBase
abstract val parser: Parser[T]

The particular parser used to parse this compiler's input.
The particular parser used to parse this compiler's input.

Definition Classes
CompilerWithConfig
abstract val parsers: ParsersBase

The suite of parsers that is used by this compiler.
The suite of parsers that is used by this compiler.

Definition Classes
CompilerWithConfig
abstract def process(source: Source, ast: T, config: Config): Unit

Function to process the input that was parsed.
Function to process the input that was parsed. source is the input text processed by the compiler. ast is the abstract syntax tree produced by the parser from that text. config provides access to all aspects of the configuration.

Definition Classes
CompilerBase

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

A step to the previous node in a sequence.
A step to the previous node in a sequence.

Definition Classes
Profiler
object Other extends Step with Product with Serializable

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
object Parent extends Step with Product with Serializable

A step to the parent of the current node.
A step to the parent of the current node.

Definition Classes
Profiler
object Prev extends Step with Product with Serializable

A step to the previous node in a sequence.
A step to the previous node in a sequence.

Definition Classes
Profiler
object Self extends Step with Product with Serializable

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

Definition Classes
Profiler
final def asInstanceOf[T0]: T0

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

Definition Classes
Values
def clone(): AnyRef

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

Return the optional column number of a message.
Return the optional column number of a message.

Definition Classes
Messaging
def createAndInitConfig(args: Seq[String]): Config

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

Definition Classes
CompilerBase
def createConfig(args: Seq[String]): Config

Create the configuration for a particular run of the compiler.
Create the configuration for a particular run of the compiler. Override this if you have a custom configuration for your compiler.

Definition Classes
Compiler → CompilerBase
def dimValue(record: Record, dim: Dimension): Value

Support Kiama-specific profiling dimensions.
Support Kiama-specific profiling dimensions.

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

Driver for this compiler.
Driver for this compiler. First, use the argument list to create a configuration for this execution. Then, use the configuration to run the file processing in the appropriate way.

Definition Classes
CompilerBase
def encoding: String

The character encoding of input files read by this compiler.
The character encoding of input files read by this compiler. Defaults to UTF-8.

Definition Classes
CompilerBase
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
Values
def formatMessage(message: Message): String

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
def formatMessages(messages: Messages): String

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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def includeTimings: Boolean

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

Definition Classes
Values
final def isInstanceOf[T0]: Boolean

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

Return the optional line number of a message.
Return the optional line number of a message.

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

The entry point for this compiler.
The entry point for this compiler.

Definition Classes
CompilerBase
def makeast(source: Source, config: Config): Either[T, Messages]

Make an AST by running the parser on the given source, returning messages instead if the parse fails.
Make an AST by running the parser on the given source, returning messages instead if the parse fails.

Definition Classes
CompilerWithConfig → CompilerBase
implicit object messageOrdering extends Ordering[Message]

An ordering on messages that prioritises line over column.
An ordering on messages that prioritises line over column.

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def output(str: String): Unit

Definition Classes
Values
def outputln(str: String): Unit

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

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

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

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
val positions: Positions

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

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
def printReports(totalTime: Long, dimensionNames: Seq[Dimension], records: List[Record]): Unit

Definition Classes
Profiler
var printTables: Boolean

Definition Classes
Values
def processfile(filename: String, config: Config): Unit

Process a file argument by using makeast to turn their contents into abstract syntax trees (ASTs) and then by process which conducts arbitrary processing on the ASTs.
Process a file argument by using makeast to turn their contents into abstract syntax trees (ASTs) and then by process which conducts arbitrary processing on the ASTs. The character encoding of the files is given by the encoding method.

Definition Classes
CompilerBase
def processfiles(config: Config): Unit

Process the files one by one.
Process the files one by one.

Definition Classes
CompilerBase
def profile[T](computation: ⇒ T, dimensionNames: Seq[Dimension], logging: Boolean): T

Definition Classes
Profiler
def profileStart(logging: Boolean): Unit

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

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

Definition Classes
Profiler
def profileStopInteractive(): Unit

Definition Classes
Profiler
def report(messages: Messages, emitter: Emitter = new OutputEmitter): Unit

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
def startReport(dimensionNames: Seq[Dimension]): Unit

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
var startTime: Long

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

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

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

Definition Classes
Profiler
def toString(): String

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

Definition Classes
Profiler
def valueToString(a: Value): String

Definition Classes
Values
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package util

trait Compiler[T] extends CompilerWithConfig[T, Config]

Type Members

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

case class Dep(step: Step, tipe: Value, attribute: Value) extends Product with Serializable

case class Record extends Product with Serializable

abstract class Step extends AnyRef

Abstract Value Members

abstract def format(ast: T): Document

abstract val parser: Parser[T]

abstract val parsers: ParsersBase

abstract def process(source: Source, ast: T, config: Config): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Next extends Step with Product with Serializable

object Other extends Step with Product with Serializable

object Parent extends Step with Product with Serializable

object Prev extends Step with Product with Serializable

object Self extends Step with Product with Serializable

final def asInstanceOf[T0]: T0

def checkFor(record: Record, dim: Dimension, eventtype: String, needed: Dimension)(f: (Value) ⇒ Value): Value

def clone(): AnyRef

def column(message: Message): Option[Int]

def createAndInitConfig(args: Seq[String]): Config

def createConfig(args: Seq[String]): Config

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

def driver(args: Seq[String]): Unit

def encoding: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def finishReport(): Unit

def formatMessage(message: Message): String

def formatMessages(messages: Messages): String

final def getClass(): Class[_]

def hashCode(): Int

def includeTimings: Boolean

def isEventType(record: Record, eventtype: String): Boolean

final def isInstanceOf[T0]: Boolean

def line(message: Message): Option[Int]

def main(args: Array[String]): Unit

def makeast(source: Source, config: Config): Either[T, Messages]

implicit object messageOrdering extends Ordering[Message]

def nanoToMs(nano: Long): Long

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def output(str: String): Unit

def outputln(str: String): Unit

def parseProfileOption(value: String): Seq[Dimension]

def percent(v: Long, total: Long): String

def positionOf(message: Message): Option[Position]

val positions: Positions

def printDependencyGraph(record: Record, dim: Dimension): Unit

def printReports(totalTime: Long, dimensionNames: Seq[Dimension], records: List[Record]): Unit

var printTables: Boolean

def processfile(filename: String, config: Config): Unit

def processfiles(config: Config): Unit

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

def profileStart(logging: Boolean): Unit

def profileStop(): (Seq[Dimension]) ⇒ Unit

def profileStop(dimensionNames: Seq[Dimension]): Unit

def profileStopInteractive(): Unit

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

def startReport(dimensionNames: Seq[Dimension]): Unit

var startTime: Long

def summariseAlongDims(dimensionNames: Seq[Dimension], records: List[Record], nrecords: Int, profiledTime: Long): Unit

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

def time[T](computation: ⇒ T, warmup: Int, n: Int, discard: Int): Unit

def toString(): String

def trace(predicate: (Event) ⇒ Boolean): Unit

def valueToString(a: Value): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from CompilerWithConfig[T, Config]

Inherited from CompilerBase[T, Config]