idris-1.3.4: Functional Programming Language with Dependent Types

License | BSD3
Maintainer | The Idris Community.
Safe Haskell | Safe-Inferred
Language | Haskell2010

Idris.Output

Description

Synopsis

- clearHighlights :: Idris ()
- emitWarning :: Message w => w -> Idris ()
- formatMessage :: Message w => w -> Idris OutputDoc
- idemodePutSExp :: SExpable a => String -> a -> Idris ()
- iPrintError :: String -> Idris ()
- iPrintFunTypes :: [(Name, Bool)] -> Name -> [(Name, Doc OutputAnnotation)] -> Idris ()
- iPrintResult :: String -> Idris ()
- iPrintTermWithType :: Doc OutputAnnotation -> Doc OutputAnnotation -> Idris ()
- iputGoal :: SimpleDoc OutputAnnotation -> Idris ()
- iputStr :: String -> Idris ()
- iputStrLn :: String -> Idris ()
- iRender :: Doc a -> Idris (SimpleDoc a)
- iRenderError :: Doc OutputAnnotation -> Idris ()
- iRenderOutput :: Doc OutputAnnotation -> Idris ()
- iRenderResult :: Doc OutputAnnotation -> Idris ()
- iWarn :: FC -> OutputDoc -> Idris ()
- prettyDocumentedIst :: IState -> (Name, PTerm, Maybe (Docstring DocTerm)) -> Doc OutputAnnotation
- printUndefinedNames :: [Name] -> Doc OutputAnnotation
- pshow :: IState -> Err -> String
- renderExternal :: OutputFmt -> Int -> Doc OutputAnnotation -> Idris String
- sendHighlighting :: Set (FC', OutputAnnotation) -> Idris ()
- sendParserHighlighting :: Idris ()
- warnTotality :: Idris ()
- writeHighlights :: FilePath -> Idris ()
- type OutputDoc = Doc OutputAnnotation
- class Message a where
  - messageExtent :: a -> FC
  - messageText :: a -> OutputDoc
  - messageSource :: a -> Maybe String

# Documentation

clearHighlights :: Idris () #

emitWarning :: Message w => w -> Idris () #

formatMessage :: Message w => w -> Idris OutputDoc #

idemodePutSExp :: SExpable a => String -> a -> Idris () #

iPrintError :: String -> Idris () #

iPrintFunTypes :: [(Name, Bool)] -> Name -> [(Name, Doc OutputAnnotation)] -> Idris () #

Pretty-print a collection of overloadings to REPL or IDEMode - corresponds to :t name

iPrintResult :: String -> Idris () #

iPrintTermWithType :: Doc OutputAnnotation -> Doc OutputAnnotation -> Idris () #

iputGoal :: SimpleDoc OutputAnnotation -> Idris () #

iputStr :: String -> Idris () #

iputStrLn :: String -> Idris () #

iRender :: Doc a -> Idris (SimpleDoc a) #

iRenderError :: Doc OutputAnnotation -> Idris () #

Show an error with semantic highlighting

iRenderOutput :: Doc OutputAnnotation -> Idris () #

iRenderResult :: Doc OutputAnnotation -> Idris () #

iWarn :: FC -> OutputDoc -> Idris () #

prettyDocumentedIst :: IState -> (Name, PTerm, Maybe (Docstring DocTerm)) -> Doc OutputAnnotation #

printUndefinedNames :: [Name] -> Doc OutputAnnotation #

pshow :: IState -> Err -> String #

renderExternal :: OutputFmt -> Int -> Doc OutputAnnotation -> Idris String #

sendHighlighting :: Set (FC', OutputAnnotation) -> Idris () #

sendParserHighlighting :: Idris () #

warnTotality :: Idris () #

Warn about totality problems without failing to compile

writeHighlights :: FilePath -> Idris () #

Write the highlighting information to a file, for use in external tools or in editors that don't support the IDE protocol

type OutputDoc = Doc OutputAnnotation #

class Message a where #

Methods

messageExtent :: a -> FC #

messageText :: a -> OutputDoc #

messageSource :: a -> Maybe String #

#### Instances

Instances details

Message ParseError # |
Instance details Defined in Idris.Parser.Stack Methods messageExtent :: ParseError -> FC # messageText :: ParseError -> OutputDoc # messageSource :: ParseError -> Maybe String #