Development.IDE

Documentation

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.

>>> [1,2,3] <> [4,5,6]
[1,2,3,4,5,6]

data ParseResult a

The result of running a parser.

Constructors

POk

The parser has consumed a (possibly empty) prefix of the input and produced a result. Use getMessages to check for accumulated warnings and non-fatal errors.

Fields

• PState

  The resulting parsing state. Can be used to resume parsing.

• a

  The resulting value.

PFailed

The parser has consumed a (possibly empty) prefix of the input and failed.

Fields

• PState

  The parsing state right before failure, including the fatal parse error. getMessages and getErrorMessages must return a non-empty bag of errors.

action :: Action a -> Rules ()

type family RuleResult key

The type mapping between the key or a rule and the resulting value.

Instances

type RuleResult NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

type RuleResult NonLocalCompletions = CachedCompletions

type RuleResult LocalCompletions

Produce completions info for a file

Defined in Development.IDE.Plugin.Completions.Types

type RuleResult LocalCompletions = CachedCompletions

type RuleResult GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSessionIO = IdeGhcSession

type RuleResult AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

type RuleResult AddWatchedFile = Bool

type RuleResult GetClientSettings

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetClientSettings = Hashed (Maybe Value)

type RuleResult GetModSummary

Generate a ModSummary that has enough information to be used to get .hi and .hie files. without needing to parse the entire source

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModSummary = ModSummaryResult

type RuleResult GetModSummaryWithoutTimestamps

Generate a ModSummary with the timestamps and preprocessed content elided, for more successful early cutoff

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModSummaryWithoutTimestamps = ModSummaryResult

type RuleResult IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

type RuleResult IsFileOfInterest = IsFileOfInterestResult

type RuleResult GetModIface

Get a module interface details, either from an interface file or a typechecked module

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIface = HiFileResult

type RuleResult GetModIfaceFromDiskAndIndex

GetModIfaceFromDisk and index the `.hie` file into the database. This is an internal rule, use GetModIface instead.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIfaceFromDiskAndIndex = HiFileResult

type RuleResult GetModIfaceFromDisk

Read the module interface file from disk. Throws an error for VFS files. This is an internal rule, use GetModIface instead.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIfaceFromDisk = HiFileResult

type RuleResult GhcSessionDeps

A GHC session preloaded with all the dependencies This rule is also responsible for calling ReportImportCycles for the direct dependencies

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSessionDeps = HscEnvEq

type RuleResult GhcSession

A GHC session that we reuse.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSession = HscEnvEq

type RuleResult GetBindings

A IntervalMap telling us what is in scope at each point

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetBindings = Bindings

type RuleResult GetHieAst

The uncompressed HieAST

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetHieAst = HieAstResult

type RuleResult GetDocMap

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetDocMap = DocAndKindMap

type RuleResult TypeCheck

The type checked version of this file, requires TypeCheck+

Defined in Development.IDE.Core.RuleTypes

type RuleResult TypeCheck = TcModuleResult

type RuleResult ReportImportCycles

This rule is used to report import cycles. It depends on GetDependencyInformation. We cannot report the cycles directly from GetDependencyInformation since we can only report diagnostics for the current file.

Defined in Development.IDE.Core.RuleTypes

type RuleResult ReportImportCycles = ()

type RuleResult GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModuleGraph = DependencyInformation

type RuleResult GetDependencyInformation

The dependency information produced by following the imports recursively. This rule will succeed even if there is an error, e.g., a module could not be located, a module could not be parsed or an import cycle.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetDependencyInformation = DependencyInformation

type RuleResult NeedsCompilation

Does this module need to be compiled?

Defined in Development.IDE.Core.RuleTypes

type RuleResult NeedsCompilation = Maybe LinkableType

type RuleResult GetLocatedImports

Resolve the imports in a module to the file path of a module in the same package

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetLocatedImports = [(Located ModuleName, Maybe ArtifactsLocation)]

type RuleResult GetParsedModuleWithComments

The parse tree for the file using GetFileContents, all comments included using Opt_KeepRawTokenStream

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetParsedModuleWithComments = ParsedModule

type RuleResult GetParsedModule

The parse tree for the file using GetFileContents

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetParsedModule = ParsedModule

type RuleResult GetFileExists

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetFileExists = Bool

type RuleResult GetFileContents

Get the contents of a file, either dirty (if the buffer is modified) or Nothing to mean use from disk.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetFileContents = (FileVersion, Maybe Text)

type RuleResult GetModificationTime

Get the modification time of a file.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModificationTime = FileVersion

type RuleResult GetImportMap

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetImportMap = ImportMap

type RuleResult GenerateCore

Convert to Core, requires TypeCheck*

Defined in Development.IDE.Core.RuleTypes

type RuleResult GenerateCore = ModGuts

type RuleResult GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetKnownTargets = KnownTargets

type RuleResult GetAnnotatedParsedSource

Defined in Development.IDE.GHC.ExactPrint

type RuleResult GetAnnotatedParsedSource = Annotated ParsedSource

type RuleResult GetGlobalBindingTypeSigs

Defined in Development.IDE.Plugin.TypeLenses

type RuleResult GetGlobalBindingTypeSigs = GlobalBindingTypeSigsResult

type RuleResult (Q k)

Defined in Development.IDE.Types.Shake

type RuleResult (Q k) = A (RuleResult k)

data Rules a

Instances

Monad Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

(>>=) :: Rules a -> (a -> Rules b) -> Rules b

(>>) :: Rules a -> Rules b -> Rules b

return :: a -> Rules a

Functor Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

fmap :: (a -> b) -> Rules a -> Rules b

(<$) :: a -> Rules b -> Rules a

MonadFail Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

fail :: String -> Rules a

Applicative Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

pure :: a -> Rules a

(<*>) :: Rules (a -> b) -> Rules a -> Rules b

liftA2 :: (a -> b -> c) -> Rules a -> Rules b -> Rules c

(*>) :: Rules a -> Rules b -> Rules b

(<*) :: Rules a -> Rules b -> Rules a

MonadIO Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

liftIO :: IO a -> Rules a

Semigroup a => Semigroup (Rules a)

Defined in Development.IDE.Graph.Internal.Types

Methods

(<>) :: Rules a -> Rules a -> Rules a

sconcat :: NonEmpty (Rules a) -> Rules a

stimes :: Integral b => b -> Rules a -> Rules a

Monoid a => Monoid (Rules a)

Defined in Development.IDE.Graph.Internal.Types

Methods

mempty :: Rules a

mappend :: Rules a -> Rules a -> Rules a

mconcat :: [Rules a] -> Rules a

data Action a

Instances

Monad Action

Defined in Development.IDE.Graph.Internal.Types

Methods

(>>=) :: Action a -> (a -> Action b) -> Action b

(>>) :: Action a -> Action b -> Action b

return :: a -> Action a

Functor Action

Defined in Development.IDE.Graph.Internal.Types

Methods

fmap :: (a -> b) -> Action a -> Action b

(<$) :: a -> Action b -> Action a

MonadFail Action

Defined in Development.IDE.Graph.Internal.Types

Methods

fail :: String -> Action a

Applicative Action

Defined in Development.IDE.Graph.Internal.Types

Methods

pure :: a -> Action a

(<*>) :: Action (a -> b) -> Action a -> Action b

liftA2 :: (a -> b -> c) -> Action a -> Action b -> Action c

(*>) :: Action a -> Action b -> Action b

(<*) :: Action a -> Action b -> Action a

MonadIO Action

Defined in Development.IDE.Graph.Internal.Types

Methods

liftIO :: IO a -> Action a

MonadThrow Action

Defined in Development.IDE.Graph.Internal.Types

Methods

throwM :: Exception e => e -> Action a

MonadCatch Action

Defined in Development.IDE.Graph.Internal.Types

Methods

catch :: Exception e => Action a -> (e -> Action a) -> Action a

MonadMask Action

Defined in Development.IDE.Graph.Internal.Types

Methods

mask :: ((forall a. Action a -> Action a) -> Action b) -> Action b

uninterruptibleMask :: ((forall a. Action a -> Action a) -> Action b) -> Action b

generalBracket :: Action a -> (a -> ExitCase b -> Action c) -> (a -> Action b) -> Action (b, c)

getClientConfig :: MonadLsp Config m => m Config

Returns the current client configuration. It is not wise to permanently cache the returned value of this function, as clients can at runitime change their configuration.

data NormalizedUri

Instances

Eq NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

(==) :: NormalizedUri -> NormalizedUri -> Bool

(/=) :: NormalizedUri -> NormalizedUri -> Bool

Ord NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

compare :: NormalizedUri -> NormalizedUri -> Ordering

(<) :: NormalizedUri -> NormalizedUri -> Bool

(<=) :: NormalizedUri -> NormalizedUri -> Bool

(>) :: NormalizedUri -> NormalizedUri -> Bool

(>=) :: NormalizedUri -> NormalizedUri -> Bool

max :: NormalizedUri -> NormalizedUri -> NormalizedUri

min :: NormalizedUri -> NormalizedUri -> NormalizedUri

Read NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

readsPrec :: Int -> ReadS NormalizedUri

readList :: ReadS [NormalizedUri]

readPrec :: ReadPrec NormalizedUri

readListPrec :: ReadPrec [NormalizedUri]

Show NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

showsPrec :: Int -> NormalizedUri -> ShowS

show :: NormalizedUri -> String

showList :: [NormalizedUri] -> ShowS

Generic NormalizedUri

Defined in Language.LSP.Types.Uri

Associated Types

type Rep NormalizedUri :: Type -> Type

Methods

from :: NormalizedUri -> Rep NormalizedUri x

to :: Rep NormalizedUri x -> NormalizedUri

Hashable NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

hashWithSalt :: Int -> NormalizedUri -> Int

hash :: NormalizedUri -> Int

NFData NormalizedUri

Defined in Language.LSP.Types.Uri

Methods

rnf :: NormalizedUri -> ()

type Rep NormalizedUri

Defined in Language.LSP.Types.Uri

