Safe Haskell	Safe-Inferred
Language	Haskell2010

Development.IDE.Types.Location

Description

Types and functions for working with source code locations.

Synopsis

data Location = Location {
- _uri :: Uri
- _range :: Range
}
noFilePath :: FilePath
noRange :: Range
data Position = Position {
- _line :: UInt
- _character :: UInt
}
showPosition :: Position -> String
data Range = Range {
- _start :: Position
- _end :: Position
}
newtype Uri = Uri {
- getUri :: Text
}
data NormalizedUri
toNormalizedUri :: Uri -> NormalizedUri
fromNormalizedUri :: NormalizedUri -> Uri
data NormalizedFilePath
fromUri :: NormalizedUri -> NormalizedFilePath
emptyFilePath :: NormalizedFilePath
emptyPathUri :: NormalizedUri
toNormalizedFilePath' :: FilePath -> NormalizedFilePath
fromNormalizedFilePath :: NormalizedFilePath -> FilePath
filePathToUri' :: NormalizedFilePath -> NormalizedUri
uriToFilePath' :: Uri -> Maybe FilePath
readSrcSpan :: ReadS RealSrcSpan

Documentation

data Location #

Constructors

Location
Fields _uri :: Uri _range :: Range

Instances

Instances details

FromJSON Location
Instance details Defined in Language.LSP.Types.Location Methods parseJSON :: Value -> Parser Location # parseJSONList :: Value -> Parser [Location] #
ToJSON Location
Instance details Defined in Language.LSP.Types.Location Methods toJSON :: Location -> Value # toEncoding :: Location -> Encoding # toJSONList :: [Location] -> Value # toEncodingList :: [Location] -> Encoding #
Generic Location
Instance details Defined in Language.LSP.Types.Location Associated Types type Rep Location :: Type -> Type # Methods from :: Location -> Rep Location x # to :: Rep Location x -> Location #
Read Location
Instance details Defined in Language.LSP.Types.Location Methods readsPrec :: Int -> ReadS Location # readList :: ReadS [Location] # readPrec :: ReadPrec Location # readListPrec :: ReadPrec [Location] #
Show Location
Instance details Defined in Language.LSP.Types.Location Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
NFData Location
Instance details Defined in Language.LSP.Types.Location Methods rnf :: Location -> () #
Eq Location
Instance details Defined in Language.LSP.Types.Location Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Ord Location
Instance details 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 #
Hashable Location
Instance details Defined in Language.LSP.Types.Location Methods hashWithSalt :: Int -> Location -> Int # hash :: Location -> Int #
HasLocation DiagnosticRelatedInformation Location
Instance details Defined in Language.LSP.Types.Lens Methods location :: Lens' DiagnosticRelatedInformation Location #
HasLocation SymbolInformation Location
Instance details Defined in Language.LSP.Types.Lens Methods location :: Lens' SymbolInformation Location #
HasRange Location Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' Location Range #
HasUri Location Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' Location Uri #
type Rep Location
Instance details Defined in Language.LSP.Types.Location type Rep Location = D1 ('MetaData "Location" "Language.LSP.Types.Location" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "_uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Uri) :*: S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range)))

noFilePath :: FilePath Source #

noRange :: Range Source #

data Position #

A position in a document. Note that the character offsets in a line are given in UTF-16 code units, *not* Unicode code points.

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

Instances details

FromJSON Position
Instance details Defined in Language.LSP.Types.Location Methods parseJSON :: Value -> Parser Position # parseJSONList :: Value -> Parser [Position] #
ToJSON Position
Instance details Defined in Language.LSP.Types.Location Methods toJSON :: Position -> Value # toEncoding :: Position -> Encoding # toJSONList :: [Position] -> Value # toEncodingList :: [Position] -> Encoding #
Generic Position
Instance details Defined in Language.LSP.Types.Location Associated Types type Rep Position :: Type -> Type # Methods from :: Position -> Rep Position x # to :: Rep Position x -> Position #
Read Position
Instance details Defined in Language.LSP.Types.Location Methods readsPrec :: Int -> ReadS Position # readList :: ReadS [Position] # readPrec :: ReadPrec Position # readListPrec :: ReadPrec [Position] #
Show Position
Instance details Defined in Language.LSP.Types.Location Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #
NFData Position
Instance details Defined in Language.LSP.Types.Location Methods rnf :: Position -> () #
Eq Position
Instance details Defined in Language.LSP.Types.Location Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #
Ord Position
Instance details 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 #
Hashable Position
Instance details Defined in Language.LSP.Types.Location Methods hashWithSalt :: Int -> Position -> Int # hash :: Position -> Int #
HasCharacter Position UInt
Instance details Defined in Language.LSP.Types.Lens Methods character :: Lens' Position UInt #
HasEnd Range Position
Instance details Defined in Language.LSP.Types.Lens Methods end :: Lens' Range Position #
HasLine Position UInt
Instance details Defined in Language.LSP.Types.Lens Methods line :: Lens' Position UInt #
HasPosition CallHierarchyPrepareParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' CallHierarchyPrepareParams Position #
HasPosition CompletionParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' CompletionParams Position #
HasPosition DeclarationParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' DeclarationParams Position #
HasPosition DefinitionParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' DefinitionParams Position #
HasPosition DocumentHighlightParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' DocumentHighlightParams Position #
HasPosition DocumentOnTypeFormattingParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' DocumentOnTypeFormattingParams Position #
HasPosition HoverParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' HoverParams Position #
HasPosition ImplementationParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' ImplementationParams Position #
HasPosition ReferenceParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' ReferenceParams Position #
HasPosition PrepareRenameParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' PrepareRenameParams Position #
HasPosition RenameParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' RenameParams Position #
HasPosition SignatureHelpParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' SignatureHelpParams Position #
HasPosition TextDocumentPositionParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' TextDocumentPositionParams Position #
HasPosition TypeDefinitionParams Position
Instance details Defined in Language.LSP.Types.Lens Methods position :: Lens' TypeDefinitionParams Position #
HasStart Range Position
Instance details Defined in Language.LSP.Types.Lens Methods start :: Lens' Range Position #
HasPositions SelectionRangeParams (List Position)
Instance details Defined in Language.LSP.Types.Lens Methods positions :: Lens' SelectionRangeParams (List Position) #
type Rep Position
Instance details Defined in Language.LSP.Types.Location type Rep Position = D1 ('MetaData "Position" "Language.LSP.Types.Location" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" 'False) (C1 ('MetaCons "Position" 'PrefixI 'True) (S1 ('MetaSel ('Just "_line") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UInt) :*: S1 ('MetaSel ('Just "_character") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UInt)))

showPosition :: Position -> String Source #

data Range #

Constructors

Range
Fields _start :: Position The range's start position. (inclusive) _end :: Position The range's end position. (exclusive, see: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#range )

Instances

Instances details

FromJSON Range
Instance details Defined in Language.LSP.Types.Location Methods parseJSON :: Value -> Parser Range # parseJSONList :: Value -> Parser [Range] #
ToJSON Range
Instance details Defined in Language.LSP.Types.Location Methods toJSON :: Range -> Value # toEncoding :: Range -> Encoding # toJSONList :: [Range] -> Value # toEncodingList :: [Range] -> Encoding #
Generic Range
Instance details Defined in Language.LSP.Types.Location Associated Types type Rep Range :: Type -> Type # Methods from :: Range -> Rep Range x # to :: Rep Range x -> Range #
Read Range
Instance details Defined in Language.LSP.Types.Location Methods readsPrec :: Int -> ReadS Range # readList :: ReadS [Range] # readPrec :: ReadPrec Range # readListPrec :: ReadPrec [Range] #
Show Range
Instance details Defined in Language.LSP.Types.Location Methods showsPrec :: Int -> Range -> ShowS # show :: Range -> String # showList :: [Range] -> ShowS #
NFData Range
Instance details Defined in Language.LSP.Types.Location Methods rnf :: Range -> () #
Eq Range
Instance details Defined in Language.LSP.Types.Location Methods (==) :: Range -> Range -> Bool # (/=) :: Range -> Range -> Bool #
Ord Range
Instance details 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 #
MapAge Range Source #
Instance details Defined in Development.IDE.Core.UseStale Methods mapAgeFrom :: forall (from :: Age) (to :: Age). PositionMap from to -> Tracked to Range -> Maybe (Tracked from Range) Source # mapAgeTo :: forall (from :: Age) (to :: Age). PositionMap from to -> Tracked from Range -> Maybe (Tracked to Range) Source #
Hashable Range
Instance details Defined in Language.LSP.Types.Location Methods hashWithSalt :: Int -> Range -> Int # hash :: Range -> Int #
HasEnd Range Position
Instance details Defined in Language.LSP.Types.Lens Methods end :: Lens' Range Position #
HasInsert InsertReplaceEdit Range
Instance details Defined in Language.LSP.Types.Lens Methods insert :: Lens' InsertReplaceEdit Range #
HasRange CallHierarchyItem Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' CallHierarchyItem Range #
HasRange CodeActionParams Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' CodeActionParams Range #
HasRange CodeLens Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' CodeLens Range #
HasRange Diagnostic Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' Diagnostic Range #
HasRange ColorInformation Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' ColorInformation Range #
HasRange ColorPresentationParams Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' ColorPresentationParams Range #
HasRange DocumentHighlight Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' DocumentHighlight Range #
HasRange DocumentLink Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' DocumentLink Range #
HasRange DocumentSymbol Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' DocumentSymbol Range #
HasRange DocumentRangeFormattingParams Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' DocumentRangeFormattingParams Range #
HasRange Location Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' Location Range #
HasRange RangeWithPlaceholder Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' RangeWithPlaceholder Range #
HasRange SelectionRange Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' SelectionRange Range #
HasRange SemanticTokensRangeParams Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' SemanticTokensRangeParams Range #
HasRange AnnotatedTextEdit Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' AnnotatedTextEdit Range #
HasRange TextEdit Range
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' TextEdit Range #
HasRepalce InsertReplaceEdit Range
Instance details Defined in Language.LSP.Types.Lens Methods repalce :: Lens' InsertReplaceEdit Range #
HasSelectionRange CallHierarchyItem Range
Instance details Defined in Language.LSP.Types.Lens Methods selectionRange :: Lens' CallHierarchyItem Range #
HasSelectionRange DocumentSymbol Range
Instance details Defined in Language.LSP.Types.Lens Methods selectionRange :: Lens' DocumentSymbol Range #
HasStart Range Position
Instance details Defined in Language.LSP.Types.Lens Methods start :: Lens' Range Position #
HasTargetRange LocationLink Range
Instance details Defined in Language.LSP.Types.Lens Methods targetRange :: Lens' LocationLink Range #
HasTargetSelectionRange LocationLink Range
Instance details Defined in Language.LSP.Types.Lens Methods targetSelectionRange :: Lens' LocationLink Range #
HasFromRanges CallHierarchyIncomingCall (List Range)
Instance details Defined in Language.LSP.Types.Lens Methods fromRanges :: Lens' CallHierarchyIncomingCall (List Range) #
HasFromRanges CallHierarchyOutgoingCall (List Range)
Instance details Defined in Language.LSP.Types.Lens Methods fromRanges :: Lens' CallHierarchyOutgoingCall (List Range) #
HasOriginSelectionRange LocationLink (Maybe Range)
Instance details Defined in Language.LSP.Types.Lens Methods originSelectionRange :: Lens' LocationLink (Maybe Range) #
HasRange Hover (Maybe Range)
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' Hover (Maybe Range) #
HasRange TextDocumentContentChangeEvent (Maybe Range)
Instance details Defined in Language.LSP.Types.Lens Methods range :: Lens' TextDocumentContentChangeEvent (Maybe Range) #
HasSelection ShowDocumentParams (Maybe Range)
Instance details Defined in Language.LSP.Types.Lens Methods selection :: Lens' ShowDocumentParams (Maybe Range) #
type Rep Range
Instance details Defined in Language.LSP.Types.Location type Rep Range = D1 ('MetaData "Range" "Language.LSP.Types.Location" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" 'False) (C1 ('MetaCons "Range" 'PrefixI 'True) (S1 ('MetaSel ('Just "_start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Just "_end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Position)))

newtype Uri #

Constructors

Uri
Fields getUri :: Text

Instances

Instances details

FromJSON Uri
Instance details Defined in Language.LSP.Types.Uri Methods parseJSON :: Value -> Parser Uri # parseJSONList :: Value -> Parser [Uri] #
FromJSONKey Uri
Instance details Defined in Language.LSP.Types.Uri Methods fromJSONKey :: FromJSONKeyFunction Uri # fromJSONKeyList :: FromJSONKeyFunction [Uri] #
ToJSON Uri
Instance details Defined in Language.LSP.Types.Uri Methods toJSON :: Uri -> Value # toEncoding :: Uri -> Encoding # toJSONList :: [Uri] -> Value # toEncodingList :: [Uri] -> Encoding #
ToJSONKey Uri
Instance details Defined in Language.LSP.Types.Uri Methods toJSONKey :: ToJSONKeyFunction Uri # toJSONKeyList :: ToJSONKeyFunction [Uri] #
Generic Uri
Instance details Defined in Language.LSP.Types.Uri Associated Types type Rep Uri :: Type -> Type # Methods from :: Uri -> Rep Uri x # to :: Rep Uri x -> Uri #
Read Uri
Instance details Defined in Language.LSP.Types.Uri Methods readsPrec :: Int -> ReadS Uri # readList :: ReadS [Uri] # readPrec :: ReadPrec Uri # readListPrec :: ReadPrec [Uri] #
Show Uri
Instance details Defined in Language.LSP.Types.Uri Methods showsPrec :: Int -> Uri -> ShowS # show :: Uri -> String # showList :: [Uri] -> ShowS #
NFData Uri
Instance details Defined in Language.LSP.Types.Uri Methods rnf :: Uri -> () #
Eq Uri
Instance details Defined in Language.LSP.Types.Uri Methods (==) :: Uri -> Uri -> Bool # (/=) :: Uri -> Uri -> Bool #
Ord Uri
Instance details 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 #
Hashable Uri
Instance details Defined in Language.LSP.Types.Uri Methods hashWithSalt :: Int -> Uri -> Int # hash :: Uri -> Int #
HasNewUri RenameFile Uri
Instance details Defined in Language.LSP.Types.Lens Methods newUri :: Lens' RenameFile Uri #
HasOldUri RenameFile Uri
Instance details Defined in Language.LSP.Types.Lens Methods oldUri :: Lens' RenameFile Uri #
HasTargetUri LocationLink Uri
Instance details Defined in Language.LSP.Types.Lens Methods targetUri :: Lens' LocationLink Uri #
HasUri CallHierarchyItem Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' CallHierarchyItem Uri #
HasUri PublishDiagnosticsParams Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' PublishDiagnosticsParams Uri #
HasUri Location Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' Location Uri #
HasUri TextDocumentIdentifier Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' TextDocumentIdentifier Uri #
HasUri TextDocumentItem Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' TextDocumentItem Uri #
HasUri VersionedTextDocumentIdentifier Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' VersionedTextDocumentIdentifier Uri #
HasUri FileEvent Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' FileEvent Uri #
HasUri ShowDocumentParams Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' ShowDocumentParams Uri #
HasUri CreateFile Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' CreateFile Uri #
HasUri DeleteFile Uri
Instance details Defined in Language.LSP.Types.Lens Methods uri :: Lens' DeleteFile Uri #
HasChanges WorkspaceEdit (Maybe WorkspaceEditMap)
Instance details Defined in Language.LSP.Types.Lens Methods changes :: Lens' WorkspaceEdit (Maybe WorkspaceEditMap) #
HasRootUri InitializeParams (Maybe Uri)
Instance details Defined in Language.LSP.Types.Lens Methods rootUri :: Lens' InitializeParams (Maybe Uri) #
HasTarget DocumentLink (Maybe Uri)
Instance details Defined in Language.LSP.Types.Lens Methods target :: Lens' DocumentLink (Maybe Uri) #
type Rep Uri
Instance details Defined in Language.LSP.Types.Uri type Rep Uri = D1 ('MetaData "Uri" "Language.LSP.Types.Uri" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" 'True) (C1 ('MetaCons "Uri" 'PrefixI 'True) (S1 ('MetaSel ('Just "getUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data NormalizedUri #

Instances

Instances details

Generic NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Associated Types type Rep NormalizedUri :: Type -> Type # Methods from :: NormalizedUri -> Rep NormalizedUri x # to :: Rep NormalizedUri x -> NormalizedUri #
Read NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Methods readsPrec :: Int -> ReadS NormalizedUri # readList :: ReadS [NormalizedUri] # readPrec :: ReadPrec NormalizedUri # readListPrec :: ReadPrec [NormalizedUri] #
Show NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Methods showsPrec :: Int -> NormalizedUri -> ShowS # show :: NormalizedUri -> String # showList :: [NormalizedUri] -> ShowS #
NFData NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Methods rnf :: NormalizedUri -> () #
Eq NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Methods (==) :: NormalizedUri -> NormalizedUri -> Bool # (/=) :: NormalizedUri -> NormalizedUri -> Bool #
Ord NormalizedUri
Instance details 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 #
Hashable NormalizedUri
Instance details Defined in Language.LSP.Types.Uri Methods hashWithSalt :: Int -> NormalizedUri -> Int # hash :: NormalizedUri -> Int #
HasVfsMap VFS (Map NormalizedUri VirtualFile)
Instance details Defined in Language.LSP.VFS Methods vfsMap :: Lens' VFS (Map NormalizedUri VirtualFile) #
type Rep NormalizedUri
Instance details Defined in Language.LSP.Types.Uri type Rep NormalizedUri = D1 ('MetaData "NormalizedUri" "Language.LSP.Types.Uri" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" '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)))

toNormalizedUri :: Uri -> NormalizedUri #

fromNormalizedUri :: NormalizedUri -> Uri #

data NormalizedFilePath #

A file path that is already normalized.

The NormalizedUri is 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 HLS, do not modify it without profiling.

Adoption Plan of OsPath

Currently we store Text. We may change it to OsPath in the future if the following steps are executed.

In the client codebase, use osPathToNormalizedFilePath and normalizedFilePathToOsPath instead of fromNormalizedFilePath and toNormalizedFilePath. For HLS, we could wait until GHC 9.6 becomes the oldest GHC we support, then change FilePath to OsPath everywhere in the codebase.
Deprecate and remove fromNormalizedFilePath and toNormalizedFilePath.
Change Text to OsPath and benchmark it to make sure performance doesn't go down. Don't forget to check Windows, as OsPath on Windows uses UTF-16, which may consume more memory.

See #453 and #446 for more discussions on this topic.

Instances

Instances details

IsString NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods fromString :: String -> NormalizedFilePath #
Generic NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Associated Types type Rep NormalizedFilePath :: Type -> Type # Methods from :: NormalizedFilePath -> Rep NormalizedFilePath x # to :: Rep NormalizedFilePath x -> NormalizedFilePath #
Show NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods showsPrec :: Int -> NormalizedFilePath -> ShowS # show :: NormalizedFilePath -> String # showList :: [NormalizedFilePath] -> ShowS #
Binary NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods put :: NormalizedFilePath -> Put # get :: Get NormalizedFilePath # putList :: [NormalizedFilePath] -> Put #
NFData NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods rnf :: NormalizedFilePath -> () #
Eq NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods (==) :: NormalizedFilePath -> NormalizedFilePath -> Bool # (/=) :: NormalizedFilePath -> NormalizedFilePath -> Bool #
Ord NormalizedFilePath
Instance details 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 #
Hashable NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri Methods hashWithSalt :: Int -> NormalizedFilePath -> Int # hash :: NormalizedFilePath -> Int #
type Rep NormalizedFilePath
Instance details Defined in Language.LSP.Types.Uri type Rep NormalizedFilePath = D1 ('MetaData "NormalizedFilePath" "Language.LSP.Types.Uri" "lsp-types-1.6.0.0-ADWGUPu2vzQDpYvK7KrBVs" 'False) (C1 ('MetaCons "NormalizedFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NormalizedUri) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text)))

fromUri :: NormalizedUri -> NormalizedFilePath Source #

emptyFilePath :: NormalizedFilePath Source #

emptyPathUri :: NormalizedUri Source #

toNormalizedFilePath' :: FilePath -> NormalizedFilePath Source #

fromNormalizedFilePath :: NormalizedFilePath -> FilePath #

Extracts FilePath from NormalizedFilePath.

filePathToUri' :: NormalizedFilePath -> NormalizedUri Source #

uriToFilePath' :: Uri -> Maybe FilePath Source #

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.

readSrcSpan :: ReadS RealSrcSpan Source #

Parser for the GHC output format