SrcLoc

This module contains types that relate to the positions of things in source files, and allow tagging of those things with locations

SrcLoc

data RealSrcLoc

Real Source Location

Represents a single point within a file

Instances

Eq RealSrcLoc

Defined in SrcLoc

Methods

(==) :: RealSrcLoc -> RealSrcLoc -> Bool

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

Ord RealSrcLoc

Defined in SrcLoc

Methods

compare :: RealSrcLoc -> RealSrcLoc -> Ordering

(<) :: RealSrcLoc -> RealSrcLoc -> Bool

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

(>) :: RealSrcLoc -> RealSrcLoc -> Bool

(>=) :: RealSrcLoc -> RealSrcLoc -> Bool

max :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc

min :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc

Show RealSrcLoc

Defined in SrcLoc

Methods

showsPrec :: Int -> RealSrcLoc -> ShowS

show :: RealSrcLoc -> String

showList :: [RealSrcLoc] -> ShowS

Outputable RealSrcLoc

Defined in SrcLoc

Methods

ppr :: RealSrcLoc -> SDoc

pprPrec :: Rational -> RealSrcLoc -> SDoc

data SrcLoc

Source Location

Constructors

RealSrcLoc !RealSrcLoc

UnhelpfulLoc FastString

Instances

Eq SrcLoc

Defined in SrcLoc

Methods

(==) :: SrcLoc -> SrcLoc -> Bool

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

Ord SrcLoc

Defined in SrcLoc

Methods

compare :: SrcLoc -> SrcLoc -> Ordering

(<) :: SrcLoc -> SrcLoc -> Bool

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

(>) :: SrcLoc -> SrcLoc -> Bool

(>=) :: SrcLoc -> SrcLoc -> Bool

max :: SrcLoc -> SrcLoc -> SrcLoc

min :: SrcLoc -> SrcLoc -> SrcLoc

Show SrcLoc

Defined in SrcLoc

Methods

showsPrec :: Int -> SrcLoc -> ShowS

show :: SrcLoc -> String

showList :: [SrcLoc] -> ShowS

Outputable SrcLoc

Defined in SrcLoc

Methods

ppr :: SrcLoc -> SDoc

pprPrec :: Rational -> SrcLoc -> SDoc

Constructing SrcLoc

mkSrcLoc :: FastString -> Int -> Int -> SrcLoc

mkRealSrcLoc :: FastString -> Int -> Int -> RealSrcLoc

mkGeneralSrcLoc :: FastString -> SrcLoc

Creates a "bad" SrcLoc that has no detailed information about its location

noSrcLoc :: SrcLoc

Built-in "bad" SrcLoc values for particular locations

generatedSrcLoc :: SrcLoc

Built-in "bad" SrcLoc values for particular locations

interactiveSrcLoc :: SrcLoc

Built-in "bad" SrcLoc values for particular locations

advanceSrcLoc :: RealSrcLoc -> Char -> RealSrcLoc

Move the SrcLoc down by one line if the character is a newline, to the next 8-char tabstop if it is a tab, and across by one character in any other case

Unsafely deconstructing SrcLoc

srcLocFile :: RealSrcLoc -> FastString

Gives the filename of the RealSrcLoc

srcLocLine :: RealSrcLoc -> Int

Raises an error when used on a "bad" SrcLoc

srcLocCol :: RealSrcLoc -> Int

Raises an error when used on a "bad" SrcLoc

SrcSpan

data RealSrcSpan

A RealSrcSpan delimits a portion of a text file. It could be represented by a pair of (line,column) coordinates, but in fact we optimise slightly by using more compact representations for single-line and zero-length spans, both of which are quite common.

The end position is defined to be the column after the end of the span. That is, a span of (1,1)-(1,2) is one character long, and a span of (1,1)-(1,1) is zero characters long.

Real Source Span

Instances

Eq RealSrcSpan

Defined in SrcLoc

Methods

(==) :: RealSrcSpan -> RealSrcSpan -> Bool

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

Data RealSrcSpan

