/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying file Copyright.txt or https://cmake.org/licensing for details. */ #include "cmParseArgumentsCommand.h" #include #include #include #include #include "cmAlgorithms.h" #include "cmMakefile.h" #include "cmMessageType.h" #include "cmSystemTools.h" class cmExecutionStatus; static std::string EscapeArg(const std::string& arg) { // replace ";" with "\;" so output argument lists will split correctly std::string escapedArg; for (char i : arg) { if (i == ';') { escapedArg += '\\'; } escapedArg += i; } return escapedArg; } namespace { enum insideValues { NONE, SINGLE, MULTI }; typedef std::map options_map; typedef std::map single_map; typedef std::map> multi_map; typedef std::set options_set; } // function to be called every time, a new key word was parsed or all // parameters where parsed. static void DetectKeywordsMissingValues(insideValues currentState, const std::string& currentArgName, int& argumentsFound, options_set& keywordsMissingValues) { if (currentState == SINGLE || (currentState == MULTI && argumentsFound == 0)) { keywordsMissingValues.insert(currentArgName); } argumentsFound = 0; } static void PassParsedArguments(const std::string& prefix, cmMakefile& makefile, const options_map& options, const single_map& singleValArgs, const multi_map& multiValArgs, const std::vector& unparsed, const options_set& keywordsMissingValues) { for (auto const& iter : options) { makefile.AddDefinition(prefix + iter.first, iter.second ? "TRUE" : "FALSE"); } for (auto const& iter : singleValArgs) { if (!iter.second.empty()) { makefile.AddDefinition(prefix + iter.first, iter.second.c_str()); } else { makefile.RemoveDefinition(prefix + iter.first); } } for (auto const& iter : multiValArgs) { if (!iter.second.empty()) { makefile.AddDefinition(prefix + iter.first, cmJoin(cmMakeRange(iter.second), ";").c_str()); } else { makefile.RemoveDefinition(prefix + iter.first); } } if (!unparsed.empty()) { makefile.AddDefinition(prefix + "UNPARSED_ARGUMENTS", cmJoin(cmMakeRange(unparsed), ";").c_str()); } else { makefile.RemoveDefinition(prefix + "UNPARSED_ARGUMENTS"); } if (!keywordsMissingValues.empty()) { makefile.AddDefinition( prefix + "KEYWORDS_MISSING_VALUES", cmJoin(cmMakeRange(keywordsMissingValues), ";").c_str()); } else { makefile.RemoveDefinition(prefix + "KEYWORDS_MISSING_VALUES"); } } bool cmParseArgumentsCommand::InitialPass(std::vector const& args, cmExecutionStatus&) { // cmake_parse_arguments(prefix options single multi ) // 1 2 3 4 // or // cmake_parse_arguments(PARSE_ARGV N prefix options single multi) if (args.size() < 4) { this->SetError("must be called with at least 4 arguments."); return false; } std::vector::const_iterator argIter = args.begin(), argEnd = args.end(); bool parseFromArgV = false; unsigned long argvStart = 0; if (*argIter == "PARSE_ARGV") { if (args.size() != 6) { this->Makefile->IssueMessage( MessageType::FATAL_ERROR, "PARSE_ARGV must be called with exactly 6 arguments."); cmSystemTools::SetFatalErrorOccured(); return true; } parseFromArgV = true; argIter++; // move past PARSE_ARGV if (!cmSystemTools::StringToULong(argIter->c_str(), &argvStart)) { this->Makefile->IssueMessage(MessageType::FATAL_ERROR, "PARSE_ARGV index '" + *argIter + "' is not an unsigned integer"); cmSystemTools::SetFatalErrorOccured(); return true; } argIter++; // move past N } // the first argument is the prefix const std::string prefix = (*argIter++) + "_"; // define the result maps holding key/value pairs for // options, single values and multi values options_map options; single_map singleValArgs; multi_map multiValArgs; // anything else is put into a vector of unparsed strings std::vector unparsed; // remember already defined keywords std::set used_keywords; const std::string dup_warning = "keyword defined more than once: "; // the second argument is a (cmake) list of options without argument std::vector list; cmSystemTools::ExpandListArgument(*argIter++, list); for (std::string const& iter : list) { if (!used_keywords.insert(iter).second) { this->GetMakefile()->IssueMessage(MessageType::WARNING, dup_warning + iter); } options[iter]; // default initialize } // the third argument is a (cmake) list of single argument options list.clear(); cmSystemTools::ExpandListArgument(*argIter++, list); for (std::string const& iter : list) { if (!used_keywords.insert(iter).second) { this->GetMakefile()->IssueMessage(MessageType::WARNING, dup_warning + iter); } singleValArgs[iter]; // default initialize } // the fourth argument is a (cmake) list of multi argument options list.clear(); cmSystemTools::ExpandListArgument(*argIter++, list); for (std::string const& iter : list) { if (!used_keywords.insert(iter).second) { this->GetMakefile()->IssueMessage(MessageType::WARNING, dup_warning + iter); } multiValArgs[iter]; // default initialize } insideValues insideValues = NONE; std::string currentArgName; list.clear(); if (!parseFromArgV) { // Flatten ;-lists in the arguments into a single list as was done // by the original function(CMAKE_PARSE_ARGUMENTS). for (; argIter != argEnd; ++argIter) { cmSystemTools::ExpandListArgument(*argIter, list); } } else { // in the PARSE_ARGV move read the arguments from ARGC and ARGV# std::string argc = this->Makefile->GetSafeDefinition("ARGC"); unsigned long count; if (!cmSystemTools::StringToULong(argc.c_str(), &count)) { this->Makefile->IssueMessage(MessageType::FATAL_ERROR, "PARSE_ARGV called with ARGC='" + argc + "' that is not an unsigned integer"); cmSystemTools::SetFatalErrorOccured(); return true; } for (unsigned long i = argvStart; i < count; ++i) { std::ostringstream argName; argName << "ARGV" << i; const char* arg = this->Makefile->GetDefinition(argName.str()); if (!arg) { this->Makefile->IssueMessage(MessageType::FATAL_ERROR, "PARSE_ARGV called with " + argName.str() + " not set"); cmSystemTools::SetFatalErrorOccured(); return true; } list.emplace_back(arg); } } options_set keywordsMissingValues; int multiArgumentsFound = 0; // iterate over the arguments list and fill in the values where applicable for (std::string const& arg : list) { const options_map::iterator optIter = options.find(arg); if (optIter != options.end()) { DetectKeywordsMissingValues(insideValues, currentArgName, multiArgumentsFound, keywordsMissingValues); insideValues = NONE; optIter->second = true; continue; } const single_map::iterator singleIter = singleValArgs.find(arg); if (singleIter != singleValArgs.end()) { DetectKeywordsMissingValues(insideValues, currentArgName, multiArgumentsFound, keywordsMissingValues); insideValues = SINGLE; currentArgName = arg; continue; } const multi_map::iterator multiIter = multiValArgs.find(arg); if (multiIter != multiValArgs.end()) { DetectKeywordsMissingValues(insideValues, currentArgName, multiArgumentsFound, keywordsMissingValues); insideValues = MULTI; currentArgName = arg; continue; } switch (insideValues) { case SINGLE: singleValArgs[currentArgName] = arg; insideValues = NONE; break; case MULTI: ++multiArgumentsFound; if (parseFromArgV) { multiValArgs[currentArgName].push_back(EscapeArg(arg)); } else { multiValArgs[currentArgName].push_back(arg); } break; default: multiArgumentsFound = 0; if (parseFromArgV) { unparsed.push_back(EscapeArg(arg)); } else { unparsed.push_back(arg); } break; } } DetectKeywordsMissingValues(insideValues, currentArgName, multiArgumentsFound, keywordsMissingValues); PassParsedArguments(prefix, *this->Makefile, options, singleValArgs, multiValArgs, unparsed, keywordsMissingValues); return true; }