(Support) Moved some command-line parsing functions

API-Breaking change

* The high-level command-line parsing functions intended for ROSE
  tools have been moved out of ::CommandlineProcessing and into
  ::Rose::CommandLine.

* This moves those functions out of libroseutil and into librose.

* This allows those functions to call other functions in librose
  in order validate command-lines, provide suggestions, and
  generate documentation.

To fix your code:

1) #include <CommandLine.h> // a ROSE header file

2) Change "CommandlineProcessing" to "Rose::CommandLine", but
   only for those few things that have been moved. They are:

    createEmptyParser
    createEmptyParserStage
    genericSwitches
    genericSwitchArgs
    insertBooleanSwitch

projects/BinFuncDetect/compareResults.C

@@ -2,6 +2,7 @@
 
 #include <AsmUnparser.h>
 #include <cstring>
+#include <CommandLine.h>
 #include <Diagnostics.h>
 #include <FileSystem.h>
 #include <iostream>
@@ -38,7 +39,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  .purpose("compares disassembler results")
  .version(std::string(ROSE_SCM_VERSION_ID).substr(0, 8), ROSE_CONFIGURE_DATE)
  .chapter(1, "ROSE Command-line Tools")
- .with(CommandlineProcessing::genericSwitches())
+ .with(Rose::CommandLine::genericSwitches())
  .doc("synopsis",
  "@prop{programName} [@v{switches}] @v{csv1} @v{csv2}")
  .doc("description",

projects/BinaryAnalysisTools/PathFinder/findPath.C

@@ -10,6 +10,7 @@
 #include <boost/thread/locks.hpp>
 #include <boost/thread/mutex.hpp>
 #include <boost/thread/thread.hpp>
+#include <CommandLine.h>
 #include <Diagnostics.h>
 #include <DwarfLineMapper.h>
 #include <Partitioner2/CfgPath.h>
@@ -598,7 +599,7 @@ buildVirtualCpu(const P2::Partitioner &partitioner) {
  }
  }
 
- SmtSolver *solver = SmtSolver::instance(CommandlineProcessing::genericSwitchArgs.smtSolver);
+ SmtSolver *solver = SmtSolver::instance(Rose::CommandLine::genericSwitchArgs.smtSolver);
  RiscOperatorsPtr ops = RiscOperators::instance(&partitioner, myRegs, solver);
 
  return partitioner.instructionProvider().dispatcher()->create(ops);

projects/BinaryAnalysisTools/bROwSE/Application.C

@@ -15,6 +15,7 @@
 #include <bROwSE/WSplash.h>
 #include <bROwSE/WStatus.h>
 #include <bROwSE/WStrings.h>
+#include <CommandLine.h> // ROSE
 #include <Disassembler.h> // ROSE
 #include <Partitioner2/Engine.h> // ROSE
 #include <Partitioner2/Modules.h> // ROSE
@@ -52,7 +53,7 @@ Application::parseCommandLine(int argc, char *argv[], Settings &settings)
  using namespace Sawyer::CommandLine;
 
  // Generic switches
