diff --git a/changelog.in b/changelog.in index 8a4a3bbf84..1c416a0cc8 100755 --- a/changelog.in +++ b/changelog.in @@ -75,6 +75,27 @@ Date: unreleased [DESCRIPTION] This is the development changelog for the next Gecode release. +[ENTRY] +Module: driver +What: new +Rank: minor +Issue: 144 +[DESCRIPTION] +Options support opt-in strict parsing through parse_strict(), which reports +unrecognised arguments, prints help, and exits with failure. The named methods +parse_strict() and parse_permissive() select the strictness of parse(). Existing +parsing calls retain their behaviour. Examples that accept only named options +use strict parsing. +Strict parsing will become the default in a future major release. + +[ENTRY] +Module: example +What: bug +Rank: minor +[DESCRIPTION] +Fix duplicate registration of EFPA's symmetry option, which hid its other +command-line options. + [ENTRY] Module: search What: bug diff --git a/examples/alpha.cpp b/examples/alpha.cpp index e88bdf216e..1da09cbf9e 100644 --- a/examples/alpha.cpp +++ b/examples/alpha.cpp @@ -139,7 +139,7 @@ main(int argc, char* argv[]) { opt.branching(Alpha::BRANCH_NONE, "none"); opt.branching(Alpha::BRANCH_INVERSE, "inverse"); opt.branching(Alpha::BRANCH_SIZE, "size"); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/archimedean-spiral.cpp b/examples/archimedean-spiral.cpp index 8a8261b341..3529adc1ec 100644 --- a/examples/archimedean-spiral.cpp +++ b/examples/archimedean-spiral.cpp @@ -115,7 +115,7 @@ int main(int argc, char* argv[]) { Options opt("ArchimedeanSpiral"); opt.solutions(0); opt.step(0.1); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); FloatMaximizeScript::run(opt); return 0; } diff --git a/examples/cartesian-heart.cpp b/examples/cartesian-heart.cpp index 1ff50f298c..f941497470 100644 --- a/examples/cartesian-heart.cpp +++ b/examples/cartesian-heart.cpp @@ -109,7 +109,7 @@ int main(int argc, char* argv[]) { Options opt("CartesianHeart"); opt.solutions(0); opt.step(0.01); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/colored-matrix.cpp b/examples/colored-matrix.cpp index dad2a8392b..ab9985e017 100755 --- a/examples/colored-matrix.cpp +++ b/examples/colored-matrix.cpp @@ -68,7 +68,7 @@ class ColoredMatrixOptions : public Options { /// Parse options from arguments \a argv (number is \a argc) void parse(int& argc, char* argv[]) { - Options::parse(argc,argv); + Options::parse_strict(argc,argv); } /// Return height diff --git a/examples/common-pattern.cpp b/examples/common-pattern.cpp index 059e1bae33..b5369de37f 100644 --- a/examples/common-pattern.cpp +++ b/examples/common-pattern.cpp @@ -251,7 +251,7 @@ main(int argc, char* argv[]) { opt.search(CommonPattern::SEARCH_DFS); opt.search(CommonPattern::SEARCH_BAB,"bab","find a longest pattern"); opt.search(CommonPattern::SEARCH_DFS,"dfs","enumerate frequent patterns"); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); try { opt.read(); } catch (const std::invalid_argument& error) { diff --git a/examples/crew.cpp b/examples/crew.cpp index 4420d389a7..4b31946b1f 100644 --- a/examples/crew.cpp +++ b/examples/crew.cpp @@ -180,7 +180,7 @@ int main(int argc, char* argv[]) { Options o("Crew"); o.iterations(100); - o.parse(argc,argv); + o.parse_strict(argc,argv); Script::run(o); return 0; } diff --git a/examples/descartes-folium.cpp b/examples/descartes-folium.cpp index 3bfa10afa3..c9436da058 100644 --- a/examples/descartes-folium.cpp +++ b/examples/descartes-folium.cpp @@ -118,7 +118,7 @@ int main(int argc, char* argv[]) { Options opt("DescartesFolium"); opt.solutions(0); opt.step(0.1); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); FloatMaximizeScript::run(opt); return 0; } diff --git a/examples/donald.cpp b/examples/donald.cpp index b997e9a8a0..f4e1e2c551 100644 --- a/examples/donald.cpp +++ b/examples/donald.cpp @@ -122,7 +122,7 @@ main(int argc, char* argv[]) { opt.model(Donald::MODEL_CARRY, "carry", "use carry"); opt.solutions(0); opt.iterations(1500); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/efpa.cpp b/examples/efpa.cpp index a85b509366..91fa4592a2 100644 --- a/examples/efpa.cpp +++ b/examples/efpa.cpp @@ -68,7 +68,6 @@ class EFPAOptions : public Options { add(_q); add(_v); add(_permutation); - add(_symmetry); // Add permutation options _permutation.add(true, "full" ); @@ -79,7 +78,7 @@ class EFPAOptions : public Options { } /// Parse options from arguments \a argv (number is \a argc) void parse(int& argc, char* argv[]) { - Options::parse(argc,argv); + Options::parse_strict(argc,argv); } /// Get v, number of sequences int v(void) const { return _v.value(); } diff --git a/examples/eq20.cpp b/examples/eq20.cpp index ff7e5897b3..d70c41f4b1 100755 --- a/examples/eq20.cpp +++ b/examples/eq20.cpp @@ -112,7 +112,7 @@ main(int argc, char* argv[]) { Options opt("Eq20"); opt.solutions(0); opt.iterations(1000); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/fifteen-puzzle.cpp b/examples/fifteen-puzzle.cpp index 16ef255fb2..93b35cf91b 100644 --- a/examples/fifteen-puzzle.cpp +++ b/examples/fifteen-puzzle.cpp @@ -439,7 +439,7 @@ run(PuzzleOptions& opt) { int main(int argc, char* argv[]) { PuzzleOptions opt; - opt.parse(argc,argv); + opt.parse_strict(argc,argv); if (opt.mode() == SM_SOLUTION) { std::cout << "Initial board (seed " << opt.seed() << "):\n"; print_board(std::cout,initial_board(opt)); diff --git a/examples/golden-spiral.cpp b/examples/golden-spiral.cpp index 090d751377..103bfd1704 100644 --- a/examples/golden-spiral.cpp +++ b/examples/golden-spiral.cpp @@ -123,7 +123,7 @@ int main(int argc, char* argv[]) { Options opt("GoldenSpiral"); opt.solutions(0); opt.step(0.1); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); FloatMaximizeScript::run(opt); return 0; } diff --git a/examples/golf.cpp b/examples/golf.cpp index abc926ed60..23a5a5b133 100755 --- a/examples/golf.cpp +++ b/examples/golf.cpp @@ -234,7 +234,7 @@ main(int argc, char* argv[]) { opt.propagation(Golf::PROP_MIXED, "mixed", "Use set intersection cardinality and integer distinct for pair play constraints"); opt.ipl(IPL_DOM); opt.solutions(1); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/grocery.cpp b/examples/grocery.cpp index f85c25795b..c936440bc1 100644 --- a/examples/grocery.cpp +++ b/examples/grocery.cpp @@ -104,7 +104,7 @@ int main(int argc, char* argv[]) { Options opt("Grocery"); opt.iterations(20); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/hamming.cpp b/examples/hamming.cpp index e5207e4457..17269d8d78 100644 --- a/examples/hamming.cpp +++ b/examples/hamming.cpp @@ -136,7 +136,7 @@ class Hamming : public Script { int main(int argc, char* argv[]) { HammingOptions opt("Hamming",20,3,32); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/money.cpp b/examples/money.cpp index 5def6df590..dd14a15f59 100755 --- a/examples/money.cpp +++ b/examples/money.cpp @@ -133,7 +133,7 @@ main(int argc, char* argv[]) { opt.model(Money::MODEL_CARRY, "carry", "use carry"); opt.solutions(0); opt.iterations(20000); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/open-route.cpp b/examples/open-route.cpp index b7e6ee143c..f76fbf5194 100644 --- a/examples/open-route.cpp +++ b/examples/open-route.cpp @@ -121,7 +121,7 @@ main(int argc, char* argv[]) { "Assign the current prefix before extending the route"); opt.branching(OpenRoute::BRANCH_LENGTH,"length", "Choose the complete route length first"); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); Script::run(opt); return 0; } diff --git a/examples/warehouses.cpp b/examples/warehouses.cpp index 1754fa1dd6..1b6a83f4e0 100755 --- a/examples/warehouses.cpp +++ b/examples/warehouses.cpp @@ -232,7 +232,7 @@ main(int argc, char* argv[]) { opt.model(MODEL_LEXCOST, "lex", "use lexicographic cost"); opt.solutions(0); opt.iterations(10); - opt.parse(argc,argv); + opt.parse_strict(argc,argv); switch (opt.model()) { case MODEL_SUMCOST: IntMinimizeScript::run(opt); diff --git a/gecode/driver.hh b/gecode/driver.hh index 0dd99b4caf..981fc353a1 100755 --- a/gecode/driver.hh +++ b/gecode/driver.hh @@ -407,9 +407,29 @@ namespace Gecode { * The options are parsed from position one onwards until no more options * are detected. After parsing, the parsed arguments have been removed. * + * Strict parsing will become the default in a future major release. + * Use parse_permissive() to explicitly retain partial parsing. + * */ void parse(int& argc, char* argv[]); + /** + * \brief Parse options, optionally rejecting unrecognised arguments + * + * With \a strict set to false, this behaves like the two-argument + * overload. With \a strict set to true, any remaining argument causes + * an error message and help text to be printed, followed by exit with + * failure. Use strict parsing when no positional arguments or further + * parsing are expected. Help options are handled as in the two-argument + * overload. + */ + void parse(int& argc, char* argv[], bool strict); + + /// Parse options with strict checking (equivalent to parse() with \c true) + void parse_strict(int& argc, char* argv[]); + /// Parse options partially (equivalent to parse() with \c false) + void parse_permissive(int& argc, char* argv[]); + /// Return name of script const char* name(void) const; /// Set name of script diff --git a/gecode/driver/options.cpp b/gecode/driver/options.cpp index ec014a85cd..967184a207 100755 --- a/gecode/driver/options.cpp +++ b/gecode/driver/options.cpp @@ -631,6 +631,17 @@ namespace Gecode { return; } + void + BaseOptions::parse(int& argc, char* argv[], bool strict) { + parse(argc,argv); + if (strict && (argc > 1)) { + std::cerr << "Unrecognised argument \"" << argv[1] << "\"" + << std::endl; + help(); + exit(EXIT_FAILURE); + } + } + BaseOptions::~BaseOptions(void) { Driver::BaseOption::strdel(_name); } diff --git a/gecode/driver/options.hpp b/gecode/driver/options.hpp index 9e622c131f..aeb4b23bf9 100755 --- a/gecode/driver/options.hpp +++ b/gecode/driver/options.hpp @@ -191,6 +191,15 @@ namespace Gecode { * Options * */ + inline void + BaseOptions::parse_strict(int& argc, char* argv[]) { + parse(argc,argv,true); + } + inline void + BaseOptions::parse_permissive(int& argc, char* argv[]) { + parse(argc,argv,false); + } + inline const char* BaseOptions::name(void) const { return _name; diff --git a/test/instance.cpp b/test/instance.cpp index 79cca8635f..e409024b57 100644 --- a/test/instance.cpp +++ b/test/instance.cpp @@ -613,6 +613,56 @@ namespace Test { namespace Instance { return true; }); + /// Observe help requests without terminating the test runner + class HelpOptions : public Gecode::Options { + public: + struct HelpShown {}; + HelpOptions(void) : Gecode::Options("Strict parsing test") {} + void help(void) override { + Gecode::Options::help(); + throw HelpShown(); + } + }; + + Case strict_options("Driver::Options::Strict", [](void) { + Gecode::Options options("Test"); + char name[] = "test", iterations[] = "-iterations", value[] = "200"; + char unknown[] = "--typo", help[] = "--help", positional[] = "instance.txt"; + char* valid_argv[] = {name, iterations, value, nullptr}; + int valid_argc = 3; + options.parse_strict(valid_argc, valid_argv); + CHECK(valid_argc == 1 && options.iterations() == 200); + + // Both the original overload and explicit non-strict parsing leave + // arguments for callers to interpret. + char* remaining_argv[] = {name, unknown, positional, nullptr}; + int remaining_argc = 3; + options.parse(remaining_argc, remaining_argv); + CHECK(remaining_argc == 3 && remaining_argv[1] == unknown); + options.parse_permissive(remaining_argc, remaining_argv); + CHECK(remaining_argc == 3 && remaining_argv[2] == positional); + + HelpOptions strict; + char* invalid_argv[] = {name, iterations, value, unknown, help, nullptr}; + int invalid_argc = 5; + bool help_shown = false; + std::ostringstream output; + std::streambuf* previous = std::cerr.rdbuf(output.rdbuf()); + try { + strict.parse_strict(invalid_argc, invalid_argv); + } catch (const HelpOptions::HelpShown&) { + help_shown = true; + } catch (...) { + std::cerr.rdbuf(previous); + throw; + } + std::cerr.rdbuf(previous); + CHECK(help_shown); + CHECK(output.str().find("Unrecognised argument \"--typo\"") != std::string::npos); + CHECK(output.str().find("Options for Strict parsing test:") != std::string::npos); + return true; + }); + Case options("Driver::InstanceOptions", [](void) { // Unique names in the temporary directory const char* tmp = std::getenv("TMPDIR");