ENH: Rename nxrunner --ooc-memory-budget flag to --memory-budget

* Rename the CLI flag, ArgumentType enum entry, k_ constants, help
  function, local variable, and error-message strings to drop the
  "Ooc" prefix
* Update calls into Preferences to match the renamed API
  (setMemoryBudgetBytes, memoryBudgetBytes, k_MemoryBudgetBytes_Key)

The MemoryBudgetManager now lives in simplnx core (not the SimplnxOoc
plugin) and applies to any cache subsystem that registers against it,
so the "Ooc" qualifier is no longer accurate.

Signed-off-by: Joey Kleingers <joey.kleingers@bluequartz.net>

Author: joeykleingers

src/nxrunner/src/nxrunner.cpp

@@ -58,8 +58,8 @@ constexpr StringLiteral k_PreflightParamShort = "-p";
 constexpr StringLiteral k_LogFileParamShort = "-l";
 constexpr StringLiteral k_ConvertParamShort = "-c";
 constexpr StringLiteral k_ConvertOutputParamShort = "-co";
-constexpr StringLiteral k_OocMemoryBudgetParamLong = "--ooc-memory-budget";
-constexpr StringLiteral k_OocMemoryBudgetParamShort = "-b";
+constexpr StringLiteral k_MemoryBudgetParamLong = "--memory-budget";
+constexpr StringLiteral k_MemoryBudgetParamShort = "-b";
 
 void LoadApp()
 {
@@ -152,7 +152,7 @@ enum class ArgumentType
   Logfile,
   Convert,
   ConvertOutput,
-  OocMemoryBudget
+  MemoryBudget
 };
 
 struct Argument
@@ -251,10 +251,10 @@ Result<CliArguments> ParseParameters(int argc, char* argv[])
       std::string argStr = ParseArgument(argc, argv, index);
       args.emplace_back(ArgumentType::ConvertOutput, argStr);
     }
-    else if(arg == k_OocMemoryBudgetParamLong || arg == k_OocMemoryBudgetParamShort)
+    else if(arg == k_MemoryBudgetParamLong || arg == k_MemoryBudgetParamShort)
     {
       std::string argStr = ParseArgument(argc, argv, index);
-      args.emplace_back(ArgumentType::OocMemoryBudget, argStr);
+      args.emplace_back(ArgumentType::MemoryBudget, argStr);
     }
     else
     {
@@ -465,7 +465,7 @@ void DisplayDefaultHelp()
   cliOut << fmt::format("\t {}|{} <pipeline filepath>  [{}|{} <log filepath>]\t", k_ConvertParamLong, k_ConvertParamShort, k_LogFileParamLong, k_LogFileParamShort)
          << "\t Convert the SIMPL pipeline at the target filepath. Optionally, create a log file at the specified path.";
   cliOut << fmt::format("\t <operand [argument]>  [{}|{} <log filepath>]\t", k_LogFileParamLong, k_LogFileParamShort) << "\t Creates a log file at the specified path.";
-  cliOut << fmt::format("\t {}|{} <gigabytes>\t", k_OocMemoryBudgetParamLong, k_OocMemoryBudgetParamShort)
+  cliOut << fmt::format("\t {}|{} <gigabytes>\t", k_MemoryBudgetParamLong, k_MemoryBudgetParamShort)
          << "\t Override the OOC memory budget for this run (decimal GB, e.g. 8 or 1.5). Does not modify saved preferences.\n";
   cliOut.endline();
 }
@@ -509,10 +509,10 @@ void DisplayLogfileHelp()
   cliOut.endline();
 }
 
-void DisplayOocMemoryBudgetHelp()
+void DisplayMemoryBudgetHelp()
 {
   cliOut << "To override the OOC memory budget for this run:\n\t";
-  cliOut << fmt::format("\t {}|{} <gigabytes>\t", k_OocMemoryBudgetParamLong, k_OocMemoryBudgetParamShort)
+  cliOut << fmt::format("\t {}|{} <gigabytes>\t", k_MemoryBudgetParamLong, k_MemoryBudgetParamShort)
          << "\t Override the OOC memory budget for this run only (decimal gigabytes, e.g. 8 or 1.5). Does not modify saved preferences.";
   cliOut.endline();
 }
