Copyright	(c) Niklas Broberg 2009
License	BSD-style (see the file LICENSE.txt)
Maintainer	Niklas Broberg, d00nibro@chalmers.se
Stability	stable
Portability	portable
Safe Haskell	Safe
Language	Haskell98

Language.Haskell.Exts.SrcLoc

Description

This module defines various data types representing source location information, of varying degree of preciseness.

Synopsis

Documentation

data SrcLoc Source

A single position in the source.

Constructors

SrcLoc
Fields srcFilename :: String srcLine :: Int srcColumn :: Int

Instances

Eq SrcLoc Source
Methods (==) :: SrcLoc -> SrcLoc -> Bool (/=) :: SrcLoc -> SrcLoc -> Bool
Data SrcLoc Source
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcLoc -> c SrcLoc gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcLoc toConstr :: SrcLoc -> Constr dataTypeOf :: SrcLoc -> DataType dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SrcLoc) dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcLoc) gmapT :: (forall b. Data b => b -> b) -> SrcLoc -> SrcLoc gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcLoc -> r gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcLoc -> r gmapQ :: (forall d. Data d => d -> u) -> SrcLoc -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcLoc -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcLoc -> m SrcLoc gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcLoc -> m SrcLoc gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcLoc -> m SrcLoc
Ord SrcLoc Source
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 Source
Methods showsPrec :: Int -> SrcLoc -> ShowS show :: SrcLoc -> String showList :: [SrcLoc] -> ShowS
Generic SrcLoc Source
Associated Types type Rep SrcLoc :: * -> * Methods from :: SrcLoc -> Rep SrcLoc x to :: Rep SrcLoc x -> SrcLoc
SrcInfo SrcLoc Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcLoc Source fromSrcInfo :: SrcSpanInfo -> SrcLoc Source getPointLoc :: SrcLoc -> SrcLoc Source fileName :: SrcLoc -> String Source startLine :: SrcLoc -> Int Source startColumn :: SrcLoc -> Int Source
Pretty SrcLoc Source
Methods pretty :: SrcLoc -> Doc prettyPrec :: Int -> SrcLoc -> Doc
type Rep SrcLoc Source

noLoc :: SrcLoc Source

data SrcSpan Source

A portion of the source, spanning one or more lines and zero or more columns.

Constructors

SrcSpan
Fields srcSpanFilename :: String srcSpanStartLine :: Int srcSpanStartColumn :: Int srcSpanEndLine :: Int srcSpanEndColumn :: Int

Instances

Eq SrcSpan Source
Methods (==) :: SrcSpan -> SrcSpan -> Bool (/=) :: SrcSpan -> SrcSpan -> Bool
Data SrcSpan Source
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 Source
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 Source
Methods showsPrec :: Int -> SrcSpan -> ShowS show :: SrcSpan -> String showList :: [SrcSpan] -> ShowS
SrcInfo SrcSpan Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcSpan Source fromSrcInfo :: SrcSpanInfo -> SrcSpan Source getPointLoc :: SrcSpan -> SrcLoc Source fileName :: SrcSpan -> String Source startLine :: SrcSpan -> Int Source startColumn :: SrcSpan -> Int Source
Pretty SrcSpan Source
Methods pretty :: SrcSpan -> Doc prettyPrec :: Int -> SrcSpan -> Doc

srcSpanStart :: SrcSpan -> (Int, Int) Source

Returns srcSpanStartLine and srcSpanStartColumn in a pair.

srcSpanEnd :: SrcSpan -> (Int, Int) Source

Returns srcSpanEndLine and srcSpanEndColumn in a pair.

mkSrcSpan :: SrcLoc -> SrcLoc -> SrcSpan Source

Combine two locations in the source to denote a span.

mergeSrcSpan :: SrcSpan -> SrcSpan -> SrcSpan Source

Merge two source spans into a single span from the start of the first to the end of the second. Assumes that the two spans relate to the same source file.

isNullSpan :: SrcSpan -> Bool Source

Test if a given span starts and ends at the same location.

spanSize :: SrcSpan -> (Int, Int) Source

data Loc a Source

An entity located in the source.

Constructors

Loc
Fields loc :: SrcSpan unLoc :: a

Instances

Eq a => Eq (Loc a) Source
Methods (==) :: Loc a -> Loc a -> Bool (/=) :: Loc a -> Loc a -> Bool
Ord a => Ord (Loc a) Source
Methods compare :: Loc a -> Loc a -> Ordering (<) :: Loc a -> Loc a -> Bool (<=) :: Loc a -> Loc a -> Bool (>) :: Loc a -> Loc a -> Bool (>=) :: Loc a -> Loc a -> Bool max :: Loc a -> Loc a -> Loc a min :: Loc a -> Loc a -> Loc a
Show a => Show (Loc a) Source
Methods showsPrec :: Int -> Loc a -> ShowS show :: Loc a -> String showList :: [Loc a] -> ShowS

data SrcSpanInfo Source

A portion of the source, extended with information on the position of entities within the span.

Constructors

SrcSpanInfo
Fields srcInfoSpan :: SrcSpan srcInfoPoints :: [SrcSpan]

Instances

