Agda.Interaction.Imports

This module deals with finding imported modules and loading their interface files.

Documentation

data Mode

Is the aim to type-check the top-level module, or only to scope-check it?

Constructors

ScopeCheck

TypeCheck

Instances

Eq Mode

Methods

(==) :: Mode -> Mode -> Bool

(/=) :: Mode -> Mode -> Bool

Show Mode

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

data MainInterface

Are we loading the interface for the user-loaded file or for an import?

Constructors

MainInterface Mode

For the main file.

In this case state changes inflicted by createInterface are preserved.

NotMainInterface

For an imported file.

In this case state changes inflicted by createInterface are not preserved.

Instances

Eq MainInterface

Methods

(==) :: MainInterface -> MainInterface -> Bool

(/=) :: MainInterface -> MainInterface -> Bool

Show MainInterface

Methods

showsPrec :: Int -> MainInterface -> ShowS

show :: MainInterface -> String

showList :: [MainInterface] -> ShowS

includeStateChanges :: MainInterface -> Bool

Should state changes inflicted by createInterface be preserved?

mergeInterface :: Interface -> TCM ()

Merge an interface into the current proof state.

addImportedThings :: Signature -> BuiltinThings PrimFun -> PatternSynDefns -> DisplayForms -> [TCWarning] -> TCM ()

scopeCheckImport :: ModuleName -> TCM (ModuleName, Map ModuleName Scope)

Scope checks the given module. A proper version of the module name (with correct definition sites) is returned.

data MaybeWarnings' a

Constructors

NoWarnings

SomeWarnings a

Instances

Functor MaybeWarnings'

Methods

fmap :: (a -> b) -> MaybeWarnings' a -> MaybeWarnings' b

(<$) :: a -> MaybeWarnings' b -> MaybeWarnings' a

Foldable MaybeWarnings'

Methods

fold :: Monoid m => MaybeWarnings' m -> m

foldMap :: Monoid m => (a -> m) -> MaybeWarnings' a -> m

foldr :: (a -> b -> b) -> b -> MaybeWarnings' a -> b

foldr' :: (a -> b -> b) -> b -> MaybeWarnings' a -> b

foldl :: (b -> a -> b) -> b -> MaybeWarnings' a -> b

foldl' :: (b -> a -> b) -> b -> MaybeWarnings' a -> b

foldr1 :: (a -> a -> a) -> MaybeWarnings' a -> a

foldl1 :: (a -> a -> a) -> MaybeWarnings' a -> a

toList :: MaybeWarnings' a -> [a]

null :: MaybeWarnings' a -> Bool

length :: MaybeWarnings' a -> Int

elem :: Eq a => a -> MaybeWarnings' a -> Bool

maximum :: Ord a => MaybeWarnings' a -> a

minimum :: Ord a => MaybeWarnings' a -> a

sum :: Num a => MaybeWarnings' a -> a

product :: Num a => MaybeWarnings' a -> a

Traversable MaybeWarnings'

Methods

traverse :: Applicative f => (a -> f b) -> MaybeWarnings' a -> f (MaybeWarnings' b)

sequenceA :: Applicative f => MaybeWarnings' (f a) -> f (MaybeWarnings' a)

mapM :: Monad m => (a -> m b) -> MaybeWarnings' a -> m (MaybeWarnings' b)

sequence :: Monad m => MaybeWarnings' (m a) -> m (MaybeWarnings' a)

