X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhalcyon.git;a=blobdiff_plain;f=src%2FCommandLine.hs;h=3fc8eb39098fba581ac5a5c11ae5f13ca4098682;hp=919a3a2136f11a76a9da1441e36b7497084ad407;hb=86efdb6afac4a7a165babba90a0a25e0e1185e5b;hpb=bfe49b970e83f1d422d57ece7cebdfe7a56b817c diff --git a/src/CommandLine.hs b/src/CommandLine.hs index 919a3a2..3fc8eb3 100644 --- a/src/CommandLine.hs +++ b/src/CommandLine.hs @@ -1,51 +1,49 @@ --- |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. +-- | 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 -( heartbeat, +( get_cfg, help_set, help_text, - ignore_replies_set, - ignore_retweets_set, - from_email_address, - to_email_address, parse_errors, parse_usernames ) where -import Data.Maybe (isJust, isNothing) +import Data.Maybe (fromJust, isJust, isNothing) import System.Console.GetOpt import System.Environment (getArgs) +import Configuration (Cfg(..)) - --- |A record containing values for all available options. +-- | A record containing values for all available options. data Options = Options { opt_heartbeat :: Maybe Int, opt_help :: Bool, opt_ignore_replies :: Bool, opt_ignore_retweets :: Bool, opt_from :: Maybe String, - opt_to :: Maybe String } + opt_to :: Maybe String, + opt_verbose :: Bool } --- |Constructs an instance of Options, with each of its members set to --- default values. +-- | Constructs an instance of Options, with each of its members set +-- to default values. default_options :: Options default_options = Options { opt_heartbeat = Just 600, opt_help = False, opt_ignore_replies = False, opt_ignore_retweets = False, opt_from = Nothing, - opt_to = Nothing } + opt_to = Nothing, + opt_verbose = False } --- |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. +-- | 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, +-- For more information and an example of this idiom, see, -- --- +-- -- options :: [OptDescr (Options -> IO Options)] options = @@ -77,7 +75,12 @@ options = Option ['I']["ignore-retweets"] (NoArg set_ignore_retweets) - "Ignore retweets." + "Ignore retweets.", + + Option + ['v']["verbose"] + (NoArg set_verbose) + "Be verbose about stuff." ] @@ -106,6 +109,10 @@ set_ignore_replies :: Options -> IO Options set_ignore_replies opts = return opts { opt_ignore_replies = True } +set_verbose :: Options -> IO Options +set_verbose opts = + return opts { opt_verbose = True } + set_to :: String -> Options -> IO Options set_to arg opts = do return opts { opt_to = Just arg } @@ -115,17 +122,23 @@ set_from arg opts = do return opts { opt_from = Just arg } --- The usage header. +-- | The usage header. usage :: String usage = "Usage: twat [-n heartbeat] [-t to_address] [-f from_address] [username2, [username3]...]" --- The usage header, and all available flags (as generated by GetOpt) +-- | Was the help option passed? +help_set :: IO Bool +help_set = do + opts <- parse_options + return (opt_help opts) + +-- | The usage header, and all available flags (as generated by GetOpt) help_text :: String help_text = usageInfo usage options --- Return a list of options. +-- | Return a list of options. parse_options :: IO Options parse_options = do argv <- getArgs @@ -143,7 +156,7 @@ parse_options = do -- | A list of parse errors relating to the heartbeat. heartbeat_errors :: IO [String] heartbeat_errors = do - hb <- heartbeat + hb <- parse_heartbeat if (isNothing hb) then return ["\"heartbeat\" does not appear to be an integer."] else return [] @@ -162,29 +175,29 @@ username_errors = do -- |Parse errors relating to the "To" address. to_errors :: IO [String] to_errors = do - toaddr <- to_email_address - fromaddr <- from_email_address + toaddr <- parse_to_address + fromaddr <- parse_from_address if (isNothing toaddr) && (isJust fromaddr) then return ["\"from\" address specified without \"to\" address."] else return [] --- |Parse errors relating to the "From" address. +-- | Parse errors relating to the "From" address. from_errors :: IO [String] from_errors = do - toaddr <- to_email_address - fromaddr <- from_email_address + toaddr <- parse_to_address + fromaddr <- parse_from_address if (isJust toaddr) && (isNothing fromaddr) then return ["\"to\" address specified without \"from\" address."] else return [] --- |Format an error message for printing. +-- | Format an error message for printing. format_error :: String -> String format_error err = "ERROR: " ++ err ++ "\n" --- |Return a list of all parse errors. +-- | Return a list of all parse errors. parse_errors :: IO [String] parse_errors = do argv <- getArgs @@ -199,46 +212,42 @@ parse_errors = do errs_to ++ errs_from) --- |Was the "help" option passed on the command line? -help_set :: IO Bool -help_set = do - opts <- parse_options - return (opt_help opts) - --- | Was the "ignore-replies" option passes on the command line? -ignore_replies_set :: IO Bool -ignore_replies_set = do +-- | What's the heartbeat? +parse_heartbeat :: IO (Maybe Int) +parse_heartbeat = do opts <- parse_options - return (opt_ignore_replies opts) + return (opt_heartbeat opts) --- | Was the "ignore-retweets" option passes on the command line? -ignore_retweets_set :: IO Bool -ignore_retweets_set = do +-- | What "To" address was given on the command line? +parse_to_address :: IO (Maybe String) +parse_to_address = do opts <- parse_options - return (opt_ignore_retweets opts) + return (opt_to opts) --- |What's the heartbeat? -heartbeat :: IO (Maybe Int) -heartbeat = do +-- | What "From" address was given on the command line? +parse_from_address :: IO (Maybe String) +parse_from_address = do opts <- parse_options - return (opt_heartbeat opts) - --- |What "To" address was given on the command line? -to_email_address :: IO (Maybe String) -to_email_address = do - opts <- parse_options - return (opt_to opts) - --- |What "From" address was given on the command line? -from_email_address :: IO (Maybe String) -from_email_address = do - opts <- parse_options - return (opt_from opts) + return (opt_from opts) --- |What usernames were passed on the command line? +-- | What usernames were passed on the command line? parse_usernames :: IO [String] parse_usernames = do argv <- getArgs let (_, usernames, _) = getOpt Permute options argv return usernames + + + +-- | Construct a Cfg object from the command line options assuming +-- there are no errors. +get_cfg :: IO Cfg +get_cfg = do + opts <- parse_options + return Cfg { heartbeat = fromJust $ opt_heartbeat opts, + ignore_replies = opt_ignore_replies opts, + ignore_retweets = opt_ignore_retweets opts, + from_address = opt_from opts, + to_address = opt_to opts, + verbose = opt_verbose opts }