Add support for #fileID

beccadax · beccadax · commit 0e569f5d9e66 · 2020-07-13T14:05:13.000-07:00
This temporarily breaks -enable-experimental-concise-pound-file.

fixup adding #fileID
diff --git a/include/swift/AST/DiagnosticsCommon.def b/include/swift/AST/DiagnosticsCommon.def
@@ -118,11 +118,11 @@ ERROR(sdk_node_unrecognized_decl_kind,none,
 ERROR(sdk_node_unrecognized_accessor_kind,none,
       "unrecognized accessor kind '%0' in SDK node", (StringRef))
 
-// Emitted from ModuleDecl::computeMagicFileStringMap()
-WARNING(pound_source_location_creates_pound_file_conflicts,none,
-        "'#sourceLocation' directive produces '#file' string of '%0', which "
-        "conflicts with '#file' strings produced by other paths in the module",
-        (StringRef))
+// Emitted from ModuleDecl::computeFileIDMap()
+WARNING(source_location_creates_file_id_conflicts,none,
+        "'#sourceLocation' directive produces '#fileID' string of '%0', which "
+        "conflicts with '#fileID' strings produced by other paths in the "
+        "module", (StringRef))
 NOTE(fixit_correct_source_location_file,none,
      "change file in '#sourceLocation' to '%0'", (StringRef))
 
diff --git a/include/swift/AST/MagicIdentifierKinds.def b/include/swift/AST/MagicIdentifierKinds.def
@@ -57,6 +57,10 @@ MAGIC_STRING_IDENTIFIER(File, "#file", PoundFileExpr)
   MAGIC_IDENTIFIER_TOKEN(File, pound_file)
   MAGIC_IDENTIFIER_DEPRECATED_TOKEN(File, kw___FILE__)
 
+/// The \c #fileID magic identifier literal.
+MAGIC_STRING_IDENTIFIER(FileID, "#fileID", PoundFileIDExpr)
+  MAGIC_IDENTIFIER_TOKEN(FileID, pound_fileID)
+
 /// The \c #filePath magic identifier literal.
 MAGIC_STRING_IDENTIFIER(FilePath, "#filePath", PoundFilePathExpr)
   MAGIC_IDENTIFIER_TOKEN(FilePath, pound_filePath)
diff --git a/include/swift/AST/Module.h b/include/swift/AST/Module.h
@@ -370,21 +370,18 @@ class ModuleDecl : public DeclContext, public TypeDecl {
   bool isClangModule() const;
   void addFile(FileUnit &newFile);
 
-  /// Creates a map from \c #filePath strings to corresponding \c #file
+  /// Creates a map from \c #filePath strings to corresponding \c #fileID
   /// strings, diagnosing any conflicts.
   ///
-  /// A given \c #filePath string always maps to exactly one \c #file string,
+  /// A given \c #filePath string always maps to exactly one \c #fileID string,
   /// but it is possible for \c #sourceLocation directives to introduce
   /// duplicates in the opposite direction. If there are such conflicts, this
   /// method will diagnose the conflict and choose a "winner" among the paths
-  /// in a reproducible way. The \c bool paired with the \c #file string is
+  /// in a reproducible way. The \c bool paired with the \c #fileID string is
   /// \c true for paths which did not have a conflict or won a conflict, and
   /// \c false for paths which lost a conflict. Thus, if you want to generate a
-  /// reverse mapping, you should drop or special-case the \c #file strings that
-  /// are paired with \c false.
-  ///
-  /// Note that this returns an empty StringMap if concise \c #file strings are
-  /// disabled. Users should fall back to using the file path in this case.
+  /// reverse mapping, you should drop or special-case the \c #fileID strings
+  /// that are paired with \c false.
   llvm::StringMap<std::pair<std::string, /*isWinner=*/bool>>
   computeFileIDMap(bool shouldDiagnose) const;
 
diff --git a/lib/AST/Module.cpp b/lib/AST/Module.cpp
@@ -2153,7 +2153,6 @@ resolveFileIDConflicts(const ModuleDecl *module, StringRef fileString,
                        const llvm::StringMap<SourceFilePathInfo> &paths,
                        bool shouldDiagnose) {
   assert(paths.size() > 1);
-  assert(module->getASTContext().LangOpts.EnableConcisePoundFile);
 
   /// The path we consider to be "correct"; we will emit fix-its changing the
   /// other paths to match this one.
@@ -2203,7 +2202,7 @@ resolveFileIDConflicts(const ModuleDecl *module, StringRef fileString,
 
     for (auto loc : pathPair.second.virtualFileLocs) {
       diags.diagnose(loc,
-                     diag::pound_source_location_creates_pound_file_conflicts,
+                     diag::source_location_creates_file_id_conflicts,
                      fileString);
 
       // Offer a fix-it unless it would be tautological.
@@ -2221,18 +2220,15 @@ ModuleDecl::computeFileIDMap(bool shouldDiagnose) const {
   llvm::StringMap<std::pair<std::string, bool>> result;
   SmallString<64> scratch;
 
-  if (!getASTContext().LangOpts.EnableConcisePoundFile)
-    return result;
-
   for (auto &namePair : getInfoForUsedFileNames(this)) {
     computeFileID(this, namePair.first(), scratch);
     auto &infoForPaths = namePair.second;
 
     assert(!infoForPaths.empty());
 
     // TODO: In the future, we'd like to handle these conflicts gracefully by
-    // generating a unique `#file` string for each conflicting name. For now, we
-    // will simply warn about conflicts.
+    // generating a unique `#fileID` string for each conflicting name. For now,
+    // we will simply warn about conflicts.
     StringRef winner = infoForPaths.begin()->first();
     if (infoForPaths.size() > 1)
       winner = resolveFileIDConflicts(this, scratch, infoForPaths,
diff --git a/lib/SIL/IR/SILPrinter.cpp b/lib/SIL/IR/SILPrinter.cpp
@@ -2936,7 +2936,7 @@ static void printFileIDMap(SILPrintContext &Ctx, const FileIDMap map) {
   if (map.empty())
     return;
 
-  Ctx.OS() << "\n\n// Mappings from '#file' to '#filePath':\n";
+  Ctx.OS() << "\n\n// Mappings from '#fileID' to '#filePath':\n";
 
   if (Ctx.sortSIL()) {
     llvm::SmallVector<llvm::StringRef, 16> keys;
diff --git a/lib/SILGen/SILGenApply.cpp b/lib/SILGen/SILGenApply.cpp
@@ -4848,7 +4848,7 @@ RValue SILGenFunction::emitLiteral(LiteralExpr *literal, SGFContext C) {
 
     auto magicLiteral = cast<MagicIdentifierLiteralExpr>(literal);
     switch (magicLiteral->getKind()) {
-    case MagicIdentifierLiteralExpr::File: {
+    case MagicIdentifierLiteralExpr::FileID: {
       std::string value = loc.isValid() ? getMagicFileIDString(loc) : "";
       builtinLiteralArgs = emitStringLiteral(*this, literal, value, C,
                                              magicLiteral->getStringEncoding());
@@ -4857,6 +4857,7 @@ RValue SILGenFunction::emitLiteral(LiteralExpr *literal, SGFContext C) {
       break;
     }
 
+    case MagicIdentifierLiteralExpr::File:
     case MagicIdentifierLiteralExpr::FilePath: {
       StringRef value = loc.isValid() ? getMagicFilePathString(loc) : "";
       builtinLiteralArgs = emitStringLiteral(*this, literal, value, C,
diff --git a/lib/SILGen/SILGenConvert.cpp b/lib/SILGen/SILGenConvert.cpp
@@ -144,7 +144,8 @@ auto SILGenFunction::emitSourceLocationArgs(SourceLoc sourceLoc,
   unsigned line = 0;
   unsigned column = 0;
   if (sourceLoc.isValid()) {
-    filename = getMagicFileIDString(sourceLoc);
+    // FIXME: Should be getMagicFileIDString()
+    filename = getMagicFilePathString(sourceLoc);
     std::tie(line, column) =
         ctx.SourceMgr.getPresumedLineAndColumnForLoc(sourceLoc);
   }
diff --git a/lib/Serialization/Deserialization.cpp b/lib/Serialization/Deserialization.cpp
@@ -216,6 +216,7 @@ getActualDefaultArgKind(uint8_t raw) {
   CASE(Inherited)
   CASE(Column)
   CASE(File)
+  CASE(FileID)
   CASE(FilePath)
   CASE(Line)
   CASE(Function)
diff --git a/lib/Serialization/ModuleFormat.h b/lib/Serialization/ModuleFormat.h
@@ -482,6 +482,7 @@ enum class DefaultArgumentKind : uint8_t {
   None = 0,
   Normal,
   File,
+  FileID,
   FilePath,
   Line,
   Column,
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
@@ -1122,6 +1122,7 @@ static uint8_t getRawStableDefaultArgumentKind(swift::DefaultArgumentKind kind)
   CASE(Inherited)
   CASE(Column)
   CASE(File)
+  CASE(FileID)
   CASE(FilePath)
   CASE(Line)
   CASE(Function)
diff --git a/test/IDE/complete_pound_expr.swift b/test/IDE/complete_pound_expr.swift
@@ -15,28 +15,31 @@ func test1() {
   let _ = useSelector(##^POUND_EXPR_3^#)
 }
 
-// POUND_EXPR_INTCONTEXT: Begin completions, 6 items
+// POUND_EXPR_INTCONTEXT: Begin completions, 7 items
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#function]/None:            function[#String#]; name=function
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#file]/None:                file[#String#]; name=file
+// POUND_EXPR_INTCONTEXT-DAG: Keyword[#fileID]/None: fileID[#String#]; name=fileID
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#filePath]/None: filePath[#String#]; name=filePath
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#line]/None/TypeRelation[Identical]: line[#Int#]; name=line
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#column]/None/TypeRelation[Identical]: column[#Int#]; name=column
 // POUND_EXPR_INTCONTEXT-DAG: Keyword[#dsohandle]/None:           dsohandle[#UnsafeRawPointer#]; name=dsohandle
 // POUND_EXPR_INTCONTEXT: End completions
 
-// POUND_EXPR_STRINGCONTEXT: Begin completions, 7 items
+// POUND_EXPR_STRINGCONTEXT: Begin completions, 8 items
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#function]/None/TypeRelation[Identical]: function[#String#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#file]/None/TypeRelation[Identical]: file[#String#];
+// POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#fileID]/None/TypeRelation[Identical]: fileID[#String#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#filePath]/None/TypeRelation[Identical]: filePath[#String#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#line]/None:                line[#Int#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#column]/None:              column[#Int#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword[#dsohandle]/None:           dsohandle[#UnsafeRawPointer#];
 // POUND_EXPR_STRINGCONTEXT-DAG: Keyword/None/TypeRelation[Identical]: keyPath({#@objc property sequence#})[#String#];
 // POUND_EXPR_STRINGCONTEXT: End completions
 
-// POUND_EXPR_SELECTORCONTEXT: Begin completions, 7 items
+// POUND_EXPR_SELECTORCONTEXT: Begin completions, 8 items
 // POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#function]/None/TypeRelation[Identical]: function[#Selector#];
 // POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#file]/None/TypeRelation[Identical]: file[#Selector#];
+// POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#fileID]/None/TypeRelation[Identical]: fileID[#Selector#];
 // POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#filePath]/None/TypeRelation[Identical]: filePath[#Selector#];
 // POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#line]/None:                line[#Int#];
 // POUND_EXPR_SELECTORCONTEXT-DAG: Keyword[#column]/None:              column[#Int#];
diff --git a/test/SILGen/Inputs/magic_identifier_file_conflicting_other.swift b/test/SILGen/Inputs/magic_identifier_file_conflicting_other.swift
@@ -2,7 +2,7 @@
 // It should be compiled with -verify.
 
 // We should diagnose cross-file conflicts.
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_c.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_c.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to 'first/other_file_c.swift'}} {{23-50="first/other_file_c.swift"}}
 #sourceLocation(file: "second/other_file_c.swift", line: 1)
 #sourceLocation()
diff --git a/test/SILGen/magic_identifier_file.swift b/test/SILGen/magic_identifier_file.swift
@@ -32,6 +32,6 @@ func forceTry(_ fn: () throws -> ()) {
 // CONCISE: string_literal utf8 "Foo/magic_identifier_file.swift"
 }
 
-// CONCISE-LABEL: // Mappings from '#file' to '#filePath':
+// CONCISE-LABEL: // Mappings from '#fileID' to '#filePath':
 // CONCISE:       //   'Foo/magic_identifier_file.swift' => 'SOURCE_DIR/test/SILGen/magic_identifier_file.swift'
 
diff --git a/test/SILGen/magic_identifier_file_conflicting.swift.gyb b/test/SILGen/magic_identifier_file_conflicting.swift.gyb
@@ -33,12 +33,12 @@ def fixit_loc(start_col, orig_suffix):
 #sourceLocation(file: "${TEMPDIR_ESC}/magic_identifier_file_conflicting.swift", line: 10)
 #sourceLocation()
 
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/magic_identifier_file_conflicting.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/magic_identifier_file_conflicting.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to '${TEMPDIR_ESC}/magic_identifier_file_conflicting.swift'}} {{${fixit_loc(23, "other_path_b/magic_identifier_file_conflicting.swift")}="${TEMPDIR_ESC}/magic_identifier_file_conflicting.swift"}}
 #sourceLocation(file: "${TEMPDIR_ESC}/other_path_b/magic_identifier_file_conflicting.swift", line: 20)
 #sourceLocation()
 
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/magic_identifier_file_conflicting.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/magic_identifier_file_conflicting.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to '${TEMPDIR_ESC}/magic_identifier_file_conflicting.swift'}} {{23-64="${TEMPDIR_ESC}/magic_identifier_file_conflicting.swift"}}
 #sourceLocation(file: "magic_identifier_file_conflicting.swift", line: 30)
 #sourceLocation()
@@ -60,38 +60,38 @@ def fixit_loc(start_col, orig_suffix):
 // But there should be warnings for different-path, same-name virtual files.
 // The lexicographically first path should be treated as canonical--we diagnose
 // but don't offer a fix-it.
-// expected-warning@+1 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_b.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+1 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_b.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 #sourceLocation(file: "first/other_file_b.swift", line: 60)
 #sourceLocation()
 
 // Subsequent paths should fix-it to the first one.
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_b.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_b.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to 'first/other_file_b.swift'}} {{23-50="first/other_file_b.swift"}}
 #sourceLocation(file: "second/other_file_b.swift", line: 70)
 #sourceLocation()
 
 // Even if there's more than one.
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_b.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_b.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to 'first/other_file_b.swift'}} {{23-49="first/other_file_b.swift"}}
 #sourceLocation(file: "third/other_file_b.swift", line: 80)
 #sourceLocation()
 
 // Even if one is duplicated.
-// expected-warning@+2 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_b.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+2 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_b.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 // expected-note@+1 {{change file in '#sourceLocation' to 'first/other_file_b.swift'}} {{23-49="first/other_file_b.swift"}}
 #sourceLocation(file: "third/other_file_b.swift", line: 90)
 #sourceLocation()
 
 // We should diagnose cross-file conflicts.
-// expected-warning@+1 {{'#sourceLocation' directive produces '#file' string of 'Foo/other_file_c.swift', which conflicts with '#file' strings produced by other paths in the module}}
+// expected-warning@+1 {{'#sourceLocation' directive produces '#fileID' string of 'Foo/other_file_c.swift', which conflicts with '#fileID' strings produced by other paths in the module}}
 #sourceLocation(file: "first/other_file_c.swift", line: 100)
 #sourceLocation()
 
 //
-// Check '#file' => '#filePath' mapping table
+// Check '#fileID' => '#filePath' mapping table
 //
 
-// CHECK-LABEL: // Mappings from '#file' to '#filePath':
+// CHECK-LABEL: // Mappings from '#fileID' to '#filePath':
 // CHECK-NEXT:  //   'Foo/magic_identifier_file_conflicting.swift' => 'BUILD_DIR{{[/\\]}}test-{{[^/]+}}{{[/\\]}}SILGen{{[/\\]}}Output{{[/\\]}}magic_identifier_file_conflicting.swift.gyb.tmp{{[/\\]}}magic_identifier_file_conflicting.swift'
 // CHECK-NEXT:  //   'Foo/magic_identifier_file_conflicting.swift' => 'BUILD_DIR{{[/\\]}}test-{{[^/]+}}{{[/\\]}}SILGen{{[/\\]}}Output{{[/\\]}}magic_identifier_file_conflicting.swift.gyb.tmp{{[/\\]}}other_path_b{{[/\\]}}magic_identifier_file_conflicting.swift' (alternate)
 // CHECK-NEXT:  //   'Foo/magic_identifier_file_conflicting.swift' => 'magic_identifier_file_conflicting.swift' (alternate)
diff --git a/utils/gyb_syntax_support/ExprNodes.py b/utils/gyb_syntax_support/ExprNodes.py
@@ -130,6 +130,12 @@
              Child('PoundFile', kind='PoundFileToken'),
          ]),
 
+    # A #fileID expression.
+    Node('PoundFileIDExpr', kind='Expr',
+         children=[
+             Child('PoundFileID', kind='PoundFileIDToken'),
+         ]),
+
     # A #filePath expression.
     Node('PoundFilePathExpr', kind='Expr',
          children=[
diff --git a/utils/gyb_syntax_support/NodeSerializationCodes.py b/utils/gyb_syntax_support/NodeSerializationCodes.py
@@ -248,6 +248,7 @@
     'CatchItemList': 244,
     'MultipleTrailingClosureElementList': 245,
     'MultipleTrailingClosureElement': 246,
+    'PoundFileIDExpr': 247,
 }
 
 
diff --git a/utils/gyb_syntax_support/Token.py b/utils/gyb_syntax_support/Token.py
@@ -265,6 +265,8 @@ def macro_name(self):
                  serialization_code=73),
     PoundKeyword('PoundFile', 'file', text='#file',
                  serialization_code=68),
+    PoundKeyword('PoundFileID', 'fileID', text='#fileID',
+                 serialization_code=122),
     PoundKeyword('PoundFilePath', 'filePath', text='#filePath',
                  serialization_code=121),
     PoundKeyword('PoundColumn', 'column', text='#column',
