Copyright	(C) 2011-2015 Edward Kmett
License	BSD-style (see the file LICENSE)
Maintainer	Edward Kmett <ekmett@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

Text.Trifecta.Delta

Description

A Delta keeps track of the cursor position of the parser, so it can be referred to later, for example in error messages.

Synopsis

data Delta
- = Columns !Int64 !Int64
- | Tab !Int64 !Int64 !Int64
- | Lines !Int64 !Int64 !Int64 !Int64
- | Directed !ByteString !Int64 !Int64 !Int64 !Int64
class HasDelta t where
class HasBytes t where
nextTab :: Int64 -> Int64
rewind :: Delta -> Delta
near :: (HasDelta s, HasDelta t) => s -> t -> Bool
column :: HasDelta t => t -> Int64
columnByte :: Delta -> Int64

Documentation

data Delta #

Since there are multiple ways to be at a certain location, Delta captures all these alternatives as a single type.

Constructors

Columns !Int64 !Int64	( number of characters , number of bytes )
Tab !Int64 !Int64 !Int64	( number of characters before the tab , number of characters after the tab , number of bytes )
Lines !Int64 !Int64 !Int64 !Int64	( number of newlines contained , number of characters since the last newline , number of bytes , number of bytes since the last newline )
Directed !ByteString !Int64 !Int64 !Int64 !Int64	( current file name , number of lines since the last line directive , number of characters since the last newline , number of bytes , number of bytes since the last newline )

Instances

Eq Delta #
Instance details Defined in Text.Trifecta.Delta Methods (==) :: Delta -> Delta -> Bool # (/=) :: Delta -> Delta -> Bool #
Data Delta #
Instance details Defined in Text.Trifecta.Delta Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Delta -> c Delta # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Delta # toConstr :: Delta -> Constr # dataTypeOf :: Delta -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Delta) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Delta) # gmapT :: (forall b. Data b => b -> b) -> Delta -> Delta # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Delta -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Delta -> r # gmapQ :: (forall d. Data d => d -> u) -> Delta -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Delta -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Delta -> m Delta # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Delta -> m Delta # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Delta -> m Delta #
Ord Delta #
Instance details Defined in Text.Trifecta.Delta Methods compare :: Delta -> Delta -> Ordering # (<) :: Delta -> Delta -> Bool # (<=) :: Delta -> Delta -> Bool # (>) :: Delta -> Delta -> Bool # (>=) :: Delta -> Delta -> Bool # max :: Delta -> Delta -> Delta # min :: Delta -> Delta -> Delta #
Show Delta #
Instance details Defined in Text.Trifecta.Delta Methods showsPrec :: Int -> Delta -> ShowS # show :: Delta -> String # showList :: [Delta] -> ShowS #
Generic Delta #
Instance details Defined in Text.Trifecta.Delta Associated Types type Rep Delta :: * -> * # Methods from :: Delta -> Rep Delta x # to :: Rep Delta x -> Delta #
Semigroup Delta #
Instance details Defined in Text.Trifecta.Delta Methods (<>) :: Delta -> Delta -> Delta # sconcat :: NonEmpty Delta -> Delta # stimes :: Integral b => b -> Delta -> Delta #
Monoid Delta #
Instance details Defined in Text.Trifecta.Delta Methods mempty :: Delta # mappend :: Delta -> Delta -> Delta # mconcat :: [Delta] -> Delta #
Pretty Delta #	Example: `file.txt:12:34`
Instance details Defined in Text.Trifecta.Delta Methods pretty :: Delta -> Doc # prettyList :: [Delta] -> Doc #
Hashable Delta #
Instance details Defined in Text.Trifecta.Delta Methods hashWithSalt :: Int -> Delta -> Int # hash :: Delta -> Int #
HasDelta Delta #
Instance details Defined in Text.Trifecta.Delta Methods delta :: Delta -> Delta #
HasBytes Delta #
Instance details Defined in Text.Trifecta.Delta Methods bytes :: Delta -> Int64 #
Measured Delta Rope #
Instance details Defined in Text.Trifecta.Rope Methods measure :: Rope -> Delta #
Measured Delta Strand #
Instance details Defined in Text.Trifecta.Rope Methods measure :: Strand -> Delta #
MarkParsing Delta Parser #
Instance details Defined in Text.Trifecta.Parser Methods mark :: Parser Delta # release :: Delta -> Parser () #
type Rep Delta #
Instance details Defined in Text.Trifecta.Delta type Rep Delta = D1 (MetaData "Delta" "Text.Trifecta.Delta" "trifecta-2-EopHS1729LQA1QYMOn2Dm4" False) ((C1 (MetaCons "Columns" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64)) :+: C1 (MetaCons "Tab" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64)))) :+: (C1 (MetaCons "Lines" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64)) :: (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64))) :+: C1 (MetaCons "Directed" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64)) :: (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64))))))

