CbC/CbC_llvm: docs/CommandLine.rst comparison

comparison docs/CommandLine.rst @ 120:1172e4bd9c6f

update 4.0.0

author	mir3636
date	Fri, 25 Nov 2016 19:14:25 +0900
parents	afa8332a0e37
children	803732b1fca8

comparison

equal deleted inserted replaced

-:34baf5011add
+:1172e4bd9c6f
 cl::opt<OptLevel> OptimizationLevel(cl::desc("Choose optimization level:"),
 cl::values(
 clEnumVal(g , "No optimizations, enable debugging"),
 clEnumVal(O1, "Enable trivial optimizations"),
 clEnumVal(O2, "Enable default optimizations"),
-clEnumVal(O3, "Enable expensive optimizations"),
+clEnumVal(O3, "Enable expensive optimizations")));
-clEnumValEnd));
 ...
 if (OptimizationLevel >= O2) doPartialRedundancyElimination(...);
 ...
 This declaration defines a variable "``OptimizationLevel``" of the
 "``OptLevel``" enum type.  This variable can be assigned any of the values that
-are listed in the declaration (Note that the declaration list must be terminated
+are listed in the declaration.  The CommandLine library enforces that
-with the "``clEnumValEnd``" argument!).  The CommandLine library enforces that
 the user can only specify one of the options, and it ensure that only valid enum
 values can be specified.  The "``clEnumVal``" macros ensure that the command
 line arguments matched the enum values.  With this option added, our help output
 now is:
 cl::opt<OptLevel> OptimizationLevel(cl::desc("Choose optimization level:"),
 cl::values(
 clEnumValN(Debug, "g", "No optimizations, enable debugging"),
 clEnumVal(O1        , "Enable trivial optimizations"),
 clEnumVal(O2        , "Enable default optimizations"),
-clEnumVal(O3        , "Enable expensive optimizations"),
+clEnumVal(O3        , "Enable expensive optimizations")));
-clEnumValEnd));
 ...
 if (OptimizationLevel == Debug) outputDebugInfo(...);
 ...
 // Enable Debug Options to be specified on the command line
 cl::opt<DebugLev> DebugLevel("debug_level", cl::desc("Set the debugging level:"),
 cl::values(
 clEnumValN(nodebuginfo, "none", "disable debug information"),
 clEnumVal(quick,               "enable quick debug information"),
-clEnumVal(detailed,            "enable detailed debug information"),
+clEnumVal(detailed,            "enable detailed debug information")));
-clEnumValEnd));
 This definition defines an enumerated command line variable of type "``enum
 DebugLev``", which works exactly the same way as before.  The difference here is
 just the interface exposed to the user of your program and the help output by
 the "``-help``" option:
 cl::list<Opts> OptimizationList(cl::desc("Available Optimizations:"),
 cl::values(
 clEnumVal(dce               , "Dead Code Elimination"),
 clEnumVal(constprop         , "Constant Propagation"),
 clEnumValN(inlining, "inline", "Procedure Integration"),
-clEnumVal(strip             , "Strip Symbols"),
+clEnumVal(strip             , "Strip Symbols")));
-clEnumValEnd));
 This defines a variable that is conceptually of the type
 "``std::vector<enum Opts>``".  Thus, you can access it with standard vector
 methods:
 cl::bits<Opts> OptimizationBits(cl::desc("Available Optimizations:"),
 cl::values(
 clEnumVal(dce               , "Dead Code Elimination"),
 clEnumVal(constprop         , "Constant Propagation"),
 clEnumValN(inlining, "inline", "Procedure Integration"),
-clEnumVal(strip             , "Strip Symbols"),
+clEnumVal(strip             , "Strip Symbols")));
-clEnumValEnd));
 To test to see if ``constprop`` was specified, we can use the ``cl:bits::isSet``
 function:
 .. code-block:: c++
 an alias for.
 .. _cl::values:
 * The **cl::values** attribute specifies the string-to-value mapping to be used
-by the generic parser.  It takes a **clEnumValEnd terminated** list of
+by the generic parser.  It takes a list of (option, value, description)
-(option, value, description) triplets that specify the option name, the value
+triplets that specify the option name, the value mapped to, and the
-mapped to, and the description shown in the ``-help`` for the tool.  Because
+description shown in the ``-help`` for the tool.  Because the generic parser
-the generic parser is used most frequently with enum values, two macros are
+is used most frequently with enum values, two macros are often useful:
-often useful:
 #. The **clEnumVal** macro is used as a nice simple way to specify a triplet
 for an enum.  This macro automatically makes the option name be the same as
 the enum name.  The first option to the macro is the enum, the second is
 the description for the command line option.
 using namespace llvm;
 int main(int argc, char **argv) {
 cl::OptionCategory AnotherCategory("Some options");
-StringMap<cl::Option*> Map;
+StringMap<cl::Option*> &Map = cl::getRegisteredOptions();
-cl::getRegisteredOptions(Map);
 //Unhide useful option and put it in a different category
 assert(Map.count("print-all-options") > 0);
 Map["print-all-options"]->setHiddenFlag(cl::NotHidden);
 Map["print-all-options"]->setCategory(AnotherCategory);

Mercurial > hg > CbC > CbC_llvm

comparison docs/CommandLine.rst @ 120:1172e4bd9c6f