<?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/Implicit/UI.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> This module describes the attributes that can be specified on flags and modes.
<a name="line-3"></a>
<a name="line-4"></a> Many attributes have examples specified on the following data type:
<a name="line-5"></a>
<a name="line-6"></a> > data Sample = Sample {hello :: String}
<a name="line-7"></a>-}</span>
<a name="line-8"></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'>Implicit</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span> <span class='hs-keyword'>where</span>
<a name="line-9"></a>
<a name="line-10"></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'>Implicit</span><span class='hs-varop'>.</span><span class='hs-conid'>Ann</span>
<a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span>
<a name="line-12"></a>
<a name="line-13"></a>
<a name="line-14"></a><a name="opt"></a><span class='hs-comment'>-- | Flag: \"I want users to be able to omit the value associated with this flag.\"</span>
<a name="line-15"></a><span class='hs-comment'>--</span>
<a name="line-16"></a><span class='hs-comment'>-- Make the value of a flag optional. If @--flag@ is given, it will</span>
<a name="line-17"></a><span class='hs-comment'>-- be treated as @--flag=/this_argument/@.</span>
<a name="line-18"></a><span class='hs-comment'>--</span>
<a name="line-19"></a><span class='hs-comment'>-- > {hello = def &= opt "foo"}</span>
<a name="line-20"></a><span class='hs-comment'>-- > -h --hello[=VALUE] (default=foo)</span>
<a name="line-21"></a><span class='hs-comment'>--</span>
<a name="line-22"></a><span class='hs-comment'>-- Note that all flags in CmdArgs are optional, and if omitted will use their default value.</span>
<a name="line-23"></a><span class='hs-comment'>-- Those annotated with @opt@ also allow the flag to be present without an associated value.</span>
<a name="line-24"></a><span class='hs-comment'>-- As an example:</span>
<a name="line-25"></a><span class='hs-comment'>--</span>
<a name="line-26"></a><span class='hs-comment'>-- > {hello = "DEFAULT" &= opt "OPTIONAL"}</span>
<a name="line-27"></a><span class='hs-comment'>--</span>
<a name="line-28"></a><span class='hs-comment'>-- > $ main</span>
<a name="line-29"></a><span class='hs-comment'>-- > {hello = "DEFAULT"}</span>
<a name="line-30"></a><span class='hs-comment'>-- > $ main --hello</span>
<a name="line-31"></a><span class='hs-comment'>-- > {hello = "OPTIONAL"}</span>
<a name="line-32"></a><span class='hs-comment'>-- > $ main --hello=VALUE</span>
<a name="line-33"></a><span class='hs-comment'>-- > {hello = "VALUE"}</span>
<a name="line-34"></a><span class='hs-definition'>opt</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span> <span class='hs-varid'>a</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-conid'>Ann</span>
<a name="line-35"></a><span class='hs-definition'>opt</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FlagOptional</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>cast</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span>
<a name="line-36"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>y</span>
<a name="line-37"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>show</span> <span class='hs-varid'>x</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="typ"></a><span class='hs-comment'>-- | Flag: \"For this flag, users need to give something of type ...\"</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- The the type of a flag's value, usually upper case. Only used</span>
<a name="line-42"></a><span class='hs-comment'>-- for the help message. Commonly the type will be @FILE@ ('typFile')</span>
<a name="line-43"></a><span class='hs-comment'>-- or @DIR@ ('typDir').</span>
<a name="line-44"></a><span class='hs-comment'>--</span>
<a name="line-45"></a><span class='hs-comment'>-- > {hello = def &= typ "MESSAGE"}</span>
<a name="line-46"></a><span class='hs-comment'>-- > -h --hello=MESSAGE</span>
<a name="line-47"></a><span class='hs-definition'>typ</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-48"></a><span class='hs-definition'>typ</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FlagType</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="typFile"></a><span class='hs-comment'>-- | Flag: \"Users must give a file for this flag's value.\"</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- Alias for @'typ' "FILE"@.</span>
<a name="line-53"></a><span class='hs-definition'>typFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-54"></a><span class='hs-definition'>typFile</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>typ</span> <span class='hs-str'>"FILE"</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="typDir"></a><span class='hs-comment'>-- | Flag: \"Users must give a directory for this flag's value.\"</span>
<a name="line-57"></a><span class='hs-comment'>--</span>
<a name="line-58"></a><span class='hs-comment'>-- Alias for @'typ' "DIR"@.</span>
<a name="line-59"></a><span class='hs-definition'>typDir</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-60"></a><span class='hs-definition'>typDir</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>typ</span> <span class='hs-str'>"DIR"</span>
<a name="line-61"></a>
<a name="line-62"></a>
<a name="line-63"></a><a name="help"></a><span class='hs-comment'>-- | Flag/Mode: \"The help message is ...\"</span>
<a name="line-64"></a><span class='hs-comment'>--</span>
<a name="line-65"></a><span class='hs-comment'>-- Descriptive text used in the help output.</span>
<a name="line-66"></a><span class='hs-comment'>--</span>
<a name="line-67"></a><span class='hs-comment'>-- > {hello = def &= help "Help message"}</span>
<a name="line-68"></a><span class='hs-comment'>-- > -h --hello=VALUE Help message</span>
<a name="line-69"></a><span class='hs-definition'>help</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-70"></a><span class='hs-definition'>help</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Help</span>
<a name="line-71"></a>
<a name="line-72"></a><span class='hs-comment'>{-
<a name="line-73"></a>-- | Flag: Specify group membership for this flag
<a name="line-74"></a>--
<a name="line-75"></a>-- > {str = def &= group "Repository Management"
<a name="line-76"></a>-- > ---- Repository Management ----
<a name="line-77"></a>-- > -s --str=VALUE
<a name="line-78"></a>group :: String -> Ann
<a name="line-79"></a>group = FldGroup
<a name="line-80"></a>-}</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="name"></a><span class='hs-comment'>-- | Flag: \"Use this flag name for this field.\"</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- Add flags which trigger this option.</span>
<a name="line-85"></a><span class='hs-comment'>--</span>
<a name="line-86"></a><span class='hs-comment'>-- > {hello = def &= name "foo"}</span>
<a name="line-87"></a><span class='hs-comment'>-- > -h --hello --foo=VALUE</span>
<a name="line-88"></a><span class='hs-definition'>name</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-89"></a><span class='hs-definition'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Name</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="args"></a><span class='hs-comment'>-- | Flag: \"Put non-flag arguments here.\"</span>
<a name="line-92"></a><span class='hs-comment'>--</span>
<a name="line-93"></a><span class='hs-comment'>-- > {hello = def &= args}</span>
<a name="line-94"></a><span class='hs-definition'>args</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-95"></a><span class='hs-definition'>args</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FlagArgs</span>
<a name="line-96"></a>
<a name="line-97"></a><a name="argPos"></a><span class='hs-comment'>-- | Flag: \"Put the nth non-flag argument here.\"</span>
<a name="line-98"></a><span class='hs-comment'>--</span>
<a name="line-99"></a><span class='hs-comment'>-- This field should be used to store a particular argument position</span>
<a name="line-100"></a><span class='hs-comment'>-- (0-based).</span>
<a name="line-101"></a><span class='hs-comment'>--</span>
<a name="line-102"></a><span class='hs-comment'>-- > {hello = def &= argPos 0}</span>
<a name="line-103"></a><span class='hs-definition'>argPos</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-104"></a><span class='hs-definition'>argPos</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FlagArgPos</span>
<a name="line-105"></a>
<a name="line-106"></a>
<a name="line-107"></a><a name="groupname"></a><span class='hs-comment'>-- | Flag\/Mode: \"Give these flags/modes a group name in the help output.\"</span>
<a name="line-108"></a><span class='hs-comment'>--</span>
<a name="line-109"></a><span class='hs-comment'>-- This mode will be used for all following modes/flags, until the</span>
<a name="line-110"></a><span class='hs-comment'>-- next @groupname@.</span>
<a name="line-111"></a><span class='hs-comment'>--</span>
<a name="line-112"></a><span class='hs-comment'>-- > {hello = def &= groupname "Welcomes"}</span>
<a name="line-113"></a><span class='hs-comment'>-- > Welcomes</span>
<a name="line-114"></a><span class='hs-comment'>-- > -h --hello=VALUE</span>
<a name="line-115"></a><span class='hs-definition'>groupname</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-116"></a><span class='hs-definition'>groupname</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GroupName</span>
<a name="line-117"></a>
<a name="line-118"></a>
<a name="line-119"></a><a name="details"></a><span class='hs-comment'>-- | Mode: \"A longer description of this mode is ...\"</span>
<a name="line-120"></a><span class='hs-comment'>--</span>
<a name="line-121"></a><span class='hs-comment'>-- Suffix to be added to the help message.</span>
<a name="line-122"></a><span class='hs-comment'>--</span>
<a name="line-123"></a><span class='hs-comment'>-- > Sample{..} &= details ["More details on the website www.example.org"]</span>
<a name="line-124"></a><span class='hs-definition'>details</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-conid'>Ann</span>
<a name="line-125"></a><span class='hs-definition'>details</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModeHelpSuffix</span>
<a name="line-126"></a>
<a name="line-127"></a><a name="summary"></a><span class='hs-comment'>-- | Modes: \"My program name\/version\/copyright is ...\"</span>
<a name="line-128"></a><span class='hs-comment'>--</span>
<a name="line-129"></a><span class='hs-comment'>-- One line summary of the entire program, the first line of</span>
<a name="line-130"></a><span class='hs-comment'>-- @--help@ and the only line of @--version@.</span>
<a name="line-131"></a><span class='hs-comment'>--</span>
<a name="line-132"></a><span class='hs-comment'>-- > Sample{..} &= summary "CmdArgs v0.0, (C) Neil Mitchell 1981"</span>
<a name="line-133"></a><span class='hs-definition'>summary</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-134"></a><span class='hs-definition'>summary</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgSummary</span>
<a name="line-135"></a>
<a name="line-136"></a>
<a name="line-137"></a><a name="auto"></a><span class='hs-comment'>-- | Mode: \"If the user doesn't give a mode, use this one.\"</span>
<a name="line-138"></a><span class='hs-comment'>--</span>
<a name="line-139"></a><span class='hs-comment'>-- This mode is the default. If no mode is specified and a mode has this</span>
<a name="line-140"></a><span class='hs-comment'>-- attribute then that mode is selected, otherwise an error is raised.</span>
<a name="line-141"></a><span class='hs-comment'>--</span>
<a name="line-142"></a><span class='hs-comment'>-- > modes [Mode1{..}, Mode2{..} &= auto, Mode3{..}]</span>
<a name="line-143"></a><span class='hs-definition'>auto</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-144"></a><span class='hs-definition'>auto</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModeDefault</span>
<a name="line-145"></a>
<a name="line-146"></a>
<a name="line-147"></a><a name="program"></a><span class='hs-comment'>-- | Modes: \"My program executable is named ...\"</span>
<a name="line-148"></a><span class='hs-comment'>--</span>
<a name="line-149"></a><span class='hs-comment'>-- This is the name of the program executable. Only used in the help message.</span>
<a name="line-150"></a><span class='hs-comment'>-- Defaults to the type of the mode.</span>
<a name="line-151"></a><span class='hs-comment'>--</span>
<a name="line-152"></a><span class='hs-comment'>-- > Sample{..} &= program "sample"</span>
<a name="line-153"></a><span class='hs-definition'>program</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-154"></a><span class='hs-definition'>program</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgProgram</span>
<a name="line-155"></a>
<a name="line-156"></a>
<a name="line-157"></a><a name="explicit"></a><span class='hs-comment'>-- | Flag: \"Don't guess any names for this field.\"</span>
<a name="line-158"></a><span class='hs-comment'>--</span>
<a name="line-159"></a><span class='hs-comment'>-- A field should not have any flag names guessed for it.</span>
<a name="line-160"></a><span class='hs-comment'>-- All flag names must be specified by 'flag'.</span>
<a name="line-161"></a><span class='hs-comment'>--</span>
<a name="line-162"></a><span class='hs-comment'>-- > {hello = def &= explicit &= name "foo"}</span>
<a name="line-163"></a><span class='hs-comment'>-- > --foo=VALUE</span>
<a name="line-164"></a><span class='hs-definition'>explicit</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-165"></a><span class='hs-definition'>explicit</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Explicit</span>
<a name="line-166"></a>
<a name="line-167"></a>
<a name="line-168"></a><a name="ignore"></a><span class='hs-comment'>-- | Flag/Mode: \"Ignore this field, don't let the user set it.\"</span>
<a name="line-169"></a><span class='hs-comment'>--</span>
<a name="line-170"></a><span class='hs-comment'>-- A mode or field is not dealt with by CmdArgs.</span>
<a name="line-171"></a><span class='hs-comment'>--</span>
<a name="line-172"></a><span class='hs-comment'>-- > {hello = def, extra = def &= ignore}</span>
<a name="line-173"></a><span class='hs-comment'>-- > --hello=VALUE</span>
<a name="line-174"></a><span class='hs-definition'>ignore</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-175"></a><span class='hs-definition'>ignore</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Ignore</span>
<a name="line-176"></a>
<a name="line-177"></a>
<a name="line-178"></a><a name="verbosity"></a><span class='hs-comment'>-- | Modes: \"My program needs verbosity flags.\"</span>
<a name="line-179"></a><span class='hs-comment'>--</span>
<a name="line-180"></a><span class='hs-comment'>-- Add @--verbose@ and @--quiet@ flags.</span>
<a name="line-181"></a><span class='hs-definition'>verbosity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ann</span>
<a name="line-182"></a><span class='hs-definition'>verbosity</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgVerbosity</span>
<a name="line-183"></a>
<a name="line-184"></a>
<a name="line-185"></a><a name="helpArg"></a><span class='hs-comment'>-- | Modes: \"Customise the help argument.\"</span>
<a name="line-186"></a><span class='hs-comment'>--</span>
<a name="line-187"></a><span class='hs-comment'>-- Add extra options to a help argument, such as 'help', 'name', 'ignore' or 'explicit'.</span>
<a name="line-188"></a><span class='hs-comment'>--</span>
<a name="line-189"></a><span class='hs-comment'>-- > Sample{..} &= helpArg [explicit, name "h"]</span>
<a name="line-190"></a><span class='hs-definition'>helpArg</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Ann</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-191"></a><span class='hs-definition'>helpArg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgHelpArg</span>
<a name="line-192"></a>
<a name="line-193"></a>
<a name="line-194"></a><a name="versionArg"></a><span class='hs-comment'>-- | Modes: \"Customise the version argument.\"</span>
<a name="line-195"></a><span class='hs-comment'>--</span>
<a name="line-196"></a><span class='hs-comment'>-- Add extra options to a version argument, such as 'help', 'name', 'ignore', 'summary' or 'explicit'.</span>
<a name="line-197"></a><span class='hs-comment'>--</span>
<a name="line-198"></a><span class='hs-comment'>-- > Sample{..} &= versionArg [ignore]</span>
<a name="line-199"></a><span class='hs-definition'>versionArg</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Ann</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-200"></a><span class='hs-definition'>versionArg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgVersionArg</span>
<a name="line-201"></a>
<a name="line-202"></a><a name="verbosityArgs"></a><span class='hs-comment'>-- | Modes: \"Customise the verbosity arguments.\"</span>
<a name="line-203"></a><span class='hs-comment'>--</span>
<a name="line-204"></a><span class='hs-comment'>-- Add extra options to a verbosity arguments (@--verbose@ and @--quiet@),</span>
<a name="line-205"></a><span class='hs-comment'>-- such as 'help', 'name', 'ignore' or 'explicit'. The verbose options come</span>
<a name="line-206"></a><span class='hs-comment'>-- first, followed by the quiet options.</span>
<a name="line-207"></a><span class='hs-comment'>--</span>
<a name="line-208"></a><span class='hs-comment'>-- > Sample{..} &= verbosityArgs [ignore] [name "silent", explicit]</span>
<a name="line-209"></a><span class='hs-definition'>verbosityArgs</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Ann</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Ann</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ann</span>
<a name="line-210"></a><span class='hs-definition'>verbosityArgs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ProgVerbosityArgs</span>
</pre></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
a754cb499dfee5e1f453d3b6cc13d4c8
>
files
>
160
