Safe Haskell	None
Language	Haskell2010

Data.Loc.Types

Description

For convenience, this module exports only the important types from Loc.

Synopsis

Documentation

data Pos Source #

Pos stands for positive integer. You can also think of it as position, because we use it to represent line and column numbers (Line and Column).

Pos has instances of several of the standard numeric typeclasses, although many of the operations throw Underflow when non-positive values result. Pos does not have an Integral instance, because there is no sensible way to implement quotRem.

Instances

Enum Pos Source #	`>>>` `toEnum 3 :: Pos`3 `>>>` `toEnum 0 :: Pos`* Exception: arithmetic underflow `>>>` `fromEnum (3 :: Pos)`**3
Methods succ :: Pos -> Pos # pred :: Pos -> Pos # toEnum :: Int -> Pos # fromEnum :: Pos -> Int # enumFrom :: Pos -> [Pos] # enumFromThen :: Pos -> Pos -> [Pos] # enumFromTo :: Pos -> Pos -> [Pos] # enumFromThenTo :: Pos -> Pos -> Pos -> [Pos] #
Eq Pos Source #
Methods (==) :: Pos -> Pos -> Bool # (/=) :: Pos -> Pos -> Bool #
Num Pos Source #	`>>>` `fromInteger 3 :: Pos`3 `>>>` `fromInteger 0 :: Pos`* Exception: arithmetic underflow `>>>` `2 + 3 :: Pos`5 `>>>` `3 - 2 :: Pos`1 `>>>` `3 - 3 :: Pos`*** Exception: arithmetic underflow `>>>` `2 * 3 :: Pos`6 `>>>` `negate 3 :: Pos`***** Exception: arithmetic underflow
Methods (+) :: Pos -> Pos -> Pos # (-) :: Pos -> Pos -> Pos # (*) :: Pos -> Pos -> Pos # negate :: Pos -> Pos # abs :: Pos -> Pos # signum :: Pos -> Pos # fromInteger :: Integer -> Pos #
Ord Pos Source #
Methods compare :: Pos -> Pos -> Ordering # (<) :: Pos -> Pos -> Bool # (<=) :: Pos -> Pos -> Bool # (>) :: Pos -> Pos -> Bool # (>=) :: Pos -> Pos -> Bool # max :: Pos -> Pos -> Pos # min :: Pos -> Pos -> Pos #
Read Pos Source #
Methods readsPrec :: Int -> ReadS Pos # readList :: ReadS [Pos] # readPrec :: ReadPrec Pos # readListPrec :: ReadPrec [Pos] #
Real Pos Source #
Methods toRational :: Pos -> Rational #
Show Pos Source #
Methods showsPrec :: Int -> Pos -> ShowS # show :: Pos -> String # showList :: [Pos] -> ShowS #
ToNat Pos Source #
Methods toNat :: Pos -> Natural Source #

data Line Source #

Instances

Enum Line Source #
Methods succ :: Line -> Line # pred :: Line -> Line # toEnum :: Int -> Line # fromEnum :: Line -> Int # enumFrom :: Line -> [Line] # enumFromThen :: Line -> Line -> [Line] # enumFromTo :: Line -> Line -> [Line] # enumFromThenTo :: Line -> Line -> Line -> [Line] #
Eq Line Source #
Methods (==) :: Line -> Line -> Bool # (/=) :: Line -> Line -> Bool #
Num Line Source #
Methods (+) :: Line -> Line -> Line # (-) :: Line -> Line -> Line # (*) :: Line -> Line -> Line # negate :: Line -> Line # abs :: Line -> Line # signum :: Line -> Line # fromInteger :: Integer -> Line #
Ord Line Source #
Methods compare :: Line -> Line -> Ordering # (<) :: Line -> Line -> Bool # (<=) :: Line -> Line -> Bool # (>) :: Line -> Line -> Bool # (>=) :: Line -> Line -> Bool # max :: Line -> Line -> Line # min :: Line -> Line -> Line #
Read Line Source #
Methods readsPrec :: Int -> ReadS Line # readList :: ReadS [Line] # readPrec :: ReadPrec Line # readListPrec :: ReadPrec [Line] #
Real Line Source #
Methods toRational :: Line -> Rational #
Show Line Source #
Methods showsPrec :: Int -> Line -> ShowS # show :: Line -> String # showList :: [Line] -> ShowS #
ToNat Line Source #
Methods toNat :: Line -> Natural Source #

data Column Source #

Instances