- SwitchGroup gen = CommandlineProcessing::genericSwitches();
+ SwitchGroup gen = Rose::CommandLine::genericSwitches();
  gen.insert(Switch("config")
  .argument("names", listParser(anyParser(settings.configurationNames), ":"))
  .whichValue(SAVE_ALL)

projects/BinaryAnalysisTools/debugSemantics.C

@@ -5,6 +5,7 @@
 #include <BinaryNoOperation.h>
 #include <BinaryYicesSolver.h>
 #include <BinaryZ3Solver.h>
+#include <CommandLine.h>
 #include <ConcreteSemantics2.h>
 #include <Diagnostics.h>
 #include <Disassembler.h>
@@ -249,7 +250,7 @@ parseCommandLine(int argc, char *argv[], P2::Engine &engine, Settings &settings)
 
 static SmtSolver *
 makeSolver(const Settings &settings) {
- return SmtSolver::instance(CommandlineProcessing::genericSwitchArgs.smtSolver);
+ return SmtSolver::instance(Rose::CommandLine::genericSwitchArgs.smtSolver);
 }
 
 static BaseSemantics::SValuePtr

projects/BinaryAnalysisTools/findSimilarFunctions.C

@@ -1,5 +1,6 @@
 #include <rose.h>
 
+#include <CommandLine.h>
 #include <Disassembler.h>
 #include <EditDistance/TreeEditDistance.h>
 #include <EditDistance/LinearEditDistance.h>
@@ -418,9 +419,9 @@ main(int argc, char *argv[]) {
  // Parse command-line
  P2::Engine engine;
  Settings settings;
- CommandlineProcessing::genericSwitchArgs.threads = 0; // we want multi-threading by default
+ Rose::CommandLine::genericSwitchArgs.threads = 0; // we want multi-threading by default
  std::vector<std::string> positionalArgs = parseCommandLine(argc, argv, engine, settings);
- size_t nThreads = CommandlineProcessing::genericSwitchArgs.threads;
+ size_t nThreads = Rose::CommandLine::genericSwitchArgs.threads;
  if (0 == nThreads)
  nThreads = boost::thread::hardware_concurrency();
 

projects/BinaryAnalysisTools/generatePaths.C

@@ -1,5 +1,6 @@
 #include <rose.h>
 
+#include <CommandLine.h> // ROSE
 #include "integerOps.h"
 
 #include <iostream>
@@ -28,7 +29,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  "Generates a program, written in C, on standard output, that has a certain structure specified by the "
  "command-line switches described here.");
 
- SwitchGroup gen = CommandlineProcessing::genericSwitches();
+ SwitchGroup gen = Rose::CommandLine::genericSwitches();
  gen.insert(Switch("tree-depth", 't')
  .argument("n", nonNegativeIntegerParser(settings.binaryTreeDepth))
  .doc("Width in bits of the 'if' tree."));

projects/BinaryAnalysisTools/maxBijection.C

@@ -1,6 +1,7 @@
 #include "rose.h"
 #include "rose_getline.h"
 #include "rose_strtoull.h"
+#include <CommandLine.h> // ROSE
 #include "Diagnostics.h"
 #include "integerOps.h"
 #include <Sawyer/CommandLine.h>
@@ -21,7 +22,7 @@ struct Settings {
 static Sawyer::CommandLine::ParserResult
 parseCommandLine(int argc, char *argv[], Settings &settings) {
  using namespace Sawyer::CommandLine;
- SwitchGroup generic = CommandlineProcessing::genericSwitches();
+ SwitchGroup generic = Rose::CommandLine::genericSwitches();
 
  SwitchGroup tool("Tool-specific switches");
  tool.insert(Switch("width")

projects/BinaryAnalysisTools/symbolicSimplifier.C

@@ -1,5 +1,6 @@
 #include <rose.h>
 #include <rosePublicConfig.h>
+#include <CommandLine.h>
 #include <Sawyer/CommandLine.h>
 #include <BinarySymbolicExprParser.h>
 
@@ -52,7 +53,7 @@ parseCommandLine(int argc, char *argv[], bool &testSerialization /*in,out*/) {
  "Parses symbolic expressions from standard input and prints the resulting expression trees. These trees "
  "undergo basic simplifications in ROSE before they're printed.")
  .doc("Symbolic expression syntax", symbolicParser().docString())
- .with(CommandlineProcessing::genericSwitches())
+ .with(Rose::CommandLine::genericSwitches())
  .with(tool);
 
  if (!parser.parse(argc, argv).apply().unreachedArgs().empty())

projects/BinaryAnalysisTools/xml2json.C

@@ -4,6 +4,7 @@ static const char *description =
  "by the ROSE binary analysis state serialization.";
 
 #include <rose.h> // Must be first ROSE include file
+#include <CommandLine.h>
 #include <Diagnostics.h> // ROSE
 
 #include <boost/algorithm/string/classification.hpp>
@@ -39,15 +40,15 @@ parseCommandLine(int argc, char *argv[]) {
  using namespace Sawyer::CommandLine;
  Settings retval;
 
- Parser p = /*Rose*/::CommandlineProcessing::createEmptyParser(purpose, description);
- p.with(/*Rose*/::CommandlineProcessing::genericSwitches());
+ Parser p = Rose::CommandLine::createEmptyParser(purpose, description);
+ p.with(Rose::CommandLine::genericSwitches());
  p.doc("Synopsis", "@prop{programName} [@v{switches}] @v{xml_input_file} @v{json_output_file}");
  p.errorStream(mlog[FATAL]);
  SwitchGroup tool("Tool-specific switches");
  tool.name("tool");
 
 #ifdef XML2JSON_SUPPORT_CHECK
- /*Rose*/::CommandlineProcessing::insertBooleanSwitch(tool, "check", retval.check, "Perform extra input checking.");
+ Rose::CommandLine::insertBooleanSwitch(tool, "check", retval.check, "Perform extra input checking.");
 #endif
 
  tool.insert(Switch("delete")

projects/BinaryCloneDetection/semantic/runRandom.C

@@ -6,6 +6,7 @@
 
 #include <BinaryDebugger.h>
 #include <Combinatorics.h>
+#include <CommandLine.h>
 #include <Partitioner2/Engine.h>
 #include <rose_strtoull.h>
 
@@ -51,7 +52,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings)
  using namespace Sawyer::CommandLine;
 
  // Generic switches
- SwitchGroup gen = CommandlineProcessing::genericSwitches();
+ SwitchGroup gen = Rose::CommandLine::genericSwitches();
 
  // Switches for this tool
  SwitchGroup tool("Tool-specific switches");

projects/EditDistanceMetric/astDiff.C

@@ -8,6 +8,7 @@
 // the integer order of visit).
 
 #include <rose.h>
+#include <CommandLine.h>
 #include <EditDistance/TreeEditDistance.h>
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Stopwatch.h>
@@ -29,7 +30,7 @@ using namespace Rose;
 Sawyer::CommandLine::ParserResult
 parseCommandLine(int argc, char *argv[], Settings &settings) {
  using namespace Sawyer::CommandLine;
- SwitchGroup gen = CommandlineProcessing::genericSwitches();
+ SwitchGroup gen = Rose::CommandLine::genericSwitches();
  SwitchGroup tool = toolCommandLineSwitches(settings);
 
  Parser parser;

projects/MatrixTesting/matrixAttachments.C

@@ -1,6 +1,7 @@
 #include <rose.h>
 
 #include <boost/foreach.hpp>
+#include <CommandLine.h> // from ROSE
 #include <FileSystem.h> // from ROSE
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Message.h>
@@ -74,7 +75,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  "like normal, but the final COMMIT is skipped, causing the database to roll back to its initial "
  "state."));
 
- return parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
+ return parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
 }
 
 static bool

projects/MatrixTesting/matrixDeleteTest.C

@@ -2,6 +2,7 @@
 
 #include <boost/foreach.hpp>
 #include <boost/lexical_cast.hpp>
+#include <CommandLine.h>
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Message.h>
 #include <SqlDatabase.h>
@@ -46,7 +47,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  .argument("uri", anyParser(settings.databaseUri))
  .doc("Uniform resource locator for the database." + SqlDatabase::uriDocumentation()));
 
- return parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
+ return parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
 }
 
 int

projects/MatrixTesting/matrixErrors.C

@@ -4,6 +4,7 @@
 #include <boost/algorithm/string/split.hpp>
 #include <boost/algorithm/string/trim.hpp>
 #include <boost/foreach.hpp>
+#include <CommandLine.h>
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Message.h>
 #include <SqlDatabase.h>
@@ -77,7 +78,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  .intrinsicValue(true, settings.latestTests)
  .doc("Operate on only the latest version of ROSE in the database."));
 