class HasDelta t where #

Minimal complete definition

delta

Methods

delta :: t -> Delta #

Instances

HasDelta Char #
Instance details Defined in Text.Trifecta.Delta Methods delta :: Char -> Delta #
HasDelta Word8 #
Instance details Defined in Text.Trifecta.Delta Methods delta :: Word8 -> Delta #
HasDelta ByteString #
Instance details Defined in Text.Trifecta.Delta Methods delta :: ByteString -> Delta #
HasDelta Delta #
Instance details Defined in Text.Trifecta.Delta Methods delta :: Delta -> Delta #
HasDelta Rope #
Instance details Defined in Text.Trifecta.Rope Methods delta :: Rope -> Delta #
HasDelta Strand #
Instance details Defined in Text.Trifecta.Rope Methods delta :: Strand -> Delta #
HasDelta Rendering #
Instance details Defined in Text.Trifecta.Rendering Methods delta :: Rendering -> Delta #
HasDelta Caret #
Instance details Defined in Text.Trifecta.Rendering Methods delta :: Caret -> Delta #
HasDelta HighlightedRope #
Instance details Defined in Text.Trifecta.Highlight Methods delta :: HighlightedRope -> Delta #
HasDelta (Careted a) #
Instance details Defined in Text.Trifecta.Rendering Methods delta :: Careted a -> Delta #
HasDelta (Rendered a) #
Instance details Defined in Text.Trifecta.Rendering Methods delta :: Rendered a -> Delta #
(HasDelta l, HasDelta r) => HasDelta (Either l r) #
Instance details Defined in Text.Trifecta.Delta Methods delta :: Either l r -> Delta #
(Measured v a, HasDelta v) => HasDelta (FingerTree v a) #
Instance details Defined in Text.Trifecta.Delta Methods delta :: FingerTree v a -> Delta #

class HasBytes t where #

Minimal complete definition

bytes

Methods

bytes :: t -> Int64 #

Instances

HasBytes ByteString #
Instance details Defined in Text.Trifecta.Delta Methods bytes :: ByteString -> Int64 #
HasBytes Delta #
Instance details Defined in Text.Trifecta.Delta Methods bytes :: Delta -> Int64 #
HasBytes Rope #
Instance details Defined in Text.Trifecta.Rope Methods bytes :: Rope -> Int64 #
HasBytes Strand #
Instance details Defined in Text.Trifecta.Rope Methods bytes :: Strand -> Int64 #
HasBytes Caret #
Instance details Defined in Text.Trifecta.Rendering Methods bytes :: Caret -> Int64 #
HasBytes HighlightedRope #
Instance details Defined in Text.Trifecta.Highlight Methods bytes :: HighlightedRope -> Int64 #
HasBytes (Careted a) #
Instance details Defined in Text.Trifecta.Rendering Methods bytes :: Careted a -> Int64 #
HasBytes (Rendered a) #
Instance details Defined in Text.Trifecta.Rendering Methods bytes :: Rendered a -> Int64 #
(Measured v a, HasBytes v) => HasBytes (FingerTree v a) #
Instance details Defined in Text.Trifecta.Delta Methods bytes :: FingerTree v a -> Int64 #

nextTab :: Int64 -> Int64 #

Increment a column number to the next tabstop.

rewind :: Delta -> Delta #

Rewind a Delta to the beginning of the line.

near :: (HasDelta s, HasDelta t) => s -> t -> Bool #

Should we show two things with a Delta on the same line?

>>> near (Columns 0 0) (Columns 5 5)
True

>>> near (Lines 1 0 1 0) (Lines 2 4 4 2)
False

column :: HasDelta t => t -> Int64 #

Retrieve the character offset within the current line from this Delta.

columnByte :: Delta -> Int64 #

Retrieve the byte offset within the current line from this Delta.