highlight-1.0.0.2: Command line tool for highlighting parts of files matching a regex.
Safe HaskellNone
LanguageHaskell2010

Highlight.Highlight.Options

Synopsis

Documentation

data ColorGrepFilenames Source #

Whether or not to color filenames output by grep when reading in from stdin.

Constructors

ColorGrepFilenames 
DoNotColorGrepFileNames 

Instances

Instances details
Eq ColorGrepFilenames Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

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

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

Read ColorGrepFilenames Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

readsPrec :: Int -> ReadS ColorGrepFilenames #

readList :: ReadS [ColorGrepFilenames] #

readPrec :: ReadPrec ColorGrepFilenames #

readListPrec :: ReadPrec [ColorGrepFilenames] #

Show ColorGrepFilenames Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

showsPrec :: Int -> ColorGrepFilenames -> ShowS #

show :: ColorGrepFilenames -> String #

showList :: [ColorGrepFilenames] -> ShowS #

colorGrepFilenamesParser :: Parser ColorGrepFilenames Source #

class HasColorGrepFilenames r where Source #

Methods

colorGrepFilenamesLens :: Lens' r ColorGrepFilenames Source #

Instances

Instances details
HasColorGrepFilenames Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

colorGrepFilenamesLens :: Lens' Options ColorGrepFilenames Source #

data Options Source #

Constructors

Options 

Fields

Instances

Instances details
Eq Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

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

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

Read Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

readsPrec :: Int -> ReadS Options #

readList :: ReadS [Options] #

readPrec :: ReadPrec Options #

readListPrec :: ReadPrec [Options] #

Show Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

showsPrec :: Int -> Options -> ShowS #

show :: Options -> String #

showList :: [Options] -> ShowS #

HasCommonOptions Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

commonOptionsLens :: Lens' Options CommonOptions Source #

HasInputFilenames Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

inputFilenamesLens :: Lens' Options [InputFilename] Source #

HasRawRegex Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

rawRegexLens :: Lens' Options RawRegex Source #

HasRecursive Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

recursiveLens :: Lens' Options Recursive Source #

HasIgnoreCase Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

ignoreCaseLens :: Lens' Options IgnoreCase Source #

HasOptions Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

optionsLens :: Lens' Options Options Source #

HasColorGrepFilenames Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

colorGrepFilenamesLens :: Lens' Options ColorGrepFilenames Source #

defaultOptions :: Options Source #

optionsParser :: Parser Options Source #

class HasOptions r where Source #

Methods

optionsLens :: Lens' r Options Source #

Instances

Instances details
HasOptions Options Source # 
Instance details

Defined in Highlight.Highlight.Options

Methods

optionsLens :: Lens' Options Options 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 #

data CommonOptions Source #

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

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 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 #

newtype InputFilename Source #

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

Constructors

InputFilename 

Fields

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 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 #

newtype RawRegex Source #

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

Constructors

RawRegex 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 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 #

data Recursive Source #

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

Constructors

Recursive 

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 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 #

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 #

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