Skip to content

[NFC][TableGen] Remove close member from various CodeGenHelpers #167904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2025
Merged

[NFC][TableGen] Remove close member from various CodeGenHelpers #167904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 3 additions & 27 deletions llvm/include/llvm/TableGen/CodeGenHelpers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,17 @@ class IfDefEmitter {
OS << "#undef " << Name << "\n";
OS << "\n";
}
~IfDefEmitter() { close(); }

// Explicit function to close the ifdef scopes.
void close() {
if (Closed)
return;

~IfDefEmitter() {
OS << "\n";
if (LateUndef)
OS << "#undef " << Name << "\n";
OS << "#endif // " << Name << "\n\n";
Closed = true;
}

private:
std::string Name;
raw_ostream &OS;
bool LateUndef;
bool Closed = false;
};

// Simple RAII helper for emitting header include guard (ifndef-define-endif).
Expand All @@ -62,20 +54,11 @@ class IncludeGuardEmitter {
OS << "#ifndef " << Name << "\n"
<< "#define " << Name << "\n\n";
}
~IncludeGuardEmitter() { close(); }

// Explicit function to close the ifdef scopes.
void close() {
if (Closed)
return;
OS << "\n#endif // " << Name << "\n\n";
Closed = true;
}
~IncludeGuardEmitter() { OS << "\n#endif // " << Name << "\n\n"; }

private:
std::string Name;
raw_ostream &OS;
bool Closed = false;
};

// Simple RAII helper for emitting namespace scope. Name can be a single
Expand All @@ -89,15 +72,9 @@ class NamespaceEmitter {
OS << "namespace " << Name << " {\n\n";
}

~NamespaceEmitter() { close(); }

