1 //===--- OptParser.td - Common Option Parsing Interfaces ------------------===//
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 // This file defines the common interfaces used by the option parsing TableGen
13 //===----------------------------------------------------------------------===//
15 // Define the kinds of options.
17 class OptionKind<string name, int precedence = 0, bit sentinel = 0> {
19 // The kind precedence, kinds with lower precedence are matched first.
20 int Precedence = precedence;
21 // Indicate a sentinel option.
22 bit Sentinel = sentinel;
26 def KIND_GROUP : OptionKind<"Group">;
27 // The input option kind.
28 def KIND_INPUT : OptionKind<"Input", 1, 1>;
29 // The unknown option kind.
30 def KIND_UNKNOWN : OptionKind<"Unknown", 2, 1>;
31 // A flag with no values.
32 def KIND_FLAG : OptionKind<"Flag">;
33 // An option which prefixes its (single) value.
34 def KIND_JOINED : OptionKind<"Joined", 1>;
35 // An option which is followed by its value.
36 def KIND_SEPARATE : OptionKind<"Separate">;
37 // An option followed by its values, which are separated by commas.
38 def KIND_COMMAJOINED : OptionKind<"CommaJoined">;
39 // An option which is which takes multiple (separate) arguments.
40 def KIND_MULTIARG : OptionKind<"MultiArg">;
41 // An option which is either joined to its (non-empty) value, or followed by its
43 def KIND_JOINED_OR_SEPARATE : OptionKind<"JoinedOrSeparate">;
44 // An option which is both joined to its (first) value, and followed by its
46 def KIND_JOINED_AND_SEPARATE : OptionKind<"JoinedAndSeparate">;
47 // An option which consumes all remaining arguments if there are any.
48 def KIND_REMAINING_ARGS : OptionKind<"RemainingArgs">;
50 // Define the option flags.
54 // HelpHidden - The option should not be displayed in --help, even if it has
55 // help text. Clients *can* use this in conjunction with the OptTable::PrintHelp
56 // arguments to implement hidden help groups.
57 def HelpHidden : OptionFlag;
59 // RenderAsInput - The option should not render the name when rendered as an
60 // input (i.e., the option is rendered as values).
61 def RenderAsInput : OptionFlag;
63 // RenderJoined - The option should be rendered joined, even if separate (only
64 // sensible on single value separate options).
65 def RenderJoined : OptionFlag;
67 // RenderSeparate - The option should be rendered separately, even if joined
68 // (only sensible on joined options).
69 def RenderSeparate : OptionFlag;
71 // Define the option group class.
73 class OptionGroup<string name> {
74 string EnumName = ?; // Uses the def name if undefined.
77 OptionGroup Group = ?;
78 list<OptionFlag> Flags = [];
81 // Define the option class.
83 class Option<list<string> prefixes, string name, OptionKind kind> {
84 string EnumName = ?; // Uses the def name if undefined.
85 list<string> Prefixes = prefixes;
87 OptionKind Kind = kind;
88 // Used by MultiArg option kind.
91 string MetaVarName = ?;
92 list<OptionFlag> Flags = [];
93 OptionGroup Group = ?;
95 list<string> AliasArgs = [];
98 // Helpers for defining options.
100 class Flag<list<string> prefixes, string name>
101 : Option<prefixes, name, KIND_FLAG>;
102 class Joined<list<string> prefixes, string name>
103 : Option<prefixes, name, KIND_JOINED>;
104 class Separate<list<string> prefixes, string name>
105 : Option<prefixes, name, KIND_SEPARATE>;
106 class CommaJoined<list<string> prefixes, string name>
107 : Option<prefixes, name, KIND_COMMAJOINED>;
108 class MultiArg<list<string> prefixes, string name, int numargs>
109 : Option<prefixes, name, KIND_MULTIARG> {
110 int NumArgs = numargs;
112 class JoinedOrSeparate<list<string> prefixes, string name>
113 : Option<prefixes, name, KIND_JOINED_OR_SEPARATE>;
114 class JoinedAndSeparate<list<string> prefixes, string name>
115 : Option<prefixes, name, KIND_JOINED_AND_SEPARATE>;
117 // Mix-ins for adding optional attributes.
119 class Alias<Option alias> { Option Alias = alias; }
120 class AliasArgs<list<string> aliasargs> { list<string> AliasArgs = aliasargs; }
121 class EnumName<string name> { string EnumName = name; }
122 class Flags<list<OptionFlag> flags> { list<OptionFlag> Flags = flags; }
123 class Group<OptionGroup group> { OptionGroup Group = group; }
124 class HelpText<string text> { string HelpText = text; }
125 class MetaVarName<string name> { string MetaVarName = name; }
127 // Predefined options.
129 // FIXME: Have generator validate that these appear in correct position (and
130 // aren't duplicated).
131 def INPUT : Option<[], "<input>", KIND_INPUT>;
132 def UNKNOWN : Option<[], "<unknown>", KIND_UNKNOWN>;