1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===- Arg.h - Parsed Argument Classes --------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
/// 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 {
class raw_ostream;
namespace opt {
class ArgList;
/// A concrete instance of a particular driver option.
///
/// The Arg class encodes just enough information to be able to
/// derive the argument values efficiently.
class Arg {
private:
/// The option this argument is an instance of.
const Option Opt;
/// The argument this argument was derived from (during tool chain
/// argument translation), if any.
const Arg *BaseArg;
/// How this instance of the option was spelled.
StringRef Spelling;
/// The index at which this argument appears in the containing
/// ArgList.
unsigned Index;
/// Was this argument used to effect compilation?
///
/// This is used for generating "argument unused" diagnostics.
mutable unsigned Claimed : 1;
/// Does this argument own its values?
mutable unsigned OwnsValues : 1;
/// The argument values, as C strings.
SmallVector<const char *, 2> Values;
/// If this arg was created through an alias, this is the original alias arg.
/// For example, *this might be "-finput-charset=utf-8" and Alias might
/// point to an arg representing "/source-charset:utf-8".
std::unique_ptr<Arg> Alias;
public:
Arg(const Option Opt, StringRef Spelling, unsigned Index,
const Arg *BaseArg = nullptr);
Arg(const Option Opt, StringRef Spelling, unsigned Index,
const char *Value0, const Arg *BaseArg = nullptr);
Arg(const Option Opt, StringRef Spelling, unsigned Index,
const char *Value0, const char *Value1, const Arg *BaseArg = nullptr);
Arg(const Arg &) = delete;
Arg &operator=(const Arg &) = delete;
~Arg();
const Option &getOption() const { return Opt; }
/// Returns the used prefix and name of the option:
/// For `--foo=bar`, returns `--foo=`.
/// This is often the wrong function to call:
/// * Use `getValue()` to get `bar`.
/// * Use `getAsString()` to get a string suitable for printing an Arg in
/// a diagnostic.
StringRef getSpelling() const { return Spelling; }
unsigned getIndex() const { return Index; }
/// 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) { this->BaseArg = BaseArg; }
/// Args are converted to their unaliased form. For args that originally
/// came from an alias, this returns the alias the arg was produced from.
const Arg* getAlias() const { return Alias.get(); }
void setAlias(std::unique_ptr<Arg> Alias) { this->Alias = std::move(Alias); }
bool getOwnsValues() const { return OwnsValues; }
void setOwnsValues(bool Value) const { OwnsValues = Value; }
bool isClaimed() const { return getBaseArg().Claimed; }
/// 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; }
const SmallVectorImpl<const char *> &getValues() const { return Values; }
bool containsValue(StringRef Value) const {
for (unsigned i = 0, e = getNumValues(); i != e; ++i)
if (Values[i] == Value)
return true;
return false;
}
/// Append the argument onto the given array as strings.
void render(const ArgList &Args, ArgStringList &Output) const;
/// 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 print(raw_ostream &O) const;
void dump() const;
/// Return a formatted version of the argument and its values, for
/// diagnostics. Since this is for diagnostics, if this Arg was produced
/// through an alias, this returns the string representation of the alias
/// that the user wrote.
std::string getAsString(const ArgList &Args) const;
};
} // end namespace opt
} // end namespace llvm
#endif // LLVM_OPTION_ARG_H
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