Eq SrcSpanInfo Source
Methods (==) :: SrcSpanInfo -> SrcSpanInfo -> Bool (/=) :: SrcSpanInfo -> SrcSpanInfo -> Bool
Data SrcSpanInfo Source
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcSpanInfo -> c SrcSpanInfo gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcSpanInfo toConstr :: SrcSpanInfo -> Constr dataTypeOf :: SrcSpanInfo -> DataType dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SrcSpanInfo) dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcSpanInfo) gmapT :: (forall b. Data b => b -> b) -> SrcSpanInfo -> SrcSpanInfo gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpanInfo -> r gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpanInfo -> r gmapQ :: (forall d. Data d => d -> u) -> SrcSpanInfo -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcSpanInfo -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcSpanInfo -> m SrcSpanInfo gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpanInfo -> m SrcSpanInfo gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpanInfo -> m SrcSpanInfo
Ord SrcSpanInfo Source
Methods compare :: SrcSpanInfo -> SrcSpanInfo -> Ordering (<) :: SrcSpanInfo -> SrcSpanInfo -> Bool (<=) :: SrcSpanInfo -> SrcSpanInfo -> Bool (>) :: SrcSpanInfo -> SrcSpanInfo -> Bool (>=) :: SrcSpanInfo -> SrcSpanInfo -> Bool max :: SrcSpanInfo -> SrcSpanInfo -> SrcSpanInfo min :: SrcSpanInfo -> SrcSpanInfo -> SrcSpanInfo
Show SrcSpanInfo Source
Methods showsPrec :: Int -> SrcSpanInfo -> ShowS show :: SrcSpanInfo -> String showList :: [SrcSpanInfo] -> ShowS
SrcInfo SrcSpanInfo Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcSpanInfo Source fromSrcInfo :: SrcSpanInfo -> SrcSpanInfo Source getPointLoc :: SrcSpanInfo -> SrcLoc Source fileName :: SrcSpanInfo -> String Source startLine :: SrcSpanInfo -> Int Source startColumn :: SrcSpanInfo -> Int Source
Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) Source
Methods parse :: String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) Source parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) Source parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo)), [Comment]) Source parser :: Maybe [Fixity] -> P (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) Source
Methods parse :: String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) Source parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) Source parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo), [Comment]) Source parser :: Maybe [Fixity] -> P (NonGreedy (ModuleHeadAndImports SrcSpanInfo))
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) Source
Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) Source parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) Source parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo), [Comment]) Source parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleHead SrcSpanInfo))
Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo)) Source
Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) Source parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) Source parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo), [Comment]) Source parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleName SrcSpanInfo))

noInfoSpan :: SrcSpan -> SrcSpanInfo Source

Generate a SrcSpanInfo with no positional information for entities.

infoSpan :: SrcSpan -> [SrcSpan] -> SrcSpanInfo Source

Generate a SrcSpanInfo with the supplied positional information for entities.

combSpanInfo :: SrcSpanInfo -> SrcSpanInfo -> SrcSpanInfo Source

Combine two SrcSpanInfos into one that spans the combined source area of the two arguments, leaving positional information blank.

combSpanMaybe :: SrcSpanInfo -> Maybe SrcSpanInfo -> SrcSpanInfo Source

Like '(+?)', but it also concatenates the srcInfoPoints.

(<++>) :: SrcSpanInfo -> SrcSpanInfo -> SrcSpanInfo infixl 5 Source

Short name for combSpanInfo

(<+?>) :: SrcSpanInfo -> Maybe SrcSpanInfo -> SrcSpanInfo infixl 4 Source

Optionally combine the first argument with the second, or return it unchanged if the second argument is Nothing.

(<?+>) :: Maybe SrcSpanInfo -> SrcSpanInfo -> SrcSpanInfo infixl 4 Source

Optionally combine the second argument with the first, or return it unchanged if the first argument is Nothing.

(<**) :: SrcSpanInfo -> [SrcSpan] -> SrcSpanInfo infixl 4 Source

Add more positional information for entities of a span.

(<^^>) :: SrcSpan -> SrcSpan -> SrcSpanInfo infixl 6 Source

Merge two SrcSpans and lift them to a SrcInfoSpan with no positional information for entities.

class SrcInfo si where Source

A class to work over all kinds of source location information.

Minimal complete definition

toSrcInfo, fromSrcInfo, fileName, startLine, startColumn

Methods

toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> si Source

fromSrcInfo :: SrcSpanInfo -> si Source

getPointLoc :: si -> SrcLoc Source

fileName :: si -> String Source

startLine :: si -> Int Source

startColumn :: si -> Int Source

Instances

SrcInfo SrcSpanInfo Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcSpanInfo Source fromSrcInfo :: SrcSpanInfo -> SrcSpanInfo Source getPointLoc :: SrcSpanInfo -> SrcLoc Source fileName :: SrcSpanInfo -> String Source startLine :: SrcSpanInfo -> Int Source startColumn :: SrcSpanInfo -> Int Source
SrcInfo SrcSpan Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcSpan Source fromSrcInfo :: SrcSpanInfo -> SrcSpan Source getPointLoc :: SrcSpan -> SrcLoc Source fileName :: SrcSpan -> String Source startLine :: SrcSpan -> Int Source startColumn :: SrcSpan -> Int Source
SrcInfo SrcLoc Source
Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcLoc Source fromSrcInfo :: SrcSpanInfo -> SrcLoc Source getPointLoc :: SrcLoc -> SrcLoc Source fileName :: SrcLoc -> String Source startLine :: SrcLoc -> Int Source startColumn :: SrcLoc -> Int Source