optparse-simple-0.0.3/0000755000000000000000000000000012532604621013025 5ustar0000000000000000optparse-simple-0.0.3/Setup.hs0000644000000000000000000000005612532604621014462 0ustar0000000000000000import Distribution.Simple main = defaultMain optparse-simple-0.0.3/optparse-simple.cabal0000644000000000000000000000137512532604621017143 0ustar0000000000000000name: optparse-simple version: 0.0.3 synopsis: Simple interface to optparse-applicative description: Simple interface to optparse-applicative license: BSD3 license-file: LICENSE author: FP Complete maintainer: chrisdone@fpcomplete.com copyright: 2015 FP Complete category: Options build-type: Simple cabal-version: >=1.8 library hs-source-dirs: src/ ghc-options: -Wall -O2 exposed-modules: Options.Applicative.Simple build-depends: base >= 4 && <5 , template-haskell , transformers , optparse-applicative , gitrev , either optparse-simple-0.0.3/LICENSE0000644000000000000000000000273312532604621014037 0ustar0000000000000000Copyright (c) 2015, optparse-simple All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of optparse-simple nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. optparse-simple-0.0.3/src/0000755000000000000000000000000012532604621013614 5ustar0000000000000000optparse-simple-0.0.3/src/Options/0000755000000000000000000000000012532604621015247 5ustar0000000000000000optparse-simple-0.0.3/src/Options/Applicative/0000755000000000000000000000000012532604621017510 5ustar0000000000000000optparse-simple-0.0.3/src/Options/Applicative/Simple.hs0000644000000000000000000001270212532604621021277 0ustar0000000000000000{-# LANGUAGE TemplateHaskell #-} -- | Simple interface to program arguments. -- -- Typical usage with no commands: -- -- @ -- do (opts,()) <- -- simpleOptions "ver" -- "header" -- "desc" -- (flag () () (long "some-flag")) -- empty -- doThings opts -- @ -- -- Typical usage with commands: -- -- @ -- do (opts,runCmd) <- -- simpleOptions "ver" -- "header" -- "desc" -- (pure ()) $ -- do addCommand "delete" -- "Delete the thing" -- (const deleteTheThing) -- (pure ()) -- addCommand "create" -- "Create a thing" -- createAThing -- (strOption (long "hello")) -- runCmd -- @ module Options.Applicative.Simple ( module Options.Applicative.Simple , module Options.Applicative ) where import Control.Monad.Trans.Class (lift) import Control.Monad.Trans.Either import Control.Monad.Trans.Writer import Data.Monoid import Data.Version import Development.GitRev (gitDirty, gitHash) import Language.Haskell.TH (Q,Exp) import qualified Language.Haskell.TH.Syntax as TH import Options.Applicative import System.Environment -- | Generate and execute a simple options parser. simpleOptions :: String -- ^ version string -> String -- ^ header -> String -- ^ program description -> Parser a -- ^ global settings -> EitherT b (Writer (Mod CommandFields b)) () -- ^ commands (use 'addCommand') -> IO (a,b) simpleOptions versionString h pd globalParser commandParser = do args <- getArgs case execParserPure (prefs idm) parser args of Failure _ | null args -> withArgs ["--help"] (execParser parser) parseResult -> handleParseResult parseResult where parser = info (versionOption <*> simpleParser globalParser commandParser) desc desc = fullDesc <> header h <> progDesc pd versionOption = infoOption versionString (long "version" <> help "Show version") -- | Generate a string like @Version 1.2, Git revision 1234@. -- -- @$(simpleVersion …)@ @::@ 'String' simpleVersion :: Version -> Q Exp simpleVersion version = [|concat (["Version " ,$(TH.lift $ showVersion version) ] ++ if $gitHash == ("UNKNOWN" :: String) then [] else [", Git revision " ,$gitHash ,if $gitDirty then " (dirty)" else "" ])|] -- | Add a command to the options dispatcher. addCommand :: String -- ^ command string -> String -- ^ title of command -> (a -> b) -- ^ constructor to wrap up command in common data type -> Parser a -- ^ command parser -> EitherT b (Writer (Mod CommandFields b)) () addCommand cmd title constr inner = lift (tell (command cmd (info (constr <$> inner) (progDesc title)))) -- | Add a command that takes sub-commands to the options dispatcher. -- -- Example: -- -- @ -- addSubCommands "thing" -- "Subcommands that operate on things" -- (do addCommand "delete" -- "Delete the thing" -- (const deleteTheThing) -- (pure ()) -- addCommand "create" -- "Create a thing" -- createAThing -- (strOption (long "hello"))) -- @ -- -- If there are common options between all the sub-commands, use 'addCommand' -- in combination with 'simpleParser' instead of 'addSubCommands'. addSubCommands :: String -- ^ command string -> String -- ^ title of command -> EitherT b (Writer (Mod CommandFields b)) () -- ^ sub-commands (use 'addCommand') -> EitherT b (Writer (Mod CommandFields b)) () addSubCommands cmd title commandParser = addCommand cmd title (\((), a) -> a) (simpleParser (pure ()) commandParser) -- | Generate a simple options parser. -- -- Most of the time you should use 'simpleOptions' instead, but 'simpleParser' -- can be used for sub-commands that need common options. For example: -- -- @ -- addCommand "thing" -- "Subcommands that operate on things" -- (\\(opts,runSubCmd) -> runSubCmd opts) -- (simpleParser (flag () () (long "some-flag")) $ -- do addCommand "delete" -- "Delete the thing" -- (const deleteTheThing) -- (pure ()) -- addCommand "create" -- "Create a thing" -- createAThing -- (strOption (long "hello"))) -- @ -- simpleParser :: Parser a -- ^ common settings -> EitherT b (Writer (Mod CommandFields b)) () -- ^ commands (use 'addCommand') -> Parser (a,b) simpleParser commonParser commandParser = helpOption <*> config where helpOption = abortOption ShowHelpText $ long "help" <> help "Show this help text" config = (,) <$> commonParser <*> case runWriter (runEitherT commandParser) of (Right (),d) -> subparser d (Left b,_) -> pure b