Highlight.Common.Options

Documentation

data IgnoreCase

Whether or not the case of a regular expression should be ignored. Similar to grep's --ignore-case option.

Constructors

IgnoreCase

DoNotIgnoreCase

Instances

Eq IgnoreCase

Methods

(==) :: IgnoreCase -> IgnoreCase -> Bool

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

Read IgnoreCase

Methods

readsPrec :: Int -> ReadS IgnoreCase

readList :: ReadS [IgnoreCase]

readPrec :: ReadPrec IgnoreCase

readListPrec :: ReadPrec [IgnoreCase]

Show IgnoreCase

Methods

showsPrec :: Int -> IgnoreCase -> ShowS

show :: IgnoreCase -> String

showList :: [IgnoreCase] -> ShowS

class HasIgnoreCase r where

Methods

ignoreCaseLens :: Lens' r IgnoreCase

ignoreCaseLens :: HasCommonOptions r => Lens' r IgnoreCase

Instances

HasIgnoreCase CommonOptions

Methods

ignoreCaseLens :: Lens' CommonOptions IgnoreCase

HasIgnoreCase Options

Methods

ignoreCaseLens :: Lens' Options IgnoreCase

ignoreCaseParser :: Parser IgnoreCase

data Recursive

Whether or not files should be searched recursively. Similar to grep's --recursive option.

Constructors

Recursive

NotRecursive

Instances

Eq Recursive

Methods

(==) :: Recursive -> Recursive -> Bool

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

Read Recursive

Methods

readsPrec :: Int -> ReadS Recursive

readList :: ReadS [Recursive]

readPrec :: ReadPrec Recursive

readListPrec :: ReadPrec [Recursive]

Show Recursive

Methods

showsPrec :: Int -> Recursive -> ShowS

show :: Recursive -> String

showList :: [Recursive] -> ShowS

class HasRecursive r where

Methods

recursiveLens :: Lens' r Recursive

recursiveLens :: HasCommonOptions r => Lens' r Recursive

Instances

HasRecursive CommonOptions

Methods

recursiveLens :: Lens' CommonOptions Recursive

HasRecursive Options

Methods

recursiveLens :: Lens' Options Recursive

recursiveParser :: Parser Recursive

newtype RawRegex

The raw, pre-compiled regular expression passed in on the command line by the user.

Constructors

RawRegex

Fields

• unRawRegex :: String

Instances

Eq RawRegex

Methods

(==) :: RawRegex -> RawRegex -> Bool

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

Read RawRegex

Methods

readsPrec :: Int -> ReadS RawRegex

readList :: ReadS [RawRegex]

readPrec :: ReadPrec RawRegex

readListPrec :: ReadPrec [RawRegex]

Show RawRegex

Methods

showsPrec :: Int -> RawRegex -> ShowS

show :: RawRegex -> String

showList :: [RawRegex] -> ShowS

IsString RawRegex

Methods

fromString :: String -> RawRegex

class HasRawRegex r where

Methods

rawRegexLens :: Lens' r RawRegex

rawRegexLens :: HasCommonOptions r => Lens' r RawRegex

Instances

HasRawRegex CommonOptions

Methods

rawRegexLens :: Lens' CommonOptions RawRegex

HasRawRegex Options

Methods

rawRegexLens :: Lens' Options RawRegex

rawRegexParser :: Parser RawRegex

newtype InputFilename

An input file passed in on the command line by the user.

Constructors

InputFilename

Fields

• unInputFilename :: FilePath

Instances

Eq InputFilename

Methods

(==) :: InputFilename -> InputFilename -> Bool

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

Read InputFilename

Methods

readsPrec :: Int -> ReadS InputFilename

readList :: ReadS [InputFilename]

readPrec :: ReadPrec InputFilename

readListPrec :: ReadPrec [InputFilename]

Show InputFilename

Methods

showsPrec :: Int -> InputFilename -> ShowS

show :: InputFilename -> String

showList :: [InputFilename] -> ShowS

IsString InputFilename

Methods

fromString :: String -> InputFilename

class HasInputFilenames r where

Methods

inputFilenamesLens :: Lens' r [InputFilename]

inputFilenamesLens :: HasCommonOptions r => Lens' r [InputFilename]

Instances

HasInputFilenames CommonOptions

Methods

inputFilenamesLens :: Lens' CommonOptions [InputFilename]

HasInputFilenames Options

Methods

inputFilenamesLens :: Lens' Options [InputFilename]

inputFilenamesParser :: Parser [InputFilename]

data CommonOptions

A set of options that are common to both the highlight and hrep applications.

Constructors

CommonOptions

Fields

• commonOptionsIgnoreCase :: IgnoreCase
• commonOptionsRecursive :: Recursive
• commonOptionsRawRegex :: RawRegex
• commonOptionsInputFilenames :: [InputFilename]

Instances

Eq CommonOptions

Methods

(==) :: CommonOptions -> CommonOptions -> Bool

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

Read CommonOptions

Methods

readsPrec :: Int -> ReadS CommonOptions

readList :: ReadS [CommonOptions]

readPrec :: ReadPrec CommonOptions

readListPrec :: ReadPrec [CommonOptions]

Show CommonOptions

Methods

showsPrec :: Int -> CommonOptions -> ShowS

show :: CommonOptions -> String

showList :: [CommonOptions] -> ShowS

HasCommonOptions CommonOptions

Methods

commonOptionsLens :: Lens' CommonOptions CommonOptions

HasInputFilenames CommonOptions

Methods

inputFilenamesLens :: Lens' CommonOptions [InputFilename]

HasRawRegex CommonOptions

Methods

rawRegexLens :: Lens' CommonOptions RawRegex

HasRecursive CommonOptions

Methods

recursiveLens :: Lens' CommonOptions Recursive

HasIgnoreCase CommonOptions

Methods

ignoreCaseLens :: Lens' CommonOptions IgnoreCase

class HasCommonOptions r where

Minimal complete definition

commonOptionsLens

Methods

commonOptionsLens :: Lens' r CommonOptions

Instances

HasCommonOptions CommonOptions

Methods

commonOptionsLens :: Lens' CommonOptions CommonOptions

HasCommonOptions Options

Methods

commonOptionsLens :: Lens' Options CommonOptions

commonOptionsParser :: Parser CommonOptions

defaultCommonOptions :: CommonOptions

A default set of CommonOptions. Defined as the following:

>>> :{
let opts =
      CommonOptions
        { commonOptionsIgnoreCase = DoNotIgnoreCase
        , commonOptionsRecursive = NotRecursive
        , commonOptionsRawRegex = RawRegex { unRawRegex = "" }
        , commonOptionsInputFilenames = []
        }
:}

>>> opts == defaultCommonOptions
True