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

Safe HaskellNone
LanguageHaskell98

Agda.TypeChecking.Monad.Base

Contents

Synopsis

Type checking state

data TCState Source

Constructors

TCSt 

Fields

stPreScopeState :: !PreScopeState

The state which is frozen after scope checking.

stPostScopeState :: !PostScopeState

The state which is modified after scope checking.

stPersistentState :: !PersistentTCState

State which is forever, like a diamond.

data PreScopeState Source

Constructors

PreScopeState 

Fields

stPreTokens :: CompressedFile

Highlighting info for tokens (but not those tokens for which highlighting exists in stSyntaxInfo).

stPreImports :: Signature

Imported declared identifiers. Those most not be serialized!

stPreImportedModules :: Set ModuleName
 
stPreModuleToSource :: ModuleToSource
 
stPreVisitedModules :: VisitedModules
 
stPreScope :: ScopeInfo
 
stPrePatternSyns :: PatternSynDefns

Pattern synonyms of the current file. Serialized.

stPrePatternSynImports :: PatternSynDefns

Imported pattern synonyms. Must not be serialized!

stPrePragmaOptions :: PragmaOptions

Options applying to the current file. OPTIONS pragmas only affect this field.

stPreImportedBuiltins :: BuiltinThings PrimFun
 
stPreHaskellImports :: Set String

Imports that should be generated by the compiler / MAlonzo (this includes imports from imported modules).

stPreHaskellImportsUHC :: Set String

Imports that should be generated by the compiler / UHC backend (this includes imports from imported modules).

stPreHaskellCode :: [String]

Inline Haskell code that should be inserted by the GHC backend

stPreFreshInteractionId :: !InteractionId
 

data PostScopeState Source

Constructors

PostScopeState 

Fields

stPostSyntaxInfo :: CompressedFile

Highlighting info.

stPostDisambiguatedNames :: !DisambiguatedNames

Disambiguation carried out by the type checker. Maps position of first name character to disambiguated QName for each AmbiguousQName already passed by the type checker.

stPostMetaStore :: MetaStore
 
stPostInteractionPoints :: InteractionPoints
 
stPostAwakeConstraints :: Constraints
 
stPostSleepingConstraints :: Constraints
 
stPostDirty :: Bool

Dirty when a constraint is added, used to prevent pointer update. Currently unused.

stPostOccursCheckDefs :: Set QName

Definitions to be considered during occurs check. Initialized to the current mutual block before the check. During occurs check, we remove definitions from this set as soon we have checked them.

stPostSignature :: Signature

Declared identifiers of the current file. These will be serialized after successful type checking.

stPostImportsDisplayForms :: !DisplayForms

Display forms we add for imported identifiers

stPostImportedDisplayForms :: !DisplayForms

Display forms added by someone else to imported identifiers

stPostCurrentModule :: Maybe ModuleName

The current module is available after it has been type checked.

stPostInstanceDefs :: TempInstanceTable
 
stPostStatistics :: Statistics

Counters to collect various statistics about meta variables etc. Only for current file.

stPostMutualBlocks :: Map MutualId (Set QName)
 
stPostLocalBuiltins :: BuiltinThings PrimFun
 
stPostFreshMetaId :: MetaId
 
stPostFreshMutualId :: MutualId
 
stPostFreshCtxId :: CtxId
 
stPostFreshProblemId :: ProblemId
 
stPostFreshInt :: Int
 
stPostFreshNameId :: NameId
 

data PersistentTCState Source

A part of the state which is not reverted when an error is thrown or the state is reset.

Constructors

PersistentTCSt 

Fields

stDecodedModules :: DecodedModules
 
stPersistentOptions :: CommandLineOptions
 
stInteractionOutputCallback :: InteractionOutputCallback

Callback function to call when there is a response to give to the interactive frontend. See the documentation of InteractionOutputCallback.

stBenchmark :: !Benchmark

Structure to track how much CPU time was spent on which Agda phase. Needs to be a strict field to avoid space leaks!

stAccumStatistics :: !Statistics

Should be strict field.

stLoadedFileCache :: !(Maybe LoadedFileCache)

Cached typechecking state from the last loaded file. Should be Nothing when checking imports.

type CachedTypeCheckLog = [(TypeCheckAction, PostScopeState)] Source

A log of what the type checker does and states after the action is completed. The cached version is stored first executed action first.

type CurrentTypeCheckLog = [(TypeCheckAction, PostScopeState)] Source

Like CachedTypeCheckLog, but storing the log for an ongoing type checking of a module. Stored in reverse order (last performed action first).

data TypeCheckAction Source

A complete log for a module will look like this:

  • Pragmas
  • EnterSection, entering the main module.
  • 'Decl'/'EnterSection'/'LeaveSection', for declarations and nested modules
  • LeaveSection, leaving the main module.

initPersistentState :: PersistentTCState Source

Empty persistent state.

initPreScopeState :: PreScopeState Source

Empty state of type checker.

st-prefixed lenses

Fresh things

fresh :: (HasFresh i, MonadState TCState m) => m i Source

freshName :: (MonadState TCState m, HasFresh NameId) => Range -> String -> m Name Source

freshNoName :: (MonadState TCState m, HasFresh NameId) => Range -> m Name Source

