mirror of
https://github.com/github/codeql.git
synced 2025-12-17 01:03:14 +01:00
109 lines
3.8 KiB
C++
109 lines
3.8 KiB
C++
#pragma once
|
|
|
|
#include <binlog/binlog.hpp>
|
|
#include <string>
|
|
#include <vector>
|
|
#include <unordered_map>
|
|
#include <optional>
|
|
#include <cassert>
|
|
#include <fstream>
|
|
#include <filesystem>
|
|
#include <sstream>
|
|
#include <mutex>
|
|
#include <fmt/format.h>
|
|
#include <fmt/chrono.h>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
namespace codeql {
|
|
|
|
extern const std::string_view programName;
|
|
|
|
struct SwiftDiagnosticsLocation {
|
|
std::string_view file;
|
|
unsigned startLine;
|
|
unsigned startColumn;
|
|
unsigned endLine;
|
|
unsigned endColumn;
|
|
|
|
nlohmann::json json() const;
|
|
std::string str() const;
|
|
};
|
|
|
|
// Models a diagnostic source for Swift, holding static information that goes out into a diagnostic
|
|
// These are internally stored into a map on id's. A specific error log can use binlog's category
|
|
// as id, which will then be used to recover the diagnostic source while dumping.
|
|
struct SwiftDiagnostic {
|
|
enum class Visibility : unsigned char {
|
|
none = 0b000,
|
|
statusPage = 0b001,
|
|
cliSummaryTable = 0b010,
|
|
telemetry = 0b100,
|
|
all = 0b111,
|
|
};
|
|
|
|
std::string_view id;
|
|
std::string_view name;
|
|
static constexpr std::string_view extractorName = "swift";
|
|
std::string_view action;
|
|
// space separated if more than 1. Not a vector to allow constexpr
|
|
// TODO(C++20) with vector going constexpr this can be turned to `std::vector<std::string_view>`
|
|
std::string_view helpLinks;
|
|
// for the moment, we only output errors, so no need to store the severity
|
|
|
|
Visibility visibility{Visibility::all};
|
|
|
|
std::optional<SwiftDiagnosticsLocation> location{};
|
|
|
|
constexpr SwiftDiagnostic(std::string_view id,
|
|
std::string_view name,
|
|
std::string_view action = "",
|
|
std::string_view helpLinks = "",
|
|
Visibility visibility = Visibility::all)
|
|
: id{id}, name{name}, action{action}, helpLinks{helpLinks}, visibility{visibility} {}
|
|
|
|
constexpr SwiftDiagnostic(std::string_view id, std::string_view name, Visibility visibility)
|
|
: SwiftDiagnostic(id, name, "", "", visibility) {}
|
|
|
|
// create a JSON diagnostics for this source with the given timestamp and message to out
|
|
// A plaintextMessage is used that includes both the message and the action to take. Dots are
|
|
// appended to both. The id is used to construct the source id in the form
|
|
// `swift/<prog name>/<id>`
|
|
nlohmann::json json(const std::chrono::system_clock::time_point& timestamp,
|
|
std::string_view message) const;
|
|
|
|
// returns <id> or <id>@<location> if a location is present
|
|
std::string abbreviation() const;
|
|
|
|
SwiftDiagnostic withLocation(std::string_view file,
|
|
unsigned startLine = 0,
|
|
unsigned startColumn = 0,
|
|
unsigned endLine = 0,
|
|
unsigned endColumn = 0) const {
|
|
auto ret = *this;
|
|
ret.location = SwiftDiagnosticsLocation{file, startLine, startColumn, endLine, endColumn};
|
|
return ret;
|
|
}
|
|
|
|
private:
|
|
bool has(Visibility v) const;
|
|
};
|
|
|
|
inline constexpr SwiftDiagnostic::Visibility operator|(SwiftDiagnostic::Visibility lhs,
|
|
SwiftDiagnostic::Visibility rhs) {
|
|
return static_cast<SwiftDiagnostic::Visibility>(static_cast<unsigned char>(lhs) |
|
|
static_cast<unsigned char>(rhs));
|
|
}
|
|
|
|
inline constexpr SwiftDiagnostic::Visibility operator&(SwiftDiagnostic::Visibility lhs,
|
|
SwiftDiagnostic::Visibility rhs) {
|
|
return static_cast<SwiftDiagnostic::Visibility>(static_cast<unsigned char>(lhs) &
|
|
static_cast<unsigned char>(rhs));
|
|
}
|
|
|
|
constexpr SwiftDiagnostic internalError{
|
|
"internal-error",
|
|
"Internal error",
|
|
SwiftDiagnostic::Visibility::telemetry,
|
|
};
|
|
} // namespace codeql
|