ModuleNameResolver

class ModuleNameResolver(val moduleRoots: ModuleRoots)

A ModuleNameResolver resolves fully-qualified references to Avail modules to absolute file references.

Assuming that the Avail module path comprises four module roots listed in the order S, P,Q, R, then the following algorithm is used for resolution of a fully-qualified reference R/X/Y/Z/M:

Obtain the canonical name /R'/A/B/C/M' by applying an existing renaming rule for /R/X/Y/Z/M.
If package /R'/A/B/C contains a module M', then capture its file reference F.
If package /R'/A/B contains a module M', then capture its file reference F.
If package /R'/A contains a module M', then capture its file reference F.
If module root /R contains a module M', then capture its file reference F.
If module root /S contains a module M', then capture its file reference F.
If module root /P contains a module M', then capture its file reference F.
If module root /Q contains a module M', then capture its file reference F.
If the resolution succeeded and F specifies a directory, then replace the resolution with F/M'.avail. Verify that the resolution specifies an existing regular file.
Otherwise, resolution failed.

An instance is obtained via RenamesFileParser.parse.

Author

Todd L Smith

Leslie Schultz

Richard Arriaga

Parameters

moduleRoots

The Avail module roots.

Constructors

ModuleNameResolver

constructor(moduleRoots: ModuleRoots)

Construct a new ModuleNameResolver.

Types

Companion

object Companion

ModuleNameResolutionResult

class ModuleNameResolutionResult

This class was created so that, upon an UnresolvedDependencyException, the ModuleNameResolver could bundle information about the different paths checked for the missing file into the exception itself.