// Explicit function to close the namespace scopes.
void close() {
if (Closed)
return;
~NamespaceEmitter() {
if (!Name.empty())
OS << "\n} // namespace " << Name << "\n";
Closed = true;
}

private:
Expand All @@ -114,7 +91,6 @@ class NamespaceEmitter {
}
std::string Name;
raw_ostream &OS;
bool Closed = false;
};

} // end namespace llvm
Expand Down
123 changes: 62 additions & 61 deletions llvm/utils/TableGen/Basic/DirectiveEmitter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,80 +276,81 @@ static void emitDirectivesDecl(const RecordKeeper &Records, raw_ostream &OS) {
OS << "#include <utility>\n"; // for std::pair
OS << "\n";
NamespaceEmitter LlvmNS(OS, "llvm");
NamespaceEmitter DirLangNS(OS, DirLang.getCppNamespace());

if (DirLang.hasEnableBitmaskEnumInNamespace())
OS << "LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();\n\n";

// Emit Directive associations
std::vector<const Record *> Associations;
copy_if(DirLang.getAssociations(), std::back_inserter(Associations),
// Skip the "special" value
[](const Record *Def) { return Def->getName() != "AS_FromLeaves"; });
generateEnumClass(Associations, OS, "Association",
/*Prefix=*/"", /*ExportEnums=*/false);
{
NamespaceEmitter DirLangNS(OS, DirLang.getCppNamespace());

if (DirLang.hasEnableBitmaskEnumInNamespace())
OS << "LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();\n\n";

// Emit Directive associations
std::vector<const Record *> Associations;
copy_if(
DirLang.getAssociations(), std::back_inserter(Associations),
// Skip the "special" value
[](const Record *Def) { return Def->getName() != "AS_FromLeaves"; });
generateEnumClass(Associations, OS, "Association",
/*Prefix=*/"", /*ExportEnums=*/false);

generateEnumClass(DirLang.getCategories(), OS, "Category", /*Prefix=*/"",
/*ExportEnums=*/false);
generateEnumClass(DirLang.getCategories(), OS, "Category", /*Prefix=*/"",
/*ExportEnums=*/false);

generateEnumBitmask(DirLang.getSourceLanguages(), OS, "SourceLanguage",
/*Prefix=*/"", /*ExportEnums=*/false);
generateEnumBitmask(DirLang.getSourceLanguages(), OS, "SourceLanguage",
/*Prefix=*/"", /*ExportEnums=*/false);

// Emit Directive enumeration
generateEnumClass(DirLang.getDirectives(), OS, "Directive",
DirLang.getDirectivePrefix(),
DirLang.hasMakeEnumAvailableInNamespace());
// Emit Directive enumeration
generateEnumClass(DirLang.getDirectives(), OS, "Directive",
DirLang.getDirectivePrefix(),
DirLang.hasMakeEnumAvailableInNamespace());

// Emit Clause enumeration
generateEnumClass(DirLang.getClauses(), OS, "Clause",
DirLang.getClausePrefix(),
DirLang.hasMakeEnumAvailableInNamespace());
// Emit Clause enumeration
generateEnumClass(DirLang.getClauses(), OS, "Clause",
DirLang.getClausePrefix(),
DirLang.hasMakeEnumAvailableInNamespace());

// Emit ClauseVals enumeration
std::string EnumHelperFuncs;
generateClauseEnumVal(DirLang.getClauses(), OS, DirLang, EnumHelperFuncs);
// Emit ClauseVals enumeration
std::string EnumHelperFuncs;
generateClauseEnumVal(DirLang.getClauses(), OS, DirLang, EnumHelperFuncs);

// Generic function signatures
OS << "// Enumeration helper functions\n";
// Generic function signatures
OS << "// Enumeration helper functions\n";

OS << "LLVM_ABI std::pair<Directive, directive::VersionRange> get" << Lang
<< "DirectiveKindAndVersions(StringRef Str);\n";
OS << "LLVM_ABI std::pair<Directive, directive::VersionRange> get" << Lang
<< "DirectiveKindAndVersions(StringRef Str);\n";

OS << "inline Directive get" << Lang << "DirectiveKind(StringRef Str) {\n";
OS << " return get" << Lang << "DirectiveKindAndVersions(Str).first;\n";
OS << "}\n";
OS << "\n";
OS << "inline Directive get" << Lang << "DirectiveKind(StringRef Str) {\n";
OS << " return get" << Lang << "DirectiveKindAndVersions(Str).first;\n";
OS << "}\n";
OS << "\n";

OS << "LLVM_ABI StringRef get" << Lang
<< "DirectiveName(Directive D, unsigned Ver = 0);\n";
OS << "\n";
OS << "LLVM_ABI StringRef get" << Lang
<< "DirectiveName(Directive D, unsigned Ver = 0);\n";
OS << "\n";

OS << "LLVM_ABI std::pair<Clause, directive::VersionRange> get" << Lang
<< "ClauseKindAndVersions(StringRef Str);\n";
OS << "\n";
OS << "LLVM_ABI std::pair<Clause, directive::VersionRange> get" << Lang
<< "ClauseKindAndVersions(StringRef Str);\n";
OS << "\n";

OS << "inline Clause get" << Lang << "ClauseKind(StringRef Str) {\n";
OS << " return get" << Lang << "ClauseKindAndVersions(Str).first;\n";
OS << "}\n";
OS << "\n";
OS << "inline Clause get" << Lang << "ClauseKind(StringRef Str) {\n";
OS << " return get" << Lang << "ClauseKindAndVersions(Str).first;\n";
OS << "}\n";
OS << "\n";

OS << "LLVM_ABI StringRef get" << Lang
<< "ClauseName(Clause C, unsigned Ver = 0);\n";
OS << "\n";
OS << "LLVM_ABI StringRef get" << Lang
<< "ClauseName(Clause C, unsigned Ver = 0);\n";
OS << "\n";

OS << "/// Return true if \\p C is a valid clause for \\p D in version \\p "
<< "Version.\n";
OS << "LLVM_ABI bool isAllowedClauseForDirective(Directive D, "
<< "Clause C, unsigned Version);\n";
OS << "\n";
OS << "constexpr std::size_t getMaxLeafCount() { return "
<< getMaxLeafCount(DirLang) << "; }\n";
OS << "LLVM_ABI Association getDirectiveAssociation(Directive D);\n";
OS << "LLVM_ABI Category getDirectiveCategory(Directive D);\n";
OS << "LLVM_ABI SourceLanguage getDirectiveLanguages(Directive D);\n";
OS << EnumHelperFuncs;

DirLangNS.close();
OS << "/// Return true if \\p C is a valid clause for \\p D in version \\p "
<< "Version.\n";
OS << "LLVM_ABI bool isAllowedClauseForDirective(Directive D, "
<< "Clause C, unsigned Version);\n";
OS << "\n";
OS << "constexpr std::size_t getMaxLeafCount() { return "
<< getMaxLeafCount(DirLang) << "; }\n";
OS << "LLVM_ABI Association getDirectiveAssociation(Directive D);\n";
OS << "LLVM_ABI Category getDirectiveCategory(Directive D);\n";
OS << "LLVM_ABI SourceLanguage getDirectiveLanguages(Directive D);\n";
OS << EnumHelperFuncs;
} // close DirLangNS

// These specializations need to be in ::llvm.
for (StringRef Enum : {"Association", "Category", "Directive", "Clause"}) {
Expand Down
79 changes: 41 additions & 38 deletions mlir/tools/mlir-tblgen/EnumsGen.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,41 +702,45 @@ static void emitEnumDecl(const Record &enumDef, raw_ostream &os) {
StringRef underlyingToSymFnName = enumInfo.getUnderlyingToSymbolFnName();
auto enumerants = enumInfo.getAllCases();

llvm::NamespaceEmitter ns(os, cppNamespace);

// Emit the enum class definition
emitEnumClass(enumDef, enumName, underlyingType, description, enumerants, os);

// Emit conversion function declarations
if (llvm::all_of(enumerants, [](EnumCase enumerant) {
return enumerant.getValue() >= 0;
})) {
os << formatv(
"::std::optional<{0}> {1}({2});\n", enumName, underlyingToSymFnName,
underlyingType.empty() ? std::string("unsigned") : underlyingType);
}
os << formatv("{2} {1}({0});\n", enumName, symToStrFnName, symToStrFnRetType);
os << formatv("::std::optional<{0}> {1}(::llvm::StringRef);\n", enumName,
strToSymFnName);

if (enumInfo.isBitEnum()) {
emitOperators(enumDef, os);
} else {
emitMaxValueFn(enumDef, os);
}
{
llvm::NamespaceEmitter ns(os, cppNamespace);

// Emit the enum class definition
emitEnumClass(enumDef, enumName, underlyingType, description, enumerants,
os);

// Emit conversion function declarations
if (llvm::all_of(enumerants, [](EnumCase enumerant) {
return enumerant.getValue() >= 0;
})) {
os << formatv(
"::std::optional<{0}> {1}({2});\n", enumName, underlyingToSymFnName,
underlyingType.empty() ? std::string("unsigned") : underlyingType);
}
os << formatv("{2} {1}({0});\n", enumName, symToStrFnName,
symToStrFnRetType);
os << formatv("::std::optional<{0}> {1}(::llvm::StringRef);\n", enumName,
strToSymFnName);

if (enumInfo.isBitEnum()) {
emitOperators(enumDef, os);
} else {
emitMaxValueFn(enumDef, os);
}

// Generate a generic `stringifyEnum` function that forwards to the method
// specified by the user.
const char *const stringifyEnumStr = R"(
// Generate a generic `stringifyEnum` function that forwards to the method
// specified by the user.
const char *const stringifyEnumStr = R"(
inline {0} stringifyEnum({1} enumValue) {{
return {2}(enumValue);
}
)";
os << formatv(stringifyEnumStr, symToStrFnRetType, enumName, symToStrFnName);
os << formatv(stringifyEnumStr, symToStrFnRetType, enumName,
symToStrFnName);

// Generate a generic `symbolizeEnum` function that forwards to the method
// specified by the user.
const char *const symbolizeEnumStr = R"(
// Generate a generic `symbolizeEnum` function that forwards to the method
// specified by the user.
const char *const symbolizeEnumStr = R"(
template <typename EnumType>
::std::optional<EnumType> symbolizeEnum(::llvm::StringRef);

Expand All @@ -745,9 +749,9 @@ inline ::std::optional<{0}> symbolizeEnum<{0}>(::llvm::StringRef str) {
return {1}(str);
}
)";
os << formatv(symbolizeEnumStr, enumName, strToSymFnName);
os << formatv(symbolizeEnumStr, enumName, strToSymFnName);

const char *const attrClassDecl = R"(
const char *const attrClassDecl = R"(
class {1} : public ::mlir::{2} {
public:
using ValueType = {0};
Expand All @@ -757,13 +761,12 @@ class {1} : public ::mlir::{2} {
{0} getValue() const;
};
)";
if (enumInfo.genSpecializedAttr()) {
StringRef attrClassName = enumInfo.getSpecializedAttrClassName();
StringRef baseAttrClassName = "IntegerAttr";
os << formatv(attrClassDecl, enumName, attrClassName, baseAttrClassName);
}

ns.close();
if (enumInfo.genSpecializedAttr()) {
StringRef attrClassName = enumInfo.getSpecializedAttrClassName();
StringRef baseAttrClassName = "IntegerAttr";
os << formatv(attrClassDecl, enumName, attrClassName, baseAttrClassName);
}
} // close `ns`.

// Generate a generic parser and printer for the enum.
std::string qualName =
Expand Down
Loading