@@ -546,8 +546,8 @@ Result<> DisplayHelpMenu(const std::vector<Argument>& arguments)
     DisplayLogfileHelp();
     return {};
   }
-  case ArgumentType::OocMemoryBudget: {
-    DisplayOocMemoryBudgetHelp();
+  case ArgumentType::MemoryBudget: {
+    DisplayMemoryBudgetHelp();
     return {};
   }
   case ArgumentType::Invalid: {
@@ -595,7 +595,7 @@ int main(int argc, char* argv[])
   CliArguments arguments = parsingResult.value();
   std::vector<Result<>> results;
 
-  std::optional<uint64> overrideOocMemoryBudgetBytes;
+  std::optional<uint64> overrideMemoryBudgetBytes;
 
   // Set log file and check for parsing errors
   for(const Argument& argument : arguments)
@@ -610,10 +610,10 @@ int main(int argc, char* argv[])
       results.push_back(SetLogFile(argument));
       break;
     }
-    case ArgumentType::OocMemoryBudget: {
+    case ArgumentType::MemoryBudget: {
       if(argument.value.empty())
       {
-        results.push_back(nx::core::MakeErrorResult(k_InvalidArgumentError, "--ooc-memory-budget requires a value in gigabytes (e.g. 8 or 1.5)"));
+        results.push_back(nx::core::MakeErrorResult(k_InvalidArgumentError, "--memory-budget requires a value in gigabytes (e.g. 8 or 1.5)"));
         break;
       }
       try
@@ -623,13 +623,13 @@ int main(int argc, char* argv[])
         if(parsedChars != argument.value.size() || !std::isfinite(gb) || gb <= 0.0)
         {
           results.push_back(
-              nx::core::MakeErrorResult(k_InvalidArgumentError, fmt::format("Invalid value for --ooc-memory-budget: '{}' (must be a finite, positive number of gigabytes)", argument.value)));
+              nx::core::MakeErrorResult(k_InvalidArgumentError, fmt::format("Invalid value for --memory-budget: '{}' (must be a finite, positive number of gigabytes)", argument.value)));
           break;
         }
-        overrideOocMemoryBudgetBytes = static_cast<uint64>(gb * 1024.0 * 1024.0 * 1024.0);
+        overrideMemoryBudgetBytes = static_cast<uint64>(gb * 1024.0 * 1024.0 * 1024.0);
       } catch(const std::exception&)
       {
-        results.push_back(nx::core::MakeErrorResult(k_InvalidArgumentError, fmt::format("Invalid value for --ooc-memory-budget: '{}' (expected a positive number of gigabytes)", argument.value)));
+        results.push_back(nx::core::MakeErrorResult(k_InvalidArgumentError, fmt::format("Invalid value for --memory-budget: '{}' (expected a positive number of gigabytes)", argument.value)));
       }
       break;
     }
@@ -667,28 +667,28 @@ int main(int argc, char* argv[])
       }
       if(wasPresent)
       {
-        prefs->setOocMemoryBudgetBytes(originalValue);
+        prefs->setMemoryBudgetBytes(originalValue);
       }
       else
       {
-        prefs->removeValue(Preferences::k_OocMemoryBudgetBytes_Key);
+        prefs->removeValue(Preferences::k_MemoryBudgetBytes_Key);
       }
     }
   };
   PreferencesBudgetRestorer budgetRestorer;
 
-  if(overrideOocMemoryBudgetBytes.has_value())
+  if(overrideMemoryBudgetBytes.has_value())
   {
     Preferences* preferences = app->getPreferences();
     if(preferences != nullptr)
     {
       budgetRestorer.prefs = preferences;
-      budgetRestorer.wasPresent = preferences->contains(std::string(Preferences::k_OocMemoryBudgetBytes_Key));
+      budgetRestorer.wasPresent = preferences->contains(std::string(Preferences::k_MemoryBudgetBytes_Key));
       if(budgetRestorer.wasPresent)
       {
-        budgetRestorer.originalValue = preferences->oocMemoryBudgetBytes();
+        budgetRestorer.originalValue = preferences->memoryBudgetBytes();
       }
-      preferences->setOocMemoryBudgetBytes(*overrideOocMemoryBudgetBytes);
+      preferences->setMemoryBudgetBytes(*overrideMemoryBudgetBytes);
     }
   }