freshNoName_ :: (MonadState TCState m, HasFresh NameId) => m Name Source

class FreshName a where Source

Create a fresh name from a.

Methods

freshName_ :: (MonadState TCState m, HasFresh NameId) => a -> m Name Source

Managing file names

type ModuleToSource = Map TopLevelModuleName AbsolutePath Source

Maps top-level module names to the corresponding source file names.

type SourceToModule = Map AbsolutePath TopLevelModuleName Source

Maps source file names to the corresponding top-level module names.

Interface

data ModuleInfo Source

Constructors

ModuleInfo 

Fields

miInterface :: Interface
 
miWarnings :: Bool

True if warnings were encountered when the module was type checked.

data Interface Source

Constructors

Interface 

Fields

iSourceHash :: Hash

Hash of the source code.

iImportedModules :: [(ModuleName, Hash)]

Imported modules and their hashes.

iModuleName :: ModuleName

Module name of this interface.

iScope :: Map ModuleName Scope

Scope defined by this module.

iInsideScope :: ScopeInfo

Scope after we loaded this interface. Used in AtTopLevel and interactionLoop.

Andreas, AIM XX: For performance reason, this field is not serialized, so if you deserialize an interface, iInsideScope will be empty. You need to type-check the file to get iInsideScope.

iSignature :: Signature
 
iDisplayForms :: DisplayForms

Display forms added for imported identifiers.

iBuiltin :: BuiltinThings (String, QName)
 
iHaskellImports :: Set String

Haskell imports listed in (transitively) imported modules are not included here.

iHaskellImportsUHC :: Set String

Haskell imports listed in (transitively) imported modules are not included here.

iHaskellCode :: [String]

Inline Haskell code

iHighlighting :: HighlightingInfo
 
iPragmaOptions :: [OptionsPragma]

Pragma options set in the file.

iPatternSyns :: PatternSynDefns
 

iFullHash :: Interface -> Hash Source

Combines the source hash and the (full) hashes of the imported modules.

Closure

Constraints

data Constraint Source

Constructors

ValueCmp Comparison Type Term Term 
ElimCmp [Polarity] Type Term [Elim] [Elim] 
TypeCmp Comparison Type Type 
TelCmp Type Type Comparison Telescope Telescope

the two types are for the error message only

SortCmp Comparison Sort Sort 
LevelCmp Comparison Level Level 
UnBlock MetaId 
Guarded Constraint ProblemId 
IsEmpty Range Type

The range is the one of the absurd pattern.

CheckSizeLtSat Term

Check that the Term is either not a SIZELT or a non-empty SIZELT.

FindInScope MetaId (Maybe MetaId) (Maybe [Candidate])

the first argument is the instance argument, the second one is the meta on which the constraint may be blocked on and the third one is the list of candidates (or Nothing if we haven’t determined the list of candidates yet)

flipCmp :: CompareDirection -> CompareDirection Source

Flip the direction of comparison.

dirToCmp :: (Comparison -> a -> a -> c) -> CompareDirection -> a -> a -> c Source

Turn a Comparison function into a CompareDirection function.

Property: dirToCmp f (fromCmp cmp) = f cmp

Open things

data Open a Source

A thing tagged with the context it came from.

Constructors

OpenThing 

Fields

openThingCtxIds :: [CtxId]
 
openThing :: a
 

Judgements

data Judgement a Source

Parametrized since it is used without MetaId when creating a new meta.

Constructors

HasType 

Fields

jMetaId :: a
 
jMetaType :: Type
 
IsSort 

Fields

jMetaId :: a
 
jMetaType :: Type
 

Meta variables

data MetaVariable Source

Constructors

MetaVar 

Fields

mvInfo :: MetaInfo
 
mvPriority :: MetaPriority

some metavariables are more eager to be instantiated

mvPermutation :: Permutation

a metavariable doesn't have to depend on all variables in the context, this "permutation" will throw away the ones it does not depend on

mvJudgement :: Judgement MetaId
 
mvInstantiation :: MetaInstantiation
 
mvListeners :: Set Listener

meta variables scheduled for eta-expansion but blocked by this one

mvFrozen :: Frozen

are we past the point where we can instantiate this meta variable?

data Frozen Source

Frozen meta variable cannot be instantiated by unification. This serves to prevent the completion of a definition by its use outside of the current block. (See issues 118, 288, 399).

Constructors

Frozen

Do not instantiate.

Instantiable 

data MetaInstantiation Source

Constructors

InstV [Arg String] Term

solved by term (abstracted over some free variables)

InstS Term

solved by Lam .. Sort s

Open

unsolved

OpenIFS

open, to be instantiated as "implicit from scope"

BlockedConst Term

solution blocked by unsolved constraints

PostponedTypeCheckingProblem (Closure TypeCheckingProblem) (TCM Bool) 

data TypeCheckingProblem Source

Constructors

CheckExpr Expr Type 
CheckArgs ExpandHidden Range [NamedArg Expr] Type Type (Args -> Type -> TCM Term) 
CheckLambda (Arg ([WithHiding Name], Maybe Type)) Expr Type

(λ (xs : t₀) → e) : t This is not an instance of CheckExpr as the domain type has already been checked. For example, when checking (λ (x y : Fin _) → e) : (x : Fin n) → ? we want to postpone (λ (y : Fin n) → e) : ? where Fin n is a Type rather than an Expr.

