Agda.Unused.Monad.Reader

A reader monad for determining unused code.

Definition

data Mode where

A type indicating how checking should be done.

Constructors

Skip :: Mode

Check nothing.

Local :: Mode

Check private items only.

Global :: Mode

Check all items.

GlobalMain :: Mode

Check imports & reject all other declarations.

Instances

Eq Mode

Defined in Agda.Unused.Monad.Reader

Methods

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

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

Show Mode

Defined in Agda.Unused.Monad.Reader

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

data Environment

An environment type for use in a reader monad.

Constructors

Environment

Fields

• environmentMode :: !Mode

  The current check mode.

• environmentRoot :: !FilePath

  The project root path.

• environmentIncludes :: ![AbsolutePath]

  The include paths.

Instances

Show Environment

Defined in Agda.Unused.Monad.Reader

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

Ask

askSkip :: MonadReader Environment m => m Bool

Ask whether to skip checking names.

askLocal :: MonadReader Environment m => m Bool

Ask whether we are in local mode.

askGlobalMain :: MonadReader Environment m => m Bool

Ask whether we are in global main mode.

askRoot :: MonadReader Environment m => m FilePath

Ask for the project root path.

askIncludes :: MonadReader Environment m => m [AbsolutePath]

Ask for the include paths.

Local

localSkip :: MonadReader Environment m => m a -> m a

Perform a local computation, but skip checking names.

localGlobal :: MonadReader Environment m => m a -> m a

Perform a local computation in global mode.