[RISCV][VLOPT] Add vector narrowing integer right shift instructions to isSupportedIn...
[llvm-project.git] / llvm / utils / TableGen / OptionRSTEmitter.cpp
blob6eac10e1831f022e60605c17c3016a45aad7edbb
1 //===- OptionRSTEmitter.cpp - Table Driven Command Line Option Parsing ----===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
9 #include "Common/OptEmitter.h"
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/ADT/StringMap.h"
12 #include "llvm/TableGen/Record.h"
13 #include "llvm/TableGen/TableGenBackend.h"
15 using namespace llvm;
17 /// This tablegen backend takes an input .td file describing a list of options
18 /// and emits a RST man page.
19 static void emitOptionRst(const RecordKeeper &Records, raw_ostream &OS) {
20 llvm::StringMap<std::vector<const Record *>> OptionsByGroup;
22 // Get the options.
23 std::vector<const Record *> Opts = Records.getAllDerivedDefinitions("Option");
24 llvm::sort(Opts, IsOptionRecordsLess);
26 // Get the option groups.
27 for (const Record *R : Records.getAllDerivedDefinitions("OptionGroup"))
28 OptionsByGroup.try_emplace(R->getValueAsString("Name"));
30 // Map options to their group.
31 for (const Record *R : Opts) {
32 if (const DefInit *DI = dyn_cast<DefInit>(R->getValueInit("Group")))
33 OptionsByGroup[DI->getDef()->getValueAsString("Name")].push_back(R);
34 else
35 OptionsByGroup["options"].push_back(R);
38 // Print options under their group.
39 for (const auto &KV : OptionsByGroup) {
40 std::string GroupName = KV.getKey().upper();
41 OS << GroupName << '\n';
42 OS << std::string(GroupName.size(), '-') << '\n';
43 OS << '\n';
45 for (const Record *R : KV.getValue()) {
46 OS << ".. option:: ";
48 // Print the prefix.
49 std::vector<StringRef> Prefixes = R->getValueAsListOfStrings("Prefixes");
50 if (!Prefixes.empty())
51 OS << Prefixes[0];
53 // Print the option name.
54 OS << R->getValueAsString("Name");
56 StringRef MetaVarName;
57 // Print the meta-variable.
58 if (!isa<UnsetInit>(R->getValueInit("MetaVarName"))) {
59 MetaVarName = R->getValueAsString("MetaVarName");
60 } else if (!isa<UnsetInit>(R->getValueInit("Values")))
61 MetaVarName = "<value>";
63 if (!MetaVarName.empty()) {
64 OS << '=';
65 OS.write_escaped(MetaVarName);
68 OS << "\n\n";
70 std::string HelpText;
71 // The option help text.
72 if (!isa<UnsetInit>(R->getValueInit("HelpText"))) {
73 HelpText = R->getValueAsString("HelpText").trim().str();
74 if (!HelpText.empty() && HelpText.back() != '.')
75 HelpText.push_back('.');
78 if (!isa<UnsetInit>(R->getValueInit("Values"))) {
79 SmallVector<StringRef> Values;
80 SplitString(R->getValueAsString("Values"), Values, ",");
81 HelpText += (" " + MetaVarName + " must be '").str();
83 if (Values.size() > 1) {
84 HelpText += join(Values.begin(), Values.end() - 1, "', '");
85 HelpText += "' or '";
87 HelpText += (Values.back() + "'.").str();
90 if (!HelpText.empty()) {
91 OS << ' ';
92 OS.write_escaped(HelpText);
93 OS << "\n\n";
99 static TableGen::Emitter::Opt X("gen-opt-rst", emitOptionRst,
100 "Generate option RST");