UnquoteTactic Term Term Type

First argument is computation and the others are hole and goal type

newtype MetaPriority Source

Meta variable priority: When we have an equation between meta-variables, which one should be instantiated?

Higher value means higher priority to be instantiated.

Constructors

MetaPriority Int 

data MetaInfo Source

MetaInfo is cloned from one meta to the next during pruning.

Constructors

MetaInfo 

Fields

miClosRange :: Closure Range
 
miMetaOccursCheck :: RunMetaOccursCheck

Run the extended occurs check that goes in definitions?

miNameSuggestion :: MetaNameSuggestion

Used for printing. Just x if meta-variable comes from omitted argument with name x.

type MetaNameSuggestion = String Source

Name suggestion for meta variable. Empty string means no suggestion.

data NamedMeta Source

For printing, we couple a meta with its name suggestion.

Interaction meta variables

data InteractionPoint Source

Interaction points are created by the scope checker who sets the range. The meta variable is created by the type checker and then hooked up to the interaction point.

Constructors

InteractionPoint 

Fields

ipRange :: Range

The position of the interaction point.

ipMeta :: Maybe MetaId

The meta variable, if any, holding the type etc.

type InteractionPoints = Map InteractionId InteractionPoint Source

Data structure managing the interaction points.

Signature

data DisplayForm Source

A DisplayForm is in essence a rewrite rule q ts --> dt for a defined symbol (could be a constructor as well) q. The right hand side is a DisplayTerm which is used to reify to a more readable Syntax.

The patterns ts are just terms, but var 0 is interpreted as a hole. Each occurrence of var 0 is a new hole (pattern var). For each *occurrence* of var0 the rhs dt has a free variable. These are instantiated when matching a display form against a term q vs succeeds.

Constructors

Display 

Fields

dfFreeVars :: Nat

Number n of free variables in dfRHS.

dfPats :: [Term]

Left hand side patterns, where var 0 stands for a pattern variable. There should be n occurrences of var0 in dfPats.

dfRHS :: DisplayTerm

Right hand side, with n free variables.

data DisplayTerm Source

A structured presentation of a Term for reification into Syntax.

Constructors

DWithApp DisplayTerm [DisplayTerm] Args

(f vs | ws) us. The first DisplayTerm is the parent function f with its args vs. The list of DisplayTerms are the with expressions ws. The Args are additional arguments us (possible in case the with-application is of function type).

DCon ConHead [Arg DisplayTerm]

c vs.

DDef QName [Elim' DisplayTerm]

d vs.

DDot Term

.v.

DTerm Term

v.

defaultDisplayForm :: QName -> [Open DisplayForm] Source

By default, we have no display form.

data NLPat Source

Non-linear (non-constructor) first-order pattern.

Constructors

PVar (Maybe CtxId) !Int

Matches anything (modulo non-linearity).

PWild

Matches anything (e.g. irrelevant terms).

PDef QName PElims

Matches f es

PLam ArgInfo (Abs NLPat)

Matches λ x → t

PPi (Dom (Type' NLPat)) (Abs (Type' NLPat))

Matches (x : A) → B

PBoundVar !Int PElims

Matches x es where x is a lambda-bound variable

PTerm Term

Matches the term modulo β (ideally βη).

data RewriteRule Source

Rewrite rules can be added independently from function clauses.

Constructors

RewriteRule 

Fields

rewName :: QName

Name of rewrite rule q : Γ → lhs ≡ rhs where is the rewrite relation.

rewContext :: Telescope

Γ.

rewLHS :: NLPat

Γ ⊢ lhs : t.

rewRHS :: Term

Γ ⊢ rhs : t.

rewType :: Type

Γ ⊢ t.

Instances

Show RewriteRule Source 
KillRange RewriteRule Source 
KillRange RewriteRuleMap Source 
Abstract RewriteRule Source

tel ⊢ (Γ ⊢ lhs ↦ rhs : t) becomes tel, Γ ⊢ lhs ↦ rhs : t) we do not need to change lhs, rhs, and t since they live in Γ. See 'Abstract Clause'.

Apply RewriteRule Source 
PrettyTCM RewriteRule Source 
InstantiateFull RewriteRule Source 
KillCtxId RewriteRule Source 
Subst Term RewriteRule Source 

data Definition Source

Constructors

Defn 

Fields

defArgInfo :: ArgInfo

Hiding should not be used.

defName :: QName
 
defType :: Type

Type of the lifted definition.

defPolarity :: [Polarity]

Variance information on arguments of the definition. Does not include info for dropped parameters to projection(-like) functions and constructors.

defArgOccurrences :: [Occurrence]

Positivity information on arguments of the definition. Does not include info for dropped parameters to projection(-like) functions and constructors.

defDisplay :: [Open DisplayForm]
 
defMutual :: MutualId
 
defCompiledRep :: CompiledRepresentation
 
defInstance :: Maybe QName

Just q when this definition is an instance of class q

defCopy :: Bool

Has this function been created by a module instantiation?

theDef :: Defn
 

defaultDefn :: ArgInfo -> QName -> Type -> Defn -> Definition Source

