mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
The serialized diagnostic format has some extra fields that we can adopt for diagnostic groups. Specifically: * Category: store the diagnostic group name here * Flags: extend the hack used by educational notes of placing Markdown file paths here
60 lines
1.7 KiB
C++
60 lines
1.7 KiB
C++
//===--- DiagnosticGroups.h - Diagnostic Groups -----------------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 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 defines the diagnostic groups enumaration, group graph
|
|
// and auxilary functions.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_DIAGNOSTICGROUPS_H
|
|
#define SWIFT_DIAGNOSTICGROUPS_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include <array>
|
|
#include <string_view>
|
|
#include <unordered_map>
|
|
|
|
namespace swift {
|
|
enum class DiagID : uint32_t;
|
|
|
|
enum class DiagGroupID : uint16_t {
|
|
#define GROUP(Name, Version) Name,
|
|
#include "swift/AST/DiagnosticGroups.def"
|
|
};
|
|
|
|
constexpr const auto DiagGroupsCount = [] {
|
|
size_t count = 0;
|
|
#define GROUP(Name, Version) ++count;
|
|
#include "DiagnosticGroups.def"
|
|
return count;
|
|
}();
|
|
|
|
struct DiagGroupInfo {
|
|
DiagGroupID id;
|
|
std::string_view name;
|
|
std::string_view documentationFile;
|
|
llvm::ArrayRef<DiagGroupID> supergroups;
|
|
llvm::ArrayRef<DiagGroupID> subgroups;
|
|
llvm::ArrayRef<DiagID> diagnostics;
|
|
|
|
void traverseDepthFirst(
|
|
llvm::function_ref<void(const DiagGroupInfo &)> func) const;
|
|
};
|
|
|
|
extern const std::array<DiagGroupInfo, DiagGroupsCount> diagnosticGroupsInfo;
|
|
const DiagGroupInfo &getDiagGroupInfoByID(DiagGroupID id);
|
|
std::optional<DiagGroupID> getDiagGroupIDByName(std::string_view name);
|
|
|
|
} // end namespace swift
|
|
|
|
#endif /* SWIFT_DIAGNOSTICGROUPS_H */
|