-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Declarative command-line parser using type-driven pattern matching.
--   
--   This is a declarative command-line parser that uses type-driven
--   pattern matching.
@package lambda-options
@version 1.0.0.0


-- | Data definition for option keywords.
module Text.LambdaOptions.Keyword

-- | An option keyword, such as <tt>"--help"</tt>
data Keyword
Keyword :: [String] -> String -> String -> Keyword

-- | All the aliases for this keyword.
[kwNames] :: Keyword -> [String]

-- | Text to describe the arguments to the option given by this keyword.
[kwArgText] :: Keyword -> String

-- | Text to describe the function of the option given by this keyword.
[kwText] :: Keyword -> String

-- | Convenience <a>Keyword</a> creation class.
class ToKeyword a
toKeyword :: ToKeyword a => a -> Keyword

-- | Shorthand for <a>toKeyword</a>.
kw :: ToKeyword a => a -> Keyword

-- | Sets the <a>kwArgText</a> field in the keyword. Intended to be used
--   infix:
--   
--   <pre>
--   kw "--directory" `argText` "DIR" `text` "Write files to DIR."
--   </pre>
argText :: Keyword -> String -> Keyword

-- | Sets the <a>kwText</a> field in the keyword. Intended to be used
--   infix.
--   
--   <pre>
--   kw "--quiet" `text` "Suppress message display."
--   </pre>
text :: Keyword -> String -> Keyword
instance GHC.Classes.Ord Text.LambdaOptions.Keyword.Keyword
instance GHC.Classes.Eq Text.LambdaOptions.Keyword.Keyword
instance GHC.Show.Show Text.LambdaOptions.Keyword.Keyword
instance Data.Data.Data Text.LambdaOptions.Keyword.Keyword
instance Text.LambdaOptions.Keyword.ToKeyword Text.LambdaOptions.Keyword.Keyword
instance Text.LambdaOptions.Keyword.ToKeyword GHC.Base.String
instance Text.LambdaOptions.Keyword.ToKeyword [GHC.Base.String]
instance Text.LambdaOptions.Keyword.ToKeyword ()
instance Data.String.IsString Text.LambdaOptions.Keyword.Keyword


-- | Provides a configurable way to format help options for textual
--   presentation.
module Text.LambdaOptions.Formatter

-- | User configuration for formatting.
data FormatConfig
FormatConfig :: Int -> FormatConfig
[fmtMaxWidth] :: FormatConfig -> Int

-- | <pre>
--   FormatConfig { fmtMaxWidth = 80 }
--   </pre>
defaultFormatConfig :: FormatConfig

-- | Formats the given string with the given configuration.
format :: FormatConfig -> String -> String

-- | Formats the given keywords with the given configuration.
formatKeywords :: FormatConfig -> [Keyword] -> String
instance GHC.Classes.Ord Text.LambdaOptions.Formatter.FormatConfig
instance GHC.Classes.Eq Text.LambdaOptions.Formatter.FormatConfig
instance GHC.Read.Read Text.LambdaOptions.Formatter.FormatConfig
instance GHC.Show.Show Text.LambdaOptions.Formatter.FormatConfig


-- | Class used for parsing command-line options.
module Text.LambdaOptions.Parseable

-- | Class describing parseable values. Much like the <a>Read</a> class.
class Parseable a

-- | Given a sequence of strings, <a>parse</a> returns <a>Nothing</a> and
--   the number of strings consumed if the parse failed. Otherwise,
--   <a>parse</a> returns <a>Just</a> the parsed value and the number of
--   strings consumed.
--   
--   Element-wise, an entire string must be parsed in the sequence to be
--   considered a successful parse.
parse :: Parseable a => [String] -> (Maybe a, Int)

-- | Turns a parser of a single string into a parser suitable for a
--   <a>Parseable</a> instance.
--   
--   Useful for implementing a <a>Parseable</a> for a type with a
--   <a>Read</a> instance by supplying <a>readMaybe</a> to this function.
--   
--   <b>Note:</b> The string is <i>not</i> tokenized in any way before
--   being passed into the input parser.
simpleParse :: (String -> Maybe a) -> [String] -> (Maybe a, Int)

