Adjust 'makeOptions' to new TableGen format of Swift's 'Options.inc'

Author: artemcm

Package.swift

@@ -129,9 +129,13 @@ let package = Package(
     /// The `makeOptions` utility (for importing option definitions).
     .executableTarget(
       name: "makeOptions",
-      dependencies: []),
+      dependencies: [],
+      // Do not enforce checks for LLVM's ABI-breaking build settings.
+      // makeOptions runtime uses some header-only code from LLVM's ADT classes,
+      // but we do not want to link libSupport into the executable.
+      cxxSettings: [.unsafeFlags(["-DLLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING=1"])]),
   ],
-  cxxLanguageStandard: .cxx14
+  cxxLanguageStandard: .cxx17
 )
 
 if ProcessInfo.processInfo.environment["SWIFT_DRIVER_LLBUILD_FWK"] == nil {

README.md

@@ -156,7 +156,7 @@ $ apt-get install libncurses-dev
 be found, e.g.:
 
 ```
-$ swift build -Xcc -I/path/to/build/Ninja-ReleaseAssert/swift-.../include --product makeOptions
+$ swift build -Xcc -Xcc -I/path/to/build/Ninja-Release/swift-.../include -Xcc -I/path/to/build/Ninja-Release/llvm-.../include -Xcc -I/path/to/source/llvm-project/llvm/include --product makeOptions
 ```
 
 Then, run `makeOptions` and redirect the output to overwrite `Options.swift`:

Sources/SwiftOptions/Options.swift

@@ -65,6 +65,9 @@ extension Option {
   public static let cacheDisableReplay: Option = Option("-cache-disable-replay", .flag, attributes: [.frontend, .cacheInvariant], helpText: "Skip loading the compilation result from cache")
   public static let cacheReplayPrefixMap: Option = Option("-cache-replay-prefix-map", .separate, attributes: [.frontend, .noDriver, .cacheInvariant], metaVar: "<prefix=replacement>", helpText: "Remap paths when replaying outputs from cache")
   public static let candidateModuleFile: Option = Option("-candidate-module-file", .separate, attributes: [.helpHidden, .frontend, .noDriver], metaVar: "<path>", helpText: "Specify Swift module may be ready to use for an interface")
+  public static let casBackendMode: Option = Option("-cas-backend-mode=", .joined, attributes: [.frontend, .noDriver], metaVar: "native|casid|verify", helpText: "CASBackendMode for output kind")
+  public static let casBackend: Option = Option("-cas-backend", .flag, attributes: [.frontend, .noDriver], helpText: "Enable using CASBackend for object file output")
+  public static let casEmitCasidFile: Option = Option("-cas-emit-casid-file", .flag, attributes: [.frontend, .noDriver], helpText: "Emit .casid file next to object file when CAS Backend is enabled")
   public static let casFs: Option = Option("-cas-fs", .separate, attributes: [.helpHidden, .frontend, .noDriver], metaVar: "<cas-id>", helpText: "Root CASID for CAS FileSystem")
   public static let casPath: Option = Option("-cas-path", .separate, attributes: [.frontend, .cacheInvariant], metaVar: "<path>", helpText: "Path to CAS")
   public static let casPluginOption: Option = Option("-cas-plugin-option", .separate, attributes: [.frontend], metaVar: "<name>=<option>", helpText: "Option pass to CAS Plugin")
@@ -883,6 +886,9 @@ extension Option {
       Option.cacheDisableReplay,
       Option.cacheReplayPrefixMap,
       Option.candidateModuleFile,
+      Option.casBackendMode,
+      Option.casBackend,
+      Option.casEmitCasidFile,
       Option.casFs,
       Option.casPath,
       Option.casPluginOption,

Sources/makeOptions/makeOptions.cpp

@@ -17,6 +17,13 @@
 #include <string>
 #include <vector>
 
+#if __has_include("swift/Option/Options.inc")
+#if __has_include("llvm/ADT/ArrayRef.h")
+#if __has_include("llvm/ADT/StringRef.h")
+
+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/ADT/StringRef.h"
+
 enum class OptionKind {
   Group = 0,
   Input,
@@ -38,12 +45,7 @@ enum class OptionKind {
 enum class OptionID {
   Opt_INVALID = 0,
 #define OPTION(...) LLVM_MAKE_OPT_ID_WITH_ID_PREFIX(Opt_, __VA_ARGS__),
-#if __has_include("swift/Option/Options.inc")
 #include "swift/Option/Options.inc"
-#else
-#warning "Unable to include 'swift/Option/Options.inc', `makeOptions` will not be usable"
-#endif
-
 #undef OPTION
 };
 
@@ -102,7 +104,7 @@ static std::string swiftify(const std::string &name) {
 /// Raw option from the TableGen'd output of the Swift options.
 struct RawOption {
   OptionID id;
-  const char * const *prefixes;
+  const llvm::ArrayRef<llvm::StringLiteral> prefixes;
   const char *spelling;
   std::string idName;
   OptionKind kind;
@@ -125,20 +127,16 @@ struct RawOption {
   }
 };
 
-#define PREFIX(NAME, VALUE) static const char *const NAME[] = VALUE;
-#if __has_include("swift/Option/Options.inc")
+#define PREFIX(NAME, VALUE) static constexpr llvm::StringLiteral NAME[] = VALUE;
 #include "swift/Option/Options.inc"
-#endif
 #undef PREFIX
 
 static const RawOption rawOptions[] = {
 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
                HELPTEXT, METAVAR, VALUES)                                      \
-  { OptionID::Opt_##ID, PREFIX, NAME, swiftify(#ID), OptionKind::KIND, \
-    OptionID::Opt_##GROUP, OptionID::Opt_##ALIAS, FLAGS, HELPTEXT, METAVAR },
-#if __has_include("swift/Option/Options.inc")
+ { OptionID::Opt_##ID, PREFIX, NAME, swiftify(#ID), OptionKind::KIND, \
+   OptionID::Opt_##GROUP, OptionID::Opt_##ALIAS, FLAGS, HELPTEXT, METAVAR },
 #include "swift/Option/Options.inc"
-#endif
 #undef OPTION
 };
 
@@ -181,20 +179,20 @@ void forEachOption(std::function<void(const RawOption &)> fn) {
   }
 }
 
-void forEachSpelling(const char * const *prefixes, const std::string &spelling,
+void forEachSpelling(const llvm::ArrayRef<llvm::StringLiteral> prefixes, const std::string &spelling,
                      std::function<void(const std::string &spelling,
                                         bool isAlternateSpelling)> fn) {
-  if (!prefixes || !*prefixes) {
-    fn(spelling, /*isAlternateSpelling=*/false);
-    return;
-  }
-
   fn(spelling, /*isAlternateSpelling=*/false);
 
-  std::string defaultPrefix = std::string(*prefixes++);
-  while (*prefixes) {
+  if (prefixes.empty())
+    return;
+
+  std::string defaultPrefix = std::string(*prefixes.begin());
+  for (auto it = prefixes.begin() + 1, end = prefixes.end(); it != end; it++) {
+    if (it->empty())
+      continue;
     std::string altSpelling =
-        std::string(*prefixes++) + spelling.substr(defaultPrefix.size());
+        std::string(*it) + spelling.substr(defaultPrefix.size());
     fn(altSpelling, /*isAlternateSpelling=*/true);
   }
 }
@@ -414,3 +412,13 @@ int makeOptions_main() {
 
   return 0;
 }
+#else
+static_assert(false, "Failed to locate/include StringRef.h");
+#endif
+#else
+static_assert(false, "Failed to locate/include ArrayRef.h");
+#endif
+#else
+#warning "Unable to include 'swift/Option/Options.inc', `makeOptions` will not be usable"
+int makeOptions_main() {return 0;}
+#endif