wyil.lang

Class WyilFile

java.lang.Object

wybs.util.AbstractCompilationUnit

wyil.lang.WyilFile

All Implemented Interfaces:

wybs.lang.CompilationUnit

public final class WyilFile
extends wybs.util.AbstractCompilationUnit

Provides an in-memory representation of a binary WyIL file. This is an Intermediate Representation of Whiley (and potentially other) files, where all aspects of name resolution and type checking are already resolved. Furthermore, the Whiley Intermediate Language (WyIL) is a low-level, register-based bytecode format where control-flow constructs are flattened into unstructured control flow using conditional and unconditional branching.

The purpose of the WyIL file format is to simply the construction of back-ends for the Whiley compiler, as well as simplifying the process of name and type resolution in libraries. The format achieves a similar goal to that Java ClassFile format, except that it is geared towards Whiley rather than Java.

Author:

David J. Pearce

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WyilFile.Block A block is an chunk of information within a WyIL file.
static class	WyilFile.Constant A constant declaration is a top-level block within a WyilFile that associates a name with a given constant value.
static class	WyilFile.Declaration A declaration is a named entity within a WyIL file, and is either a type, constant, function or method declaration.
static class	WyilFile.FunctionOrMethod
static class	WyilFile.FunctionOrMethodOrProperty
static class	WyilFile.Property
static class	WyilFile.Type A type declaration is a top-level block within a WyilFile that associates a name with a given type.

Field Summary

Fields

Modifier and Type	Field and Description
static wyfs.lang.Content.Type<WyilFile>	ContentType Responsible for identifying and reading/writing WyilFiles.

Fields inherited from class wybs.util.AbstractCompilationUnit

entry

Constructor Summary

Constructors

Constructor and Description
WyilFile(wyfs.lang.Path.Entry<? extends wybs.lang.CompilationUnit> entry) Construct a WyilFile objects with a given identifier, originating filename and list of declarations.

Method Summary

Modifier and Type	Method and Description
List<WyilFile.Block>	blocks() Returns all declarations declared in this WyilFile.
WyilFile.Constant	constant(String name) Looks up a constant declaration in this WyilFile with the given name; if none exists, returns null.
Collection<WyilFile.Constant>	constants() Returns all constant declarations in this WyilFile.
List<WyilFile.FunctionOrMethodOrProperty>	functionOrMethodOrProperty(String name) Returns all function or method declarations in this WyilFile with the given name.
WyilFile.FunctionOrMethodOrProperty	functionOrMethodOrProperty(String name, Type.FunctionOrMethod ft) Looks up a function or method declaration in this WyilFile with the given name and type; if none exists, returns null.
Collection<WyilFile.FunctionOrMethod>	functionOrMethods() Returns all function or method declarations in this WyilFile.
boolean	hasName(String name) Determines whether a declaration exists with the given name.
void	replace(WyilFile.Block old, WyilFile.Block nuw)
WyilFile.Type	type(String name) Looks up a type declaration in this WyilFile with the given name; if none exists, returns null.
Collection<WyilFile.Type>	types() Returns all type declarations in this WyilFile.

Methods inherited from class wybs.util.AbstractCompilationUnit

getEntry

Methods inherited from class java.lang.Object

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

Field Detail

ContentType

public static final wyfs.lang.Content.Type<WyilFile> ContentType

Responsible for identifying and reading/writing WyilFiles. The normal extension is ".wyil" for WyilFiles.

Constructor Detail

WyilFile

public WyilFile(wyfs.lang.Path.Entry<? extends wybs.lang.CompilationUnit> entry)

Construct a WyilFile objects with a given identifier, originating filename and list of declarations.

Parameters:

mid -

filename -

declarations -

Method Detail

hasName

public boolean hasName(String name)

Determines whether a declaration exists with the given name.

Parameters:

name -

Returns:

blocks

public List<WyilFile.Block> blocks()

Returns all declarations declared in this WyilFile. This list is modifiable, and one can add new declarations to this WyilFile by adding them to the returned list.

Returns:

type

public WyilFile.Type type(String name)

Looks up a type declaration in this WyilFile with the given name; if none exists, returns null.

Parameters:

name -

Returns:

types

public Collection<WyilFile.Type> types()

Returns all type declarations in this WyilFile. Note that the returned list is not modifiable.

Parameters:

name -

Returns:

constant

public WyilFile.Constant constant(String name)

Looks up a constant declaration in this WyilFile with the given name; if none exists, returns null.

Parameters:

name -

Returns:

constants

public Collection<WyilFile.Constant> constants()

Returns all constant declarations in this WyilFile. Note that the returned list is not modifiable.

Parameters:

name -

Returns:

functionOrMethodOrProperty

public List<WyilFile.FunctionOrMethodOrProperty> functionOrMethodOrProperty(String name)

Returns all function or method declarations in this WyilFile with the given name. Note that the returned list is not modifiable.

Parameters:

name -

Returns:

functionOrMethodOrProperty

public WyilFile.FunctionOrMethodOrProperty functionOrMethodOrProperty(String name,
                                                                      Type.FunctionOrMethod ft)

Looks up a function or method declaration in this WyilFile with the given name and type; if none exists, returns null.

Parameters:

name -

Returns:

functionOrMethods

public Collection<WyilFile.FunctionOrMethod> functionOrMethods()

Returns all function or method declarations in this WyilFile. Note that the returned list is not modifiable.

Parameters:

name -

Returns:

replace

public void replace(WyilFile.Block old,
                    WyilFile.Block nuw)