Rename opt.argSrcRelative to opt.resolve

Author: gknowles

docs/reference.adoc

@@ -244,6 +244,11 @@ the user will be prompted for it. Use Cli::fPrompt* flags to adjust behavior.
 | Causes a check that the option value was set during parsing, and reports
 badUsage() if it wasn't.
 
+| opt.resolve
+| When srcType is ArgSrc::kFile values are interpreted as file paths and, if
+the argument also has kFile srcType, resolved relative to the file source of
+the argument. Other source types are not supported.
+
 | opt.<<guide.adoc#si-units, siUnits>>
 | Removes the symbol and, if SI unit prefixes (m, k, ki, M, Mi, etc) are
 present, multiplies by the corresponding factor.

libs/dimcli/cli.cpp

@@ -1215,7 +1215,7 @@ void Cli::defParseAction(Cli & cli, OptBase & opt, const string & val) {
 
 //===========================================================================
 // static
-void Cli::argSrcResolveAction(Cli & cli, OptBase & opt, const string & rel) {
+void Cli::argSrcFileRelAction(Cli & cli, OptBase & opt, const string & rel) {
     string val = rel;
 #ifdef DIMCLI_LIB_FILESYSTEM
     if (opt.srcType() == ArgSrc::kFile) {

libs/dimcli/cli.h

@@ -1029,7 +1029,7 @@ class DIMCLI_LIB_DECL Cli {
         OptBase & opt,
         const std::string & val
     );
-    static void argSrcResolveAction(
+    static void argSrcFileRelAction(
         Cli & cli,
         OptBase & opt,
         const std::string & val
@@ -1896,7 +1896,10 @@ class Cli::OptShim : public OptBase {
         int flags = 0            // Cli::fPrompt* flags
     );
 
-    A & argSrcRelative();
+    // When srcType is ArgSrc::kFile values are interpreted as file paths and,
+    // if the argument also has kFile srcType, resolved relative to the file
+    // source of the argument. Other source types are not supported.
+    A & resolve(ArgSrc::Type srcType);
 
     // Function signature of actions that are tied to options.
     using ActionFn = void(Cli & cli, A & opt, const std::string & val);
@@ -2370,8 +2373,10 @@ A & Cli::OptShim<A, T>::prompt(const std::string & msg, int flags) {
 
 //===========================================================================
 template <typename A, typename T>
-A & Cli::OptShim<A, T>::argSrcRelative() {
-    return parse(Cli::argSrcResolveAction).valueDesc("FILE");
+A & Cli::OptShim<A, T>::resolve(ArgSrc::Type srcType) {
+    if (srcType == ArgSrc::kFile)
+        parse(Cli::argSrcFileRelAction).valueDesc("FILE");
+    return static_cast<A &>(*this);
 }
 
 
@@ -2496,7 +2501,7 @@ inline bool Cli::Opt<T>::parseValue(const std::string & value) {
 template <>
 inline // static
 void Cli::Opt<DIMCLI_LIB_FILESYSTEM_PATH>::initConfig(Cli &) {
-    argSrcRelative();
+    resolve(ArgSrc::kFile);
 }
 #endif
 
@@ -2715,7 +2720,7 @@ inline bool Cli::OptVec<T>::parseValue(const std::string & value) {
 template <>
 inline // static
 void Cli::OptVec<DIMCLI_LIB_FILESYSTEM_PATH>::initConfig(Cli &) {
-    argSrcRelative();
+    resolve(ArgSrc::kFile);
 }
 #endif
 

tests/cli/clitest.cpp

@@ -580,10 +580,12 @@ static void valueTests() {
     // parse manufactured relative file argument
     {
         cli = {};
-        auto & opt = cli.opt<string>("v").argSrcRelative();
+        auto stype = Dim::Cli::ArgSrc::kFile;
+        auto & opt = cli.opt<string>("v").resolve(stype);
+        cli.optVec<string>("x").resolve(stype);
         EXPECT_PARSE(cli, "");
         EXPECT_EQUAL(*opt, "");
-        auto rc = cli.parseValue(opt, Dim::Cli::ArgSrc::kFile, "a/b.rsp", "c");
+        auto rc = cli.parseValue(opt, stype, "a/b.rsp", "c");
         EXPECT_EQUAL(rc, true);
         EXPECT_EQUAL(*opt, "a/c");
     }
@@ -2117,6 +2119,7 @@ static void filesystemTests() {
         (void) cvt.toString(def, path);
         EXPECT_EQUAL(def, "path");
         cli.opt(&path, "path", path)
+            .valueDesc(cli.valueDesc<fs::path>())
             .desc("std::filesystem::path");
         EXPECT_PARSE(cli, "--path one");
         EXPECT_EQUAL(path, "one");