hledger-lib-1.21: A reusable library providing the core functionality of hledger
Safe HaskellNone
LanguageHaskell2010

Hledger.Utils.Regex

Description

Easy regular expression helpers, currently based on regex-tdfa. These should:

  • be cross-platform, not requiring C libraries
  • support unicode
  • support extended regular expressions
  • support replacement, with backreferences etc.
  • support splitting
  • have mnemonic names
  • have simple monomorphic types
  • work with simple strings

Regex strings are automatically compiled into regular expressions the first time they are seen, and these are cached. If you use a huge number of unique regular expressions this might lead to increased memory usage. Several functions have memoised variants (*Memo), which also trade space for time.

Currently two APIs are provided:

  • The old partial one (with ' suffixes') which will call error on any problem (eg with malformed regexps). This comes from hledger's origin as a command-line tool.
  • The new total one which will return an error message. This is better for long-running apps like hledger-web.

Current limitations:

  • (?i) and similar are not supported
Synopsis

Regexp type and constructors

data Regexp Source #

Regular expression. Extended regular expression-ish syntax ? But does not support eg (?i) syntax.

Instances

Instances details
Eq Regexp Source # 
Instance details

Defined in Hledger.Utils.Regex

Methods

(==) :: Regexp -> Regexp -> Bool #

(/=) :: Regexp -> Regexp -> Bool #

Ord Regexp Source # 
Instance details

Defined in Hledger.Utils.Regex

Read Regexp Source # 
Instance details

Defined in Hledger.Utils.Regex

Show Regexp Source # 
Instance details

Defined in Hledger.Utils.Regex

ToJSON Regexp Source # 
Instance details

Defined in Hledger.Utils.Regex

RegexLike Regexp String Source # 
Instance details

Defined in Hledger.Utils.Regex

RegexContext Regexp String String Source # 
Instance details

Defined in Hledger.Utils.Regex

Methods

match :: Regexp -> String -> String #

matchM :: MonadFail m => Regexp -> String -> m String #

type aliases

type Replacement = String Source #

A replacement pattern. May include numeric backreferences (N).

type RegexError = String Source #

An error message arising during a regular expression operation. Eg: trying to compile a malformed regular expression, or trying to apply a malformed replacement pattern.

total regex operations

regexMatch :: Regexp -> String -> Bool Source #

Test whether a Regexp matches a String. This is an alias for matchTest for consistent naming.

regexMatchText :: Regexp -> Text -> Bool Source #

Tests whether a Regexp matches a Text.

This currently unpacks the Text to a String an works on that. This is due to a performance bug in regex-tdfa (#9), which may or may not be relevant here.

regexReplace :: Regexp -> Replacement -> String -> Either RegexError String Source #

A memoising version of regexReplace. Caches the result for each search pattern, replacement pattern, target string tuple. This won't generate a regular expression parsing error since that is pre-compiled nowadays, but there can still be a runtime error from the replacement pattern, eg with a backreference referring to a nonexistent match group.