mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
5c22fd50e2
Removing accessors other than getter and setter can be ABI breaking. This patch starts to formally include all accessor decls in the tree and diagnose their removal. This change only applies to the ABI checker since we still exclude accessors other than getter and setter when diagnosing source compatibility. Including accessors formally can also allow us to check the missing of availability attributes for newly added accessors. rdar://52063421
125 lines
4.4 KiB
C++
125 lines
4.4 KiB
C++
//===--- ModuleDiagsConsumer.cpp - Print module differ diagnostics --*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the ModuleDifferDiagsConsumer class, which displays
|
|
// diagnostics from the module differ as text to an output.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "swift/AST/DiagnosticEngine.h"
|
|
#include "swift/AST/DiagnosticsModuleDiffer.h"
|
|
#include "ModuleDiagsConsumer.h"
|
|
|
|
using namespace swift;
|
|
|
|
namespace {
|
|
// Reproduce the DiagIDs, as we want both the size and access to the raw ids
|
|
// themselves.
|
|
enum LocalDiagID : uint32_t {
|
|
#define DIAG(KIND, ID, Options, Text, Signature) ID,
|
|
#include "swift/AST/DiagnosticsAll.def"
|
|
NumDiags
|
|
};
|
|
|
|
static StringRef getCategoryName(uint32_t ID) {
|
|
switch(ID) {
|
|
case LocalDiagID::removed_decl:
|
|
return "/* Removed Decls */";
|
|
case LocalDiagID::moved_decl:
|
|
case LocalDiagID::decl_kind_changed:
|
|
return "/* Moved Decls */";
|
|
case LocalDiagID::renamed_decl:
|
|
return "/* Renamed Decls */";
|
|
case LocalDiagID::decl_attr_change:
|
|
case LocalDiagID::decl_new_attr:
|
|
case LocalDiagID::var_let_changed:
|
|
case LocalDiagID::func_self_access_change:
|
|
case LocalDiagID::new_decl_without_intro:
|
|
return "/* Decl Attribute changes */";
|
|
case LocalDiagID::default_arg_removed:
|
|
case LocalDiagID::decl_type_change:
|
|
case LocalDiagID::func_type_escaping_changed:
|
|
case LocalDiagID::param_ownership_change:
|
|
case LocalDiagID::type_witness_change:
|
|
return "/* Type Changes */";
|
|
case LocalDiagID::raw_type_change:
|
|
return "/* RawRepresentable Changes */";
|
|
case LocalDiagID::generic_sig_change:
|
|
return "/* Generic Signature Changes */";
|
|
case LocalDiagID::decl_added:
|
|
case LocalDiagID::decl_reorder:
|
|
case LocalDiagID::var_has_fixed_order_change:
|
|
case LocalDiagID::func_has_fixed_order_change:
|
|
return "/* Fixed-layout Type Changes */";
|
|
case LocalDiagID::conformance_added:
|
|
case LocalDiagID::conformance_removed:
|
|
case LocalDiagID::optional_req_changed:
|
|
case LocalDiagID::existing_conformance_added:
|
|
return "/* Protocol Conformance Change */";
|
|
case LocalDiagID::default_associated_type_removed:
|
|
case LocalDiagID::protocol_req_added:
|
|
case LocalDiagID::decl_new_witness_table_entry:
|
|
return "/* Protocol Requirement Change */";
|
|
case LocalDiagID::super_class_removed:
|
|
case LocalDiagID::super_class_changed:
|
|
case LocalDiagID::no_longer_open:
|
|
return "/* Class Inheritance Change */";
|
|
default:
|
|
return StringRef();
|
|
}
|
|
}
|
|
}
|
|
|
|
swift::ide::api::
|
|
ModuleDifferDiagsConsumer::ModuleDifferDiagsConsumer(bool DiagnoseModuleDiff,
|
|
llvm::raw_ostream &OS):
|
|
PrintingDiagnosticConsumer(OS), OS(OS),
|
|
DiagnoseModuleDiff(DiagnoseModuleDiff) {
|
|
#define DIAG(KIND, ID, Options, Text, Signature) \
|
|
auto ID = getCategoryName(LocalDiagID::ID); \
|
|
assert(!ID.empty()); \
|
|
AllDiags[ID] = std::set<std::string>();
|
|
#include "swift/AST/DiagnosticsModuleDiffer.def"
|
|
}
|
|
|
|
void swift::ide::api::ModuleDifferDiagsConsumer::handleDiagnostic(
|
|
SourceManager &SM, SourceLoc Loc, DiagnosticKind Kind,
|
|
StringRef FormatString, ArrayRef<DiagnosticArgument> FormatArgs,
|
|
const DiagnosticInfo &Info,
|
|
const SourceLoc bufferIndirectlyCausingDiagnostic) {
|
|
auto Category = getCategoryName((uint32_t)Info.ID);
|
|
if (Category.empty()) {
|
|
PrintingDiagnosticConsumer::handleDiagnostic(
|
|
SM, Loc, Kind, FormatString, FormatArgs, Info,
|
|
bufferIndirectlyCausingDiagnostic);
|
|
return;
|
|
}
|
|
if (!DiagnoseModuleDiff)
|
|
return;
|
|
llvm::SmallString<256> Text;
|
|
{
|
|
llvm::raw_svector_ostream Out(Text);
|
|
DiagnosticEngine::formatDiagnosticText(Out, FormatString, FormatArgs);
|
|
}
|
|
AllDiags[Category].insert(Text.str().str());
|
|
}
|
|
|
|
swift::ide::api::ModuleDifferDiagsConsumer::~ModuleDifferDiagsConsumer() {
|
|
for (auto &Pair: AllDiags) {
|
|
OS << "\n";
|
|
OS << Pair.first << "\n";
|
|
for (auto &Item: Pair.second) {
|
|
OS << Item << "\n";
|
|
}
|
|
}
|
|
}
|