summaryrefslogtreecommitdiff
blob: 258bfa154ce5e244183c6c6c8bcf594cb48f2e97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
	<maintainer>
		<email>haskell@gentoo.org</email>
		<name>Gentoo Haskell</name>
	</maintainer>
	<longdescription>
		ReadArgs provides the @readArgs@ IO action, which lets you tell the compiler
		to parse the command line arguments to fit the type signature you give.
		
		For example @(a :: Int, b :: String, c :: Float) &lt;- readArgs@ would
		parse the first runtime argument as an @Int@, the second as a @String@ (no
		quotes required) and the third as a @Float@.
		
		If the runtime arguments are incompatible with the type signature,
		then a simple usage statement is given of the types needed.
		
		Continuing the previous example, if it was used in a
		program named @Example@, the error message for the above
		action would be:
		
		@
		usage: Example Int String Float
		@
		
		Any type that has both @Typeable@ and @Read@ instances
		can be used. @Char@, @String@, and @Text@ are handled specially so that
		command line arguments for both do not require quotes (as their
		@Read@ instances do). A special instance is provided for @FilePath@ so
		that no constructor or quotes are required.
		
		@readArgs@ also supports optional arguments and variadic arguments.
		Optional arguments are specified using @Maybe@, and variadic arguments
		using a list.  @(a :: Int, b :: Maybe String, c :: [Float]) &lt;- readArgs@
		would successfully parse any of the following sets of command line arguments:
		
		@
		Example 1
		Example 1 2 3 4
		Example 1 foo
		Example 1 foo 2 3 4
		@
		
		But not
		
		@
		Example
		Example foo
		Example 1.0
		@
		
		Usage statements for optional and variadic arguments use command-line
		parlance:
		
		@
		usage: Example Int [String] [Float..]
		@
		
		Note that both optional and variadic parsers are greedy by default
		(so @Example 1 2 3 4@ was parsed as @(1, "2", [3.0,4.0])@.  They
		may both be made non-greedy through use of the @NonGreedy@ constructor:
		
		@
		( a :: Int
		, NonGreedy b :: NonGreedy Maybe String
		, NonGreedy c :: NonGreedy [] Float
		) &lt;- readArgs
		@
	</longdescription>
	<upstream>
		<remote-id type="github">rampion/ReadArgs</remote-id>
	</upstream>
</pkgmetadata>