Safe Haskell	None
Language	Haskell2010

Highlight.Common.Options

Synopsis

data IgnoreCase
- = IgnoreCase
- | DoNotIgnoreCase
class HasIgnoreCase r where
- ignoreCaseLens :: Lens' r IgnoreCase
ignoreCaseParser :: Parser IgnoreCase
data Recursive
- = Recursive
- | NotRecursive
class HasRecursive r where
- recursiveLens :: Lens' r Recursive
recursiveParser :: Parser Recursive
newtype RawRegex = RawRegex {
- unRawRegex :: String
}
class HasRawRegex r where
- rawRegexLens :: Lens' r RawRegex
rawRegexParser :: Parser RawRegex
newtype InputFilename = InputFilename {
- unInputFilename :: FilePath
}
class HasInputFilenames r where
- inputFilenamesLens :: Lens' r [InputFilename]
inputFilenamesParser :: Parser [InputFilename]
data CommonOptions = CommonOptions {
}
class HasCommonOptions r where
- commonOptionsLens :: Lens' r CommonOptions
commonOptionsParser :: Parser CommonOptions
defaultCommonOptions :: CommonOptions

Documentation

data IgnoreCase Source #

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

Constructors

IgnoreCase
DoNotIgnoreCase

Instances

Instances details

Eq IgnoreCase Source #
Instance details Defined in Highlight.Common.Options Methods (==) :: IgnoreCase -> IgnoreCase -> Bool # (/=) :: IgnoreCase -> IgnoreCase -> Bool #
Read IgnoreCase Source #
Instance details Defined in Highlight.Common.Options Methods readsPrec :: Int -> ReadS IgnoreCase # readList :: ReadS [IgnoreCase] # readPrec :: ReadPrec IgnoreCase # readListPrec :: ReadPrec [IgnoreCase] #
Show IgnoreCase Source #
Instance details Defined in Highlight.Common.Options Methods showsPrec :: Int -> IgnoreCase -> ShowS # show :: IgnoreCase -> String # showList :: [IgnoreCase] -> ShowS #

class HasIgnoreCase r where Source #

Minimal complete definition

Nothing

Methods

ignoreCaseLens :: Lens' r IgnoreCase Source #

default ignoreCaseLens :: HasCommonOptions r => Lens' r IgnoreCase Source #

Instances

Instances details

HasIgnoreCase CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods ignoreCaseLens :: Lens' CommonOptions IgnoreCase Source #
HasIgnoreCase Options Source #
Instance details Defined in Highlight.Highlight.Options Methods ignoreCaseLens :: Lens' Options IgnoreCase Source #

ignoreCaseParser :: Parser IgnoreCase Source #

data Recursive Source #

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

Constructors

Recursive
NotRecursive

Instances

Instances details

Eq Recursive Source #
Instance details Defined in Highlight.Common.Options Methods (==) :: Recursive -> Recursive -> Bool # (/=) :: Recursive -> Recursive -> Bool #
Read Recursive Source #
Instance details Defined in Highlight.Common.Options Methods readsPrec :: Int -> ReadS Recursive # readList :: ReadS [Recursive] # readPrec :: ReadPrec Recursive # readListPrec :: ReadPrec [Recursive] #
Show Recursive Source #
Instance details Defined in Highlight.Common.Options Methods showsPrec :: Int -> Recursive -> ShowS # show :: Recursive -> String # showList :: [Recursive] -> ShowS #

class HasRecursive r where Source #

Minimal complete definition

Nothing

Methods

recursiveLens :: Lens' r Recursive Source #

default recursiveLens :: HasCommonOptions r => Lens' r Recursive Source #

Instances

Instances details

HasRecursive CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods recursiveLens :: Lens' CommonOptions Recursive Source #
HasRecursive Options Source #
Instance details Defined in Highlight.Highlight.Options Methods recursiveLens :: Lens' Options Recursive Source #

recursiveParser :: Parser Recursive Source #

newtype RawRegex Source #

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

Constructors

RawRegex
Fields unRawRegex :: String

Instances

Instances details

