<?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/Explicit.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE ScopedTypeVariables #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-|
<a name="line-3"></a> This module constructs command lines. You may either use the helper functions
<a name="line-4"></a> ('flagNone', 'flagOpt', 'mode' etc.) or construct the type directly. These
<a name="line-5"></a> types are intended to give all the necessary power to the person constructing
<a name="line-6"></a> a command line parser.
<a name="line-7"></a>
<a name="line-8"></a> For people constructing simpler command line parsers, the module
<a name="line-9"></a> "System.Console.CmdArgs.Implicit" may be more appropriate.
<a name="line-10"></a>
<a name="line-11"></a> As an example of a parser:
<a name="line-12"></a>
<a name="line-13"></a> @
<a name="line-14"></a> arguments :: 'Mode' [(String,String)]
<a name="line-15"></a> arguments = 'mode' \"explicit\" [] \"Explicit sample program\" ('flagArg' (upd \"file\") \"FILE\")
<a name="line-16"></a> ['flagOpt' \"world\" [\"hello\",\"h\"] (upd \"world\") \"WHO\" \"World argument\"
<a name="line-17"></a> ,'flagReq' [\"greeting\",\"g\"] (upd \"greeting\") \"MSG\" \"Greeting to give\"
<a name="line-18"></a> ,'flagHelpSimple' ((\"help\",\"\"):)]
<a name="line-19"></a> where upd msg x v = Right $ (msg,x):v
<a name="line-20"></a> @
<a name="line-21"></a>
<a name="line-22"></a> And this can be invoked by:
<a name="line-23"></a>
<a name="line-24"></a> @
<a name="line-25"></a> main = do
<a name="line-26"></a> xs <- 'processArgs' arguments
<a name="line-27"></a> if (\"help\",\"\") \`elem\` xs then
<a name="line-28"></a> print $ 'helpText' [] 'HelpFormatDefault' arguments
<a name="line-29"></a> else
<a name="line-30"></a> print xs
<a name="line-31"></a> @
<a name="line-32"></a>
<a name="line-33"></a> /Groups/: The 'Group' structure allows flags/modes to be grouped for the purpose of
<a name="line-34"></a> displaying help. When processing command lines, the group structure is ignored.
<a name="line-35"></a>
<a name="line-36"></a> /Modes/: The Explicit module allows multiple mode programs by placing additional modes
<a name="line-37"></a> in 'modeGroupModes'. Every mode is allowed sub-modes, and thus multiple levels of mode
<a name="line-38"></a> may be created. Given a mode @x@ with sub-modes @xs@, if the first argument corresponds
<a name="line-39"></a> to the name of a sub-mode, then that sub-mode will be applied. If not, then the arguments
<a name="line-40"></a> will be processed by mode @x@. Consequently, if you wish to force the user to explicitly
<a name="line-41"></a> enter a mode, simply give sub-modes, and leave 'modeArgs' as @Nothing@. Alternatively, if
<a name="line-42"></a> you want one sub-mode to be selected by default, place all it's flags both in the sub-mode
<a name="line-43"></a> and the outer mode.
<a name="line-44"></a>
<a name="line-45"></a> /Parsing rules/: Command lines are parsed as per most GNU programs. Short arguments single
<a name="line-46"></a> letter flags start with @-@, longer flags start with @--@, and everything else is considered
<a name="line-47"></a> an argument. Anything after @--@ alone is considered to be an argument. For example:
<a name="line-48"></a>
<a name="line-49"></a> > -f --flag argument1 -- --argument2
<a name="line-50"></a>
<a name="line-51"></a> This command line passes one single letter flag (@f@), one longer flag (@flag@) and two arguments
<a name="line-52"></a> (@argument1@ and @--argument2@).
<a name="line-53"></a>-}</span>
<a name="line-54"></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'>Explicit</span><span class='hs-layout'>(</span>
<a name="line-55"></a> <span class='hs-comment'>-- * Running command lines</span>
<a name="line-56"></a> <span class='hs-varid'>process</span><span class='hs-layout'>,</span> <span class='hs-varid'>processArgs</span><span class='hs-layout'>,</span> <span class='hs-varid'>processValue</span><span class='hs-layout'>,</span>
<a name="line-57"></a> <span class='hs-comment'>-- * Constructing command lines</span>
<a name="line-58"></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'>Explicit</span><span class='hs-varop'>.</span><span class='hs-conid'>Type</span><span class='hs-layout'>,</span>
<a name="line-59"></a> <span class='hs-varid'>flagHelpSimple</span><span class='hs-layout'>,</span> <span class='hs-varid'>flagHelpFormat</span><span class='hs-layout'>,</span> <span class='hs-varid'>flagVersion</span><span class='hs-layout'>,</span> <span class='hs-varid'>flagsVerbosity</span><span class='hs-layout'>,</span>
<a name="line-60"></a> <span class='hs-comment'>-- * Displaying help</span>
<a name="line-61"></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'>Explicit</span><span class='hs-varop'>.</span><span class='hs-conid'>Help</span><span class='hs-layout'>,</span>
<a name="line-62"></a> <span class='hs-comment'>-- * Utilities for working with command lines</span>
<a name="line-63"></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'>Explicit</span><span class='hs-varop'>.</span><span class='hs-conid'>ExpandArgsAt</span><span class='hs-layout'>,</span>
<a name="line-64"></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'>Explicit</span><span class='hs-varop'>.</span><span class='hs-conid'>SplitJoin</span><span class='hs-layout'>,</span>
<a name="line-65"></a> <span class='hs-conid'>Complete</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>complete</span>
<a name="line-66"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-67"></a>
<a name="line-68"></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><span class='hs-varop'>.</span><span class='hs-conid'>Type</span>
<a name="line-69"></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><span class='hs-varop'>.</span><span class='hs-conid'>Process</span>
<a name="line-70"></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><span class='hs-varop'>.</span><span class='hs-conid'>Help</span>
<a name="line-71"></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><span class='hs-varop'>.</span><span class='hs-conid'>ExpandArgsAt</span>
<a name="line-72"></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><span class='hs-varop'>.</span><span class='hs-conid'>SplitJoin</span>
<a name="line-73"></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><span class='hs-varop'>.</span><span class='hs-conid'>Complete</span>
<a name="line-74"></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'>Default</span>
<a name="line-75"></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'>Helper</span>
<a name="line-76"></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'>Text</span>
<a name="line-77"></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'>Verbosity</span>
<a name="line-78"></a>
<a name="line-79"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-80"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span>
<a name="line-81"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span>
<a name="line-82"></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-83"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Exit</span>
<a name="line-84"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-85"></a>
<a name="line-86"></a>
<a name="line-87"></a><a name="processArgs"></a><span class='hs-comment'>-- | Process the flags obtained by @'getArgs'@ and @'expandArgsAt'@ with a mode. Displays</span>
<a name="line-88"></a><span class='hs-comment'>-- an error and exits with failure if the command line fails to parse, or returns</span>
<a name="line-89"></a><span class='hs-comment'>-- the associated value. Implemented in terms of 'process'. This function makes</span>
<a name="line-90"></a><span class='hs-comment'>-- use of the following environment variables:</span>
<a name="line-91"></a><span class='hs-comment'>--</span>
<a name="line-92"></a><span class='hs-comment'>-- * @$CMDARGS_COMPLETE@ - causes the program to produce completions using 'complete', then exit.</span>
<a name="line-93"></a><span class='hs-comment'>-- Completions are based on the result of 'getArgs', the index of the current argument is taken</span>
<a name="line-94"></a><span class='hs-comment'>-- from @$CMDARGS_COMPLETE@ (set it to @-@ to complete the last argument), and the index within</span>
<a name="line-95"></a><span class='hs-comment'>-- that argument is taken from @$CMDARGS_COMPLETE_POS@ (if set).</span>
<a name="line-96"></a><span class='hs-comment'>--</span>
<a name="line-97"></a><span class='hs-comment'>-- * @$CMDARGS_HELPER@\/@$CMDARGS_HELPER_/PROG/@ - uses the helper mechanism for entering command</span>
<a name="line-98"></a><span class='hs-comment'>-- line programs as described in "System.Console.CmdArgs.Helper".</span>
<a name="line-99"></a><span class='hs-definition'>processArgs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Mode</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-100"></a><span class='hs-definition'>processArgs</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-101"></a> <span class='hs-varid'>env</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getEnvironment</span>
<a name="line-102"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>lookup</span> <span class='hs-str'>"CMDARGS_COMPLETE"</span> <span class='hs-varid'>env</span> <span class='hs-keyword'>of</span>
<a name="line-103"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-104"></a> <span class='hs-varid'>args</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getArgs</span>
<a name="line-105"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>argInd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>length</span> <span class='hs-varid'>args</span> <span class='hs-comment'>-</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>readMay</span> <span class='hs-varid'>x</span>
<a name="line-106"></a> <span class='hs-varid'>argPos</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-keyword'>if</span> <span class='hs-varid'>argInd</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>argInd</span> <span class='hs-varop'><</span> <span class='hs-varid'>length</span> <span class='hs-varid'>args</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>length</span> <span class='hs-layout'>(</span><span class='hs-varid'>args</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>argInd</span><span class='hs-layout'>)</span> <span class='hs-keyword'>else</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-107"></a> <span class='hs-varid'>readMay</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>lookup</span> <span class='hs-str'>"CMDARGS_COMPLETE_POS"</span> <span class='hs-varid'>env</span>
<a name="line-108"></a> <span class='hs-varid'>print</span> <span class='hs-varop'>$</span> <span class='hs-varid'>complete</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-varid'>concatMap</span> <span class='hs-varid'>words</span> <span class='hs-varid'>args</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>argInd</span><span class='hs-layout'>,</span><span class='hs-varid'>argPos</span><span class='hs-layout'>)</span>
<a name="line-109"></a> <span class='hs-varid'>exitWith</span> <span class='hs-conid'>ExitSuccess</span>
<a name="line-110"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-111"></a> <span class='hs-varid'>nam</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getProgName</span>
<a name="line-112"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>var</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mplus</span> <span class='hs-layout'>(</span><span class='hs-varid'>lookup</span> <span class='hs-layout'>(</span><span class='hs-str'>"CMDARGS_HELPER_"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>toUpper</span> <span class='hs-varop'>$</span> <span class='hs-varid'>head</span> <span class='hs-varop'>$</span> <span class='hs-varid'>modeNames</span> <span class='hs-varid'>m</span> <span class='hs-varop'>++</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>nam</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>env</span><span class='hs-layout'>)</span>
<a name="line-113"></a> <span class='hs-layout'>(</span><span class='hs-varid'>lookup</span> <span class='hs-str'>"CMDARGS_HELPER"</span> <span class='hs-varid'>env</span><span class='hs-layout'>)</span>
<a name="line-114"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>var</span> <span class='hs-keyword'>of</span>
<a name="line-115"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>run</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>expandArgsAt</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>getArgs</span>
<a name="line-116"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-117"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>execute</span> <span class='hs-varid'>cmd</span> <span class='hs-varid'>m</span> <span class='hs-conid'>[]</span>
<a name="line-118"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>res</span> <span class='hs-keyword'>of</span>
<a name="line-119"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>err</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-120"></a> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>stderr</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Error when running helper "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>cmd</span>
<a name="line-121"></a> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>stderr</span> <span class='hs-varid'>err</span>
<a name="line-122"></a> <span class='hs-varid'>exitFailure</span>
<a name="line-123"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>args</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>run</span> <span class='hs-varid'>args</span>
<a name="line-124"></a> <span class='hs-keyword'>where</span>
<a name="line-125"></a> <span class='hs-varid'>run</span> <span class='hs-varid'>args</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>process</span> <span class='hs-varid'>m</span> <span class='hs-varid'>args</span> <span class='hs-keyword'>of</span>
<a name="line-126"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>stderr</span> <span class='hs-varid'>x</span><span class='hs-layout'>;</span> <span class='hs-varid'>exitFailure</span>
<a name="line-127"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>x</span>
<a name="line-128"></a>
<a name="line-129"></a>
<a name="line-130"></a><a name="readMay"></a><span class='hs-definition'>readMay</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Read</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span>
<a name="line-131"></a><span class='hs-definition'>readMay</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</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'>x</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>reads</span> <span class='hs-varid'>s</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-str'>""</span><span class='hs-layout'>,</span><span class='hs-str'>""</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lex</span> <span class='hs-varid'>t</span><span class='hs-keyglyph'>]</span> <span class='hs-keyword'>of</span>
<a name="line-132"></a> <span class='hs-keyglyph'>[</span><span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-varid'>x</span>
<a name="line-133"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Nothing</span>
<a name="line-134"></a>
<a name="line-135"></a>
<a name="line-136"></a><a name="processValue"></a><span class='hs-comment'>-- | Process a list of flags (usually obtained from @'getArgs'@ and @'expandArgsAt'@) with a mode. Displays</span>
<a name="line-137"></a><span class='hs-comment'>-- an error and exits with failure if the command line fails to parse, or returns</span>
<a name="line-138"></a><span class='hs-comment'>-- the associated value. Implemeneted in terms of 'process'. This function</span>
<a name="line-139"></a><span class='hs-comment'>-- does not take account of any environment variables that may be set</span>
<a name="line-140"></a><span class='hs-comment'>-- (see 'processArgs').</span>
<a name="line-141"></a><span class='hs-definition'>processValue</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Mode</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-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-142"></a><span class='hs-definition'>processValue</span> <span class='hs-varid'>m</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>process</span> <span class='hs-varid'>m</span> <span class='hs-varid'>xs</span> <span class='hs-keyword'>of</span>
<a name="line-143"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>error</span> <span class='hs-varid'>x</span>
<a name="line-144"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>x</span>
<a name="line-145"></a>
<a name="line-146"></a>
<a name="line-147"></a><a name="flagHelpSimple"></a><span class='hs-comment'>-- | Create a help flag triggered by @-?@/@--help@.</span>
<a name="line-148"></a><span class='hs-definition'>flagHelpSimple</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flag</span> <span class='hs-varid'>a</span>
<a name="line-149"></a><span class='hs-definition'>flagHelpSimple</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>flagNone</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"help"</span><span class='hs-layout'>,</span><span class='hs-str'>"?"</span><span class='hs-keyglyph'>]</span> <span class='hs-varid'>f</span> <span class='hs-str'>"Display help message"</span>
<a name="line-150"></a>
<a name="line-151"></a>
<a name="line-152"></a><a name="flagHelpFormat"></a><span class='hs-comment'>-- | Create a help flag triggered by @-?@/@--help@. The user</span>
<a name="line-153"></a><span class='hs-comment'>-- may optionally modify help by specifying the format, such as:</span>
<a name="line-154"></a><span class='hs-comment'>--</span>
<a name="line-155"></a><span class='hs-comment'>-- > --help=all - help for all modes</span>
<a name="line-156"></a><span class='hs-comment'>-- > --help=html - help in HTML format</span>
<a name="line-157"></a><span class='hs-comment'>-- > --help=100 - wrap the text at 100 characters</span>
<a name="line-158"></a><span class='hs-comment'>-- > --help=100,one - full text wrapped at 100 characters</span>
<a name="line-159"></a><span class='hs-definition'>flagHelpFormat</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormat</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TextFormat</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flag</span> <span class='hs-varid'>a</span>
<a name="line-160"></a><span class='hs-definition'>flagHelpFormat</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>flagOpt</span> <span class='hs-str'>""</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"help"</span><span class='hs-layout'>,</span><span class='hs-str'>"?"</span><span class='hs-keyglyph'>]</span> <span class='hs-varid'>upd</span> <span class='hs-str'>""</span> <span class='hs-str'>"Display help message"</span><span class='hs-layout'>)</span><span class='hs-layout'>{</span><span class='hs-varid'>flagInfo</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FlagOptRare</span> <span class='hs-str'>""</span><span class='hs-layout'>}</span>
<a name="line-161"></a> <span class='hs-keyword'>where</span>
<a name="line-162"></a> <span class='hs-varid'>upd</span> <span class='hs-varid'>s</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>format</span> <span class='hs-varid'>s</span> <span class='hs-keyword'>of</span>
<a name="line-163"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Left</span> <span class='hs-varid'>e</span>
<a name="line-164"></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-conid'>Right</span> <span class='hs-varop'>$</span> <span class='hs-varid'>f</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>v</span>
<a name="line-165"></a>
<a name="line-166"></a> <span class='hs-varid'>format</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>String</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormat</span><span class='hs-layout'>,</span><span class='hs-conid'>TextFormat</span><span class='hs-layout'>)</span>
<a name="line-167"></a> <span class='hs-varid'>format</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldl</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>acc</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>either</span> <span class='hs-conid'>Left</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-varid'>acc</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Right</span> <span class='hs-varid'>def</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>sep</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-168"></a> <span class='hs-keyword'>where</span>
<a name="line-169"></a> <span class='hs-varid'>sep</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>words</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</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-keyword'>if</span> <span class='hs-varid'>x</span> <span class='hs-varop'>`elem`</span> <span class='hs-str'>":,"</span> <span class='hs-keyword'>then</span> <span class='hs-chr'>' '</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>toLower</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-170"></a> <span class='hs-varid'>f</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-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span>
<a name="line-171"></a> <span class='hs-str'>"all"</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormatAll</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-172"></a> <span class='hs-str'>"one"</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormatOne</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-173"></a> <span class='hs-str'>"def"</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormatDefault</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-174"></a> <span class='hs-str'>"html"</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-conid'>HTML</span><span class='hs-layout'>)</span>
<a name="line-175"></a> <span class='hs-str'>"text"</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'>defaultWrap</span><span class='hs-layout'>)</span>
<a name="line-176"></a> <span class='hs-str'>"bash"</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormatBash</span><span class='hs-layout'>,</span><span class='hs-conid'>Wrap</span> <span class='hs-num'>1000000</span><span class='hs-layout'>)</span>
<a name="line-177"></a> <span class='hs-str'>"zsh"</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-conid'>HelpFormatZsh</span> <span class='hs-layout'>,</span><span class='hs-conid'>Wrap</span> <span class='hs-num'>1000000</span><span class='hs-layout'>)</span>
<a name="line-178"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>all</span> <span class='hs-varid'>isDigit</span> <span class='hs-varid'>x</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-conid'>Wrap</span> <span class='hs-varop'>$</span> <span class='hs-varid'>read</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-179"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Left</span> <span class='hs-str'>"unrecognised help format, expected one of: all one def html text <NUMBER>"</span>
<a name="line-180"></a>
<a name="line-181"></a>
<a name="line-182"></a><a name="flagVersion"></a><span class='hs-comment'>-- | Create a version flag triggered by @-V@/@--version@.</span>
<a name="line-183"></a><span class='hs-definition'>flagVersion</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flag</span> <span class='hs-varid'>a</span>
<a name="line-184"></a><span class='hs-definition'>flagVersion</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>flagNone</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"version"</span><span class='hs-layout'>,</span><span class='hs-str'>"V"</span><span class='hs-keyglyph'>]</span> <span class='hs-varid'>f</span> <span class='hs-str'>"Print version information"</span>
<a name="line-185"></a>
<a name="line-186"></a>
<a name="line-187"></a><a name="flagsVerbosity"></a><span class='hs-comment'>-- | Create verbosity flags triggered by @-v@/@--verbose@ and</span>
<a name="line-188"></a><span class='hs-comment'>-- @-q@/@--quiet@</span>
<a name="line-189"></a><span class='hs-definition'>flagsVerbosity</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Verbosity</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-190"></a><span class='hs-definition'>flagsVerbosity</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span>
<a name="line-191"></a> <span class='hs-keyglyph'>[</span><span class='hs-varid'>flagNone</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"verbose"</span><span class='hs-layout'>,</span><span class='hs-str'>"v"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-conid'>Loud</span><span class='hs-layout'>)</span> <span class='hs-str'>"Loud verbosity"</span>
<a name="line-192"></a> <span class='hs-layout'>,</span><span class='hs-varid'>flagNone</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"quiet"</span><span class='hs-layout'>,</span><span class='hs-str'>"q"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-conid'>Quiet</span><span class='hs-layout'>)</span> <span class='hs-str'>"Quiet verbosity"</span><span class='hs-keyglyph'>]</span>
</pre></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
a754cb499dfee5e1f453d3b6cc13d4c8
>
files
>
151
