mirror of
https://gitlab.kitware.com/cmake/cmake.git
synced 2026-10-07 04:02:23 +03:00
Matthew Woehlke
436bfb628c
Create methods to issue diagnostics. Diagnostics are similar to messages, except that they are associated with a diagnostic category, and the diagnostic state determines their severity. Also, add overloads of methods to issue messages and diagnostics that accept a backtrace, as a number of places must currently bypass layers in order to pass a custom backtrace. These are also sub-optimal because the lower level APIs require the diagnostic state to be explicitly passed by the caller, which we would prefer to avoid whenever possible.
108 lines
2.8 KiB
C++
108 lines
2.8 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 <cm/optional>
|
|
|
|
#include "cmDiagnostics.h"
|
|
#include "cmListFileCache.h"
|
|
#include "cmMessageType.h" // IWYU pragma: keep
|
|
|
|
#ifndef CMAKE_BOOTSTRAP
|
|
# include "cmSarifLog.h"
|
|
#endif
|
|
|
|
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()) const;
|
|
|
|
void IssueDiagnostic(
|
|
cmDiagnosticCategory category, std::string const& text,
|
|
cmStateSnapshot const& context,
|
|
cmListFileBacktrace const& backtrace = cmListFileBacktrace()) const;
|
|
|
|
void DisplayMessage(MessageType type, cmDiagnosticCategory category,
|
|
std::string const& text,
|
|
cmListFileBacktrace const& backtrace) const;
|
|
|
|
void SetTopSource(cm::optional<std::string> topSource);
|
|
|
|
void SetSuppressDevWarnings(bool suppress)
|
|
{
|
|
this->SuppressDevWarnings = suppress;
|
|
}
|
|
void SetSuppressDeprecatedWarnings(bool suppress)
|
|
{
|
|
this->SuppressDeprecatedWarnings = suppress;
|
|
}
|
|
void SetDevWarningsAsErrors(bool error)
|
|
{
|
|
this->DevWarningsAsErrors = error;
|
|
}
|
|
void SetDeprecatedWarningsAsErrors(bool error)
|
|
{
|
|
this->DeprecatedWarningsAsErrors = error;
|
|
}
|
|
|
|
bool GetSuppressDevWarnings() const { return this->SuppressDevWarnings; }
|
|
bool GetSuppressDeprecatedWarnings() const
|
|
{
|
|
return this->SuppressDeprecatedWarnings;
|
|
}
|
|
bool GetDevWarningsAsErrors() const { return this->DevWarningsAsErrors; }
|
|
bool GetDeprecatedWarningsAsErrors() const
|
|
{
|
|
return this->DeprecatedWarningsAsErrors;
|
|
}
|
|
|
|
#ifndef CMAKE_BOOTSTRAP
|
|
cmSarif::ResultsLog const& GetSarifResultsLog() const { return SarifLog; }
|
|
#endif
|
|
|
|
// 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
|
|
|
|
private:
|
|
bool IsMessageTypeVisible(MessageType t) const;
|
|
MessageType ConvertMessageType(MessageType t) const;
|
|
|
|
cm::optional<std::string> TopSource;
|
|
|
|
#ifndef CMAKE_BOOTSTRAP
|
|
cmSarif::ResultsLog SarifLog;
|
|
#endif
|
|
|
|
bool SuppressDevWarnings = false;
|
|
bool SuppressDeprecatedWarnings = false;
|
|
bool DevWarningsAsErrors = false;
|
|
bool DeprecatedWarningsAsErrors = false;
|
|
#ifdef CMake_ENABLE_DEBUGGER
|
|
std::shared_ptr<cmDebugger::cmDebuggerAdapter> DebuggerAdapter;
|
|
#endif
|
|
};
|