Null a => Null (MaybeWarnings' a)

Methods

empty :: MaybeWarnings' a

null :: MaybeWarnings' a -> Bool

type MaybeWarnings = MaybeWarnings' [TCWarning]

applyFlagsToMaybeWarnings :: IgnoreFlags -> MaybeWarnings -> TCM MaybeWarnings

hasWarnings :: MaybeWarnings -> Bool

alreadyVisited :: TopLevelModuleName -> MainInterface -> TCM (Interface, MaybeWarnings) -> TCM (Interface, MaybeWarnings)

If the module has already been visited (without warnings), then its interface is returned directly. Otherwise the computation is used to find the interface and the computed interface is stored for potential later use (unless the MainInterface is MainInterface ScopeCheck).

typeCheckMain :: AbsolutePath -> Mode -> TCM (Interface, MaybeWarnings)

Type checks the main file of the interaction. This could be the file loaded in the interacting editor (emacs), or the file passed on the command line.

First, the primitive modules are imported. Then, getInterface' is called to do the main work.

If the Mode is ScopeCheck, then type-checking is not performed, only scope-checking. (This may include type-checking of imported modules.) In this case the generated, partial interface is not stored in the state (stDecodedModules). Note, however, that if the file has already been type-checked, then a complete interface is returned.

getInterface :: ModuleName -> TCM Interface

Tries to return the interface associated to the given (imported) module. The time stamp of the relevant interface file is also returned. Calls itself recursively for the imports of the given module. May type check the module. An error is raised if a warning is encountered.

Do not use this for the main file, use typeCheckMain instead.

getInterface_ :: TopLevelModuleName -> TCM Interface

See getInterface.

getInterface' :: TopLevelModuleName -> MainInterface -> TCM (Interface, MaybeWarnings)

A more precise variant of getInterface. If warnings are encountered then they are returned instead of being turned into errors.

isCached

Arguments

:: TopLevelModuleName

Module name of file we process.

-> AbsolutePath

File we process.

-> MaybeT TCM Interface

Check whether interface file exists and is in cache in the correct version (as testified by the interface file hash).

getStoredInterface

Arguments

:: TopLevelModuleName

Module name of file we process.

-> AbsolutePath

File we process.

-> MainInterface

-> TCM (Bool, (Interface, MaybeWarnings))

Bool is: do we have to merge the interface?

Try to get the interface from interface file or cache.

typeCheck

Arguments

:: TopLevelModuleName

Module name of file we process.

-> AbsolutePath

File we process.

-> MainInterface

-> TCM (Bool, (Interface, MaybeWarnings))

Bool is: do we have to merge the interface?

Run the type checker on a file and create an interface.

Mostly, this function calls createInterface. But if it is not the main module we check, we do it in a fresh state, suitably initialize, in order to forget some state changes after successful type checking.

chaseMsg

Arguments

:: String

The prefix, like Checking, Finished, Loading .

-> TopLevelModuleName

The module name.

-> Maybe String

Optionally: the file name.

-> TCM ()

Formats and outputs the Checking, Finished and "Loading " messages.

highlightFromInterface

Arguments

:: Interface

-> AbsolutePath

The corresponding file.

-> TCM ()

Print the highlighting information contained in the given interface.

readInterface :: FilePath -> TCM (Maybe Interface)

writeInterface :: FilePath -> Interface -> TCM ()

Writes the given interface to the given file.

removePrivates :: ScopeInfo -> ScopeInfo

createInterface

Arguments

:: AbsolutePath

The file to type check.

-> TopLevelModuleName

The expected module name.

-> MainInterface

-> TCM (Interface, MaybeWarnings)

Tries to type check a module and write out its interface. The function only writes out an interface file if it does not encounter any warnings.

If appropriate this function writes out syntax highlighting information.

getAllWarnings' :: WhichWarnings -> IgnoreFlags -> TCM [TCWarning]

Collect all warnings that have accumulated in the state. Depending on the argument, we either respect the flags passed in by the user, or not (for instance when deciding if we are writing an interface file or not)

getAllWarnings :: WhichWarnings -> IgnoreFlags -> TCM MaybeWarnings

errorWarningsOfTCErr :: TCErr -> TCM [TCWarning]

constructIScope :: Interface -> Interface

Reconstruct the iScope (not serialized) from the iInsideScope (serialized).

buildInterface

Arguments

:: AbsolutePath

-> TopLevelInfo

TopLevelInfo for the current module.

-> HighlightingInfo

Syntax highlighting info for the module.

-> [OptionsPragma]

Options set in OPTIONS pragmas.

-> TCM Interface

Builds an interface for the current module, which should already have been successfully type checked.

getInterfaceFileHashes :: FilePath -> TCM (Maybe (Hash, Hash))

Returns (iSourceHash, iFullHash)

moduleHash :: ModuleName -> TCM Hash

isNewerThan :: FilePath -> FilePath -> IO Bool

True if the first file is newer than the second file. If a file doesn't exist it is considered to be infinitely old.