Create a definition with sensible defaults.

data CoreRepresentation Source

Constructors

CrDefn CoreExpr

Core code for functions.

CrType CoreType

Core type for agda type.

CrConstr CoreConstr

Core constructor for agda constructor.

data Polarity Source

Polarity for equality and subtype checking.

Constructors

Covariant

monotone

Contravariant

antitone

Invariant

no information (mixed variance)

Nonvariant

constant

data ExtLamInfo Source

Additional information for extended lambdas.

Constructors

ExtLamInfo 

data Projection Source

Additional information for projection Functions.

Constructors

Projection 

Fields

projProper :: Maybe QName

Nothing if only projection-like, Just q if record projection, where q is the original projection name (current name could be from module app).

projFromType :: QName

Type projected from. Record type if projProper = Just{}.

projIndex :: Int

Index of the record argument. Start counting with 1, because 0 means that it is already applied to the record value. This can happen in module instantiation, but then either the record value is var 0, or funProjection == Nothing.

projDropPars :: Term

Term t to be be applied to record parameters and record value. The parameters will be dropped. In case of a proper projection, a postfix projection application will be created: t = pars r -> r .p (Invariant: the number of abstractions equals projIndex.) In case of a projection-like function, just the function symbol is returned as Def: t = pars -> f.

projArgInfo :: ArgInfo

The info of the principal (record) argument.

data Defn Source

Constructors

Axiom

Postulate.

Function 

Fields

funClauses :: [Clause]
 
funCompiled :: Maybe CompiledClauses

Nothing while function is still type-checked. Just cc after type and coverage checking and translation to case trees.

funTreeless :: Maybe Compiled

Intermediate representation for compiler backends.

funInv :: FunctionInverse
 
funMutual :: [QName]

Mutually recursive functions, datas and records. Does not include this function.

funAbstr :: IsAbstract
 
funDelayed :: Delayed

Are the clauses of this definition delayed?

funProjection :: Maybe Projection

Is it a record projection? If yes, then return the name of the record type and index of the record argument. Start counting with 1, because 0 means that it is already applied to the record. (Can happen in module instantiation.) This information is used in the termination checker.

funStatic :: Bool

Should calls to this function be normalised at compile-time?

funInline :: Bool

Should calls to this function be inlined by the compiler?

funSmashable :: Bool

Are we allowed to smash this function?

funTerminates :: Maybe Bool

Has this function been termination checked? Did it pass?

funExtLam :: Maybe ExtLamInfo

Is this function generated from an extended lambda? If yes, then return the number of hidden and non-hidden lambda-lifted arguments

funWith :: Maybe QName

Is this a generated with-function? If yes, then what's the name of the parent function.

funCopatternLHS :: Bool

Is this a function defined by copatterns?

Datatype 

Fields

dataPars :: Nat

Number of parameters.

dataSmallPars :: Permutation

Parameters that are maybe small.

dataNonLinPars :: Drop Permutation

Parameters that appear in indices.

dataIxs :: Nat

Number of indices.

dataInduction :: Induction

data or codata (legacy).

dataClause :: Maybe Clause

This might be in an instantiated module.

dataCons :: [QName]

Constructor names.

dataSort :: Sort
 
dataMutual :: [QName]

Mutually recursive functions, datas and records. Does not include this data type.

dataAbstr :: IsAbstract
 
Record 

Fields

recPars :: Nat

Number of parameters.

recClause :: Maybe Clause
 
recConHead :: ConHead

Constructor name and fields.

recNamedCon :: Bool
 
recConType :: Type

The record constructor's type. (Includes record parameters.)

recFields :: [Arg QName]
 
recTel :: Telescope

The record field telescope. (Includes record parameters.) Note: TelV recTel _ == telView' recConType. Thus, recTel is redundant.

recMutual :: [QName]

Mutually recursive functions, datas and records. Does not include this record.

recEtaEquality' :: EtaEquality

Eta-expand at this record type. False for unguarded recursive records and coinductive records unless the user specifies otherwise.

recInduction :: Maybe Induction

Inductive or CoInductive? Matters only for recursive records. Nothing means that the user did not specify it, which is an error for recursive records.

recRecursive :: Bool

Recursive record. Infers recEtaEquality = False. Projections are not size-preserving.

recAbstr :: IsAbstract
 
Constructor 

Fields

conPars :: Nat

Number of parameters.

conSrcCon :: ConHead

Name of (original) constructor and fields. (This might be in a module instance.)

conData :: QName

Name of datatype or record type.

conAbstr :: IsAbstract
 
conInd :: Induction

Inductive or coinductive?

Primitive

Primitive or builtin functions.

Fields

primAbstr :: IsAbstract
 
primName :: String
 
primClauses :: [Clause]

null for primitive functions, not null for builtin functions.

primCompiled :: Maybe CompiledClauses

Nothing for primitive functions, Just something for builtin functions.

emptyFunction :: Defn Source

A template for creating Function definitions, with sensible defaults.

isEmptyFunction :: Defn -> Bool Source

Checking whether we are dealing with a function yet to be defined.

newtype Fields Source

Constructors

Fields [(Name, Type)] 

Instances

data Simplification Source