Defined in SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RealSrcSpan -> c RealSrcSpan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RealSrcSpan

toConstr :: RealSrcSpan -> Constr

dataTypeOf :: RealSrcSpan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RealSrcSpan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RealSrcSpan)

gmapT :: (forall b. Data b => b -> b) -> RealSrcSpan -> RealSrcSpan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r

gmapQ :: (forall d. Data d => d -> u) -> RealSrcSpan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RealSrcSpan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

Ord RealSrcSpan

Defined in SrcLoc

Methods

compare :: RealSrcSpan -> RealSrcSpan -> Ordering

(<) :: RealSrcSpan -> RealSrcSpan -> Bool

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

(>) :: RealSrcSpan -> RealSrcSpan -> Bool

(>=) :: RealSrcSpan -> RealSrcSpan -> Bool

max :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan

min :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan

Show RealSrcSpan

Defined in SrcLoc

Methods

showsPrec :: Int -> RealSrcSpan -> ShowS

show :: RealSrcSpan -> String

showList :: [RealSrcSpan] -> ShowS

Outputable RealSrcSpan

Defined in SrcLoc

Methods

ppr :: RealSrcSpan -> SDoc

pprPrec :: Rational -> RealSrcSpan -> SDoc

ToJson RealSrcSpan

Defined in SrcLoc

Methods

json :: RealSrcSpan -> JsonDoc

data SrcSpan

Source Span

A SrcSpan identifies either a specific portion of a text file or a human-readable description of a location.

Constructors

RealSrcSpan !RealSrcSpan

UnhelpfulSpan !FastString

Instances

Eq SrcSpan

Defined in SrcLoc

Methods

(==) :: SrcSpan -> SrcSpan -> Bool

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

Data SrcSpan

Defined in SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcSpan -> c SrcSpan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcSpan

toConstr :: SrcSpan -> Constr

dataTypeOf :: SrcSpan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SrcSpan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcSpan)

gmapT :: (forall b. Data b => b -> b) -> SrcSpan -> SrcSpan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r

gmapQ :: (forall d. Data d => d -> u) -> SrcSpan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcSpan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

Ord SrcSpan

Defined in SrcLoc

Methods

compare :: SrcSpan -> SrcSpan -> Ordering

(<) :: SrcSpan -> SrcSpan -> Bool

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

(>) :: SrcSpan -> SrcSpan -> Bool

(>=) :: SrcSpan -> SrcSpan -> Bool

max :: SrcSpan -> SrcSpan -> SrcSpan

min :: SrcSpan -> SrcSpan -> SrcSpan

Show SrcSpan

Defined in SrcLoc

Methods

showsPrec :: Int -> SrcSpan -> ShowS

show :: SrcSpan -> String

showList :: [SrcSpan] -> ShowS

NFData SrcSpan

Defined in SrcLoc

Methods

rnf :: SrcSpan -> ()

Outputable SrcSpan

Defined in SrcLoc

Methods

ppr :: SrcSpan -> SDoc

pprPrec :: Rational -> SrcSpan -> SDoc

ToJson SrcSpan

Defined in SrcLoc

Methods

json :: SrcSpan -> JsonDoc

Binary SrcSpan

Defined in Binary

Methods

put_ :: BinHandle -> SrcSpan -> IO ()

put :: BinHandle -> SrcSpan -> IO (Bin SrcSpan)

get :: BinHandle -> IO SrcSpan

Binary a => Binary (GenLocated SrcSpan a)

Defined in Binary

Methods

put_ :: BinHandle -> GenLocated SrcSpan a -> IO ()

put :: BinHandle -> GenLocated SrcSpan a -> IO (Bin (GenLocated SrcSpan a))

get :: BinHandle -> IO (GenLocated SrcSpan a)

Constructing SrcSpan

mkGeneralSrcSpan :: FastString -> SrcSpan

Create a "bad" SrcSpan that has not location information

mkSrcSpan :: SrcLoc -> SrcLoc -> SrcSpan

