1 //===--- ArgList.h - Argument List Management ----------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #ifndef CLANG_DRIVER_ARGLIST_H_ 11 #define CLANG_DRIVER_ARGLIST_H_ 12 13 #include "clang/Basic/LLVM.h" 14 #include "clang/Driver/OptSpecifier.h" 15 #include "clang/Driver/Util.h" 16 #include "llvm/ADT/SmallVector.h" 17 #include "llvm/ADT/StringRef.h" 18 19 #include <list> 20 #include <string> 21 #include <vector> 22 23 namespace clang { 24 class DiagnosticsEngine; 25 26 namespace driver { 27 class Arg; 28 class ArgList; 29 class Option; 30 31 /// arg_iterator - Iterates through arguments stored inside an ArgList. 32 class arg_iterator { 33 /// The current argument. 34 SmallVectorImpl<Arg*>::const_iterator Current; 35 36 /// The argument list we are iterating over. 37 const ArgList &Args; 38 39 /// Optional filters on the arguments which will be match. Most clients 40 /// should never want to iterate over arguments without filters, so we won't 41 /// bother to factor this into two separate iterator implementations. 42 // 43 // FIXME: Make efficient; the idea is to provide efficient iteration over 44 // all arguments which match a particular id and then just provide an 45 // iterator combinator which takes multiple iterators which can be 46 // efficiently compared and returns them in order. 47 OptSpecifier Id0, Id1, Id2; 48 49 void SkipToNextArg(); 50 51 public: 52 typedef Arg * const * value_type; 53 typedef Arg * const & reference; 54 typedef Arg * const * pointer; 55 typedef std::forward_iterator_tag iterator_category; 56 typedef std::ptrdiff_t difference_type; 57 58 arg_iterator(SmallVectorImpl<Arg*>::const_iterator it, 59 const ArgList &_Args, OptSpecifier _Id0 = 0U, 60 OptSpecifier _Id1 = 0U, OptSpecifier _Id2 = 0U) 61 : Current(it), Args(_Args), Id0(_Id0), Id1(_Id1), Id2(_Id2) { 62 SkipToNextArg(); 63 } 64 65 operator const Arg*() { return *Current; } 66 reference operator*() const { return *Current; } 67 pointer operator->() const { return Current; } 68 69 arg_iterator &operator++() { 70 ++Current; 71 SkipToNextArg(); 72 return *this; 73 } 74 75 arg_iterator operator++(int) { 76 arg_iterator tmp(*this); 77 ++(*this); 78 return tmp; 79 } 80 81 friend bool operator==(arg_iterator LHS, arg_iterator RHS) { 82 return LHS.Current == RHS.Current; 83 } 84 friend bool operator!=(arg_iterator LHS, arg_iterator RHS) { 85 return !(LHS == RHS); 86 } 87 }; 88 89 /// ArgList - Ordered collection of driver arguments. 90 /// 91 /// The ArgList class manages a list of Arg instances as well as 92 /// auxiliary data and convenience methods to allow Tools to quickly 93 /// check for the presence of Arg instances for a particular Option 94 /// and to iterate over groups of arguments. 95 class ArgList { 96 private: 97 ArgList(const ArgList &); // DO NOT IMPLEMENT 98 void operator=(const ArgList &); // DO NOT IMPLEMENT 99 100 public: 101 typedef SmallVector<Arg*, 16> arglist_type; 102 typedef arglist_type::iterator iterator; 103 typedef arglist_type::const_iterator const_iterator; 104 typedef arglist_type::reverse_iterator reverse_iterator; 105 typedef arglist_type::const_reverse_iterator const_reverse_iterator; 106 107 private: 108 /// The internal list of arguments. 109 arglist_type Args; 110 111 protected: 112 ArgList(); 113 114 public: 115 virtual ~ArgList(); 116 117 /// @name Arg Access 118 /// @{ 119 120 /// append - Append \arg A to the arg list. 121 void append(Arg *A); 122 123 arglist_type &getArgs() { return Args; } 124 const arglist_type &getArgs() const { return Args; } 125 126 unsigned size() const { return Args.size(); } 127 128 /// @} 129 /// @name Arg Iteration 130 /// @{ 131 132 iterator begin() { return Args.begin(); } 133 iterator end() { return Args.end(); } 134 135 reverse_iterator rbegin() { return Args.rbegin(); } 136 reverse_iterator rend() { return Args.rend(); } 137 138 const_iterator begin() const { return Args.begin(); } 139 const_iterator end() const { return Args.end(); } 140 141 const_reverse_iterator rbegin() const { return Args.rbegin(); } 142 const_reverse_iterator rend() const { return Args.rend(); } 143 144 arg_iterator filtered_begin(OptSpecifier Id0 = 0U, OptSpecifier Id1 = 0U, 145 OptSpecifier Id2 = 0U) const { 146 return arg_iterator(Args.begin(), *this, Id0, Id1, Id2); 147 } 148 arg_iterator filtered_end() const { 149 return arg_iterator(Args.end(), *this); 150 } 151 152 /// @} 153 /// @name Arg Removal 154 /// @{ 155 156 /// eraseArg - Remove any option matching \arg Id. 157 void eraseArg(OptSpecifier Id); 158 159 /// @} 160 /// @name Arg Access 161 /// @{ 162 163 /// hasArg - Does the arg list contain any option matching \arg Id. 164 /// 165 /// \arg Claim Whether the argument should be claimed, if it exists. 166 bool hasArgNoClaim(OptSpecifier Id) const { 167 return getLastArgNoClaim(Id) != 0; 168 } 169 bool hasArg(OptSpecifier Id) const { 170 return getLastArg(Id) != 0; 171 } 172 bool hasArg(OptSpecifier Id0, OptSpecifier Id1) const { 173 return getLastArg(Id0, Id1) != 0; 174 } 175 bool hasArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const { 176 return getLastArg(Id0, Id1, Id2) != 0; 177 } 178 179 /// getLastArg - Return the last argument matching \arg Id, or null. 180 /// 181 /// \arg Claim Whether the argument should be claimed, if it exists. 182 Arg *getLastArgNoClaim(OptSpecifier Id) const; 183 Arg *getLastArg(OptSpecifier Id) const; 184 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const; 185 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const; 186 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 187 OptSpecifier Id3) const; 188 189 /// getArgString - Return the input argument string at \arg Index. 190 virtual const char *getArgString(unsigned Index) const = 0; 191 192 /// getNumInputArgStrings - Return the number of original argument strings, 193 /// which are guaranteed to be the first strings in the argument string 194 /// list. 195 virtual unsigned getNumInputArgStrings() const = 0; 196 197 /// @} 198 /// @name Argument Lookup Utilities 199 /// @{ 200 201 /// getLastArgValue - Return the value of the last argument, or a default. 202 StringRef getLastArgValue(OptSpecifier Id, 203 StringRef Default = "") const; 204 205 /// getLastArgValue - Return the value of the last argument as an integer, 206 /// or a default. Emits an error if the argument is given, but non-integral. 207 int getLastArgIntValue(OptSpecifier Id, int Default, 208 DiagnosticsEngine &Diags) const; 209 210 /// getAllArgValues - Get the values of all instances of the given argument 211 /// as strings. 212 std::vector<std::string> getAllArgValues(OptSpecifier Id) const; 213 214 /// @} 215 /// @name Translation Utilities 216 /// @{ 217 218 /// hasFlag - Given an option \arg Pos and its negative form \arg 219 /// Neg, return true if the option is present, false if the 220 /// negation is present, and \arg Default if neither option is 221 /// given. If both the option and its negation are present, the 222 /// last one wins. 223 bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const; 224 225 /// AddLastArg - Render only the last argument match \arg Id0, if 226 /// present. 227 void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const; 228 229 /// AddAllArgs - Render all arguments matching the given ids. 230 void AddAllArgs(ArgStringList &Output, OptSpecifier Id0, 231 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const; 232 233 /// AddAllArgValues - Render the argument values of all arguments 234 /// matching the given ids. 235 void AddAllArgValues(ArgStringList &Output, OptSpecifier Id0, 236 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const; 237 238 /// AddAllArgsTranslated - Render all the arguments matching the 239 /// given ids, but forced to separate args and using the provided 240 /// name instead of the first option value. 241 /// 242 /// \param Joined - If true, render the argument as joined with 243 /// the option specifier. 244 void AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0, 245 const char *Translation, 246 bool Joined = false) const; 247 248 /// ClaimAllArgs - Claim all arguments which match the given 249 /// option id. 250 void ClaimAllArgs(OptSpecifier Id0) const; 251 252 /// ClaimAllArgs - Claim all arguments. 253 /// 254 void ClaimAllArgs() const; 255 256 /// @} 257 /// @name Arg Synthesis 258 /// @{ 259 260 /// MakeArgString - Construct a constant string pointer whose 261 /// lifetime will match that of the ArgList. 262 virtual const char *MakeArgString(StringRef Str) const = 0; 263 const char *MakeArgString(const char *Str) const { 264 return MakeArgString(StringRef(Str)); 265 } 266 const char *MakeArgString(std::string Str) const { 267 return MakeArgString(StringRef(Str)); 268 } 269 const char *MakeArgString(const Twine &Str) const; 270 271 /// \brief Create an arg string for (\arg LHS + \arg RHS), reusing the 272 /// string at \arg Index if possible. 273 const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS, 274 StringRef RHS) const; 275 276 /// @} 277 }; 278 279 class InputArgList : public ArgList { 280 private: 281 /// List of argument strings used by the contained Args. 282 /// 283 /// This is mutable since we treat the ArgList as being the list 284 /// of Args, and allow routines to add new strings (to have a 285 /// convenient place to store the memory) via MakeIndex. 286 mutable ArgStringList ArgStrings; 287 288 /// Strings for synthesized arguments. 289 /// 290 /// This is mutable since we treat the ArgList as being the list 291 /// of Args, and allow routines to add new strings (to have a 292 /// convenient place to store the memory) via MakeIndex. 293 mutable std::list<std::string> SynthesizedStrings; 294 295 /// The number of original input argument strings. 296 unsigned NumInputArgStrings; 297 298 public: 299 InputArgList(const char* const *ArgBegin, const char* const *ArgEnd); 300 ~InputArgList(); 301 302 virtual const char *getArgString(unsigned Index) const { 303 return ArgStrings[Index]; 304 } 305 306 virtual unsigned getNumInputArgStrings() const { 307 return NumInputArgStrings; 308 } 309 310 /// @name Arg Synthesis 311 /// @{ 312 313 public: 314 /// MakeIndex - Get an index for the given string(s). 315 unsigned MakeIndex(StringRef String0) const; 316 unsigned MakeIndex(StringRef String0, StringRef String1) const; 317 318 virtual const char *MakeArgString(StringRef Str) const; 319 320 /// @} 321 }; 322 323 /// DerivedArgList - An ordered collection of driver arguments, 324 /// whose storage may be in another argument list. 325 class DerivedArgList : public ArgList { 326 const InputArgList &BaseArgs; 327 328 /// The list of arguments we synthesized. 329 mutable arglist_type SynthesizedArgs; 330 331 public: 332 /// Construct a new derived arg list from \arg BaseArgs. 333 DerivedArgList(const InputArgList &BaseArgs); 334 ~DerivedArgList(); 335 336 virtual const char *getArgString(unsigned Index) const { 337 return BaseArgs.getArgString(Index); 338 } 339 340 virtual unsigned getNumInputArgStrings() const { 341 return BaseArgs.getNumInputArgStrings(); 342 } 343 344 const InputArgList &getBaseArgs() const { 345 return BaseArgs; 346 } 347 348 /// @name Arg Synthesis 349 /// @{ 350 351 /// AddSynthesizedArg - Add a argument to the list of synthesized arguments 352 /// (to be freed). 353 void AddSynthesizedArg(Arg *A) { 354 SynthesizedArgs.push_back(A); 355 } 356 357 virtual const char *MakeArgString(StringRef Str) const; 358 359 /// AddFlagArg - Construct a new FlagArg for the given option \arg Id and 360 /// append it to the argument list. 361 void AddFlagArg(const Arg *BaseArg, const Option *Opt) { 362 append(MakeFlagArg(BaseArg, Opt)); 363 } 364 365 /// AddPositionalArg - Construct a new Positional arg for the given option 366 /// \arg Id, with the provided \arg Value and append it to the argument 367 /// list. 368 void AddPositionalArg(const Arg *BaseArg, const Option *Opt, 369 StringRef Value) { 370 append(MakePositionalArg(BaseArg, Opt, Value)); 371 } 372 373 374 /// AddSeparateArg - Construct a new Positional arg for the given option 375 /// \arg Id, with the provided \arg Value and append it to the argument 376 /// list. 377 void AddSeparateArg(const Arg *BaseArg, const Option *Opt, 378 StringRef Value) { 379 append(MakeSeparateArg(BaseArg, Opt, Value)); 380 } 381 382 383 /// AddJoinedArg - Construct a new Positional arg for the given option \arg 384 /// Id, with the provided \arg Value and append it to the argument list. 385 void AddJoinedArg(const Arg *BaseArg, const Option *Opt, 386 StringRef Value) { 387 append(MakeJoinedArg(BaseArg, Opt, Value)); 388 } 389 390 391 /// MakeFlagArg - Construct a new FlagArg for the given option 392 /// \arg Id. 393 Arg *MakeFlagArg(const Arg *BaseArg, const Option *Opt) const; 394 395 /// MakePositionalArg - Construct a new Positional arg for the 396 /// given option \arg Id, with the provided \arg Value. 397 Arg *MakePositionalArg(const Arg *BaseArg, const Option *Opt, 398 StringRef Value) const; 399 400 /// MakeSeparateArg - Construct a new Positional arg for the 401 /// given option \arg Id, with the provided \arg Value. 402 Arg *MakeSeparateArg(const Arg *BaseArg, const Option *Opt, 403 StringRef Value) const; 404 405 /// MakeJoinedArg - Construct a new Positional arg for the 406 /// given option \arg Id, with the provided \arg Value. 407 Arg *MakeJoinedArg(const Arg *BaseArg, const Option *Opt, 408 StringRef Value) const; 409 410 /// @} 411 }; 412 413 } // end namespace driver 414 } // end namespace clang 415 416 #endif 417
