Safe Haskell	None
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 :: Int
- _character :: Int
}
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 SrcSpan

Documentation

data Location #

Constructors

Location
Fields _uri :: Uri _range :: Range

Instances

Eq Location
Instance details Defined in Language.Haskell.LSP.Types.Location Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Ord Location
Instance details Defined in Language.Haskell.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
Instance details Defined in Language.Haskell.LSP.Types.Location Methods readsPrec :: Int -> ReadS Location # readList :: ReadS [Location] # readPrec :: ReadPrec Location # readListPrec :: ReadPrec [Location] #
Show Location
Instance details Defined in Language.Haskell.LSP.Types.Location Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
Generic Location
Instance details Defined in Language.Haskell.LSP.Types.Location Associated Types type Rep Location :: Type -> Type # Methods from :: Location -> Rep Location x # to :: Rep Location x -> Location #
ToJSON Location
Instance details Defined in Language.Haskell.LSP.Types.Location Methods toJSON :: Location -> Value # toEncoding :: Location -> Encoding # toJSONList :: [Location] -> Value # toEncodingList :: [Location] -> Encoding #
FromJSON Location
Instance details Defined in Language.Haskell.LSP.Types.Location Methods parseJSON :: Value -> Parser Location # parseJSONList :: Value -> Parser [Location] #
NFData Location
Instance details Defined in Language.Haskell.LSP.Types.Location Methods rnf :: Location -> () #
type Rep Location
Instance details Defined in Language.Haskell.LSP.Types.Location type Rep Location = D1 (MetaData "Location" "Language.Haskell.LSP.Types.Location" "haskell-lsp-types-0.22.0.0-4uvQXZ4RjIwGZdqqtXC5yo" False) (C1 (MetaCons "Location" PrefixI True) (S1 (MetaSel (Just "_uri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Uri) :*: S1 (MetaSel (Just "_range") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Range)))

noFilePath :: FilePath Source #

noRange :: Range Source #

data Position #

Constructors

Position
Fields _line :: Int _character :: Int

Instances

Eq Position
Instance details Defined in Language.Haskell.LSP.Types.Location Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #
Ord Position
Instance details Defined in Language.Haskell.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
Instance details Defined in Language.Haskell.LSP.Types.Location Methods readsPrec :: Int -> ReadS Position # readList :: ReadS [Position] # readPrec :: ReadPrec Position # readListPrec :: ReadPrec [Position] #
Show Position
Instance details Defined in Language.Haskell.LSP.Types.Location Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #
Generic Position
Instance details Defined in Language.Haskell.LSP.Types.Location Associated Types type Rep Position :: Type -> Type # Methods from :: Position -> Rep Position x # to :: Rep Position x -> Position #
ToJSON Position
Instance details Defined in Language.Haskell.LSP.Types.Location Methods toJSON :: Position -> Value # toEncoding :: Position -> Encoding # toJSONList :: [Position] -> Value # toEncodingList :: [Position] -> Encoding #
FromJSON Position
Instance details Defined in Language.Haskell.LSP.Types.Location Methods parseJSON :: Value -> Parser Position # parseJSONList :: Value -> Parser [Position] #
NFData Position
Instance details Defined in Language.Haskell.LSP.Types.Location Methods rnf :: Position -> () #
type Rep Position
Instance details Defined in Language.Haskell.LSP.Types.Location type Rep Position = D1 (MetaData "Position" "Language.Haskell.LSP.Types.Location" "haskell-lsp-types-0.22.0.0-4uvQXZ4RjIwGZdqqtXC5yo" False) (C1 (MetaCons "Position" PrefixI True) (S1 (MetaSel (Just "_line") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "_character") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

showPosition :: Position -> String Source #

data Range #

Constructors

Range
Fields _start :: Position _end :: Position

Instances

Eq Range
Instance details Defined in Language.Haskell.LSP.Types.Location Methods (==) :: Range -> Range -> Bool # (/=) :: Range -> Range -> Bool #
Ord Range
Instance details Defined in Language.Haskell.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
Instance details Defined in Language.Haskell.LSP.Types.Location Methods readsPrec :: Int -> ReadS Range # readList :: ReadS [Range] # readPrec :: ReadPrec Range # readListPrec :: ReadPrec [Range] #
Show Range
Instance details Defined in Language.Haskell.LSP.Types.Location Methods showsPrec :: Int -> Range -> ShowS # show :: Range -> String # showList :: [Range] -> ShowS #
Generic Range
Instance details Defined in Language.Haskell.LSP.Types.Location Associated Types type Rep Range :: Type -> Type # Methods from :: Range -> Rep Range x # to :: Rep Range x -> Range #
ToJSON Range
Instance details Defined in Language.Haskell.LSP.Types.Location Methods toJSON :: Range -> Value # toEncoding :: Range -> Encoding # toJSONList :: [Range] -> Value # toEncodingList :: [Range] -> Encoding #
FromJSON Range
Instance details Defined in Language.Haskell.LSP.Types.Location Methods parseJSON :: Value -> Parser Range # parseJSONList :: Value -> Parser [Range] #
NFData Range
Instance details Defined in Language.Haskell.LSP.Types.Location Methods rnf :: Range -> () #
type Rep Range
Instance details Defined in Language.Haskell.LSP.Types.Location type Rep Range = D1 (MetaData "Range" "Language.Haskell.LSP.Types.Location" "haskell-lsp-types-0.22.0.0-4uvQXZ4RjIwGZdqqtXC5yo" False) (C1 (MetaCons "Range" PrefixI True) (S1 (MetaSel (Just "_start") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Position) :*: S1 (MetaSel (Just "_end") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Position)))

newtype Uri #

Constructors

Uri
Fields getUri :: Text

Instances

Eq Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods (==) :: Uri -> Uri -> Bool # (/=) :: Uri -> Uri -> Bool #
Ord Uri
Instance details Defined in Language.Haskell.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
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods readsPrec :: Int -> ReadS Uri # readList :: ReadS [Uri] # readPrec :: ReadPrec Uri # readListPrec :: ReadPrec [Uri] #
Show Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods showsPrec :: Int -> Uri -> ShowS # show :: Uri -> String # showList :: [Uri] -> ShowS #
Generic Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Associated Types type Rep Uri :: Type -> Type # Methods from :: Uri -> Rep Uri x # to :: Rep Uri x -> Uri #
Hashable Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods hashWithSalt :: Int -> Uri -> Int # hash :: Uri -> Int #
ToJSON Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods toJSON :: Uri -> Value # toEncoding :: Uri -> Encoding # toJSONList :: [Uri] -> Value # toEncodingList :: [Uri] -> Encoding #
ToJSONKey Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods toJSONKey :: ToJSONKeyFunction Uri # toJSONKeyList :: ToJSONKeyFunction [Uri] #
FromJSON Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods parseJSON :: Value -> Parser Uri # parseJSONList :: Value -> Parser [Uri] #
FromJSONKey Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods fromJSONKey :: FromJSONKeyFunction Uri # fromJSONKeyList :: FromJSONKeyFunction [Uri] #
NFData Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri Methods rnf :: Uri -> () #
type Rep Uri
Instance details Defined in Language.Haskell.LSP.Types.Uri type Rep Uri = D1 (MetaData "Uri" "Language.Haskell.LSP.Types.Uri" "haskell-lsp-types-0.22.0.0-4uvQXZ4RjIwGZdqqtXC5yo" True) (C1 (MetaCons "Uri" PrefixI True) (S1 (MetaSel (Just "getUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data NormalizedUri #

Instances

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

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

fromUri :: NormalizedUri -> NormalizedFilePath Source #

emptyFilePath :: NormalizedFilePath Source #

emptyPathUri :: NormalizedUri Source #

toNormalizedFilePath' :: FilePath -> NormalizedFilePath Source #

fromNormalizedFilePath :: NormalizedFilePath -> FilePath #

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 SrcSpan Source #

Parser for the GHC output format