type Rep NormalizedUri = D1 ('MetaData "NormalizedUri" "Language.LSP.Types.Uri" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "NormalizedUri" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

type DiagnosticStore = HashMap NormalizedUri StoreItem

data Diagnostic

Constructors

Diagnostic

Fields

• _range :: Range
• _severity :: Maybe DiagnosticSeverity
• _code :: Maybe (Int32 |? Text)
• _source :: Maybe DiagnosticSource
• _message :: Text
• _tags :: Maybe (List DiagnosticTag)
• _relatedInformation :: Maybe (List DiagnosticRelatedInformation)

Instances

Eq Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

(==) :: Diagnostic -> Diagnostic -> Bool

(/=) :: Diagnostic -> Diagnostic -> Bool

Ord Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

compare :: Diagnostic -> Diagnostic -> Ordering

(<) :: Diagnostic -> Diagnostic -> Bool

(<=) :: Diagnostic -> Diagnostic -> Bool

(>) :: Diagnostic -> Diagnostic -> Bool

(>=) :: Diagnostic -> Diagnostic -> Bool

max :: Diagnostic -> Diagnostic -> Diagnostic

min :: Diagnostic -> Diagnostic -> Diagnostic

Read Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

readsPrec :: Int -> ReadS Diagnostic

readList :: ReadS [Diagnostic]

readPrec :: ReadPrec Diagnostic

readListPrec :: ReadPrec [Diagnostic]

Show Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

showsPrec :: Int -> Diagnostic -> ShowS

show :: Diagnostic -> String

showList :: [Diagnostic] -> ShowS

Generic Diagnostic

Defined in Language.LSP.Types.Diagnostic

Associated Types

type Rep Diagnostic :: Type -> Type

Methods

from :: Diagnostic -> Rep Diagnostic x

to :: Rep Diagnostic x -> Diagnostic

ToJSON Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

toJSON :: Diagnostic -> Value

toEncoding :: Diagnostic -> Encoding

toJSONList :: [Diagnostic] -> Value

toEncodingList :: [Diagnostic] -> Encoding

FromJSON Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

parseJSON :: Value -> Parser Diagnostic

parseJSONList :: Value -> Parser [Diagnostic]

NFData Diagnostic

Defined in Language.LSP.Types.Diagnostic

Methods

rnf :: Diagnostic -> ()

HasMessage Diagnostic Text

Defined in Language.LSP.Types.Lens

Methods

message :: Lens' Diagnostic Text

HasRange Diagnostic Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' Diagnostic Range

HasRelatedInformation Diagnostic (Maybe (List DiagnosticRelatedInformation))

Defined in Language.LSP.Types.Lens

Methods

relatedInformation :: Lens' Diagnostic (Maybe (List DiagnosticRelatedInformation))

HasSeverity Diagnostic (Maybe DiagnosticSeverity)

Defined in Language.LSP.Types.Lens

Methods

severity :: Lens' Diagnostic (Maybe DiagnosticSeverity)

HasSource Diagnostic (Maybe DiagnosticSource)

Defined in Language.LSP.Types.Lens

Methods

source :: Lens' Diagnostic (Maybe DiagnosticSource)

HasCode Diagnostic (Maybe (Int32 |? Text))

Defined in Language.LSP.Types.Lens

Methods

code :: Lens' Diagnostic (Maybe (Int32 |? Text))

HasDiagnostics CodeAction (Maybe (List Diagnostic))

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' CodeAction (Maybe (List Diagnostic))

HasDiagnostics CodeActionContext (List Diagnostic)

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' CodeActionContext (List Diagnostic)

HasDiagnostics PublishDiagnosticsParams (List Diagnostic)

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' PublishDiagnosticsParams (List Diagnostic)

HasTags Diagnostic (Maybe (List DiagnosticTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' Diagnostic (Maybe (List DiagnosticTag))

type Rep Diagnostic

Defined in Language.LSP.Types.Diagnostic

type Rep Diagnostic = D1 ('MetaData "Diagnostic" "Language.LSP.Types.Diagnostic" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "Diagnostic" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range) :*: (S1 ('MetaSel ('Just "_severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiagnosticSeverity)) :*: S1 ('MetaSel ('Just "_code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Int32 |? Text))))) :*: ((S1 ('MetaSel ('Just "_source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiagnosticSource)) :*: S1 ('MetaSel ('Just "_message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "_tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (List DiagnosticTag))) :*: S1 ('MetaSel ('Just "_relatedInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (List DiagnosticRelatedInformation)))))))

data DiagnosticSeverity

Constructors

DsError

Error = 1,

DsWarning

Warning = 2,

DsInfo

Info = 3,

DsHint

Hint = 4

Instances

Eq DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

(==) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

(/=) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

Ord DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

compare :: DiagnosticSeverity -> DiagnosticSeverity -> Ordering

(<) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

(<=) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

(>) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

(>=) :: DiagnosticSeverity -> DiagnosticSeverity -> Bool

max :: DiagnosticSeverity -> DiagnosticSeverity -> DiagnosticSeverity

min :: DiagnosticSeverity -> DiagnosticSeverity -> DiagnosticSeverity

Read DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

readsPrec :: Int -> ReadS DiagnosticSeverity

readList :: ReadS [DiagnosticSeverity]

readPrec :: ReadPrec DiagnosticSeverity

readListPrec :: ReadPrec [DiagnosticSeverity]

Show DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

showsPrec :: Int -> DiagnosticSeverity -> ShowS

show :: DiagnosticSeverity -> String

showList :: [DiagnosticSeverity] -> ShowS

Generic DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Associated Types

type Rep DiagnosticSeverity :: Type -> Type

Methods

from :: DiagnosticSeverity -> Rep DiagnosticSeverity x

to :: Rep DiagnosticSeverity x -> DiagnosticSeverity

ToJSON DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

toJSON :: DiagnosticSeverity -> Value

toEncoding :: DiagnosticSeverity -> Encoding

toJSONList :: [DiagnosticSeverity] -> Value

toEncodingList :: [DiagnosticSeverity] -> Encoding

FromJSON DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

parseJSON :: Value -> Parser DiagnosticSeverity

parseJSONList :: Value -> Parser [DiagnosticSeverity]

NFData DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

Methods

rnf :: DiagnosticSeverity -> ()

HasSeverity Diagnostic (Maybe DiagnosticSeverity)

Defined in Language.LSP.Types.Lens

Methods

severity :: Lens' Diagnostic (Maybe DiagnosticSeverity)

type Rep DiagnosticSeverity

Defined in Language.LSP.Types.Diagnostic

type Rep DiagnosticSeverity = D1 ('MetaData "DiagnosticSeverity" "Language.LSP.Types.Diagnostic" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) ((C1 ('MetaCons "DsError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DsWarning" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DsInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DsHint" 'PrefixI 'False) (U1 :: Type -> Type)))

data Location

Constructors

Location

Fields

• _uri :: Uri
• _range :: Range

Instances

Eq Location

Defined in Language.LSP.Types.Location

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

Defined in Language.LSP.Types.Location

Methods

compare :: Location -> Location -> Ordering

(<) :: Location -> Location -> Bool

(<=) :: Location -> Location -> Bool

(>) :: Location -> Location -> Bool

(>=) :: Location -> Location -> Bool

max :: Location -> Location -> Location

min :: Location -> Location -> Location

Read Location

Defined in Language.LSP.Types.Location

Methods

readsPrec :: Int -> ReadS Location

readList :: ReadS [Location]

readPrec :: ReadPrec Location

readListPrec :: ReadPrec [Location]

Show Location

Defined in Language.LSP.Types.Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Generic Location

Defined in Language.LSP.Types.Location

Associated Types

type Rep Location :: Type -> Type

Methods

from :: Location -> Rep Location x

to :: Rep Location x -> Location

ToJSON Location

Defined in Language.LSP.Types.Location

Methods

toJSON :: Location -> Value

toEncoding :: Location -> Encoding

toJSONList :: [Location] -> Value

toEncodingList :: [Location] -> Encoding

FromJSON Location

Defined in Language.LSP.Types.Location

Methods

parseJSON :: Value -> Parser Location

parseJSONList :: Value -> Parser [Location]

NFData Location

Defined in Language.LSP.Types.Location

Methods

rnf :: Location -> ()

HasLocation DiagnosticRelatedInformation Location

Defined in Language.LSP.Types.Lens

Methods

location :: Lens' DiagnosticRelatedInformation Location

HasLocation SymbolInformation Location

Defined in Language.LSP.Types.Lens

Methods

location :: Lens' SymbolInformation Location

HasRange Location Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' Location Range

HasUri Location Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' Location Uri

type Rep Location

Defined in Language.LSP.Types.Location

type Rep Location = D1 ('MetaData "Location" "Language.LSP.Types.Location" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "_uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Uri) :*: S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range)))

data Range

Constructors

Range

Fields

• _start :: Position

  The range's start position.

• _end :: Position

  The range's end position.

Instances

Eq Range

Defined in Language.LSP.Types.Location

Methods

(==) :: Range -> Range -> Bool

(/=) :: Range -> Range -> Bool

Ord Range

Defined in Language.LSP.Types.Location

Methods

compare :: Range -> Range -> Ordering

(<) :: Range -> Range -> Bool

(<=) :: Range -> Range -> Bool

(>) :: Range -> Range -> Bool

(>=) :: Range -> Range -> Bool

max :: Range -> Range -> Range

min :: Range -> Range -> Range

Read Range

Defined in Language.LSP.Types.Location

Methods

readsPrec :: Int -> ReadS Range

readList :: ReadS [Range]

readPrec :: ReadPrec Range

readListPrec :: ReadPrec [Range]

Show Range

Defined in Language.LSP.Types.Location

Methods

showsPrec :: Int -> Range -> ShowS

show :: Range -> String

showList :: [Range] -> ShowS

Generic Range

Defined in Language.LSP.Types.Location

Associated Types

type Rep Range :: Type -> Type

Methods

from :: Range -> Rep Range x

to :: Rep Range x -> Range

ToJSON Range

Defined in Language.LSP.Types.Location

Methods

toJSON :: Range -> Value

toEncoding :: Range -> Encoding

toJSONList :: [Range] -> Value

toEncodingList :: [Range] -> Encoding

FromJSON Range

Defined in Language.LSP.Types.Location

Methods

parseJSON :: Value -> Parser Range

parseJSONList :: Value -> Parser [Range]

NFData Range

Defined in Language.LSP.Types.Location

Methods

rnf :: Range -> ()

MapAge Range

Defined in Development.IDE.Core.UseStale

Methods

mapAgeFrom :: forall (from :: Age) (to :: Age). PositionMap from to -> Tracked to Range -> Maybe (Tracked from Range)

mapAgeTo :: forall (from :: Age) (to :: Age). PositionMap from to -> Tracked from Range -> Maybe (Tracked to Range)

HasSelectionRange CallHierarchyItem Range

Defined in Language.LSP.Types.Lens

Methods

selectionRange :: Lens' CallHierarchyItem Range

HasSelectionRange DocumentSymbol Range

Defined in Language.LSP.Types.Lens

Methods

selectionRange :: Lens' DocumentSymbol Range

HasInsert InsertReplaceEdit Range

Defined in Language.LSP.Types.Lens

Methods

insert :: Lens' InsertReplaceEdit Range

HasRepalce InsertReplaceEdit Range

Defined in Language.LSP.Types.Lens

Methods

repalce :: Lens' InsertReplaceEdit Range

HasTargetRange LocationLink Range

Defined in Language.LSP.Types.Lens

Methods

targetRange :: Lens' LocationLink Range

HasTargetSelectionRange LocationLink Range

Defined in Language.LSP.Types.Lens

Methods

targetSelectionRange :: Lens' LocationLink Range

HasRange CodeActionParams Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' CodeActionParams Range

HasRange ColorPresentationParams Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' ColorPresentationParams Range

HasRange ColorInformation Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' ColorInformation Range

HasRange AnnotatedTextEdit Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' AnnotatedTextEdit Range

HasRange TextEdit Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' TextEdit Range

HasRange CallHierarchyItem Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' CallHierarchyItem Range

HasRange CodeLens Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' CodeLens Range

HasRange Diagnostic Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' Diagnostic Range

HasRange DocumentHighlight Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' DocumentHighlight Range

HasRange DocumentLink Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' DocumentLink Range

HasRange DocumentSymbol Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' DocumentSymbol Range

HasRange DocumentRangeFormattingParams Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' DocumentRangeFormattingParams Range

HasRange RangeWithPlaceholder Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' RangeWithPlaceholder Range

HasRange SelectionRange Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' SelectionRange Range

HasRange SemanticTokensRangeParams Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' SemanticTokensRangeParams Range

HasRange Location Range

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' Location Range

HasEnd Range Position

Defined in Language.LSP.Types.Lens

Methods

end :: Lens' Range Position

HasStart Range Position

Defined in Language.LSP.Types.Lens

Methods

start :: Lens' Range Position

HasFromRanges CallHierarchyOutgoingCall (List Range)

Defined in Language.LSP.Types.Lens

Methods

fromRanges :: Lens' CallHierarchyOutgoingCall (List Range)

HasFromRanges CallHierarchyIncomingCall (List Range)

Defined in Language.LSP.Types.Lens

Methods

fromRanges :: Lens' CallHierarchyIncomingCall (List Range)

HasSelection ShowDocumentParams (Maybe Range)

Defined in Language.LSP.Types.Lens

Methods

selection :: Lens' ShowDocumentParams (Maybe Range)

HasOriginSelectionRange LocationLink (Maybe Range)

Defined in Language.LSP.Types.Lens

Methods

originSelectionRange :: Lens' LocationLink (Maybe Range)

HasRange Hover (Maybe Range)

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' Hover (Maybe Range)

HasRange TextDocumentContentChangeEvent (Maybe Range)

Defined in Language.LSP.Types.Lens

Methods

range :: Lens' TextDocumentContentChangeEvent (Maybe Range)

type Rep Range

Defined in Language.LSP.Types.Location

type Rep Range = D1 ('MetaData "Range" "Language.LSP.Types.Location" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "Range" 'PrefixI 'True) (S1 ('MetaSel ('Just "_start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Just "_end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Position)))

data Position

Constructors

Position

Fields

• _line :: UInt

  Line position in a document (zero-based).

• _character :: UInt

  Character offset on a line in a document (zero-based). Assuming that the line is represented as a string, the character value represents the gap between the character and character + 1.

Instances

Eq Position

Defined in Language.LSP.Types.Location

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

Ord Position

Defined in Language.LSP.Types.Location

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Read Position

Defined in Language.LSP.Types.Location

Methods

readsPrec :: Int -> ReadS Position

readList :: ReadS [Position]

readPrec :: ReadPrec Position

readListPrec :: ReadPrec [Position]

Show Position

Defined in Language.LSP.Types.Location

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Generic Position

Defined in Language.LSP.Types.Location

Associated Types

type Rep Position :: Type -> Type

Methods

from :: Position -> Rep Position x

to :: Rep Position x -> Position

ToJSON Position

Defined in Language.LSP.Types.Location

Methods

toJSON :: Position -> Value

toEncoding :: Position -> Encoding

toJSONList :: [Position] -> Value

toEncodingList :: [Position] -> Encoding

FromJSON Position

Defined in Language.LSP.Types.Location

Methods

parseJSON :: Value -> Parser Position

parseJSONList :: Value -> Parser [Position]

NFData Position

Defined in Language.LSP.Types.Location

Methods

rnf :: Position -> ()

HasPosition CompletionParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' CompletionParams Position

HasPosition CallHierarchyPrepareParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' CallHierarchyPrepareParams Position

HasPosition DeclarationParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' DeclarationParams Position

HasPosition DefinitionParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' DefinitionParams Position

HasPosition DocumentHighlightParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' DocumentHighlightParams Position

HasPosition DocumentOnTypeFormattingParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' DocumentOnTypeFormattingParams Position

HasPosition HoverParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' HoverParams Position

HasPosition ImplementationParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' ImplementationParams Position

HasPosition ReferenceParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' ReferenceParams Position

HasPosition PrepareRenameParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' PrepareRenameParams Position

HasPosition RenameParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' RenameParams Position

HasPosition TypeDefinitionParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' TypeDefinitionParams Position

HasPosition TextDocumentPositionParams Position

Defined in Language.LSP.Types.Lens

Methods

position :: Lens' TextDocumentPositionParams Position

HasEnd Range Position

Defined in Language.LSP.Types.Lens

Methods

end :: Lens' Range Position

HasStart Range Position

Defined in Language.LSP.Types.Lens

Methods

start :: Lens' Range Position

HasCharacter Position UInt

Defined in Language.LSP.Types.Lens

Methods

character :: Lens' Position UInt

HasLine Position UInt

Defined in Language.LSP.Types.Lens

Methods

line :: Lens' Position UInt

HasPositions SelectionRangeParams (List Position)

Defined in Language.LSP.Types.Lens

Methods

positions :: Lens' SelectionRangeParams (List Position)

type Rep Position

Defined in Language.LSP.Types.Location

type Rep Position = D1 ('MetaData "Position" "Language.LSP.Types.Location" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "Position" 'PrefixI 'True) (S1 ('MetaSel ('Just "_line") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UInt) :*: S1 ('MetaSel ('Just "_character") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UInt)))

fromNormalizedFilePath :: NormalizedFilePath -> FilePath

fromNormalizedUri :: NormalizedUri -> Uri

toNormalizedUri :: Uri -> NormalizedUri

newtype Uri

Constructors

Uri

Fields

• getUri :: Text

Instances

Eq Uri

Defined in Language.LSP.Types.Uri

Methods

(==) :: Uri -> Uri -> Bool

(/=) :: Uri -> Uri -> Bool

Ord Uri

Defined in Language.LSP.Types.Uri

Methods

compare :: Uri -> Uri -> Ordering

(<) :: Uri -> Uri -> Bool

(<=) :: Uri -> Uri -> Bool

(>) :: Uri -> Uri -> Bool

(>=) :: Uri -> Uri -> Bool

max :: Uri -> Uri -> Uri

min :: Uri -> Uri -> Uri

Read Uri

Defined in Language.LSP.Types.Uri

Methods

readsPrec :: Int -> ReadS Uri

readList :: ReadS [Uri]

readPrec :: ReadPrec Uri

readListPrec :: ReadPrec [Uri]

Show Uri

Defined in Language.LSP.Types.Uri

Methods

showsPrec :: Int -> Uri -> ShowS

show :: Uri -> String

showList :: [Uri] -> ShowS

Generic Uri

Defined in Language.LSP.Types.Uri

Associated Types

type Rep Uri :: Type -> Type

Methods

from :: Uri -> Rep Uri x

to :: Rep Uri x -> Uri

Hashable Uri

Defined in Language.LSP.Types.Uri

Methods

hashWithSalt :: Int -> Uri -> Int

hash :: Uri -> Int

ToJSON Uri

Defined in Language.LSP.Types.Uri

Methods

toJSON :: Uri -> Value

toEncoding :: Uri -> Encoding

toJSONList :: [Uri] -> Value

toEncodingList :: [Uri] -> Encoding

ToJSONKey Uri

Defined in Language.LSP.Types.Uri

Methods

toJSONKey :: ToJSONKeyFunction Uri

toJSONKeyList :: ToJSONKeyFunction [Uri]

FromJSON Uri

Defined in Language.LSP.Types.Uri

Methods

parseJSON :: Value -> Parser Uri

parseJSONList :: Value -> Parser [Uri]

FromJSONKey Uri

Defined in Language.LSP.Types.Uri

Methods

fromJSONKey :: FromJSONKeyFunction Uri

fromJSONKeyList :: FromJSONKeyFunction [Uri]

NFData Uri

Defined in Language.LSP.Types.Uri

Methods

rnf :: Uri -> ()

HasNewUri RenameFile Uri

Defined in Language.LSP.Types.Lens

Methods

newUri :: Lens' RenameFile Uri

HasOldUri RenameFile Uri

Defined in Language.LSP.Types.Lens

Methods

oldUri :: Lens' RenameFile Uri

HasTargetUri LocationLink Uri

Defined in Language.LSP.Types.Lens

Methods

targetUri :: Lens' LocationLink Uri

HasUri DeleteFile Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' DeleteFile Uri

HasUri CreateFile Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' CreateFile Uri

HasUri ShowDocumentParams Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' ShowDocumentParams Uri

HasUri FileEvent Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' FileEvent Uri

HasUri CallHierarchyItem Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' CallHierarchyItem Uri

HasUri PublishDiagnosticsParams Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' PublishDiagnosticsParams Uri

HasUri TextDocumentItem Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' TextDocumentItem Uri

HasUri VersionedTextDocumentIdentifier Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' VersionedTextDocumentIdentifier Uri

HasUri TextDocumentIdentifier Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' TextDocumentIdentifier Uri

HasUri Location Uri

Defined in Language.LSP.Types.Lens

Methods

uri :: Lens' Location Uri

HasTarget DocumentLink (Maybe Uri)

Defined in Language.LSP.Types.Lens

Methods

target :: Lens' DocumentLink (Maybe Uri)

HasChanges WorkspaceEdit (Maybe WorkspaceEditMap)

Defined in Language.LSP.Types.Lens

Methods

changes :: Lens' WorkspaceEdit (Maybe WorkspaceEditMap)

HasRootUri InitializeParams (Maybe Uri)

Defined in Language.LSP.Types.Lens

Methods

rootUri :: Lens' InitializeParams (Maybe Uri)

type Rep Uri

Defined in Language.LSP.Types.Uri

type Rep Uri = D1 ('MetaData "Uri" "Language.LSP.Types.Uri" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'True) (C1 ('MetaCons "Uri" 'PrefixI 'True) (S1 ('MetaSel ('Just "getUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data NormalizedFilePath

Newtype wrapper around FilePath that always has normalized slashes. The NormalizedUri and hash of the FilePath are cached to avoided repeated normalisation when we need to compute them (which is a lot).

This is one of the most performance critical parts of ghcide, do not modify it without profiling.

Instances

Eq NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

(==) :: NormalizedFilePath -> NormalizedFilePath -> Bool

(/=) :: NormalizedFilePath -> NormalizedFilePath -> Bool

Ord NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

compare :: NormalizedFilePath -> NormalizedFilePath -> Ordering

(<) :: NormalizedFilePath -> NormalizedFilePath -> Bool

(<=) :: NormalizedFilePath -> NormalizedFilePath -> Bool

(>) :: NormalizedFilePath -> NormalizedFilePath -> Bool

(>=) :: NormalizedFilePath -> NormalizedFilePath -> Bool

max :: NormalizedFilePath -> NormalizedFilePath -> NormalizedFilePath

min :: NormalizedFilePath -> NormalizedFilePath -> NormalizedFilePath

Show NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

showsPrec :: Int -> NormalizedFilePath -> ShowS

show :: NormalizedFilePath -> String

showList :: [NormalizedFilePath] -> ShowS

IsString NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

fromString :: String -> NormalizedFilePath

Generic NormalizedFilePath

Defined in Language.LSP.Types.Uri

Associated Types

type Rep NormalizedFilePath :: Type -> Type

Methods

from :: NormalizedFilePath -> Rep NormalizedFilePath x

to :: Rep NormalizedFilePath x -> NormalizedFilePath

Hashable NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

hashWithSalt :: Int -> NormalizedFilePath -> Int

hash :: NormalizedFilePath -> Int

Binary NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

put :: NormalizedFilePath -> Put

get :: Get NormalizedFilePath

putList :: [NormalizedFilePath] -> Put

NFData NormalizedFilePath

Defined in Language.LSP.Types.Uri

Methods

rnf :: NormalizedFilePath -> ()

type Rep NormalizedFilePath

Defined in Language.LSP.Types.Uri

type Rep NormalizedFilePath = D1 ('MetaData "NormalizedFilePath" "Language.LSP.Types.Uri" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'False) (C1 ('MetaCons "NormalizedFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NormalizedUri) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilePath)))

newtype List a

All LSP types representing a list **must** use this type rather than '[]'. In particular this is necessary to change the FromJSON instance to be compatible with Elisp (where empty lists show up as null)

Constructors

List [a]

Instances

Functor List

Defined in Language.LSP.Types.Common

Methods

fmap :: (a -> b) -> List a -> List b

(<$) :: a -> List b -> List a

Foldable List

Defined in Language.LSP.Types.Common

Methods

fold :: Monoid m => List m -> m

foldMap :: Monoid m => (a -> m) -> List a -> m

foldMap' :: Monoid m => (a -> m) -> List a -> m

foldr :: (a -> b -> b) -> b -> List a -> b

foldr' :: (a -> b -> b) -> b -> List a -> b

foldl :: (b -> a -> b) -> b -> List a -> b

foldl' :: (b -> a -> b) -> b -> List a -> b

foldr1 :: (a -> a -> a) -> List a -> a

foldl1 :: (a -> a -> a) -> List a -> a

toList :: List a -> [a]

null :: List a -> Bool

length :: List a -> Int

elem :: Eq a => a -> List a -> Bool

maximum :: Ord a => List a -> a

minimum :: Ord a => List a -> a

sum :: Num a => List a -> a

product :: Num a => List a -> a

Traversable List

Defined in Language.LSP.Types.Common

Methods

traverse :: Applicative f => (a -> f b) -> List a -> f (List b)

sequenceA :: Applicative f => List (f a) -> f (List a)

mapM :: Monad m => (a -> m b) -> List a -> m (List b)

sequence :: Monad m => List (m a) -> m (List a)

HasFormats SemanticTokensClientCapabilities (List TokenFormat)

Defined in Language.LSP.Types.Lens

Methods

formats :: Lens' SemanticTokensClientCapabilities (List TokenFormat)

HasTokenModifiers SemanticTokensClientCapabilities (List SemanticTokenModifiers)

Defined in Language.LSP.Types.Lens

Methods

tokenModifiers :: Lens' SemanticTokensClientCapabilities (List SemanticTokenModifiers)

HasTokenModifiers SemanticTokensLegend (List SemanticTokenModifiers)

Defined in Language.LSP.Types.Lens

Methods

tokenModifiers :: Lens' SemanticTokensLegend (List SemanticTokenModifiers)

HasTokenTypes SemanticTokensClientCapabilities (List SemanticTokenTypes)

Defined in Language.LSP.Types.Lens

Methods

tokenTypes :: Lens' SemanticTokensClientCapabilities (List SemanticTokenTypes)

HasTokenTypes SemanticTokensLegend (List SemanticTokenTypes)

Defined in Language.LSP.Types.Lens

Methods

tokenTypes :: Lens' SemanticTokensLegend (List SemanticTokenTypes)

HasFromRanges CallHierarchyOutgoingCall (List Range)

Defined in Language.LSP.Types.Lens

Methods

fromRanges :: Lens' CallHierarchyOutgoingCall (List Range)

HasFromRanges CallHierarchyIncomingCall (List Range)

Defined in Language.LSP.Types.Lens

Methods

fromRanges :: Lens' CallHierarchyIncomingCall (List Range)

HasSignatures SignatureHelp (List SignatureInformation)

Defined in Language.LSP.Types.Lens

Methods

signatures :: Lens' SignatureHelp (List SignatureInformation)

HasRetriggerCharacters SignatureHelpRegistrationOptions (Maybe (List Text))

Defined in Language.LSP.Types.Lens

Methods

retriggerCharacters :: Lens' SignatureHelpRegistrationOptions (Maybe (List Text))

HasRetriggerCharacters SignatureHelpOptions (Maybe (List Text))

Defined in Language.LSP.Types.Lens

Methods

retriggerCharacters :: Lens' SignatureHelpOptions (Maybe (List Text))

HasContentFormat HoverClientCapabilities (Maybe (List MarkupKind))

Defined in Language.LSP.Types.Lens

Methods

contentFormat :: Lens' HoverClientCapabilities (Maybe (List MarkupKind))

HasRelatedInformation Diagnostic (Maybe (List DiagnosticRelatedInformation))

Defined in Language.LSP.Types.Lens

Methods

relatedInformation :: Lens' Diagnostic (Maybe (List DiagnosticRelatedInformation))

HasCommands ExecuteCommandRegistrationOptions (List Text)

Defined in Language.LSP.Types.Lens

Methods

commands :: Lens' ExecuteCommandRegistrationOptions (List Text)

HasCommands ExecuteCommandOptions (List Text)

Defined in Language.LSP.Types.Lens

Methods

commands :: Lens' ExecuteCommandOptions (List Text)

HasArguments Command (Maybe (List Value))

Defined in Language.LSP.Types.Lens

Methods

arguments :: Lens' Command (Maybe (List Value))

HasArguments ExecuteCommandParams (Maybe (List Value))

Defined in Language.LSP.Types.Lens

Methods

arguments :: Lens' ExecuteCommandParams (Maybe (List Value))

HasContentChanges DidChangeTextDocumentParams (List TextDocumentContentChangeEvent)

Defined in Language.LSP.Types.Lens

Methods

contentChanges :: Lens' DidChangeTextDocumentParams (List TextDocumentContentChangeEvent)

HasAdded WorkspaceFoldersChangeEvent (List WorkspaceFolder)

Defined in Language.LSP.Types.Lens

Methods

added :: Lens' WorkspaceFoldersChangeEvent (List WorkspaceFolder)

HasRemoved WorkspaceFoldersChangeEvent (List WorkspaceFolder)

Defined in Language.LSP.Types.Lens

Methods

removed :: Lens' WorkspaceFoldersChangeEvent (List WorkspaceFolder)

HasResourceOperations WorkspaceEditClientCapabilities (Maybe (List ResourceOperationKind))

Defined in Language.LSP.Types.Lens

Methods

resourceOperations :: Lens' WorkspaceEditClientCapabilities (Maybe (List ResourceOperationKind))

HasDocumentChanges WorkspaceEdit (Maybe (List DocumentChange))

Defined in Language.LSP.Types.Lens

Methods

documentChanges :: Lens' WorkspaceEdit (Maybe (List DocumentChange))

HasEdits TextDocumentEdit (List (TextEdit |? AnnotatedTextEdit))

Defined in Language.LSP.Types.Lens

Methods

edits :: Lens' TextDocumentEdit (List (TextEdit |? AnnotatedTextEdit))

HasEdits SemanticTokensDeltaPartialResult (List SemanticTokensEdit)

Defined in Language.LSP.Types.Lens

Methods

edits :: Lens' SemanticTokensDeltaPartialResult (List SemanticTokensEdit)

HasEdits SemanticTokensDelta (List SemanticTokensEdit)

Defined in Language.LSP.Types.Lens

Methods

edits :: Lens' SemanticTokensDelta (List SemanticTokensEdit)

HasChildren DocumentSymbol (Maybe (List DocumentSymbol))

Defined in Language.LSP.Types.Lens

Methods

children :: Lens' DocumentSymbol (Maybe (List DocumentSymbol))

HasPositions SelectionRangeParams (List Position)

Defined in Language.LSP.Types.Lens

Methods

positions :: Lens' SelectionRangeParams (List Position)

HasDiagnostics CodeAction (Maybe (List Diagnostic))

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' CodeAction (Maybe (List Diagnostic))

HasDiagnostics CodeActionContext (List Diagnostic)

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' CodeActionContext (List Diagnostic)

HasDiagnostics PublishDiagnosticsParams (List Diagnostic)

Defined in Language.LSP.Types.Lens

Methods

diagnostics :: Lens' PublishDiagnosticsParams (List Diagnostic)

HasOnly CodeActionContext (Maybe (List CodeActionKind))

Defined in Language.LSP.Types.Lens

Methods

only :: Lens' CodeActionContext (Maybe (List CodeActionKind))

HasCodeActionKinds CodeActionRegistrationOptions (Maybe (List CodeActionKind))

Defined in Language.LSP.Types.Lens

Methods

codeActionKinds :: Lens' CodeActionRegistrationOptions (Maybe (List CodeActionKind))

HasCodeActionKinds CodeActionOptions (Maybe (List CodeActionKind))

Defined in Language.LSP.Types.Lens

Methods

codeActionKinds :: Lens' CodeActionOptions (Maybe (List CodeActionKind))

HasDocumentationFormat CompletionItemClientCapabilities (Maybe (List MarkupKind))

Defined in Language.LSP.Types.Lens

Methods

documentationFormat :: Lens' CompletionItemClientCapabilities (Maybe (List MarkupKind))

HasDocumentationFormat SignatureHelpSignatureInformation (Maybe (List MarkupKind))

Defined in Language.LSP.Types.Lens

Methods

documentationFormat :: Lens' SignatureHelpSignatureInformation (Maybe (List MarkupKind))

HasProperties CodeActionResolveClientCapabilities (List Text)

Defined in Language.LSP.Types.Lens

Methods

properties :: Lens' CodeActionResolveClientCapabilities (List Text)

HasProperties CompletionItemResolveClientCapabilities (List Text)

Defined in Language.LSP.Types.Lens

Methods

properties :: Lens' CompletionItemResolveClientCapabilities (List Text)

HasDocumentSelector CodeActionRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' CodeActionRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector CompletionRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' CompletionRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentColorRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentColorRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector CallHierarchyRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' CallHierarchyRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector CodeLensRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' CodeLensRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DeclarationRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DeclarationRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DefinitionRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DefinitionRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentHighlightRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentHighlightRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentLinkRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentLinkRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentSymbolRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentSymbolRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector FoldingRangeRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' FoldingRangeRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentOnTypeFormattingRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentOnTypeFormattingRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentRangeFormattingRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentRangeFormattingRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector DocumentFormattingRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' DocumentFormattingRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector HoverRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' HoverRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector ImplementationRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' ImplementationRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector ReferenceRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' ReferenceRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector RenameRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' RenameRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector SelectionRangeRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' SelectionRangeRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector SignatureHelpRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' SignatureHelpRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector TypeDefinitionRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' TypeDefinitionRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector TextDocumentSaveRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' TextDocumentSaveRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector TextDocumentChangeRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' TextDocumentChangeRegistrationOptions (Maybe DocumentSelector)

HasDocumentSelector TextDocumentRegistrationOptions (Maybe DocumentSelector)

Defined in Language.LSP.Types.Lens

Methods

documentSelector :: Lens' TextDocumentRegistrationOptions (Maybe DocumentSelector)

HasTriggerCharacters SignatureHelpRegistrationOptions (Maybe (List Text))

Defined in Language.LSP.Types.Lens

Methods

triggerCharacters :: Lens' SignatureHelpRegistrationOptions (Maybe (List Text))

HasTriggerCharacters SignatureHelpOptions (Maybe (List Text))

Defined in Language.LSP.Types.Lens

Methods

triggerCharacters :: Lens' SignatureHelpOptions (Maybe (List Text))

HasAdditionalTextEdits CompletionItem (Maybe (List TextEdit))

Defined in Language.LSP.Types.Lens

Methods

additionalTextEdits :: Lens' CompletionItem (Maybe (List TextEdit))

HasAdditionalTextEdits ColorPresentation (Maybe (List TextEdit))

Defined in Language.LSP.Types.Lens

Methods

additionalTextEdits :: Lens' ColorPresentation (Maybe (List TextEdit))

HasCommitCharacters CompletionItem (Maybe (List Text))

Defined in Language.LSP.Types.Lens

Methods

commitCharacters :: Lens' CompletionItem (Maybe (List Text))

HasTags CompletionItem (Maybe (List CompletionItemTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' CompletionItem (Maybe (List CompletionItemTag))

HasTags CallHierarchyItem (Maybe (List SymbolTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' CallHierarchyItem (Maybe (List SymbolTag))

HasTags Diagnostic (Maybe (List DiagnosticTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' Diagnostic (Maybe (List DiagnosticTag))

HasTags SymbolInformation (Maybe (List SymbolTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' SymbolInformation (Maybe (List SymbolTag))

HasTags DocumentSymbol (Maybe (List SymbolTag))

Defined in Language.LSP.Types.Lens

Methods

tags :: Lens' DocumentSymbol (Maybe (List SymbolTag))

HasXdata SemanticTokensEdit (Maybe (List UInt))

Defined in Language.LSP.Types.Lens

Methods

xdata :: Lens' SemanticTokensEdit (Maybe (List UInt))

HasXdata SemanticTokensPartialResult (List UInt)

Defined in Language.LSP.Types.Lens

Methods

xdata :: Lens' SemanticTokensPartialResult (List UInt)

HasXdata SemanticTokens (List UInt)

Defined in Language.LSP.Types.Lens

Methods

xdata :: Lens' SemanticTokens (List UInt)

HasValueSet WorkspaceSymbolKindClientCapabilities (Maybe (List SymbolKind))

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' WorkspaceSymbolKindClientCapabilities (Maybe (List SymbolKind))

HasValueSet CodeActionKindClientCapabilities (List CodeActionKind)

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' CodeActionKindClientCapabilities (List CodeActionKind)

HasValueSet CompletionItemKindClientCapabilities (Maybe (List CompletionItemKind))

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' CompletionItemKindClientCapabilities (Maybe (List CompletionItemKind))

HasValueSet CompletionItemInsertTextModeClientCapabilities (List InsertTextMode)

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' CompletionItemInsertTextModeClientCapabilities (List InsertTextMode)

HasValueSet CompletionItemTagsClientCapabilities (List CompletionItemTag)

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' CompletionItemTagsClientCapabilities (List CompletionItemTag)

HasValueSet PublishDiagnosticsTagsClientCapabilities (List DiagnosticTag)

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' PublishDiagnosticsTagsClientCapabilities (List DiagnosticTag)

HasValueSet DocumentSymbolKindClientCapabilities (Maybe (List SymbolKind))

Defined in Language.LSP.Types.Lens

Methods

valueSet :: Lens' DocumentSymbolKindClientCapabilities (Maybe (List SymbolKind))

HasChanges WorkspaceEdit (Maybe WorkspaceEditMap)

Defined in Language.LSP.Types.Lens

Methods

changes :: Lens' WorkspaceEdit (Maybe WorkspaceEditMap)

HasChanges DidChangeWatchedFilesParams (List FileEvent)

Defined in Language.LSP.Types.Lens

Methods

changes :: Lens' DidChangeWatchedFilesParams (List FileEvent)

HasWatchers DidChangeWatchedFilesRegistrationOptions (List FileSystemWatcher)

Defined in Language.LSP.Types.Lens

Methods

watchers :: Lens' DidChangeWatchedFilesRegistrationOptions (List FileSystemWatcher)

HasItems CompletionList (List CompletionItem)

Defined in Language.LSP.Types.Lens

Methods

items :: Lens' CompletionList (List CompletionItem)

HasItems ConfigurationParams (List ConfigurationItem)

Defined in Language.LSP.Types.Lens

Methods

items :: Lens' ConfigurationParams (List ConfigurationItem)

HasParameters SignatureInformation (Maybe (List ParameterInformation))

Defined in Language.LSP.Types.Lens

Methods

parameters :: Lens' SignatureInformation (Maybe (List ParameterInformation))

HasUnregisterations UnregistrationParams (List Unregistration)

Defined in Language.LSP.Types.Lens

Methods

unregisterations :: Lens' UnregistrationParams (List Unregistration)

HasRegistrations RegistrationParams (List SomeRegistration)

Defined in Language.LSP.Types.Lens

Methods

registrations :: Lens' RegistrationParams (List SomeRegistration)

HasWorkspaceFolders InitializeParams (Maybe (List WorkspaceFolder))

Defined in Language.LSP.Types.Lens

Methods

workspaceFolders :: Lens' InitializeParams (Maybe (List WorkspaceFolder))

HasRetryOnContentModified StaleRequestClientCapabilities (List Text)

Defined in Language.LSP.Types.Lens

Methods

retryOnContentModified :: Lens' StaleRequestClientCapabilities (List Text)

Eq a => Eq (List a)

Defined in Language.LSP.Types.Common

Methods

(==) :: List a -> List a -> Bool

(/=) :: List a -> List a -> Bool

Ord a => Ord (List a)

Defined in Language.LSP.Types.Common

Methods

compare :: List a -> List a -> Ordering

(<) :: List a -> List a -> Bool

(<=) :: List a -> List a -> Bool

(>) :: List a -> List a -> Bool

(>=) :: List a -> List a -> Bool

max :: List a -> List a -> List a

min :: List a -> List a -> List a

Read a => Read (List a)

Defined in Language.LSP.Types.Common

Methods

readsPrec :: Int -> ReadS (List a)

readList :: ReadS [List a]

readPrec :: ReadPrec (List a)

readListPrec :: ReadPrec [List a]

Show a => Show (List a)

Defined in Language.LSP.Types.Common

Methods

showsPrec :: Int -> List a -> ShowS

show :: List a -> String

showList :: [List a] -> ShowS

Generic (List a)

Defined in Language.LSP.Types.Common

Associated Types

type Rep (List a) :: Type -> Type

Methods

from :: List a -> Rep (List a) x

to :: Rep (List a) x -> List a

Semigroup (List a)

Defined in Language.LSP.Types.Common

Methods

(<>) :: List a -> List a -> List a

sconcat :: NonEmpty (List a) -> List a

stimes :: Integral b => b -> List a -> List a

Monoid (List a)

Defined in Language.LSP.Types.Common

Methods

mempty :: List a

mappend :: List a -> List a -> List a

mconcat :: [List a] -> List a

ToJSON a => ToJSON (List a)

Defined in Language.LSP.Types.Common

Methods

toJSON :: List a -> Value

toEncoding :: List a -> Encoding

toJSONList :: [List a] -> Value

toEncodingList :: [List a] -> Encoding

FromJSON a => FromJSON (List a)

Defined in Language.LSP.Types.Common

Methods

parseJSON :: Value -> Parser (List a)

parseJSONList :: Value -> Parser [List a]

NFData a => NFData (List a)

Defined in Language.LSP.Types.Common

Methods

rnf :: List a -> ()

type Rep (List a)

Defined in Language.LSP.Types.Common

type Rep (List a) = D1 ('MetaData "List" "Language.LSP.Types.Common" "lsp-types-1.4.0.1-KkYKenBF7kF5FxcHFj59QO" 'True) (C1 ('MetaCons "List" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])))

renderStrict :: SimpleDocStream ann -> Text

(renderStrict sdoc) takes the output sdoc from a rendering function and transforms it to strict text.

pipe :: Doc ann

>>> pipe
|

equals :: Doc ann

>>> equals
=

backslash :: Doc ann

>>> backslash
\

slash :: Doc ann

>>> slash
/

dot :: Doc ann

>>> dot
.

space :: Doc ann

>>> "a" <> space <> "b"
a b

This is mostly used via <+>,

>>> "a" <+> "b"
a b

comma :: Doc ann

>>> comma
,

colon :: Doc ann

>>> colon
:

semi :: Doc ann

>>> semi
;

rbrace :: Doc ann

>>> rbrace
}

lbrace :: Doc ann

>>> lbrace
{

rbracket :: Doc ann

>>> rbracket
]

lbracket :: Doc ann

>>> lbracket
[

rangle :: Doc ann

>>> rangle
>

langle :: Doc ann

>>> langle
<

rparen :: Doc ann

>>> rparen
)

lparen :: Doc ann

>>> lparen
(

dquote :: Doc ann

>>> dquote
"

squote :: Doc ann

>>> squote
'

braces :: Doc ann -> Doc ann

>>> braces "·"
{·}

brackets :: Doc ann -> Doc ann

>>> brackets "·"
[·]

angles :: Doc ann -> Doc ann

>>> angles "·"
<·>

parens :: Doc ann -> Doc ann

>>> parens "·"
(·)

dquotes :: Doc ann -> Doc ann

>>> dquotes "·"
"·"

squotes :: Doc ann -> Doc ann

>>> squotes "·"
'·'

layoutCompact :: Doc ann1 -> SimpleDocStream ann2

(layoutCompact x) lays out the document x without adding any indentation and without preserving annotations. Since no 'pretty' printing is involved, this layouter is very fast. The resulting output contains fewer characters than a prettyprinted version and can be used for output that is read by other programs.

>>> let doc = hang 4 (vsep ["lorem", "ipsum", hang 4 (vsep ["dolor", "sit"])])
>>> doc
lorem
    ipsum
    dolor
        sit

>>> let putDocCompact = renderIO System.IO.stdout . layoutCompact
>>> putDocCompact doc
lorem
ipsum
dolor
sit

layoutSmart :: LayoutOptions -> Doc ann -> SimpleDocStream ann

A layout algorithm with more lookahead than layoutPretty, that introduces line breaks earlier if the content does not (or will not, rather) fit into one line.

Consider the following python-ish document,

>>> let fun x = hang 2 ("fun(" <> softline' <> x) <> ")"
>>> let doc = (fun . fun . fun . fun . fun) (align (list ["abcdef", "ghijklm"]))

which we’ll be rendering using the following pipeline (where the layout algorithm has been left open):

>>> import Data.Text.IO as T
>>> import Prettyprinter.Render.Text
>>> let hr = pipe <> pretty (replicate (26-2) '-') <> pipe
>>> let go layouter x = (T.putStrLn . renderStrict . layouter (LayoutOptions (AvailablePerLine 26 1))) (vsep [hr, x, hr])

If we render this using layoutPretty with a page width of 26 characters per line, all the fun calls fit into the first line so they will be put there:

>>> go layoutPretty doc
|------------------------|
fun(fun(fun(fun(fun(
                  [ abcdef
                  , ghijklm ])))))
|------------------------|

Note that this exceeds the desired 26 character page width. The same document, rendered with layoutSmart, fits the layout contstraints:

>>> go layoutSmart doc
|------------------------|
fun(
  fun(
    fun(
      fun(
        fun(
          [ abcdef
          , ghijklm ])))))
|------------------------|

The key difference between layoutPretty and layoutSmart is that the latter will check the potential document until it encounters a line with the same indentation or less than the start of the document. Any line encountered earlier is assumed to belong to the same syntactic structure. layoutPretty checks only the first line.

Consider for example the question of whether the As fit into the document below:

1 A
2   A
3  A
4 B
5   B

layoutPretty will check only line 1, ignoring whether e.g. line 2 might already be too wide. By contrast, layoutSmart stops only once it reaches line 4, where the B has the same indentation as the first A.

layoutPretty :: LayoutOptions -> Doc ann -> SimpleDocStream ann

This is the default layout algorithm, and it is used by show, putDoc and hPutDoc.

layoutPretty commits to rendering something in a certain way if the next element fits the layout constraints; in other words, it has one SimpleDocStream element lookahead when rendering. Consider using the smarter, but a bit less performant, layoutSmart algorithm if the results seem to run off to the right before having lots of line breaks.

defaultLayoutOptions :: LayoutOptions

The default layout options, suitable when you just want some output, and don’t particularly care about the details. Used by the Show instance, for example.

>>> defaultLayoutOptions
LayoutOptions {layoutPageWidth = AvailablePerLine 80 1.0}

removeTrailingWhitespace :: SimpleDocStream ann -> SimpleDocStream ann

Remove all trailing space characters.

This has some performance impact, because it does an entire additional pass over the SimpleDocStream.

No trimming will be done inside annotations, which are considered to contain no (trimmable) whitespace, since the annotation might actually be about the whitespace, for example a renderer that colors the background of trailing whitespace, as e.g. git diff can be configured to do.

Historical note: Since v1.7.0, layoutPretty and layoutSmart avoid producing the trailing whitespace that was the original motivation for creating removeTrailingWhitespace. See https://github.com/quchen/prettyprinter/pull/139 for some background info.

fuse :: FusionDepth -> Doc ann -> Doc ann

(fuse depth doc) combines text nodes so they can be rendered more efficiently. A fused document is always laid out identical to its unfused version.

When laying a Document out to a SimpleDocStream, every component of the input is translated directly to the simpler output format. This sometimes yields undesirable chunking when many pieces have been concatenated together.

For example

>>> "a" <> "b" <> pretty 'c' <> "d"
abcd

results in a chain of four entries in a SimpleDocStream, although this is fully equivalent to the tightly packed

>>> "abcd" :: Doc ann
abcd

which is only a single SimpleDocStream entry, and can be processed faster.

It is therefore a good idea to run fuse on concatenations of lots of small strings that are used many times:

>>> let oftenUsed = fuse Shallow ("a" <> "b" <> pretty 'c' <> "d")
>>> hsep (replicate 5 oftenUsed)
abcd abcd abcd abcd abcd

alterAnnotationsS :: (ann -> Maybe ann') -> SimpleDocStream ann -> SimpleDocStream ann'

Change the annotation of a document to a different annotation, or none at all. alterAnnotations for SimpleDocStream.

Note that the Doc version is more flexible, since it allows changing a single annotation to multiple ones. (SimpleDocTree restores this flexibility again.)

reAnnotateS :: (ann -> ann') -> SimpleDocStream ann -> SimpleDocStream ann'

Change the annotation of a document. reAnnotate for SimpleDocStream.

unAnnotateS :: SimpleDocStream ann -> SimpleDocStream xxx

Remove all annotations. unAnnotate for SimpleDocStream.

alterAnnotations :: (ann -> [ann']) -> Doc ann -> Doc ann'

Change the annotations of a Document. Individual annotations can be removed, changed, or replaced by multiple ones.

This is a general function that combines unAnnotate and reAnnotate, and it is useful for mapping semantic annotations (such as »this is a keyword«) to display annotations (such as »this is red and underlined«), because some backends may not care about certain annotations, while others may.

Annotations earlier in the new list will be applied earlier, i.e. returning [Bold, Green] will result in a bold document that contains green text, and not vice-versa.

Since this traverses the entire Doc tree, including parts that are not rendered due to other layouts fitting better, it is preferrable to reannotate after producing the layout by using alterAnnotationsS.

reAnnotate :: (ann -> ann') -> Doc ann -> Doc ann'

Change the annotation of a Document.

Useful in particular to embed documents with one form of annotation in a more generally annotated document.

Since this traverses the entire Doc tree, including parts that are not rendered due to other layouts fitting better, it is preferrable to reannotate after producing the layout by using reAnnotateS.

Since reAnnotate has the right type and satisfies 'reAnnotate id = id', it is used to define the Functor instance of Doc.

unAnnotate :: Doc ann -> Doc xxx

Remove all annotations.

Although unAnnotate is idempotent with respect to rendering,

unAnnotate . unAnnotate = unAnnotate

it should not be used without caution, for each invocation traverses the entire contained document. If possible, it is preferrable to unannotate after producing the layout by using unAnnotateS.

annotate :: ann -> Doc ann -> Doc ann

Add an annotation to a Doc. This annotation can then be used by the renderer to e.g. add color to certain parts of the output. For a full tutorial example on how to use it, see the Prettyprinter.Render.Tutorials.StackMachineTutorial or Prettyprinter.Render.Tutorials.TreeRenderingTutorial modules.

This function is only relevant for custom formats with their own annotations, and not relevant for basic prettyprinting. The predefined renderers, e.g. Prettyprinter.Render.Text, should be enough for the most common needs.

surround :: Doc ann -> Doc ann -> Doc ann -> Doc ann

(surround x l r) surrounds document x with l and r.

>>> surround "·" "A" "Z"
A·Z

This is merely an argument reordering of enclose, but allows for definitions like

>>> concatWith (surround dot) ["Prettyprinter", "Render", "Text"]
Prettyprinter.Render.Text

enclose

Arguments

:: Doc ann

L

-> Doc ann

R

-> Doc ann

x

-> Doc ann

LxR

(enclose l r x) encloses document x between documents l and r using <>.

>>> enclose "A" "Z" "·"
A·Z

enclose l r x = l <> x <> r

plural

Arguments

:: (Num amount, Eq amount)

=> doc

1 case

-> doc

other cases

-> amount

-> doc

(plural n one many) is one if n is 1, and many otherwise. A typical use case is adding a plural "s".

>>> let things = [True]
>>> let amount = length things
>>> pretty things <+> "has" <+> pretty amount <+> plural "entry" "entries" amount
[True] has 1 entry

fillBreak

Arguments

:: Int

Append spaces until the document is at least this wide

-> Doc ann

-> Doc ann

(fillBreak i x) first lays out the document x. It then appends spaces until the width is equal to i. If the width of x is already larger than i, the nesting level is increased by i and a line is appended. When we redefine ptype in the example given in fill to use fillBreak, we get a useful variation of the output:

>>> let types = [("empty","Doc"), ("nest","Int -> Doc -> Doc"), ("fillSep","[Doc] -> Doc")]
>>> let ptype (name, tp) = fillBreak 5 (pretty name) <+> "::" <+> pretty tp
>>> "let" <+> align (vcat (map ptype types))
let empty :: Doc
    nest  :: Int -> Doc -> Doc
    fillSep
          :: [Doc] -> Doc

fill

Arguments

:: Int

Append spaces until the document is at least this wide

-> Doc ann

-> Doc ann

(fill i x) lays out the document x. It then appends spaces until the width is equal to i. If the width of x is already larger, nothing is appended.

This function is quite useful in practice to output a list of bindings:

>>> let types = [("empty","Doc"), ("nest","Int -> Doc -> Doc"), ("fillSep","[Doc] -> Doc")]
>>> let ptype (name, tp) = fill 5 (pretty name) <+> "::" <+> pretty tp
>>> "let" <+> align (vcat (map ptype types))
let empty :: Doc
    nest  :: Int -> Doc -> Doc
    fillSep :: [Doc] -> Doc

pageWidth :: (PageWidth -> Doc ann) -> Doc ann

Layout a document depending on the page width, if one has been specified.

>>> let prettyPageWidth (AvailablePerLine l r) = "Width:" <+> pretty l <> ", ribbon fraction:" <+> pretty r
>>> let doc = "prefix" <+> pageWidth (brackets . prettyPageWidth)
>>> putDocW 32 (vsep [indent n doc | n <- [0,4,8]])
prefix [Width: 32, ribbon fraction: 1.0]
    prefix [Width: 32, ribbon fraction: 1.0]
        prefix [Width: 32, ribbon fraction: 1.0]

width :: Doc ann -> (Int -> Doc ann) -> Doc ann

(width doc f) lays out the document doc, and makes the column width of it available to a function.

>>> let annotate doc = width (brackets doc) (\w -> " <- width:" <+> pretty w)
>>> align (vsep (map annotate ["---", "------", indent 3 "---", vsep ["---", indent 4 "---"]]))
[---] <- width: 5
[------] <- width: 8
[   ---] <- width: 8
[---
    ---] <- width: 8

nesting :: (Int -> Doc ann) -> Doc ann

Layout a document depending on the current nesting level. align is implemented in terms of nesting.

>>> let doc = "prefix" <+> nesting (\l -> brackets ("Nested:" <+> pretty l))
>>> vsep [indent n doc | n <- [0,4,8]]
prefix [Nested: 0]
    prefix [Nested: 4]
        prefix [Nested: 8]

column :: (Int -> Doc ann) -> Doc ann

Layout a document depending on which column it starts at. align is implemented in terms of column.

>>> column (\l -> "Columns are" <+> pretty l <> "-based.")
Columns are 0-based.

>>> let doc = "prefix" <+> column (\l -> "| <- column" <+> pretty l)
>>> vsep [indent n doc | n <- [0,4,8]]
prefix | <- column 7
    prefix | <- column 11
        prefix | <- column 15

punctuate

Arguments

:: Doc ann

Punctuation, e.g. comma

-> [Doc ann]

-> [Doc ann]

(punctuate p xs) appends p to all but the last document in xs.

>>> let docs = punctuate comma (Util.words "lorem ipsum dolor sit amet")
>>> putDocW 80 (hsep docs)
lorem, ipsum, dolor, sit, amet

The separators are put at the end of the entries, which we can see if we position the result vertically:

>>> putDocW 20 (vsep docs)
lorem,
ipsum,
dolor,
sit,
amet

If you want put the commas in front of their elements instead of at the end, you should use tupled or, in general, encloseSep.

cat :: [Doc ann] -> Doc ann

(cat xs) tries laying out the documents xs separated with nothing, and if this does not fit the page, separates them with newlines. This is what differentiates it from vcat, which always lays out its contents beneath each other.

>>> let docs = Util.words "lorem ipsum dolor"
>>> putDocW 80 ("Docs:" <+> cat docs)
Docs: loremipsumdolor

When there is enough space, the documents are put above one another:

>>> putDocW 10 ("Docs:" <+> cat docs)
Docs: lorem
ipsum
dolor

cat = group . vcat

fillCat :: [Doc ann] -> Doc ann

(fillCat xs) concatenates documents xs horizontally with <> as long as it fits the page, then inserts a line' and continues doing that for all documents in xs. This is similar to how an ordinary word processor lays out the text if you just keep typing after you hit the maximum line length.

(line' means that if grouped, the documents are separated with nothing instead of newlines. See fillSep if you want a space instead.)

Observe the difference between fillSep and fillCat. fillSep concatenates the entries spaced when grouped:

>>> let docs = take 20 (cycle (["lorem", "ipsum", "dolor", "sit", "amet"]))
>>> putDocW 40 ("Grouped:" <+> group (fillSep docs))
Grouped: lorem ipsum dolor sit amet
lorem ipsum dolor sit amet lorem ipsum
dolor sit amet lorem ipsum dolor sit
amet

On the other hand, fillCat concatenates the entries directly when grouped:

>>> putDocW 40 ("Grouped:" <+> group (fillCat docs))
Grouped: loremipsumdolorsitametlorem
ipsumdolorsitametloremipsumdolorsitamet
loremipsumdolorsitamet

vcat :: [Doc ann] -> Doc ann

(vcat xs) vertically concatenates the documents xs. If it is grouped, the line breaks are removed.

In other words vcat is like vsep, with newlines removed instead of replaced by spaces.

>>> let docs = Util.words "lorem ipsum dolor"
>>> vcat docs
lorem
ipsum
dolor
>>> group (vcat docs)
loremipsumdolor

Since grouping a vcat is rather common, cat is a built-in shortcut for it.

hcat :: [Doc ann] -> Doc ann

(hcat xs) concatenates all documents xs horizontally with <> (i.e. without any spacing).

It is provided only for consistency, since it is identical to mconcat.

>>> let docs = Util.words "lorem ipsum dolor"
>>> hcat docs
loremipsumdolor

sep :: [Doc ann] -> Doc ann

(sep xs) tries laying out the documents xs separated with spaces, and if this does not fit the page, separates them with newlines. This is what differentiates it from vsep, which always lays out its contents beneath each other.

>>> let doc = "prefix" <+> sep ["text", "to", "lay", "out"]
>>> putDocW 80 doc
prefix text to lay out

With a narrower layout, the entries are separated by newlines:

>>> putDocW 20 doc
prefix text
to
lay
out

sep = group . vsep

fillSep :: [Doc ann] -> Doc ann

(fillSep xs) concatenates the documents xs horizontally with <+> as long as it fits the page, then inserts a line and continues doing that for all documents in xs. (line means that if grouped, the documents are separated with a space instead of newlines. Use fillCat if you do not want a space.)

Let's print some words to fill the line:

>>> let docs = take 20 (cycle ["lorem", "ipsum", "dolor", "sit", "amet"])
>>> putDocW 80 ("Docs:" <+> fillSep docs)
Docs: lorem ipsum dolor sit amet lorem ipsum dolor sit amet lorem ipsum dolor
sit amet lorem ipsum dolor sit amet

The same document, printed at a width of only 40, yields

>>> putDocW 40 ("Docs:" <+> fillSep docs)
Docs: lorem ipsum dolor sit amet lorem
ipsum dolor sit amet lorem ipsum dolor
sit amet lorem ipsum dolor sit amet

vsep :: [Doc ann] -> Doc ann

(vsep xs) concatenates all documents xs above each other. If a group undoes the line breaks inserted by vsep, the documents are separated with a space instead.

Using vsep alone yields

>>> "prefix" <+> vsep ["text", "to", "lay", "out"]
prefix text
to
lay
out

grouping a vsep separates the documents with a space if it fits the page (and does nothing otherwise). See the sep convenience function for this use case.

The align function can be used to align the documents under their first element:

>>> "prefix" <+> align (vsep ["text", "to", "lay", "out"])
prefix text
       to
       lay
       out

Since grouping a vsep is rather common, sep is a built-in for doing that.

hsep :: [Doc ann] -> Doc ann

(hsep xs) concatenates all documents xs horizontally with <+>, i.e. it puts a space between all entries.

>>> let docs = Util.words "lorem ipsum dolor sit amet"

>>> hsep docs
lorem ipsum dolor sit amet

hsep does not introduce line breaks on its own, even when the page is too narrow:

>>> putDocW 5 (hsep docs)
lorem ipsum dolor sit amet

For automatic line breaks, consider using fillSep instead.

concatWith :: Foldable t => (Doc ann -> Doc ann -> Doc ann) -> t (Doc ann) -> Doc ann

Concatenate all documents element-wise with a binary function.

concatWith _ [] = mempty
concatWith (**) [x,y,z] = x ** y ** z

Multiple convenience definitions based on concatWith are already predefined, for example:

hsep    = concatWith (<+>)
fillSep = concatWith (\x y -> x <> softline <> y)

This is also useful to define customized joiners:

>>> concatWith (surround dot) ["Prettyprinter", "Render", "Text"]
Prettyprinter.Render.Text

(<+>) :: Doc ann -> Doc ann -> Doc ann infixr 6

(x <+> y) concatenates document x and y with a space in between.

>>> "hello" <+> "world"
hello world

x <+> y = x <> space <> y

tupled :: [Doc ann] -> Doc ann

Haskell-inspired variant of encloseSep with parentheses and comma as separator.

>>> let doc = tupled (map pretty [1,20,300,4000])

>>> putDocW 80 doc
(1, 20, 300, 4000)

>>> putDocW 10 doc
( 1
, 20
, 300
, 4000 )

list :: [Doc ann] -> Doc ann

Haskell-inspired variant of encloseSep with braces and comma as separator.

>>> let doc = list (map pretty [1,20,300,4000])

>>> putDocW 80 doc
[1, 20, 300, 4000]

>>> putDocW 10 doc
[ 1
, 20
, 300
, 4000 ]

encloseSep

Arguments

:: Doc ann

left delimiter

-> Doc ann

right delimiter

-> Doc ann

separator

-> [Doc ann]

input documents

-> Doc ann

(encloseSep l r sep xs) concatenates the documents xs separated by sep, and encloses the resulting document by l and r.

The documents are laid out horizontally if that fits the page:

>>> let doc = "list" <+> align (encloseSep lbracket rbracket comma (map pretty [1,20,300,4000]))
>>> putDocW 80 doc
list [1,20,300,4000]

If there is not enough space, then the input is split into lines entry-wise therwise they are laid out vertically, with separators put in the front:

>>> putDocW 10 doc
list [1
     ,20
     ,300
     ,4000]

Note that doc contains an explicit call to align so that the list items are aligned vertically.

For putting separators at the end of entries instead, have a look at punctuate.

indent

Arguments

:: Int

Number of spaces to increase indentation by

-> Doc ann

-> Doc ann

(indent i x) indents document x by i columns, starting from the current cursor position.

>>> let doc = reflow "The indent function indents these words!"
>>> putDocW 24 ("prefix" <> indent 4 doc)
prefix    The indent
          function
          indents these
          words!

indent i d = hang i ({i spaces} <> d)

hang

Arguments

:: Int

Change of nesting level, relative to the start of the first line

-> Doc ann

-> Doc ann

(hang i x) lays out the document x with a nesting level set to the current column plus i. Negative values are allowed, and decrease the nesting level accordingly.

>>> let doc = reflow "Indenting these words with hang"
>>> putDocW 24 ("prefix" <+> hang 4 doc)
prefix Indenting these
           words with
           hang

This differs from nest, which is based on the current nesting level plus i. When you're not sure, try the more efficient nest first. In our example, this would yield

>>> let doc = reflow "Indenting these words with nest"
>>> putDocW 24 ("prefix" <+> nest 4 doc)
prefix Indenting these
    words with nest

hang i doc = align (nest i doc)

align :: Doc ann -> Doc ann

(align x) lays out the document x with the nesting level set to the current column. It is used for example to implement hang.

As an example, we will put a document right above another one, regardless of the current nesting level. Without alignment, the second line is put simply below everything we've had so far:

>>> "lorem" <+> vsep ["ipsum", "dolor"]
lorem ipsum
dolor

If we add an align to the mix, the vsep's contents all start in the same column:

>>> "lorem" <+> align (vsep ["ipsum", "dolor"])
lorem ipsum
      dolor

flatAlt

Arguments

:: Doc ann

Default

-> Doc ann

Preferred when grouped

-> Doc ann

By default, (flatAlt x y) renders as x. However when grouped, y will be preferred, with x as the fallback for the case when y doesn't fit.

>>> let doc = flatAlt "a" "b"
>>> putDoc doc
a
>>> putDoc (group doc)
b
>>> putDocW 0 (group doc)
a

flatAlt is particularly useful for defining conditional separators such as

softline = group (flatAlt hardline " ")

>>> let hello = "Hello" <> softline <> "world!"
>>> putDocW 12 hello
Hello world!
>>> putDocW 11 hello
Hello
world!

Example: Haskell's do-notation

We can use this to render Haskell's do-notation nicely:

>>> let open        = flatAlt "" "{ "
>>> let close       = flatAlt "" " }"
>>> let separator   = flatAlt "" "; "
>>> let prettyDo xs = group ("do" <+> align (encloseSep open close separator xs))
>>> let statements  = ["name:_ <- getArgs", "let greet = \"Hello, \" <> name", "putStrLn greet"]

This is put into a single line with {;} style if it fits:

>>> putDocW 80 (prettyDo statements)
do { name:_ <- getArgs; let greet = "Hello, " <> name; putStrLn greet }

When there is not enough space the statements are broken up into lines nicely:

>>> putDocW 10 (prettyDo statements)
do name:_ <- getArgs
   let greet = "Hello, " <> name
   putStrLn greet

Notes

Users should be careful to choose x to be less wide than y. Otherwise, if y turns out not to fit the page, we fall back on an even wider layout:

>>> let ugly = group (flatAlt "even wider" "too wide")
>>> putDocW 7 ugly
even wider

Also note that group will flatten y:

>>> putDoc (group (flatAlt "x" ("y" <> line <> "y")))
y y

This also means that an "unflattenable" y which contains a hard linebreak will never be rendered:

>>> putDoc (group (flatAlt "x" ("y" <> hardline <> "y")))
x

group :: Doc ann -> Doc ann

(group x) tries laying out x into a single line by removing the contained line breaks; if this does not fit the page, or when a hardline within x prevents it from being flattened, x is laid out without any changes.

The group function is key to layouts that adapt to available space nicely.

See vcat, line, or flatAlt for examples that are related, or make good use of it.

hardline :: Doc ann

A hardline is always laid out as a line break, even when grouped or when there is plenty of space. Note that it might still be simply discarded if it is part of a flatAlt inside a group.

>>> let doc = "lorem ipsum" <> hardline <> "dolor sit amet"
>>> putDocW 1000 doc
lorem ipsum
dolor sit amet

>>> group doc
lorem ipsum
dolor sit amet

softline' :: Doc ann

softline' is like softline, but behaves like mempty if the resulting output does not fit on the page (instead of space). In other words, line is to line' how softline is to softline'.

With enough space, we get direct concatenation:

>>> let doc = "ThisWord" <> softline' <> "IsWayTooLong"
>>> putDocW 80 doc
ThisWordIsWayTooLong

If we narrow the page to width 10, the layouter produces a line break:

>>> putDocW 10 doc
ThisWord
IsWayTooLong

softline' = group line'

softline :: Doc ann

softline behaves like space if the resulting output fits the page, otherwise like line.

Here, we have enough space to put everything in one line:

>>> let doc = "lorem ipsum" <> softline <> "dolor sit amet"
>>> putDocW 80 doc
lorem ipsum dolor sit amet

If we narrow the page to width 10, the layouter produces a line break:

>>> putDocW 10 doc
lorem ipsum
dolor sit amet

softline = group line

line' :: Doc ann

line' is like line, but behaves like mempty if the line break is undone by group (instead of space).

>>> let doc = "lorem ipsum" <> line' <> "dolor sit amet"
>>> doc
lorem ipsum
dolor sit amet
>>> group doc
lorem ipsumdolor sit amet

line :: Doc ann

The line document advances to the next line and indents to the current nesting level.

>>> let doc = "lorem ipsum" <> line <> "dolor sit amet"
>>> doc
lorem ipsum
dolor sit amet

line behaves like space if the line break is undone by group:

>>> group doc
lorem ipsum dolor sit amet

nest

Arguments

:: Int

Change of nesting level

-> Doc ann

-> Doc ann

(nest i x) lays out the document x with the current nesting level (indentation of the following lines) increased by i. Negative values are allowed, and decrease the nesting level accordingly.

>>> vsep [nest 4 (vsep ["lorem", "ipsum", "dolor"]), "sit", "amet"]
lorem
    ipsum
    dolor
sit
amet

See also

• hang (nest relative to current cursor position instead of current nesting level)
• align (set nesting level to current cursor position)
• indent (increase indentation on the spot, padding with spaces).

emptyDoc :: Doc ann

The empty document behaves like (pretty ""), so it has a height of 1. This may lead to surprising behaviour if we expect it to bear no weight inside e.g. vcat, where we get an empty line of output from it (parens for visibility only):

>>> vsep ["hello", parens emptyDoc, "world"]
hello
()
world

Together with <>, emptyDoc forms the Monoid Doc.

unsafeViaShow :: Show a => a -> Doc ann

Convenience function to convert a Showable value /that must not contain newlines/ to a Doc. If there may be newlines, use viaShow instead.

viaShow :: Show a => a -> Doc ann

Convenience function to convert a Showable value to a Doc. If the String does not contain newlines, consider using the more performant unsafeViaShow.

data Doc ann

The abstract data type Doc ann represents pretty documents that have been annotated with data of type ann.

More specifically, a value of type Doc represents a non-empty set of possible layouts of a document. The layout functions select one of these possibilities, taking into account things like the width of the output document.

The annotation is an arbitrary piece of data associated with (part of) a document. Annotations may be used by the rendering backends in order to display output differently, such as

• color information (e.g. when rendering to the terminal)
• mouseover text (e.g. when rendering to rich HTML)
• whether to show something or not (to allow simple or detailed versions)

The simplest way to display a Doc is via the Show class.

>>> putStrLn (show (vsep ["hello", "world"]))
hello
world

Instances

Functor Doc

Alter the document’s annotations.

This instance makes Doc more flexible (because it can be used in Functor-polymorphic values), but fmap is much less readable compared to using reAnnotate in code that only works for Doc anyway. Consider using the latter when the type does not matter.

Defined in Prettyprinter.Internal

Methods

fmap :: (a -> b) -> Doc a -> Doc b

(<$) :: a -> Doc b -> Doc a

Show (Doc ann)

(show doc) prettyprints document doc with defaultLayoutOptions, ignoring all annotations.

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> Doc ann -> ShowS

show :: Doc ann -> String

showList :: [Doc ann] -> ShowS

IsString (Doc ann)

>>> pretty ("hello\nworld")
hello
world

This instance uses the Pretty Text instance, and uses the same newline to line conversion.

Defined in Prettyprinter.Internal

Methods

fromString :: String -> Doc ann

Generic (Doc ann)

Defined in Prettyprinter.Internal

Associated Types

type Rep (Doc ann) :: Type -> Type

Methods

from :: Doc ann -> Rep (Doc ann) x

to :: Rep (Doc ann) x -> Doc ann

Semigroup (Doc ann)

x <> y = hcat [x, y]

>>> "hello" <> "world" :: Doc ann
helloworld

Defined in Prettyprinter.Internal

Methods

(<>) :: Doc ann -> Doc ann -> Doc ann

sconcat :: NonEmpty (Doc ann) -> Doc ann

stimes :: Integral b => b -> Doc ann -> Doc ann

Monoid (Doc ann)

mempty = emptyDoc
mconcat = hcat

>>> mappend "hello" "world" :: Doc ann
helloworld

Defined in Prettyprinter.Internal

Methods

mempty :: Doc ann

mappend :: Doc ann -> Doc ann -> Doc ann

mconcat :: [Doc ann] -> Doc ann

type Rep (Doc ann)

Defined in Prettyprinter.Internal

type Rep (Doc ann) = D1 ('MetaData "Doc" "Prettyprinter.Internal" "prettyprinter-1.7.1-BauxLiNvN3EiJKyXe93SM" 'False) (((C1 ('MetaCons "Fail" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Empty" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Char" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char)))) :+: (C1 ('MetaCons "Text" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "Line" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FlatAlt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)))))) :+: ((C1 ('MetaCons "Cat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))) :+: (C1 ('MetaCons "Nest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))) :+: C1 ('MetaCons "Union" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))))) :+: ((C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int -> Doc ann))) :+: C1 ('MetaCons "WithPageWidth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PageWidth -> Doc ann)))) :+: (C1 ('MetaCons "Nesting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int -> Doc ann))) :+: C1 ('MetaCons "Annotated" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)))))))

class Pretty a where

Overloaded conversion to Doc.

Laws:

1. output should be pretty. :-)

Minimal complete definition

pretty

Methods

pretty :: a -> Doc ann

>>> pretty 1 <+> pretty "hello" <+> pretty 1.234
1 hello 1.234

prettyList :: [a] -> Doc ann

prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

>>> prettyList [1, 23, 456]
[1, 23, 456]

Instances

Pretty Bool

>>> pretty True
True

Defined in Prettyprinter.Internal

Methods

pretty :: Bool -> Doc ann

prettyList :: [Bool] -> Doc ann

Pretty Char

Instead of (pretty 'n'), consider using line as a more readable alternative.

>>> pretty 'f' <> pretty 'o' <> pretty 'o'
foo
>>> pretty ("string" :: String)
string

Defined in Prettyprinter.Internal

Methods

pretty :: Char -> Doc ann

prettyList :: [Char] -> Doc ann

Pretty Double

>>> pretty (exp 1 :: Double)
2.71828182845904...

Defined in Prettyprinter.Internal

Methods

pretty :: Double -> Doc ann

prettyList :: [Double] -> Doc ann

Pretty Float

>>> pretty (pi :: Float)
3.1415927

Defined in Prettyprinter.Internal

Methods

pretty :: Float -> Doc ann

prettyList :: [Float] -> Doc ann

Pretty Int

>>> pretty (123 :: Int)
123

Defined in Prettyprinter.Internal

Methods

pretty :: Int -> Doc ann

prettyList :: [Int] -> Doc ann

Pretty Int8

Defined in Prettyprinter.Internal

Methods

pretty :: Int8 -> Doc ann

prettyList :: [Int8] -> Doc ann

Pretty Int16

Defined in Prettyprinter.Internal

Methods

pretty :: Int16 -> Doc ann

prettyList :: [Int16] -> Doc ann

Pretty Int32

Defined in Prettyprinter.Internal

Methods

pretty :: Int32 -> Doc ann

prettyList :: [Int32] -> Doc ann

Pretty Int64

Defined in Prettyprinter.Internal

Methods

pretty :: Int64 -> Doc ann

prettyList :: [Int64] -> Doc ann

Pretty Integer

>>> pretty (2^123 :: Integer)
10633823966279326983230456482242756608

Defined in Prettyprinter.Internal

Methods

pretty :: Integer -> Doc ann

prettyList :: [Integer] -> Doc ann

Pretty Natural

Defined in Prettyprinter.Internal

Methods

pretty :: Natural -> Doc ann

prettyList :: [Natural] -> Doc ann

Pretty Word

Defined in Prettyprinter.Internal

Methods

pretty :: Word -> Doc ann

prettyList :: [Word] -> Doc ann

Pretty Word8

Defined in Prettyprinter.Internal

Methods

pretty :: Word8 -> Doc ann

prettyList :: [Word8] -> Doc ann

Pretty Word16

Defined in Prettyprinter.Internal

Methods

pretty :: Word16 -> Doc ann

prettyList :: [Word16] -> Doc ann

Pretty Word32

Defined in Prettyprinter.Internal

Methods

pretty :: Word32 -> Doc ann

prettyList :: [Word32] -> Doc ann

Pretty Word64

Defined in Prettyprinter.Internal

Methods

pretty :: Word64 -> Doc ann

prettyList :: [Word64] -> Doc ann

Pretty ()

>>> pretty ()
()

The argument is not used:

>>> pretty (error "Strict?" :: ())
()

Defined in Prettyprinter.Internal

Methods

pretty :: () -> Doc ann

prettyList :: [()] -> Doc ann

Pretty Text

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)
hello
world

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))
hello world

Manually use hardline if you definitely want newlines.

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Text

(lazy Text instance, identical to the strict version)

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Void

Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing.

>>> pretty ([] :: [Void])
[]

Defined in Prettyprinter.Internal

Methods

pretty :: Void -> Doc ann

prettyList :: [Void] -> Doc ann

Pretty Log

Defined in Development.IDE.Main.HeapStats

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Core.Shake

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Session

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Plugin.HLS

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Core.OfInterest

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Core.FileStore

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Core.Service

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.GHC.ExactPrint

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Core.Rules

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.LSP.LanguageServer

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Plugin.TypeLenses

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Plugin.Completions

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Plugin.HLS.GhcIde

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty Log

Defined in Development.IDE.Main

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann

Pretty a => Pretty [a]

>>> pretty [1,2,3]
[1, 2, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: [a] -> Doc ann

prettyList :: [[a]] -> Doc ann

Pretty a => Pretty (Maybe a)

Ignore Nothings, print Just contents.

>>> pretty (Just True)
True
>>> braces (pretty (Nothing :: Maybe Bool))
{}

>>> pretty [Just 1, Nothing, Just 3, Nothing]
[1, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: Maybe a -> Doc ann

prettyList :: [Maybe a] -> Doc ann

Pretty a => Pretty (Identity a)

>>> pretty (Identity 1)
1

Defined in Prettyprinter.Internal

Methods

pretty :: Identity a -> Doc ann

prettyList :: [Identity a] -> Doc ann

Pretty a => Pretty (NonEmpty a)

Defined in Prettyprinter.Internal

Methods

pretty :: NonEmpty a -> Doc ann

prettyList :: [NonEmpty a] -> Doc ann

(Pretty a1, Pretty a2) => Pretty (a1, a2)

>>> pretty (123, "hello")
(123, hello)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2) -> Doc ann

prettyList :: [(a1, a2)] -> Doc ann

(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)

>>> pretty (123, "hello", False)
(123, hello, False)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2, a3) -> Doc ann

prettyList :: [(a1, a2, a3)] -> Doc ann

Pretty a => Pretty (Const a b)

Defined in Prettyprinter.Internal

Methods

pretty :: Const a b -> Doc ann

prettyList :: [Const a b] -> Doc ann

data FusionDepth

Fusion depth parameter, used by fuse.

Constructors

Shallow

Do not dive deep into nested documents, fusing mostly concatenations of text nodes together.

Deep

Recurse into all parts of the Doc, including different layout alternatives, and location-sensitive values such as created by nesting which cannot be fused before, but only during, the layout process. As a result, the performance cost of using deep fusion is often hard to predict, and depends on the interplay between page layout and document to prettyprint.

This value should only be used if profiling shows it is significantly faster than using Shallow.

Instances

Eq FusionDepth

Defined in Prettyprinter.Internal

Methods

(==) :: FusionDepth -> FusionDepth -> Bool

(/=) :: FusionDepth -> FusionDepth -> Bool

Ord FusionDepth

Defined in Prettyprinter.Internal

Methods

compare :: FusionDepth -> FusionDepth -> Ordering

(<) :: FusionDepth -> FusionDepth -> Bool

(<=) :: FusionDepth -> FusionDepth -> Bool

(>) :: FusionDepth -> FusionDepth -> Bool

(>=) :: FusionDepth -> FusionDepth -> Bool

max :: FusionDepth -> FusionDepth -> FusionDepth

min :: FusionDepth -> FusionDepth -> FusionDepth

Show FusionDepth

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> FusionDepth -> ShowS

show :: FusionDepth -> String

showList :: [FusionDepth] -> ShowS

data SimpleDocStream ann

The data type SimpleDocStream represents laid out documents and is used by the display functions.

A simplified view is that Doc = [SimpleDocStream], and the layout functions pick one of the SimpleDocStreams based on which one fits the layout constraints best. This means that SimpleDocStream has all complexity contained in Doc resolved, making it very easy to convert it to other formats, such as plain text or terminal output.

To write your own Doc to X converter, it is therefore sufficient to convert from SimpleDocStream. The »Render« submodules provide some built-in converters to do so, and helpers to create own ones.

Constructors

SFail

SEmpty

SChar !Char (SimpleDocStream ann)

SText !Int !Text (SimpleDocStream ann)

length is O(n), so we cache it in the Int field.

SLine !Int (SimpleDocStream ann)

Int = indentation level for the (next) line

SAnnPush ann (SimpleDocStream ann)

Add an annotation to the remaining document.

SAnnPop (SimpleDocStream ann)

Remove a previously pushed annotation.

Instances

Functor SimpleDocStream

Alter the document’s annotations.

This instance makes SimpleDocStream more flexible (because it can be used in Functor-polymorphic values), but fmap is much less readable compared to using reAnnotateST in code that only works for SimpleDocStream anyway. Consider using the latter when the type does not matter.

Defined in Prettyprinter.Internal

Methods

fmap :: (a -> b) -> SimpleDocStream a -> SimpleDocStream b

(<$) :: a -> SimpleDocStream b -> SimpleDocStream a

Foldable SimpleDocStream

Collect all annotations from a document.

Defined in Prettyprinter.Internal

Methods

fold :: Monoid m => SimpleDocStream m -> m

foldMap :: Monoid m => (a -> m) -> SimpleDocStream a -> m

foldMap' :: Monoid m => (a -> m) -> SimpleDocStream a -> m

foldr :: (a -> b -> b) -> b -> SimpleDocStream a -> b

foldr' :: (a -> b -> b) -> b -> SimpleDocStream a -> b

foldl :: (b -> a -> b) -> b -> SimpleDocStream a -> b

foldl' :: (b -> a -> b) -> b -> SimpleDocStream a -> b

foldr1 :: (a -> a -> a) -> SimpleDocStream a -> a

foldl1 :: (a -> a -> a) -> SimpleDocStream a -> a

toList :: SimpleDocStream a -> [a]

null :: SimpleDocStream a -> Bool

length :: SimpleDocStream a -> Int

elem :: Eq a => a -> SimpleDocStream a -> Bool

maximum :: Ord a => SimpleDocStream a -> a

minimum :: Ord a => SimpleDocStream a -> a

sum :: Num a => SimpleDocStream a -> a

product :: Num a => SimpleDocStream a -> a

Traversable SimpleDocStream

Transform a document based on its annotations, possibly leveraging Applicative effects.

Defined in Prettyprinter.Internal

Methods

traverse :: Applicative f => (a -> f b) -> SimpleDocStream a -> f (SimpleDocStream b)

sequenceA :: Applicative f => SimpleDocStream (f a) -> f (SimpleDocStream a)

mapM :: Monad m => (a -> m b) -> SimpleDocStream a -> m (SimpleDocStream b)

sequence :: Monad m => SimpleDocStream (m a) -> m (SimpleDocStream a)

Eq ann => Eq (SimpleDocStream ann)

Defined in Prettyprinter.Internal

Methods

(==) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

(/=) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

Ord ann => Ord (SimpleDocStream ann)

Defined in Prettyprinter.Internal

Methods

compare :: SimpleDocStream ann -> SimpleDocStream ann -> Ordering

(<) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

(<=) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

(>) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

(>=) :: SimpleDocStream ann -> SimpleDocStream ann -> Bool

max :: SimpleDocStream ann -> SimpleDocStream ann -> SimpleDocStream ann

min :: SimpleDocStream ann -> SimpleDocStream ann -> SimpleDocStream ann

Show ann => Show (SimpleDocStream ann)

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> SimpleDocStream ann -> ShowS

show :: SimpleDocStream ann -> String

showList :: [SimpleDocStream ann] -> ShowS

Generic (SimpleDocStream ann)

Defined in Prettyprinter.Internal

Associated Types

type Rep (SimpleDocStream ann) :: Type -> Type

Methods

from :: SimpleDocStream ann -> Rep (SimpleDocStream ann) x

to :: Rep (SimpleDocStream ann) x -> SimpleDocStream ann

type Rep (SimpleDocStream ann)

Defined in Prettyprinter.Internal

type Rep (SimpleDocStream ann) = D1 ('MetaData "SimpleDocStream" "Prettyprinter.Internal" "prettyprinter-1.7.1-BauxLiNvN3EiJKyXe93SM" 'False) ((C1 ('MetaCons "SFail" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SEmpty" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SChar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocStream ann))))) :+: ((C1 ('MetaCons "SText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocStream ann)))) :+: C1 ('MetaCons "SLine" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocStream ann)))) :+: (C1 ('MetaCons "SAnnPush" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocStream ann))) :+: C1 ('MetaCons "SAnnPop" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocStream ann))))))

data PageWidth

Maximum number of characters that fit in one line. The layout algorithms will try not to exceed the set limit by inserting line breaks when applicable (e.g. via softline').

Constructors

AvailablePerLine !Int !Double

Layouters should not exceed the specified space per line.

• The Int is the number of characters, including whitespace, that fit in a line. A typical value is 80.
• The Double is the ribbon with, i.e. the fraction of the total page width that can be printed on. This allows limiting the length of printable text per line. Values must be between 0 and 1, and 0.4 to 1 is typical.

Unbounded

Layouters should not introduce line breaks on their own.

Instances

Eq PageWidth

Defined in Prettyprinter.Internal

Methods

(==) :: PageWidth -> PageWidth -> Bool

(/=) :: PageWidth -> PageWidth -> Bool

Ord PageWidth

Defined in Prettyprinter.Internal

Methods

compare :: PageWidth -> PageWidth -> Ordering

(<) :: PageWidth -> PageWidth -> Bool

(<=) :: PageWidth -> PageWidth -> Bool

(>) :: PageWidth -> PageWidth -> Bool

(>=) :: PageWidth -> PageWidth -> Bool

max :: PageWidth -> PageWidth -> PageWidth

min :: PageWidth -> PageWidth -> PageWidth

Show PageWidth

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> PageWidth -> ShowS

show :: PageWidth -> String

showList :: [PageWidth] -> ShowS

newtype LayoutOptions

Options to influence the layout algorithms.

Constructors

LayoutOptions

Fields

• layoutPageWidth :: PageWidth

Instances

Eq LayoutOptions

Defined in Prettyprinter.Internal

Methods

(==) :: LayoutOptions -> LayoutOptions -> Bool

(/=) :: LayoutOptions -> LayoutOptions -> Bool

Ord LayoutOptions

Defined in Prettyprinter.Internal

Methods

compare :: LayoutOptions -> LayoutOptions -> Ordering

(<) :: LayoutOptions -> LayoutOptions -> Bool

(<=) :: LayoutOptions -> LayoutOptions -> Bool

(>) :: LayoutOptions -> LayoutOptions -> Bool

(>=) :: LayoutOptions -> LayoutOptions -> Bool

max :: LayoutOptions -> LayoutOptions -> LayoutOptions

min :: LayoutOptions -> LayoutOptions -> LayoutOptions

Show LayoutOptions

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> LayoutOptions -> ShowS

show :: LayoutOptions -> String

showList :: [LayoutOptions] -> ShowS

data GhcVersion

Constructors

GHC86

GHC88

GHC810

GHC90

GHC92

Instances

Eq GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

(==) :: GhcVersion -> GhcVersion -> Bool

(/=) :: GhcVersion -> GhcVersion -> Bool

Ord GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

compare :: GhcVersion -> GhcVersion -> Ordering

(<) :: GhcVersion -> GhcVersion -> Bool

(<=) :: GhcVersion -> GhcVersion -> Bool

(>) :: GhcVersion -> GhcVersion -> Bool

(>=) :: GhcVersion -> GhcVersion -> Bool

max :: GhcVersion -> GhcVersion -> GhcVersion

min :: GhcVersion -> GhcVersion -> GhcVersion

Show GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

showsPrec :: Int -> GhcVersion -> ShowS

show :: GhcVersion -> String

showList :: [GhcVersion] -> ShowS

setHieDir :: FilePath -> DynFlags -> DynFlags

dontWriteHieFiles :: DynFlags -> DynFlags

disableWarningsAsErrors :: DynFlags -> DynFlags

ghcVersion :: GhcVersion

toNormalizedFilePath' :: FilePath -> NormalizedFilePath

emptyFilePath :: NormalizedFilePath

uriToFilePath' :: Uri -> Maybe FilePath

We use an empty string as a filepath when we don’t have a file. However, haskell-lsp doesn’t support that in uriToFilePath and given that it is not a valid filepath it does not make sense to upstream a fix. So we have our own wrapper here that supports empty filepaths.

emptyPathUri :: NormalizedUri

filePathToUri' :: NormalizedFilePath -> NormalizedUri

fromUri :: NormalizedUri -> NormalizedFilePath

noFilePath :: FilePath

noRange :: Range

showPosition :: Position -> String

readSrcSpan :: ReadS RealSrcSpan

Parser for the GHC output format

type FileDiagnostic = (NormalizedFilePath, ShowDiagnostic, Diagnostic)

Human readable diagnostics for a specific file.

This type packages a pretty printed, human readable error message along with the related source location so that we can display the error on either the console or in the IDE at the right source location.

data ShowDiagnostic

Defines whether a particular diagnostic should be reported back to the user.

One important use case is "missing signature" code lenses, for which we need to enable the corresponding warning during type checking. However, we do not want to show the warning unless the programmer asks for it (#261).

Constructors

ShowDiag

Report back to the user

HideDiag

Hide from user

Instances

Eq ShowDiagnostic

Defined in Development.IDE.Types.Diagnostics

Methods

(==) :: ShowDiagnostic -> ShowDiagnostic -> Bool

(/=) :: ShowDiagnostic -> ShowDiagnostic -> Bool

Ord ShowDiagnostic

Defined in Development.IDE.Types.Diagnostics

Methods

compare :: ShowDiagnostic -> ShowDiagnostic -> Ordering

(<) :: ShowDiagnostic -> ShowDiagnostic -> Bool

(<=) :: ShowDiagnostic -> ShowDiagnostic -> Bool

(>) :: ShowDiagnostic -> ShowDiagnostic -> Bool

(>=) :: ShowDiagnostic -> ShowDiagnostic -> Bool

max :: ShowDiagnostic -> ShowDiagnostic -> ShowDiagnostic

min :: ShowDiagnostic -> ShowDiagnostic -> ShowDiagnostic

Show ShowDiagnostic

Defined in Development.IDE.Types.Diagnostics

Methods

showsPrec :: Int -> ShowDiagnostic -> ShowS

show :: ShowDiagnostic -> String

showList :: [ShowDiagnostic] -> ShowS

NFData ShowDiagnostic

Defined in Development.IDE.Types.Diagnostics

Methods

rnf :: ShowDiagnostic -> ()

type IdeResultNoDiagnosticsEarlyCutoff v = (Maybe ByteString, Maybe v)

an IdeResult with a fingerprint

type IdeResult v = ([FileDiagnostic], Maybe v)

The result of an IDE operation. Warnings and errors are in the Diagnostic, and a value is in the Maybe. For operations that throw an error you expect a non-empty list of diagnostics, at least one of which is an error, and a Nothing. For operations that succeed you expect perhaps some warnings and a Just. For operations that depend on other failing operations you may get empty diagnostics and a Nothing, to indicate this phase throws no fresh errors but still failed.

A rule on a file should only return diagnostics for that given file. It should not propagate diagnostic errors through multiple phases.

ideErrorText :: NormalizedFilePath -> Text -> FileDiagnostic

ideErrorWithSource :: Maybe DiagnosticSource -> Maybe DiagnosticSeverity -> a -> Text -> (a, ShowDiagnostic, Diagnostic)

showDiagnostics :: [FileDiagnostic] -> Text

showDiagnosticsColored :: [FileDiagnostic] -> Text

modifyDynFlags :: GhcMonad m => (DynFlags -> DynFlags) -> m ()

Used to modify dyn flags in preference to calling setSessionDynFlags, since that function also reloads packages (which is very slow).

lookupPackageConfig :: Unit -> HscEnv -> Maybe UnitInfo

Given a Unit try and find the associated PackageConfig in the environment.

textToStringBuffer :: Text -> StringBuffer

Convert from the text package to the GHC StringBuffer. Currently implemented somewhat inefficiently (if it ever comes up in a profile).

runParser :: DynFlags -> String -> P a -> ParseResult a

stringBufferToByteString :: StringBuffer -> ByteString

bytestringToStringBuffer :: ByteString -> StringBuffer

printRdrName :: RdrName -> String

Pretty print a RdrName wrapping operators in parens

printName :: Name -> String

Pretty print a Name wrapping operators in parens

evalGhcEnv :: HscEnv -> Ghc b -> IO b

Run a Ghc monad value using an existing HscEnv. Sets up and tears down all the required pieces, but designed to be more efficient than a standard runGhc.

moduleImportPath :: NormalizedFilePath -> ModuleName -> Maybe FilePath

Given a module location, and its parse tree, figure out what is the include directory implied by it. For example, given the file /usr/Test/Foo/Bar.hs with the module name Foo.Bar the directory /usr/Test should be on the include path to find sibling modules.

readFileUtf8 :: FilePath -> IO Text

Read a UTF8 file, with lenient decoding, so it will never raise a decoding error.

cgGutsToCoreModule :: SafeHaskellMode -> CgGuts -> ModDetails -> CoreModule

Convert from a CgGuts to a CoreModule.

fingerprintToBS :: Fingerprint -> ByteString

Convert a Fingerprint to a ByteString by copying the byte across. Will produce an 8 byte unreadable ByteString.

fingerprintFromStringBuffer :: StringBuffer -> IO Fingerprint

Take the Fingerprint of a StringBuffer.

fingerprintFromByteString :: ByteString -> IO Fingerprint

fingerprintFromPut :: Put -> IO Fingerprint

hDuplicateTo' :: Handle -> Handle -> IO ()

A slightly modified version of hDuplicateTo from GHC. Importantly, it avoids the bug listed in https://gitlab.haskell.org/ghc/ghc/merge_requests/2318.

traceAst :: (Data a, ExactPrint a, Outputable a, HasCallStack) => String -> a -> a

Prints an Outputable value to stderr and to an HTML file for further inspection

printOutputable :: Outputable a => a -> Text

Print a GHC value in defaultUserStyle without unique symbols.

This is the most common print utility, will print with a user-friendly style like: a_a4ME as a.

It internal using showSDocUnsafe with unsafeGlobalDynFlags.

diagFromErrMsg :: Text -> DynFlags -> MsgEnvelope DecoratedSDoc -> [FileDiagnostic]

Produce a GHC-style error from a source span and a message.

diagFromErrMsgs :: Text -> DynFlags -> Bag (MsgEnvelope DecoratedSDoc) -> [FileDiagnostic]

srcSpanToRange :: SrcSpan -> Maybe Range

Convert a GHC SrcSpan to a DAML compiler Range

realSrcSpanToRange :: RealSrcSpan -> Range

realSrcLocToPosition :: RealSrcLoc -> Position

srcSpanToFilename :: SrcSpan -> Maybe FilePath

Extract a file name from a GHC SrcSpan (use message for unhelpful ones) FIXME This may not be an _absolute_ file name, needs fixing.

realSrcSpanToLocation :: RealSrcSpan -> Location

srcSpanToLocation :: SrcSpan -> Maybe Location

rangeToSrcSpan :: NormalizedFilePath -> Range -> SrcSpan

rangeToRealSrcSpan :: NormalizedFilePath -> Range -> RealSrcSpan

positionToRealSrcLoc :: NormalizedFilePath -> Position -> RealSrcLoc

isInsideSrcSpan :: Position -> SrcSpan -> Bool

toDSeverity :: Severity -> Maybe DiagnosticSeverity

Convert a GHC severity to a DAML compiler Severity. Severities below Warning level are dropped (returning Nothing).

diagFromStrings :: Text -> DiagnosticSeverity -> [(SrcSpan, String)] -> [FileDiagnostic]

Produce a bag of GHC-style errors (ErrorMessages) from the given (optional) locations and message strings.

diagFromString :: Text -> DiagnosticSeverity -> SrcSpan -> String -> [FileDiagnostic]

Produce a GHC-style error from a source span and a message.

noSpan :: String -> SrcSpan

Produces an "unhelpful" source span with the given string.

zeroSpan

Arguments

:: FastString

file path of span

-> RealSrcSpan

creates a span with zero length in the filename of the argument passed

realSpan :: SrcSpan -> Maybe RealSrcSpan

catchSrcErrors :: DynFlags -> Text -> IO a -> IO (Either [FileDiagnostic] a)

Catch the errors thrown by GHC (SourceErrors and compiler-internal exceptions like Panic or InstallationError), and turn them into diagnostics

diagFromGhcException :: Text -> DynFlags -> GhcException -> [FileDiagnostic]

data HscEnvEq

An HscEnv with equality. Two values are considered equal if they are created with the same call to newHscEnvEq.

Instances

Eq HscEnvEq

Defined in Development.IDE.Types.HscEnvEq

Methods

(==) :: HscEnvEq -> HscEnvEq -> Bool

(/=) :: HscEnvEq -> HscEnvEq -> Bool

Show HscEnvEq

Defined in Development.IDE.Types.HscEnvEq

Methods

showsPrec :: Int -> HscEnvEq -> ShowS

show :: HscEnvEq -> String

showList :: [HscEnvEq] -> ShowS

Hashable HscEnvEq

Defined in Development.IDE.Types.HscEnvEq

Methods

hashWithSalt :: Int -> HscEnvEq -> Int

hash :: HscEnvEq -> Int

NFData HscEnvEq

Defined in Development.IDE.Types.HscEnvEq

Methods

rnf :: HscEnvEq -> ()

hscEnvWithImportPaths :: HscEnvEq -> HscEnv

Unwrap the HscEnv with the original import paths. Used only for locating imports

data GhcSessionIO

Constructors

GhcSessionIO

Instances

Eq GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GhcSessionIO -> GhcSessionIO -> Bool

(/=) :: GhcSessionIO -> GhcSessionIO -> Bool

Show GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GhcSessionIO -> ShowS

show :: GhcSessionIO -> String

showList :: [GhcSessionIO] -> ShowS

Generic GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GhcSessionIO :: Type -> Type

Methods

from :: GhcSessionIO -> Rep GhcSessionIO x

to :: Rep GhcSessionIO x -> GhcSessionIO

Hashable GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GhcSessionIO -> Int

hash :: GhcSessionIO -> Int

NFData GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GhcSessionIO -> ()

type Rep GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

type Rep GhcSessionIO = D1 ('MetaData "GhcSessionIO" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GhcSessionIO" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GhcSessionIO

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSessionIO = IdeGhcSession

data IdeGhcSession

Constructors

IdeGhcSession

Fields

• loadSessionFun :: FilePath -> IO (IdeResult HscEnvEq, [FilePath])

  Returns the Ghc session and the cradle dependencies

• sessionVersion :: !Int

  Used as Shake key, versions must be unique and not reused

Instances

Show IdeGhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> IdeGhcSession -> ShowS

show :: IdeGhcSession -> String

showList :: [IdeGhcSession] -> ShowS

NFData IdeGhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: IdeGhcSession -> ()

data AddWatchedFile

Constructors

AddWatchedFile

Instances

Eq AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: AddWatchedFile -> AddWatchedFile -> Bool

(/=) :: AddWatchedFile -> AddWatchedFile -> Bool

Show AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> AddWatchedFile -> ShowS

show :: AddWatchedFile -> String

showList :: [AddWatchedFile] -> ShowS

Generic AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep AddWatchedFile :: Type -> Type

Methods

from :: AddWatchedFile -> Rep AddWatchedFile x

to :: Rep AddWatchedFile x -> AddWatchedFile

Hashable AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> AddWatchedFile -> Int

hash :: AddWatchedFile -> Int

NFData AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: AddWatchedFile -> ()

type Rep AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

type Rep AddWatchedFile = D1 ('MetaData "AddWatchedFile" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "AddWatchedFile" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult AddWatchedFile

Defined in Development.IDE.Core.RuleTypes

type RuleResult AddWatchedFile = Bool

data GetClientSettings

Get the vscode client settings stored in the ide state

Constructors

GetClientSettings

Instances

Eq GetClientSettings

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetClientSettings -> GetClientSettings -> Bool

(/=) :: GetClientSettings -> GetClientSettings -> Bool

Show GetClientSettings

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetClientSettings -> ShowS

show :: GetClientSettings -> String

showList :: [GetClientSettings] -> ShowS

Generic GetClientSettings

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetClientSettings :: Type -> Type

Methods

from :: GetClientSettings -> Rep GetClientSettings x

to :: Rep GetClientSettings x -> GetClientSettings

Hashable GetClientSettings

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetClientSettings -> Int

hash :: GetClientSettings -> Int

NFData GetClientSettings

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetClientSettings -> ()

type Rep GetClientSettings

Defined in Development.IDE.Core.RuleTypes

type Rep GetClientSettings = D1 ('MetaData "GetClientSettings" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetClientSettings" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetClientSettings

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetClientSettings = Hashed (Maybe Value)

data GetModSummary

Constructors

GetModSummary

Instances

Eq GetModSummary

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModSummary -> GetModSummary -> Bool

(/=) :: GetModSummary -> GetModSummary -> Bool

Show GetModSummary

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModSummary -> ShowS

show :: GetModSummary -> String

showList :: [GetModSummary] -> ShowS

Generic GetModSummary

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModSummary :: Type -> Type

Methods

from :: GetModSummary -> Rep GetModSummary x

to :: Rep GetModSummary x -> GetModSummary

Hashable GetModSummary

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModSummary -> Int

hash :: GetModSummary -> Int

NFData GetModSummary

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModSummary -> ()

type Rep GetModSummary

Defined in Development.IDE.Core.RuleTypes

type Rep GetModSummary = D1 ('MetaData "GetModSummary" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModSummary" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModSummary

Generate a ModSummary that has enough information to be used to get .hi and .hie files. without needing to parse the entire source

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModSummary = ModSummaryResult

data GetModSummaryWithoutTimestamps

Constructors

GetModSummaryWithoutTimestamps

Instances

Eq GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModSummaryWithoutTimestamps -> GetModSummaryWithoutTimestamps -> Bool

(/=) :: GetModSummaryWithoutTimestamps -> GetModSummaryWithoutTimestamps -> Bool

Show GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModSummaryWithoutTimestamps -> ShowS

show :: GetModSummaryWithoutTimestamps -> String

showList :: [GetModSummaryWithoutTimestamps] -> ShowS

Generic GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModSummaryWithoutTimestamps :: Type -> Type

Methods

from :: GetModSummaryWithoutTimestamps -> Rep GetModSummaryWithoutTimestamps x

to :: Rep GetModSummaryWithoutTimestamps x -> GetModSummaryWithoutTimestamps

Hashable GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModSummaryWithoutTimestamps -> Int

hash :: GetModSummaryWithoutTimestamps -> Int

NFData GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModSummaryWithoutTimestamps -> ()

type Rep GetModSummaryWithoutTimestamps

Defined in Development.IDE.Core.RuleTypes

type Rep GetModSummaryWithoutTimestamps = D1 ('MetaData "GetModSummaryWithoutTimestamps" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModSummaryWithoutTimestamps" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModSummaryWithoutTimestamps

Generate a ModSummary with the timestamps and preprocessed content elided, for more successful early cutoff

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModSummaryWithoutTimestamps = ModSummaryResult

data IsFileOfInterest

Constructors

IsFileOfInterest

Instances

Eq IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: IsFileOfInterest -> IsFileOfInterest -> Bool

(/=) :: IsFileOfInterest -> IsFileOfInterest -> Bool

Show IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> IsFileOfInterest -> ShowS

show :: IsFileOfInterest -> String

showList :: [IsFileOfInterest] -> ShowS

Generic IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep IsFileOfInterest :: Type -> Type

Methods

from :: IsFileOfInterest -> Rep IsFileOfInterest x

to :: Rep IsFileOfInterest x -> IsFileOfInterest

Hashable IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> IsFileOfInterest -> Int

hash :: IsFileOfInterest -> Int

NFData IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: IsFileOfInterest -> ()

type Rep IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

type Rep IsFileOfInterest = D1 ('MetaData "IsFileOfInterest" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "IsFileOfInterest" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult IsFileOfInterest

Defined in Development.IDE.Core.RuleTypes

type RuleResult IsFileOfInterest = IsFileOfInterestResult

data GetModIface

Constructors

GetModIface

Instances

Eq GetModIface

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModIface -> GetModIface -> Bool

(/=) :: GetModIface -> GetModIface -> Bool

Show GetModIface

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModIface -> ShowS

show :: GetModIface -> String

showList :: [GetModIface] -> ShowS

Generic GetModIface

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModIface :: Type -> Type

Methods

from :: GetModIface -> Rep GetModIface x

to :: Rep GetModIface x -> GetModIface

Hashable GetModIface

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModIface -> Int

hash :: GetModIface -> Int

NFData GetModIface

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModIface -> ()

type Rep GetModIface

Defined in Development.IDE.Core.RuleTypes

type Rep GetModIface = D1 ('MetaData "GetModIface" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModIface" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModIface

Get a module interface details, either from an interface file or a typechecked module

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIface = HiFileResult

data GetModIfaceFromDiskAndIndex

Constructors

GetModIfaceFromDiskAndIndex

Instances

Eq GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModIfaceFromDiskAndIndex -> GetModIfaceFromDiskAndIndex -> Bool

(/=) :: GetModIfaceFromDiskAndIndex -> GetModIfaceFromDiskAndIndex -> Bool

Show GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModIfaceFromDiskAndIndex -> ShowS

show :: GetModIfaceFromDiskAndIndex -> String

showList :: [GetModIfaceFromDiskAndIndex] -> ShowS

Generic GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModIfaceFromDiskAndIndex :: Type -> Type

Methods

from :: GetModIfaceFromDiskAndIndex -> Rep GetModIfaceFromDiskAndIndex x

to :: Rep GetModIfaceFromDiskAndIndex x -> GetModIfaceFromDiskAndIndex

Hashable GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModIfaceFromDiskAndIndex -> Int

hash :: GetModIfaceFromDiskAndIndex -> Int

NFData GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModIfaceFromDiskAndIndex -> ()

type Rep GetModIfaceFromDiskAndIndex

Defined in Development.IDE.Core.RuleTypes

type Rep GetModIfaceFromDiskAndIndex = D1 ('MetaData "GetModIfaceFromDiskAndIndex" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModIfaceFromDiskAndIndex" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModIfaceFromDiskAndIndex

GetModIfaceFromDisk and index the `.hie` file into the database. This is an internal rule, use GetModIface instead.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIfaceFromDiskAndIndex = HiFileResult

data GetModIfaceFromDisk

Constructors

GetModIfaceFromDisk

Instances

Eq GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModIfaceFromDisk -> GetModIfaceFromDisk -> Bool

(/=) :: GetModIfaceFromDisk -> GetModIfaceFromDisk -> Bool

Show GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModIfaceFromDisk -> ShowS

show :: GetModIfaceFromDisk -> String

showList :: [GetModIfaceFromDisk] -> ShowS

Generic GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModIfaceFromDisk :: Type -> Type

Methods

from :: GetModIfaceFromDisk -> Rep GetModIfaceFromDisk x

to :: Rep GetModIfaceFromDisk x -> GetModIfaceFromDisk

Hashable GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModIfaceFromDisk -> Int

hash :: GetModIfaceFromDisk -> Int

NFData GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModIfaceFromDisk -> ()

type Rep GetModIfaceFromDisk

Defined in Development.IDE.Core.RuleTypes

type Rep GetModIfaceFromDisk = D1 ('MetaData "GetModIfaceFromDisk" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModIfaceFromDisk" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModIfaceFromDisk

Read the module interface file from disk. Throws an error for VFS files. This is an internal rule, use GetModIface instead.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModIfaceFromDisk = HiFileResult

newtype GhcSessionDeps

Constructors

GhcSessionDeps_

Fields

• fullModSummary :: Bool

  Load full ModSummary values in the GHC session. Required for interactive evaluation, but leads to more cache invalidations

Bundled Patterns

pattern GhcSessionDeps :: GhcSessionDeps

Instances

Eq GhcSessionDeps

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GhcSessionDeps -> GhcSessionDeps -> Bool

(/=) :: GhcSessionDeps -> GhcSessionDeps -> Bool

Show GhcSessionDeps

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GhcSessionDeps -> ShowS

show :: GhcSessionDeps -> String

showList :: [GhcSessionDeps] -> ShowS

Hashable GhcSessionDeps

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GhcSessionDeps -> Int

hash :: GhcSessionDeps -> Int

NFData GhcSessionDeps

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GhcSessionDeps -> ()

type RuleResult GhcSessionDeps

A GHC session preloaded with all the dependencies This rule is also responsible for calling ReportImportCycles for the direct dependencies

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSessionDeps = HscEnvEq

data GhcSession

Constructors

GhcSession

Instances

Eq GhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GhcSession -> GhcSession -> Bool

(/=) :: GhcSession -> GhcSession -> Bool

Show GhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GhcSession -> ShowS

show :: GhcSession -> String

showList :: [GhcSession] -> ShowS

Generic GhcSession

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GhcSession :: Type -> Type

Methods

from :: GhcSession -> Rep GhcSession x

to :: Rep GhcSession x -> GhcSession

Hashable GhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GhcSession -> Int

hash :: GhcSession -> Int

NFData GhcSession

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GhcSession -> ()

type Rep GhcSession

Defined in Development.IDE.Core.RuleTypes

type Rep GhcSession = D1 ('MetaData "GhcSession" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GhcSession" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GhcSession

A GHC session that we reuse.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GhcSession = HscEnvEq

data GetBindings

Constructors

GetBindings

Instances

Eq GetBindings

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetBindings -> GetBindings -> Bool

(/=) :: GetBindings -> GetBindings -> Bool

Show GetBindings

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetBindings -> ShowS

show :: GetBindings -> String

showList :: [GetBindings] -> ShowS

Generic GetBindings

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetBindings :: Type -> Type

Methods

from :: GetBindings -> Rep GetBindings x

to :: Rep GetBindings x -> GetBindings

Hashable GetBindings

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetBindings -> Int

hash :: GetBindings -> Int

NFData GetBindings

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetBindings -> ()

type Rep GetBindings

Defined in Development.IDE.Core.RuleTypes

type Rep GetBindings = D1 ('MetaData "GetBindings" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetBindings" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetBindings

A IntervalMap telling us what is in scope at each point

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetBindings = Bindings

data GetHieAst

Constructors

GetHieAst

Instances

Eq GetHieAst

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetHieAst -> GetHieAst -> Bool

(/=) :: GetHieAst -> GetHieAst -> Bool

Show GetHieAst

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetHieAst -> ShowS

show :: GetHieAst -> String

showList :: [GetHieAst] -> ShowS

Generic GetHieAst

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetHieAst :: Type -> Type

Methods

from :: GetHieAst -> Rep GetHieAst x

to :: Rep GetHieAst x -> GetHieAst

Hashable GetHieAst

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetHieAst -> Int

hash :: GetHieAst -> Int

NFData GetHieAst

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetHieAst -> ()

type Rep GetHieAst

Defined in Development.IDE.Core.RuleTypes

type Rep GetHieAst = D1 ('MetaData "GetHieAst" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetHieAst" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetHieAst

The uncompressed HieAST

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetHieAst = HieAstResult

data GetDocMap

Constructors

GetDocMap

Instances

Eq GetDocMap

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetDocMap -> GetDocMap -> Bool

(/=) :: GetDocMap -> GetDocMap -> Bool

Show GetDocMap

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetDocMap -> ShowS

show :: GetDocMap -> String

showList :: [GetDocMap] -> ShowS

Generic GetDocMap

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetDocMap :: Type -> Type

Methods

from :: GetDocMap -> Rep GetDocMap x

to :: Rep GetDocMap x -> GetDocMap

Hashable GetDocMap

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetDocMap -> Int

hash :: GetDocMap -> Int

NFData GetDocMap

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetDocMap -> ()

type Rep GetDocMap

Defined in Development.IDE.Core.RuleTypes

type Rep GetDocMap = D1 ('MetaData "GetDocMap" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetDocMap" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetDocMap

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetDocMap = DocAndKindMap

data TypeCheck

Constructors

TypeCheck

Instances

Eq TypeCheck

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: TypeCheck -> TypeCheck -> Bool

(/=) :: TypeCheck -> TypeCheck -> Bool

Show TypeCheck

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> TypeCheck -> ShowS

show :: TypeCheck -> String

showList :: [TypeCheck] -> ShowS

Generic TypeCheck

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep TypeCheck :: Type -> Type

Methods

from :: TypeCheck -> Rep TypeCheck x

to :: Rep TypeCheck x -> TypeCheck

Hashable TypeCheck

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> TypeCheck -> Int

hash :: TypeCheck -> Int

NFData TypeCheck

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: TypeCheck -> ()

type Rep TypeCheck

Defined in Development.IDE.Core.RuleTypes

type Rep TypeCheck = D1 ('MetaData "TypeCheck" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "TypeCheck" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult TypeCheck

The type checked version of this file, requires TypeCheck+

Defined in Development.IDE.Core.RuleTypes

type RuleResult TypeCheck = TcModuleResult

data ReportImportCycles

Constructors

ReportImportCycles

Instances

Eq ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: ReportImportCycles -> ReportImportCycles -> Bool

(/=) :: ReportImportCycles -> ReportImportCycles -> Bool

Show ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> ReportImportCycles -> ShowS

show :: ReportImportCycles -> String

showList :: [ReportImportCycles] -> ShowS

Generic ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep ReportImportCycles :: Type -> Type

Methods

from :: ReportImportCycles -> Rep ReportImportCycles x

to :: Rep ReportImportCycles x -> ReportImportCycles

Hashable ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> ReportImportCycles -> Int

hash :: ReportImportCycles -> Int

NFData ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: ReportImportCycles -> ()

type Rep ReportImportCycles

Defined in Development.IDE.Core.RuleTypes

type Rep ReportImportCycles = D1 ('MetaData "ReportImportCycles" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "ReportImportCycles" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult ReportImportCycles

This rule is used to report import cycles. It depends on GetDependencyInformation. We cannot report the cycles directly from GetDependencyInformation since we can only report diagnostics for the current file.

Defined in Development.IDE.Core.RuleTypes

type RuleResult ReportImportCycles = ()

data GetModuleGraph

Constructors

GetModuleGraph

Instances

Eq GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModuleGraph -> GetModuleGraph -> Bool

(/=) :: GetModuleGraph -> GetModuleGraph -> Bool

Show GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModuleGraph -> ShowS

show :: GetModuleGraph -> String

showList :: [GetModuleGraph] -> ShowS

Generic GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModuleGraph :: Type -> Type

Methods

from :: GetModuleGraph -> Rep GetModuleGraph x

to :: Rep GetModuleGraph x -> GetModuleGraph

Hashable GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModuleGraph -> Int

hash :: GetModuleGraph -> Int

NFData GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModuleGraph -> ()

type Rep GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

type Rep GetModuleGraph = D1 ('MetaData "GetModuleGraph" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetModuleGraph" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetModuleGraph

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModuleGraph = DependencyInformation

data GetDependencyInformation

Constructors

GetDependencyInformation

Instances

Eq GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetDependencyInformation -> GetDependencyInformation -> Bool

(/=) :: GetDependencyInformation -> GetDependencyInformation -> Bool

Show GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetDependencyInformation -> ShowS

show :: GetDependencyInformation -> String

showList :: [GetDependencyInformation] -> ShowS

Generic GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetDependencyInformation :: Type -> Type

Methods

from :: GetDependencyInformation -> Rep GetDependencyInformation x

to :: Rep GetDependencyInformation x -> GetDependencyInformation

Hashable GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetDependencyInformation -> Int

hash :: GetDependencyInformation -> Int

NFData GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetDependencyInformation -> ()

type Rep GetDependencyInformation

Defined in Development.IDE.Core.RuleTypes

type Rep GetDependencyInformation = D1 ('MetaData "GetDependencyInformation" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetDependencyInformation" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetDependencyInformation

The dependency information produced by following the imports recursively. This rule will succeed even if there is an error, e.g., a module could not be located, a module could not be parsed or an import cycle.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetDependencyInformation = DependencyInformation

data NeedsCompilation

Constructors

NeedsCompilation

Instances

Eq NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: NeedsCompilation -> NeedsCompilation -> Bool

(/=) :: NeedsCompilation -> NeedsCompilation -> Bool

Show NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> NeedsCompilation -> ShowS

show :: NeedsCompilation -> String

showList :: [NeedsCompilation] -> ShowS

Generic NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep NeedsCompilation :: Type -> Type

Methods

from :: NeedsCompilation -> Rep NeedsCompilation x

to :: Rep NeedsCompilation x -> NeedsCompilation

Hashable NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> NeedsCompilation -> Int

hash :: NeedsCompilation -> Int

NFData NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: NeedsCompilation -> ()

type Rep NeedsCompilation

Defined in Development.IDE.Core.RuleTypes

type Rep NeedsCompilation = D1 ('MetaData "NeedsCompilation" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "NeedsCompilation" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult NeedsCompilation

Does this module need to be compiled?

Defined in Development.IDE.Core.RuleTypes

type RuleResult NeedsCompilation = Maybe LinkableType

data GetLocatedImports

Constructors

GetLocatedImports

Instances

Eq GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetLocatedImports -> GetLocatedImports -> Bool

(/=) :: GetLocatedImports -> GetLocatedImports -> Bool

Show GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetLocatedImports -> ShowS

show :: GetLocatedImports -> String

showList :: [GetLocatedImports] -> ShowS

Generic GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetLocatedImports :: Type -> Type

Methods

from :: GetLocatedImports -> Rep GetLocatedImports x

to :: Rep GetLocatedImports x -> GetLocatedImports

Hashable GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetLocatedImports -> Int

hash :: GetLocatedImports -> Int

NFData GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetLocatedImports -> ()

type Rep GetLocatedImports

Defined in Development.IDE.Core.RuleTypes

type Rep GetLocatedImports = D1 ('MetaData "GetLocatedImports" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetLocatedImports" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetLocatedImports

Resolve the imports in a module to the file path of a module in the same package

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetLocatedImports = [(Located ModuleName, Maybe ArtifactsLocation)]

data GetParsedModuleWithComments

Constructors

GetParsedModuleWithComments

Instances

Eq GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetParsedModuleWithComments -> GetParsedModuleWithComments -> Bool

(/=) :: GetParsedModuleWithComments -> GetParsedModuleWithComments -> Bool

Show GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetParsedModuleWithComments -> ShowS

show :: GetParsedModuleWithComments -> String

showList :: [GetParsedModuleWithComments] -> ShowS

Generic GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetParsedModuleWithComments :: Type -> Type

Methods

from :: GetParsedModuleWithComments -> Rep GetParsedModuleWithComments x

to :: Rep GetParsedModuleWithComments x -> GetParsedModuleWithComments

Hashable GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetParsedModuleWithComments -> Int

hash :: GetParsedModuleWithComments -> Int

NFData GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetParsedModuleWithComments -> ()

type Rep GetParsedModuleWithComments

Defined in Development.IDE.Core.RuleTypes

type Rep GetParsedModuleWithComments = D1 ('MetaData "GetParsedModuleWithComments" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetParsedModuleWithComments" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetParsedModuleWithComments

The parse tree for the file using GetFileContents, all comments included using Opt_KeepRawTokenStream

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetParsedModuleWithComments = ParsedModule

data GetParsedModule

Constructors

GetParsedModule

Instances

Eq GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetParsedModule -> GetParsedModule -> Bool

(/=) :: GetParsedModule -> GetParsedModule -> Bool

Show GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetParsedModule -> ShowS

show :: GetParsedModule -> String

showList :: [GetParsedModule] -> ShowS

Generic GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetParsedModule :: Type -> Type

Methods

from :: GetParsedModule -> Rep GetParsedModule x

to :: Rep GetParsedModule x -> GetParsedModule

Hashable GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetParsedModule -> Int

hash :: GetParsedModule -> Int

NFData GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetParsedModule -> ()

type Rep GetParsedModule

Defined in Development.IDE.Core.RuleTypes

type Rep GetParsedModule = D1 ('MetaData "GetParsedModule" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetParsedModule" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetParsedModule

The parse tree for the file using GetFileContents

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetParsedModule = ParsedModule

data ModSummaryResult

Constructors

ModSummaryResult

Fields

• msrModSummary :: !ModSummary
• msrImports :: [LImportDecl GhcPs]
• msrFingerprint :: !Fingerprint

Instances

Show ModSummaryResult

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> ModSummaryResult -> ShowS

show :: ModSummaryResult -> String

showList :: [ModSummaryResult] -> ShowS

NFData ModSummaryResult

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: ModSummaryResult -> ()

data IsFileOfInterestResult

Constructors

NotFOI

IsFOI FileOfInterestStatus

Instances

Eq IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: IsFileOfInterestResult -> IsFileOfInterestResult -> Bool

(/=) :: IsFileOfInterestResult -> IsFileOfInterestResult -> Bool

Show IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> IsFileOfInterestResult -> ShowS

show :: IsFileOfInterestResult -> String

showList :: [IsFileOfInterestResult] -> ShowS

Generic IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep IsFileOfInterestResult :: Type -> Type

Methods

from :: IsFileOfInterestResult -> Rep IsFileOfInterestResult x

to :: Rep IsFileOfInterestResult x -> IsFileOfInterestResult

Hashable IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> IsFileOfInterestResult -> Int

hash :: IsFileOfInterestResult -> Int

NFData IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: IsFileOfInterestResult -> ()

type Rep IsFileOfInterestResult

Defined in Development.IDE.Core.RuleTypes

type Rep IsFileOfInterestResult = D1 ('MetaData "IsFileOfInterestResult" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "NotFOI" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IsFOI" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileOfInterestStatus)))

data FileOfInterestStatus

Constructors

OnDisk

Modified

Fields

• firstOpen :: !Bool

  was this file just opened

Instances

Eq FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: FileOfInterestStatus -> FileOfInterestStatus -> Bool

(/=) :: FileOfInterestStatus -> FileOfInterestStatus -> Bool

Show FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> FileOfInterestStatus -> ShowS

show :: FileOfInterestStatus -> String

showList :: [FileOfInterestStatus] -> ShowS

Generic FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep FileOfInterestStatus :: Type -> Type

Methods

from :: FileOfInterestStatus -> Rep FileOfInterestStatus x

to :: Rep FileOfInterestStatus x -> FileOfInterestStatus

Hashable FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> FileOfInterestStatus -> Int

hash :: FileOfInterestStatus -> Int

NFData FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: FileOfInterestStatus -> ()

type Rep FileOfInterestStatus

Defined in Development.IDE.Core.RuleTypes

type Rep FileOfInterestStatus = D1 ('MetaData "FileOfInterestStatus" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "OnDisk" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Modified" 'PrefixI 'True) (S1 ('MetaSel ('Just "firstOpen") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))

data GetFileExists

Constructors

GetFileExists

Instances

Eq GetFileExists

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetFileExists -> GetFileExists -> Bool

(/=) :: GetFileExists -> GetFileExists -> Bool

Show GetFileExists

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetFileExists -> ShowS

show :: GetFileExists -> String

showList :: [GetFileExists] -> ShowS

Generic GetFileExists

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetFileExists :: Type -> Type

Methods

from :: GetFileExists -> Rep GetFileExists x

to :: Rep GetFileExists x -> GetFileExists

Hashable GetFileExists

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetFileExists -> Int

hash :: GetFileExists -> Int

NFData GetFileExists

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetFileExists -> ()

type Rep GetFileExists

Defined in Development.IDE.Core.RuleTypes

type Rep GetFileExists = D1 ('MetaData "GetFileExists" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetFileExists" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetFileExists

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetFileExists = Bool

data GetFileContents

Constructors

GetFileContents

Instances

Eq GetFileContents

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetFileContents -> GetFileContents -> Bool

(/=) :: GetFileContents -> GetFileContents -> Bool

Show GetFileContents

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetFileContents -> ShowS

show :: GetFileContents -> String

showList :: [GetFileContents] -> ShowS

Generic GetFileContents

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetFileContents :: Type -> Type

Methods

from :: GetFileContents -> Rep GetFileContents x

to :: Rep GetFileContents x -> GetFileContents

Hashable GetFileContents

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetFileContents -> Int

hash :: GetFileContents -> Int

NFData GetFileContents

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetFileContents -> ()

type Rep GetFileContents

Defined in Development.IDE.Core.RuleTypes

type Rep GetFileContents = D1 ('MetaData "GetFileContents" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetFileContents" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetFileContents

Get the contents of a file, either dirty (if the buffer is modified) or Nothing to mean use from disk.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetFileContents = (FileVersion, Maybe Text)

data FileVersion

Either the mtime from disk or an LSP version LSP versions always compare as greater than on disk versions

Constructors

ModificationTime !POSIXTime

VFSVersion !Int32

Instances

Eq FileVersion

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: FileVersion -> FileVersion -> Bool

(/=) :: FileVersion -> FileVersion -> Bool

Ord FileVersion

Defined in Development.IDE.Core.RuleTypes

Methods

compare :: FileVersion -> FileVersion -> Ordering

(<) :: FileVersion -> FileVersion -> Bool

(<=) :: FileVersion -> FileVersion -> Bool

(>) :: FileVersion -> FileVersion -> Bool

(>=) :: FileVersion -> FileVersion -> Bool

max :: FileVersion -> FileVersion -> FileVersion

min :: FileVersion -> FileVersion -> FileVersion

Show FileVersion

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> FileVersion -> ShowS

show :: FileVersion -> String

showList :: [FileVersion] -> ShowS

Generic FileVersion

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep FileVersion :: Type -> Type

Methods

from :: FileVersion -> Rep FileVersion x

to :: Rep FileVersion x -> FileVersion

NFData FileVersion

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: FileVersion -> ()

type Rep FileVersion

Defined in Development.IDE.Core.RuleTypes

type Rep FileVersion = D1 ('MetaData "FileVersion" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "ModificationTime" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 POSIXTime)) :+: C1 ('MetaCons "VFSVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int32)))

newtype GetModificationTime

Constructors

GetModificationTime_

Fields

• missingFileDiagnostics :: Bool

  If false, missing file diagnostics are not reported

Instances

Eq GetModificationTime

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetModificationTime -> GetModificationTime -> Bool

(/=) :: GetModificationTime -> GetModificationTime -> Bool

Show GetModificationTime

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetModificationTime -> ShowS

show :: GetModificationTime -> String

showList :: [GetModificationTime] -> ShowS

Generic GetModificationTime

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetModificationTime :: Type -> Type

Methods

from :: GetModificationTime -> Rep GetModificationTime x

to :: Rep GetModificationTime x -> GetModificationTime

Hashable GetModificationTime

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetModificationTime -> Int

hash :: GetModificationTime -> Int

NFData GetModificationTime

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetModificationTime -> ()

type Rep GetModificationTime

Defined in Development.IDE.Core.RuleTypes

type Rep GetModificationTime = D1 ('MetaData "GetModificationTime" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'True) (C1 ('MetaCons "GetModificationTime_" 'PrefixI 'True) (S1 ('MetaSel ('Just "missingFileDiagnostics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

type RuleResult GetModificationTime

Get the modification time of a file.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetModificationTime = FileVersion

data DocAndKindMap

Constructors

DKMap

Fields

• getDocMap :: !DocMap
• getKindMap :: !KindMap

Instances

Show DocAndKindMap

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> DocAndKindMap -> ShowS

show :: DocAndKindMap -> String

showList :: [DocAndKindMap] -> ShowS

NFData DocAndKindMap

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: DocAndKindMap -> ()

data HieKind a where

Constructors

HieFromDisk :: !HieFile -> HieKind TypeIndex

HieFresh :: HieKind Type

Instances

NFData (HieKind a)

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: HieKind a -> ()

data HieAstResult

Save the uncompressed AST here, we compress it just before writing to disk

Constructors

forall a. HAR

Fields

• hieModule :: Module
• hieAst :: !(HieASTs a)
• refMap :: RefMap a

  Lazy because its value only depends on the hieAst, which is bundled in this type Lazyness can't cause leaks here because the lifetime of refMap will be the same as that of hieAst

• typeRefs :: Map Name [RealSrcSpan]

  type references in this file

• hieKind :: !(HieKind a)

  Is this hie file loaded from the disk, or freshly computed?

Instances

Show HieAstResult

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> HieAstResult -> ShowS

show :: HieAstResult -> String

showList :: [HieAstResult] -> ShowS

NFData HieAstResult

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: HieAstResult -> ()

data HiFileResult

Constructors

HiFileResult

Fields

• hirModSummary :: !ModSummary
• hirHomeMod :: !HomeModInfo

  Includes the Linkable iff we need object files

• hirIfaceFp :: ByteString

  Fingerprint for the ModIface

• hirLinkableFp :: ByteString

  Fingerprint for the Linkable

• hirRuntimeModules :: !(ModuleEnv UTCTime)

  same as tmrRuntimeModules

Instances

Show HiFileResult

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> HiFileResult -> ShowS

show :: HiFileResult -> String

showList :: [HiFileResult] -> ShowS

NFData HiFileResult

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: HiFileResult -> ()

data TcModuleResult

Contains the typechecked module and the OrigNameCache entry for that module.

Constructors

TcModuleResult

Fields

• tmrParsed :: ParsedModule
• tmrRenamed :: RenamedSource
• tmrTypechecked :: TcGblEnv
• tmrTopLevelSplices :: Splices

  Typechecked splice information

• tmrDeferedError :: !Bool

  Did we defer any type errors for this module?

• tmrRuntimeModules :: !(ModuleEnv UTCTime)

  Which modules did we need at runtime while compiling this file? Used for recompilation checking in the presence of TH

Instances

Show TcModuleResult

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> TcModuleResult -> ShowS

show :: TcModuleResult -> String

showList :: [TcModuleResult] -> ShowS

NFData TcModuleResult

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: TcModuleResult -> ()

data Splices

Constructors

Splices

Fields

• exprSplices :: [(LHsExpr GhcTc, LHsExpr GhcPs)]
• patSplices :: [(LHsExpr GhcTc, LPat GhcPs)]
• typeSplices :: [(LHsExpr GhcTc, LHsType GhcPs)]
• declSplices :: [(LHsExpr GhcTc, [LHsDecl GhcPs])]
• awSplices :: [(LHsExpr GhcTc, Serialized)]

Instances

Semigroup Splices

Defined in Development.IDE.Core.RuleTypes

Methods

(<>) :: Splices -> Splices -> Splices

sconcat :: NonEmpty Splices -> Splices

stimes :: Integral b => b -> Splices -> Splices

Monoid Splices

Defined in Development.IDE.Core.RuleTypes

Methods

mempty :: Splices

mappend :: Splices -> Splices -> Splices

mconcat :: [Splices] -> Splices

NFData Splices

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: Splices -> ()

newtype ImportMap

Constructors

ImportMap

Fields

• importMap :: Map ModuleName NormalizedFilePath

  Where are the modules imported by this file located?

Instances

Show ImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> ImportMap -> ShowS

show :: ImportMap -> String

showList :: [ImportMap] -> ShowS

NFData ImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: ImportMap -> ()

data GetImportMap

Constructors

GetImportMap

Instances

Eq GetImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetImportMap -> GetImportMap -> Bool

(/=) :: GetImportMap -> GetImportMap -> Bool

Show GetImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetImportMap -> ShowS

show :: GetImportMap -> String

showList :: [GetImportMap] -> ShowS

Generic GetImportMap

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetImportMap :: Type -> Type

Methods

from :: GetImportMap -> Rep GetImportMap x

to :: Rep GetImportMap x -> GetImportMap

Hashable GetImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetImportMap -> Int

hash :: GetImportMap -> Int

NFData GetImportMap

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetImportMap -> ()

type Rep GetImportMap

Defined in Development.IDE.Core.RuleTypes

type Rep GetImportMap = D1 ('MetaData "GetImportMap" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetImportMap" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetImportMap

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetImportMap = ImportMap

data GenerateCore

Constructors

GenerateCore

Instances

Eq GenerateCore

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GenerateCore -> GenerateCore -> Bool

(/=) :: GenerateCore -> GenerateCore -> Bool

Show GenerateCore

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GenerateCore -> ShowS

show :: GenerateCore -> String

showList :: [GenerateCore] -> ShowS

Generic GenerateCore

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GenerateCore :: Type -> Type

Methods

from :: GenerateCore -> Rep GenerateCore x

to :: Rep GenerateCore x -> GenerateCore

Hashable GenerateCore

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GenerateCore -> Int

hash :: GenerateCore -> Int

NFData GenerateCore

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GenerateCore -> ()

type Rep GenerateCore

Defined in Development.IDE.Core.RuleTypes

type Rep GenerateCore = D1 ('MetaData "GenerateCore" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GenerateCore" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GenerateCore

Convert to Core, requires TypeCheck*

Defined in Development.IDE.Core.RuleTypes

type RuleResult GenerateCore = ModGuts

data GetKnownTargets

Constructors

GetKnownTargets

Instances

Eq GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetKnownTargets -> GetKnownTargets -> Bool

(/=) :: GetKnownTargets -> GetKnownTargets -> Bool

Ord GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Methods

compare :: GetKnownTargets -> GetKnownTargets -> Ordering

(<) :: GetKnownTargets -> GetKnownTargets -> Bool

(<=) :: GetKnownTargets -> GetKnownTargets -> Bool

(>) :: GetKnownTargets -> GetKnownTargets -> Bool

(>=) :: GetKnownTargets -> GetKnownTargets -> Bool

max :: GetKnownTargets -> GetKnownTargets -> GetKnownTargets

min :: GetKnownTargets -> GetKnownTargets -> GetKnownTargets

Show GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetKnownTargets -> ShowS

show :: GetKnownTargets -> String

showList :: [GetKnownTargets] -> ShowS

Generic GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetKnownTargets :: Type -> Type

Methods

from :: GetKnownTargets -> Rep GetKnownTargets x

to :: Rep GetKnownTargets x -> GetKnownTargets

Hashable GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetKnownTargets -> Int

hash :: GetKnownTargets -> Int

NFData GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetKnownTargets -> ()

type Rep GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

type Rep GetKnownTargets = D1 ('MetaData "GetKnownTargets" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "GetKnownTargets" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult GetKnownTargets

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetKnownTargets = KnownTargets

data LinkableType

Constructors

ObjectLinkable

BCOLinkable

Instances

Eq LinkableType

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: LinkableType -> LinkableType -> Bool

(/=) :: LinkableType -> LinkableType -> Bool

Ord LinkableType

Defined in Development.IDE.Core.RuleTypes

Methods

compare :: LinkableType -> LinkableType -> Ordering

(<) :: LinkableType -> LinkableType -> Bool

(<=) :: LinkableType -> LinkableType -> Bool

(>) :: LinkableType -> LinkableType -> Bool

(>=) :: LinkableType -> LinkableType -> Bool

max :: LinkableType -> LinkableType -> LinkableType

min :: LinkableType -> LinkableType -> LinkableType

Show LinkableType

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> LinkableType -> ShowS

show :: LinkableType -> String

showList :: [LinkableType] -> ShowS

Generic LinkableType

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep LinkableType :: Type -> Type

Methods

from :: LinkableType -> Rep LinkableType x

to :: Rep LinkableType x -> LinkableType

Hashable LinkableType

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> LinkableType -> Int

hash :: LinkableType -> Int

NFData LinkableType

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: LinkableType -> ()

type Rep LinkableType

Defined in Development.IDE.Core.RuleTypes

type Rep LinkableType = D1 ('MetaData "LinkableType" "Development.IDE.Core.RuleTypes" "ghcide-1.7.0.0-Et6Gp1ZnqTjGFkpVtgQ7GA" 'False) (C1 ('MetaCons "ObjectLinkable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BCOLinkable" 'PrefixI 'False) (U1 :: Type -> Type))

pattern GetModificationTime :: GetModificationTime

encodeLinkableType :: Maybe LinkableType -> ByteString

Encode the linkable into an ordered bytestring. This is used to drive an ordered "newness" predicate in the NeedsCompilation build rule.

tmrModSummary :: TcModuleResult -> ModSummary

hiFileFingerPrint :: HiFileResult -> ByteString

mkHiFileResult :: ModSummary -> HomeModInfo -> ModuleEnv UTCTime -> HiFileResult

hirModIface :: HiFileResult -> ModIface

vfsVersion :: FileVersion -> Maybe Int32

awSplicesL :: Lens' Splices [(LHsExpr GhcTc, Serialized)]

declSplicesL :: Lens' Splices [(LHsExpr GhcTc, [LHsDecl GhcPs])]

exprSplicesL :: Lens' Splices [(LHsExpr GhcTc, LHsExpr GhcPs)]

patSplicesL :: Lens' Splices [(LHsExpr GhcTc, LPat GhcPs)]

typeSplicesL :: Lens' Splices [(LHsExpr GhcTc, LHsType GhcPs)]

data LoggingColumn

Constructors

TimeColumn

ThreadIdColumn

PriorityColumn

DataColumn

SourceLocColumn

newtype Recorder msg

Note that this is logging actions _of the program_, not of the user. You shouldn't call warning/error if the user has caused an error, only if our code has gone wrong and is itself erroneous (e.g. we threw an exception).

Constructors

Recorder

Fields

• logger_ :: forall m. MonadIO m => msg -> m ()

Instances

Contravariant Recorder

Defined in Development.IDE.Types.Logger

Methods

contramap :: (a -> b) -> Recorder b -> Recorder a

(>$) :: b -> Recorder b -> Recorder a

Semigroup (Recorder msg)

Defined in Development.IDE.Types.Logger

Methods

(<>) :: Recorder msg -> Recorder msg -> Recorder msg

sconcat :: NonEmpty (Recorder msg) -> Recorder msg

stimes :: Integral b => b -> Recorder msg -> Recorder msg

Monoid (Recorder msg)

Defined in Development.IDE.Types.Logger

Methods

mempty :: Recorder msg

mappend :: Recorder msg -> Recorder msg -> Recorder msg

mconcat :: [Recorder msg] -> Recorder msg

data WithPriority a

Constructors

WithPriority

Fields

• priority :: Priority
• callStack_ :: CallStack
• payload :: a

Instances

Functor WithPriority

Defined in Development.IDE.Types.Logger

Methods

fmap :: (a -> b) -> WithPriority a -> WithPriority b

(<$) :: a -> WithPriority b -> WithPriority a

newtype Logger

Note that this is logging actions _of the program_, not of the user. You shouldn't call warning/error if the user has caused an error, only if our code has gone wrong and is itself erroneous (e.g. we threw an exception).

Constructors

Logger

Fields

• logPriority :: Priority -> Text -> IO ()

Instances

Semigroup Logger

Defined in Development.IDE.Types.Logger

Methods

(<>) :: Logger -> Logger -> Logger

sconcat :: NonEmpty Logger -> Logger

stimes :: Integral b => b -> Logger -> Logger

Monoid Logger

Defined in Development.IDE.Types.Logger

Methods

mempty :: Logger

mappend :: Logger -> Logger -> Logger

mconcat :: [Logger] -> Logger

data Priority

Constructors

Debug

Verbose debug logging.

Info

Useful information in case an error has to be understood.

Warning

These error messages should not occur in a expected usage, and should be investigated.

Error

Such log messages must never occur in expected usage.

Instances

Bounded Priority

Defined in Development.IDE.Types.Logger

Methods

minBound :: Priority

maxBound :: Priority

Enum Priority

Defined in Development.IDE.Types.Logger

Methods

succ :: Priority -> Priority

pred :: Priority -> Priority

toEnum :: Int -> Priority

fromEnum :: Priority -> Int

enumFrom :: Priority -> [Priority]

enumFromThen :: Priority -> Priority -> [Priority]

enumFromTo :: Priority -> Priority -> [Priority]

enumFromThenTo :: Priority -> Priority -> Priority -> [Priority]

Eq Priority

Defined in Development.IDE.Types.Logger

Methods

(==) :: Priority -> Priority -> Bool

(/=) :: Priority -> Priority -> Bool

Ord Priority

Defined in Development.IDE.Types.Logger

Methods

compare :: Priority -> Priority -> Ordering

(<) :: Priority -> Priority -> Bool

(<=) :: Priority -> Priority -> Bool

(>) :: Priority -> Priority -> Bool

(>=) :: Priority -> Priority -> Bool

max :: Priority -> Priority -> Priority

min :: Priority -> Priority -> Priority

Show Priority

Defined in Development.IDE.Types.Logger

Methods

showsPrec :: Int -> Priority -> ShowS

show :: Priority -> String

showList :: [Priority] -> ShowS

logError :: Logger -> Text -> IO ()

logWarning :: Logger -> Text -> IO ()

logInfo :: Logger -> Text -> IO ()

logDebug :: Logger -> Text -> IO ()

noLogging :: Logger

logWith :: (HasCallStack, MonadIO m) => Recorder (WithPriority msg) -> Priority -> msg -> m ()

cmap :: (a -> b) -> Recorder b -> Recorder a

cmapWithPrio :: (a -> b) -> Recorder (WithPriority b) -> Recorder (WithPriority a)

cmapIO :: (a -> IO b) -> Recorder b -> Recorder a

cfilter :: (a -> Bool) -> Recorder a -> Recorder a

makeDefaultStderrRecorder :: MonadIO m => Maybe [LoggingColumn] -> Priority -> m (Recorder (WithPriority (Doc a)))

Priority is actually for hslogger compatibility

withDefaultRecorder

Arguments

:: MonadUnliftIO m

=> Maybe FilePath

Log file path. Nothing uses stderr

-> Maybe [LoggingColumn]

logging columns to display. Nothing uses defaultLoggingColumns

-> Priority

min priority for hslogger compatibility

-> (Recorder (WithPriority (Doc d)) -> m a)

action given a recorder

-> m a

If no path given then use stderr, otherwise use file. Kinda complicated because we also need to setup hslogger for `hie-bios` log compatibility reasons. If `hie-bios` can be set to use our logger instead or if `hie-bios` doesn't use hslogger then hslogger can be removed completely. See setupHsLogger comment.

priorityToHsLoggerPriority :: Priority -> Priority

withBacklog :: (v -> Recorder a) -> IO (Recorder a, v -> IO ())

Given a Recorder that requires an argument, produces a Recorder that queues up messages until the argument is provided using the callback, at which point it sends the backlog and begins functioning normally.

lspClientMessageRecorder :: LanguageContextEnv config -> Recorder (WithPriority Text)

Creates a recorder that sends logs to the LSP client via window/showMessage notifications.

lspClientLogRecorder :: LanguageContextEnv config -> Recorder (WithPriority Text)

Creates a recorder that sends logs to the LSP client via window/logMessage notifications.

data RuleBody k v

Constructors

Rule (k -> NormalizedFilePath -> Action (Maybe ByteString, IdeResult v))

RuleNoDiagnostics (k -> NormalizedFilePath -> Action (Maybe ByteString, Maybe v))

RuleWithCustomNewnessCheck

Fields

• newnessCheck :: ByteString -> ByteString -> Bool
• build :: k -> NormalizedFilePath -> Action (Maybe ByteString, Maybe v)

RuleWithOldValue (k -> NormalizedFilePath -> Value v -> Action (Maybe ByteString, IdeResult v))

data FastResult a

A (maybe) stale result now, and an up to date one later

Constructors

FastResult

Fields

• stale :: Maybe (a, PositionMapping)
• uptoDate :: IO (Maybe a)

newtype IdeAction a

IdeActions are used when we want to return a result immediately, even if it is stale Useful for UI actions like hover, completion where we don't want to block.

Run via runIdeAction.

Constructors

IdeAction

Fields

• runIdeActionT :: ReaderT ShakeExtras IO a

Instances

Monad IdeAction

Defined in Development.IDE.Core.Shake

Methods

(>>=) :: IdeAction a -> (a -> IdeAction b) -> IdeAction b

(>>) :: IdeAction a -> IdeAction b -> IdeAction b

return :: a -> IdeAction a

Functor IdeAction

Defined in Development.IDE.Core.Shake

Methods

fmap :: (a -> b) -> IdeAction a -> IdeAction b

(<$) :: a -> IdeAction b -> IdeAction a

Applicative IdeAction

Defined in Development.IDE.Core.Shake

Methods

pure :: a -> IdeAction a

(<*>) :: IdeAction (a -> b) -> IdeAction a -> IdeAction b

liftA2 :: (a -> b -> c) -> IdeAction a -> IdeAction b -> IdeAction c

(*>) :: IdeAction a -> IdeAction b -> IdeAction b

(<*) :: IdeAction a -> IdeAction b -> IdeAction a

MonadIO IdeAction

Defined in Development.IDE.Core.Shake

Methods

liftIO :: IO a -> IdeAction a

MonadReader ShakeExtras IdeAction

Defined in Development.IDE.Core.Shake

Methods

ask :: IdeAction ShakeExtras

local :: (ShakeExtras -> ShakeExtras) -> IdeAction a -> IdeAction a

reader :: (ShakeExtras -> a) -> IdeAction a

data VFSModified

Constructors

VFSUnmodified

VFSModified !VFS

data IdeState

A Shake database plus persistent store. Can be thought of as storing mappings from (FilePath, k) to RuleResult k.

type IdeRule k v = (RuleResult k ~ v, ShakeValue k, Show v, Typeable v, NFData v)

data ShakeExtras

Instances

MonadReader ShakeExtras IdeAction

Defined in Development.IDE.Core.Shake

Methods

ask :: IdeAction ShakeExtras

local :: (ShakeExtras -> ShakeExtras) -> IdeAction a -> IdeAction a

reader :: (ShakeExtras -> a) -> IdeAction a

getPluginConfig :: MonadLsp Config m => PluginId -> m PluginConfig

define :: IdeRule k v => Recorder (WithPriority Log) -> (k -> NormalizedFilePath -> Action (IdeResult v)) -> Rules ()

Define a new Rule without early cutoff

defineNoDiagnostics :: IdeRule k v => Recorder (WithPriority Log) -> (k -> NormalizedFilePath -> Action (Maybe v)) -> Rules ()

use :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe v)

Request a Rule result if available

useWithStale :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe (v, PositionMapping))

Request a Rule result, it not available return the last computed result, if any, which may be stale

useWithStale_ :: IdeRule k v => k -> NormalizedFilePath -> Action (v, PositionMapping)

Request a Rule result, it not available return the last computed result which may be stale. Errors out if none available.

runIdeAction :: String -> ShakeExtras -> IdeAction a -> IO a

useWithStaleFast :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (Maybe (v, PositionMapping))

Lookup value in the database and return with the stale value immediately Will queue an action to refresh the value. Might block the first time the rule runs, but never blocks after that.

useWithStaleFast' :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (FastResult v)

Same as useWithStaleFast but lets you wait for an up to date result

useNoFile :: IdeRule k v => k -> Action (Maybe v)

use_ :: IdeRule k v => k -> NormalizedFilePath -> Action v

useNoFile_ :: IdeRule k v => k -> Action v

uses_ :: IdeRule k v => k -> [NormalizedFilePath] -> Action [v]

uses :: IdeRule k v => k -> [NormalizedFilePath] -> Action [Maybe v]

Plural version of use

defineEarlyCutoff :: IdeRule k v => Recorder (WithPriority Log) -> RuleBody k v -> Rules ()

Define a new Rule with early cutoff

ideLogger :: IdeState -> Logger

actionLogger :: Action Logger

data Plugin c

Constructors

Plugin

Fields

• pluginRules :: Rules ()
• pluginHandlers :: Handlers (ServerM c)
• pluginModifyDynflags :: c -> DynFlagsModifications

Instances

Semigroup (Plugin c)

Defined in Development.IDE.Plugin

Methods

(<>) :: Plugin c -> Plugin c -> Plugin c

sconcat :: NonEmpty (Plugin c) -> Plugin c

stimes :: Integral b => b -> Plugin c -> Plugin c

Monoid (Plugin c)

Defined in Development.IDE.Plugin

Methods

mempty :: Plugin c

mappend :: Plugin c -> Plugin c -> Plugin c

mconcat :: [Plugin c] -> Plugin c

Default (Plugin c)

Defined in Development.IDE.Plugin

Methods

def :: Plugin c

getFilesOfInterestUntracked :: Action (HashMap NormalizedFilePath FileOfInterestStatus)

data IdeConfiguration

Lsp client relevant configuration details

Constructors

IdeConfiguration

Fields

• workspaceFolders :: HashSet NormalizedUri
• clientSettings :: Hashed (Maybe Value)

Instances

Show IdeConfiguration

Defined in Development.IDE.Core.IdeConfiguration

Methods

showsPrec :: Int -> IdeConfiguration -> ShowS

show :: IdeConfiguration -> String

showList :: [IdeConfiguration] -> ShowS

isWorkspaceFile :: NormalizedFilePath -> Action Bool

getFileContents :: NormalizedFilePath -> Action (UTCTime, Maybe Text)

Returns the modification time and the contents. For VFS paths, the modification time is the current time.

getFileExists :: NormalizedFilePath -> Action Bool

Returns True if the file exists

runAction :: String -> IdeState -> Action a -> IO a

getAtPoint :: NormalizedFilePath -> Position -> IdeAction (Maybe (Maybe Range, [Text]))

Try to get hover text for the name under point.

useE :: IdeRule k v => k -> NormalizedFilePath -> MaybeT IdeAction (v, PositionMapping)

useE is useful to implement functions that aren’t rules but need shortcircuiting e.g. getDefinition.

useNoFileE :: IdeRule k v => IdeState -> k -> MaybeT IdeAction v

usesE :: IdeRule k v => k -> [NormalizedFilePath] -> MaybeT IdeAction [(v, PositionMapping)]

getDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe [Location])

Goto Definition.

getTypeDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe [Location])

getParsedModule :: NormalizedFilePath -> Action (Maybe ParsedModule)

Parse the contents of a haskell file.

getClientConfigAction

Arguments

:: Config

default value

-> Action Config

Returns the client configurarion stored in the IdeState. You can use this function to access it from shake Rules