Agda.Interaction.FindFile

Functions which map between module names and file names.

Note that file name lookups are cached in the TCState. The code assumes that no Agda source files are added or removed from the include directories while the code is being type checked.

Documentation

toIFile :: AbsolutePath -> AbsolutePath

Converts an Agda file name to the corresponding interface file name.

data FindError

Errors which can arise when trying to find a source file.

Invariant: All paths are absolute.

Constructors

NotFound [AbsolutePath]

The file was not found. It should have had one of the given file names.

Ambiguous [AbsolutePath]

Several matching files were found.

Invariant: The list of matching files has at least two elements.

findErrorToTypeError :: TopLevelModuleName -> FindError -> TypeError

Given the module name which the error applies to this function converts a FindError to a TypeError.

findFile :: TopLevelModuleName -> TCM AbsolutePath

Finds the source file corresponding to a given top-level module name. The returned paths are absolute.

Raises an error if the file cannot be found.

findFile' :: TopLevelModuleName -> TCM (Either FindError AbsolutePath)

Tries to find the source file corresponding to a given top-level module name. The returned paths are absolute.

SIDE EFFECT: Updates stModuleToSource.

findFile''

Arguments

:: [AbsolutePath]

Include paths.

-> TopLevelModuleName

-> ModuleToSource

Cached invocations of findFile''. An updated copy is returned.

-> IO (Either FindError AbsolutePath, ModuleToSource)

A variant of findFile' which does not require TCM.

findInterfaceFile :: TopLevelModuleName -> TCM (Maybe AbsolutePath)

Finds the interface file corresponding to a given top-level module name. The returned paths are absolute.

Raises an error if the source file cannot be found, and returns Nothing if the source file can be found but not the interface file.

checkModuleName

Arguments

:: TopLevelModuleName

The name of the module.

-> AbsolutePath

The file from which it was loaded.

-> TCM ()

Ensures that the module name matches the file name. The file corresponding to the module name (according to the include path) has to be the same as the given file name.

moduleName' :: AbsolutePath -> TCM TopLevelModuleName

Computes the module name of the top-level module in the given file.

Warning! Parses the whole file to get the module name out. Use wisely!

moduleName :: AbsolutePath -> TCM TopLevelModuleName

A variant of moduleName' which raises an error if the file name does not match the module name.

The file name is interpreted relative to the current working directory (unless it is absolute).

tests :: IO Bool