[PATCH] D38969: Sort Attributes by "HeaderName"
This revision was automatically updated to reflect the committed changes.
Closed by commit rL315931: Sort Attributes by "HeaderName" (authored by
erichkeane).
Changed prior to commit:
https://reviews.llvm.org/D38969?vs=119195&id=119200#toc
Repository:
rL LLVM
https://reviews.llvm.org/D38969
Files:
cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp
Index: cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp
===
--- cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp
+++ cfe/trunk/utils/TableGen/ClangAttrEmitter.cpp
@@ -3663,9 +3663,14 @@
public:
const Record *Documentation;
const Record *Attribute;
+ std::string Heading;
+ unsigned SupportedSpellings;
- DocumentationData(const Record &Documentation, const Record &Attribute)
- : Documentation(&Documentation), Attribute(&Attribute) {}
+ DocumentationData(const Record &Documentation, const Record &Attribute,
+const std::pair HeadingAndKinds)
+ : Documentation(&Documentation), Attribute(&Attribute),
+Heading(std::move(HeadingAndKinds.first)),
+SupportedSpellings(HeadingAndKinds.second) {}
};
static void WriteCategoryHeader(const Record *DocCategory,
@@ -3691,16 +3696,17 @@
Pragma = 1 << 6
};
-static void WriteDocumentation(RecordKeeper &Records,
- const DocumentationData &Doc, raw_ostream &OS) {
+static std::pair
+GetAttributeHeadingAndSpellingKinds(const Record &Documentation,
+const Record &Attribute) {
// FIXME: there is no way to have a per-spelling category for the attribute
// documentation. This may not be a limiting factor since the spellings
// should generally be consistently applied across the category.
- std::vector Spellings = GetFlattenedSpellings(*Doc.Attribute);
+ std::vector Spellings = GetFlattenedSpellings(Attribute);
// Determine the heading to be used for this attribute.
- std::string Heading = Doc.Documentation->getValueAsString("Heading");
+ std::string Heading = Documentation.getValueAsString("Heading");
bool CustomHeading = !Heading.empty();
if (Heading.empty()) {
// If there's only one spelling, we can simply use that.
@@ -3722,7 +3728,7 @@
// If the heading is still empty, it is an error.
if (Heading.empty())
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"This attribute requires a heading to be specified");
// Gather a list of unique spellings; this is not the same as the semantic
@@ -3765,29 +3771,33 @@
}
Heading += ")";
}
- OS << Heading << "\n" << std::string(Heading.length(), '-') << "\n";
-
if (!SupportedSpellings)
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"Attribute has no supported spellings; cannot be "
"documented");
+ return std::make_pair(std::move(Heading), SupportedSpellings);
+}
+
+static void WriteDocumentation(RecordKeeper &Records,
+ const DocumentationData &Doc, raw_ostream &OS) {
+ OS << Doc.Heading << "\n" << std::string(Doc.Heading.length(), '-') << "\n";
// List what spelling syntaxes the attribute supports.
OS << ".. csv-table:: Supported Syntaxes\n";
OS << " :header: \"GNU\", \"C++11\", \"C2x\", \"__declspec\", \"Keyword\",";
OS << " \"Pragma\", \"Pragma clang attribute\"\n\n";
OS << " \"";
- if (SupportedSpellings & GNU) OS << "X";
+ if (Doc.SupportedSpellings & GNU) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & CXX11) OS << "X";
+ if (Doc.SupportedSpellings & CXX11) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & C2x) OS << "X";
+ if (Doc.SupportedSpellings & C2x) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Declspec) OS << "X";
+ if (Doc.SupportedSpellings & Declspec) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Keyword) OS << "X";
+ if (Doc.SupportedSpellings & Keyword) OS << "X";
OS << "\", \"";
- if (SupportedSpellings & Pragma) OS << "X";
+ if (Doc.SupportedSpellings & Pragma) OS << "X";
OS << "\", \"";
if (getPragmaAttributeSupport(Records).isAttributedSupported(*Doc.Attribute))
OS << "X";
@@ -3842,18 +3852,24 @@
if (Undocumented && Docs.size() > 1)
PrintFatalError(Doc.getLoc(),
"Attribute is \"Undocumented\", but has multiple "
-"documentation categories");
+"documentation categories");
if (!Undocumented)
-SplitDocs[Category].push_back(DocumentationData(Doc, Attr));
+SplitDocs[Category].push_back(DocumentationData(
+Doc, Attr, GetAttributeHeadingAndSpellingKinds(Doc, Attr)));
}
}
// Having split the attributes out based on what documentation goes where,
// we can begin to generate sections of documentation.
- for (const auto &I : SplitDocs) {
[PATCH] D38969: Sort Attributes by "HeaderName"
aaron.ballman accepted this revision. aaron.ballman added a comment. This revision is now accepted and ready to land. LGTM, thank you! https://reviews.llvm.org/D38969 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D38969: Sort Attributes by "HeaderName"
erichkeane updated this revision to Diff 119195.
erichkeane added a comment.
Change the constructor in DocumentationData to take by value.
https://reviews.llvm.org/D38969
Files:
utils/TableGen/ClangAttrEmitter.cpp
Index: utils/TableGen/ClangAttrEmitter.cpp
===
--- utils/TableGen/ClangAttrEmitter.cpp
+++ utils/TableGen/ClangAttrEmitter.cpp
@@ -3663,9 +3663,14 @@
public:
const Record *Documentation;
const Record *Attribute;
+ std::string Heading;
+ unsigned SupportedSpellings;
- DocumentationData(const Record &Documentation, const Record &Attribute)
- : Documentation(&Documentation), Attribute(&Attribute) {}
+ DocumentationData(const Record &Documentation, const Record &Attribute,
+const std::pair HeadingAndKinds)
+ : Documentation(&Documentation), Attribute(&Attribute),
+Heading(std::move(HeadingAndKinds.first)),
+SupportedSpellings(HeadingAndKinds.second) {}
};
static void WriteCategoryHeader(const Record *DocCategory,
@@ -3691,16 +3696,17 @@
Pragma = 1 << 6
};
-static void WriteDocumentation(RecordKeeper &Records,
- const DocumentationData &Doc, raw_ostream &OS) {
+static std::pair
+GetAttributeHeadingAndSpellingKinds(const Record &Documentation,
+const Record &Attribute) {
// FIXME: there is no way to have a per-spelling category for the attribute
// documentation. This may not be a limiting factor since the spellings
// should generally be consistently applied across the category.
- std::vector Spellings = GetFlattenedSpellings(*Doc.Attribute);
+ std::vector Spellings = GetFlattenedSpellings(Attribute);
// Determine the heading to be used for this attribute.
- std::string Heading = Doc.Documentation->getValueAsString("Heading");
+ std::string Heading = Documentation.getValueAsString("Heading");
bool CustomHeading = !Heading.empty();
if (Heading.empty()) {
// If there's only one spelling, we can simply use that.
@@ -3722,7 +3728,7 @@
// If the heading is still empty, it is an error.
if (Heading.empty())
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"This attribute requires a heading to be specified");
// Gather a list of unique spellings; this is not the same as the semantic
@@ -3765,29 +3771,33 @@
}
Heading += ")";
}
- OS << Heading << "\n" << std::string(Heading.length(), '-') << "\n";
-
if (!SupportedSpellings)
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"Attribute has no supported spellings; cannot be "
"documented");
+ return std::make_pair(std::move(Heading), SupportedSpellings);
+}
+
+static void WriteDocumentation(RecordKeeper &Records,
+ const DocumentationData &Doc, raw_ostream &OS) {
+ OS << Doc.Heading << "\n" << std::string(Doc.Heading.length(), '-') << "\n";
// List what spelling syntaxes the attribute supports.
OS << ".. csv-table:: Supported Syntaxes\n";
OS << " :header: \"GNU\", \"C++11\", \"C2x\", \"__declspec\", \"Keyword\",";
OS << " \"Pragma\", \"Pragma clang attribute\"\n\n";
OS << " \"";
- if (SupportedSpellings & GNU) OS << "X";
+ if (Doc.SupportedSpellings & GNU) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & CXX11) OS << "X";
+ if (Doc.SupportedSpellings & CXX11) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & C2x) OS << "X";
+ if (Doc.SupportedSpellings & C2x) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Declspec) OS << "X";
+ if (Doc.SupportedSpellings & Declspec) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Keyword) OS << "X";
+ if (Doc.SupportedSpellings & Keyword) OS << "X";
OS << "\", \"";
- if (SupportedSpellings & Pragma) OS << "X";
+ if (Doc.SupportedSpellings & Pragma) OS << "X";
OS << "\", \"";
if (getPragmaAttributeSupport(Records).isAttributedSupported(*Doc.Attribute))
OS << "X";
@@ -3842,18 +3852,24 @@
if (Undocumented && Docs.size() > 1)
PrintFatalError(Doc.getLoc(),
"Attribute is \"Undocumented\", but has multiple "
-"documentation categories");
+"documentation categories");
if (!Undocumented)
-SplitDocs[Category].push_back(DocumentationData(Doc, Attr));
+SplitDocs[Category].push_back(DocumentationData(
+Doc, Attr, GetAttributeHeadingAndSpellingKinds(Doc, Attr)));
}
}
// Having split the attributes out based on what documentation goes where,
// we can begin to generate sections of documentation.
- for (const auto &I : SplitDocs) {
+ for (auto &I : SplitDocs) {
WriteCategoryHeader(I.first, OS);
+std::sort(I.second.begin(), I.second.end(),
+ [](const DocumentationData &D1,
[PATCH] D38969: Sort Attributes by "HeaderName"
erichkeane added inline comments. Comment at: utils/TableGen/ClangAttrEmitter.cpp:3670 + DocumentationData(const Record &Documentation, const Record &Attribute, +const std::pair &&HeadingAndKinds) + : Documentation(&Documentation), Attribute(&Attribute), Craig brought up that I could just take by value and move out of 'first', which is more flexible for usage. New patch incoming once it passes a build. https://reviews.llvm.org/D38969 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D38969: Sort Attributes by "HeaderName"
erichkeane added a comment.
Additionally, I'm going to edit the 'interrupt' docs in a separate commit to
give each a separate header name based on the architecture. Currently they are
all named 'interrupt', so I want to rename them all interrupt (x86), etc. Look
for a future review!
Comment at: utils/TableGen/ClangAttrEmitter.cpp:3666
const Record *Attribute;
+ std::string Heading;
+ unsigned SupportedSpellings;
These two cannot be 'const', otherwise operator= is suppressed. Thus,
std::sort won't work (Requires ValueSwappable).
Comment at: utils/TableGen/ClangAttrEmitter.cpp:3865
// we can begin to generate sections of documentation.
- for (const auto &I : SplitDocs) {
+ for (auto &I : SplitDocs) {
WriteCategoryHeader(I.first, OS);
Had to remove const, since the sort actually modifies the map.
https://reviews.llvm.org/D38969
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D38969: Sort Attributes by "HeaderName"
erichkeane created this revision.
Attributes in the docs were previously sorted (apparently)
by the attribute name, so AnyX86Interrupt ended up being the
first one, rather than in a meaningful place. This resulted in the
4 'interrupt' titled sections being all in different places.
This replaces it with a naive alphabetical sort (case sensitive, underscore
and special characters first, etc).
https://reviews.llvm.org/D38969
Files:
utils/TableGen/ClangAttrEmitter.cpp
Index: utils/TableGen/ClangAttrEmitter.cpp
===
--- utils/TableGen/ClangAttrEmitter.cpp
+++ utils/TableGen/ClangAttrEmitter.cpp
@@ -3663,9 +3663,14 @@
public:
const Record *Documentation;
const Record *Attribute;
+ std::string Heading;
+ unsigned SupportedSpellings;
- DocumentationData(const Record &Documentation, const Record &Attribute)
- : Documentation(&Documentation), Attribute(&Attribute) {}
+ DocumentationData(const Record &Documentation, const Record &Attribute,
+const std::pair &&HeadingAndKinds)
+ : Documentation(&Documentation), Attribute(&Attribute),
+Heading(HeadingAndKinds.first),
+SupportedSpellings(HeadingAndKinds.second) {}
};
static void WriteCategoryHeader(const Record *DocCategory,
@@ -3691,16 +3696,17 @@
Pragma = 1 << 6
};
-static void WriteDocumentation(RecordKeeper &Records,
- const DocumentationData &Doc, raw_ostream &OS) {
+static std::pair
+GetAttributeHeadingAndSpellingKinds(const Record &Documentation,
+const Record &Attribute) {
// FIXME: there is no way to have a per-spelling category for the attribute
// documentation. This may not be a limiting factor since the spellings
// should generally be consistently applied across the category.
- std::vector Spellings = GetFlattenedSpellings(*Doc.Attribute);
+ std::vector Spellings = GetFlattenedSpellings(Attribute);
// Determine the heading to be used for this attribute.
- std::string Heading = Doc.Documentation->getValueAsString("Heading");
+ std::string Heading = Documentation.getValueAsString("Heading");
bool CustomHeading = !Heading.empty();
if (Heading.empty()) {
// If there's only one spelling, we can simply use that.
@@ -3722,7 +3728,7 @@
// If the heading is still empty, it is an error.
if (Heading.empty())
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"This attribute requires a heading to be specified");
// Gather a list of unique spellings; this is not the same as the semantic
@@ -3765,29 +3771,33 @@
}
Heading += ")";
}
- OS << Heading << "\n" << std::string(Heading.length(), '-') << "\n";
-
if (!SupportedSpellings)
-PrintFatalError(Doc.Attribute->getLoc(),
+PrintFatalError(Attribute.getLoc(),
"Attribute has no supported spellings; cannot be "
"documented");
+ return std::make_pair(std::move(Heading), SupportedSpellings);
+}
+
+static void WriteDocumentation(RecordKeeper &Records,
+ const DocumentationData &Doc, raw_ostream &OS) {
+ OS << Doc.Heading << "\n" << std::string(Doc.Heading.length(), '-') << "\n";
// List what spelling syntaxes the attribute supports.
OS << ".. csv-table:: Supported Syntaxes\n";
OS << " :header: \"GNU\", \"C++11\", \"C2x\", \"__declspec\", \"Keyword\",";
OS << " \"Pragma\", \"Pragma clang attribute\"\n\n";
OS << " \"";
- if (SupportedSpellings & GNU) OS << "X";
+ if (Doc.SupportedSpellings & GNU) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & CXX11) OS << "X";
+ if (Doc.SupportedSpellings & CXX11) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & C2x) OS << "X";
+ if (Doc.SupportedSpellings & C2x) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Declspec) OS << "X";
+ if (Doc.SupportedSpellings & Declspec) OS << "X";
OS << "\",\"";
- if (SupportedSpellings & Keyword) OS << "X";
+ if (Doc.SupportedSpellings & Keyword) OS << "X";
OS << "\", \"";
- if (SupportedSpellings & Pragma) OS << "X";
+ if (Doc.SupportedSpellings & Pragma) OS << "X";
OS << "\", \"";
if (getPragmaAttributeSupport(Records).isAttributedSupported(*Doc.Attribute))
OS << "X";
@@ -3842,18 +3852,24 @@
if (Undocumented && Docs.size() > 1)
PrintFatalError(Doc.getLoc(),
"Attribute is \"Undocumented\", but has multiple "
-"documentation categories");
+"documentation categories");
if (!Undocumented)
-SplitDocs[Category].push_back(DocumentationData(Doc, Attr));
+SplitDocs[Category].push_back(DocumentationData(
+Doc, Attr, GetAttributeHeadingAndSpellingKinds(Doc, Attr)));
}
}
// Having split the attributes out based on what documentation goes where,
// we can b
