CodeCompletionDiagnostics.cpp

//===--- CodeCompletionDiagnostics.cpp ------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#include "CodeCompletionDiagnostics.h"

#include "swift/AST/ASTContext.h"
#include "swift/AST/Decl.h"
#include "swift/AST/DiagnosticEngine.h"
#include "swift/AST/DiagnosticsIDE.h"
#include "swift/AST/DiagnosticsSema.h"

using namespace swift;
using namespace ide;

namespace {

CodeCompletionDiagnosticSeverity getSeverity(DiagnosticKind DiagKind) {
  switch (DiagKind) {
  case DiagnosticKind::Error:
    return CodeCompletionDiagnosticSeverity::Error;
    break;
  case DiagnosticKind::Warning:
    return CodeCompletionDiagnosticSeverity::Warning;
    break;
  case DiagnosticKind::Remark:
    return CodeCompletionDiagnosticSeverity::Remark;
    break;
  case DiagnosticKind::Note:
    return CodeCompletionDiagnosticSeverity::Note;
    break;
  }
  llvm_unreachable("unhandled DiagnosticKind");
}

class CodeCompletionDiagnostics {
  ASTContext &Ctx;
  DiagnosticEngine &Engine;

public:
  CodeCompletionDiagnostics(ASTContext &Ctx) : Ctx(Ctx), Engine(Ctx.Diags) {}

  template <typename... ArgTypes>
  bool
  getDiagnostics(CodeCompletionDiagnosticSeverity &severity,
                 llvm::raw_ostream &Out, Diag<ArgTypes...> ID,
                 typename swift::detail::PassArgument<ArgTypes>::type... VArgs);

  bool getDiagnosticForDeprecated(const ValueDecl *D,
                                  CodeCompletionDiagnosticSeverity &severity,
                                  llvm::raw_ostream &Out);
};

template <typename... ArgTypes>
bool CodeCompletionDiagnostics::getDiagnostics(
    CodeCompletionDiagnosticSeverity &severity, llvm::raw_ostream &Out,
    Diag<ArgTypes...> ID,
    typename swift::detail::PassArgument<ArgTypes>::type... VArgs) {
  DiagID id = ID.ID;
  std::vector<DiagnosticArgument> DiagArgs{std::move(VArgs)...};
  auto format = Engine.diagnosticStringFor(id, /*printDiagnosticNames=*/false);
  DiagnosticEngine::formatDiagnosticText(Out, format, DiagArgs);
  severity = getSeverity(Engine.declaredDiagnosticKindFor(id));

  return false;
}

bool CodeCompletionDiagnostics::getDiagnosticForDeprecated(
    const ValueDecl *D, CodeCompletionDiagnosticSeverity &severity,
    llvm::raw_ostream &Out) {
  bool isSoftDeprecated = false;
  const AvailableAttr *Attr = D->getAttrs().getDeprecated(Ctx);
  if (!Attr) {
    Attr = D->getAttrs().getSoftDeprecated(Ctx);
    isSoftDeprecated = true;
  }
  if (!Attr)
    return true;

  DeclName Name;
  unsigned RawAccessorKind;
  std::tie(RawAccessorKind, Name) = getAccessorKindAndNameForDiagnostics(D);
  // FIXME: 'RawAccessorKind' is always 2 (NOT_ACCESSOR_INDEX).
  // Code completion doesn't offer accessors. It only emits 'VarDecl's.
  // So getter/setter specific availability doesn't work in code completion.

  StringRef Platform = Attr->prettyPlatformString();
  llvm::VersionTuple DeprecatedVersion;
  if (Attr->Deprecated)
    DeprecatedVersion = Attr->Deprecated.getValue();

  if (!isSoftDeprecated) {
    if (Attr->Message.empty() && Attr->Rename.empty()) {
      getDiagnostics(severity, Out, diag::availability_deprecated,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     Attr->Deprecated.hasValue(), DeprecatedVersion,
                     /*message*/ StringRef());
    } else if (!Attr->Message.empty()) {
      EncodedDiagnosticMessage EncodedMessage(Attr->Message);
      getDiagnostics(severity, Out, diag::availability_deprecated,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     Attr->Deprecated.hasValue(), DeprecatedVersion,
                     EncodedMessage.Message);
    } else {
      getDiagnostics(severity, Out, diag::availability_deprecated_rename,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     Attr->Deprecated.hasValue(), DeprecatedVersion, false,
                     /*ReplaceKind*/ 0, Attr->Rename);
    }
  } else {
    // '100000' is used as a version number in API that will be deprecated in an
    // upcoming release. This number is to match the 'API_TO_BE_DEPRECATED'
    // macro defined in Darwin platforms.
    static llvm::VersionTuple DISTANT_FUTURE_VESION(100000);
    bool isDistantFuture = DeprecatedVersion >= DISTANT_FUTURE_VESION;

    if (Attr->Message.empty() && Attr->Rename.empty()) {
      getDiagnostics(severity, Out, diag::ide_availability_softdeprecated,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     !isDistantFuture, DeprecatedVersion,
                     /*message*/ StringRef());
    } else if (!Attr->Message.empty()) {
      EncodedDiagnosticMessage EncodedMessage(Attr->Message);
      getDiagnostics(severity, Out, diag::ide_availability_softdeprecated,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     !isDistantFuture, DeprecatedVersion,
                     EncodedMessage.Message);
    } else {
      getDiagnostics(severity, Out, diag::ide_availability_softdeprecated_rename,
                     RawAccessorKind, Name, Attr->hasPlatform(), Platform,
                     !isDistantFuture, DeprecatedVersion, Attr->Rename);
    }
  }
  return false;;
}

} // namespace