Did we encounter a simplifying reduction? In terms of CIC, that would be a iota-reduction. In terms of Agda, this is a constructor or literal pattern that matched. Just beta-reduction (substitution) or delta-reduction (unfolding of definitions) does not count as simplifying?

data Reduced no yes Source

Instances

data IsReduced Source

Three cases: 1. not reduced, 2. reduced, but blocked, 3. reduced, not blocked.

Constructors

NotReduced 
Reduced (Blocked ()) 

data AllowedReduction Source

Controlling reduce.

Constructors

ProjectionReductions

(Projection and) projection-like functions may be reduced.

InlineReductions

Functions marked INLINE may be reduced.

CopatternReductions

Copattern definitions may be reduced.

FunctionReductions

Functions which are not projections may be reduced.

LevelReductions

Reduce Level terms.

NonTerminatingReductions

Functions that have not passed termination checking.

allReductions :: AllowedReductions Source

Not quite all reductions (skip non-terminating reductions)

defDelayed :: Definition -> Delayed Source

Are the clauses of this definition delayed?

defNonterminating :: Definition -> Bool Source

Has the definition failed the termination checker?

defAbstract :: Definition -> IsAbstract Source

Beware when using this function on a def obtained with getConstInfo q! If the identifier q is abstract, getConstInfo will turn its def into an Axiom and you always get ConcreteDef, paradoxically. Use it in IgnoreAbstractMode, like this: a ignoreAbstractMode $ defAbstract <$ getConstInfo q

Injectivity

Mutual blocks

Statistics

Trace

Instance table

type InstanceTable = Map QName [QName] Source

The instance table is a Map associating to every name of recorddata typepostulate its list of instances

type TempInstanceTable = (InstanceTable, [QName]) Source

When typechecking something of the following form:

instance x : _ x = y

it's not yet known where to add x, so we add it to a list of unresolved instances and we'll deal with it later.

Builtin things

data BuiltinDescriptor Source

Constructors

BuiltinData (TCM Type) [String] 
BuiltinDataCons (TCM Type) 
BuiltinPrim String (Term -> TCM ()) 
BuiltinPostulate Relevance (TCM Type) 
BuiltinUnknown (Maybe (TCM Type)) (Term -> Type -> TCM ())

Builtin of any kind. Type can be checked (Just t) or inferred (Nothing). The second argument is the hook for the verification function.

Highlighting levels

data HighlightingLevel Source

How much highlighting should be sent to the user interface?

Constructors

None 
NonInteractive 
Interactive

This includes both non-interactive highlighting and interactive highlighting of the expression that is currently being type-checked.

data HighlightingMethod Source

How should highlighting be sent to the user interface?

Constructors

Direct

Via stdout.

Indirect

Both via files and via stdout.

ifTopLevelAndHighlightingLevelIs :: MonadTCM tcm => HighlightingLevel -> tcm () -> tcm () Source

ifTopLevelAndHighlightingLevelIs l m runs m when we're type-checking the top-level module and the highlighting level is at least l.

Type checking environment

data TCEnv Source

Constructors

TCEnv 

Fields

envContext :: Context
 
envLetBindings :: LetBindings
 
envCurrentModule :: ModuleName
 
envCurrentPath :: Maybe AbsolutePath

The path to the file that is currently being type-checked. Nothing if we do not have a file (like in interactive mode see CommandLine).

envAnonymousModules :: [(ModuleName, Nat)]

anonymous modules and their number of free variables

envImportPath :: [TopLevelModuleName]

to detect import cycles

envMutualBlock :: Maybe MutualId

the current (if any) mutual block

envTerminationCheck :: TerminationCheck ()

are we inside the scope of a termination pragma

envSolvingConstraints :: Bool

Are we currently in the process of solving active constraints?

envCheckingWhere :: Bool

Have we stepped into the where-declarations of a clause? Everything under a where will be checked with this flag on.

envAssignMetas :: Bool

Are we allowed to assign metas?

envActiveProblems :: [ProblemId]
 
envAbstractMode :: AbstractMode

When checking the typesignature of a public definition or the body of a non-abstract definition this is true. To prevent information about abstract things leaking outside the module.

envRelevance :: Relevance

Are we checking an irrelevant argument? (=Irrelevant) Then top-level irrelevant declarations are enabled. Other value: Relevant, then only relevant decls. are avail.

envDisplayFormsEnabled :: Bool

Sometimes we want to disable display forms.

envReifyInteractionPoints :: Bool

should we try to recover interaction points when reifying? disabled when generating types for with functions

envEtaContractImplicit :: Bool

it's safe to eta contract implicit lambdas as long as we're not going to reify and retypecheck (like when doing with abstraction)

envRange :: Range
 
envHighlightingRange :: Range

Interactive highlighting uses this range rather than envRange.

envCall :: Maybe (Closure Call)

what we're doing at the moment

envHighlightingLevel :: HighlightingLevel

Set to None when imported modules are type-checked.

envHighlightingMethod :: HighlightingMethod
 
envModuleNestingLevel :: Integer

This number indicates how far away from the top-level module Agda has come when chasing modules. The level of a given module is not necessarily the same as the length, in the module dependency graph, of the shortest path from the top-level module; it depends on in which order Agda chooses to chase dependencies.

envAllowDestructiveUpdate :: Bool