- return parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
+ return parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
 }
 
 // Render Unix time as a string when printing a database table

projects/MatrixTesting/matrixNextTest.C

@@ -4,6 +4,7 @@
 #include <boost/algorithm/string/join.hpp>
 #include <boost/foreach.hpp>
 #include <boost/regex.hpp>
+#include <CommandLine.h>
 #include <cstring>
 #include <LinearCongruentialGenerator.h>
 #include <Sawyer/CommandLine.h>
@@ -64,7 +65,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  " @named{shell}{Output one line of space-separated key=value pairs.}"
  " @named{overrides}{Output entire configuration space as shell OVERRIDE variables.}"));
 
- if (!parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs().empty()) {
+ if (!parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs().empty()) {
  mlog[FATAL] <<"invalid usage; see --help\n";
  exit(1);
  }

projects/MatrixTesting/matrixQueryTable.C

@@ -2,6 +2,7 @@
 
 #include <boost/algorithm/string/trim.hpp>
 #include <boost/foreach.hpp>
+#include <CommandLine.h>
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Map.h>
 #include <Sawyer/Message.h>
@@ -49,7 +50,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  .argument("uri", anyParser(settings.databaseUri))
  .doc("URI specifying which database to use." + SqlDatabase::uriDocumentation()));
 
- return parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
+ return parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
 }
 
 typedef Sawyer::Container::Map<std::string /*key*/, std::string /*colname*/> DependencyNames;

projects/MatrixTesting/matrixTestResult.C

@@ -2,6 +2,7 @@
 
 #include <boost/algorithm/string/trim.hpp>
 #include <boost/foreach.hpp>
+#include <CommandLine.h>
 #include <cstdio>
 #include <cstring>
 #include <LinearCongruentialGenerator.h>
@@ -70,7 +71,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
  "like normal, but the final COMMIT is skipped, causing the database to roll back to its initial "
  "state."));
 
- return parser.with(CommandlineProcessing::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
+ return parser.with(Rose::CommandLine::genericSwitches()).with(sg).parse(argc, argv).apply().unreachedArgs();
 }
 
 typedef Sawyer::Container::Map<std::string /*key*/, std::string /*colname*/> DependencyNames;