bool swift::ide::getContextFreeCompletionDiagnostics(
    ContextFreeNotRecommendedReason Reason, const ValueDecl *D,
    CodeCompletionDiagnosticSeverity &Severity, llvm::raw_ostream &Out) {
  CodeCompletionDiagnostics Diag(D->getASTContext());
  switch (Reason) {
  case ContextFreeNotRecommendedReason::Deprecated:
  case ContextFreeNotRecommendedReason::SoftDeprecated:
    return Diag.getDiagnosticForDeprecated(D, Severity, Out);
  case ContextFreeNotRecommendedReason::None:
    llvm_unreachable("invalid not recommended reason");
  }
  return true;
}

bool swift::ide::getContextualCompletionDiagnostics(
    ContextualNotRecommendedReason Reason, const ValueDecl *D,
    CodeCompletionDiagnosticSeverity &Severity, llvm::raw_ostream &Out) {
  CodeCompletionDiagnostics Diag(D->getASTContext());
  switch (Reason) {
  case ContextualNotRecommendedReason::InvalidAsyncContext:
    // FIXME: Could we use 'diag::async_in_nonasync_function'?
    return Diag.getDiagnostics(
        Severity, Out, diag::ide_async_in_nonasync_context, D->getName());
  case ContextualNotRecommendedReason::CrossActorReference:
    return Diag.getDiagnostics(
        Severity, Out, diag::ide_cross_actor_reference_swift5, D->getName());
  case ContextualNotRecommendedReason::RedundantImport:
    return Diag.getDiagnostics(Severity, Out, diag::ide_redundant_import,
                               D->getName());
  case ContextualNotRecommendedReason::RedundantImportIndirect:
    return Diag.getDiagnostics(
        Severity, Out, diag::ide_redundant_import_indirect, D->getName());
  case ContextualNotRecommendedReason::VariableUsedInOwnDefinition:
    return Diag.getDiagnostics(
        Severity, Out, diag::recursive_accessor_reference,
        D->getName().getBaseIdentifier(), /*"getter"*/ 0);
  case ContextualNotRecommendedReason::None:
    llvm_unreachable("invalid not recommended reason");
  }
  return true;
}