-- | Repeatedly applies <a>parse</a> the given number of times,
--   accumulating the results.
--   
--   Useful for implementing new parsers.
--   
--   Example:
--   
--   <pre>
--   data Point = Point Float Float Float
--   
--   instance Parseable Point where
--       parse strs = case repeatedParse 3 strs of
--           (Just [x,y,z], n) -&gt; (Just (Point x y z), n)`
--           (Nothing, n) -&gt; (Nothing, n)
--   </pre>
repeatedParse :: Parseable a => Int -> [String] -> (Maybe [a], Int)
instance Text.LambdaOptions.Parseable.Parseable GHC.Types.Word
instance Text.LambdaOptions.Parseable.Parseable GHC.Types.Int
instance Text.LambdaOptions.Parseable.Parseable GHC.Integer.Type.Integer
instance Text.LambdaOptions.Parseable.Parseable GHC.Types.Char
instance Text.LambdaOptions.Parseable.Parseable GHC.Base.String
instance Text.LambdaOptions.Parseable.Parseable GHC.Types.Float
instance Text.LambdaOptions.Parseable.Parseable a => Text.LambdaOptions.Parseable.Parseable (GHC.Maybe.Maybe a)
instance Text.LambdaOptions.Parseable.Parseable ()
instance (Text.LambdaOptions.Parseable.Parseable a, Text.LambdaOptions.Parseable.Parseable b) => Text.LambdaOptions.Parseable.Parseable (a, b)
instance (Text.LambdaOptions.Parseable.Parseable a, Text.LambdaOptions.Parseable.Parseable b, Text.LambdaOptions.Parseable.Parseable c) => Text.LambdaOptions.Parseable.Parseable (a, b, c)


-- | List newtype wrapper that can be pattern matched against for parsing.
module Text.LambdaOptions.List

-- | A simple wrapper over <tt>[a]</tt>. Used to avoid overlapping
--   instances for <tt>Parseable [a]</tt> and <tt>Parseable String</tt>
newtype List a
List :: [a] -> List a
[unList] :: List a -> [a]
instance GHC.Classes.Ord a => GHC.Classes.Ord (Text.LambdaOptions.List.List a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Text.LambdaOptions.List.List a)
instance GHC.Read.Read a => GHC.Read.Read (Text.LambdaOptions.List.List a)
instance GHC.Show.Show a => GHC.Show.Show (Text.LambdaOptions.List.List a)
instance Data.Data.Data a => Data.Data.Data (Text.LambdaOptions.List.List a)
instance Text.LambdaOptions.Parseable.Parseable a => Text.LambdaOptions.Parseable.Parseable (Text.LambdaOptions.List.List a)


-- | Contains the core functionality for LambdaOptions.
module Text.LambdaOptions.Core

-- | Tries to parse the supplied options against input arguments. If
--   successful, parsed option callback results are returned in
--   <a>Right</a>. Otherwise an <a>OptionsError</a> is returned in
--   <a>Left</a>.
--   
--   Example program:
--   
--   <pre>
--   import System.Environment
--   import Text.LambdaOptions
--   
--   
--   options :: Options (IO ()) ()
--   options = do
--       addOption (kw ["--help", "-h"] `text` "Display this help text.") $ do
--           putStrLn "Usage:"
--           putStrLn $ getHelpDescription options
--       addOption (kw "--user" `argText` "NAME" `text` "Prints name.") $ \name -&gt; do
--           putStrLn $ "Name:" ++ name
--       addOption (kw "--user" `argText` "NAME AGE" `text` "Prints name and age.") $ \name age -&gt; do
--           putStrLn $ "Name:" ++ name ++ " Age:" ++ show (age :: Int)
--   
--   
--   main :: IO ()
--   main = do
--       args &lt;- getArgs
--       case runOptions options args of
--           Left e -&gt; do
--               putStrLn $ parseFailedMessage e
--               putStrLn $ getHelpDescription options
--           Right actions -&gt; sequence_ actions
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; example.exe --user HaskellCurry 81 --user GraceHopper
--   Name:HaskellCurry Age:81
--   Name:GraceHopper
--   
--   &gt;&gt;&gt; example.exe -h
--   Usage:
--   -h, --help                  Display this help text.
--       --user NAME             Prints name.
--       --user NAME AGE         Prints name and age.
--   
--   &gt;&gt;&gt; example.exe --user Pythagoras LXXV
--   Unknown option at index 2: `LXXV'
--   Usage:
--   -h, --help                  Display this help text.
--       --user NAME             Prints name.
--       --user NAME AGE         Prints name and age.
--   </pre>
runOptions :: Options r () -> [String] -> Either OptionsError [r]

-- | A monad for parsing options.
data Options r a

-- | Contains information about what went wrong during an unsuccessful
--   options parse.
data OptionsError
ParseFailed :: String -> Int -> Int -> OptionsError
[parseFailedMessage] :: OptionsError -> String
[parseFailedBeginArgsIndex] :: OptionsError -> Int
[parseFailedEndArgsIndex] :: OptionsError -> Int

-- | Describes the callback <tt>f</tt> to be called for a successfully
--   parsed option.
--   
--   The function (or value) <tt>f</tt> can have any arity and ultimately
--   returns a value with type <tt>r</tt>
--   
--   Each of the callback's arguments must have a type <tt>t</tt> which
--   implements <a>Parseable</a> and <a>Typeable</a>.
--   
--   Think of this as the following constraint synonym:
--   
--   <pre>
--   type OptionCallback r f = (f ~ (Parseable t*, Typeable t*) =&gt; t0 -&gt; t1 -&gt; ... -&gt; tN -&gt; r)
--   </pre>
--   
--   Example callbacks:
--   
--   <pre>
--   f0 = putStrLn "Option parsed!" :: IO ()
--   f1 = put :: String -&gt; State String ()
--   f2 = liftIO . print :: (MonadIO m) =&gt; Int -&gt; m ()
--   f3 name year ratio = lift (print (name, year, ratio)) :: (MonadTrans m) =&gt; String -&gt; Int -&gt; Float -&gt; m IO ()
--   f4 = 7 :: Int
--   f5 = (:) :: Double -&gt; [Double] -&gt; [Double]
--   </pre>
type OptionCallback r f = (GetOpaqueParsers r f, Wrap r f)

-- | Adds the supplied option to the <tt>Options m a ()</tt> context.
--   
--   If the keyword is matched and the types of the callback's parameters
--   can successfully be parsed, the callback is called with the parsed
--   arguments.
addOption :: forall r f. OptionCallback r f => Keyword -> f -> Options r ()

-- | Produces the help description given by the input options.
getHelpDescription :: Options r () -> String

-- | Produces the <a>Keyword</a>s inserted into the input options.
getKeywords :: Options r () -> [Keyword]
instance GHC.Show.Show Text.LambdaOptions.Core.OptionsError
instance GHC.Base.Functor (Text.LambdaOptions.Core.Options r)
instance GHC.Base.Applicative (Text.LambdaOptions.Core.Options r)
instance GHC.Base.Monad (Text.LambdaOptions.Core.Options r)
instance Control.Monad.State.Class.MonadState (Text.LambdaOptions.Core.OptionsState r) (Text.LambdaOptions.Core.Options r)


-- | Declarative command-line parser using type-driven pattern matching.
module Text.LambdaOptions