Dhall.LSP.Backend.Dhall

Documentation

data FileIdentifier

A FileIdentifier represents either a local file or a remote url.

fileIdentifierFromFilePath :: FilePath -> FileIdentifier

Construct a FileIdentifier from a local file path.

fileIdentifierFromURI :: URI -> Maybe FileIdentifier

Construct a FileIdentifier from a given URI. Supports only "file:" URIs.

hashNormalToCode :: Normal -> Text

Given a normal expression compute the hash (using the default standard version) of its alpha-normal form. Returns the hash in the format used in Dhall's hash annotations (prefixed by "sha256:" and base-64 encoded).

data WellTyped

A well-typed expression.

fromWellTyped :: WellTyped -> Expr Src Void

data Normal

A fully normalised expression.

fromNormal :: Normal -> Expr Src Void

data Cache

A cache maps Dhall imports to fully normalised expressions. By reusing caches we can speeds up diagnostics etc. significantly!

emptyCache :: Cache

The initial cache.

invalidate :: FileIdentifier -> Cache -> Cache

Invalidate any _unhashed_ imports of the given file. Hashed imports are kept around as per https://github.com/dhall-lang/dhall-lang/blob/master/standard/imports.md. Transitively invalidates any imports depending on the changed file.

data DhallError

A Dhall error. Covers parsing, resolving of imports, typechecking and normalisation.

Constructors

ErrorInternal SomeException

ErrorImportSourced (SourcedException MissingImports)

ErrorTypecheck (TypeError Src Void)

ErrorParse ParseError

parse :: Text -> Either DhallError (Expr Src Import)

Parse a Dhall expression.

parseWithHeader :: Text -> Either DhallError (Header, Expr Src Import)

Parse a Dhall expression along with its "header", i.e. whitespace and comments prefixing the actual code.

load :: FileIdentifier -> Expr Src Import -> Cache -> IO (Either DhallError (Cache, Expr Src Void))

Resolve all imports in an expression.

typecheck :: Expr Src Void -> Either DhallError (WellTyped, WellTyped)

Typecheck a fully resolved expression. Returns a certification that the input was well-typed along with its (well-typed) type.

normalize :: WellTyped -> Normal

Normalise a well-typed expression.