Source/cmMessenger.h

   1 /* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2    file Copyright.txt or https://cmake.org/licensing for details.  */
   3 #pragma once
   4
   5 #include "cmConfigure.h" // IWYU pragma: keep
   6
   7 #include <iosfwd>
   8 #include <memory>
   9 #include <string>
  10
  11 #include <cm/optional>
  12
  13 #include "cmListFileCache.h"
  14 #include "cmMessageType.h" // IWYU pragma: keep
  15
  16 #ifdef CMake_ENABLE_DEBUGGER
  17 namespace cmDebugger {
  18 class cmDebuggerAdapter;
  19 }
  20 #endif
  21
  22 class cmMessenger
  23 {
  24 public:
  25   void IssueMessage(
  26     MessageType t, std::string const& text,
  27     cmListFileBacktrace const& backtrace = cmListFileBacktrace()) const;
  28
  29   void DisplayMessage(MessageType t, std::string const& text,
  30                       cmListFileBacktrace const& backtrace) const;
  31
  32   void SetTopSource(cm::optional<std::string> topSource);
  33
  34   void SetSuppressDevWarnings(bool suppress)
  35   {
  36     this->SuppressDevWarnings = suppress;
  37   }
  38   void SetSuppressDeprecatedWarnings(bool suppress)
  39   {
  40     this->SuppressDeprecatedWarnings = suppress;
  41   }
  42   void SetDevWarningsAsErrors(bool error)
  43   {
  44     this->DevWarningsAsErrors = error;
  45   }
  46   void SetDeprecatedWarningsAsErrors(bool error)
  47   {
  48     this->DeprecatedWarningsAsErrors = error;
  49   }
  50
  51   bool GetSuppressDevWarnings() const { return this->SuppressDevWarnings; }
  52   bool GetSuppressDeprecatedWarnings() const
  53   {
  54     return this->SuppressDeprecatedWarnings;
  55   }
  56   bool GetDevWarningsAsErrors() const { return this->DevWarningsAsErrors; }
  57   bool GetDeprecatedWarningsAsErrors() const
  58   {
  59     return this->DeprecatedWarningsAsErrors;
  60   }
  61
  62   // Print the top of a backtrace.
  63   void PrintBacktraceTitle(std::ostream& out,
  64                            cmListFileBacktrace const& bt) const;
  65 #ifdef CMake_ENABLE_DEBUGGER
  66   void SetDebuggerAdapter(
  67     std::shared_ptr<cmDebugger::cmDebuggerAdapter> const& debuggerAdapter)
  68   {
  69     DebuggerAdapter = debuggerAdapter;
  70   }
  71 #endif
  72
  73 private:
  74   bool IsMessageTypeVisible(MessageType t) const;
  75   MessageType ConvertMessageType(MessageType t) const;
  76
  77   cm::optional<std::string> TopSource;
  78
  79   bool SuppressDevWarnings = false;
  80   bool SuppressDeprecatedWarnings = false;
  81   bool DevWarningsAsErrors = false;
  82   bool DeprecatedWarningsAsErrors = false;
  83 #ifdef CMake_ENABLE_DEBUGGER
  84   std::shared_ptr<cmDebugger::cmDebuggerAdapter> DebuggerAdapter;
  85 #endif
  86 };