projects/SnippetTools/roseDiff.C

@@ -1,4 +1,5 @@
 #include <rose.h>
+#include <CommandLine.h>
 #include <FileSystem.h>
 
 #include <Sawyer/CommandLine.h>
@@ -26,7 +27,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings /*in,out*/) {
  .doc("description",
  "Scans the two specified directories and creates a recursive, unified diff of the ROSE-generated files "
  "in those directories.")
- .with(CommandlineProcessing::genericSwitches());
+ .with(Rose::CommandLine::genericSwitches());
 
  return parser.parse(argc, argv).apply();
 }

projects/SnippetTools/rosePatch.C

@@ -1,5 +1,6 @@
 #include <rose.h>
 
+#include <CommandLine.h>
 #include <FileSystem.h>
 #include <Sawyer/CommandLine.h>
 #include <Sawyer/Message.h>
@@ -25,7 +26,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings /*in,out*/) {
  .purpose("applies ROSE patches on the fly")
  .version(std::string(ROSE_SCM_VERSION_ID).substr(0, 8), ROSE_CONFIGURE_DATE)
  .chapter(1, "ROSE Command-line Tools")
- .with(CommandlineProcessing::genericSwitches())
+ .with(Rose::CommandLine::genericSwitches())
  .doc("Synopsis",
  "@prop{programName} --identity=@v{directory} --translated=@v{directory} --top=@v{directory} "
  "-- @v{compiler_arguments}")

projects/autoParallelization/autoPar.C

@@ -220,12 +220,12 @@ Sawyer::CommandLine::SwitchGroup commandLineSwitches() {
 static std::vector<std::string> commandline_processing(std::vector< std::string > & argvList)
 {
  using namespace Sawyer::CommandLine;
- Parser p = CommandlineProcessing::createEmptyParserStage(purpose, description);
+ Parser p = Rose::CommandLine::createEmptyParserStage(purpose, description);
  p.doc("Synopsis", "@prop{programName} @v{switches} @v{files}...");
  p.longPrefix("-");
 
 // initialize generic Sawyer switches: assertion, logging, threads, etc.
- p.with(CommandlineProcessing::genericSwitches()); 
+ p.with(Rose::CommandLine::genericSwitches()); 
 
 // initialize this tool's switches
  p.with(commandLineSwitches()); 

projects/simulator2/demos/ports_opened.C

@@ -13,6 +13,7 @@
 // The following stuff is mostly cut-n-pasted from x86sim.C with minor modifications to the documentation.
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+#include <CommandLine.h> // ROSE command-line
 #include <Diagnostics.h> // ROSE diagnostics
 #include <RSIM_Debugger.h> // Simulator interactive debugger
 #include <RSIM_Linux32.h> // Simulator architecture: Linux-x86
@@ -148,7 +149,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
 
  return parser
  .errorStream(::mlog[FATAL])
- .with(CommandlineProcessing::genericSwitches())
+ .with(Rose::CommandLine::genericSwitches())
  .with(sg) // tool-specific
  .with(RSIM_Simulator::commandLineSwitches(settings.simSettings))
  .parse(argc, argv).apply().unreachedArgs();

projects/simulator2/x86sim.C

@@ -7,6 +7,7 @@
 #include <RSIM_Private.h>
 #ifdef ROSE_ENABLE_SIMULATOR /* protects this whole file */
 
+#include <CommandLine.h> // ROSE command-line
 #include <RSIM_Debugger.h> // Interactive debugger for the simulator
 #include <RSIM_ColdFire.h> // FreeScale ColdFire/m68k naked hardware simulator
 #include <RSIM_Linux32.h> // Operating system simulation for Linux-x86
@@ -151,7 +152,7 @@ parseCommandLine(int argc, char *argv[], Settings &settings) {
 
  return parser
  .errorStream(::mlog[FATAL])
- .with(CommandlineProcessing::genericSwitches())
+ .with(Rose::CommandLine::genericSwitches())
  .with(sg) // tool-specific
  .with(RSIM_Simulator::commandLineSwitches(settings.simSettings))
  .parse(argc, argv).apply().unreachedArgs();

src/ROSETTA/Grammar/Node.code

@@ -16,6 +16,7 @@ HEADER_NODE_PREDECLARATION_START
 #include <boost/serialization/vector.hpp>
 #include <boost/unordered_map.hpp>
 #include <boost/unordered_set.hpp>
+#include <Sawyer/CommandLine.h>
 #include <Sawyer/Interval.h>
 #include <Sawyer/IntervalSet.h>