Safe Haskell	None
Language	Haskell2010

Text.RE.ZeInternals.Types.CaptureID

Synopsis

Documentation

data CaptureID Source #

CaptureID identifies captures, either by number (e.g., [cp|1|]) or name (e.g., [cp|foo|]).

Constructors

IsCaptureOrdinal CaptureOrdinal
IsCaptureName CaptureName

Instances

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

type CaptureNames = HashMap CaptureName CaptureOrdinal Source #

the dictionary for named captures stored in compiled regular expressions associates

noCaptureNames :: CaptureNames Source #

an empty CaptureNames dictionary

newtype CaptureName Source #

a CaptureName is just the text of the name

Constructors

CaptureName
Fields getCaptureName :: Text

Instances

Eq CaptureName Source #
Methods (==) :: CaptureName -> CaptureName -> Bool # (/=) :: CaptureName -> CaptureName -> Bool #
Ord CaptureName Source #
Methods compare :: CaptureName -> CaptureName -> Ordering # (<) :: CaptureName -> CaptureName -> Bool # (<=) :: CaptureName -> CaptureName -> Bool # (>) :: CaptureName -> CaptureName -> Bool # (>=) :: CaptureName -> CaptureName -> Bool # max :: CaptureName -> CaptureName -> CaptureName # min :: CaptureName -> CaptureName -> CaptureName #
Show CaptureName Source #
Methods showsPrec :: Int -> CaptureName -> ShowS # show :: CaptureName -> String # showList :: [CaptureName] -> ShowS #
Hashable CaptureName Source #
Methods hashWithSalt :: Int -> CaptureName -> Int # hash :: CaptureName -> Int #

newtype CaptureOrdinal Source #

a CaptureOrdinal is just the number of the capture, starting with 0 for the whole of the text matched, then in leftmost, outermost

Constructors

CaptureOrdinal
Fields getCaptureOrdinal :: Int

Instances

Enum CaptureOrdinal Source #
Methods succ :: CaptureOrdinal -> CaptureOrdinal # pred :: CaptureOrdinal -> CaptureOrdinal # toEnum :: Int -> CaptureOrdinal # fromEnum :: CaptureOrdinal -> Int # enumFrom :: CaptureOrdinal -> [CaptureOrdinal] # enumFromThen :: CaptureOrdinal -> CaptureOrdinal -> [CaptureOrdinal] # enumFromTo :: CaptureOrdinal -> CaptureOrdinal -> [CaptureOrdinal] # enumFromThenTo :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal -> [CaptureOrdinal] #
Eq CaptureOrdinal Source #
Methods (==) :: CaptureOrdinal -> CaptureOrdinal -> Bool # (/=) :: CaptureOrdinal -> CaptureOrdinal -> Bool #
Num CaptureOrdinal Source #
Methods (+) :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal # (-) :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal # (*) :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal # negate :: CaptureOrdinal -> CaptureOrdinal # abs :: CaptureOrdinal -> CaptureOrdinal # signum :: CaptureOrdinal -> CaptureOrdinal # fromInteger :: Integer -> CaptureOrdinal #
Ord CaptureOrdinal Source #
Methods compare :: CaptureOrdinal -> CaptureOrdinal -> Ordering # (<) :: CaptureOrdinal -> CaptureOrdinal -> Bool # (<=) :: CaptureOrdinal -> CaptureOrdinal -> Bool # (>) :: CaptureOrdinal -> CaptureOrdinal -> Bool # (>=) :: CaptureOrdinal -> CaptureOrdinal -> Bool # max :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal # min :: CaptureOrdinal -> CaptureOrdinal -> CaptureOrdinal #
Show CaptureOrdinal Source #
Methods showsPrec :: Int -> CaptureOrdinal -> ShowS # show :: CaptureOrdinal -> String # showList :: [CaptureOrdinal] -> ShowS #
Ix CaptureOrdinal Source #
Methods range :: (CaptureOrdinal, CaptureOrdinal) -> [CaptureOrdinal] # index :: (CaptureOrdinal, CaptureOrdinal) -> CaptureOrdinal -> Int # unsafeIndex :: (CaptureOrdinal, CaptureOrdinal) -> CaptureOrdinal -> Int inRange :: (CaptureOrdinal, CaptureOrdinal) -> CaptureOrdinal -> Bool # rangeSize :: (CaptureOrdinal, CaptureOrdinal) -> Int # unsafeRangeSize :: (CaptureOrdinal, CaptureOrdinal) -> Int

unsafeFindCaptureID :: CaptureID -> CaptureNames -> Int Source #

look up a CaptureID in the CaptureNames dictionary

findCaptureID :: CaptureID -> CaptureNames -> Either String Int Source #

look up a CaptureID in the CaptureNames dictionary