Create a SrcSpan between two points in a file

mkRealSrcSpan :: RealSrcLoc -> RealSrcLoc -> RealSrcSpan

Create a SrcSpan between two points in a file

noSrcSpan :: SrcSpan

Built-in "bad" SrcSpans for common sources of location uncertainty

wiredInSrcSpan :: SrcSpan

Built-in "bad" SrcSpans for common sources of location uncertainty

interactiveSrcSpan :: SrcSpan

Built-in "bad" SrcSpans for common sources of location uncertainty

srcLocSpan :: SrcLoc -> SrcSpan

Create a SrcSpan corresponding to a single point

realSrcLocSpan :: RealSrcLoc -> RealSrcSpan

combineSrcSpans :: SrcSpan -> SrcSpan -> SrcSpan

Combines two SrcSpan into one that spans at least all the characters within both spans. Assumes the "file" part is the same in both inputs

srcSpanFirstCharacter :: SrcSpan -> SrcSpan

Convert a SrcSpan into one that represents only its first character

Deconstructing SrcSpan

srcSpanStart :: SrcSpan -> SrcLoc

Returns the location at the start of the SrcSpan or a "bad" SrcSpan if that is unavailable

srcSpanEnd :: SrcSpan -> SrcLoc

Returns the location at the end of the SrcSpan or a "bad" SrcSpan if that is unavailable

realSrcSpanStart :: RealSrcSpan -> RealSrcLoc

realSrcSpanEnd :: RealSrcSpan -> RealSrcLoc

srcSpanFileName_maybe :: SrcSpan -> Maybe FastString

Obtains the filename for a SrcSpan if it is "good"

pprUserRealSpan :: Bool -> RealSrcSpan -> SDoc

Unsafely deconstructing SrcSpan

srcSpanFile :: RealSrcSpan -> FastString

srcSpanStartLine :: RealSrcSpan -> Int

srcSpanEndLine :: RealSrcSpan -> Int

srcSpanStartCol :: RealSrcSpan -> Int

srcSpanEndCol :: RealSrcSpan -> Int

Predicates on SrcSpan

isGoodSrcSpan :: SrcSpan -> Bool

Test if a SrcSpan is "good", i.e. has precise location information

isOneLineSpan :: SrcSpan -> Bool

True if the span is known to straddle only one line. For "bad" SrcSpan, it returns False

containsSpan :: RealSrcSpan -> RealSrcSpan -> Bool

Tests whether the first span "contains" the other span, meaning that it covers at least as much source code. True where spans are equal.

Located

type Located e = GenLocated SrcSpan e

type RealLocated e = GenLocated RealSrcSpan e

data GenLocated l e

We attach SrcSpans to lots of things, so let's have a datatype for it.

Constructors

L l e

Instances

Functor (GenLocated l)

Defined in SrcLoc

Methods

fmap :: (a -> b) -> GenLocated l a -> GenLocated l b

(<$) :: a -> GenLocated l b -> GenLocated l a

Foldable (GenLocated l)

Defined in SrcLoc

Methods

fold :: Monoid m => GenLocated l m -> m

foldMap :: Monoid m => (a -> m) -> GenLocated l a -> m

foldr :: (a -> b -> b) -> b -> GenLocated l a -> b

foldr' :: (a -> b -> b) -> b -> GenLocated l a -> b

foldl :: (b -> a -> b) -> b -> GenLocated l a -> b

foldl' :: (b -> a -> b) -> b -> GenLocated l a -> b

foldr1 :: (a -> a -> a) -> GenLocated l a -> a

foldl1 :: (a -> a -> a) -> GenLocated l a -> a

toList :: GenLocated l a -> [a]

null :: GenLocated l a -> Bool

length :: GenLocated l a -> Int

elem :: Eq a => a -> GenLocated l a -> Bool

maximum :: Ord a => GenLocated l a -> a

minimum :: Ord a => GenLocated l a -> a

sum :: Num a => GenLocated l a -> a

product :: Num a => GenLocated l a -> a

