You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
132 lines
4.0 KiB
132 lines
4.0 KiB
//===--- Arg.h - Parsed Argument Classes ------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// \file
|
|
/// \brief Defines the llvm::Arg class for parsed arguments.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_OPTION_ARG_H
|
|
#define LLVM_OPTION_ARG_H
|
|
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Option/Option.h"
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
namespace opt {
|
|
class ArgList;
|
|
|
|
/// \brief A concrete instance of a particular driver option.
|
|
///
|
|
/// The Arg class encodes just enough information to be able to
|
|
/// derive the argument values efficiently. In addition, Arg
|
|
/// instances have an intrusive double linked list which is used by
|
|
/// ArgList to provide efficient iteration over all instances of a
|
|
/// particular option.
|
|
class Arg {
|
|
Arg(const Arg &) LLVM_DELETED_FUNCTION;
|
|
void operator=(const Arg &) LLVM_DELETED_FUNCTION;
|
|
|
|
private:
|
|
/// \brief The option this argument is an instance of.
|
|
const Option Opt;
|
|
|
|
/// \brief The argument this argument was derived from (during tool chain
|
|
/// argument translation), if any.
|
|
const Arg *BaseArg;
|
|
|
|
/// \brief How this instance of the option was spelled.
|
|
StringRef Spelling;
|
|
|
|
/// \brief The index at which this argument appears in the containing
|
|
/// ArgList.
|
|
unsigned Index;
|
|
|
|
/// \brief Was this argument used to effect compilation?
|
|
///
|
|
/// This is used for generating "argument unused" diagnostics.
|
|
mutable unsigned Claimed : 1;
|
|
|
|
/// \brief Does this argument own its values?
|
|
mutable unsigned OwnsValues : 1;
|
|
|
|
/// \brief The argument values, as C strings.
|
|
SmallVector<const char *, 2> Values;
|
|
|
|
public:
|
|
Arg(const Option Opt, StringRef Spelling, unsigned Index,
|
|
const Arg *BaseArg = 0);
|
|
Arg(const Option Opt, StringRef Spelling, unsigned Index,
|
|
const char *Value0, const Arg *BaseArg = 0);
|
|
Arg(const Option Opt, StringRef Spelling, unsigned Index,
|
|
const char *Value0, const char *Value1, const Arg *BaseArg = 0);
|
|
~Arg();
|
|
|
|
const Option getOption() const { return Opt; }
|
|
StringRef getSpelling() const { return Spelling; }
|
|
unsigned getIndex() const { return Index; }
|
|
|
|
/// \brief Return the base argument which generated this arg.
|
|
///
|
|
/// This is either the argument itself or the argument it was
|
|
/// derived from during tool chain specific argument translation.
|
|
const Arg &getBaseArg() const {
|
|
return BaseArg ? *BaseArg : *this;
|
|
}
|
|
void setBaseArg(const Arg *_BaseArg) {
|
|
BaseArg = _BaseArg;
|
|
}
|
|
|
|
bool getOwnsValues() const { return OwnsValues; }
|
|
void setOwnsValues(bool Value) const { OwnsValues = Value; }
|
|
|
|
bool isClaimed() const { return getBaseArg().Claimed; }
|
|
|
|
/// \brief Set the Arg claimed bit.
|
|
void claim() const { getBaseArg().Claimed = true; }
|
|
|
|
unsigned getNumValues() const { return Values.size(); }
|
|
const char *getValue(unsigned N = 0) const {
|
|
return Values[N];
|
|
}
|
|
|
|
SmallVectorImpl<const char*> &getValues() {
|
|
return Values;
|
|
}
|
|
|
|
bool containsValue(StringRef Value) const {
|
|
for (unsigned i = 0, e = getNumValues(); i != e; ++i)
|
|
if (Values[i] == Value)
|
|
return true;
|
|
return false;
|
|
}
|
|
|
|
/// \brief Append the argument onto the given array as strings.
|
|
void render(const ArgList &Args, ArgStringList &Output) const;
|
|
|
|
/// \brief Append the argument, render as an input, onto the given
|
|
/// array as strings.
|
|
///
|
|
/// The distinction is that some options only render their values
|
|
/// when rendered as a input (e.g., Xlinker).
|
|
void renderAsInput(const ArgList &Args, ArgStringList &Output) const;
|
|
|
|
void dump() const;
|
|
|
|
/// \brief Return a formatted version of the argument and
|
|
/// its values, for debugging and diagnostics.
|
|
std::string getAsString(const ArgList &Args) const;
|
|
};
|
|
|
|
} // end namespace opt
|
|
} // end namespace llvm
|
|
|
|
#endif
|