Source/cmStateSnapshot.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
   4 #pragma once
   5
   6 #include "cmConfigure.h" // IWYU pragma: keep
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include <cm/string_view>
  12
  13 #include "cmPolicies.h"
  14 #include "cmStateTypes.h"
  15 #include "cmValue.h"
  16
  17 class cmState;
  18 class cmStateDirectory;
  19
  20 class cmStateSnapshot
  21 {
  22 public:
  23   cmStateSnapshot(cmState* state = nullptr);
  24   cmStateSnapshot(cmState* state, cmStateDetail::PositionType position);
  25
  26   cmValue GetDefinition(std::string const& name) const;
  27   bool IsInitialized(std::string const& name) const;
  28   void SetDefinition(std::string const& name, cm::string_view value);
  29   void RemoveDefinition(std::string const& name);
  30   std::vector<std::string> ClosureKeys() const;
  31   bool RaiseScope(std::string const& var, const char* varDef);
  32
  33   void SetListFile(std::string const& listfile);
  34
  35   std::string const& GetExecutionListFile() const;
  36
  37   std::vector<cmStateSnapshot> GetChildren();
  38
  39   bool IsValid() const;
  40   cmStateSnapshot GetBuildsystemDirectory() const;
  41   cmStateSnapshot GetBuildsystemDirectoryParent() const;
  42   cmStateSnapshot GetCallStackParent() const;
  43   cmStateSnapshot GetCallStackBottom() const;
  44   cmStateEnums::SnapshotType GetType() const;
  45
  46   void SetPolicy(cmPolicies::PolicyID id, cmPolicies::PolicyStatus status);
  47   cmPolicies::PolicyStatus GetPolicy(cmPolicies::PolicyID id,
  48                                      bool parent_scope = false) const;
  49   bool HasDefinedPolicyCMP0011();
  50   void PushPolicy(cmPolicies::PolicyMap const& entry, bool weak);
  51   bool PopPolicy();
  52   bool CanPopPolicyScope();
  53
  54   cmState* GetState() const;
  55
  56   cmStateDirectory GetDirectory() const;
  57
  58   void SetProjectName(std::string const& name);
  59   std::string GetProjectName() const;
  60
  61   void InitializeFromParent_ForSubdirsCommand();
  62
  63   struct StrictWeakOrder
  64   {
  65     bool operator()(const cmStateSnapshot& lhs,
  66                     const cmStateSnapshot& rhs) const;
  67   };
  68
  69   void SetDirectoryDefinitions();
  70   void SetDefaultDefinitions();
  71
  72 private:
  73   friend bool operator==(const cmStateSnapshot& lhs,
  74                          const cmStateSnapshot& rhs);
  75   friend bool operator!=(const cmStateSnapshot& lhs,
  76                          const cmStateSnapshot& rhs);
  77   friend class cmState;
  78   friend class cmStateDirectory;
  79   friend struct StrictWeakOrder;
  80
  81   void InitializeFromParent();
  82
  83   cmState* State;
  84   cmStateDetail::PositionType Position;
  85 };
  86
  87 bool operator==(const cmStateSnapshot& lhs, const cmStateSnapshot& rhs);
  88 bool operator!=(const cmStateSnapshot& lhs, const cmStateSnapshot& rhs);