<?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://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/System/Console/GetOpt/Utils.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-
<a name="line-2"></a>Copyright (C) 2005 John Goerzen <jgoerzen@complete.org>
<a name="line-3"></a>
<a name="line-4"></a>This program is free software; you can redistribute it and/or modify
<a name="line-5"></a>it under the terms of the GNU General Public License as published by
<a name="line-6"></a>the Free Software Foundation; either version 2 of the License, or
<a name="line-7"></a>(at your option) any later version.
<a name="line-8"></a>
<a name="line-9"></a>This program is distributed in the hope that it will be useful,
<a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<a name="line-12"></a>GNU General Public License for more details.
<a name="line-13"></a>
<a name="line-14"></a>You should have received a copy of the GNU General Public License
<a name="line-15"></a>along with this program; if not, write to the Free Software
<a name="line-16"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<a name="line-17"></a>-}</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- |
<a name="line-20"></a> Module : MissingH.getOpt
<a name="line-21"></a> Copyright : Copyright (C) 2005 John Goerzen
<a name="line-22"></a> License : GNU GPL, version 2 or above
<a name="line-23"></a>
<a name="line-24"></a> Maintainer : John Goerzen <jgoerzen@complete.org>
<a name="line-25"></a> Stability : provisional
<a name="line-26"></a> Portability: portable
<a name="line-27"></a>
<a name="line-28"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-29"></a>
<a name="line-30"></a>Utilities for command-line parsing, including wrappers around
<a name="line-31"></a>the standard System.Console.GetOpt module.
<a name="line-32"></a>-}</span>
<a name="line-33"></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'>GetOpt</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span> <span class='hs-layout'>(</span><span class='hs-varid'>parseCmdLine</span><span class='hs-layout'>,</span>
<a name="line-34"></a> <span class='hs-varid'>validateCmdLine</span><span class='hs-layout'>,</span>
<a name="line-35"></a> <span class='hs-conid'>StdOption</span><span class='hs-layout'>,</span>
<a name="line-36"></a> <span class='hs-varid'>stdRequired</span><span class='hs-layout'>,</span>
<a name="line-37"></a> <span class='hs-varid'>stdOptional</span>
<a name="line-38"></a> <span class='hs-layout'>)</span>
<a name="line-39"></a><span class='hs-keyword'>where</span>
<a name="line-40"></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'>GetOpt</span>
<a name="line-41"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Environment</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="parseCmdLine"></a><span class='hs-comment'>{- | Simple command line parser -- a basic wrapper around the system's
<a name="line-44"></a>default getOpt. See the System.Console.GetOpt manual for a description of the
<a name="line-45"></a>first two parameters.
<a name="line-46"></a>
<a name="line-47"></a>The third parameter is a usage information header.
<a name="line-48"></a>
<a name="line-49"></a>The return value consists of the list of parsed flags and a list of
<a name="line-50"></a>non-option arguments. -}</span>
<a name="line-51"></a><span class='hs-definition'>parseCmdLine</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-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</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-52"></a><span class='hs-definition'>parseCmdLine</span> <span class='hs-varid'>order</span> <span class='hs-varid'>options</span> <span class='hs-varid'>header</span> <span class='hs-keyglyph'>=</span>
<a name="line-53"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>argv</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getArgs</span>
<a name="line-54"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>getOpt</span> <span class='hs-varid'>order</span> <span class='hs-varid'>options</span> <span class='hs-varid'>argv</span> <span class='hs-keyword'>of</span>
<a name="line-55"></a> <span class='hs-layout'>(</span><span class='hs-varid'>o</span><span class='hs-layout'>,</span> <span class='hs-varid'>n</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'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>o</span><span class='hs-layout'>,</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-56"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>errors</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ioError</span> <span class='hs-layout'>(</span><span class='hs-varid'>userError</span> <span class='hs-layout'>(</span><span class='hs-varid'>concat</span> <span class='hs-varid'>errors</span> <span class='hs-varop'>++</span>
<a name="line-57"></a> <span class='hs-varid'>usageInfo</span> <span class='hs-varid'>header</span> <span class='hs-varid'>options</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="validateCmdLine"></a><span class='hs-comment'>{- | Similar to 'parseCmdLine', but takes an additional function that validates
<a name="line-60"></a>the post-parse command-line arguments. This is useful, for example, in
<a name="line-61"></a>situations where there are two arguments that are mutually-exclusive and only
<a name="line-62"></a>one may legitimately be given at a time.
<a name="line-63"></a>
<a name="line-64"></a>The return value of the function indicates whether or not it detected an
<a name="line-65"></a>error condition. If it returns Nothing, there is no error. If it returns
<a name="line-66"></a>Just String, there was an error, described by the String.
<a name="line-67"></a>-}</span>
<a name="line-68"></a><span class='hs-definition'>validateCmdLine</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-conid'>String</span> <span class='hs-keyglyph'>-></span>
<a name="line-69"></a> <span class='hs-layout'>(</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'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</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-70"></a><span class='hs-definition'>validateCmdLine</span> <span class='hs-varid'>order</span> <span class='hs-varid'>options</span> <span class='hs-varid'>header</span> <span class='hs-varid'>func</span> <span class='hs-keyglyph'>=</span>
<a name="line-71"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>parseCmdLine</span> <span class='hs-varid'>order</span> <span class='hs-varid'>options</span> <span class='hs-varid'>header</span>
<a name="line-72"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>func</span> <span class='hs-varid'>res</span> <span class='hs-keyword'>of</span>
<a name="line-73"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>res</span>
<a name="line-74"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>errormsg</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ioError</span> <span class='hs-layout'>(</span><span class='hs-varid'>userError</span> <span class='hs-layout'>(</span><span class='hs-varid'>errormsg</span> <span class='hs-varop'>++</span> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-75"></a> <span class='hs-varid'>usageInfo</span> <span class='hs-varid'>header</span> <span class='hs-varid'>options</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-76"></a>
<a name="line-77"></a><a name="StdOption"></a><span class='hs-comment'>{- | A type to standardize some common uses of GetOpt.
<a name="line-78"></a>
<a name="line-79"></a>The first component of the tuple is the long name of the option.
<a name="line-80"></a>
<a name="line-81"></a>The second component is empty if there is no arg, or has the arg otherwise. -}</span>
<a name="line-82"></a><a name="StdOption"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>StdOption</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="stdRequired"></a><span class='hs-comment'>{- | Handle a required argument. -}</span>
<a name="line-85"></a><span class='hs-definition'>stdRequired</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Name of arg</span>
<a name="line-86"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>StdOption</span>
<a name="line-87"></a><span class='hs-definition'>stdRequired</span> <span class='hs-varid'>name</span> <span class='hs-varid'>value</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>name</span><span class='hs-layout'>,</span> <span class='hs-varid'>value</span><span class='hs-layout'>)</span>
<a name="line-88"></a>
<a name="line-89"></a><a name="stdOptional"></a><span class='hs-comment'>{- | Handle an optional argument. -}</span>
<a name="line-90"></a><span class='hs-definition'>stdOptional</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Name of arg</span>
<a name="line-91"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>StdOption</span>
<a name="line-92"></a><span class='hs-definition'>stdOptional</span> <span class='hs-varid'>name</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>name</span><span class='hs-layout'>,</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-93"></a><span class='hs-definition'>stdOptional</span> <span class='hs-varid'>name</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>name</span><span class='hs-layout'>,</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ec5844e219498f2057da8f8f3070d4a1
>
files
>
287
