wyal.util

Class WyalFileResolver

java.lang.Object

wyal.util.WyalFileResolver

All Implemented Interfaces:

NameResolver

public final class WyalFileResolver
extends Object
implements NameResolver

Responsible for resolving a name which occurs at some position in a WyalFile. This takes into account the context and, if necessary, will traverse important statements to resolve the query. For example, consider a WyalFile entitled "file":

 import wyal.lang.*

 assert:
    Test.g(0) >= 0
 

Here the name "g" is not fully qualified. Depending on which file the matching declaration of g occurs will depend on what its fully qualified name is. For example, if g is declared in the current compilation unit then it's fully quaified name would be test.g. However, it could well be declared in a compilation unit matching the import wyal.lang.*.

Author:

David J. Pearce

Nested Class Summary

Nested classes/interfaces inherited from interface wyal.lang.NameResolver

NameResolver.AmbiguousNameError, NameResolver.NameNotFoundError, NameResolver.ResolutionError

Constructor Summary

Constructors

Constructor and Description
WyalFileResolver(wybs.lang.Build.Project project)

Method Summary

Modifier and Type	Method and Description
wybs.lang.NameID	resolve(WyalFile.Name name) Fully resolve a given name which occurs at some position in a compilation unit.
<T extends WyalFile.Declaration.Named> List<T>	resolveAll(WyalFile.Name name, Class<T> kind) Resolve a given name which occurs at some position in a compilation unit into one or more named declarations.
<T extends WyalFile.Declaration.Named> T	resolveExactly(WyalFile.Name name, Class<T> kind) Resolve a given name which occurs at some position in a compilation unit into exactly one named declaration.

Methods inherited from class java.lang.Object

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

Constructor Detail

WyalFileResolver

public WyalFileResolver(wybs.lang.Build.Project project)

Method Detail

resolve

public wybs.lang.NameID resolve(WyalFile.Name name)
                         throws NameResolver.ResolutionError

Description copied from interface: NameResolver

Fully resolve a given name which occurs at some position in a compilation unit. This takes into account the context and, if necessary, will traverse important statements to resolve the query. This is the primary function of a name resolver, and all other functions build on this.

Specified by:

resolve in interface NameResolver

Returns:

Throws:

NameResolver.ResolutionError

resolveExactly

public <T extends WyalFile.Declaration.Named> T resolveExactly(WyalFile.Name name,
                                                               Class<T> kind)
                                                        throws NameResolver.ResolutionError

Description copied from interface: NameResolver

Resolve a given name which occurs at some position in a compilation unit into exactly one named declaration. Depending on the context, we may be looking for a specific kind of declaration. For example, for a variable declaration, we may be looking for the corresponding type declaration.

Observe that this method is expecting to find exactly one corresponding declaration. If it find no such matches or if it finds more than one match, then a corresponding error will be reported.

Specified by:

resolveExactly in interface NameResolver

Parameters:

name - The name to be resolved in the given context.

kind - The kind of declaration we are looking for, which can simply be Declaration.Named in the case we are looking for any kind of declaration.

Returns:

Throws:

NameResolver.ResolutionError

resolveAll

public <T extends WyalFile.Declaration.Named> List<T> resolveAll(WyalFile.Name name,
                                                                 Class<T> kind)
                                                          throws NameResolver.ResolutionError

Description copied from interface: NameResolver

Resolve a given name which occurs at some position in a compilation unit into one or more named declarations. Depending on the context, we may be looking for a specific kind of declaration. For example, for a function invocation expression, we are looking for the corresponding function declaration.

Specified by:

resolveAll in interface NameResolver

Parameters:

name - The name to be resolved in the given context.

kind - The kind of declaration we are looking for, which can simply be Declaration.Named in the case we are looking for any kind of declaration.

Returns:

Throws:

NameResolver.ResolutionError