Merge pull request swiftlang#38831 from rintaro/ide-srcinfo-diag

[CodeCompletion] Explain why results aren't recommended

Author: rintaro

include/swift/AST/Attr.h

@@ -2088,6 +2088,10 @@ class DeclAttributes {
   /// a declaration is deprecated on all deployment targets, or null otherwise.
   const AvailableAttr *getDeprecated(const ASTContext &ctx) const;
 
+  /// Returns the first @available attribute that indicates
+  /// a declaration will be deprecated in the future, or null otherwise.
+  const AvailableAttr *getSoftDeprecated(const ASTContext &ctx) const;
+
   SWIFT_DEBUG_DUMPER(dump(const Decl *D = nullptr));
   void print(ASTPrinter &Printer, const PrintOptions &Options,
              const Decl *D = nullptr) const;

include/swift/AST/DiagnosticEngine.h

@@ -1116,6 +1116,8 @@ namespace swift {
     void emitTentativeDiagnostics();
 
   public:
+    DiagnosticKind declaredDiagnosticKindFor(const DiagID id);
+
     llvm::StringRef diagnosticStringFor(const DiagID id,
                                         bool printDiagnosticNames);
 
@@ -1313,6 +1315,26 @@ namespace swift {
     builder();
   }
 
+/// Temporary on-stack storage and unescaping for encoded diagnostic
+/// messages.
+class EncodedDiagnosticMessage {
+  llvm::SmallString<128> Buf;
+
+public:
+  /// \param S A string with an encoded message
+  EncodedDiagnosticMessage(StringRef S);
+
+  /// The unescaped message to display to the user.
+  const StringRef Message;
+};
+
+/// Returns a value that can be used to select between accessor kinds in
+/// diagnostics.
+///
+/// This is correlated with diag::availability_deprecated and others.
+std::pair<unsigned, DeclName>
+getAccessorKindAndNameForDiagnostics(const ValueDecl *D);
+
 } // end namespace swift
 
 #endif

include/swift/AST/DiagnosticsAll.def

@@ -20,6 +20,7 @@
 #define DIAG_NO_UNDEF
 
 #include "DiagnosticsCommon.def"
+#include "DiagnosticsIDE.def"
 #include "DiagnosticsParse.def"
 #include "DiagnosticsSema.def"
 #include "DiagnosticsClangImporter.def"

include/swift/AST/DiagnosticsIDE.def

@@ -0,0 +1,52 @@
+//===--- DiagnosticsIDE.def - Diagnostics Text ------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#define DEFINE_DIAGNOSTIC_MACROS
+#include "DefineDiagnosticMacros.h"
+
+//===----------------------------------------------------------------------===//
+
+ERROR(ide_async_in_nonasync_context, none,
+      "async %0 used in a context that does not support concurrency",
+      (DeclName))
+
+// NOTE: This is WARNING because this is emitted for cross actor references with
+// non-'Sendable' types. That is optionally ('-warn-concurrency') warning in
+// Swift 5.5.
+WARNING(ide_cross_actor_reference_swift5, none,
+        "actor-isolated %0 should only be referenced from inside the actor",
+        (DeclName))
+
+WARNING(ide_redundant_import, none,
+        "module %0 is already imported", (DeclName))
+
+// FIXME: Inform which other 'import' this module came from.
+NOTE(ide_redundant_import_indirect, none,
+     "module %0 is already imported via another module import", (DeclName))
+
+WARNING(ide_availability_softdeprecated, Deprecation,
+        "%select{getter for |setter for |}0%1 will be deprecated"
+        " in %select{a future version|%select{a future version of %3|%3 %5}4}2"
+        "%select{|: %6}6",
+        (unsigned, DeclName, bool, StringRef, bool, llvm::VersionTuple,
+         StringRef))
+
+WARNING(ide_availability_softdeprecated_rename, Deprecation,
+        "%select{getter for |setter for |}0%1 will be deprecated"
+        " in %select{a future version|%select{a future version of %3|%3 %5}4}2"
+        ": renamed to '%6'",
+        (unsigned, DeclName, bool, StringRef, bool, llvm::VersionTuple, StringRef))
+
+//===----------------------------------------------------------------------===//
+
+#define UNDEFINE_DIAGNOSTIC_MACROS
+#include "DefineDiagnosticMacros.h"

include/swift/AST/DiagnosticsIDE.h

@@ -0,0 +1,32 @@
+//===--- DiagnosticsIDE.h - Diagnostic Definitions --------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+/// \file
+/// This file defines diagnostics used only in IDE.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_DIAGNOSTICSIDE_H
+#define SWIFT_DIAGNOSTICSIDE_H
+
+#include "swift/AST/DiagnosticsCommon.h"
+
+namespace swift {
+  namespace diag {
+  // Declare common diagnostics objects with their appropriate types.
+#define DIAG(KIND,ID,Options,Text,Signature) \
+    extern detail::DiagWithArguments<void Signature>::type ID;
+#include "DiagnosticsIDE.def"
+  }
+}
+
+#endif

include/swift/IDE/CodeCompletion.h

@@ -568,6 +568,14 @@ enum class CompletionKind {
   TypeAttrBeginning,
 };
 
+enum class CodeCompletionDiagnosticSeverity: uint8_t {
+  None,
+  Error,
+  Warning,
+  Remark,
+  Note,
+};
+
 /// A single code completion result.
 class CodeCompletionResult {
   friend class CodeCompletionResultBuilder;
@@ -607,7 +615,9 @@ class CodeCompletionResult {
   enum class NotRecommendedReason {
     None = 0,
     RedundantImport,
+    RedundantImportIndirect,
     Deprecated,
+    SoftDeprecated,
     InvalidAsyncContext,
     CrossActorReference,
     VariableUsedInOwnDefinition,
@@ -633,10 +643,13 @@ class CodeCompletionResult {
 private:
   CodeCompletionString *CompletionString;
   StringRef ModuleName;
+  StringRef SourceFilePath;
   StringRef BriefDocComment;
   ArrayRef<StringRef> AssociatedUSRs;
   ArrayRef<std::pair<StringRef, StringRef>> DocWords;
   unsigned TypeDistance : 3;
+  unsigned DiagnosticSeverity: 3;
+  StringRef DiagnosticMessage;
 
 public:
   /// Constructs a \c Pattern, \c Keyword or \c BuiltinOperator result.
@@ -663,6 +676,7 @@ class CodeCompletionResult {
            getOperatorKind() != CodeCompletionOperatorKind::None);
     AssociatedKind = 0;
     IsSystem = 0;
+    DiagnosticSeverity = 0;
   }
 
   /// Constructs a \c Keyword result.
@@ -683,6 +697,7 @@ class CodeCompletionResult {
     assert(CompletionString);
     AssociatedKind = static_cast<unsigned>(Kind);
     IsSystem = 0;
+    DiagnosticSeverity = 0;
   }
 
   /// Constructs a \c Literal result.
@@ -700,6 +715,7 @@ class CodeCompletionResult {
         TypeDistance(TypeDistance) {
     AssociatedKind = static_cast<unsigned>(LiteralKind);
     IsSystem = 0;
+    DiagnosticSeverity = 0;
     assert(CompletionString);
   }
 
@@ -727,6 +743,7 @@ class CodeCompletionResult {
     assert(AssociatedDecl && "should have a decl");
     AssociatedKind = unsigned(getCodeCompletionDeclKind(AssociatedDecl));
     IsSystem = getDeclIsSystem(AssociatedDecl);
+    DiagnosticSeverity = 0;
     assert(CompletionString);
     if (isOperator())
       KnownOperatorKind =
@@ -740,9 +757,10 @@ class CodeCompletionResult {
                        CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        CodeCompletionDeclKind DeclKind, bool IsSystem,
-                       StringRef ModuleName,
+                       StringRef ModuleName, StringRef SourceFilePath,
                        CodeCompletionResult::NotRecommendedReason NotRecReason,
-                       StringRef BriefDocComment,
+                       CodeCompletionDiagnosticSeverity diagSeverity,
+                       StringRef DiagnosticMessage, StringRef BriefDocComment,
                        ArrayRef<StringRef> AssociatedUSRs,
                        ArrayRef<std::pair<StringRef, StringRef>> DocWords,
                        ExpectedTypeRelation TypeDistance,
@@ -752,9 +770,11 @@ class CodeCompletionResult {
         SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecReason)), IsSystem(IsSystem),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
-        ModuleName(ModuleName), BriefDocComment(BriefDocComment),
-        AssociatedUSRs(AssociatedUSRs), DocWords(DocWords),
-        TypeDistance(TypeDistance) {
+        ModuleName(ModuleName), SourceFilePath(SourceFilePath),
+        BriefDocComment(BriefDocComment), AssociatedUSRs(AssociatedUSRs),
+        DocWords(DocWords), TypeDistance(TypeDistance),
+        DiagnosticSeverity(unsigned(diagSeverity)),
+        DiagnosticMessage(DiagnosticMessage) {
     AssociatedKind = static_cast<unsigned>(DeclKind);
     assert(CompletionString);
     assert(!isOperator() ||
@@ -853,6 +873,29 @@ class CodeCompletionResult {
     return DocWords;
   }
 
+  void setSourceFilePath(StringRef value) {
+    SourceFilePath = value;
+  }
+
+  void setDiagnostics(CodeCompletionDiagnosticSeverity severity, StringRef message) {
+    DiagnosticSeverity = static_cast<unsigned>(severity);
+    DiagnosticMessage = message;
+  }
+
+  CodeCompletionDiagnosticSeverity getDiagnosticSeverity() const {
+    return static_cast<CodeCompletionDiagnosticSeverity>(DiagnosticSeverity);
+  }
+
+  StringRef getDiagnosticMessage() const {
+    return DiagnosticMessage;
+  }
+
+  /// Returns the source file path where the associated decl was declared.
+  /// Returns an empty string if the information is not available.
+  StringRef getSourceFilePath() const {
+    return SourceFilePath;
+  }
+
   /// Print a debug representation of the code completion result to \p OS.
   void printPrefix(raw_ostream &OS) const;
   SWIFT_DEBUG_DUMP;
@@ -865,6 +908,15 @@ class CodeCompletionResult {
   static bool getDeclIsSystem(const Decl *D);
 };
 
+/// A pair of a file path and its up-to-date-ness.
+struct SourceFileAndUpToDate {
+  StringRef FilePath;
+  bool IsUpToDate;
+
+  SourceFileAndUpToDate(StringRef FilePath, bool IsUpToDate)
+      : FilePath(FilePath), IsUpToDate(IsUpToDate) {}
+};
+
 struct CodeCompletionResultSink {
   using AllocatorPtr = std::shared_ptr<llvm::BumpPtrAllocator>;
 
@@ -877,11 +929,13 @@ struct CodeCompletionResultSink {
 
   /// Whether to annotate the results with XML.
   bool annotateResult = false;
+  bool requiresSourceFileInfo = false;
 
   /// Whether to emit object literals if desired.
   bool includeObjectLiterals = true;
 
   std::vector<CodeCompletionResult *> Results;
+  std::vector<SourceFileAndUpToDate> SourceFiles;
 
   /// A single-element cache for module names stored in Allocator, keyed by a
   /// clang::Module * or swift::ModuleDecl *.
@@ -950,7 +1004,10 @@ class CodeCompletionContext {
       : Cache(Cache) {}
 
   void setAnnotateResult(bool flag) { CurrentResults.annotateResult = flag; }
-  bool getAnnotateResult() { return CurrentResults.annotateResult; }
+  bool getAnnotateResult() const { return CurrentResults.annotateResult; }
+
+  void setRequiresSourceFileInfo(bool flag) { CurrentResults.requiresSourceFileInfo = flag; }
+  bool requiresSourceFileInfo() const { return CurrentResults.requiresSourceFileInfo; }
 
   void setIncludeObjectLiterals(bool flag) {
     CurrentResults.includeObjectLiterals = flag;
@@ -995,8 +1052,7 @@ struct SimpleCachingCodeCompletionConsumer : public CodeCompletionConsumer {
                                DeclContext *DCForModules) override;
 
   /// Clients should override this method to receive \p Results.
-  virtual void handleResults(
-      MutableArrayRef<CodeCompletionResult *> Results) = 0;
+  virtual void handleResults(CodeCompletionContext &context) = 0;
 };
 
 /// A code completion result consumer that prints the results to a
@@ -1007,6 +1063,7 @@ class PrintingCodeCompletionConsumer
   bool IncludeKeywords;
   bool IncludeComments;
   bool PrintAnnotatedDescription;
+  bool RequiresSourceFileInfo = false;
 
 public:
  PrintingCodeCompletionConsumer(llvm::raw_ostream &OS,
@@ -1018,7 +1075,8 @@ class PrintingCodeCompletionConsumer
        IncludeComments(IncludeComments),
        PrintAnnotatedDescription(PrintAnnotatedDescription) {}
 
- void handleResults(MutableArrayRef<CodeCompletionResult *> Results) override;
+  void handleResults(CodeCompletionContext &context) override;
+  void handleResults(MutableArrayRef<CodeCompletionResult *> Results);
 };
 
 /// Create a factory for code completion callbacks.

include/swift/IDE/ModuleSourceFileInfo.h

@@ -0,0 +1,39 @@
+//===--- ModuleSourceFileInfo.h ---------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_MODULESOURCEFILEINFO_H
+#define SWIFT_IDE_MODULESOURCEFILEINFO_H
+
+#include "swift/AST/RawComment.h"
+#include "swift/Basic/BasicSourceInfo.h"
+#include "swift/Basic/LLVM.h"
+
+namespace swift {
+class ASTContext;
+class Decl;
+namespace ide {
+
+/// Get the source file path where \p D is declared. Returns an empty string
+/// if the information is not available.
+StringRef getSourceFilePathForDecl(const Decl *D);
+
+/// Check if the source file of \p info is up-to-date.
+///  * \c true if the mtime and the size are the same.
+///  * \c true if the interface has hasn't changed.
+///  * \c false otherwise.
+bool isSourceFileUpToDate(const BasicSourceFileInfo &info, ASTContext &Ctx);
+
+
+} // namespace ide
+} // namespace swift
+
+#endif // SWIFT_IDE_MODULESOURCEFILEINFO_H

include/swift/Parse/Lexer.h

@@ -448,7 +448,7 @@ class Lexer {
   /// the byte content.
   ///
   /// If a copy needs to be made, it will be allocated out of the provided
-  /// \p Buffer.
+  /// \p Buffer. If \p IndentToStrip is '~0U', the indent is auto-detected.
   static StringRef getEncodedStringSegment(StringRef Str,
                                            SmallVectorImpl<char> &Buffer,
                                            bool IsFirstSegment = false,