mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
0466d5c0ca
This commit makes a number of adjustments to how the diagnostic verifier handles source buffers and source locations. Specifically: • Files named by `-verify-additional-file` are read as late as possible so that if some other component of the compiler has already loaded the file, even in some exotic way (e.g. ClangImporter’s source buffer mirroring), it will use the same buffer. • Expectation source locations now ignore virtual files and other trickery; they are based on the source buffer and physical location in the file. Hopefully this will make `-verify-additional-file` work better on Windows. As an unintended side effect, it also changes how expectations work in tests that use `#sourceLocation()`.
151 lines
5.4 KiB
C++
151 lines
5.4 KiB
C++
//===--- DiagnosticVerifier.h - Diagnostic Verifier (-verify) ---*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 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 exposes support for the diagnostic verifier, which is used to
|
|
// implement -verify mode in the compiler.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_FRONTEND_DIAGNOSTIC_VERIFIER_H
|
|
#define SWIFT_FRONTEND_DIAGNOSTIC_VERIFIER_H
|
|
|
|
#include "llvm/ADT/SmallString.h"
|
|
#include "swift/AST/DiagnosticConsumer.h"
|
|
#include "swift/Basic/LLVM.h"
|
|
|
|
namespace swift {
|
|
class DependencyTracker;
|
|
class FileUnit;
|
|
class SourceManager;
|
|
class SourceFile;
|
|
|
|
// MARK: - DependencyVerifier
|
|
|
|
bool verifyDependencies(SourceManager &SM, ArrayRef<FileUnit *> SFs);
|
|
bool verifyDependencies(SourceManager &SM, ArrayRef<SourceFile *> SFs);
|
|
|
|
// MARK: - DiagnosticVerifier
|
|
struct ExpectedFixIt;
|
|
|
|
/// A range expressed in terms of line-and-column pairs.
|
|
struct LineColumnRange {
|
|
unsigned StartLine, StartCol;
|
|
unsigned EndLine, EndCol;
|
|
|
|
LineColumnRange() : StartLine(0), StartCol(0), EndLine(0), EndCol(0) {}
|
|
};
|
|
|
|
class CapturedFixItInfo final {
|
|
SourceManager *diagSM;
|
|
DiagnosticInfo::FixIt FixIt;
|
|
mutable LineColumnRange LineColRange;
|
|
|
|
public:
|
|
CapturedFixItInfo(SourceManager &diagSM, DiagnosticInfo::FixIt FixIt)
|
|
: diagSM(&diagSM), FixIt(FixIt) {}
|
|
|
|
CharSourceRange &getSourceRange() { return FixIt.getRange(); }
|
|
const CharSourceRange &getSourceRange() const { return FixIt.getRange(); }
|
|
|
|
StringRef getText() const { return FixIt.getText(); }
|
|
|
|
/// Obtain the line-column range corresponding to the fix-it's
|
|
/// replacement range.
|
|
const LineColumnRange &getLineColumnRange(SourceManager &SM) const;
|
|
};
|
|
|
|
struct CapturedDiagnosticInfo {
|
|
llvm::SmallString<128> Message;
|
|
std::optional<unsigned> SourceBufferID;
|
|
DiagnosticKind Classification;
|
|
SourceLoc Loc;
|
|
unsigned Line;
|
|
unsigned Column;
|
|
SmallVector<CapturedFixItInfo, 2> FixIts;
|
|
SmallVector<std::string, 1> EducationalNotes;
|
|
|
|
CapturedDiagnosticInfo(llvm::SmallString<128> Message,
|
|
std::optional<unsigned> SourceBufferID,
|
|
DiagnosticKind Classification, SourceLoc Loc,
|
|
unsigned Line, unsigned Column,
|
|
SmallVector<CapturedFixItInfo, 2> FixIts,
|
|
SmallVector<std::string, 1> EducationalNotes)
|
|
: Message(Message), SourceBufferID(SourceBufferID),
|
|
Classification(Classification), Loc(Loc), Line(Line), Column(Column),
|
|
FixIts(FixIts), EducationalNotes(EducationalNotes) {
|
|
std::sort(EducationalNotes.begin(), EducationalNotes.end());
|
|
}
|
|
};
|
|
/// This class implements support for -verify mode in the compiler. It
|
|
/// buffers up diagnostics produced during compilation, then checks them
|
|
/// against expected-error markers in the source file.
|
|
class DiagnosticVerifier : public DiagnosticConsumer {
|
|
SourceManager &SM;
|
|
std::vector<CapturedDiagnosticInfo> CapturedDiagnostics;
|
|
ArrayRef<unsigned> BufferIDs;
|
|
ArrayRef<std::string> AdditionalFilePaths;
|
|
bool AutoApplyFixes;
|
|
bool IgnoreUnknown;
|
|
bool UseColor;
|
|
ArrayRef<std::string> AdditionalExpectedPrefixes;
|
|
|
|
public:
|
|
explicit DiagnosticVerifier(SourceManager &SM, ArrayRef<unsigned> BufferIDs,
|
|
ArrayRef<std::string> AdditionalFilePaths,
|
|
bool AutoApplyFixes, bool IgnoreUnknown,
|
|
bool UseColor,
|
|
ArrayRef<std::string> AdditionalExpectedPrefixes)
|
|
: SM(SM), BufferIDs(BufferIDs), AdditionalFilePaths(AdditionalFilePaths),
|
|
AutoApplyFixes(AutoApplyFixes), IgnoreUnknown(IgnoreUnknown),
|
|
UseColor(UseColor),
|
|
AdditionalExpectedPrefixes(AdditionalExpectedPrefixes) {}
|
|
|
|
virtual void handleDiagnostic(SourceManager &SM,
|
|
const DiagnosticInfo &Info) override;
|
|
|
|
virtual bool finishProcessing() override;
|
|
|
|
private:
|
|
/// Result of verifying a file.
|
|
struct Result {
|
|
/// Were there any errors? All of the following are considered errors:
|
|
/// - Expected diagnostics that were not present
|
|
/// - Unexpected diagnostics that were present
|
|
/// - Errors in the definition of expected diagnostics
|
|
bool HadError;
|
|
bool HadUnexpectedDiag;
|
|
};
|
|
|
|
void printDiagnostic(const llvm::SMDiagnostic &Diag) const;
|
|
|
|
bool
|
|
verifyUnknown(std::vector<CapturedDiagnosticInfo> &CapturedDiagnostics) const;
|
|
|
|
/// verifyFile - After the file has been processed, check to see if we
|
|
/// got all of the expected diagnostics and check to see if there were any
|
|
/// unexpected ones.
|
|
Result verifyFile(unsigned BufferID);
|
|
|
|
bool checkForFixIt(const std::vector<ExpectedFixIt> &ExpectedAlts,
|
|
const CapturedDiagnosticInfo &D, unsigned BufferID) const;
|
|
|
|
// Render the verifier syntax for a given set of fix-its.
|
|
std::string renderFixits(ArrayRef<CapturedFixItInfo> ActualFixIts,
|
|
unsigned BufferID, unsigned DiagnosticLineNo) const;
|
|
|
|
void printRemainingDiagnostics() const;
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|