319 lines · cpp
1//===- ArgList.cpp - Argument List Management -----------------------------===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8 9#include "llvm/Option/ArgList.h"10#include "llvm/ADT/ArrayRef.h"11#include "llvm/ADT/SmallVector.h"12#include "llvm/ADT/StringRef.h"13#include "llvm/ADT/Twine.h"14#include "llvm/Config/llvm-config.h"15#include "llvm/Option/Arg.h"16#include "llvm/Option/OptSpecifier.h"17#include "llvm/Option/OptTable.h"18#include "llvm/Option/Option.h"19#include "llvm/Support/Compiler.h"20#include "llvm/Support/Debug.h"21#include "llvm/Support/raw_ostream.h"22#include <algorithm>23#include <cassert>24#include <cstddef>25#include <memory>26#include <string>27#include <vector>28 29using namespace llvm;30using namespace llvm::opt;31 32void ArgList::append(Arg *A) {33 Args.push_back(A);34 35 // Update ranges for the option and all of its groups.36 for (Option O = A->getOption().getUnaliasedOption(); O.isValid();37 O = O.getGroup()) {38 auto &R =39 OptRanges.insert(std::make_pair(O.getID(), emptyRange())).first->second;40 R.first = std::min<unsigned>(R.first, Args.size() - 1);41 R.second = Args.size();42 }43}44 45void ArgList::eraseArg(OptSpecifier Id) {46 // Zero out the removed entries but keep them around so that we don't47 // need to invalidate OptRanges.48 for (Arg *const &A : filtered(Id)) {49 // Avoid the need for a non-const filtered iterator variant.50 Arg **ArgsBegin = Args.data();51 ArgsBegin[&A - ArgsBegin] = nullptr;52 }53 OptRanges.erase(Id.getID());54}55 56ArgList::OptRange57ArgList::getRange(std::initializer_list<OptSpecifier> Ids) const {58 OptRange R = emptyRange();59 for (auto Id : Ids) {60 auto I = OptRanges.find(Id.getID());61 if (I != OptRanges.end()) {62 R.first = std::min(R.first, I->second.first);63 R.second = std::max(R.second, I->second.second);64 }65 }66 // Map an empty {-1, 0} range to {0, 0} so it can be used to form iterators.67 if (R.first == -1u)68 R.first = 0;69 return R;70}71 72bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default) const {73 if (Arg *A = getLastArg(Pos, Neg))74 return A->getOption().matches(Pos);75 return Default;76}77 78bool ArgList::hasFlagNoClaim(OptSpecifier Pos, OptSpecifier Neg,79 bool Default) const {80 if (Arg *A = getLastArgNoClaim(Pos, Neg))81 return A->getOption().matches(Pos);82 return Default;83}84 85bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg,86 bool Default) const {87 if (Arg *A = getLastArg(Pos, PosAlias, Neg))88 return A->getOption().matches(Pos) || A->getOption().matches(PosAlias);89 return Default;90}91 92StringRef ArgList::getLastArgValue(OptSpecifier Id, StringRef Default) const {93 if (Arg *A = getLastArg(Id))94 return A->getValue();95 return Default;96}97 98std::vector<std::string> ArgList::getAllArgValues(OptSpecifier Id) const {99 SmallVector<const char *, 16> Values;100 AddAllArgValues(Values, Id);101 return std::vector<std::string>(Values.begin(), Values.end());102}103 104void ArgList::addOptInFlag(ArgStringList &Output, OptSpecifier Pos,105 OptSpecifier Neg) const {106 if (Arg *A = getLastArg(Pos, Neg))107 if (A->getOption().matches(Pos))108 A->render(*this, Output);109}110 111void ArgList::AddAllArgsExcept(ArgStringList &Output,112 ArrayRef<OptSpecifier> Ids,113 ArrayRef<OptSpecifier> ExcludeIds) const {114 for (const Arg *Arg : *this) {115 bool Excluded = false;116 for (OptSpecifier Id : ExcludeIds) {117 if (Arg->getOption().matches(Id)) {118 Excluded = true;119 break;120 }121 }122 if (!Excluded) {123 for (OptSpecifier Id : Ids) {124 if (Arg->getOption().matches(Id)) {125 Arg->claim();126 Arg->render(*this, Output);127 break;128 }129 }130 }131 }132}133 134/// This is a nicer interface when you don't have a list of Ids to exclude.135void ArgList::addAllArgs(ArgStringList &Output,136 ArrayRef<OptSpecifier> Ids) const {137 ArrayRef<OptSpecifier> Exclude = {};138 AddAllArgsExcept(Output, Ids, Exclude);139}140 141void ArgList::AddAllArgs(ArgStringList &Output, OptSpecifier Id0) const {142 for (auto *Arg : filtered(Id0)) {143 Arg->claim();144 Arg->render(*this, Output);145 }146}147 148void ArgList::AddAllArgValues(ArgStringList &Output, OptSpecifier Id0,149 OptSpecifier Id1, OptSpecifier Id2) const {150 for (auto *Arg : filtered(Id0, Id1, Id2)) {151 Arg->claim();152 const auto &Values = Arg->getValues();153 Output.append(Values.begin(), Values.end());154 }155}156 157void ArgList::AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0,158 const char *Translation,159 bool Joined) const {160 for (auto *Arg : filtered(Id0)) {161 Arg->claim();162 163 if (Joined) {164 Output.push_back(MakeArgString(StringRef(Translation) +165 Arg->getValue(0)));166 } else {167 Output.push_back(Translation);168 Output.push_back(Arg->getValue(0));169 }170 }171}172 173void ArgList::ClaimAllArgs(OptSpecifier Id0) const {174 for (auto *Arg : filtered(Id0))175 Arg->claim();176}177 178void ArgList::ClaimAllArgs() const {179 for (auto *Arg : *this)180 if (!Arg->isClaimed())181 Arg->claim();182}183 184const char *ArgList::GetOrMakeJoinedArgString(unsigned Index,185 StringRef LHS,186 StringRef RHS) const {187 StringRef Cur = getArgString(Index);188 if (Cur.size() == LHS.size() + RHS.size() && Cur.starts_with(LHS) &&189 Cur.ends_with(RHS))190 return Cur.data();191 192 return MakeArgString(LHS + RHS);193}194 195void ArgList::print(raw_ostream &O) const {196 for (Arg *A : *this) {197 O << "* ";198 A->print(O);199 }200}201 202#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)203LLVM_DUMP_METHOD void ArgList::dump() const { print(dbgs()); }204#endif205 206StringRef ArgList::getSubCommand(207 ArrayRef<OptTable::SubCommand> AllSubCommands,208 std::function<void(ArrayRef<StringRef>)> HandleMultipleSubcommands,209 std::function<void(ArrayRef<StringRef>)> HandleOtherPositionals) const {210 211 SmallVector<StringRef, 4> SubCommands;212 SmallVector<StringRef, 4> OtherPositionals;213 for (const Arg *A : *this) {214 if (A->getOption().getKind() != Option::InputClass)215 continue;216 217 size_t OldSize = SubCommands.size();218 for (const OptTable::SubCommand &CMD : AllSubCommands) {219 if (StringRef(CMD.Name) == A->getValue())220 SubCommands.push_back(A->getValue());221 }222 223 if (SubCommands.size() == OldSize)224 OtherPositionals.push_back(A->getValue());225 }226 227 // Invoke callbacks if necessary.228 if (SubCommands.size() > 1) {229 HandleMultipleSubcommands(SubCommands);230 return {};231 }232 if (!OtherPositionals.empty())233 HandleOtherPositionals(OtherPositionals);234 235 if (SubCommands.size() == 1)236 return SubCommands.front();237 return {}; // No valid usage of subcommand found.238}239 240void InputArgList::releaseMemory() {241 // An InputArgList always owns its arguments.242 for (Arg *A : *this)243 delete A;244}245 246InputArgList::InputArgList(const char* const *ArgBegin,247 const char* const *ArgEnd)248 : NumInputArgStrings(ArgEnd - ArgBegin) {249 ArgStrings.append(ArgBegin, ArgEnd);250}251 252unsigned InputArgList::MakeIndex(StringRef String0) const {253 unsigned Index = ArgStrings.size();254 255 // Tuck away so we have a reliable const char *.256 SynthesizedStrings.push_back(std::string(String0));257 ArgStrings.push_back(SynthesizedStrings.back().c_str());258 259 return Index;260}261 262unsigned InputArgList::MakeIndex(StringRef String0,263 StringRef String1) const {264 unsigned Index0 = MakeIndex(String0);265 unsigned Index1 = MakeIndex(String1);266 assert(Index0 + 1 == Index1 && "Unexpected non-consecutive indices!");267 (void) Index1;268 return Index0;269}270 271const char *InputArgList::MakeArgStringRef(StringRef Str) const {272 return getArgString(MakeIndex(Str));273}274 275DerivedArgList::DerivedArgList(const InputArgList &BaseArgs)276 : BaseArgs(BaseArgs) {}277 278const char *DerivedArgList::MakeArgStringRef(StringRef Str) const {279 return BaseArgs.MakeArgString(Str);280}281 282void DerivedArgList::AddSynthesizedArg(Arg *A) {283 SynthesizedArgs.push_back(std::unique_ptr<Arg>(A));284}285 286Arg *DerivedArgList::MakeFlagArg(const Arg *BaseArg, const Option Opt) const {287 SynthesizedArgs.push_back(288 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),289 BaseArgs.MakeIndex(Opt.getName()), BaseArg));290 return SynthesizedArgs.back().get();291}292 293Arg *DerivedArgList::MakePositionalArg(const Arg *BaseArg, const Option Opt,294 StringRef Value) const {295 unsigned Index = BaseArgs.MakeIndex(Value);296 SynthesizedArgs.push_back(297 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),298 Index, BaseArgs.getArgString(Index), BaseArg));299 return SynthesizedArgs.back().get();300}301 302Arg *DerivedArgList::MakeSeparateArg(const Arg *BaseArg, const Option Opt,303 StringRef Value) const {304 unsigned Index = BaseArgs.MakeIndex(Opt.getName(), Value);305 SynthesizedArgs.push_back(306 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),307 Index, BaseArgs.getArgString(Index + 1), BaseArg));308 return SynthesizedArgs.back().get();309}310 311Arg *DerivedArgList::MakeJoinedArg(const Arg *BaseArg, const Option Opt,312 StringRef Value) const {313 unsigned Index = BaseArgs.MakeIndex((Opt.getName() + Value).str());314 SynthesizedArgs.push_back(std::make_unique<Arg>(315 Opt, MakeArgString(Opt.getPrefix() + Opt.getName()), Index,316 BaseArgs.getArgString(Index) + Opt.getName().size(), BaseArg));317 return SynthesizedArgs.back().get();318}319