Change opt.anyUnits and opt.relative to use transform instead of parse actions

Author: gknowles

docs/guide.adoc

@@ -987,7 +987,7 @@ int main(int argc, char * argv[]) {
         .parse([](auto & cli, auto & opt, const string & val) {
             int tmp = *opt; // save the old value
             if (!opt.parseValue(val)) // parse the new value into opt
-                return cli.badUsage(opt, val);
+                return cli.badUsage(opt);
             *opt *= tmp; // multiply old and new together
         });
     if (!cli.parse(argc, argv))

libs/dimcli/cli.cpp

@@ -191,8 +191,12 @@ struct Cli::Config {
     shared_ptr<locale> defLoc = make_shared<locale>();
     shared_ptr<locale> numLoc = make_shared<locale>("");
 
+    // Opt* and value actively being parsed, referenced servicing action
+    // callbacks.
     Cli::OptBase * curOpt = {};
+    string originalValue;
     string newValue;
+
     int exitCode = kExitOk;
     string errMsg;
     string errDetail;
@@ -780,7 +784,7 @@ void Cli::newValue(const string & value) {
         if (parseBool(v, value)) {
             m_cfg->newValue = v ? "1" : "0";
         } else {
-            badUsage(opt, value);
+            badUsage(opt);
         }
     }
 }
@@ -1232,20 +1236,19 @@ void Cli::defParseAction(Cli & cli, OptBase & opt, const string & val) {
 
     string desc;
     writeChoicesDetail(&desc, opt.m_choiceDescs);
-    cli.badUsage(opt, val, desc);
+    cli.badUsage(opt, nullptr, desc);
 }
 
 //===========================================================================
 // static
 void Cli::argSrcFileRelAction(Cli & cli, OptBase & opt, const string & rel) {
-    string val = rel;
 #ifdef DIMCLI_LIB_FILESYSTEM
     if (opt.srcType() == ArgSrc::kFile) {
         auto p = fs::u8path(opt.srcName()).parent_path() / rel;
-        val = (char *) p.generic_u8string().c_str();
+        string val = (char *) p.generic_u8string().c_str();
+        cli.newValue(val);
     }
 #endif
-    defParseAction(cli, opt, val);
 }
 
 //===========================================================================
@@ -2624,6 +2627,7 @@ Cli & Cli::resetValues() & {
     for (auto && opt : m_cfg->opts)
         opt->reset();
     m_cfg->curOpt = {};
+    m_cfg->originalValue.clear();
     m_cfg->newValue.clear();
     m_cfg->parseExit = false;
     m_cfg->exitCode = kExitOk;
@@ -2674,7 +2678,17 @@ void Cli::badUsage(
     const string & detail
 ) {
     string prefix = "Invalid '" + opt.from() + "' value";
-    return badUsage(prefix, value, detail);
+    badUsage(prefix, value, detail);
+}
+
+//===========================================================================
+void Cli::badUsage(
+    const OptBase & opt,
+    nullptr_t,
+    const string & detail
+) {
+    string prefix = "Invalid '" + opt.from() + "' value";
+    badUsage(prefix, m_cfg->originalValue, detail);
 }
 
 //===========================================================================
@@ -2747,6 +2761,7 @@ bool Cli::parseValue(
         return false;
     }
     if (ptr) {
+        m_cfg->originalValue = ptr;
         m_cfg->newValue = ptr;
         m_cfg->curOpt = &opt;
         opt.doTransforms(*this);
@@ -2756,10 +2771,12 @@ bool Cli::parseValue(
         if (!parseAborted())
             opt.doChecks(*this);
     } else {
+        m_cfg->originalValue.clear();
         m_cfg->newValue.clear();
         opt.assignImplicit();
         opt.doChecks(*this);
     }
+    m_cfg->originalValue.clear();
     m_cfg->newValue.clear();
     return !parseAborted();
 }

libs/dimcli/cli.h

@@ -594,6 +594,15 @@ class DIMCLI_LIB_DECL Cli {
         const std::string & detail = {}
     );
 
+    // Intended for use from transform, parse, and check actions. Calls
+    // cli.badUsage(opt, value, detail) with value set to the string value
+    // being parsed. Outside of parsing an empty string is used for the value.
+    void badUsage(
+        const OptBase & opt,
+        std::nullptr_t value = nullptr,
+        const std::string & detail = {}
+    );
+
     // Calls cli.badUsage with "Out of range" message and the low and high in
     // the detail.
     template <typename A, typename T>
@@ -2324,7 +2333,7 @@ A & Cli::OptShim<A, T>::anyUnits(InputIt first, InputIt last, int flags) {
     } else {
         units.insert(first, last);
     }
-    return parse([units, flags](auto & cli, auto & opt, auto & val) {
+    return transform([units, flags](auto & cli, auto & opt, auto & val) {
         long double dval;
         bool success = true;
         if (!opt.withUnits(dval, cli, val, units, flags))
@@ -2344,10 +2353,7 @@ A & Cli::OptShim<A, T>::anyUnits(InputIt first, InputIt last, int flags) {
             assert(success // LCOV_EXCL_LINE
                 && "Internal dimcli error: convert double to string failed.");
         }
-        if (!opt.parseValue(sval)) {
-            success = false;
-            cli.badUsage(opt, val);
-        }
+        cli.newValue(sval);
     });
 }
 
@@ -2396,7 +2402,7 @@ A & Cli::OptShim<A, T>::prompt(const std::string & msg, int flags) {
 template <typename A, typename T>
 A & Cli::OptShim<A, T>::resolve(ArgSrc::Type srcType) {
     if (srcType == ArgSrc::kFile)
-        parse(Cli::argSrcFileRelAction).valueDesc("FILE");
+        transform(Cli::argSrcFileRelAction).valueDesc("FILE");
     return static_cast<A &>(*this);
 }
 

tests/cli/clitest.cpp

@@ -2617,7 +2617,11 @@ static void unitsTests() {
             "Error: Invalid 'V' value: 1B\n"
             "Units symbol 'B' not recognized.\n"
         );
+    }
 
+    {
+        cli = {};
+        auto & dbls = cli.optVec<double>("[V]");
         dbls.siUnits("b", cli.fUnitBinaryPrefix);
         EXPECT_PARSE(cli, "1k 1ki");
         EXPECT_EQUAL(dbls[0], 1024);
@@ -2627,7 +2631,11 @@ static void unitsTests() {
 Error: Invalid 'V' value: 1000m
 Units symbol 'm' not recognized.
 )");
+    }
 
+    {
+        cli = {};
+        auto & dbls = cli.optVec<double>("[V]");
         dbls.siUnits("b", cli.fUnitInsensitive);
         EXPECT_PARSE(cli, "1 1b 1B 1kB 1Kb");
         EXPECT_EQUAL(dbls[0], 1);
@@ -2640,8 +2648,12 @@ Units symbol 'm' not recognized.
 Error: Invalid 'V' value: 1000u
 Units symbol 'u' not recognized.
 )");
+    }
 
-        // with fUnitRequire
+    // with fUnitRequire
+    {
+        cli = {};
+        auto & dbls = cli.optVec<double>("[V]");
         dbls.siUnits("b", cli.fUnitRequire);
         EXPECT_PARSE(cli, "1b 1kb");
         EXPECT_EQUAL(dbls[0], 1);
@@ -2664,6 +2676,11 @@ Units symbol 'k' not recognized.
         EXPECT_ERR(cli, "Error: Invalid 'V' value: kb\n");
         EXPECT_PARSE(cli, "1x23kb", false);
         EXPECT_ERR(cli, "Error: Invalid 'V' value: 1x23kb\n");
+    }
+
+    {
+        cli = {};
+        auto & dbls = cli.optVec<double>("[V]");
         dbls.siUnits("", cli.fUnitRequire);
         EXPECT_PARSE(cli, "1k");
         EXPECT_EQUAL(dbls[0], 1000);