Enum Column Source #
Methods succ :: Column -> Column # pred :: Column -> Column # toEnum :: Int -> Column # fromEnum :: Column -> Int # enumFrom :: Column -> [Column] # enumFromThen :: Column -> Column -> [Column] # enumFromTo :: Column -> Column -> [Column] # enumFromThenTo :: Column -> Column -> Column -> [Column] #
Eq Column Source #
Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Num Column Source #
Methods (+) :: Column -> Column -> Column # (-) :: Column -> Column -> Column # (*) :: Column -> Column -> Column # negate :: Column -> Column # abs :: Column -> Column # signum :: Column -> Column # fromInteger :: Integer -> Column #
Ord Column Source #
Methods compare :: Column -> Column -> Ordering # (<) :: Column -> Column -> Bool # (<=) :: Column -> Column -> Bool # (>) :: Column -> Column -> Bool # (>=) :: Column -> Column -> Bool # max :: Column -> Column -> Column # min :: Column -> Column -> Column #
Read Column Source #
Methods readsPrec :: Int -> ReadS Column # readList :: ReadS [Column] # readPrec :: ReadPrec Column # readListPrec :: ReadPrec [Column] #
Real Column Source #
Methods toRational :: Column -> Rational #
Show Column Source #
Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
ToNat Column Source #
Methods toNat :: Column -> Natural Source #

data Loc Source #

Stands for location. Consists of a Line and a Column. You can think of a Loc like a caret position in a text editor. Following the normal convention for text editors and such, line and column numbers start with 1.

Instances

Eq Loc Source #
Methods (==) :: Loc -> Loc -> Bool # (/=) :: Loc -> Loc -> Bool #
Ord Loc Source #
Methods compare :: Loc -> Loc -> Ordering # (<) :: Loc -> Loc -> Bool # (<=) :: Loc -> Loc -> Bool # (>) :: Loc -> Loc -> Bool # (>=) :: Loc -> Loc -> Bool # max :: Loc -> Loc -> Loc # min :: Loc -> Loc -> Loc #
Read Loc Source #	`readPrec` = `locReadPrec`
Methods readsPrec :: Int -> ReadS Loc # readList :: ReadS [Loc] # readPrec :: ReadPrec Loc # readListPrec :: ReadPrec [Loc] #
Show Loc Source #	`showsPrec` = `locShowsPrec`
Methods showsPrec :: Int -> Loc -> ShowS # show :: Loc -> String # showList :: [Loc] -> ShowS #

data Span Source #

A Span consists of a start location (start) and an end location (end). The end location must be greater than the start location; in other words, empty or backwards spans are not permitted.

Construct and combine spans using fromTo, fromToMay, +, and -.

Instances

Eq Span Source #
Methods (==) :: Span -> Span -> Bool # (/=) :: Span -> Span -> Bool #
Ord Span Source #
Methods compare :: Span -> Span -> Ordering # (<) :: Span -> Span -> Bool # (<=) :: Span -> Span -> Bool # (>) :: Span -> Span -> Bool # (>=) :: Span -> Span -> Bool # max :: Span -> Span -> Span # min :: Span -> Span -> Span #
Read Span Source #	`readPrec` = `spanReadPrec`
Methods readsPrec :: Int -> ReadS Span # readList :: ReadS [Span] # readPrec :: ReadPrec Span # readListPrec :: ReadPrec [Span] #
Show Span Source #	`showsPrec` = `spanShowsPrec`
Methods showsPrec :: Int -> Span -> ShowS # show :: Span -> String # showList :: [Span] -> ShowS #

data Area Source #

A set of non-overlapping, non-abutting Spans. You may also think of an Area like a span that can be empty or have “gaps”.

Construct and combine areas using mempty, spanArea, fromTo, +, and -.

Instances

Eq Area Source #
Methods (==) :: Area -> Area -> Bool # (/=) :: Area -> Area -> Bool #
Ord Area Source #
Methods compare :: Area -> Area -> Ordering # (<) :: Area -> Area -> Bool # (<=) :: Area -> Area -> Bool # (>) :: Area -> Area -> Bool # (>=) :: Area -> Area -> Bool # max :: Area -> Area -> Area # min :: Area -> Area -> Area #
Read Area Source #	`readPrec` = `areaReadPrec`
Methods readsPrec :: Int -> ReadS Area # readList :: ReadS [Area] # readPrec :: ReadPrec Area # readListPrec :: ReadPrec [Area] #
Show Area Source #	`showsPrec` = `areaShowsPrec`
Methods showsPrec :: Int -> Area -> ShowS # show :: Area -> String # showList :: [Area] -> ShowS #
Semigroup Area Source #	`<>` = `+`
Methods (<>) :: Area -> Area -> Area # sconcat :: NonEmpty Area -> Area # stimes :: Integral b => b -> Area -> Area #
Monoid Area Source #
Methods mempty :: Area # mappend :: Area -> Area -> Area # mconcat :: [Area] -> Area #