Eq RawRegex Source #
Instance details Defined in Highlight.Common.Options Methods (==) :: RawRegex -> RawRegex -> Bool # (/=) :: RawRegex -> RawRegex -> Bool #
Read RawRegex Source #
Instance details Defined in Highlight.Common.Options Methods readsPrec :: Int -> ReadS RawRegex # readList :: ReadS [RawRegex] # readPrec :: ReadPrec RawRegex # readListPrec :: ReadPrec [RawRegex] #
Show RawRegex Source #
Instance details Defined in Highlight.Common.Options Methods showsPrec :: Int -> RawRegex -> ShowS # show :: RawRegex -> String # showList :: [RawRegex] -> ShowS #
IsString RawRegex Source #
Instance details Defined in Highlight.Common.Options Methods fromString :: String -> RawRegex #

class HasRawRegex r where Source #

Minimal complete definition

Nothing

Methods

rawRegexLens :: Lens' r RawRegex Source #

default rawRegexLens :: HasCommonOptions r => Lens' r RawRegex Source #

Instances

Instances details

HasRawRegex CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods rawRegexLens :: Lens' CommonOptions RawRegex Source #
HasRawRegex Options Source #
Instance details Defined in Highlight.Highlight.Options Methods rawRegexLens :: Lens' Options RawRegex Source #

rawRegexParser :: Parser RawRegex Source #

newtype InputFilename Source #

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

Constructors

InputFilename
Fields unInputFilename :: FilePath

Instances

Instances details

Eq InputFilename Source #
Instance details Defined in Highlight.Common.Options Methods (==) :: InputFilename -> InputFilename -> Bool # (/=) :: InputFilename -> InputFilename -> Bool #
Read InputFilename Source #
Instance details Defined in Highlight.Common.Options Methods readsPrec :: Int -> ReadS InputFilename # readList :: ReadS [InputFilename] # readPrec :: ReadPrec InputFilename # readListPrec :: ReadPrec [InputFilename] #
Show InputFilename Source #
Instance details Defined in Highlight.Common.Options Methods showsPrec :: Int -> InputFilename -> ShowS # show :: InputFilename -> String # showList :: [InputFilename] -> ShowS #
IsString InputFilename Source #
Instance details Defined in Highlight.Common.Options Methods fromString :: String -> InputFilename #

class HasInputFilenames r where Source #

Minimal complete definition

Nothing

Methods

inputFilenamesLens :: Lens' r [InputFilename] Source #

default inputFilenamesLens :: HasCommonOptions r => Lens' r [InputFilename] Source #

Instances

Instances details

HasInputFilenames CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods inputFilenamesLens :: Lens' CommonOptions [InputFilename] Source #
HasInputFilenames Options Source #
Instance details Defined in Highlight.Highlight.Options Methods inputFilenamesLens :: Lens' Options [InputFilename] Source #

inputFilenamesParser :: Parser [InputFilename] Source #

data CommonOptions Source #

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

Instances details

Eq CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods (==) :: CommonOptions -> CommonOptions -> Bool # (/=) :: CommonOptions -> CommonOptions -> Bool #
Read CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods readsPrec :: Int -> ReadS CommonOptions # readList :: ReadS [CommonOptions] # readPrec :: ReadPrec CommonOptions # readListPrec :: ReadPrec [CommonOptions] #
Show CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods showsPrec :: Int -> CommonOptions -> ShowS # show :: CommonOptions -> String # showList :: [CommonOptions] -> ShowS #
HasCommonOptions CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods commonOptionsLens :: Lens' CommonOptions CommonOptions Source #
HasInputFilenames CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods inputFilenamesLens :: Lens' CommonOptions [InputFilename] Source #
HasRawRegex CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods rawRegexLens :: Lens' CommonOptions RawRegex Source #
HasRecursive CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods recursiveLens :: Lens' CommonOptions Recursive Source #
HasIgnoreCase CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods ignoreCaseLens :: Lens' CommonOptions IgnoreCase Source #

class HasCommonOptions r where Source #

Methods

commonOptionsLens :: Lens' r CommonOptions Source #

Instances

Instances details

HasCommonOptions CommonOptions Source #
Instance details Defined in Highlight.Common.Options Methods commonOptionsLens :: Lens' CommonOptions CommonOptions Source #
HasCommonOptions Options Source #
Instance details Defined in Highlight.Highlight.Options Methods commonOptionsLens :: Lens' Options CommonOptions Source #

commonOptionsParser :: Parser CommonOptions Source #

defaultCommonOptions :: CommonOptions Source #

A default set of CommonOptions. Defined as the following:

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

>>> opts == defaultCommonOptions
True