Agda-2.6.0.1: A dependently typed functional programming language and proof assistant

Safe Haskell | None
Language | Haskell2010

Agda.Interaction.FindFile

Description

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.

Synopsis

- toIFile :: AbsolutePath -> AbsolutePath
- data FindError
  - = NotFound [AbsolutePath]
  - | Ambiguous [AbsolutePath]
- findErrorToTypeError :: TopLevelModuleName -> FindError -> TypeError
- findFile :: TopLevelModuleName -> TCM AbsolutePath
- findFile' :: TopLevelModuleName -> TCM (Either FindError AbsolutePath)
- findFile'' :: [AbsolutePath] -> TopLevelModuleName -> ModuleToSource -> IO (Either FindError AbsolutePath, ModuleToSource)
- findInterfaceFile :: TopLevelModuleName -> TCM (Maybe AbsolutePath)
- checkModuleName :: TopLevelModuleName -> AbsolutePath -> Maybe TopLevelModuleName -> TCM ()
- moduleName :: AbsolutePath -> Module -> TCM TopLevelModuleName
- rootNameModule :: AbsolutePath -> String
- replaceModuleExtension :: String -> AbsolutePath -> AbsolutePath

# Documentation

toIFile :: AbsolutePath -> AbsolutePath Source #

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

data FindError Source #

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 Source #

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

findFile :: TopLevelModuleName -> TCM AbsolutePath Source #

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) Source #

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

SIDE EFFECT: Updates `stModuleToSource`.

findFile'' Source #

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 `TCMT`.

findInterfaceFile :: TopLevelModuleName -> TCM (Maybe AbsolutePath) Source #

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 Source #

Arguments

:: TopLevelModuleName | The name of the module.
-> AbsolutePath | The file from which it was loaded.
-> Maybe TopLevelModuleName | The expected name, coming from an import statement.
-> 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 Source #

Arguments

:: AbsolutePath | The path to the file.
-> Module | The parsed module.
-> TCM TopLevelModuleName |

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

If no top-level module name is given, then an attempt is made to use the file name as a module name.

rootNameModule :: AbsolutePath -> String Source #

replaceModuleExtension :: String -> AbsolutePath -> AbsolutePath Source #