mirror of
https://gitlab.kitware.com/cmake/cmake.git
synced 2026-09-25 04:09:36 +03:00
Daniel Tierney
4cc948ad08
Reorganize CMake's SARIF implementation to clearly distinguish between the SARIF standard and CMake's result reporting structure, fixing several validation failures. - Removed unused message strings in reported rules. - Report artifact locations relative to the CMake home directory. - Use the recommended schema URL. - Stop reporting some invalid locations read from the top of the stack. cmMessenger no longer manages a SARIF log but stores a list of displayed messages. The SARIF log is constructed from displayed messages upon writing the file.
77 lines
1.9 KiB
C++
77 lines
1.9 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file LICENSE.rst or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <cm/optional>
|
|
|
|
#include "cmDiagnosticContext.h"
|
|
#include "cmDiagnostics.h"
|
|
#include "cmListFileCache.h"
|
|
#include "cmMessageType.h" // IWYU pragma: keep
|
|
|
|
class cmStateSnapshot;
|
|
|
|
#ifdef CMake_ENABLE_DEBUGGER
|
|
namespace cmDebugger {
|
|
class cmDebuggerAdapter;
|
|
}
|
|
#endif
|
|
|
|
class cmMessenger
|
|
{
|
|
public:
|
|
void IssueMessage(
|
|
MessageType type, std::string const& text,
|
|
cmListFileBacktrace const& backtrace = cmListFileBacktrace());
|
|
|
|
void IssueDiagnostic(cmDiagnosticCategory category, std::string const& text,
|
|
cmStateSnapshot const& fallbackContext,
|
|
cmDiagnosticContext const& context = {});
|
|
|
|
void DisplayMessage(MessageType type, cmDiagnosticCategory category,
|
|
std::string const& text,
|
|
cmListFileBacktrace const& backtrace);
|
|
|
|
void SetTopSource(cm::optional<std::string> topSource);
|
|
|
|
// Print the top of a backtrace.
|
|
void PrintBacktraceTitle(std::ostream& out,
|
|
cmListFileBacktrace const& bt) const;
|
|
#ifdef CMake_ENABLE_DEBUGGER
|
|
void SetDebuggerAdapter(
|
|
std::shared_ptr<cmDebugger::cmDebuggerAdapter> const& debuggerAdapter)
|
|
{
|
|
DebuggerAdapter = debuggerAdapter;
|
|
}
|
|
#endif
|
|
|
|
struct Message
|
|
{
|
|
MessageType Type;
|
|
cmDiagnosticCategory Category;
|
|
cmListFileBacktrace Backtrace;
|
|
std::string Text;
|
|
};
|
|
|
|
std::vector<Message> const& GetDisplayedMessages() const
|
|
{
|
|
return this->DisplayedMessages;
|
|
}
|
|
|
|
private:
|
|
cm::optional<std::string> TopSource;
|
|
|
|
std::vector<Message> DisplayedMessages;
|
|
|
|
#ifdef CMake_ENABLE_DEBUGGER
|
|
std::shared_ptr<cmDebugger::cmDebuggerAdapter> DebuggerAdapter;
|
|
#endif
|
|
};
|