org.openquark.cal.runtime
Class ErrorInfo

java.lang.Object
  org.openquark.cal.runtime.ErrorInfo

public final class ErrorInfo
extends Object

Class used to provide the information needed to show source position information in error messages. It is used for the Prelude.error function, but also for pattern matching failures, and even internal CAL implementation errors where an "origin" in terms of CAL source can be given. ErrorInfo contains information that indicates where in the source code that call that generated the error exists.

Author:

Greg McClement

Constructor Summary

ErrorInfo(QualifiedName topLevelFunctionName, int line, int column)

ErrorInfo(String moduleName, String topLevelFunctionName, int line, int column)

Method Summary

int	getColumn()
int	getLine()
QualifiedName	getTopLevelFunctionName()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorInfo

public ErrorInfo(QualifiedName topLevelFunctionName,
                 int line,
                 int column)

ErrorInfo

public ErrorInfo(String moduleName,
                 String topLevelFunctionName,
                 int line,
                 int column)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getTopLevelFunctionName

public QualifiedName getTopLevelFunctionName()

Returns:

The top level function that contains the error call. This is never null.

getLine

public int getLine()

Returns:

The line number that the error appeared on. Will be 0 if not applicable.

getColumn

public int getColumn()

Returns:

The column number of the line that the error call appeared on. Will be 0 if not applicable.