Idris2Doc : Core.FC

Core.FC

(source)

Definitions

FilePos : Type
Totality: total
Visibility: public export
FileName : Type
Totality: total
Visibility: public export
data VirtualIdent : Type
Totality: total
Visibility: public export
Constructor: 
Interactive : VirtualIdent

Hints:
Eq VirtualIdent
Show VirtualIdent
TTC VirtualIdent
data OriginDesc : Type
Totality: total
Visibility: public export
Constructors:
PhysicalIdrSrc : ModuleIdent -> OriginDesc
  Anything that originates in physical Idris source files is assigned a
`PhysicalIdrSrc modIdent`,
where `modIdent` is the top-level module identifier of that file.
PhysicalPkgSrc : FileName -> OriginDesc
  Anything parsed from a package file is decorated with `PhysicalPkgSrc fname`,
where `fname` is path to the package file.
Virtual : VirtualIdent -> OriginDesc

Hints:
Eq OriginDesc
Show OriginDesc
TTC OriginDesc
data FC : Type
  A file context is a filename together with starting and ending positions.
It's often carried by AST nodes that might have been created from a source
file or by the compiler. That makes it useful to have the notion of
`EmptyFC` as part of the type.

Totality: total
Visibility: public export
Constructors:
MkFC : OriginDesc -> FilePos -> FilePos -> FC
MkVirtualFC : OriginDesc -> FilePos -> FilePos -> FC
  Virtual FCs are FC attached to desugared/generated code. They can help with marking
errors, but we shouldn't attach semantic highlighting metadata to them.
EmptyFC : FC

Hints:
Eq FC
HasNames (Int, (FC, Name))
HasNamespaces a => HasNamespaces (FC, a)
Hashable def => Hashable (FC, def)
Pretty Void FC
Show FC
TTC FC
NonEmptyFC : Type
  A version of a file context that cannot be empty

Totality: total
Visibility: public export
justFC : NonEmptyFC -> FC
  NonEmptyFC always embeds into FC

Totality: total
Visibility: export
isNonEmptyFC : FC -> Maybe NonEmptyFC
  A view checking whether an arbitrary FC happens to be non-empty

Totality: total
Visibility: export
isConcreteFC : FC -> Maybe NonEmptyFC
  A view checking whether an arbitrary FC originates from a source location

Totality: total
Visibility: export
virtualiseFC : FC -> FC
  Turn an FC into a virtual one

Totality: total
Visibility: export
defaultFC : NonEmptyFC
Totality: total
Visibility: export
replFC : FC
Totality: total
Visibility: export
toNonEmptyFC : FC -> NonEmptyFC
Totality: total
Visibility: export
origin : NonEmptyFC -> OriginDesc
Totality: total
Visibility: export
startPos : NonEmptyFC -> FilePos
Totality: total
Visibility: export
startLine : NonEmptyFC -> Int
Totality: total
Visibility: export
startCol : NonEmptyFC -> Int
Totality: total
Visibility: export
endPos : NonEmptyFC -> FilePos
Totality: total
Visibility: export
endLine : NonEmptyFC -> Int
Totality: total
Visibility: export
endCol : NonEmptyFC -> Int
Totality: total
Visibility: export
boundToFC : OriginDesc -> WithBounds t -> FC
Totality: total
Visibility: export
within : FilePos -> NonEmptyFC -> Bool
Totality: total
Visibility: export
onLine : Int -> NonEmptyFC -> Bool
Totality: total
Visibility: export
emptyFC : FC
Totality: total
Visibility: export
mergeFC : FC -> FC -> Maybe FC
Totality: total
Visibility: export