org.kiama.example.oberon0.L2

Desugarer

trait Desugarer extends Desugarer

Desugaring transformation for L2.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Desugarer
  2. Desugarer
  3. NameAnalyser
  4. SymbolTable
  5. SymbolTable
  6. Environments
  7. Analyser
  8. Transformer
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Type Members

  1. trait Builtin extends Named

    Marker trait for all built-in entities.

  2. case class BuiltinType(ident: String) extends Type with Named with Builtin with Product with Serializable

    A built-in type with an implicit definition that the compiler must have special knowledge about.

  3. case class Constant(ident: String, decl: ConstDecl) extends Entity with NamedEntity with Product with Serializable

    A user-defined constant entity represented by a constant declaration.

  4. abstract class Entity extends AnyRef

    An entity that represents some program object.

  5. type Environment = Stack[Scope]

    An environment is a stack of scopes with the innermost scope on the top.

    An environment is a stack of scopes with the innermost scope on the top.

    Definition Classes
    Environments
  6. trait ErrorEntity extends Entity

    An entity that represents an error situation.

  7. case class IntegerValue(ident: String, tipe: Type, value: Int) extends Entity with NamedEntity with Builtin with Product with Serializable

    A built-in value of some type that is represented by a particular integer value.

  8. case class Module(ident: String, decl: ModuleDecl) extends Entity with NamedEntity with Product with Serializable

    A user-defined module represented by a module declaration.

  9. trait Named extends AnyRef

    Support for unique ids for named things.

  10. trait NamedEntity extends Entity with Named

    A named entity.

  11. type Scope = Map[String, Entity]

    A scope maps identifiers to entities.

    A scope maps identifiers to entities.

    Definition Classes
    Environments
  12. abstract class Type extends Entity

    An entity representing by a user-provided type declaration.

  13. case class UserType(ident: String, tipe: TypeDecl) extends Type with Named with Product with Serializable

    A user-defined type.

  14. case class Variable(ident: String, tipe: TypeDef) extends Entity with NamedEntity with Product with Serializable

    A variable entity including a reference to its types' definition.

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. object MultipleEntity extends Entity with ErrorEntity with Product with Serializable

    A entity represented by names for whom we have seen more than one declaration so we are unsure what is being represented.

  7. object Named extends AnyRef

    Static support for entity names.

  8. object UnknownEntity extends Entity with ErrorEntity with Product with Serializable

    An unknown entity, represented by names whose declarations are missing.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. lazy val booleanType: BuiltinType

    Built-in Boolean type.

    Built-in Boolean type.

    Definition Classes
    SymbolTable
  11. def casesToIf(ce: IdnExp, cases: List[Case], optelse: Option[Block]): IfStatement

    Return an IF cascade equivaleant to the given cases and optional else block.

    Return an IF cascade equivaleant to the given cases and optional else block. The variable ce holds the selection value. Specifically, these cases on ce CASE e1 : s1 CASE e2 .. e3 : s2 ELSE s3 are transformed into IF ce = e1 THEN s1 ELSEIF (ce >= e2) & (ce <= e3) THEN s2 ELSE 32 END If a case has more than one condition then they are combined with Or operators.

  12. def check(n: SourceASTNode): Unit

    Check an AST node for semantic errors.

    Check an AST node for semantic errors. Report any errors using the messaging module. This default implementation just ask the node's children to check themselves.

    Definition Classes
    NameAnalyserAnalyser
  13. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def defenv: Environment

    The default environment.

    The default environment.

    Definition Classes
    SymbolTable
  15. def defenvPairs: List[(String, Entity)]

    Definition Classes
    SymbolTable
  16. def define(env: Environment, i: String, e: Entity): Environment

    Define i to be e in the current scope of env, raising an error if the environment is empty.

    Define i to be e in the current scope of env, raising an error if the environment is empty.

    Definition Classes
    Environments
  17. lazy val desugarCase: Strategy

    Desugar CASE statements into equivalent blocks containing cascading IF statements.

    Desugar CASE statements into equivalent blocks containing cascading IF statements. A new variable called "casevar" is introduced in the block to hold the selection value so that it does not need to be re-evaluated. Specifically, CASE e OF cases END is transformed into VAR caseval : INTEGER; BEGIN caseval := e; IF caseval ... THEN ... END END

  18. lazy val desugarFor: Strategy

    Desugar FOR statements into equivalent blocks containing a WHILE loop.

    Desugar FOR statements into equivalent blocks containing a WHILE loop. A new variable called "limit" is introduced in the block to hold the upper limit of the FOR to protect against changes in the body. Specifically, FOR id := e1 TO e2 BY e3 DO body END is transformed into VAR limit : INTEGER; BEGIN id := e1; limit := e2; WHILE (id op limit) DO body id := id + e3 END END If e3 is negative, op is <=, otherwise it is >=.

  19. def enter(env: Environment): Environment

    Enter a new empty scope nested within the given environment.

    Enter a new empty scope nested within the given environment.

    Definition Classes
    Environments
  20. lazy val entity: (Identifier) ⇒ Entity

    The program entity referred to by an identifier definition or use.

    The program entity referred to by an identifier definition or use. In the case of a definition it's the thing being defined, so define it to be a reference to the declaration. If it's already defined, return a entity that indicates a multiple definition. In the case of a use, it's the thing defined elsewhere that is being referred to here, so look it up in the environment.

    Definition Classes
    NameAnalyser
  21. def entityFromDecl(n: IdnDef, i: String): Entity

    The entity for an identifier definition as given by its declaration context.

    The entity for an identifier definition as given by its declaration context.

    Definition Classes
    NameAnalyser
  22. lazy val env: Chain[SourceASTNode, Environment]

    The environment containing bindings for all identifiers visible at the given node.

    The environment containing bindings for all identifiers visible at the given node. It starts at the module declaration with the default environment. At blocks we enter a nested scope which is removed on exit from the block. At constant and type declarations the left-hand side binding is not in scope on the right-hand side. Each identifier definition just adds its binding to the chain. The envout cases for assignment and expression mean that we don't need to traverse into those constructs, since declarations can't occur there.

    Definition Classes
    NameAnalyser
  23. def envin(in: (SourceASTNode) ⇒ Environment): ==>[SourceASTNode, Environment]

    Definition Classes
    NameAnalyser
  24. def envout(out: (SourceASTNode) ⇒ Environment): ==>[SourceASTNode, Environment]

    Definition Classes
    NameAnalyser
  25. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  27. lazy val expconst: (Expression) ⇒ Boolean

    Is an expression expected to be constant or not? Either the expression is the root of an expected constant expression or its parent expression is expected to be constant.

    Is an expression expected to be constant or not? Either the expression is the root of an expected constant expression or its parent expression is expected to be constant.

    Definition Classes
    NameAnalyser
  28. lazy val falseConstant: IntegerValue

    Built-in false constant.

    Built-in false constant.

    Definition Classes
    SymbolTable
  29. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. final def getClass(): java.lang.Class[_]

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

    Definition Classes
    AnyRef → Any
  32. lazy val integerType: BuiltinType

    Built-in integer type.

    Built-in integer type.

    Definition Classes
    SymbolTable
  33. def isBoolean(e: Type): Boolean

    Return true if the given type is Boolean or an unknown type.

    Return true if the given type is Boolean or an unknown type.

    Definition Classes
    SymbolTable
  34. def isConstant(e: Entity): Boolean

    Return true if the entity is erroneous or is a constant.

    Return true if the entity is erroneous or is a constant.

    Definition Classes
    SymbolTable
  35. def isDefinedInEnv(env: Environment, i: String): Boolean

    Say whether i is defined in any scope of env.

    Say whether i is defined in any scope of env.

    Definition Classes
    Environments
  36. def isDefinedInInner(env: Environment, i: String): Boolean

    Say whether i is defined in an innermost scope of env (i.

    Say whether i is defined in an innermost scope of env (i.e., in the current scope).

    Definition Classes
    Environments
  37. def isDefinedInOuter(env: Environment, i: String): Boolean

    Say whether i is defined in an outer scope of env (i.

    Say whether i is defined in an outer scope of env (i.e., not in the current scope).

    Definition Classes
    Environments
  38. def isDefinedInScope(scope: Scope, i: String): Boolean

    Say whether i is defined in the given scope.

    Say whether i is defined in the given scope.

    Definition Classes
    Environments
  39. def isDefinedInScope(env: Environment, i: String): Boolean

    Say whether i is defined in the current scope of env.

    Say whether i is defined in the current scope of env.

    Definition Classes
    Environments
  40. def isError(e: Entity): Boolean

    Return true if the entity is an error, false otherwise.

    Return true if the entity is an error, false otherwise.

    Definition Classes
    SymbolTable
  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  42. def isInteger(e: Type): Boolean

    Return true if the given type is integer or an unknown type.

    Return true if the given type is integer or an unknown type.

    Definition Classes
    SymbolTable
  43. def isLvalue(l: Expression): Boolean

    Return true if the expression can legally appear on the left-hand side of an assignment statement.

    Return true if the expression can legally appear on the left-hand side of an assignment statement. At this level only allow identifiers of variables or things we don't know anything about. The true default is used so that this computation can be used in redefinitions.

    Definition Classes
    NameAnalyser
  44. def isModule(e: Entity): Boolean

    Return true if the entity is erroneous or is a module.

    Return true if the entity is erroneous or is a module.

    Definition Classes
    SymbolTable
  45. def isRvalue(r: IdnExp): Boolean

    Return true if the identifier is an r-value and hence its value can be used (ie.

    Return true if the identifier is an r-value and hence its value can be used (ie. it's erroneous or is a constant, value or variable).

    Definition Classes
    NameAnalyser
  46. def isType(e: Entity): Boolean

    Return true if the entity is erroneous or is a type.

    Return true if the entity is erroneous or is a type.

    Definition Classes
    SymbolTable
  47. def isVariable(e: Entity): Boolean

    Return true if the entity is erroneous or is a variable.

    Return true if the entity is erroneous or is a variable.

    Definition Classes
    SymbolTable
  48. lazy val isconst: (Expression) ⇒ Boolean

    Is an expression constant or not? Unknown entities are constant.

    Is an expression constant or not? Unknown entities are constant. Strictly speaking we only need to support integer expressions here, but we treat Boolean ones as constant in the same way so that we avoid spurious errors. Type analysis will reject Boolean constant expressions anyway.

    Definition Classes
    NameAnalyser
  49. def leave(env: Environment): Environment

    Leave the outermost scope of the given environment, raising an error if the environment is empty.

    Leave the outermost scope of the given environment, raising an error if the environment is empty.

    Definition Classes
    Environments
  50. def lookup(env: Environment, i: String, e: Entity, scope: Boolean = false): Entity

    Look up i in env, returning the mapped Entity if there is one, otherwise return e.

    Look up i in env, returning the mapped Entity if there is one, otherwise return e. If scope is true, just search the innermost scope, otherwise search outwards in all scopes, returning the first Entity found, if any.

    Definition Classes
    Environments
  51. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  52. final def notify(): Unit

    Definition Classes
    AnyRef
  53. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  54. def resetEnvironments: Unit

    Reset the environment module.

    Reset the environment module.

    Definition Classes
    Environments
  55. lazy val rootconstexp: (Expression) ⇒ Boolean

    Is this expression the root of what is expected to be a constant expression? At this level only expressions on the RHS of a constant declaration have this property.

    Is this expression the root of what is expected to be a constant expression? At this level only expressions on the RHS of a constant declaration have this property.

    Definition Classes
    NameAnalyser
  56. def rootconstexpDef: (Expression) ⇒ Boolean

    Definition Classes
    NameAnalyser
  57. def rootenv(bindings: (String, Entity)*): Environment

    Create a root environment, i.

    Create a root environment, i.e., one that has a single scope containing the given bindings.

    Definition Classes
    Environments
  58. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  59. def toString(): String

    Definition Classes
    AnyRef → Any
  60. def transform(m: ModuleDecl): ModuleDecl

    Desugar FOR and CASE statements into simpler constructs.

    Desugar FOR and CASE statements into simpler constructs. Then call the next level of transformation.

    Definition Classes
    DesugarerDesugarerTransformer
  61. lazy val trueConstant: IntegerValue

    Built-in true constant.

    Built-in true constant.

    Definition Classes
    SymbolTable
  62. def uniquifyNames(m: ModuleDecl): ModuleDecl

    Rename user-defined names to avoid clashes with outer declarations of the same name.

    Rename user-defined names to avoid clashes with outer declarations of the same name. This transformation is not idempotent.

    Definition Classes
    Desugarer
  63. lazy val unknownType: BuiltinType

    A type that is unknown, eg because the typed thing is erroneously defined.

    A type that is unknown, eg because the typed thing is erroneously defined.

    Definition Classes
    SymbolTable
  64. lazy val value: (Expression) ⇒ Int

    What is the value of an integer expression? Only needs to be valid if the expression is an integer constant (see isconst above) and is defined (eg, no divide by zero.

    What is the value of an integer expression? Only needs to be valid if the expression is an integer constant (see isconst above) and is defined (eg, no divide by zero.) Returns zero in all other cases. FIXME: Ignores issues of overflow.

    Definition Classes
    NameAnalyser
  65. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Desugarer

Inherited from NameAnalyser

Inherited from SymbolTable

Inherited from SymbolTable

Inherited from Environments

Inherited from Analyser

Inherited from Transformer

Inherited from AnyRef

Inherited from Any