1 //===--- Option.h - Abstract Driver Options ---------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_OPTION_OPTION_H
11 #define LLVM_OPTION_OPTION_H
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/Option/OptTable.h"
16 #include "llvm/Support/ErrorHandling.h"
22 /// ArgStringList - Type used for constructing argv lists for subprocesses.
23 typedef SmallVector<const char*, 16> ArgStringList;
25 /// Base flags for all options. Custom flags may be added after.
27 HelpHidden = (1 << 0),
28 RenderAsInput = (1 << 1),
29 RenderJoined = (1 << 2),
30 RenderSeparate = (1 << 3)
33 /// Option - Abstract representation for a single form of driver
36 /// An Option class represents a form of option that the driver
37 /// takes, for example how many arguments the option has and how
38 /// they can be provided. Individual option instances store
39 /// additional information about what group the option is a member
40 /// of (if any), if the option is an alias, and a number of
41 /// flags. At runtime the driver parses the command line into
42 /// concrete Arg instances, each of which corresponds to a
43 /// particular Option instance.
56 JoinedOrSeparateClass,
57 JoinedAndSeparateClass
60 enum RenderStyleKind {
61 RenderCommaJoinedStyle,
68 const OptTable::Info *Info;
69 const OptTable *Owner;
72 Option(const OptTable::Info *Info, const OptTable *Owner);
75 bool isValid() const {
76 return Info != nullptr;
79 unsigned getID() const {
80 assert(Info && "Must have a valid info!");
84 OptionClass getKind() const {
85 assert(Info && "Must have a valid info!");
86 return OptionClass(Info->Kind);
89 /// \brief Get the name of this option without any prefix.
90 StringRef getName() const {
91 assert(Info && "Must have a valid info!");
95 const Option getGroup() const {
96 assert(Info && "Must have a valid info!");
97 assert(Owner && "Must have a valid owner!");
98 return Owner->getOption(Info->GroupID);
101 const Option getAlias() const {
102 assert(Info && "Must have a valid info!");
103 assert(Owner && "Must have a valid owner!");
104 return Owner->getOption(Info->AliasID);
107 /// \brief Get the alias arguments as a \0 separated list.
108 /// E.g. ["foo", "bar"] would be returned as "foo\0bar\0".
109 const char *getAliasArgs() const {
110 assert(Info && "Must have a valid info!");
111 assert((!Info->AliasArgs || Info->AliasArgs[0] != 0) &&
112 "AliasArgs should be either 0 or non-empty.");
114 return Info->AliasArgs;
117 /// \brief Get the default prefix for this option.
118 StringRef getPrefix() const {
119 const char *Prefix = *Info->Prefixes;
120 return Prefix ? Prefix : StringRef();
123 /// \brief Get the name of this option with the default prefix.
124 std::string getPrefixedName() const {
125 std::string Ret = getPrefix();
130 unsigned getNumArgs() const { return Info->Param; }
132 bool hasNoOptAsInput() const { return Info->Flags & RenderAsInput;}
134 RenderStyleKind getRenderStyle() const {
135 if (Info->Flags & RenderJoined)
136 return RenderJoinedStyle;
137 if (Info->Flags & RenderSeparate)
138 return RenderSeparateStyle;
143 return RenderValuesStyle;
145 case JoinedAndSeparateClass:
146 return RenderJoinedStyle;
147 case CommaJoinedClass:
148 return RenderCommaJoinedStyle;
152 case JoinedOrSeparateClass:
153 case RemainingArgsClass:
154 return RenderSeparateStyle;
156 llvm_unreachable("Unexpected kind!");
159 /// Test if this option has the flag \a Val.
160 bool hasFlag(unsigned Val) const {
161 return Info->Flags & Val;
164 /// getUnaliasedOption - Return the final option this option
165 /// aliases (itself, if the option has no alias).
166 const Option getUnaliasedOption() const {
167 const Option Alias = getAlias();
168 if (Alias.isValid()) return Alias.getUnaliasedOption();
172 /// getRenderName - Return the name to use when rendering this
174 StringRef getRenderName() const {
175 return getUnaliasedOption().getName();
178 /// matches - Predicate for whether this option is part of the
179 /// given option (which may be a group).
181 /// Note that matches against options which are an alias should never be
182 /// done -- aliases do not participate in matching and so such a query will
184 bool matches(OptSpecifier ID) const;
186 /// accept - Potentially accept the current argument, returning a
187 /// new Arg instance, or 0 if the option does not accept this
188 /// argument (or the argument is missing values).
190 /// If the option accepts the current argument, accept() sets
191 /// Index to the position where argument parsing should resume
192 /// (even if the argument is missing values).
194 /// \param ArgSize The number of bytes taken up by the matched Option prefix
195 /// and name. This is used to determine where joined values
197 Arg *accept(const ArgList &Args, unsigned &Index, unsigned ArgSize) const;
202 } // end namespace opt
203 } // end namespace llvm