Home | History | Annotate | Download | only in Option 
      1 //===--- Arg.h - Parsed Argument Classes ------------------------*- 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 /// \file
     11 /// \brief Defines the llvm::Arg class for parsed arguments.
     12 ///
     13 //===----------------------------------------------------------------------===//
     14 
     15 #ifndef LLVM_OPTION_ARG_H
     16 #define LLVM_OPTION_ARG_H
     17 
     18 #include "llvm/ADT/SmallVector.h"
     19 #include "llvm/ADT/StringRef.h"
     20 #include "llvm/Option/Option.h"
     21 #include <string>
     22 
     23 namespace llvm {
     24 namespace opt {
     25 class ArgList;
     26 
     27 /// \brief A concrete instance of a particular driver option.
     28 ///
     29 /// The Arg class encodes just enough information to be able to
     30 /// derive the argument values efficiently.
     31 class Arg {
     32   Arg(const Arg &) = delete;
     33   void operator=(const Arg &) = delete;
     34 
     35 private:
     36   /// \brief The option this argument is an instance of.
     37   const Option Opt;
     38 
     39   /// \brief The argument this argument was derived from (during tool chain
     40   /// argument translation), if any.
     41   const Arg *BaseArg;
     42 
     43   /// \brief How this instance of the option was spelled.
     44   StringRef Spelling;
     45 
     46   /// \brief The index at which this argument appears in the containing
     47   /// ArgList.
     48   unsigned Index;
     49 
     50   /// \brief Was this argument used to effect compilation?
     51   ///
     52   /// This is used for generating "argument unused" diagnostics.
     53   mutable unsigned Claimed : 1;
     54 
     55   /// \brief Does this argument own its values?
     56   mutable unsigned OwnsValues : 1;
     57 
     58   /// \brief The argument values, as C strings.
     59   SmallVector<const char *, 2> Values;
     60 
     61 public:
     62   Arg(const Option Opt, StringRef Spelling, unsigned Index,
     63       const Arg *BaseArg = nullptr);
     64   Arg(const Option Opt, StringRef Spelling, unsigned Index,
     65       const char *Value0, const Arg *BaseArg = nullptr);
     66   Arg(const Option Opt, StringRef Spelling, unsigned Index,
     67       const char *Value0, const char *Value1, const Arg *BaseArg = nullptr);
     68   ~Arg();
     69 
     70   const Option &getOption() const { return Opt; }
     71   StringRef getSpelling() const { return Spelling; }
     72   unsigned getIndex() const { return Index; }
     73 
     74   /// \brief Return the base argument which generated this arg.
     75   ///
     76   /// This is either the argument itself or the argument it was
     77   /// derived from during tool chain specific argument translation.
     78   const Arg &getBaseArg() const {
     79     return BaseArg ? *BaseArg : *this;
     80   }
     81   void setBaseArg(const Arg *BaseArg) { this->BaseArg = BaseArg; }
     82 
     83   bool getOwnsValues() const { return OwnsValues; }
     84   void setOwnsValues(bool Value) const { OwnsValues = Value; }
     85 
     86   bool isClaimed() const { return getBaseArg().Claimed; }
     87 
     88   /// \brief Set the Arg claimed bit.
     89   void claim() const { getBaseArg().Claimed = true; }
     90 
     91   unsigned getNumValues() const { return Values.size(); }
     92   const char *getValue(unsigned N = 0) const {
     93     return Values[N];
     94   }
     95 
     96   SmallVectorImpl<const char*> &getValues() {
     97     return Values;
     98   }
     99 
    100   bool containsValue(StringRef Value) const {
    101     for (unsigned i = 0, e = getNumValues(); i != e; ++i)
    102       if (Values[i] == Value)
    103         return true;
    104     return false;
    105   }
    106 
    107   /// \brief Append the argument onto the given array as strings.
    108   void render(const ArgList &Args, ArgStringList &Output) const;
    109 
    110   /// \brief Append the argument, render as an input, onto the given
    111   /// array as strings.
    112   ///
    113   /// The distinction is that some options only render their values
    114   /// when rendered as a input (e.g., Xlinker).
    115   void renderAsInput(const ArgList &Args, ArgStringList &Output) const;
    116 
    117   void dump() const;
    118 
    119   /// \brief Return a formatted version of the argument and
    120   /// its values, for debugging and diagnostics.
    121   std::string getAsString(const ArgList &Args) const;
    122 };
    123 
    124 } // end namespace opt
    125 } // end namespace llvm
    126 
    127 #endif
    128