Text.RE.Tools.Grep

Documentation

grep :: IsRegex re ByteString => Verbosity -> re -> FilePath -> IO ()

operates a bit like classic grep printing out the lines matched

data Line

grepLines returns a Line for each line in the file, listing all of the Matches for that line

Constructors

Line

Fields

• getLineNumber :: LineNo

  the LineNo for this line

• getLineMatches :: Matches ByteString

  all the Matches of the RE on this line

Instances

Show Line

Methods

showsPrec :: Int -> Line -> ShowS

show :: Line -> String

showList :: [Line] -> ShowS

grepLines :: IsRegex re ByteString => re -> FilePath -> IO [Line]

returns a Line for each line in the file enumerating all of the matches for that line.

type GrepScript re s t = [(re, LineNo -> Matches s -> Maybe t)]

a GrepScript lists RE-action associations, with the first RE to match a line selecting the action to be executed on each line in the file

grepScript :: IsRegex re s => GrepScript re s t -> [s] -> [t]

given a list of lines, apply the GrepScript to each line of the file

report :: Verbosity -> [Line] -> String

generate a grep report from a list of Line

data Verbosity

specifies whether to return the linss matched or missed

Constructors

LinesMatched

LinesNotMatched

Instances

Eq Verbosity

Methods

(==) :: Verbosity -> Verbosity -> Bool

(/=) :: Verbosity -> Verbosity -> Bool

Ord Verbosity

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

(<=) :: Verbosity -> Verbosity -> Bool

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

Show Verbosity

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

linesMatched :: Verbosity -> [Line] -> [Line]

given a velocity flag filter out either the lines matched or not matched

IsRegex

class Replace s => IsRegex re s where

the IsRegex class allows tools to be written that will work with regex back end text type supported by the back end

Minimal complete definition

matchOnce, matchMany, makeRegexWith, makeSearchReplaceWith, regexSource

Methods

matchOnce :: re -> s -> Match s

finding the first match

matchMany :: re -> s -> Matches s

finding all matches

makeRegex :: (Functor m, Monad m) => s -> m re

compiling an RE, failing if the RE is not well formed

makeRegexWith :: (Functor m, Monad m) => SimpleREOptions -> s -> m re

comiling an RE, specifying the SimpleREOptions

makeSearchReplace :: (Functor m, Monad m, IsRegex re s) => s -> s -> m (SearchReplace re s)

compiling a SearchReplace template from the RE text and the template Text, failing if they are not well formed

makeSearchReplaceWith :: (Functor m, Monad m, IsRegex re s) => SimpleREOptions -> s -> s -> m (SearchReplace re s)

compiling a SearchReplace template specifing the SimpleREOptions for the RE

makeEscaped :: (Functor m, Monad m) => (s -> s) -> s -> m re

incorporate an escaped string into a compiled RE with the default options

makeEscapedWith :: (Functor m, Monad m) => SimpleREOptions -> (s -> s) -> s -> m re

incorporate an escaped string into a compiled RE with the specified SimpleREOptions

regexSource :: re -> s

extract the text of the RE from the RE

LineNo

newtype LineNo

our line numbers are of the proper zero-based kind

Constructors

ZeroBasedLineNo

Fields

• getZeroBasedLineNo :: Int

Instances

Enum LineNo

Methods

succ :: LineNo -> LineNo

pred :: LineNo -> LineNo

toEnum :: Int -> LineNo

fromEnum :: LineNo -> Int

enumFrom :: LineNo -> [LineNo]

enumFromThen :: LineNo -> LineNo -> [LineNo]

enumFromTo :: LineNo -> LineNo -> [LineNo]

enumFromThenTo :: LineNo -> LineNo -> LineNo -> [LineNo]

Show LineNo

Methods

showsPrec :: Int -> LineNo -> ShowS

show :: LineNo -> String

showList :: [LineNo] -> ShowS

firstLine :: LineNo

the first line in a file

getLineNo :: LineNo -> Int

extract a conventional 1-based line number

lineNo :: Int -> LineNo

inject a conventional 1-based line number

Text.RE

module Text.RE