When True, allows destructively shared updating terms during evaluation or unification. This is disabled when doing speculative checking, like solve instance metas, or when updating might break abstraction, as is the case when checking abstract definitions.

envExpandLast :: ExpandHidden

When type-checking an alias f=e, we do not want to insert hidden arguments in the end, because these will become unsolved metas.

envAppDef :: Maybe QName

We are reducing an application of this function. (For debugging of incomplete matches only.)

envSimplification :: Simplification

Did we encounter a simplification (proper match) during the current reduction process?

envAllowedReductions :: AllowedReductions
 
envCompareBlocked :: Bool

Can we compare blocked things during conversion? No by default. Yes for rewriting feature.

envPrintDomainFreePi :: Bool

When True types will be omitted from printed pi types if they can be inferred

envInsideDotPattern :: Bool

Used by the scope checker to make sure that certain forms of expressions are not used inside dot patterns: extended lambdas and let-expressions.

Instances

MonadReader TCEnv ReduceM Source 
MonadReader TCEnv TerM 
MonadIO m => MonadReader TCEnv (TCMT m) Source 

Context

type Context = [ContextEntry] Source

The Context is a stack of ContextEntrys.

data ContextEntry Source

Constructors

Ctx 

Fields

ctxId :: CtxId
 
ctxEntry :: Dom (Name, Type)
 

Let bindings

Abstract mode

data AbstractMode Source

Constructors

AbstractMode

Abstract things in the current module can be accessed.

ConcreteMode

No abstract things can be accessed.

IgnoreAbstractMode

All abstract things can be accessed.

Insertion of implicit arguments

data ExpandHidden Source

Constructors

ExpandLast

Add implicit arguments in the end until type is no longer hidden Pi.

DontExpandLast

Do not append implicit arguments.

data ExplicitToInstance Source

Constructors

ExplicitToInstance

Explicit arguments are considered as instance arguments

ExplicitStayExplicit 

data Candidate Source

A candidate solution for an instance meta is a term with its type. It may be the case that the candidate is not fully applied yet or of the wrong type, hence the need for the type.

Type checking errors

data CallInfo Source

Information about a call.

Constructors

CallInfo 

Fields

callInfoTarget :: QName

Target function name.

callInfoRange :: Range

Range of the target function.

callInfoCall :: Closure Term

To be formatted representation of the call.

Instances

data TerminationError Source

Information about a mutual block which did not pass the termination checker.

Constructors

TerminationError 

Fields

termErrFunctions :: [QName]

The functions which failed to check. (May not include automatically generated functions.)

termErrCalls :: [CallInfo]

The problematic call sites.

data SplitError Source

Error when splitting a pattern variable into possible constructor patterns.

Constructors

NotADatatype (Closure Type)

Neither data type nor record.

IrrelevantDatatype (Closure Type)

Data type, but in irrelevant position.

CoinductiveDatatype (Closure Type)

Split on codata not allowed. UNUSED, but keep! -- | NoRecordConstructor Type -- ^ record type, but no constructor

CantSplit 

Fields

cantSplitConName :: QName

Constructor.

cantSplitTel :: Telescope

Context for indices.

cantSplitConIdx :: Args

Inferred indices (from type of constructor).

cantSplitGivenIdx :: Args

Expected indices (from checking pattern).

GenericSplitError String 

data TypeError Source

Constructors

InternalError String 
NotImplemented String 
NotSupported String 
CompilationError String 
TerminationCheckFailed [TerminationError] 
PropMustBeSingleton 
DataMustEndInSort Term 
ShouldEndInApplicationOfTheDatatype Type

The target of a constructor isn't an application of its datatype. The Type records what it does target.

ShouldBeAppliedToTheDatatypeParameters Term Term

The target of a constructor isn't its datatype applied to something that isn't the parameters. First term is the correct target and the second term is the actual target.

ShouldBeApplicationOf Type QName

Expected a type to be an application of a particular datatype.

ConstructorPatternInWrongDatatype QName QName

constructor, datatype

IndicesNotConstructorApplications [Arg Term]

Indices.

IndexVariablesNotDistinct [Nat] [Arg Term]

Variables, indices.

IndicesFreeInParameters [Nat] [Arg Term] [Arg Term]

Indices (variables), index expressions (with constructors applied to reconstructed parameters), parameters.

CantResolveOverloadedConstructorsTargetingSameDatatype QName [QName]

Datatype, constructors.

DoesNotConstructAnElementOf QName Type

constructor, type

DifferentArities

Varying number of arguments for a function.

WrongHidingInLHS

The left hand side of a function definition has a hidden argument where a non-hidden was expected.

WrongHidingInLambda Type

Expected a non-hidden function and found a hidden lambda.

WrongHidingInApplication Type

A function is applied to a hidden argument where a non-hidden was expected.

WrongNamedArgument (NamedArg Expr)

A function is applied to a hidden named argument it does not have.

WrongIrrelevanceInLambda Type

Expected a relevant function and found an irrelevant lambda.

WrongInstanceDeclaration

A term is declared as an instance but it’s not allowed

HidingMismatch Hiding Hiding

The given hiding does not correspond to the expected hiding.

RelevanceMismatch Relevance Relevance

The given relevance does not correspond to the expected relevane.

NotInductive Term

