X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhalcyon.git;a=blobdiff_plain;f=src%2FCommandLine.hs;h=01b5a806219e8f131fc69b9a7646f64890e3b02e;hp=19b8d1b39a8dd3971624b6923091f6d92f96d97f;hb=1b72ed45ef890ed1329a32457b4d7f3a7fb37788;hpb=94484087fbfe98d6735aa82798a9bf506f97fd19 diff --git a/src/CommandLine.hs b/src/CommandLine.hs index 19b8d1b..01b5a80 100644 --- a/src/CommandLine.hs +++ b/src/CommandLine.hs @@ -1,151 +1,182 @@ --- The CommandLine module handles parsing of the command-line options. --- It should more or less be a black box, providing Main with only the --- information it requires. - -module CommandLine -( help_set, - help_text, - from_email_address, - to_email_address, - parse_errors, - parse_usernames -) where - -import Data.Maybe (isJust, isNothing) -import System.Console.GetOpt -import System.Environment (getArgs) - - - --- A record containing values for all available options. -data Options = Options { opt_help :: Bool, - opt_from :: Maybe String, - opt_to :: Maybe String } - - --- This constructs an instance of Options, with each of its members --- set to default values. -default_options :: Options -default_options = Options { opt_help = False, - opt_from = Nothing, - opt_to = Nothing } - - --- The options list that we construct associates a function with each --- option. This function is responsible for updating an Options record --- with the appropriate value. --- --- For more information and an example of this idiom, see, +module CommandLine ( + get_args, + show_help ) +where + +import System.Console.CmdArgs ( + (&=), + args, + cmdArgs, + def, + details, + groupname, + help, + helpArg, + program, + summary, + typ, + versionArg ) +import System.Environment ( withArgs ) + +-- Get the version from Cabal. +import Paths_halcyon ( version ) +import Data.Version ( showVersion ) + +import OptionalConfiguration ( OptionalCfg(..) ) + + +-- | The description of the program, displayed as part of the help. -- --- http://www.haskell.org/haskellwiki/High-level_option_handling_with_GetOpt --- -options :: [OptDescr (Options -> IO Options)] -options = - [ Option ['h'][] (NoArg set_help) "Prints this help message.", - Option ['t'][] (ReqArg set_to "email_address") "Send tweets TO email_address.", - Option ['f'][] (ReqArg set_from "email_address") "Send tweets FROM email_address." - ] - - -set_help :: Options -> IO Options -set_help opts = do - return opts { opt_help = True } +description :: String +description = + "Monitor a list of Twitter accounts and display or email any new tweets." -set_to :: String -> Options -> IO Options -set_to arg opts = do - return opts { opt_to = Just arg } -set_from :: String -> Options -> IO Options -set_from arg opts = do - return opts { opt_from = Just arg } +-- | The name of this program. +-- +program_name :: String +program_name = "halcyon" --- The usage header. -usage :: String -usage = "Usage: twat [-t to_address] [-f from_address] [username2, [username3]...]" +-- | A summary string output as part of the help. +-- +my_summary :: String +my_summary = program_name ++ "-" ++ (showVersion version) --- The usage header, and all available flags (as generated by GetOpt) -help_text :: String -help_text = usageInfo usage options +-- | Help string for the \"consumer_key\" option. +-- +consumer_key_help :: String +consumer_key_help = "Your Twitter API consumer key" --- Return a list of options. -parse_options :: IO Options -parse_options = do - argv <- getArgs - let (actions, _, _) = getOpt Permute options argv +-- | Help string for the \"consumer_secret\" option. +-- +consumer_secret_help :: String +consumer_secret_help = "Your Twitter API consumer secret" - -- This will execute each of the functions contained in our options - -- list, one after another, on a default_options record. The end - -- result should be an Options instance with all of its members set - -- correctly. - opts <- foldl (>>=) (return default_options) actions - return opts +-- | Help string for the \"access_token\" option +-- +access_token_help :: String +access_token_help = "Your Twitter API access token" -username_errors :: IO [String] -username_errors = do - argv <- getArgs - let (_, usernames, _) = getOpt Permute options argv +-- | Help string for the \"access_secret\" option. +-- +access_secret_help :: String +access_secret_help = "Your Twitter API access secret" - if (null usernames) - then return ["No usernames provided."] - else return [] +-- | Help string for the \"heartbeat\" option. +-- +heartbeat_help :: String +heartbeat_help = "How many seconds to wait between polling" -to_errors :: IO [String] -to_errors = do - toaddr <- to_email_address - fromaddr <- from_email_address - if (isNothing toaddr) && (isJust fromaddr) - then return ["\"From\" address specified without \"To\" address."] - else return [] -from_errors :: IO [String] -from_errors = do - toaddr <- to_email_address - fromaddr <- from_email_address - if (isJust toaddr) && (isNothing fromaddr) - then return ["\"To\" address specified without \"From\" address."] - else return [] +-- | Help string for the \"to_address\" option. +-- +to_address_help :: String +to_address_help = "Send tweets to ADDRESS" -format_error :: String -> String -format_error err = "ERROR: " ++ err ++ "\n" +-- | Help string for the \"from_address\" option. +-- +from_address_help :: String +from_address_help = "Send tweets from ADDRESS" --- Return a list of errors. -parse_errors :: IO [String] -parse_errors = do - argv <- getArgs - let (_, _, errors) = getOpt Permute options argv - errs_username <- username_errors - errs_to <- to_errors - errs_from <- from_errors - return $ map format_error (errors ++ errs_username ++ errs_to ++ errs_from) +-- | Help string for the \"sendmail_path\" option. +-- +sendmail_path_help :: String +sendmail_path_help = "Use PATH to send mail" --- Is the help option set? -help_set :: IO Bool -help_set = do - opts <- parse_options - return (opt_help opts) +-- | Help string for the \"ignore_replies\" option. +-- +ignore_replies_help :: String +ignore_replies_help = "Ignore replies to other tweets" -to_email_address :: IO (Maybe String) -to_email_address = do - opts <- parse_options - return (opt_to opts) -from_email_address :: IO (Maybe String) -from_email_address = do - opts <- parse_options - return (opt_from opts) +-- | Help string for the \"ignore_retweets\" option. +-- +ignore_retweets_help :: String +ignore_retweets_help = "Ignore retweets from other users" -parse_usernames :: IO [String] -parse_usernames = do - argv <- getArgs - let (_, usernames, _) = getOpt Permute options argv - return usernames +-- | Help string for the \"verbose\" option. +-- +verbose_help :: String +verbose_help = "Be verbose about stuff" + + +arg_spec :: OptionalCfg +arg_spec = + OptionalCfg { + consumer_key = + def &= typ "KEY" + &= groupname "Twitter API" + &= help consumer_key_help, + + consumer_secret = + def &= typ "SECRET" + &= groupname "Twitter API" + &= help consumer_secret_help, + + access_token = + def &= typ "TOKEN" + &= groupname "Twitter API" + &= help access_token_help, + + access_secret = + def &= typ "SECRET" + &= groupname "Twitter API" + &= help access_secret_help, + + heartbeat = + def &= groupname "Miscellaneous" + &= help heartbeat_help, + + ignore_replies = + def &= groupname "Miscellaneous" + &= help ignore_replies_help, + + ignore_retweets = + def &= groupname "Miscellaneous" + &= help ignore_retweets_help, + + verbose = + def &= groupname "Miscellaneous" + &= help verbose_help, + + sendmail_path = + def &= typ "PATH" + &= groupname "Mail Options" + &= help sendmail_path_help, + + from_address = + def &= typ "ADDRESS" + &= groupname "Mail Options" + &= help from_address_help, + + to_address = + def &= typ "ADDRESS" + &= groupname "Mail Options" + &= help to_address_help, + + usernames = + def &= args + &= typ "USERNAMES" } + + &= program program_name + &= summary my_summary + &= details [description] + &= helpArg [groupname "Common flags"] + &= versionArg [groupname "Common flags"] + +show_help :: IO OptionalCfg +show_help = withArgs ["--help"] get_args + + +get_args :: IO OptionalCfg +get_args = cmdArgs arg_spec