Function sanitizeKey

src/workflow/Util.cpp:289–306

TODO: investigate removing this. `OSRunner::registerValue` already calls `OSRunner::cleanValueName`, perhaps we just reuse that

// TODO: investigate removing this. `OSRunner::registerValue` already calls `OSRunner::cleanValueName`, perhaps we just reuse that
std::string sanitizeKey(std::string key) {
  static const std::regex invalidCharsRegex(R"([|!@#$%^&*(){}\\[\];:'",<.>/?+=]+)");
  static const std::regex squeezeUnderscoresRegex(R"(_{2,})");
  static const std::regex trailingUnderscoreOrWhiteSpaceRegex(R"((_|\s)+$)");

  if (std::regex_search(key, invalidCharsRegex)) {
    LOG_FREE(Warn, "openstudio.worklow.Util", fmt::format("Renaming result key '{}' to remove invalid characters", key));
    // Replace invalid characters with underscores
    key = std::regex_replace(key, invalidCharsRegex, "_");
  }

  // Squeeze consecutive underscores
  key = std::regex_replace(key, squeezeUnderscoresRegex, "_");
  // Strip trailing underscores or whitespace
  key = std::regex_replace(key, trailingUnderscoreOrWhiteSpaceRegex, "");

  return key;
}

bool addResultMeasureInfo(WorkflowStepResult& result, BCLMeasure& measure) {
  try {