The term does not correspond to an inductive data type.

UninstantiatedDotPattern Expr 
IlltypedPattern Pattern Type 
IllformedProjectionPattern Pattern 
CannotEliminateWithPattern (NamedArg Pattern) Type 
TooManyArgumentsInLHS Type 
WrongNumberOfConstructorArguments QName Nat Nat 
ShouldBeEmpty Type [Pattern] 
ShouldBeASort Type

The given type should have been a sort.

ShouldBePi Type

The given type should have been a pi.

ShouldBeRecordType Type 
ShouldBeRecordPattern Pattern 
NotAProjectionPattern (NamedArg Pattern) 
NotAProperTerm 
SetOmegaNotValidType 
InvalidTypeSort Sort

This sort is not a type expression.

InvalidType Term

This term is not a type expression.

FunctionTypeInSizeUniv Term

This term, a function type constructor, lives in SizeUniv, which is not allowed.

SplitOnIrrelevant Pattern (Dom Type) 
DefinitionIsIrrelevant QName 
VariableIsIrrelevant Name 
UnequalTerms Comparison Term Term Type 
UnequalTypes Comparison Type Type 
UnequalRelevance Comparison Term Term

The two function types have different relevance.

UnequalHiding Term Term

The two function types have different hiding.

UnequalSorts Sort Sort 
UnequalBecauseOfUniverseConflict Comparison Term Term 
HeterogeneousEquality Term Type Term Type

We ended up with an equality constraint where the terms have different types. This is not supported.

NotLeqSort Sort Sort 
MetaCannotDependOn MetaId [Nat] Nat

The arguments are the meta variable, the parameters it can depend on and the paratemeter that it wants to depend on.

MetaOccursInItself MetaId 
GenericError String 
GenericDocError Doc 
BuiltinMustBeConstructor String Expr 
NoSuchBuiltinName String 
DuplicateBuiltinBinding String Term Term 
NoBindingForBuiltin String 
NoSuchPrimitiveFunction String 
ShadowedModule Name [ModuleName] 
BuiltinInParameterisedModule String 
IllegalLetInTelescope TypedBinding 
NoRHSRequiresAbsurdPattern [NamedArg Pattern] 
AbsurdPatternRequiresNoRHS [NamedArg Pattern] 
TooFewFields QName [Name] 
TooManyFields QName [Name] 
DuplicateFields [Name] 
DuplicateConstructors [Name] 
WithOnFreeVariable Expr 
UnexpectedWithPatterns [Pattern] 
WithClausePatternMismatch Pattern Pattern 
FieldOutsideRecord 
ModuleArityMismatch ModuleName Telescope [NamedArg Expr] 
IncompletePatternMatching Term [Elim] 
CoverageFailure QName [[Arg DeBruijnPattern]] 
UnreachableClauses QName [[Arg DeBruijnPattern]] 
CoverageCantSplitOn QName Telescope Args Args 
CoverageCantSplitIrrelevantType Type 
CoverageCantSplitType Type 
CoverageNoExactSplit QName Clause 
WithoutKError Type Term Term 
UnifyConflict ConHead ConHead 
UnifyCycle Int Term 
UnifyIndicesNotVars Type Term Term Args 
UnificationRecursiveEq Type Int Term 
UnificationStuck Telescope [Term] [Term] 
SplitError SplitError 
NotStrictlyPositive QName [Occ] 
LocalVsImportedModuleClash ModuleName 
UnsolvedMetas [Range] 
UnsolvedConstraints Constraints 
SolvedButOpenHoles

Some interaction points (holes) have not be filled by user. There are not UnsolvedMetas since unification solved them. This is an error, since interaction points are never filled without user interaction.

CyclicModuleDependency [TopLevelModuleName] 
FileNotFound TopLevelModuleName [AbsolutePath] 
OverlappingProjects AbsolutePath TopLevelModuleName TopLevelModuleName 
AmbiguousTopLevelModuleName TopLevelModuleName [AbsolutePath] 
ModuleNameDoesntMatchFileName TopLevelModuleName [AbsolutePath] 
ClashingFileNamesFor ModuleName [AbsolutePath] 
ModuleDefinedInOtherFile TopLevelModuleName AbsolutePath AbsolutePath

Module name, file from which it was loaded, file which the include path says contains the module. Scope errors

BothWithAndRHS 
NotInScope [QName] 
NoSuchModule QName 
AmbiguousName QName [QName] 
AmbiguousModule QName [ModuleName] 
UninstantiatedModule QName 
ClashingDefinition QName QName 
ClashingModule ModuleName ModuleName 
ClashingImport Name QName 
ClashingModuleImport Name ModuleName 
PatternShadowsConstructor Name QName 
ModuleDoesntExport QName [ImportedName] 
DuplicateImports QName [ImportedName] 
InvalidPattern Pattern 
RepeatedVariablesInPattern [Name] 
NotAModuleExpr Expr

The expr was used in the right hand side of an implicit module definition, but it wasn't of the form m Delta.

