mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
53989ad72c
We're going to move toward the new swift-syntax formatter. Use it for the "swift" diagnostic style instead of the experimental formatter written in C++. There are some tests for the experimental formatter in C++ that test precise formatting of diagnostics. I've disabled them in the same places where the new swift-syntax formatter is enabled, for now. We may choose to remove them entirely, because swift-syntax itself is where the specific format is defined, and has those same kinds of tests already.
103 lines
3.4 KiB
C++
103 lines
3.4 KiB
C++
//===--- DiagnosticOptions.h ------------------------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_BASIC_DIAGNOSTICOPTIONS_H
|
|
#define SWIFT_BASIC_DIAGNOSTICOPTIONS_H
|
|
|
|
#include "llvm/ADT/Hashing.h"
|
|
|
|
namespace swift {
|
|
|
|
/// Options for controlling diagnostics.
|
|
class DiagnosticOptions {
|
|
public:
|
|
/// Indicates whether textual diagnostics should use color.
|
|
bool UseColor = false;
|
|
|
|
/// Indicates whether the diagnostics produced during compilation should be
|
|
/// checked against expected diagnostics, indicated by markers in the
|
|
/// input source file.
|
|
enum {
|
|
NoVerify,
|
|
Verify,
|
|
VerifyAndApplyFixes
|
|
} VerifyMode = NoVerify;
|
|
|
|
enum FormattingStyle { LLVM, Swift };
|
|
|
|
/// Indicates whether to allow diagnostics for \c <unknown> locations if
|
|
/// \c VerifyMode is not \c NoVerify.
|
|
bool VerifyIgnoreUnknown = false;
|
|
|
|
/// Indicates whether diagnostic passes should be skipped.
|
|
bool SkipDiagnosticPasses = false;
|
|
|
|
/// Additional non-source files which will have diagnostics emitted in them,
|
|
/// and which should be scanned for expectations by the diagnostic verifier.
|
|
std::vector<std::string> AdditionalVerifierFiles;
|
|
|
|
/// Keep emitting subsequent diagnostics after a fatal error.
|
|
bool ShowDiagnosticsAfterFatalError = false;
|
|
|
|
/// When emitting fixits as code edits, apply all fixits from diagnostics
|
|
/// without any filtering.
|
|
bool FixitCodeForAllDiagnostics = false;
|
|
|
|
/// Suppress all warnings
|
|
bool SuppressWarnings = false;
|
|
|
|
/// Suppress all remarks
|
|
bool SuppressRemarks = false;
|
|
|
|
/// Treat all warnings as errors
|
|
bool WarningsAsErrors = false;
|
|
|
|
/// When printing diagnostics, include the diagnostic name (diag::whatever) at
|
|
/// the end.
|
|
bool PrintDiagnosticNames = false;
|
|
|
|
/// If set to true, include educational notes in printed output if available.
|
|
/// Educational notes are documentation which supplement diagnostics.
|
|
bool PrintEducationalNotes = false;
|
|
|
|
/// Whether to emit diagnostics in the terse LLVM style or in a more
|
|
/// descriptive style that's specific to Swift (currently experimental).
|
|
FormattingStyle PrintedFormattingStyle = FormattingStyle::LLVM;
|
|
|
|
/// Whether to emit macro expansion buffers into separate, temporary files.
|
|
bool EmitMacroExpansionFiles = true;
|
|
|
|
std::string DiagnosticDocumentationPath = "";
|
|
|
|
std::string LocalizationCode = "";
|
|
|
|
/// Path to a directory of diagnostic localization tables.
|
|
std::string LocalizationPath = "";
|
|
|
|
/// Return a hash code of any components from these options that should
|
|
/// contribute to a Swift Bridging PCH hash.
|
|
llvm::hash_code getPCHHashComponents() const {
|
|
// Nothing here that contributes anything significant when emitting the PCH.
|
|
return llvm::hash_value(0);
|
|
}
|
|
|
|
/// Return a hash code of any components from these options that should
|
|
/// contribute to a Swift Dependency Scanning hash.
|
|
llvm::hash_code getModuleScanningHashComponents() const {
|
|
return llvm::hash_value(0);
|
|
}
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_BASIC_DIAGNOSTICOPTIONS_H
|