System/Console/GetOpt.hs

   1 -----------------------------------------------------------------------------
   2 --
   3 -- Module      :  System.Console.GetOpt
   4 -- Copyright   :  (c) Sven Panne Oct. 1996 (small changes Dec. 1997)
   5 -- License     :  BSD-style (see the file libraries/core/LICENSE)
   6 --
   7 -- Maintainer  :  libraries@haskell.org
   8 -- Stability   :  experimental
   9 -- Portability :  portable
  10 --
  11 -- $Id: GetOpt.hs,v 1.1 2001/07/04 10:48:39 simonmar Exp $
  12 --
  13 -- A Haskell port of GNU's getopt library
  14 --
  15 -----------------------------------------------------------------------------
  16
  17 {-
  18 Sven Panne <Sven.Panne@informatik.uni-muenchen.de> Oct. 1996 (small
  19 changes Dec. 1997)
  20
  21 Two rather obscure features are missing: The Bash 2.0 non-option hack
  22 (if you don't already know it, you probably don't want to hear about
  23 it...) and the recognition of long options with a single dash
  24 (e.g. '-help' is recognised as '--help', as long as there is no short
  25 option 'h').
  26
  27 Other differences between GNU's getopt and this implementation: * To
  28 enforce a coherent description of options and arguments, there are
  29 explanation fields in the option/argument descriptor.  * Error
  30 messages are now more informative, but no longer POSIX
  31 compliant... :-( And a final Haskell advertisement: The GNU C
  32 implementation uses well over 1100 lines, we need only 195 here,
  33 including a 46 line example! :-)
  34 -}
  35
  36 module System.Console.GetOpt (
  37         ArgOrder(..),
  38         OptDescr(..),
  39         ArgDescr(..),
  40         usageInfo,      -- :: String -> [OptDescr a] -> String
  41         getOpt          -- :: ArgOrder a -> [OptDescr a] -> [String]
  42                         --        -> ([a],[String],[String])
  43   ) where
  44
  45 import Data.List        ( isPrefixOf )
  46
  47 data ArgOrder a                -- what to do with options following non-options:
  48    = RequireOrder                --  no option processing after first non-option
  49    | Permute                     --  freely intersperse options and non-options
  50    | ReturnInOrder (String -> a) --  wrap non-options into options
  51
  52 data OptDescr a =              -- description of a single options:
  53    Option [Char]                --    list of short option characters
  54           [String]              --    list of long option strings (without "--")
  55           (ArgDescr a)          --    argument descriptor
  56           String                --    explanation of option for user
  57
  58 data ArgDescr a                        -- description of an argument option:
  59    = NoArg                   a         --    no argument expected
  60    | ReqArg (String       -> a) String --    option requires argument
  61    | OptArg (Maybe String -> a) String --    optional argument
  62
  63 data OptKind a                -- kind of cmd line arg (internal use only):
  64    = Opt       a                --    an option
  65    | NonOpt    String           --    a non-option
  66    | EndOfOpts                  --    end-of-options marker (i.e. "--")
  67    | OptErr    String           --    something went wrong...
  68
  69 usageInfo :: String                    -- header
  70           -> [OptDescr a]              -- option descriptors
  71           -> String                    -- nicely formatted decription of options
  72 usageInfo header optDescr = unlines (header:table)
  73    where (ss,ls,ds)     = (unzip3 . map fmtOpt) optDescr
  74          table          = zipWith3 paste (sameLen ss) (sameLen ls) ds
  75          paste x y z    = "  " ++ x ++ "  " ++ y ++ "  " ++ z
  76          sameLen xs     = flushLeft ((maximum . map length) xs) xs
  77          flushLeft n xs = [ take n (x ++ repeat ' ') | x <- xs ]
  78
  79 fmtOpt :: OptDescr a -> (String,String,String)
  80 fmtOpt (Option sos los ad descr) = (sepBy ',' (map (fmtShort ad) sos),
  81                                     sepBy ',' (map (fmtLong  ad) los),
  82                                     descr)
  83    where sepBy _  []     = ""
  84          sepBy _  [x]    = x
  85          sepBy ch (x:xs) = x ++ ch:' ':sepBy ch xs
  86
  87 fmtShort :: ArgDescr a -> Char -> String
  88 fmtShort (NoArg  _   ) so = "-" ++ [so]
  89 fmtShort (ReqArg _ ad) so = "-" ++ [so] ++ " " ++ ad
  90 fmtShort (OptArg _ ad) so = "-" ++ [so] ++ "[" ++ ad ++ "]"
  91
  92 fmtLong :: ArgDescr a -> String -> String
  93 fmtLong (NoArg  _   ) lo = "--" ++ lo
  94 fmtLong (ReqArg _ ad) lo = "--" ++ lo ++ "=" ++ ad
  95 fmtLong (OptArg _ ad) lo = "--" ++ lo ++ "[=" ++ ad ++ "]"
  96
  97 getOpt :: ArgOrder a                   -- non-option handling
  98        -> [OptDescr a]                 -- option descriptors
  99        -> [String]                     -- the commandline arguments
 100        -> ([a],[String],[String])      -- (options,non-options,error messages)
 101 getOpt _        _        []         =  ([],[],[])
 102 getOpt ordering optDescr (arg:args) = procNextOpt opt ordering
 103    where procNextOpt (Opt o)    _                 = (o:os,xs,es)
 104          procNextOpt (NonOpt x) RequireOrder      = ([],x:rest,[])
 105          procNextOpt (NonOpt x) Permute           = (os,x:xs,es)
 106          procNextOpt (NonOpt x) (ReturnInOrder f) = (f x :os, xs,es)
 107          procNextOpt EndOfOpts  RequireOrder      = ([],rest,[])
 108          procNextOpt EndOfOpts  Permute           = ([],rest,[])
 109          procNextOpt EndOfOpts  (ReturnInOrder f) = (map f rest,[],[])
 110          procNextOpt (OptErr e) _                 = (os,xs,e:es)
 111
 112          (opt,rest) = getNext arg args optDescr
 113          (os,xs,es) = getOpt ordering optDescr rest
 114
 115 -- take a look at the next cmd line arg and decide what to do with it
 116 getNext :: String -> [String] -> [OptDescr a] -> (OptKind a,[String])
 117 getNext ('-':'-':[]) rest _        = (EndOfOpts,rest)
 118 getNext ('-':'-':xs) rest optDescr = longOpt xs rest optDescr
 119 getNext ('-': x :xs) rest optDescr = shortOpt x xs rest optDescr
 120 getNext a            rest _        = (NonOpt a,rest)
 121
 122 -- handle long option
 123 longOpt :: String -> [String] -> [OptDescr a] -> (OptKind a,[String])
 124 longOpt ls rs optDescr = long ads arg rs
 125    where (opt,arg) = break (=='=') ls
 126          options   = [ o  | o@(Option _ ls _ _) <- optDescr, l <- ls, opt `isPrefixOf` l ]
 127          ads       = [ ad | Option _ _ ad _ <- options ]
 128          optStr    = ("--"++opt)
 129
 130          long (_:_:_)      _        rest     = (errAmbig options optStr,rest)
 131          long [NoArg  a  ] []       rest     = (Opt a,rest)
 132          long [NoArg  _  ] ('=':_)  rest     = (errNoArg optStr,rest)
 133          long [ReqArg _ d] []       []       = (errReq d optStr,[])
 134          long [ReqArg f _] []       (r:rest) = (Opt (f r),rest)
 135          long [ReqArg f _] ('=':xs) rest     = (Opt (f xs),rest)
 136          long [OptArg f _] []       rest     = (Opt (f Nothing),rest)
 137          long [OptArg f _] ('=':xs) rest     = (Opt (f (Just xs)),rest)
 138          long _            _        rest     = (errUnrec optStr,rest)
 139
 140 -- handle short option
 141 shortOpt :: Char -> String -> [String] -> [OptDescr a] -> (OptKind a,[String])
 142 shortOpt x xs rest optDescr = short ads xs rest
 143   where options = [ o  | o@(Option ss _ _ _) <- optDescr, s <- ss, x == s ]
 144         ads     = [ ad | Option _ _ ad _ <- options ]
 145         optStr  = '-':[x]
 146
 147         short (_:_:_)        _  rest     = (errAmbig options optStr,rest)
 148         short (NoArg  a  :_) [] rest     = (Opt a,rest)
 149         short (NoArg  a  :_) xs rest     = (Opt a,('-':xs):rest)
 150         short (ReqArg _ d:_) [] []       = (errReq d optStr,[])
 151         short (ReqArg f _:_) [] (r:rest) = (Opt (f r),rest)
 152         short (ReqArg f _:_) xs rest     = (Opt (f xs),rest)
 153         short (OptArg f _:_) [] rest     = (Opt (f Nothing),rest)
 154         short (OptArg f _:_) xs rest     = (Opt (f (Just xs)),rest)
 155         short []             [] rest     = (errUnrec optStr,rest)
 156         short []             xs rest     = (errUnrec optStr,('-':xs):rest)
 157
 158 -- miscellaneous error formatting
 159
 160 errAmbig :: [OptDescr a] -> String -> OptKind a
 161 errAmbig ods optStr = OptErr (usageInfo header ods)
 162    where header = "option `" ++ optStr ++ "' is ambiguous; could be one of:"
 163
 164 errReq :: String -> String -> OptKind a
 165 errReq d optStr = OptErr ("option `" ++ optStr ++ "' requires an argument " ++ d ++ "\n")
 166
 167 errUnrec :: String -> OptKind a
 168 errUnrec optStr = OptErr ("unrecognized option `" ++ optStr ++ "'\n")
 169
 170 errNoArg :: String -> OptKind a
 171 errNoArg optStr = OptErr ("option `" ++ optStr ++ "' doesn't allow an argument\n")
 172
 173 {-
 174 -----------------------------------------------------------------------------------------
 175 -- and here a small and hopefully enlightening example:
 176
 177 data Flag = Verbose | Version | Name String | Output String | Arg String   deriving Show
 178
 179 options :: [OptDescr Flag]
 180 options =
 181    [Option ['v']     ["verbose"]           (NoArg Verbose)      "verbosely list files",
 182     Option ['V','?'] ["version","release"] (NoArg Version)      "show version info",
 183     Option ['o']     ["output"]            (OptArg out "FILE")  "use FILE for dump",
 184     Option ['n']     ["name"]              (ReqArg Name "USER") "only dump USER's files"]
 185
 186 out :: Maybe String -> Flag
 187 out Nothing  = Output "stdout"
 188 out (Just o) = Output o
 189
 190 test :: ArgOrder Flag -> [String] -> String
 191 test order cmdline = case getOpt order options cmdline of
 192                         (o,n,[]  ) -> "options=" ++ show o ++ "  args=" ++ show n ++ "\n"
 193                         (_,_,errs) -> concat errs ++ usageInfo header options
 194    where header = "Usage: foobar [OPTION...] files..."
 195
 196 -- example runs:
 197 -- putStr (test RequireOrder ["foo","-v"])
 198 --    ==> options=[]  args=["foo", "-v"]
 199 -- putStr (test Permute ["foo","-v"])
 200 --    ==> options=[Verbose]  args=["foo"]
 201 -- putStr (test (ReturnInOrder Arg) ["foo","-v"])
 202 --    ==> options=[Arg "foo", Verbose]  args=[]
 203 -- putStr (test Permute ["foo","--","-v"])
 204 --    ==> options=[]  args=["foo", "-v"]
 205 -- putStr (test Permute ["-?o","--name","bar","--na=baz"])
 206 --    ==> options=[Version, Output "stdout", Name "bar", Name "baz"]  args=[]
 207 -- putStr (test Permute ["--ver","foo"])
 208 --    ==> option `--ver' is ambiguous; could be one of:
 209 --          -v      --verbose             verbosely list files
 210 --          -V, -?  --version, --release  show version info
 211 --        Usage: foobar [OPTION...] files...
 212 --          -v        --verbose             verbosely list files
 213 --          -V, -?    --version, --release  show version info
 214 --          -o[FILE]  --output[=FILE]       use FILE for dump
 215 --          -n USER   --name=USER           only dump USER's files
 216 -----------------------------------------------------------------------------------------
 217 -}