NotAnExpression Expr 
NotAValidLetBinding NiceDeclaration 
NothingAppliedToHiddenArg Expr 
NothingAppliedToInstanceArg Expr 
BadArgumentsToPatternSynonym QName 
TooFewArgumentsToPatternSynonym QName 
UnusedVariableInPatternSynonym 
NoParseForApplication [Expr] 
AmbiguousParseForApplication [Expr] [Expr] 
NoParseForLHS LHSOrPatSyn Pattern 
AmbiguousParseForLHS LHSOrPatSyn Pattern [Pattern] 
OperatorInformation [NotationSection] TypeError 
OperatorChangeMessage TypeError 
IFSNoCandidateInScope Type 
UnquoteFailed UnquoteError 
SafeFlagPostulate Name 
SafeFlagPragma [String] 
SafeFlagNonTerminating 
SafeFlagTerminating 
SafeFlagPrimTrustMe 
SafeFlagNoPositivityCheck 
NeedOptionCopatterns 
NeedOptionRewriting 

Instances

data LHSOrPatSyn Source

Distinguish error message when parsing lhs or pattern synonym, resp.

Constructors

IsLHS 
IsPatSyn 

The reduce monad

data ReduceEnv Source

Environment of the reduce monad.

Constructors

ReduceEnv 

Fields

redEnv :: TCEnv

Read only access to environment.

redSt :: TCState

Read only access to state (signature, metas...).

runReduceF :: (a -> ReduceM b) -> TCM (a -> b) Source

Type checking monad transformer

newtype TCMT m a Source

Constructors

TCM 

Fields

unTCM :: IORef TCState -> TCEnv -> m a
 

Instances

MonadTrans TCMT Source 
MonadError TCErr IM Source 
MonadBench Phase TCM Source

We store benchmark statistics in an IORef. This enables benchmarking pure computation, see Agda.Benchmarking.

MonadIO m => MonadState TCState (TCMT m) Source 
MonadIO m => MonadReader TCEnv (TCMT m) Source 
MonadError TCErr (TCMT IO) Source 
MonadIO m => Monad (TCMT m) Source 
MonadIO m => Functor (TCMT m) Source 
MonadIO m => Applicative (TCMT m) Source 
Monoid (TCM Any) Source

Short-cutting disjunction forms a monoid.

MonadIO m => MonadIO (TCMT m) Source 
Null (TCM Doc) Source 
MonadIO m => MonadTCM (TCMT m) Source 
MonadIO m => ReadTCState (TCMT m) Source 
MonadIO m => HasBuiltins (TCMT m) Source 
MonadIO m => HasOptions (TCMT m) Source 
HasConstInfo (TCMT IO) Source 

type TCM = TCMT IO Source

class (Applicative tcm, MonadIO tcm, MonadReader TCEnv tcm, MonadState TCState tcm) => MonadTCM tcm where Source

Methods

liftTCM :: TCM a -> tcm a Source

Instances

type IM = TCMT (InputT IO) Source

Interaction monad.

runIM :: IM a -> TCM a Source

catchError_ :: TCM a -> (TCErr -> TCM a) -> TCM a Source

Preserve the state of the failing computation.

finally_ :: TCM a -> TCM b -> TCM a Source

Execute a finalizer even when an exception is thrown. Does not catch any errors. In case both the regular computation and the finalizer throw an exception, the one of the finalizer is propagated.

mapTCMT :: (forall a. m a -> n a) -> TCMT m a -> TCMT n a Source

pureTCM :: MonadIO m => (TCState -> TCEnv -> a) -> TCMT m a Source

returnTCMT :: MonadIO m => a -> TCMT m a Source

bindTCMT :: MonadIO m => TCMT m a -> (a -> TCMT m b) -> TCMT m b Source

thenTCMT :: MonadIO m => TCMT m a -> TCMT m b -> TCMT m b Source

fmapTCMT :: MonadIO m => (a -> b) -> TCMT m a -> TCMT m b Source

apTCMT :: MonadIO m => TCMT m (a -> b) -> TCMT m a -> TCMT m b Source

internalError :: MonadTCM tcm => String -> tcm a Source

genericError :: MonadTCM tcm => String -> tcm a Source

typeError :: MonadTCM tcm => TypeError -> tcm a Source

runTCM :: MonadIO m => TCEnv -> TCState -> TCMT m a -> m (a, TCState) Source

Running the type checking monad (most general form).

runTCMTop :: TCM a -> IO (Either TCErr a) Source

Running the type checking monad on toplevel (with initial state).

runTCMTop' :: MonadIO m => TCMT m a -> m a Source

runSafeTCM :: TCM a -> TCState -> IO (a, TCState) Source

runSafeTCM runs a safe TCM action (a TCM action which cannot fail) in the initial environment.

forkTCM :: TCM a -> TCM () Source

Runs the given computation in a separate thread, with a copy of the current state and environment.

Note that Agda sometimes uses actual, mutable state. If the computation given to forkTCM tries to modify this state, then bad things can happen, because accesses are not mutually exclusive. The forkTCM function has been added mainly to allow the thread to read (a snapshot of) the current state in a convenient way.

Note also that exceptions which are raised in the thread are not propagated to the parent, so the thread should not do anything important.

extendedLambdaName :: String Source

Base name for extended lambda patterns

absurdLambdaName :: String Source

Name of absurdLambda definitions.

isAbsurdLambdaName :: QName -> Bool Source

Check whether we have an definition from an absurd lambda.

KillRange instances