GeezerVison is showing github.com — codeql/shared/cpp/Diagnostics.h at main · oops4git/codeql

Expand file tree

Diagnostics.h

Copy path

More file actions

Latest commit

History

88 lines (71 loc) · 2.83 KB

Diagnostics.h

Copy path

File metadata and controls

88 lines (71 loc) · 2.83 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

#pragma once

#include <optional>

#include <string_view>

#include <nlohmann/json.hpp>

namespace codeql {

extern const std::string_view programName;

extern const std::string_view extractorName;

struct DiagnosticsLocation {

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.

class Diagnostic {

public:

enum class Visibility : unsigned char {

none = 0b000,

statusPage = 0b001,

cliSummaryTable = 0b010,

telemetry = 0b100,

all = 0b111,

};

// Notice that Tool Status Page severity is not necessarily the same as log severity, as the

// scope is different: TSP's scope is the whole analysis, log's scope is a single run

enum class Severity {

note,

warning,

error,

};

std::string_view id;

std::string_view name;

std::string_view action;

Visibility visibility{Visibility::all};

Severity severity{Severity::error};

std::optional<DiagnosticsLocation> location{};

// create a JSON diagnostics for this source with the given `timestamp` and Markdown `message`

// A markdownMessage is emitted that includes both the message and the action to take. 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;

Diagnostic withLocation(std::string_view file,

unsigned startLine = 0,

unsigned startColumn = 0,

unsigned endLine = 0,

unsigned endColumn = 0) const {

auto ret = *this;

ret.location = DiagnosticsLocation{file, startLine, startColumn, endLine, endColumn};

return ret;

}

private:

bool has(Visibility v) const;

};

inline constexpr Diagnostic::Visibility operator|(Diagnostic::Visibility lhs,

Diagnostic::Visibility rhs) {

return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) |

static_cast<unsigned char>(rhs));

}

inline constexpr Diagnostic::Visibility operator&(Diagnostic::Visibility lhs,

Diagnostic::Visibility rhs) {

return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) &

static_cast<unsigned char>(rhs));

}