Traversable (GenLocated l)

Defined in SrcLoc

Methods

traverse :: Applicative f => (a -> f b) -> GenLocated l a -> f (GenLocated l b)

sequenceA :: Applicative f => GenLocated l (f a) -> f (GenLocated l a)

mapM :: Monad m => (a -> m b) -> GenLocated l a -> m (GenLocated l b)

sequence :: Monad m => GenLocated l (m a) -> m (GenLocated l a)

(Eq l, Eq e) => Eq (GenLocated l e)

Defined in SrcLoc

Methods

(==) :: GenLocated l e -> GenLocated l e -> Bool

(/=) :: GenLocated l e -> GenLocated l e -> Bool

(Data l, Data e) => Data (GenLocated l e)

Defined in SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenLocated l e -> c (GenLocated l e)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (GenLocated l e)

toConstr :: GenLocated l e -> Constr

dataTypeOf :: GenLocated l e -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (GenLocated l e))

dataCast2 :: Typeable t => (forall d e0. (Data d, Data e0) => c (t d e0)) -> Maybe (c (GenLocated l e))

gmapT :: (forall b. Data b => b -> b) -> GenLocated l e -> GenLocated l e

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenLocated l e -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenLocated l e -> r

gmapQ :: (forall d. Data d => d -> u) -> GenLocated l e -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenLocated l e -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

(Ord l, Ord e) => Ord (GenLocated l e)

Defined in SrcLoc

Methods

compare :: GenLocated l e -> GenLocated l e -> Ordering

(<) :: GenLocated l e -> GenLocated l e -> Bool

(<=) :: GenLocated l e -> GenLocated l e -> Bool

(>) :: GenLocated l e -> GenLocated l e -> Bool

(>=) :: GenLocated l e -> GenLocated l e -> Bool

max :: GenLocated l e -> GenLocated l e -> GenLocated l e

min :: GenLocated l e -> GenLocated l e -> GenLocated l e

(Outputable l, Outputable e) => Outputable (GenLocated l e)

Defined in SrcLoc

Methods

ppr :: GenLocated l e -> SDoc

pprPrec :: Rational -> GenLocated l e -> SDoc

Binary a => Binary (GenLocated SrcSpan a)

Defined in Binary

Methods

put_ :: BinHandle -> GenLocated SrcSpan a -> IO ()

put :: BinHandle -> GenLocated SrcSpan a -> IO (Bin (GenLocated SrcSpan a))

get :: BinHandle -> IO (GenLocated SrcSpan a)

NamedThing e => NamedThing (GenLocated l e)

Defined in Name

Methods

getOccName :: GenLocated l e -> OccName

getName :: GenLocated l e -> Name

Constructing Located

noLoc :: e -> Located e

mkGeneralLocated :: String -> e -> Located e

Deconstructing Located

getLoc :: GenLocated l e -> l

unLoc :: GenLocated l e -> e

Combining and comparing Located values

eqLocated :: Eq a => Located a -> Located a -> Bool

Tests whether the two located things are equal

cmpLocated :: Ord a => Located a -> Located a -> Ordering

Tests the ordering of the two located things

combineLocs :: Located a -> Located b -> SrcSpan

addCLoc :: Located a -> Located b -> c -> Located c

Combine locations from two Located things and add them to a third thing

leftmost_smallest :: SrcSpan -> SrcSpan -> Ordering

Alternative strategies for ordering SrcSpans

leftmost_largest :: SrcSpan -> SrcSpan -> Ordering

Alternative strategies for ordering SrcSpans

rightmost :: SrcSpan -> SrcSpan -> Ordering

Alternative strategies for ordering SrcSpans

spans :: SrcSpan -> (Int, Int) -> Bool

Determines whether a span encloses a given line and column index

isSubspanOf

Arguments

:: SrcSpan

The span that may be enclosed by the other

-> SrcSpan

The span it may be enclosed by

-> Bool

Determines whether a span is enclosed by another one

sortLocated :: [Located a] -> [Located a]