Source/cmFileAPIConfigureLog.cxx

   1 /* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2    file Copyright.txt or https://cmake.org/licensing for details.  */
   3 #include "cmFileAPIConfigureLog.h"
   4
   5 #include <cm3p/json/value.h>
   6
   7 #include "cmFileAPI.h"
   8 #include "cmStringAlgorithms.h"
   9 #include "cmake.h"
  10
  11 namespace {
  12
  13 class ConfigureLog
  14 {
  15   cmFileAPI& FileAPI;
  16   unsigned long Version;
  17
  18   Json::Value DumpPath();
  19   Json::Value DumpEventKindNames();
  20
  21 public:
  22   ConfigureLog(cmFileAPI& fileAPI, unsigned long version);
  23   Json::Value Dump();
  24 };
  25
  26 ConfigureLog::ConfigureLog(cmFileAPI& fileAPI, unsigned long version)
  27   : FileAPI(fileAPI)
  28   , Version(version)
  29 {
  30   static_cast<void>(this->Version);
  31 }
  32
  33 Json::Value ConfigureLog::Dump()
  34 {
  35   Json::Value configureLog = Json::objectValue;
  36   configureLog["path"] = this->DumpPath();
  37   configureLog["eventKindNames"] = this->DumpEventKindNames();
  38   return configureLog;
  39 }
  40
  41 Json::Value ConfigureLog::DumpPath()
  42 {
  43   return cmStrCat(this->FileAPI.GetCMakeInstance()->GetHomeOutputDirectory(),
  44                   "/CMakeFiles/CMakeConfigureLog.yaml");
  45 }
  46
  47 Json::Value ConfigureLog::DumpEventKindNames()
  48 {
  49   // Report at most one version of each event kind.
  50   // If a new event kind is added, increment ConfigureLogV1Minor.
  51   // If a new version of an existing event kind is added, a new
  52   // major version of the configureLog object kind is needed.
  53   Json::Value eventKindNames = Json::arrayValue;
  54   if (this->Version == 1) {
  55     eventKindNames.append("message-v1");     // WriteMessageEvent
  56     eventKindNames.append("try_compile-v1"); // WriteTryCompileEvent
  57     eventKindNames.append("try_run-v1");     // WriteTryRunEvent
  58   }
  59   return eventKindNames;
  60 }
  61 }
  62
  63 Json::Value cmFileAPIConfigureLogDump(cmFileAPI& fileAPI,
  64                                       unsigned long version)
  65 {
  66   ConfigureLog configureLog(fileAPI, version);
  67   return configureLog.Dump();
  68 }