| Copyright | License : BSD3 |
|---|---|
| Maintainer | The Idris Community. |
| Safe Haskell | None |
| Language | Haskell98 |
Idris.Core.TT
Description
TT is the core language of Idris. The language has:
- Full dependent types
- A hierarchy of universes, with cumulativity: Type : Type1, Type1 : Type2, ...
- Pattern matching letrec binding
- (primitive types defined externally)
Some technical stuff:
- Typechecker is kept as simple as possible - no unification, just a checker for incomplete terms.
- We have a simple collection of tactics which we use to elaborate source programs with implicit syntax into fully explicit terms.
- data AppStatus n
- = Complete
- | MaybeHoles
- | Holes [n]
- data ArithTy
- data Binder b
- data Const
- type Ctxt a = Map Name (Map Name a)
- data ConstraintFC = ConstraintFC {
- uconstraint :: UConstraint
- ufc :: FC
- data DataOpt
- type DataOpts = [DataOpt]
- data Datatype n = Data {}
- type Env = EnvTT Name
- type EnvTT n = [(n, Binder (TT n))]
- type Err = Err' Term
- data Err' t
- = Msg String
- | InternalMsg String
- | CantUnify Bool (t, Maybe Provenance) (t, Maybe Provenance) (Err' t) [(Name, t)] Int
- | InfiniteUnify Name t [(Name, t)]
- | CantConvert t t [(Name, t)]
- | CantSolveGoal t [(Name, t)]
- | UnifyScope Name Name t [(Name, t)]
- | CantInferType String
- | NonFunctionType t t
- | NotEquality t t
- | TooManyArguments Name
- | CantIntroduce t
- | NoSuchVariable Name
- | WithFnType t
- | NoTypeDecl Name
- | NotInjective t t t
- | CantResolve Bool t (Err' t)
- | InvalidTCArg Name t
- | CantResolveAlts [Name]
- | NoValidAlts [Name]
- | IncompleteTerm t
- | NoEliminator String t
- | UniverseError FC UExp (Int, Int) (Int, Int) [ConstraintFC]
- | UniqueError Universe Name
- | UniqueKindError Universe Name
- | ProgramLineComment
- | Inaccessible Name
- | UnknownImplicit Name Name
- | CantMatch t
- | NonCollapsiblePostulate Name
- | AlreadyDefined Name
- | ProofSearchFail (Err' t)
- | NoRewriting t t t
- | At FC (Err' t)
- | Elaborating String Name (Maybe t) (Err' t)
- | ElaboratingArg Name Name [(Name, Name)] (Err' t)
- | ProviderError String
- | LoadingFailed String (Err' t)
- | ReflectionError [[ErrorReportPart]] (Err' t)
- | ReflectionFailed String (Err' t)
- | ElabScriptDebug [ErrorReportPart] t [(Name, t, [(Name, Binder t)])]
- | ElabScriptStuck t
- | RunningElabScript (Err' t)
- | ElabScriptStaging Name
- | FancyMsg [ErrorReportPart]
- data ErrorReportPart
- data FC
- newtype FC' = FC' {}
- data ImplicitInfo = Impl {
- tcinstance :: Bool
- toplevel_imp :: Bool
- machine_gen :: Bool
- data IntTy
- data Name
- data NameOutput
- data NameType
- data NativeTy
- data OutputAnnotation
- = AnnName Name (Maybe NameOutput) (Maybe String) (Maybe String)
- | AnnBoundName Name Bool
- | AnnConst Const
- | AnnData String String
- | AnnType String String
- | AnnKeyword
- | AnnFC FC
- | AnnTextFmt TextFormatting
- | AnnLink String
- | AnnTerm [(Name, Bool)] (TT Name)
- | AnnSearchResult Ordering
- | AnnErr Err
- | AnnNamespace [Text] (Maybe FilePath)
- | AnnQuasiquote
- | AnnAntiquote
- data Provenance
- data Raw
- data SpecialName
- data TC a
- type Term = TT Name
- class TermSize a where
- data TextFormatting
- data TT n
- type Type = Term
- data TypeInfo = TI {}
- data UConstraint
- type UCs = (Int, [UConstraint])
- data UExp
- data Universe
- addAlist :: [(Name, a)] -> Ctxt a -> Ctxt a
- addBinder :: TT n -> TT n
- addDef :: Name -> a -> Ctxt a -> Ctxt a
- allTTNames :: Eq n => TT n -> [n]
- arity :: TT n -> Int
- bindAll :: [(n, Binder (TT n))] -> TT n -> TT n
- bindingOf :: Name -> Bool -> Doc OutputAnnotation
- bindTyArgs :: (TT n -> Binder (TT n)) -> [(n, TT n)] -> TT n -> TT n
- caseName :: Name -> Bool
- constDocs :: Const -> String
- constIsType :: Const -> Bool
- deleteDefExact :: Name -> Ctxt a -> Ctxt a
- discard :: Monad m => m a -> m ()
- emptyContext :: Map k a
- emptyFC :: FC
- explicitNames :: TT n -> TT n
- fc_end :: FC -> (Int, Int)
- fc_fname :: FC -> String
- fc_start :: FC -> (Int, Int)
- fcIn :: FC -> FC -> Bool
- fileFC :: String -> FC
- finalise :: Eq n => TT n -> TT n
- fmapMB :: Monad m => (a -> m b) -> Binder a -> m (Binder b)
- forget :: TT Name -> Raw
- forgetEnv :: [Name] -> TT Name -> Raw
- freeNames :: Eq n => TT n -> [n]
- getArgTys :: TT n -> [(n, TT n)]
- getRetTy :: TT n -> TT n
- implicitable :: Name -> Bool
- instantiate :: TT n -> TT n -> TT n
- internalNS :: String
- intTyName :: IntTy -> String
- isInjective :: TT n -> Bool
- isTypeConst :: Const -> Bool
- lookupCtxt :: Name -> Ctxt a -> [a]
- lookupCtxtExact :: Name -> Ctxt a -> Maybe a
- lookupCtxtName :: Name -> Ctxt a -> [(Name, a)]
- mapCtxt :: (a -> b) -> Ctxt a -> Ctxt b
- mkApp :: TT n -> [TT n] -> TT n
- nativeTyWidth :: NativeTy -> Int
- nextName :: Name -> Name
- noOccurrence :: Eq n => n -> TT n -> Bool
- nsroot :: Name -> Name
- occurrences :: Eq n => n -> TT n -> Int
- pEraseType :: TT n -> TT n
- pmap :: (t1 -> t) -> (t1, t1) -> (t, t)
- pprintRaw :: [Name] -> Raw -> Doc OutputAnnotation
- pprintTT :: [Name] -> TT Name -> Doc OutputAnnotation
- prettyEnv :: Env -> Term -> Doc OutputAnnotation
- psubst :: Eq n => n -> TT n -> TT n -> TT n
- pToV :: Eq n => n -> TT n -> TT n
- pToVs :: Eq n => [n] -> TT n -> TT n
- pureTerm :: TT Name -> Bool
- raw_apply :: Raw -> [Raw] -> Raw
- raw_unapply :: Raw -> (Raw, [Raw])
- refsIn :: TT Name -> [Name]
- safeForget :: TT Name -> Maybe Raw
- safeForgetEnv :: [Name] -> TT Name -> Maybe Raw
- showCG :: Name -> String
- showEnv :: (Eq n, Show n) => EnvTT n -> TT n -> String
- showEnvDbg :: (Show a, Eq a) => [(a, Binder (TT a))] -> TT a -> [Char]
- showSep :: String -> [String] -> String
- sInstanceN :: Name -> [String] -> SpecialName
- sMN :: Int -> String -> Name
- sNS :: Name -> [String] -> Name
- spanFC :: FC -> FC -> FC
- str :: Text -> String
- subst :: Eq n => n -> TT n -> TT n -> TT n
- substNames :: Eq n => [(n, TT n)] -> TT n -> TT n
- substTerm :: Eq n => TT n -> TT n -> TT n -> TT n
- substV :: TT n -> TT n -> TT n
- sUN :: String -> Name
- tcname :: Name -> Bool
- termSmallerThan :: Int -> Term -> Bool
- tfail :: Err -> TC a
- thead :: Text -> Char
- tnull :: Text -> Bool
- toAlist :: Ctxt a -> [(Name, a)]
- traceWhen :: Bool -> String -> t -> t
- txt :: String -> Text
- unApply :: TT n -> (TT n, [TT n])
- uniqueBinders :: [Name] -> TT Name -> TT Name
- uniqueName :: Name -> [Name] -> Name
- uniqueNameFrom :: [Name] -> [Name] -> Name
- uniqueNameSet :: Name -> Set Name -> Name
- unList :: Term -> Maybe [Term]
- updateDef :: Name -> (a -> a) -> Ctxt a -> Ctxt a
- vToP :: TT n -> TT n
- weakenTm :: Int -> TT n -> TT n
Documentation
Constructors
| Complete | |
| MaybeHoles | |
| Holes [n] |
All binding forms are represented in a uniform fashion. This type only represents
the types of bindings (and their values, if any); the attached identifiers are part
of the Bind constructor for the TT type.
Constructors
| Lam | A function binding |
Fields
| |
| Pi | A binding that occurs in a function type
expression, e.g. |
Fields
| |
| Let | A binding that occurs in a |
| NLet | NLet is an intermediate product in the evaluator that's used for temporarily naming locals during reduction. It won't occur outside the evaluator. |
| Hole | A hole in a term under construction in the elaborator. If this is not filled during elaboration, it is an error. |
Fields
| |
| GHole | A saved TT hole that will later be converted to a top-level Idris metavariable applied to all elements of its local environment. |
Fields
| |
| Guess | A provided value for a hole. It will later be substituted - the guess is to keep it computationally inert while working on other things if necessary. |
| PVar | A pattern variable (these are bound around terms that make up pattern-match clauses) |
Fields
| |
| PVTy | The type of a pattern binding |
Fields
| |
type Ctxt a = Map Name (Map Name a) Source #
Contexts allow us to map names to things. A root name maps to a collection of things in different namespaces with that name.
data ConstraintFC Source #
Constructors
| ConstraintFC | |
Fields
| |
Instances
Data declaration options
Constructors
| Codata | Set if the the data-type is coinductive |
| DefaultEliminator | Set if an eliminator should be generated for data type |
| DefaultCaseFun | Set if a case function should be generated for data type |
| DataErrRev |
Constructors
| Data | |
Idris errors. Used as exceptions in the compiler, but reported to users if they reach the top level.
Constructors
Source location. These are typically produced by the parser getFC
FC with equality
data ImplicitInfo Source #
Constructors
| Impl | |
Fields
| |
Instances
Names are hierarchies of strings, describing scope (so no danger of duplicate names, but need to be careful on lookup).
data NameOutput Source #
Output annotation for pretty-printed name - decides colour
Constructors
| TypeOutput | |
| FunOutput | |
| DataOutput | |
| MetavarOutput | |
| PostulateOutput |
Instances
data OutputAnnotation Source #
Output annotations for pretty-printing
Constructors
| AnnName Name (Maybe NameOutput) (Maybe String) (Maybe String) | ^ The name, classification, docs overview, and pretty-printed type |
| AnnBoundName Name Bool | ^ The name and whether it is implicit |
| AnnConst Const | |
| AnnData String String | type, doc overview |
| AnnType String String | name, doc overview |
| AnnKeyword | |
| AnnFC FC | |
| AnnTextFmt TextFormatting | |
| AnnLink String | A link to this URL |
| AnnTerm [(Name, Bool)] (TT Name) | pprint bound vars, original term |
| AnnSearchResult Ordering | more general, isomorphic, or more specific |
| AnnErr Err | |
| AnnNamespace [Text] (Maybe FilePath) | A namespace (e.g. on an import line or in a namespace declaration). Stored starting at the root, with the hierarchy fully resolved. If a file path is present, then the namespace represents a module imported from that file. |
| AnnQuasiquote | |
| AnnAntiquote |
data Provenance Source #
Constructors
| ExpectedType | |
| TooManyArgs Term | |
| InferredVal | |
| GivenVal | |
| SourceTerm Term |
Instances
data SpecialName Source #
Constructors
| WhereN !Int !Name !Name | |
| WithN !Int !Name | |
| InstanceN !Name [Text] | |
| ParentN !Name !Text | |
| MethodN !Name | |
| CaseN !FC' !Name | |
| ElimN !Name | |
| InstanceCtorN !Name | |
| MetaN !Name !Name |
Instances
data TextFormatting Source #
Text formatting output
Constructors
| BoldText | |
| ItalicText | |
| UnderlineText |
Instances
Terms in the core language. The type parameter is the type of
identifiers used for bindings and explicit named references;
usually we use TT .Name
Constructors
| P NameType n (TT n) | named references with type (P for Parameter, motivated by McKinna and Pollack's Pure Type Systems Formalized) |
| V !Int | a resolved de Bruijn-indexed variable |
| Bind n !(Binder (TT n)) (TT n) | a binding |
| App (AppStatus n) !(TT n) (TT n) | function, function type, arg |
| Constant Const | constant |
| Proj (TT n) !Int | argument projection; runtime only (-1) is a special case for 'subtract one from BI' |
| Erased | an erased term |
| Impossible | special case for totality checking |
| TType UExp | the type of types at some level |
| UType Universe | Uniqueness type universe (disjoint from TType) |
Constructors
| TI | |
type UCs = (Int, [UConstraint]) Source #
Universe expressions for universe checking
Constructors
| NullType | |
| UniqueType | |
| AllTypes |
allTTNames :: Eq n => TT n -> [n] Source #
bindAll :: [(n, Binder (TT n))] -> TT n -> TT n Source #
Introduce a Bind into the given term for each element of the
given list of (name, binder) pairs.
Arguments
| :: Name | ^ the bound name |
| -> Bool | ^ whether the name is implicit |
| -> Doc OutputAnnotation |
Pretty-printer helper for the binding site of a name
constIsType :: Const -> Bool Source #
Determines whether the input constant represents a type
emptyContext :: Map k a Source #
explicitNames :: TT n -> TT n Source #
Replace all non-free de Bruijn references in the given term with references to the name of their binding.
fcIn :: FC -> FC -> Bool Source #
Determine whether the first argument is completely contained in the second
finalise :: Eq n => TT n -> TT n Source #
Replace every non-free reference to the name of a binding in the given term with a de Bruijn index.
getArgTys :: TT n -> [(n, TT n)] Source #
Return a list of pairs of the names of the outermost Pi-bound
variables in the given term, together with their types.
implicitable :: Name -> Bool Source #
instantiate :: TT n -> TT n -> TT n Source #
Replace the outermost (index 0) de Bruijn variable with the given term
internalNS :: String Source #
isInjective :: TT n -> Bool Source #
A term is injective iff it is a data constructor, type constructor, constant, the type Type, pi-binding, or an application of an injective term.
isTypeConst :: Const -> Bool Source #
lookupCtxt :: Name -> Ctxt a -> [a] Source #
lookupCtxtName :: Name -> Ctxt a -> [(Name, a)] Source #
Look up a name in the context, given an optional namespace. The name (n) may itself have a (partial) namespace given.
Rules for resolution:
- if an explicit namespace is given, return the names which match it. If none match, return all names.
- if the name has has explicit namespace given, return the names which match it and ignore the given namespace.
- otherwise, return all names.
mkApp :: TT n -> [TT n] -> TT n Source #
Returns a term representing the application of the first argument (a function) to every element of the second argument.
nativeTyWidth :: NativeTy -> Int Source #
noOccurrence :: Eq n => n -> TT n -> Bool Source #
Returns true if V 0 and bound name n do not occur in the term
occurrences :: Eq n => n -> TT n -> Int Source #
Return number of occurrences of V 0 or bound name i the term
pEraseType :: TT n -> TT n Source #
Arguments
| :: [Name] | Bound names, for highlighting |
| -> Raw | The term to pretty-print |
| -> Doc OutputAnnotation |
Pretty-print a raw term.
Arguments
| :: [Name] | The bound names (for highlighting and de Bruijn indices) |
| -> TT Name | The term to be printed |
| -> Doc OutputAnnotation |
Pretty-print a term
pToV :: Eq n => n -> TT n -> TT n Source #
Replace references to the given Name-like id with references to
de Bruijn index 0.
pToVs :: Eq n => [n] -> TT n -> TT n Source #
Convert several names. First in the list comes out as V 0
sInstanceN :: Name -> [String] -> SpecialName Source #
Arguments
| :: Eq n | |
| => n | The id to replace |
| -> TT n | The replacement term |
| -> TT n | The term to replace in |
| -> TT n |
As instantiate, but in addition to replacing V 0Name-like id.
substNames :: Eq n => [(n, TT n)] -> TT n -> TT n Source #
As subst, but takes a list of (name, substitution) pairs instead
of a single name and substitution
Replaces all terms equal (in the sense of (==)) to
the old term with the new term.
substV :: TT n -> TT n -> TT n Source #
As instantiate, but also decrement the indices of all de Bruijn variables
remaining in the term, so that there are no more references to the variable
that has been substituted.
tcname :: Name -> Bool Source #
Return True if the argument Name should be interpreted as the name of a
typeclass.
termSmallerThan :: Int -> Term -> Bool Source #
Hard-code a heuristic maximum term size, to prevent attempts to serialize or force infinite or just gigantic terms
unApply :: TT n -> (TT n, [TT n]) Source #
Deconstruct an application; returns the function and a list of arguments
Replace de Bruijn indices in the given term with explicit references to the names of the bindings they refer to. It is an error if the given term contains free de Bruijn indices.