Skylighting.Regex

skylighting-core-0.14: syntax highlighting library

Safe Haskell | Safe-Inferred
Language | Haskell2010

Skylighting.Regex

Synopsis

- data Regex
  - = MatchAnyChar
  - | MatchDynamic !Int
  - | MatchChar (Char -> Bool)
  - | MatchSome !Regex
  - | MatchAlt !Regex !Regex
  - | MatchConcat !Regex !Regex
  - | MatchCapture !Int !Regex
  - | MatchCaptured !Int
  - | AssertWordBoundary
  - | AssertBeginning
  - | AssertEnd
  - | AssertPositive !Direction !Regex
  - | AssertNegative !Direction !Regex
  - | Possessive !Regex
  - | Lazy !Regex
  - | Subroutine !Int
  - | MatchNull
- data RE
- pattern RE :: ByteString -> Bool -> RE
- reCaseSensitive :: RE -> Bool
- reString :: RE -> ByteString
- compileRE :: RE -> Either String Regex
- compileRegex :: Bool -> ByteString -> Either String Regex
- matchRegex :: Regex -> ByteString -> Maybe (ByteString, IntMap (Int, Int))
- testRegex :: Bool -> String -> String -> Maybe (String, [(Int, String)])
- isWordChar :: Char -> Bool

# Documentation

data Regex #

Constructors

MatchAnyChar |
MatchDynamic !Int |
MatchChar (Char -> Bool) |
MatchSome !Regex |
MatchAlt !Regex !Regex |
MatchConcat !Regex !Regex |
MatchCapture !Int !Regex |
MatchCaptured !Int |
AssertWordBoundary |
AssertBeginning |
AssertEnd |
AssertPositive !Direction !Regex |
AssertNegative !Direction !Regex |
Possessive !Regex |
Lazy !Regex |
Subroutine !Int |
MatchNull |

#### Instances

Instances details

Monoid Regex # |
Instance details Defined in Regex.KDE.Regex Methods mempty :: Regex mappend :: Regex -> Regex -> Regex mconcat :: [Regex] -> Regex
Semigroup Regex # |
Instance details Defined in Regex.KDE.Regex Methods (<>) :: Regex -> Regex -> Regex # sconcat :: NonEmpty Regex -> Regex stimes :: Integral b => b -> Regex -> Regex
Show Regex # |
Instance details Defined in Regex.KDE.Regex Methods showsPrec :: Int -> Regex -> ShowS show :: Regex -> String showList :: [Regex] -> ShowS

data RE #

A representation of a regular expression.

#### Instances

Instances details

FromJSON RE # |
Instance details Defined in Skylighting.Regex Methods parseJSON :: Value -> Parser RE # parseJSONList :: Value -> Parser [RE] # omittedField :: Maybe RE #
ToJSON RE # |
Instance details Defined in Skylighting.Regex Methods toJSON :: RE -> Value # toEncoding :: RE -> Encoding # toJSONList :: [RE] -> Value # toEncodingList :: [RE] -> Encoding # omitField :: RE -> Bool #
Data RE # |
Instance details Defined in Skylighting.Regex Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RE -> c RE gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RE toConstr :: RE -> Constr dataTypeOf :: RE -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RE) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RE) gmapT :: (forall b. Data b => b -> b) -> RE -> RE gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RE -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RE -> r gmapQ :: (forall d. Data d => d -> u) -> RE -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> RE -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> RE -> m RE gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RE -> m RE gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RE -> m RE
Read RE # |
Instance details Defined in Skylighting.Regex Methods readsPrec :: Int -> ReadS RE readList :: ReadS [RE] readPrec :: ReadPrec RE readListPrec :: ReadPrec [RE]
Show RE # |
Instance details Defined in Skylighting.Regex Methods showsPrec :: Int -> RE -> ShowS show :: RE -> String showList :: [RE] -> ShowS
Binary RE # |
Instance details Defined in Skylighting.Regex Methods put :: RE -> Put get :: Get RE putList :: [RE] -> Put
Eq RE # |
Instance details Defined in Skylighting.Regex Methods (==) :: RE -> RE -> Bool (/=) :: RE -> RE -> Bool
Ord RE # |
Instance details Defined in Skylighting.Regex Methods compare :: RE -> RE -> Ordering (<) :: RE -> RE -> Bool (<=) :: RE -> RE -> Bool (>) :: RE -> RE -> Bool (>=) :: RE -> RE -> Bool max :: RE -> RE -> RE min :: RE -> RE -> RE

pattern RE :: ByteString -> Bool -> RE #

reCaseSensitive :: RE -> Bool #

reString :: RE -> ByteString #

compileRE :: RE -> Either String Regex #

compileRegex :: Bool -> ByteString -> Either String Regex #

Compile a UTF-8 encoded ByteString as a Regex. If the first parameter is True, then the Regex will be case sensitive.

matchRegex :: Regex -> ByteString -> Maybe (ByteString, IntMap (Int, Int)) #

Match a Regex against a (presumed UTF-8 encoded) ByteString, returning the matched text and a map of (offset, size) pairs for captures. Note that all matches are from the beginning of the string (a `^` anchor is implicit). Note also that to avoid pathological performance in certain cases, the matcher is limited to considering 2000 possible matches at a time; when that threshold is reached, it discards smaller matches. Hence certain regexes may incorrectly fail to match: e.g. `a*a{3000}$` on a string of 3000 `a`s.

testRegex :: Bool -> String -> String -> Maybe (String, [(Int, String)]) #

isWordChar :: Char -> Bool #