<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ --> <title>System/Console/CmdArgs/GetOpt.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a> <a name="line-2"></a><span class='hs-comment'>-- | This provides a compatiblity wrapper to the @System.Console.GetOpt@ module in @base@.</span> <a name="line-3"></a><span class='hs-comment'>-- That module is essentially a Haskell port of the GNU @getopt@ library.</span> <a name="line-4"></a><span class='hs-comment'>--</span> <a name="line-5"></a><span class='hs-comment'>-- /Changes:/ The changes from @GetOpt@ are listed in the documentation for each function.</span> <a name="line-6"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Console</span><span class='hs-varop'>.</span><span class='hs-conid'>CmdArgs</span><span class='hs-varop'>.</span><span class='hs-conid'>GetOpt</span><span class='hs-layout'>(</span> <a name="line-7"></a> <span class='hs-varid'>convert</span><span class='hs-layout'>,</span> <span class='hs-varid'>getOpt</span><span class='hs-layout'>,</span> <span class='hs-varid'>getOpt'</span><span class='hs-layout'>,</span> <span class='hs-varid'>usageInfo</span><span class='hs-layout'>,</span> <a name="line-8"></a> <span class='hs-conid'>ArgOrder</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>OptDescr</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>ArgDescr</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <a name="line-9"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-10"></a> <a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Console</span><span class='hs-varop'>.</span><span class='hs-conid'>CmdArgs</span><span class='hs-varop'>.</span><span class='hs-conid'>Explicit</span> <a name="line-12"></a> <a name="line-13"></a> <a name="line-14"></a><a name="ArgOrder"></a><span class='hs-comment'>-- | What to do with options following non-options.</span> <a name="line-15"></a><a name="ArgOrder"></a><span class='hs-comment'>--</span> <a name="line-16"></a><a name="ArgOrder"></a><span class='hs-comment'>-- /Changes:/ Only 'Permute' is allowed, both @RequireOrder@ and @ReturnInOrder@</span> <a name="line-17"></a><a name="ArgOrder"></a><span class='hs-comment'>-- have been removed.</span> <a name="line-18"></a><a name="ArgOrder"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ArgOrder</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Permute</span> <a name="line-19"></a> <a name="line-20"></a> <a name="line-21"></a><a name="OptDescr"></a><span class='hs-comment'>-- | Each 'OptDescr' describes a single option/flag.</span> <a name="line-22"></a><a name="OptDescr"></a><span class='hs-comment'>--</span> <a name="line-23"></a><a name="OptDescr"></a><span class='hs-comment'>-- The arguments to 'Option' are:</span> <a name="line-24"></a><a name="OptDescr"></a><span class='hs-comment'>--</span> <a name="line-25"></a><a name="OptDescr"></a><span class='hs-comment'>-- * list of short option characters</span> <a name="line-26"></a><a name="OptDescr"></a><span class='hs-comment'>--</span> <a name="line-27"></a><a name="OptDescr"></a><span class='hs-comment'>-- * list of long option strings (without @\"--\"@, may not be 1 character long)</span> <a name="line-28"></a><a name="OptDescr"></a><span class='hs-comment'>--</span> <a name="line-29"></a><a name="OptDescr"></a><span class='hs-comment'>-- * argument descriptor</span> <a name="line-30"></a><a name="OptDescr"></a><span class='hs-comment'>--</span> <a name="line-31"></a><a name="OptDescr"></a><span class='hs-comment'>-- * explanation of option for userdata</span> <a name="line-32"></a><a name="OptDescr"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>OptDescr</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Option</span> <a name="line-33"></a> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Char</span><span class='hs-keyglyph'>]</span> <a name="line-34"></a> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <a name="line-35"></a> <span class='hs-layout'>(</span><span class='hs-conid'>ArgDescr</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <a name="line-36"></a> <span class='hs-conid'>String</span> <a name="line-37"></a> <a name="line-38"></a> <a name="line-39"></a><a name="ArgDescr"></a><span class='hs-comment'>-- | Describes whether an option takes an argument or not, and if so</span> <a name="line-40"></a><a name="ArgDescr"></a><span class='hs-comment'>-- how the argument is injected into a value of type @a@.</span> <a name="line-41"></a><a name="ArgDescr"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ArgDescr</span> <span class='hs-varid'>a</span> <a name="line-42"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NoArg</span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ no argument expected</span> <a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ReqArg</span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ option requires argument</span> <a name="line-44"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptArg</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ optional argument</span> <a name="line-45"></a> <a name="line-46"></a> <a name="line-47"></a><a name="usageInfo"></a><span class='hs-comment'>-- | Return a string describing the usage of a command, derived from</span> <a name="line-48"></a><span class='hs-comment'>-- the header (first argument) and the options described by the </span> <a name="line-49"></a><span class='hs-comment'>-- second argument.</span> <a name="line-50"></a><span class='hs-definition'>usageInfo</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptDescr</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <a name="line-51"></a><span class='hs-definition'>usageInfo</span> <span class='hs-varid'>desc</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>show</span> <span class='hs-varop'>$</span> <span class='hs-varid'>convert</span> <span class='hs-varid'>desc</span> <span class='hs-varid'>flags</span> <a name="line-52"></a> <a name="line-53"></a> <a name="line-54"></a><a name="getOpt"></a><span class='hs-comment'>-- | Process the command-line, and return the list of values that matched</span> <a name="line-55"></a><span class='hs-comment'>-- (and those that didn\'t). The arguments are:</span> <a name="line-56"></a><span class='hs-comment'>--</span> <a name="line-57"></a><span class='hs-comment'>-- * The order requirements (see 'ArgOrder')</span> <a name="line-58"></a><span class='hs-comment'>--</span> <a name="line-59"></a><span class='hs-comment'>-- * The option descriptions (see 'OptDescr')</span> <a name="line-60"></a><span class='hs-comment'>--</span> <a name="line-61"></a><span class='hs-comment'>-- * The actual command line arguments (presumably got from </span> <a name="line-62"></a><span class='hs-comment'>-- 'System.Environment.getArgs').</span> <a name="line-63"></a><span class='hs-comment'>--</span> <a name="line-64"></a><span class='hs-comment'>-- 'getOpt' returns a triple consisting of the option arguments, a list</span> <a name="line-65"></a><span class='hs-comment'>-- of non-options, and a list of error messages.</span> <a name="line-66"></a><span class='hs-comment'>--</span> <a name="line-67"></a><span class='hs-comment'>-- /Changes:/ The list of errors will contain at most one entry, and if an</span> <a name="line-68"></a><span class='hs-comment'>-- error is present then the other two lists will be empty.</span> <a name="line-69"></a><span class='hs-definition'>getOpt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ArgOrder</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptDescr</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <a name="line-70"></a><span class='hs-definition'>getOpt</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>args</span> <span class='hs-keyglyph'>=</span> <a name="line-71"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>process</span> <span class='hs-layout'>(</span><span class='hs-varid'>convert</span> <span class='hs-str'>""</span> <span class='hs-varid'>flags</span><span class='hs-layout'>)</span> <span class='hs-varid'>args</span> <span class='hs-keyword'>of</span> <a name="line-72"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <a name="line-73"></a> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span><span class='hs-conid'>[]</span><span class='hs-layout'>)</span> <a name="line-74"></a> <a name="line-75"></a> <a name="line-76"></a><a name="getOpt'"></a><span class='hs-comment'>-- | /Changes:/ This is exactly the same as 'getOpt', but the 3rd element of the</span> <a name="line-77"></a><span class='hs-comment'>-- tuple (second last) will be an empty list.</span> <a name="line-78"></a><span class='hs-definition'>getOpt'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ArgOrder</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptDescr</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <a name="line-79"></a><span class='hs-definition'>getOpt'</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-varid'>z</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span><span class='hs-varid'>c</span><span class='hs-layout'>)</span> <a name="line-80"></a> <span class='hs-keyword'>where</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span><span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getOpt</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-varid'>z</span> <a name="line-81"></a> <a name="line-82"></a> <a name="line-83"></a><a name="convert"></a><span class='hs-comment'>-- | Given a help text and a list of option descriptions, generate a 'Mode'.</span> <a name="line-84"></a><span class='hs-definition'>convert</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptDescr</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Mode</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <a name="line-85"></a><span class='hs-definition'>convert</span> <span class='hs-varid'>help</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mode</span> <span class='hs-str'>"program"</span> <span class='hs-layout'>(</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span><span class='hs-conid'>[]</span><span class='hs-layout'>)</span> <span class='hs-varid'>help</span> <span class='hs-varid'>args</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>f</span> <span class='hs-varid'>flags</span><span class='hs-layout'>)</span> <a name="line-86"></a> <span class='hs-keyword'>where</span> <a name="line-87"></a> <span class='hs-varid'>args</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>flagArg</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-varop'>++</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-str'>"ARG"</span> <a name="line-88"></a> <a name="line-89"></a> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-conid'>Option</span> <span class='hs-varid'>short</span> <span class='hs-varid'>long</span> <span class='hs-varid'>x</span> <span class='hs-varid'>help</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span> <a name="line-90"></a> <span class='hs-conid'>NoArg</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>flagNone</span> <span class='hs-varid'>names</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-varop'>++</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>help</span> <a name="line-91"></a> <span class='hs-conid'>ReqArg</span> <span class='hs-varid'>op</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>flagReq</span> <span class='hs-varid'>names</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-varop'>++</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>op</span> <span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span> <span class='hs-varid'>help</span> <a name="line-92"></a> <span class='hs-conid'>OptArg</span> <span class='hs-varid'>op</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>flagOpt</span> <span class='hs-str'>""</span> <span class='hs-varid'>names</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-varop'>++</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>op</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>then</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyword'>else</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span> <span class='hs-varid'>help</span> <a name="line-93"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>names</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>return</span> <span class='hs-varid'>short</span> <span class='hs-varop'>++</span> <span class='hs-varid'>long</span> </pre></body> </html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
a754cb499dfee5e1f453d3b6cc13d4c8
>
files
>
152
