Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / e63da933eba10f5ea5bf39af47a0ded719c2cf5d / . / llvm / docs / CommandLine.html
blob: 0bcd38267cc96b8a404d18a55fb1035e93423b3f [file] [log] [blame]
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]6 <title>CommandLine 2.0 Library Manual</title>
Misha Brukman7120c832003-11-07 18:11:14 +0000[diff] [blame]7 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]8</head>
9<body>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]10
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]11<h1>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]12 CommandLine 2.0 Library Manual
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]13</h1>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]14
15<ol>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]16 <li><a href="#introduction">Introduction</a></li>
17
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]18 <li><a href="#quickstart">Quick Start Guide</a>
19 <ol>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]20 <li><a href="#bool">Boolean Arguments</a></li>
21 <li><a href="#alias">Argument Aliases</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]22 <li><a href="#onealternative">Selecting an alternative from a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]23 set of possibilities</a></li>
24 <li><a href="#namedalternatives">Named alternatives</a></li>
25 <li><a href="#list">Parsing a list of options</a></li>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]26 <li><a href="#bits">Collecting options as a set of flags</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]27 <li><a href="#description">Adding freeform text to help output</a></li>
28 </ol></li>
29
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]30 <li><a href="#referenceguide">Reference Guide</a>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]31 <ol>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]32 <li><a href="#positional">Positional Arguments</a>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]33 <ul>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]34 <li><a href="#--">Specifying positional options with hyphens</a></li>
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]35 <li><a href="#getPosition">Determining absolute position with
36 getPosition</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]37 <li><a href="#cl::ConsumeAfter">The <tt>cl::ConsumeAfter</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]38 modifier</a></li>
39 </ul></li>
40
41 <li><a href="#storage">Internal vs External Storage</a></li>
42
43 <li><a href="#attributes">Option Attributes</a></li>
44
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]45 <li><a href="#modifiers">Option Modifiers</a>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]46 <ul>
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]47 <li><a href="#hiding">Hiding an option from <tt>-help</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]48 output</a></li>
49 <li><a href="#numoccurrences">Controlling the number of occurrences
50 required and allowed</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]51 <li><a href="#valrequired">Controlling whether or not a value must be
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]52 specified</a></li>
53 <li><a href="#formatting">Controlling other formatting options</a></li>
54 <li><a href="#misc">Miscellaneous option modifiers</a></li>
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]55 <li><a href="#response">Response files</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]56 </ul></li>
57
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]58 <li><a href="#toplevel">Top-Level Classes and Functions</a>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]59 <ul>
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]60 <li><a href="#cl::ParseCommandLineOptions">The
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]61 <tt>cl::ParseCommandLineOptions</tt> function</a></li>
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]62 <li><a href="#cl::ParseEnvironmentOptions">The
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]63 <tt>cl::ParseEnvironmentOptions</tt> function</a></li>
Chris Lattnerf1be2882007-12-19 19:48:49 +0000[diff] [blame]64 <li><a href="#cl::SetVersionPrinter">The <tt>cl::SetVersionPrinter</tt>
Reid Spencer0075b2f2006-06-05 17:30:16 +0000[diff] [blame]65 function</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]66 <li><a href="#cl::opt">The <tt>cl::opt</tt> class</a></li>
67 <li><a href="#cl::list">The <tt>cl::list</tt> class</a></li>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]68 <li><a href="#cl::bits">The <tt>cl::bits</tt> class</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]69 <li><a href="#cl::alias">The <tt>cl::alias</tt> class</a></li>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]70 <li><a href="#cl::extrahelp">The <tt>cl::extrahelp</tt> class</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]71 </ul></li>
72
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]73 <li><a href="#builtinparsers">Builtin parsers</a>
74 <ul>
75 <li><a href="#genericparser">The Generic <tt>parser&lt;t&gt;</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]76 parser</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]77 <li><a href="#boolparser">The <tt>parser&lt;bool&gt;</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]78 specialization</a></li>
Dale Johannesen10c5ccc2007-05-22 18:32:34 +0000[diff] [blame]79 <li><a href="#boolOrDefaultparser">The <tt>parser&lt;boolOrDefault&gt;</tt>
80 specialization</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]81 <li><a href="#stringparser">The <tt>parser&lt;string&gt;</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]82 specialization</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]83 <li><a href="#intparser">The <tt>parser&lt;int&gt;</tt>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]84 specialization</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]85 <li><a href="#doubleparser">The <tt>parser&lt;double&gt;</tt> and
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]86 <tt>parser&lt;float&gt;</tt> specializations</a></li>
87 </ul></li>
88 </ol></li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]89 <li><a href="#extensionguide">Extension Guide</a>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]90 <ol>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]91 <li><a href="#customparser">Writing a custom parser</a></li>
92 <li><a href="#explotingexternal">Exploiting external storage</a></li>
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]93 <li><a href="#dynamicopts">Dynamically adding command line
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]94 options</a></li>
95 </ol></li>
96</ol>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]97
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]98<div class="doc_author">
99 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]100</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]101
102<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]103<h2>
Misha Brukman403ff612003-11-07 19:42:44 +0000[diff] [blame]104 <a name="introduction">Introduction</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]105</h2>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]106<!-- *********************************************************************** -->
107
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]108<div class="doc_text">
109
110<p>This document describes the CommandLine argument processing library. It will
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]111show you how to use it, and what it can do. The CommandLine library uses a
112declarative approach to specifying the command line options that your program
113takes. By default, these options declarations implicitly hold the value parsed
114for the option declared (of course this <a href="#storage">can be
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]115changed</a>).</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]116
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]117<p>Although there are a <b>lot</b> of command line argument parsing libraries
118out there in many different languages, none of them fit well with what I needed.
119By looking at the features and problems of other libraries, I designed the
120CommandLine library to have the following features:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]121
122<ol>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]123<li>Speed: The CommandLine library is very quick and uses little resources. The
124parsing time of the library is directly proportional to the number of arguments
125parsed, not the the number of options recognized. Additionally, command line
Chris Lattner364e6312003-06-21 21:45:56 +0000[diff] [blame]126argument values are captured transparently into user defined global variables,
127which can be accessed like any other variable (and with the same
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]128performance).</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]129
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]130<li>Type Safe: As a user of CommandLine, you don't have to worry about
131remembering the type of arguments that you want (is it an int? a string? a
132bool? an enum?) and keep casting it around. Not only does this help prevent
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]133error prone constructs, it also leads to dramatically cleaner source code.</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]134
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]135<li>No subclasses required: To use CommandLine, you instantiate variables that
136correspond to the arguments that you would like to capture, you don't subclass a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]137parser. This means that you don't have to write <b>any</b> boilerplate
138code.</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]139
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]140<li>Globally accessible: Libraries can specify command line arguments that are
141automatically enabled in any tool that links to the library. This is possible
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]142because the application doesn't have to keep a list of arguments to pass to
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]143the parser. This also makes supporting <a href="#dynamicopts">dynamically
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]144loaded options</a> trivial.</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]145
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]146<li>Cleaner: CommandLine supports enum and other types directly, meaning that
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]147there is less error and more security built into the library. You don't have to
148worry about whether your integral command line argument accidentally got
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]149assigned a value that is not valid for your enum type.</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]150
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]151<li>Powerful: The CommandLine library supports many different types of
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]152arguments, from simple <a href="#boolparser">boolean flags</a> to <a
153href="#cl::opt">scalars arguments</a> (<a href="#stringparser">strings</a>, <a
154href="#intparser">integers</a>, <a href="#genericparser">enums</a>, <a
155href="#doubleparser">doubles</a>), to <a href="#cl::list">lists of
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]156arguments</a>. This is possible because CommandLine is...</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]157
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]158<li>Extensible: It is very simple to add a new argument type to CommandLine.
159Simply specify the parser that you want to use with the command line option when
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]160you declare it. <a href="#customparser">Custom parsers</a> are no problem.</li>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]161
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]162<li>Labor Saving: The CommandLine library cuts down on the amount of grunt work
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]163that you, the user, have to do. For example, it automatically provides a
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]164<tt>-help</tt> option that shows the available command line options for your
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]165tool. Additionally, it does most of the basic correctness checking for
166you.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]167
168<li>Capable: The CommandLine library can handle lots of different forms of
169options often found in real programs. For example, <a
170href="#positional">positional</a> arguments, <tt>ls</tt> style <a
171href="#cl::Grouping">grouping</a> options (to allow processing '<tt>ls
172-lad</tt>' naturally), <tt>ld</tt> style <a href="#cl::Prefix">prefix</a>
173options (to parse '<tt>-lmalloc -L/usr/lib</tt>'), and <a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]174href="#cl::ConsumeAfter">interpreter style options</a>.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]175
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]176</ol>
177
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]178<p>This document will hopefully let you jump in and start using CommandLine in
179your utility quickly and painlessly. Additionally it should be a simple
180reference manual to figure out how stuff works. If it is failing in some area
181(or you want an extension to the library), nag the author, <a
182href="mailto:sabre@nondot.org">Chris Lattner</a>.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]183
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]184</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]185
186<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]187<h2>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]188 <a name="quickstart">Quick Start Guide</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]189</h2>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]190<!-- *********************************************************************** -->
191
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]192<div class="doc_text">
193
194<p>This section of the manual runs through a simple CommandLine'ification of a
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]195basic compiler tool. This is intended to show you how to jump into using the
196CommandLine library in your own program, and show you some of the cool things it
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]197can do.</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]198
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]199<p>To start out, you need to include the CommandLine header file into your
200program:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]201
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]202<div class="doc_code"><pre>
Andrew Lenharthb720e2c2005-11-14 19:32:05 +0000[diff] [blame]203 #include "llvm/Support/CommandLine.h"
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]204</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]205
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]206<p>Additionally, you need to add this as the first line of your main
207program:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]208
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]209<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]210int main(int argc, char **argv) {
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]211 <a href="#cl::ParseCommandLineOptions">cl::ParseCommandLineOptions</a>(argc, argv);
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]212 ...
213}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]214</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]215
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]216<p>... which actually parses the arguments and fills in the variable
217declarations.</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]218
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]219<p>Now that you are ready to support command line arguments, we need to tell the
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]220system which ones we want, and what type of arguments they are. The CommandLine
Chris Lattner364e6312003-06-21 21:45:56 +0000[diff] [blame]221library uses a declarative syntax to model command line arguments with the
222global variable declarations that capture the parsed values. This means that
223for every command line option that you would like to support, there should be a
224global variable declaration to capture the result. For example, in a compiler,
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]225we would like to support the Unix-standard '<tt>-o &lt;filename&gt;</tt>' option
Chris Lattner364e6312003-06-21 21:45:56 +0000[diff] [blame]226to specify where to put the output. With the CommandLine library, this is
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]227represented like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]228
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]229<a name="value_desc_example"></a>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]230<div class="doc_code"><pre>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]231<a href="#cl::opt">cl::opt</a>&lt;string&gt; OutputFilename("<i>o</i>", <a href="#cl::desc">cl::desc</a>("<i>Specify output filename</i>"), <a href="#cl::value_desc">cl::value_desc</a>("<i>filename</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]232</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]233
NAKAMURA Takumi2a7024f2011-04-11 03:27:31 +0000[diff] [blame]234<p>This declares a global variable &quot;<tt>OutputFilename</tt>&quot; that is used to
235capture the result of the &quot;<tt>o</tt>&quot; argument (first parameter). We specify
236that this is a simple scalar option by using the &quot;<tt><a
237href="#cl::opt">cl::opt</a></tt>&quot; template (as opposed to the <a
238href="#list">&quot;<tt>cl::list</tt> template</a>), and tell the CommandLine library
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]239that the data type that we are parsing is a string.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]240
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]241<p>The second and third parameters (which are optional) are used to specify what
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]242to output for the "<tt>-help</tt>" option. In this case, we get a line that
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]243looks like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]244
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]245<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]246USAGE: compiler [options]
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]247
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]248OPTIONS:
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]249 -help - display available options (-help-hidden for more)
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]250 <b>-o &lt;filename&gt; - Specify output filename</b>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]251</pre></div>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]252
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]253<p>Because we specified that the command line option should parse using the
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]254<tt>string</tt> data type, the variable declared is automatically usable as a
255real string in all contexts that a normal C++ string object may be used. For
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]256example:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]257
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]258<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]259 ...
Chris Lattnera01203e2008-03-30 16:59:21 +0000[diff] [blame]260 std::ofstream Output(OutputFilename.c_str());
261 if (Output.good()) ...
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]262 ...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]263</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]264
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]265<p>There are many different options that you can use to customize the command
266line option handling library, but the above example shows the general interface
267to these options. The options can be specified in any order, and are specified
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]268with helper functions like <a href="#cl::desc"><tt>cl::desc(...)</tt></a>, so
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]269there are no positional dependencies to remember. The available options are
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]270discussed in detail in the <a href="#referenceguide">Reference Guide</a>.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]271
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]272<p>Continuing the example, we would like to have our compiler take an input
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]273filename as well as an output filename, but we do not want the input filename to
274be specified with a hyphen (ie, not <tt>-filename.c</tt>). To support this
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]275style of argument, the CommandLine library allows for <a
276href="#positional">positional</a> arguments to be specified for the program.
277These positional arguments are filled with command line parameters that are not
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]278in option form. We use this feature like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]279
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]280<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]281<a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <a href="#cl::init">cl::init</a>("<i>-</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]282</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]283
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]284<p>This declaration indicates that the first positional argument should be
285treated as the input filename. Here we use the <tt><a
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]286href="#cl::init">cl::init</a></tt> option to specify an initial value for the
287command line option, which is used if the option is not specified (if you do not
288specify a <tt><a href="#cl::init">cl::init</a></tt> modifier for an option, then
289the default constructor for the data type is used to initialize the value).
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]290Command line options default to being optional, so if we would like to require
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]291that the user always specify an input filename, we would add the <tt><a
292href="#cl::Required">cl::Required</a></tt> flag, and we could eliminate the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]293<tt><a href="#cl::init">cl::init</a></tt> modifier, like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]294
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]295<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]296<a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <b><a href="#cl::Required">cl::Required</a></b>);
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]297</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]298
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]299<p>Again, the CommandLine library does not require the options to be specified
300in any particular order, so the above declaration is equivalent to:</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]301
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]302<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]303<a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::Required">cl::Required</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]304</pre></div>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]305
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]306<p>By simply adding the <tt><a href="#cl::Required">cl::Required</a></tt> flag,
307the CommandLine library will automatically issue an error if the argument is not
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]308specified, which shifts all of the command line option verification code out of
309your application into the library. This is just one example of how using flags
310can alter the default behaviour of the library, on a per-option basis. By
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]311adding one of the declarations above, the <tt>-help</tt> option synopsis is now
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]312extended to:</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]313
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]314<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]315USAGE: compiler [options] <b>&lt;input file&gt;</b>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]316
317OPTIONS:
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]318 -help - display available options (-help-hidden for more)
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]319 -o &lt;filename&gt; - Specify output filename
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]320</pre></div>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]321
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]322<p>... indicating that an input filename is expected.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]323
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]324</div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]325
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]326<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]327<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]328 <a name="bool">Boolean Arguments</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]329</h3>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]330
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]331<div class="doc_text">
332
333<p>In addition to input and output filenames, we would like the compiler example
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]334to support three boolean flags: "<tt>-f</tt>" to force writing binary output to
335a terminal, "<tt>--quiet</tt>" to enable quiet mode, and "<tt>-q</tt>" for
336backwards compatibility with some of our users. We can support these by
337declaring options of boolean type like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]338
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]339<div class="doc_code"><pre>
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]340<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable binary output on terminals</i>"));
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]341<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet ("<i>quiet</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"));
342<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet2("<i>q</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"), <a href="#cl::Hidden">cl::Hidden</a>);
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]343</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]344
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]345<p>This does what you would expect: it declares three boolean variables
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]346("<tt>Force</tt>", "<tt>Quiet</tt>", and "<tt>Quiet2</tt>") to recognize these
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]347options. Note that the "<tt>-q</tt>" option is specified with the "<a
348href="#cl::Hidden"><tt>cl::Hidden</tt></a>" flag. This modifier prevents it
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]349from being shown by the standard "<tt>-help</tt>" output (note that it is still
350shown in the "<tt>-help-hidden</tt>" output).</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]351
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]352<p>The CommandLine library uses a <a href="#builtinparsers">different parser</a>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]353for different data types. For example, in the string case, the argument passed
354to the option is copied literally into the content of the string variable... we
355obviously cannot do that in the boolean case, however, so we must use a smarter
356parser. In the case of the boolean parser, it allows no options (in which case
357it assigns the value of true to the variable), or it allows the values
358"<tt>true</tt>" or "<tt>false</tt>" to be specified, allowing any of the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]359following inputs:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]360
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]361<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]362 compiler -f # No value, 'Force' == true
363 compiler -f=true # Value specified, 'Force' == true
364 compiler -f=TRUE # Value specified, 'Force' == true
365 compiler -f=FALSE # Value specified, 'Force' == false
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]366</pre></div>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]367
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]368<p>... you get the idea. The <a href="#boolparser">bool parser</a> just turns
369the string values into boolean values, and rejects things like '<tt>compiler
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]370-f=foo</tt>'. Similarly, the <a href="#doubleparser">float</a>, <a
371href="#doubleparser">double</a>, and <a href="#intparser">int</a> parsers work
372like you would expect, using the '<tt>strtol</tt>' and '<tt>strtod</tt>' C
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]373library calls to parse the string value into the specified data type.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]374
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]375<p>With the declarations above, "<tt>compiler -help</tt>" emits this:</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]376
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]377<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]378USAGE: compiler [options] &lt;input file&gt;
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]379
380OPTIONS:
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]381 <b>-f - Enable binary output on terminals</b>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]382 -o - Override output filename
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]383 <b>-quiet - Don't print informational messages</b>
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]384 -help - display available options (-help-hidden for more)
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]385</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]386
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]387<p>and "<tt>compiler -help-hidden</tt>" prints this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]388
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]389<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]390USAGE: compiler [options] &lt;input file&gt;
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]391
392OPTIONS:
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]393 -f - Enable binary output on terminals
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]394 -o - Override output filename
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]395 <b>-q - Don't print informational messages</b>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]396 -quiet - Don't print informational messages
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]397 -help - display available options (-help-hidden for more)
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]398</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]399
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]400<p>This brief example has shown you how to use the '<tt><a
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]401href="#cl::opt">cl::opt</a></tt>' class to parse simple scalar command line
402arguments. In addition to simple scalar arguments, the CommandLine library also
403provides primitives to support CommandLine option <a href="#alias">aliases</a>,
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]404and <a href="#list">lists</a> of options.</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]405
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]406</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]407
408<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]409<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]410 <a name="alias">Argument Aliases</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]411</h3>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]412
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]413<div class="doc_text">
414
415<p>So far, the example works well, except for the fact that we need to check the
416quiet condition like this now:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]417
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]418<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]419...
420 if (!Quiet &amp;&amp; !Quiet2) printInformationalMessage(...);
421...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]422</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]423
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]424<p>... which is a real pain! Instead of defining two values for the same
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]425condition, we can use the "<tt><a href="#cl::alias">cl::alias</a></tt>" class to make the "<tt>-q</tt>"
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]426option an <b>alias</b> for the "<tt>-quiet</tt>" option, instead of providing
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]427a value itself:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]428
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]429<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]430<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Overwrite output files</i>"));
431<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet ("<i>quiet</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"));
432<a href="#cl::alias">cl::alias</a> QuietA("<i>q</i>", <a href="#cl::desc">cl::desc</a>("<i>Alias for -quiet</i>"), <a href="#cl::aliasopt">cl::aliasopt</a>(Quiet));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]433</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]434
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]435<p>The third line (which is the only one we modified from above) defines a
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]436"<tt>-q</tt>" alias that updates the "<tt>Quiet</tt>" variable (as specified by
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]437the <tt><a href="#cl::aliasopt">cl::aliasopt</a></tt> modifier) whenever it is
438specified. Because aliases do not hold state, the only thing the program has to
439query is the <tt>Quiet</tt> variable now. Another nice feature of aliases is
440that they automatically hide themselves from the <tt>-help</tt> output
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]441(although, again, they are still visible in the <tt>-help-hidden
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]442output</tt>).</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]443
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]444<p>Now the application code can simply use:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]445
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]446<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]447...
448 if (!Quiet) printInformationalMessage(...);
449...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]450</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]451
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]452<p>... which is much nicer! The "<tt><a href="#cl::alias">cl::alias</a></tt>"
453can be used to specify an alternative name for any variable type, and has many
454uses.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]455
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]456</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]457
458<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]459<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]460 <a name="onealternative">Selecting an alternative from a set of
461 possibilities</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]462</h3>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]463
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]464<div class="doc_text">
465
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]466<p>So far we have seen how the CommandLine library handles builtin types like
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]467<tt>std::string</tt>, <tt>bool</tt> and <tt>int</tt>, but how does it handle
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]468things it doesn't know about, like enums or '<tt>int*</tt>'s?</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]469
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]470<p>The answer is that it uses a table-driven generic parser (unless you specify
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]471your own parser, as described in the <a href="#extensionguide">Extension
Reid Spencera39bf3d2004-08-10 16:38:18 +0000[diff] [blame]472Guide</a>). This parser maps literal strings to whatever type is required, and
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]473requires you to tell it what this mapping should be.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]474
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]475<p>Let's say that we would like to add four optimization levels to our
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]476optimizer, using the standard flags "<tt>-g</tt>", "<tt>-O0</tt>",
477"<tt>-O1</tt>", and "<tt>-O2</tt>". We could easily implement this with boolean
478options like above, but there are several problems with this strategy:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]479
480<ol>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]481<li>A user could specify more than one of the options at a time, for example,
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]482"<tt>compiler -O3 -O2</tt>". The CommandLine library would not be able to
483catch this erroneous input for us.</li>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]484
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]485<li>We would have to test 4 different variables to see which ones are set.</li>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]486
487<li>This doesn't map to the numeric levels that we want... so we cannot easily
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]488see if some level &gt;= "<tt>-O1</tt>" is enabled.</li>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]489
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]490</ol>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]491
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]492<p>To cope with these problems, we can use an enum value, and have the
493CommandLine library fill it in with the appropriate level directly, which is
494used like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]495
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]496<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]497enum OptLevel {
498 g, O1, O2, O3
499};
500
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]501<a href="#cl::opt">cl::opt</a>&lt;OptLevel&gt; OptimizationLevel(<a href="#cl::desc">cl::desc</a>("<i>Choose optimization level:</i>"),
502 <a href="#cl::values">cl::values</a>(
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]503 clEnumVal(g , "<i>No optimizations, enable debugging</i>"),
504 clEnumVal(O1, "<i>Enable trivial optimizations</i>"),
505 clEnumVal(O2, "<i>Enable default optimizations</i>"),
506 clEnumVal(O3, "<i>Enable expensive optimizations</i>"),
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]507 clEnumValEnd));
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]508
509...
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]510 if (OptimizationLevel &gt;= O2) doPartialRedundancyElimination(...);
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]511...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]512</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]513
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]514<p>This declaration defines a variable "<tt>OptimizationLevel</tt>" of the
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]515"<tt>OptLevel</tt>" enum type. This variable can be assigned any of the values
516that are listed in the declaration (Note that the declaration list must be
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]517terminated with the "<tt>clEnumValEnd</tt>" argument!). The CommandLine
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]518library enforces
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]519that the user can only specify one of the options, and it ensure that only valid
520enum values can be specified. The "<tt>clEnumVal</tt>" macros ensure that the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]521command line arguments matched the enum values. With this option added, our
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]522help output now is:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]523
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]524<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]525USAGE: compiler [options] &lt;input file&gt;
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]526
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]527OPTIONS:
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]528 <b>Choose optimization level:
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]529 -g - No optimizations, enable debugging
530 -O1 - Enable trivial optimizations
531 -O2 - Enable default optimizations
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]532 -O3 - Enable expensive optimizations</b>
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]533 -f - Enable binary output on terminals
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]534 -help - display available options (-help-hidden for more)
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]535 -o &lt;filename&gt; - Specify output filename
536 -quiet - Don't print informational messages
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]537</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]538
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]539<p>In this case, it is sort of awkward that flag names correspond directly to
540enum names, because we probably don't want a enum definition named "<tt>g</tt>"
541in our program. Because of this, we can alternatively write this example like
542this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]543
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]544<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]545enum OptLevel {
546 Debug, O1, O2, O3
547};
548
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]549<a href="#cl::opt">cl::opt</a>&lt;OptLevel&gt; OptimizationLevel(<a href="#cl::desc">cl::desc</a>("<i>Choose optimization level:</i>"),
550 <a href="#cl::values">cl::values</a>(
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]551 clEnumValN(Debug, "g", "<i>No optimizations, enable debugging</i>"),
552 clEnumVal(O1 , "<i>Enable trivial optimizations</i>"),
553 clEnumVal(O2 , "<i>Enable default optimizations</i>"),
554 clEnumVal(O3 , "<i>Enable expensive optimizations</i>"),
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]555 clEnumValEnd));
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]556
557...
558 if (OptimizationLevel == Debug) outputDebugInfo(...);
559...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]560</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]561
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]562<p>By using the "<tt>clEnumValN</tt>" macro instead of "<tt>clEnumVal</tt>", we
563can directly specify the name that the flag should get. In general a direct
564mapping is nice, but sometimes you can't or don't want to preserve the mapping,
565which is when you would use it.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]566
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]567</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]568
569<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]570<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]571 <a name="namedalternatives">Named Alternatives</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]572</h3>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]573
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]574<div class="doc_text">
575
576<p>Another useful argument form is a named alternative style. We shall use this
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]577style in our compiler to specify different debug levels that can be used.
578Instead of each debug level being its own switch, we want to support the
579following options, of which only one can be specified at a time:
580"<tt>--debug-level=none</tt>", "<tt>--debug-level=quick</tt>",
581"<tt>--debug-level=detailed</tt>". To do this, we use the exact same format as
582our optimization level flags, but we also specify an option name. For this
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]583case, the code looks like this:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]584
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]585<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]586enum DebugLev {
587 nodebuginfo, quick, detailed
588};
589
590// Enable Debug Options to be specified on the command line
Chris Lattner3b8f3da2003-06-03 04:40:06 +0000[diff] [blame]591<a href="#cl::opt">cl::opt</a>&lt;DebugLev&gt; DebugLevel("<i>debug_level</i>", <a href="#cl::desc">cl::desc</a>("<i>Set the debugging level:</i>"),
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]592 <a href="#cl::values">cl::values</a>(
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]593 clEnumValN(nodebuginfo, "none", "<i>disable debug information</i>"),
594 clEnumVal(quick, "<i>enable quick debug information</i>"),
595 clEnumVal(detailed, "<i>enable detailed debug information</i>"),
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]596 clEnumValEnd));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]597</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]598
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]599<p>This definition defines an enumerated command line variable of type "<tt>enum
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]600DebugLev</tt>", which works exactly the same way as before. The difference here
601is just the interface exposed to the user of your program and the help output by
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]602the "<tt>-help</tt>" option:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]603
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]604<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]605USAGE: compiler [options] &lt;input file&gt;
606
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]607OPTIONS:
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]608 Choose optimization level:
609 -g - No optimizations, enable debugging
610 -O1 - Enable trivial optimizations
611 -O2 - Enable default optimizations
612 -O3 - Enable expensive optimizations
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]613 <b>-debug_level - Set the debugging level:
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]614 =none - disable debug information
615 =quick - enable quick debug information
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]616 =detailed - enable detailed debug information</b>
Dan Gohmandd121d52009-08-25 15:54:01 +0000[diff] [blame]617 -f - Enable binary output on terminals
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]618 -help - display available options (-help-hidden for more)
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]619 -o &lt;filename&gt; - Specify output filename
620 -quiet - Don't print informational messages
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]621</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]622
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]623<p>Again, the only structural difference between the debug level declaration and
John Criswella9f34ca2004-11-21 14:34:34 +0000[diff] [blame]624the optimization level declaration is that the debug level declaration includes
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]625an option name (<tt>"debug_level"</tt>), which automatically changes how the
626library processes the argument. The CommandLine library supports both forms so
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]627that you can choose the form most appropriate for your application.</p>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]628
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]629</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]630
631<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]632<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]633 <a name="list">Parsing a list of options</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]634</h3>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]635
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]636<div class="doc_text">
637
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]638<p>Now that we have the standard run-of-the-mill argument types out of the way,
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]639lets get a little wild and crazy. Lets say that we want our optimizer to accept
640a <b>list</b> of optimizations to perform, allowing duplicates. For example, we
641might want to run: "<tt>compiler -dce -constprop -inline -dce -strip</tt>". In
642this case, the order of the arguments and the number of appearances is very
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]643important. This is what the "<tt><a href="#cl::list">cl::list</a></tt>"
644template is for. First, start by defining an enum of the optimizations that you
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]645would like to perform:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]646
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]647<div class="doc_code"><pre>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]648enum Opts {
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]649 // 'inline' is a C++ keyword, so name it 'inlining'
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]650 dce, constprop, inlining, strip
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]651};
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]652</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]653
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]654<p>Then define your "<tt><a href="#cl::list">cl::list</a></tt>" variable:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]655
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]656<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]657<a href="#cl::list">cl::list</a>&lt;Opts&gt; OptimizationList(<a href="#cl::desc">cl::desc</a>("<i>Available Optimizations:</i>"),
658 <a href="#cl::values">cl::values</a>(
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]659 clEnumVal(dce , "<i>Dead Code Elimination</i>"),
Misha Brukman373086d2003-05-20 21:01:22 +0000[diff] [blame]660 clEnumVal(constprop , "<i>Constant Propagation</i>"),
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]661 clEnumValN(inlining, "<i>inline</i>", "<i>Procedure Integration</i>"),
662 clEnumVal(strip , "<i>Strip Symbols</i>"),
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]663 clEnumValEnd));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]664</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]665
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]666<p>This defines a variable that is conceptually of the type
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]667"<tt>std::vector&lt;enum Opts&gt;</tt>". Thus, you can access it with standard
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]668vector methods:</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]669
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]670<div class="doc_code"><pre>
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]671 for (unsigned i = 0; i != OptimizationList.size(); ++i)
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]672 switch (OptimizationList[i])
673 ...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]674</pre></div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]675
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]676<p>... to iterate through the list of options specified.</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]677
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]678<p>Note that the "<tt><a href="#cl::list">cl::list</a></tt>" template is
679completely general and may be used with any data types or other arguments that
680you can use with the "<tt><a href="#cl::opt">cl::opt</a></tt>" template. One
681especially useful way to use a list is to capture all of the positional
682arguments together if there may be more than one specified. In the case of a
683linker, for example, the linker takes several '<tt>.o</tt>' files, and needs to
684capture them into a list. This is naturally specified as:</p>
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]685
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]686<div class="doc_code"><pre>
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]687...
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]688<a href="#cl::list">cl::list</a>&lt;std::string&gt; InputFilenames(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("&lt;Input files&gt;"), <a href="#cl::OneOrMore">cl::OneOrMore</a>);
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]689...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]690</pre></div>
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]691
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]692<p>This variable works just like a "<tt>vector&lt;string&gt;</tt>" object. As
Chris Lattner2e19f3e2002-07-25 19:27:01 +0000[diff] [blame]693such, accessing the list is simple, just like above. In this example, we used
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]694the <tt><a href="#cl::OneOrMore">cl::OneOrMore</a></tt> modifier to inform the
695CommandLine library that it is an error if the user does not specify any
696<tt>.o</tt> files on our command line. Again, this just reduces the amount of
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]697checking we have to do.</p>
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]698
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]699</div>
Chris Lattner03133252002-04-13 18:35:59 +0000[diff] [blame]700
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]701<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]702<h3>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]703 <a name="bits">Collecting options as a set of flags</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]704</h3>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]705
706<div class="doc_text">
707
708<p>Instead of collecting sets of options in a list, it is also possible to
Dan Gohman42f56912010-02-26 20:18:32 +0000[diff] [blame]709gather information for enum values in a <b>bit vector</b>. The representation used by
Jim Laskeyd6281ce2005-08-26 09:25:54 +0000[diff] [blame]710the <a href="#bits"><tt>cl::bits</tt></a> class is an <tt>unsigned</tt>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]711integer. An enum value is represented by a 0/1 in the enum's ordinal value bit
712position. 1 indicating that the enum was specified, 0 otherwise. As each
713specified value is parsed, the resulting enum's bit is set in the option's bit
714vector:</p>
715
716<div class="doc_code"><pre>
717 <i>bits</i> |= 1 << (unsigned)<i>enum</i>;
718</pre></div>
719
Jim Laskeya82d08f2005-08-25 23:01:25 +0000[diff] [blame]720<p>Options that are specified multiple times are redundant. Any instances after
721the first are discarded.</p>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]722
723<p>Reworking the above list example, we could replace <a href="#list">
724<tt>cl::list</tt></a> with <a href="#bits"><tt>cl::bits</tt></a>:</p>
725
726<div class="doc_code"><pre>
727<a href="#cl::bits">cl::bits</a>&lt;Opts&gt; OptimizationBits(<a href="#cl::desc">cl::desc</a>("<i>Available Optimizations:</i>"),
728 <a href="#cl::values">cl::values</a>(
729 clEnumVal(dce , "<i>Dead Code Elimination</i>"),
730 clEnumVal(constprop , "<i>Constant Propagation</i>"),
731 clEnumValN(inlining, "<i>inline</i>", "<i>Procedure Integration</i>"),
732 clEnumVal(strip , "<i>Strip Symbols</i>"),
733 clEnumValEnd));
734</pre></div>
735
736<p>To test to see if <tt>constprop</tt> was specified, we can use the
737<tt>cl:bits::isSet</tt> function:</p>
738
739<div class="doc_code"><pre>
740 if (OptimizationBits.isSet(constprop)) {
741 ...
742 }
743</pre></div>
744
745<p>It's also possible to get the raw bit vector using the
746<tt>cl::bits::getBits</tt> function:</p>
747
748<div class="doc_code"><pre>
Jim Laskeyd6281ce2005-08-26 09:25:54 +0000[diff] [blame]749 unsigned bits = OptimizationBits.getBits();
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]750</pre></div>
751
752<p>Finally, if external storage is used, then the location specified must be of
Jim Laskeyd6281ce2005-08-26 09:25:54 +0000[diff] [blame]753<b>type</b> <tt>unsigned</tt>. In all other ways a <a
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]754href="#bits"><tt>cl::bits</tt></a> option is equivalent to a <a
Jim Laskeyd6281ce2005-08-26 09:25:54 +0000[diff] [blame]755href="#list"> <tt>cl::list</tt></a> option.</p>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]756
757</div>
758
759
760<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]761<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]762 <a name="description">Adding freeform text to help output</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]763</h3>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]764
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]765<div class="doc_text">
766
767<p>As our program grows and becomes more mature, we may decide to put summary
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]768information about what it does into the help output. The help output is styled
769to look similar to a Unix <tt>man</tt> page, providing concise information about
770a program. Unix <tt>man</tt> pages, however often have a description about what
771the program does. To add this to your CommandLine program, simply pass a third
772argument to the <a
773href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>
774call in main. This additional argument is then printed as the overview
775information for your program, allowing you to include any additional information
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]776that you want. For example:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]777
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]778<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]779int main(int argc, char **argv) {
780 <a href="#cl::ParseCommandLineOptions">cl::ParseCommandLineOptions</a>(argc, argv, " CommandLine compiler example\n\n"
781 " This program blah blah blah...\n");
782 ...
783}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]784</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]785
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]786<p>would yield the help output:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]787
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]788<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]789<b>OVERVIEW: CommandLine compiler example
790
791 This program blah blah blah...</b>
792
793USAGE: compiler [options] &lt;input file&gt;
794
795OPTIONS:
796 ...
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]797 -help - display available options (-help-hidden for more)
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]798 -o &lt;filename&gt; - Specify output filename
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]799</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]800
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]801</div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]802
803
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]804<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]805<h2>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]806 <a name="referenceguide">Reference Guide</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]807</h2>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]808<!-- *********************************************************************** -->
809
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]810<div class="doc_text">
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]811
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]812<p>Now that you know the basics of how to use the CommandLine library, this
813section will give you the detailed information you need to tune how command line
814options work, as well as information on more "advanced" command line option
815processing capabilities.</p>
816
817</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]818
819<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]820<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]821 <a name="positional">Positional Arguments</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]822</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]823
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]824<div class="doc_text">
825
826<p>Positional arguments are those arguments that are not named, and are not
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]827specified with a hyphen. Positional arguments should be used when an option is
828specified by its position alone. For example, the standard Unix <tt>grep</tt>
829tool takes a regular expression argument, and an optional filename to search
830through (which defaults to standard input if a filename is not specified).
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]831Using the CommandLine library, this would be specified as:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]832
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]833<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]834<a href="#cl::opt">cl::opt</a>&lt;string&gt; Regex (<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;regular expression&gt;</i>"), <a href="#cl::Required">cl::Required</a>);
835<a href="#cl::opt">cl::opt</a>&lt;string&gt; Filename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <a href="#cl::init">cl::init</a>("<i>-</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]836</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]837
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]838<p>Given these two option declarations, the <tt>-help</tt> output for our grep
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]839replacement would look like this:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]840
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]841<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]842USAGE: spiffygrep [options] <b>&lt;regular expression&gt; &lt;input file&gt;</b>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]843
844OPTIONS:
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]845 -help - display available options (-help-hidden for more)
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]846</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]847
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]848<p>... and the resultant program could be used just like the standard
849<tt>grep</tt> tool.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]850
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]851<p>Positional arguments are sorted by their order of construction. This means
852that command line options will be ordered according to how they are listed in a
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]853.cpp file, but will not have an ordering defined if the positional arguments
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]854are defined in multiple .cpp files. The fix for this problem is simply to
855define all of your positional arguments in one .cpp file.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]856
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]857</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]858
859
860<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]861<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]862 <a name="--">Specifying positional options with hyphens</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]863</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]864
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]865<div class="doc_text">
866
867<p>Sometimes you may want to specify a value to your positional argument that
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]868starts with a hyphen (for example, searching for '<tt>-foo</tt>' in a file). At
869first, you will have trouble doing this, because it will try to find an argument
870named '<tt>-foo</tt>', and will fail (and single quotes will not save you).
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]871Note that the system <tt>grep</tt> has the same problem:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]872
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]873<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]874 $ spiffygrep '-foo' test.txt
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]875 Unknown command line argument '-foo'. Try: spiffygrep -help'
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]876
877 $ grep '-foo' test.txt
878 grep: illegal option -- f
879 grep: illegal option -- o
880 grep: illegal option -- o
881 Usage: grep -hblcnsviw pattern file . . .
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]882</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]883
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]884<p>The solution for this problem is the same for both your tool and the system
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]885version: use the '<tt>--</tt>' marker. When the user specifies '<tt>--</tt>' on
886the command line, it is telling the program that all options after the
887'<tt>--</tt>' should be treated as positional arguments, not options. Thus, we
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]888can use it like this:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]889
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]890<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]891 $ spiffygrep -- -foo test.txt
892 ...output...
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]893</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]894
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]895</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]896
897<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]898<h4>
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]899 <a name="getPosition">Determining absolute position with getPosition()</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]900</h4>
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]901<div class="doc_text">
902 <p>Sometimes an option can affect or modify the meaning of another option. For
903 example, consider <tt>gcc</tt>'s <tt>-x LANG</tt> option. This tells
904 <tt>gcc</tt> to ignore the suffix of subsequent positional arguments and force
905 the file to be interpreted as if it contained source code in language
Chris Lattner5db870c2008-04-01 18:02:36 +0000[diff] [blame]906 <tt>LANG</tt>. In order to handle this properly, you need to know the
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]907 absolute position of each argument, especially those in lists, so their
908 interaction(s) can be applied correctly. This is also useful for options like
909 <tt>-llibname</tt> which is actually a positional argument that starts with
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]910 a dash.</p>
911 <p>So, generally, the problem is that you have two <tt>cl::list</tt> variables
912 that interact in some way. To ensure the correct interaction, you can use the
913 <tt>cl::list::getPosition(optnum)</tt> method. This method returns the
914 absolute position (as found on the command line) of the <tt>optnum</tt>
915 item in the <tt>cl::list</tt>.</p>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]916 <p>The idiom for usage is like this:</p>
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]917
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]918 <div class="doc_code"><pre>
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]919 static cl::list&lt;std::string&gt; Files(cl::Positional, cl::OneOrMore);
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]920 static cl::list&lt;std::string&gt; Libraries("l", cl::ZeroOrMore);
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]921
922 int main(int argc, char**argv) {
923 // ...
924 std::vector&lt;std::string&gt;::iterator fileIt = Files.begin();
925 std::vector&lt;std::string&gt;::iterator libIt = Libraries.begin();
926 unsigned libPos = 0, filePos = 0;
927 while ( 1 ) {
928 if ( libIt != Libraries.end() )
929 libPos = Libraries.getPosition( libIt - Libraries.begin() );
930 else
931 libPos = 0;
932 if ( fileIt != Files.end() )
933 filePos = Files.getPosition( fileIt - Files.begin() );
934 else
935 filePos = 0;
936
937 if ( filePos != 0 &amp;&amp; (libPos == 0 || filePos &lt; libPos) ) {
938 // Source File Is next
939 ++fileIt;
940 }
941 else if ( libPos != 0 &amp;&amp; (filePos == 0 || libPos &lt; filePos) ) {
942 // Library is next
943 ++libIt;
944 }
945 else
946 break; // we're done with the list
947 }
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]948 }</pre></div>
949
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]950 <p>Note that, for compatibility reasons, the <tt>cl::opt</tt> also supports an
951 <tt>unsigned getPosition()</tt> option that will provide the absolute position
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]952 of that option. You can apply the same approach as above with a
Reid Spencerc0f1b212004-08-13 20:19:14 +0000[diff] [blame]953 <tt>cl::opt</tt> and a <tt>cl::list</tt> option as you can with two lists.</p>
954</div>
955
956<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]957<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]958 <a name="cl::ConsumeAfter">The <tt>cl::ConsumeAfter</tt> modifier</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]959</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]960
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]961<div class="doc_text">
962
963<p>The <tt>cl::ConsumeAfter</tt> <a href="#formatting">formatting option</a> is
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]964used to construct programs that use "interpreter style" option processing. With
965this style of option processing, all arguments specified after the last
966positional argument are treated as special interpreter arguments that are not
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]967interpreted by the command line argument.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]968
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]969<p>As a concrete example, lets say we are developing a replacement for the
970standard Unix Bourne shell (<tt>/bin/sh</tt>). To run <tt>/bin/sh</tt>, first
971you specify options to the shell itself (like <tt>-x</tt> which turns on trace
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]972output), then you specify the name of the script to run, then you specify
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]973arguments to the script. These arguments to the script are parsed by the Bourne
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]974shell command line option processor, but are not interpreted as options to the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]975shell itself. Using the CommandLine library, we would specify this as:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]976
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]977<div class="doc_code"><pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]978<a href="#cl::opt">cl::opt</a>&lt;string&gt; Script(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input script&gt;</i>"), <a href="#cl::init">cl::init</a>("-"));
979<a href="#cl::list">cl::list</a>&lt;string&gt; Argv(<a href="#cl::ConsumeAfter">cl::ConsumeAfter</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;program arguments&gt;...</i>"));
980<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Trace("<i>x</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable trace output</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]981</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]982
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]983<p>which automatically provides the help output:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]984
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]985<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]986USAGE: spiffysh [options] <b>&lt;input script&gt; &lt;program arguments&gt;...</b>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]987
988OPTIONS:
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]989 -help - display available options (-help-hidden for more)
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]990 <b>-x - Enable trace output</b>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]991</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]992
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]993<p>At runtime, if we run our new shell replacement as `<tt>spiffysh -x test.sh
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]994-a -x -y bar</tt>', the <tt>Trace</tt> variable will be set to true, the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]995<tt>Script</tt> variable will be set to "<tt>test.sh</tt>", and the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]996<tt>Argv</tt> list will contain <tt>["-a", "-x", "-y", "bar"]</tt>, because they
997were specified after the last positional argument (which is the script
998name).</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]999
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1000<p>There are several limitations to when <tt>cl::ConsumeAfter</tt> options can
1001be specified. For example, only one <tt>cl::ConsumeAfter</tt> can be specified
1002per program, there must be at least one <a href="#positional">positional
Chris Lattnerb68bd762004-05-06 22:03:59 +0000[diff] [blame]1003argument</a> specified, there must not be any <a href="#cl::list">cl::list</a>
1004positional arguments, and the <tt>cl::ConsumeAfter</tt> option should be a <a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1005href="#cl::list">cl::list</a> option.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1006
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1007</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1008
1009<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1010<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1011 <a name="storage">Internal vs External Storage</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1012</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1013
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1014<div class="doc_text">
1015
1016<p>By default, all command line options automatically hold the value that they
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1017parse from the command line. This is very convenient in the common case,
1018especially when combined with the ability to define command line options in the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1019files that use them. This is called the internal storage model.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1020
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1021<p>Sometimes, however, it is nice to separate the command line option processing
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1022code from the storage of the value parsed. For example, lets say that we have a
1023'<tt>-debug</tt>' option that we would like to use to enable debug information
1024across the entire body of our program. In this case, the boolean value
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1025controlling the debug code should be globally accessible (in a header file, for
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1026example) yet the command line option processing code should not be exposed to
1027all of these clients (requiring lots of .cpp files to #include
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1028<tt>CommandLine.h</tt>).</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1029
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1030<p>To do this, set up your .h file with your option, like this for example:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1031
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1032<div class="doc_code">
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1033<pre>
1034<i>// DebugFlag.h - Get access to the '-debug' command line option
1035//
1036
1037// DebugFlag - This boolean is set to true if the '-debug' command line option
1038// is specified. This should probably not be referenced directly, instead, use
1039// the DEBUG macro below.
1040//</i>
1041extern bool DebugFlag;
1042
1043<i>// DEBUG macro - This macro should be used by code to emit debug information.
1044// In the '-debug' option is specified on the command line, and if this is a
1045// debug build, then the code specified as the option to the macro will be
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1046// executed. Otherwise it will not be.</i>
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1047<span class="doc_hilite">#ifdef NDEBUG
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1048#define DEBUG(X)
1049#else
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1050#define DEBUG(X)</span> do { if (DebugFlag) { X; } } while (0)
1051<span class="doc_hilite">#endif</span>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1052</pre>
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1053</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1054
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1055<p>This allows clients to blissfully use the <tt>DEBUG()</tt> macro, or the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1056<tt>DebugFlag</tt> explicitly if they want to. Now we just need to be able to
1057set the <tt>DebugFlag</tt> boolean when the option is set. To do this, we pass
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1058an additional argument to our command line argument processor, and we specify
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1059where to fill in with the <a href="#cl::location">cl::location</a>
1060attribute:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1061
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1062<div class="doc_code">
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1063<pre>
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1064bool DebugFlag; <i>// the actual value</i>
Chris Lattner76884682003-08-01 21:30:37 +0000[diff] [blame]1065static <a href="#cl::opt">cl::opt</a>&lt;bool, true&gt; <i>// The parser</i>
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1066Debug("<i>debug</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable debug output</i>"), <a href="#cl::Hidden">cl::Hidden</a>, <a href="#cl::location">cl::location</a>(DebugFlag));
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1067</pre>
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1068</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1069
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1070<p>In the above example, we specify "<tt>true</tt>" as the second argument to
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1071the <tt><a href="#cl::opt">cl::opt</a></tt> template, indicating that the
1072template should not maintain a copy of the value itself. In addition to this,
1073we specify the <tt><a href="#cl::location">cl::location</a></tt> attribute, so
1074that <tt>DebugFlag</tt> is automatically set.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1075
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1076</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1077
1078<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1079<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1080 <a name="attributes">Option Attributes</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1081</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1082
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1083<div class="doc_text">
1084
1085<p>This section describes the basic attributes that you can specify on
1086options.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1087
1088<ul>
1089
1090<li>The option name attribute (which is required for all options, except <a
1091href="#positional">positional options</a>) specifies what the option name is.
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1092This option is specified in simple double quotes:
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1093
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1094<pre>
1095<a href="#cl::opt">cl::opt</a>&lt;<b>bool</b>&gt; Quiet("<i>quiet</i>");
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1096</pre>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1097
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1098</li>
1099
1100<li><a name="cl::desc">The <b><tt>cl::desc</tt></b></a> attribute specifies a
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1101description for the option to be shown in the <tt>-help</tt> output for the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1102program.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1103
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1104<li><a name="cl::value_desc">The <b><tt>cl::value_desc</tt></b></a> attribute
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1105specifies a string that can be used to fine tune the <tt>-help</tt> output for
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1106a command line option. Look <a href="#value_desc_example">here</a> for an
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1107example.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1108
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1109<li><a name="cl::init">The <b><tt>cl::init</tt></b></a> attribute specifies an
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1110initial value for a <a href="#cl::opt">scalar</a> option. If this attribute is
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1111not specified then the command line option value defaults to the value created
Brian Gaeke8b89b2b2003-08-19 22:56:22 +0000[diff] [blame]1112by the default constructor for the type. <b>Warning</b>: If you specify both
1113<b><tt>cl::init</tt></b> and <b><tt>cl::location</tt></b> for an option,
1114you must specify <b><tt>cl::location</tt></b> first, so that when the
1115command-line parser sees <b><tt>cl::init</tt></b>, it knows where to put the
1116initial value. (You will get an error at runtime if you don't put them in
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1117the right order.)</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1118
Mikhail Glushenkov132a4712009-06-17 03:09:39 +0000[diff] [blame]1119<li><a name="cl::location">The <b><tt>cl::location</tt></b></a> attribute where
1120to store the value for a parsed command line option if using external storage.
1121See the section on <a href="#storage">Internal vs External Storage</a> for more
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1122information.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1123
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1124<li><a name="cl::aliasopt">The <b><tt>cl::aliasopt</tt></b></a> attribute
Misha Brukmanb139a7d2005-02-09 22:49:05 +0000[diff] [blame]1125specifies which option a <tt><a href="#cl::alias">cl::alias</a></tt> option is
1126an alias for.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1127
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1128<li><a name="cl::values">The <b><tt>cl::values</tt></b></a> attribute specifies
1129the string-to-value mapping to be used by the generic parser. It takes a
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1130<b>clEnumValEnd terminated</b> list of (option, value, description) triplets
Chris Lattner1fbd76e2004-07-16 00:10:54 +0000[diff] [blame]1131that
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1132specify the option name, the value mapped to, and the description shown in the
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1133<tt>-help</tt> for the tool. Because the generic parser is used most
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1134frequently with enum values, two macros are often useful:
1135
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1136<ol>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1137
1138<li><a name="clEnumVal">The <b><tt>clEnumVal</tt></b></a> macro is used as a
1139nice simple way to specify a triplet for an enum. This macro automatically
1140makes the option name be the same as the enum name. The first option to the
1141macro is the enum, the second is the description for the command line
1142option.</li>
1143
1144<li><a name="clEnumValN">The <b><tt>clEnumValN</tt></b></a> macro is used to
1145specify macro options where the option name doesn't equal the enum name. For
1146this macro, the first argument is the enum value, the second is the flag name,
1147and the second is the description.</li>
1148
Mikhail Glushenkov132a4712009-06-17 03:09:39 +0000[diff] [blame]1149</ol>
1150
1151You will get a compile time error if you try to use cl::values with a parser
1152that does not support it.</li>
1153
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000[diff] [blame]1154<li><a name="cl::multi_val">The <b><tt>cl::multi_val</tt></b></a>
1155attribute specifies that this option takes has multiple values
1156(example: <tt>-sectalign segname sectname sectvalue</tt>). This
1157attribute takes one unsigned argument - the number of values for the
1158option. This attribute is valid only on <tt>cl::list</tt> options (and
1159will fail with compile error if you try to use it with other option
1160types). It is allowed to use all of the usual modifiers on
1161multi-valued options (besides <tt>cl::ValueDisallowed</tt>,
1162obviously).</li>
1163
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1164</ul>
1165
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1166</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1167
1168<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1169<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1170 <a name="modifiers">Option Modifiers</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1171</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1172
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1173<div class="doc_text">
1174
1175<p>Option modifiers are the flags and expressions that you pass into the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1176constructors for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
1177href="#cl::list">cl::list</a></tt>. These modifiers give you the ability to
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1178tweak how options are parsed and how <tt>-help</tt> output is generated to fit
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1179your application well.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1180
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1181<p>These options fall into five main categories:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1182
1183<ol>
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1184<li><a href="#hiding">Hiding an option from <tt>-help</tt> output</a></li>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1185<li><a href="#numoccurrences">Controlling the number of occurrences
1186 required and allowed</a></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1187<li><a href="#valrequired">Controlling whether or not a value must be
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1188 specified</a></li>
1189<li><a href="#formatting">Controlling other formatting options</a></li>
1190<li><a href="#misc">Miscellaneous option modifiers</a></li>
1191</ol>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1192
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1193<p>It is not possible to specify two options from the same category (you'll get
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1194a runtime error) to a single option, except for options in the miscellaneous
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1195category. The CommandLine library specifies defaults for all of these settings
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1196that are the most useful in practice and the most common, which mean that you
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1197usually shouldn't have to worry about these.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1198
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1199</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1200
1201<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1202<h4>
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1203 <a name="hiding">Hiding an option from <tt>-help</tt> output</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1204</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1205
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1206<div class="doc_text">
1207
1208<p>The <tt>cl::NotHidden</tt>, <tt>cl::Hidden</tt>, and
1209<tt>cl::ReallyHidden</tt> modifiers are used to control whether or not an option
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1210appears in the <tt>-help</tt> and <tt>-help-hidden</tt> output for the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1211compiled program:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1212
1213<ul>
1214
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1215<li><a name="cl::NotHidden">The <b><tt>cl::NotHidden</tt></b></a> modifier
1216(which is the default for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1217href="#cl::list">cl::list</a></tt> options) indicates the option is to appear
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1218in both help listings.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1219
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1220<li><a name="cl::Hidden">The <b><tt>cl::Hidden</tt></b></a> modifier (which is the
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1221default for <tt><a href="#cl::alias">cl::alias</a></tt> options) indicates that
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1222the option should not appear in the <tt>-help</tt> output, but should appear in
1223the <tt>-help-hidden</tt> output.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1224
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1225<li><a name="cl::ReallyHidden">The <b><tt>cl::ReallyHidden</tt></b></a> modifier
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1226indicates that the option should not appear in any help output.</li>
1227
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1228</ul>
1229
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1230</div>
1231
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1232<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1233<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1234 <a name="numoccurrences">Controlling the number of occurrences required and
1235 allowed</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1236</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1237
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1238<div class="doc_text">
1239
1240<p>This group of options is used to control how many time an option is allowed
1241(or required) to be specified on the command line of your program. Specifying a
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1242value for this setting allows the CommandLine library to do error checking for
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1243you.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1244
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1245<p>The allowed values for this option group are:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1246
1247<ul>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1248
1249<li><a name="cl::Optional">The <b><tt>cl::Optional</tt></b></a> modifier (which
1250is the default for the <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1251href="#cl::alias">cl::alias</a></tt> classes) indicates that your program will
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1252allow either zero or one occurrence of the option to be specified.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1253
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1254<li><a name="cl::ZeroOrMore">The <b><tt>cl::ZeroOrMore</tt></b></a> modifier
1255(which is the default for the <tt><a href="#cl::list">cl::list</a></tt> class)
1256indicates that your program will allow the option to be specified zero or more
1257times.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1258
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1259<li><a name="cl::Required">The <b><tt>cl::Required</tt></b></a> modifier
1260indicates that the specified option must be specified exactly one time.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1261
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1262<li><a name="cl::OneOrMore">The <b><tt>cl::OneOrMore</tt></b></a> modifier
1263indicates that the option must be specified at least one time.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1264
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1265<li>The <b><tt>cl::ConsumeAfter</tt></b> modifier is described in the <a
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1266href="#positional">Positional arguments section</a>.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1267
1268</ul>
1269
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1270<p>If an option is not specified, then the value of the option is equal to the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1271value specified by the <tt><a href="#cl::init">cl::init</a></tt> attribute. If
1272the <tt><a href="#cl::init">cl::init</a></tt> attribute is not specified, the
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1273option value is initialized with the default constructor for the data type.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1274
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1275<p>If an option is specified multiple times for an option of the <tt><a
1276href="#cl::opt">cl::opt</a></tt> class, only the last value will be
1277retained.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1278
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1279</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1280
1281<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1282<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1283 <a name="valrequired">Controlling whether or not a value must be specified</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1284</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1285
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1286<div class="doc_text">
1287
1288<p>This group of options is used to control whether or not the option allows a
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1289value to be present. In the case of the CommandLine library, a value is either
1290specified with an equal sign (e.g. '<tt>-index-depth=17</tt>') or as a trailing
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1291string (e.g. '<tt>-o a.out</tt>').</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1292
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1293<p>The allowed values for this option group are:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1294
1295<ul>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1296
1297<li><a name="cl::ValueOptional">The <b><tt>cl::ValueOptional</tt></b></a> modifier
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1298(which is the default for <tt>bool</tt> typed options) specifies that it is
1299acceptable to have a value, or not. A boolean argument can be enabled just by
1300appearing on the command line, or it can have an explicit '<tt>-foo=true</tt>'.
1301If an option is specified with this mode, it is illegal for the value to be
1302provided without the equal sign. Therefore '<tt>-foo true</tt>' is illegal. To
1303get this behavior, you must use the <a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1304href="#cl::ValueRequired">cl::ValueRequired</a> modifier.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1305
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1306<li><a name="cl::ValueRequired">The <b><tt>cl::ValueRequired</tt></b></a> modifier
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1307(which is the default for all other types except for <a
1308href="#onealternative">unnamed alternatives using the generic parser</a>)
1309specifies that a value must be provided. This mode informs the command line
1310library that if an option is not provides with an equal sign, that the next
1311argument provided must be the value. This allows things like '<tt>-o
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1312a.out</tt>' to work.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1313
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1314<li><a name="cl::ValueDisallowed">The <b><tt>cl::ValueDisallowed</tt></b></a>
1315modifier (which is the default for <a href="#onealternative">unnamed
1316alternatives using the generic parser</a>) indicates that it is a runtime error
1317for the user to specify a value. This can be provided to disallow users from
1318providing options to boolean options (like '<tt>-foo=true</tt>').</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1319
1320</ul>
1321
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1322<p>In general, the default values for this option group work just like you would
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1323want them to. As mentioned above, you can specify the <a
1324href="#cl::ValueDisallowed">cl::ValueDisallowed</a> modifier to a boolean
1325argument to restrict your command line parser. These options are mostly useful
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1326when <a href="#extensionguide">extending the library</a>.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1327
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1328</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1329
1330<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1331<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1332 <a name="formatting">Controlling other formatting options</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1333</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1334
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1335<div class="doc_text">
1336
1337<p>The formatting option group is used to specify that the command line option
1338has special abilities and is otherwise different from other command line
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1339arguments. As usual, you can only specify one of these arguments at most.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1340
1341<ul>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1342
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1343<li><a name="cl::NormalFormatting">The <b><tt>cl::NormalFormatting</tt></b></a>
1344modifier (which is the default all options) specifies that this option is
1345"normal".</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1346
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1347<li><a name="cl::Positional">The <b><tt>cl::Positional</tt></b></a> modifier
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1348specifies that this is a positional argument that does not have a command line
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1349option associated with it. See the <a href="#positional">Positional
1350Arguments</a> section for more information.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1351
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1352<li>The <b><a href="#cl::ConsumeAfter"><tt>cl::ConsumeAfter</tt></a></b> modifier
1353specifies that this option is used to capture "interpreter style" arguments. See <a href="#cl::ConsumeAfter">this section for more information</a>.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1354
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1355<li><a name="cl::Prefix">The <b><tt>cl::Prefix</tt></b></a> modifier specifies
Reid Spencer80bb6932004-11-24 06:13:42 +0000[diff] [blame]1356that this option prefixes its value. With 'Prefix' options, the equal sign does
1357not separate the value from the option name specified. Instead, the value is
1358everything after the prefix, including any equal sign if present. This is useful
1359for processing odd arguments like <tt>-lmalloc</tt> and <tt>-L/usr/lib</tt> in a
Misha Brukman3f2fa8d2005-05-10 22:05:27 +0000[diff] [blame]1360linker tool or <tt>-DNAME=value</tt> in a compiler tool. Here, the
Reid Spencer80bb6932004-11-24 06:13:42 +0000[diff] [blame]1361'<tt>l</tt>', '<tt>D</tt>' and '<tt>L</tt>' options are normal string (or list)
Misha Brukman3f2fa8d2005-05-10 22:05:27 +0000[diff] [blame]1362options, that have the <b><tt><a href="#cl::Prefix">cl::Prefix</a></tt></b>
1363modifier added to allow the CommandLine library to recognize them. Note that
1364<b><tt><a href="#cl::Prefix">cl::Prefix</a></tt></b> options must not have the
1365<b><tt><a href="#cl::ValueDisallowed">cl::ValueDisallowed</a></tt></b> modifier
1366specified.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1367
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1368<li><a name="cl::Grouping">The <b><tt>cl::Grouping</tt></b></a> modifier is used
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1369to implement Unix-style tools (like <tt>ls</tt>) that have lots of single letter
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1370arguments, but only require a single dash. For example, the '<tt>ls -labF</tt>'
1371command actually enables four different options, all of which are single
Misha Brukman3f2fa8d2005-05-10 22:05:27 +0000[diff] [blame]1372letters. Note that <b><tt><a href="#cl::Grouping">cl::Grouping</a></tt></b>
1373options cannot have values.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1374
1375</ul>
1376
Misha Brukman3f2fa8d2005-05-10 22:05:27 +0000[diff] [blame]1377<p>The CommandLine library does not restrict how you use the <b><tt><a
1378href="#cl::Prefix">cl::Prefix</a></tt></b> or <b><tt><a
1379href="#cl::Grouping">cl::Grouping</a></tt></b> modifiers, but it is possible to
1380specify ambiguous argument settings. Thus, it is possible to have multiple
1381letter options that are prefix or grouping options, and they will still work as
1382designed.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1383
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1384<p>To do this, the CommandLine library uses a greedy algorithm to parse the
1385input option into (potentially multiple) prefix and grouping options. The
1386strategy basically looks like this:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1387
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1388<div class="doc_code"><tt>parse(string OrigInput) {</tt>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1389
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1390<ol>
1391<li><tt>string input = OrigInput;</tt>
1392<li><tt>if (isOption(input)) return getOption(input).parse();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// Normal option</i>
1393<li><tt>while (!isOption(input) &amp;&amp; !input.empty()) input.pop_back();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// Remove the last letter</i>
1394<li><tt>if (input.empty()) return error();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// No matching option</i>
1395<li><tt>if (getOption(input).isPrefix())<br>
1396&nbsp;&nbsp;return getOption(input).parse(input);</tt>
1397<li><tt>while (!input.empty()) {&nbsp;&nbsp;&nbsp;&nbsp;<i>// Must be grouping options</i><br>
1398&nbsp;&nbsp;getOption(input).parse();<br>
1399&nbsp;&nbsp;OrigInput.erase(OrigInput.begin(), OrigInput.begin()+input.length());<br>
1400&nbsp;&nbsp;input = OrigInput;<br>
1401&nbsp;&nbsp;while (!isOption(input) &amp;&amp; !input.empty()) input.pop_back();<br>
1402}</tt>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1403<li><tt>if (!OrigInput.empty()) error();</tt></li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1404</ol>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1405
1406<p><tt>}</tt></p>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1407</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1408
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1409</div>
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1410
1411<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1412<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1413 <a name="misc">Miscellaneous option modifiers</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1414</h4>
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1415
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1416<div class="doc_text">
1417
1418<p>The miscellaneous option modifiers are the only flags where you can specify
1419more than one flag from the set: they are not mutually exclusive. These flags
1420specify boolean properties that modify the option.</p>
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1421
1422<ul>
1423
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1424<li><a name="cl::CommaSeparated">The <b><tt>cl::CommaSeparated</tt></b></a> modifier
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1425indicates that any commas specified for an option's value should be used to
1426split the value up into multiple values for the option. For example, these two
1427options are equivalent when <tt>cl::CommaSeparated</tt> is specified:
1428"<tt>-foo=a -foo=b -foo=c</tt>" and "<tt>-foo=a,b,c</tt>". This option only
1429makes sense to be used in a case where the option is allowed to accept one or
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1430more values (i.e. it is a <a href="#cl::list">cl::list</a> option).</li>
1431
Chris Lattnerb68bd762004-05-06 22:03:59 +0000[diff] [blame]1432<li><a name="cl::PositionalEatsArgs">The
1433<b><tt>cl::PositionalEatsArgs</tt></b></a> modifier (which only applies to
1434positional arguments, and only makes sense for lists) indicates that positional
1435argument should consume any strings after it (including strings that start with
1436a "-") up until another recognized positional argument. For example, if you
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1437have two "eating" positional arguments, "<tt>pos1</tt>" and "<tt>pos2</tt>", the
Chris Lattnerb68bd762004-05-06 22:03:59 +0000[diff] [blame]1438string "<tt>-pos1 -foo -bar baz -pos2 -bork</tt>" would cause the "<tt>-foo -bar
1439-baz</tt>" strings to be applied to the "<tt>-pos1</tt>" option and the
1440"<tt>-bork</tt>" string to be applied to the "<tt>-pos2</tt>" option.</li>
1441
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1442<li><a name="cl::Sink">The <b><tt>cl::Sink</tt></b></a> modifier is
1443used to handle unknown options. If there is at least one option with
Benjamin Kramereaccdd32009-08-05 15:42:44 +0000[diff] [blame]1444<tt>cl::Sink</tt> modifier specified, the parser passes
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1445unrecognized option strings to it as values instead of signaling an
Benjamin Kramereaccdd32009-08-05 15:42:44 +0000[diff] [blame]1446error. As with <tt>cl::CommaSeparated</tt>, this modifier
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1447only makes sense with a <a href="#cl::list">cl::list</a> option.</li>
1448
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1449</ul>
1450
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1451<p>So far, these are the only three miscellaneous option modifiers.</p>
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1452
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1453</div>
Chris Lattner7333cc12003-05-22 20:36:06 +0000[diff] [blame]1454
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1455<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1456<h4>
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1457 <a name="response">Response files</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1458</h4>
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1459
1460<div class="doc_text">
1461
1462<p>Some systems, such as certain variants of Microsoft Windows and
1463some older Unices have a relatively low limit on command-line
1464length. It is therefore customary to use the so-called 'response
1465files' to circumvent this restriction. These files are mentioned on
1466the command-line (using the "@file") syntax. The program reads these
1467files and inserts the contents into argv, thereby working around the
1468command-line length limits. Response files are enabled by an optional
1469fourth argument to
1470<a href="#cl::ParseEnvironmentOptions"><tt>cl::ParseEnvironmentOptions</tt></a>
1471and
1472<a href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>.
1473</p>
1474
1475</div>
1476
1477
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1478<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1479<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1480 <a name="toplevel">Top-Level Classes and Functions</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1481</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1482
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1483<div class="doc_text">
1484
1485<p>Despite all of the built-in flexibility, the CommandLine option library
1486really only consists of one function (<a
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1487href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>)
1488and three main classes: <a href="#cl::opt"><tt>cl::opt</tt></a>, <a
1489href="#cl::list"><tt>cl::list</tt></a>, and <a
1490href="#cl::alias"><tt>cl::alias</tt></a>. This section describes these three
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1491classes in detail.</p>
1492
1493</div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1494
1495<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1496<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1497 <a name="cl::ParseCommandLineOptions">The <tt>cl::ParseCommandLineOptions</tt>
1498 function</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1499</h4>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1500
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1501<div class="doc_text">
1502
1503<p>The <tt>cl::ParseCommandLineOptions</tt> function is designed to be called
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1504directly from <tt>main</tt>, and is used to fill in the values of all of the
1505command line option variables once <tt>argc</tt> and <tt>argv</tt> are
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1506available.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1507
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1508<p>The <tt>cl::ParseCommandLineOptions</tt> function requires two parameters
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1509(<tt>argc</tt> and <tt>argv</tt>), but may also take an optional third parameter
1510which holds <a href="#description">additional extra text</a> to emit when the
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1511<tt>-help</tt> option is invoked, and a fourth boolean parameter that enables
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1512<a href="#response">response files</a>.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1513
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1514</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1515
1516<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1517<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1518 <a name="cl::ParseEnvironmentOptions">The <tt>cl::ParseEnvironmentOptions</tt>
1519 function</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1520</h4>
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1521
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1522<div class="doc_text">
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1523
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1524<p>The <tt>cl::ParseEnvironmentOptions</tt> function has mostly the same effects
1525as <a
1526href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>,
1527except that it is designed to take values for options from an environment
1528variable, for those cases in which reading the command line is not convenient or
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1529desired. It fills in the values of all the command line option variables just
1530like <a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1531href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>
1532does.</p>
1533
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1534<p>It takes four parameters: the name of the program (since <tt>argv</tt> may
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1535not be available, it can't just look in <tt>argv[0]</tt>), the name of the
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1536environment variable to examine, the optional
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1537<a href="#description">additional extra text</a> to emit when the
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1538<tt>-help</tt> option is invoked, and the boolean
Benjamin Kramer0f420382009-10-12 14:46:08 +0000[diff] [blame]1539switch that controls whether <a href="#response">response files</a>
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000[diff] [blame]1540should be read.</p>
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1541
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1542<p><tt>cl::ParseEnvironmentOptions</tt> will break the environment
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1543variable's value up into words and then process them using
1544<a href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>.
1545<b>Note:</b> Currently <tt>cl::ParseEnvironmentOptions</tt> does not support
1546quoting, so an environment variable containing <tt>-option "foo bar"</tt> will
1547be parsed as three words, <tt>-option</tt>, <tt>"foo</tt>, and <tt>bar"</tt>,
1548which is different from what you would get from the shell with the same
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1549input.</p>
1550
1551</div>
Brian Gaekef2ea9e02003-08-19 23:11:43 +0000[diff] [blame]1552
1553<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1554<h4>
Reid Spencer0075b2f2006-06-05 17:30:16 +0000[diff] [blame]1555 <a name="cl::SetVersionPrinter">The <tt>cl::SetVersionPrinter</tt>
1556 function</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1557</h4>
Reid Spencer0075b2f2006-06-05 17:30:16 +0000[diff] [blame]1558
1559<div class="doc_text">
1560
1561<p>The <tt>cl::SetVersionPrinter</tt> function is designed to be called
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1562directly from <tt>main</tt> and <i>before</i>
Reid Spencer0075b2f2006-06-05 17:30:16 +0000[diff] [blame]1563<tt>cl::ParseCommandLineOptions</tt>. Its use is optional. It simply arranges
1564for a function to be called in response to the <tt>--version</tt> option instead
1565of having the <tt>CommandLine</tt> library print out the usual version string
1566for LLVM. This is useful for programs that are not part of LLVM but wish to use
1567the <tt>CommandLine</tt> facilities. Such programs should just define a small
1568function that takes no arguments and returns <tt>void</tt> and that prints out
1569whatever version information is appropriate for the program. Pass the address
1570of that function to <tt>cl::SetVersionPrinter</tt> to arrange for it to be
1571called when the <tt>--version</tt> option is given by the user.</p>
1572
1573</div>
1574<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1575<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1576 <a name="cl::opt">The <tt>cl::opt</tt> class</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1577</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1578
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1579<div class="doc_text">
1580
1581<p>The <tt>cl::opt</tt> class is the class used to represent scalar command line
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1582options, and is the one used most of the time. It is a templated class which
1583can take up to three arguments (all except for the first have default values
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1584though):</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1585
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1586<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1587<b>namespace</b> cl {
1588 <b>template</b> &lt;<b>class</b> DataType, <b>bool</b> ExternalStorage = <b>false</b>,
1589 <b>class</b> ParserClass = parser&lt;DataType&gt; &gt;
1590 <b>class</b> opt;
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1591}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1592</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1593
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1594<p>The first template argument specifies what underlying data type the command
1595line argument is, and is used to select a default parser implementation. The
1596second template argument is used to specify whether the option should contain
1597the storage for the option (the default) or whether external storage should be
1598used to contain the value parsed for the option (see <a href="#storage">Internal
1599vs External Storage</a> for more information).</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1600
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1601<p>The third template argument specifies which parser to use. The default value
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1602selects an instantiation of the <tt>parser</tt> class based on the underlying
1603data type of the option. In general, this default works well for most
1604applications, so this option is only used when using a <a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1605href="#customparser">custom parser</a>.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1606
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1607</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1608
1609<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1610<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1611 <a name="cl::list">The <tt>cl::list</tt> class</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1612</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1613
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1614<div class="doc_text">
1615
1616<p>The <tt>cl::list</tt> class is the class used to represent a list of command
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1617line options. It too is a templated class which can take up to three
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1618arguments:</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1619
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1620<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1621<b>namespace</b> cl {
1622 <b>template</b> &lt;<b>class</b> DataType, <b>class</b> Storage = <b>bool</b>,
1623 <b>class</b> ParserClass = parser&lt;DataType&gt; &gt;
1624 <b>class</b> list;
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1625}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1626</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1627
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1628<p>This class works the exact same as the <a
1629href="#cl::opt"><tt>cl::opt</tt></a> class, except that the second argument is
1630the <b>type</b> of the external storage, not a boolean value. For this class,
1631the marker type '<tt>bool</tt>' is used to indicate that internal storage should
1632be used.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1633
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1634</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1635
1636<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1637<h4>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]1638 <a name="cl::bits">The <tt>cl::bits</tt> class</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1639</h4>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]1640
1641<div class="doc_text">
1642
1643<p>The <tt>cl::bits</tt> class is the class used to represent a list of command
1644line options in the form of a bit vector. It is also a templated class which
1645can take up to three arguments:</p>
1646
1647<div class="doc_code"><pre>
1648<b>namespace</b> cl {
1649 <b>template</b> &lt;<b>class</b> DataType, <b>class</b> Storage = <b>bool</b>,
1650 <b>class</b> ParserClass = parser&lt;DataType&gt; &gt;
1651 <b>class</b> bits;
1652}
1653</pre></div>
1654
1655<p>This class works the exact same as the <a
1656href="#cl::opt"><tt>cl::lists</tt></a> class, except that the second argument
Jim Laskeyd6281ce2005-08-26 09:25:54 +0000[diff] [blame]1657must be of <b>type</b> <tt>unsigned</tt> if external storage is used.</p>
Jim Laskey295810d2005-08-25 22:52:43 +0000[diff] [blame]1658
1659</div>
1660
1661<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1662<h4>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1663 <a name="cl::alias">The <tt>cl::alias</tt> class</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1664</h4>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1665
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1666<div class="doc_text">
1667
1668<p>The <tt>cl::alias</tt> class is a nontemplated class that is used to form
1669aliases for other arguments.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1670
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1671<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1672<b>namespace</b> cl {
1673 <b>class</b> alias;
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1674}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1675</pre></div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1676
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1677<p>The <a href="#cl::aliasopt"><tt>cl::aliasopt</tt></a> attribute should be
1678used to specify which option this is an alias for. Alias arguments default to
1679being <a href="#cl::Hidden">Hidden</a>, and use the aliased options parser to do
1680the conversion from string to data.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1681
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1682</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1683
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1684<!-- _______________________________________________________________________ -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1685<h4>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1686 <a name="cl::extrahelp">The <tt>cl::extrahelp</tt> class</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1687</h4>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1688
1689<div class="doc_text">
1690
1691<p>The <tt>cl::extrahelp</tt> class is a nontemplated class that allows extra
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1692help text to be printed out for the <tt>-help</tt> option.</p>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1693
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1694<div class="doc_code"><pre>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1695<b>namespace</b> cl {
1696 <b>struct</b> extrahelp;
1697}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1698</pre></div>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1699
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1700<p>To use the extrahelp, simply construct one with a <tt>const char*</tt>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1701parameter to the constructor. The text passed to the constructor will be printed
1702at the bottom of the help message, verbatim. Note that multiple
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1703<tt>cl::extrahelp</tt> <b>can</b> be used, but this practice is discouraged. If
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1704your tool needs to print additional help information, put all that help into a
1705single <tt>cl::extrahelp</tt> instance.</p>
1706<p>For example:</p>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1707<div class="doc_code"><pre>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1708 cl::extrahelp("\nADDITIONAL HELP:\n\n This is the extra help\n");
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1709</pre></div>
Reid Spencer5e554702004-11-16 06:11:52 +0000[diff] [blame]1710</div>
1711
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1712<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1713<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1714 <a name="builtinparsers">Builtin parsers</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1715</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1716
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1717<div class="doc_text">
1718
1719<p>Parsers control how the string value taken from the command line is
1720translated into a typed value, suitable for use in a C++ program. By default,
1721the CommandLine library uses an instance of <tt>parser&lt;type&gt;</tt> if the
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1722command line option specifies that it uses values of type '<tt>type</tt>'.
1723Because of this, custom option processing is specified with specializations of
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1724the '<tt>parser</tt>' class.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1725
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1726<p>The CommandLine library provides the following builtin parser
1727specializations, which are sufficient for most applications. It can, however,
1728also be extended to work with new data types and new ways of interpreting the
1729same data. See the <a href="#customparser">Writing a Custom Parser</a> for more
1730details on this type of library extension.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1731
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1732<ul>
1733
1734<li><a name="genericparser">The <b>generic <tt>parser&lt;t&gt;</tt> parser</b></a>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1735can be used to map strings values to any data type, through the use of the <a
1736href="#cl::values">cl::values</a> property, which specifies the mapping
1737information. The most common use of this parser is for parsing enum values,
1738which allows you to use the CommandLine library for all of the error checking to
1739make sure that only valid enum values are specified (as opposed to accepting
1740arbitrary strings). Despite this, however, the generic parser class can be used
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1741for any data type.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1742
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1743<li><a name="boolparser">The <b><tt>parser&lt;bool&gt;</tt> specialization</b></a>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1744is used to convert boolean strings to a boolean value. Currently accepted
1745strings are "<tt>true</tt>", "<tt>TRUE</tt>", "<tt>True</tt>", "<tt>1</tt>",
Chris Lattner38751952009-04-08 03:43:51 +0000[diff] [blame]1746"<tt>false</tt>", "<tt>FALSE</tt>", "<tt>False</tt>", and "<tt>0</tt>".</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1747
Dale Johannesen10c5ccc2007-05-22 18:32:34 +0000[diff] [blame]1748<li><a name="boolOrDefaultparser">The <b><tt>parser&lt;boolOrDefault&gt;</tt>
1749 specialization</b></a> is used for cases where the value is boolean,
1750but we also need to know whether the option was specified at all. boolOrDefault
1751is an enum with 3 values, BOU_UNSET, BOU_TRUE and BOU_FALSE. This parser accepts
1752the same strings as <b><tt>parser&lt;bool&gt;</tt></b>.</li>
1753
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1754<li><a name="stringparser">The <b><tt>parser&lt;string&gt;</tt>
1755specialization</b></a> simply stores the parsed string into the string value
1756specified. No conversion or modification of the data is performed.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1757
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1758<li><a name="intparser">The <b><tt>parser&lt;int&gt;</tt> specialization</b></a>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1759uses the C <tt>strtol</tt> function to parse the string input. As such, it will
1760accept a decimal number (with an optional '+' or '-' prefix) which must start
1761with a non-zero digit. It accepts octal numbers, which are identified with a
1762'<tt>0</tt>' prefix digit, and hexadecimal numbers with a prefix of
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1763'<tt>0x</tt>' or '<tt>0X</tt>'.</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1764
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1765<li><a name="doubleparser">The <b><tt>parser&lt;double&gt;</tt></b></a> and
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1766<b><tt>parser&lt;float&gt;</tt> specializations</b> use the standard C
1767<tt>strtod</tt> function to convert floating point strings into floating point
1768values. As such, a broad range of string formats is supported, including
1769exponential notation (ex: <tt>1.7e15</tt>) and properly supports locales.
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1770</li>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1771
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1772</ul>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1773
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1774</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1775
1776<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1777<h2>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1778 <a name="extensionguide">Extension Guide</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1779</h2>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1780<!-- *********************************************************************** -->
1781
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1782<div class="doc_text">
1783
1784<p>Although the CommandLine library has a lot of functionality built into it
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1785already (as discussed previously), one of its true strengths lie in its
1786extensibility. This section discusses how the CommandLine library works under
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1787the covers and illustrates how to do some simple, common, extensions.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1788
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1789</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1790
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1791<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1792<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1793 <a name="customparser">Writing a custom parser</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1794</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1795
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1796<div class="doc_text">
1797
1798<p>One of the simplest and most common extensions is the use of a custom parser.
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1799As <a href="#builtinparsers">discussed previously</a>, parsers are the portion
1800of the CommandLine library that turns string input from the user into a
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1801particular parsed data type, validating the input in the process.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1802
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1803<p>There are two ways to use a new parser:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1804
1805<ol>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1806
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1807<li>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1808
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1809<p>Specialize the <a href="#genericparser"><tt>cl::parser</tt></a> template for
1810your custom data type.<p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1811
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1812<p>This approach has the advantage that users of your custom data type will
1813automatically use your custom parser whenever they define an option with a value
1814type of your data type. The disadvantage of this approach is that it doesn't
Jim Laskey88b5e792006-07-31 20:18:49 +0000[diff] [blame]1815work if your fundamental data type is something that is already supported.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1816
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1817</li>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1818
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1819<li>
1820
1821<p>Write an independent class, using it explicitly from options that need
1822it.</p>
1823
1824<p>This approach works well in situations where you would line to parse an
1825option using special syntax for a not-very-special data-type. The drawback of
1826this approach is that users of your parser have to be aware that they are using
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1827your parser instead of the builtin ones.</p>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1828
1829</li>
1830
1831</ol>
1832
1833<p>To guide the discussion, we will discuss a custom parser that accepts file
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1834sizes, specified with an optional unit after the numeric size. For example, we
1835would like to parse "102kb", "41M", "1G" into the appropriate integer value. In
1836this case, the underlying data type we want to parse into is
1837'<tt>unsigned</tt>'. We choose approach #2 above because we don't want to make
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1838this the default for all <tt>unsigned</tt> options.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1839
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1840<p>To start out, we declare our new <tt>FileSizeParser</tt> class:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1841
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1842<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1843<b>struct</b> FileSizeParser : <b>public</b> cl::basic_parser&lt;<b>unsigned</b>&gt; {
1844 <i>// parse - Return true on error.</i>
1845 <b>bool</b> parse(cl::Option &amp;O, <b>const char</b> *ArgName, <b>const</b> std::string &amp;ArgValue,
1846 <b>unsigned</b> &amp;Val);
1847};
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1848</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1849
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1850<p>Our new class inherits from the <tt>cl::basic_parser</tt> template class to
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1851fill in the default, boiler plate code for us. We give it the data type that
1852we parse into, the last argument to the <tt>parse</tt> method, so that clients of
1853our custom parser know what object type to pass in to the parse method. (Here we
1854declare that we parse into '<tt>unsigned</tt>' variables.)</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1855
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1856<p>For most purposes, the only method that must be implemented in a custom
1857parser is the <tt>parse</tt> method. The <tt>parse</tt> method is called
1858whenever the option is invoked, passing in the option itself, the option name,
1859the string to parse, and a reference to a return value. If the string to parse
Chris Lattner204e4a22008-01-09 19:28:50 +0000[diff] [blame]1860is not well-formed, the parser should output an error message and return true.
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1861Otherwise it should return false and set '<tt>Val</tt>' to the parsed value. In
1862our example, we implement <tt>parse</tt> as:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1863
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1864<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1865<b>bool</b> FileSizeParser::parse(cl::Option &amp;O, <b>const char</b> *ArgName,
1866 <b>const</b> std::string &amp;Arg, <b>unsigned</b> &amp;Val) {
1867 <b>const char</b> *ArgStart = Arg.c_str();
1868 <b>char</b> *End;
Anton Korobeynikov581ba342008-02-20 12:38:31 +0000[diff] [blame]1869
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1870 <i>// Parse integer part, leaving 'End' pointing to the first non-integer char</i>
1871 Val = (unsigned)strtol(ArgStart, &amp;End, 0);
1872
1873 <b>while</b> (1) {
1874 <b>switch</b> (*End++) {
Chris Lattnerd50b29a2005-08-22 16:24:25 +0000[diff] [blame]1875 <b>case</b> 0: <b>return</b> false; <i>// No error</i>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1876 <b>case</b> 'i': <i>// Ignore the 'i' in KiB if people use that</i>
1877 <b>case</b> 'b': <b>case</b> 'B': <i>// Ignore B suffix</i>
1878 <b>break</b>;
1879
1880 <b>case</b> 'g': <b>case</b> 'G': Val *= 1024*1024*1024; <b>break</b>;
1881 <b>case</b> 'm': <b>case</b> 'M': Val *= 1024*1024; <b>break</b>;
1882 <b>case</b> 'k': <b>case</b> 'K': Val *= 1024; <b>break</b>;
1883
1884 default:
1885 <i>// Print an error message if unrecognized character!</i>
Benjamin Kramer666cf9d2009-08-02 12:13:02 +0000[diff] [blame]1886 <b>return</b> O.error("'" + Arg + "' value invalid for file size argument!");
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1887 }
1888 }
1889}
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1890</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1891
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1892<p>This function implements a very simple parser for the kinds of strings we are
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1893interested in. Although it has some holes (it allows "<tt>123KKK</tt>" for
1894example), it is good enough for this example. Note that we use the option
1895itself to print out the error message (the <tt>error</tt> method always returns
1896true) in order to get a nice error message (shown below). Now that we have our
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1897parser class, we can use it like this:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1898
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1899<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1900<b>static</b> <a href="#cl::opt">cl::opt</a>&lt;<b>unsigned</b>, <b>false</b>, FileSizeParser&gt;
1901MFS(<i>"max-file-size"</i>, <a href="#cl::desc">cl::desc</a>(<i>"Maximum file size to accept"</i>),
1902 <a href="#cl::value_desc">cl::value_desc</a>("<i>size</i>"));
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1903</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1904
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1905<p>Which adds this to the output of our program:</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1906
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1907<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1908OPTIONS:
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1909 -help - display available options (-help-hidden for more)
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1910 ...
1911 <b>-max-file-size=&lt;size&gt; - Maximum file size to accept</b>
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1912</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1913
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1914<p>And we can test that our parse works correctly now (the test program just
1915prints out the max-file-size argument value):</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1916
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1917<div class="doc_code"><pre>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1918$ ./test
1919MFS: 0
1920$ ./test -max-file-size=123MB
1921MFS: 128974848
1922$ ./test -max-file-size=3G
1923MFS: 3221225472
1924$ ./test -max-file-size=dog
1925-max-file-size option: 'dog' value invalid for file size argument!
Misha Brukman922bf922005-03-11 00:00:33 +0000[diff] [blame]1926</pre></div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1927
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1928<p>It looks like it works. The error message that we get is nice and helpful,
1929and we seem to accept reasonable file sizes. This wraps up the "custom parser"
1930tutorial.</p>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1931
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1932</div>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1933
1934<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1935<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1936 <a name="explotingexternal">Exploiting external storage</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1937</h3>
Chris Lattner74ea5a62002-08-07 18:27:04 +0000[diff] [blame]1938
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1939<div class="doc_text">
Reid Spencercf2bc3d2004-08-30 05:56:51 +0000[diff] [blame]1940 <p>Several of the LLVM libraries define static <tt>cl::opt</tt> instances that
1941 will automatically be included in any program that links with that library.
1942 This is a feature. However, sometimes it is necessary to know the value of the
1943 command line option outside of the library. In these cases the library does or
1944 should provide an external storage location that is accessible to users of the
1945 library. Examples of this include the <tt>llvm::DebugFlag</tt> exported by the
1946 <tt>lib/Support/Debug.cpp</tt> file and the <tt>llvm::TimePassesIsEnabled</tt>
1947 flag exported by the <tt>lib/VMCore/Pass.cpp</tt> file.</p>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1948
Reid Spencercf2bc3d2004-08-30 05:56:51 +0000[diff] [blame]1949<p>TODO: complete this section</p>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1950
1951</div>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1952
1953<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1954<h3>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1955 <a name="dynamicopts">Dynamically adding command line options</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1956</h3>
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1957
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1958<div class="doc_text">
Chris Lattner50761292002-08-06 19:36:06 +0000[diff] [blame]1959
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1960<p>TODO: fill in this section</p>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1961
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1962</div>
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1963
Chris Lattnerba025252001-07-23 23:03:12 +0000[diff] [blame]1964<!-- *********************************************************************** -->
1965
1966<hr>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1967<address>
1968 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]1969 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1970 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]1971 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1972
1973 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]1974 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman7120c832003-11-07 18:11:14 +0000[diff] [blame]1975 Last modified: $Date$
Misha Brukman374258e2004-05-12 18:42:35 +0000[diff] [blame]1976</address>
Misha Brukmanc86e8b12003-10-24 19:59:21 +0000[diff] [blame]1977
1978</body>
1979</html>