SrcLoc

Contents

Description

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

Synopsis

SrcLoc

data RealSrcLoc Source

Represents a single point within a file

Instances

Eq RealSrcLoc
Ord RealSrcLoc
Outputable RealSrcLoc

data SrcLoc Source

Constructors

RealSrcLoc !RealSrcLoc
UnhelpfulLoc FastString

Instances

Eq SrcLoc
Ord SrcLoc
Outputable SrcLoc

Constructing SrcLoc

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

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

mkGeneralSrcLoc :: FastString -> SrcLoc Source

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

noSrcLoc, interactiveSrcLoc, generatedSrcLoc :: SrcLoc Source

Built-in bad SrcLoc values for particular locations

advanceSrcLoc :: RealSrcLoc -> Char -> RealSrcLoc Source

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 Source

Gives the filename of the RealSrcLoc

srcLocLine :: RealSrcLoc -> Int Source

Raises an error when used on a bad SrcLoc

srcLocCol :: RealSrcLoc -> Int Source

Raises an error when used on a bad SrcLoc

Misc. operations on SrcLoc

pprDefnLoc :: RealSrcSpan -> SDoc Source

Pretty prints information about the SrcSpan in the style defined at ...

SrcSpan

data RealSrcSpan Source

A SrcSpan 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.

Instances

Eq RealSrcSpan
Data RealSrcSpan
Typeable RealSrcSpan
Outputable RealSrcSpan

data SrcSpan Source

Constructors

RealSrcSpan !RealSrcSpan
UnhelpfulSpan !FastString

Instances

Eq SrcSpan
Data SrcSpan
Ord SrcSpan
Typeable SrcSpan
Outputable SrcSpan

Constructing SrcSpan

mkGeneralSrcSpan :: FastString -> SrcSpan Source

Create a bad SrcSpan that has not location information

mkSrcSpan :: SrcLoc -> SrcLoc -> SrcSpan Source

Create a SrcSpan between two points in a file

mkRealSrcSpan :: RealSrcLoc -> RealSrcLoc -> RealSrcSpan Source

Create a SrcSpan between two points in a file

noSrcSpan, wiredInSrcSpan :: SrcSpan Source

Built-in bad SrcSpans for common sources of location uncertainty

srcLocSpan :: SrcLoc -> SrcSpan Source

Create a SrcSpan corresponding to a single point

realSrcLocSpan :: RealSrcLoc -> RealSrcSpan Source

combineSrcSpans :: SrcSpan -> SrcSpan -> SrcSpan Source

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

Deconstructing SrcSpan

srcSpanStart :: SrcSpan -> SrcLoc Source

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

srcSpanEnd :: SrcSpan -> SrcLoc Source

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

realSrcSpanStart :: RealSrcSpan -> RealSrcLoc Source

realSrcSpanEnd :: RealSrcSpan -> RealSrcLoc Source

srcSpanFileName_maybe :: SrcSpan -> Maybe FastString Source

Obtains the filename for a SrcSpan if it is good

Unsafely deconstructing SrcSpan

srcSpanFile :: RealSrcSpan -> FastString Source

srcSpanStartLine :: RealSrcSpan -> Int Source

srcSpanEndLine :: RealSrcSpan -> Int Source

srcSpanStartCol :: RealSrcSpan -> Int Source

srcSpanEndCol :: RealSrcSpan -> Int Source

Predicates on SrcSpan

isGoodSrcSpan :: SrcSpan -> Bool Source

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

isOneLineSpan :: SrcSpan -> Bool Source

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

Located

type Located e = GenLocated SrcSpan eSource

type RealLocated e = GenLocated RealSrcSpan eSource

data GenLocated l e Source

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

Constructors

L l e

Instances

Typeable2 GenLocated
Functor (GenLocated l)
(Eq l, Eq e) => Eq (GenLocated l e)
(Data l, Data e) => Data (GenLocated l e)
(Ord l, Ord e) => Ord (GenLocated l e)
(Outputable l, Outputable e) => Outputable (GenLocated l e)