Data.Loc

Documentation

data Pos

Position type.

Constructors

Pos !FilePath !Int !Int !Int

Source file name, line, column, and character offset.

Line numbering starts at 1, column offset starts at 1, and character offset starts at 0.

Instances

Eq Pos

Data Pos

Ord Pos

Read Pos

Show Pos

Located Pos

Typeable * Pos

posFile :: Pos -> FilePath

Position file.

posLine :: Pos -> Int

Position line.

posCol :: Pos -> Int

Position column.

posCoff :: Pos -> Int

Position character offset.

startPos :: FilePath -> Pos

Starting position for given file.

linePos :: FilePath -> Int -> Pos

Position corresponding to given file and line.

Note that the associated character offset is set to 0.

advancePos :: Pos -> Char -> Pos

Advance a position by a single character. Newlines increment the line number, tabs increase the position column following a tab stop width of 8, and all other characters increase the position column by one. All characters, including newlines and tabs, increase the character offset by 1.

Note that advancePos assumes UNIX-style newlines.

displayPos :: Pos -> String

Format a position in a human-readable way, returning an ordinary String.

displaySPos :: Pos -> ShowS

Format a position in a human-readable way.

data Loc

Location type, consisting of a beginning position and an end position.

Constructors

NoLoc

Loc !Pos !Pos

Beginning and end positions

Instances

Eq Loc

Data Loc

Read Loc

Show Loc

Monoid Loc

Located Loc

IsLocation Loc

Typeable * Loc

locStart :: Loc -> Loc

Starting position of the location.

locEnd :: Loc -> Loc

Ending position of the location.

(<-->) :: (Located a, Located b) => a -> b -> Loc infixl 6

Merge the locations of two Located values.

displayLoc :: Loc -> String

Format a location in a human-readable way, returning an ordinary String.

displaySLoc :: Loc -> ShowS

Format a location in a human-readable way.

newtype SrcLoc

Source location type. Source location are all equal, which allows AST nodes to be compared modulo location information.

Constructors

SrcLoc Loc

Instances

Eq SrcLoc

Data SrcLoc

Ord SrcLoc

Read SrcLoc

Show SrcLoc

Monoid SrcLoc

Located SrcLoc

IsLocation SrcLoc

Typeable * SrcLoc

srclocOf :: Located a => a -> SrcLoc

The SrcLoc of a Located value.

srcspan :: (Located a, Located b) => a -> b -> SrcLoc infixl 6

A SrcLoc with (minimal) span that includes two Located values.

class IsLocation a where

Locations

Minimal complete definition

fromLoc

Methods

fromLoc :: Loc -> a

fromPos :: Pos -> a

Instances

IsLocation SrcLoc

IsLocation Loc

noLoc :: IsLocation a => a

No location.

class Located a where

Located values have a location.

Minimal complete definition

locOf

Methods

locOf :: a -> Loc

locOfList :: [a] -> Loc

Instances

Located SrcLoc

Located Loc

Located Pos

Located a => Located [a]

Located a => Located (Maybe a)

Located (L a)

class Relocatable a where

Values that can be relocated

Methods

reloc :: Loc -> a -> a

Instances

Relocatable (L a)

data L a

A value of type L a is a value of type a with an associated Loc, but this location is ignored when performing comparisons.

Constructors

L Loc a

Instances

Functor L

Eq x => Eq (L x)

Data a => Data (L a)

Ord x => Ord (L x)

Show x => Show (L x)

Relocatable (L a)

Located (L a)

Typeable (* -> *) L

unLoc :: L a -> a