avail/avail.builder

Package-level declarations

Types

AvailBuilder

class AvailBuilder(val runtime: AvailRuntime)

An AvailBuilder compiles and installs into an Avail runtime a target module and each of its dependencies.

BuildDirectoryTracer

class BuildDirectoryTracer(var availBuilder: AvailBuilder, originalAfterTraceCompletes: () -> Unit)

Used for scanning all modules in all visible Avail directories and their subdirectories.

ModuleName

open class ModuleName constructor(val qualifiedName: String, val isRename: Boolean = false)

A ModuleName represents the canonical name of an Avail module. A canonical name is specified relative to an Avail module root and has the form R/X/Y/Z, where R is a module root on the Avail module path, X is a package within R, Y is a package within X, and Z is a module or package within Y.

ModuleNameResolver

class ModuleNameResolver(val moduleRoots: ModuleRoots)

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

ModuleRoot

class ModuleRoot constructor(val name: String, val resolver: ModuleRootResolver)

A ModuleRoot represents a vendor of Avail modules and/or the vended modules themselves.

ModuleRootErrorCode

enum ModuleRootErrorCode : Enum<ModuleRootErrorCode> , ErrorCode

ModuleRootErrorCode is an enum of ErrorCodes specific to errors involving ModuleRoots.

ModuleRootErrorCodeRange

object ModuleRootErrorCodeRange : ErrorCodeRange

A ModuleRootErrorCodeRange is an ErrorCodeRange that holds defined error codes that involve failures while dealing with ModuleRoots.

ModuleRoots

class ModuleRoots(val fileManager: FileManager, modulePath: String, withFailures: (List<String>) -> Unit) : Iterable<ModuleRoot>

ModuleRoots encapsulates the Avail module path. The Avail module path specifies bindings between logical root names and locations of Avail modules. A logical root name should typically belong to a vendor of Avail modules, ergo a domain name or registered trademark suffices nicely.

RenamesFileParser

class RenamesFileParser constructor(reader: Reader, roots: ModuleRoots)

A RenamesFileParser parses a file of Avail module renaming rules and answers a map.

RenamesFileParserException

class RenamesFileParserException : Exception

RenamesFileParserException is thrown by a RenamesFileParser when a parse fails for any reason.

ResolvedModuleName

class ResolvedModuleName : ModuleName

A ResolvedModuleName represents the canonical name of an Avail module that has been resolved to an absolute file reference.

UnreachableRootException

class UnreachableRootException : UnresolvedDependencyException

UnreachableRootException is a type of UnresolvedDependencyException that is specifically for the case that the ModuleRootResolver is unable to reach the source of the ModuleRoot at the ModuleRootResolver.uri.

UnresolvedDependencyException

abstract class UnresolvedDependencyException : Exception

A UnresolvedDependencyException is thrown by the builder when an unresolved reference to a module is discovered.

UnresolvedModuleException

class UnresolvedModuleException : UnresolvedDependencyException

UnresolvedModuleException is a type of UnresolvedDependencyException that is specifically for the case that the compiler could not find a module it needed in order to resolve its dependency graph. It contains the list of locations checked by the compiler for that module, which is all of the acceptable locations for the missing module according to its dependent's location.

UnresolvedRootException

class UnresolvedRootException : UnresolvedDependencyException

UnresolvedRootException is a type of UnresolvedDependencyException that is specifically for the case that the compiler could not find one of the roots it expected to be present. This may be caused by: