cmStateSnapshot.h 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #ifndef cmStateSnapshot_h
  4. #define cmStateSnapshot_h
  5. #include "cmConfigure.h" // IWYU pragma: keep
  6. #include <string>
  7. #include <vector>
  8. #include "cmLinkedTree.h"
  9. #include "cmPolicies.h"
  10. #include "cmStateTypes.h"
  11. class cmState;
  12. class cmStateDirectory;
  13. class cmStateSnapshot
  14. {
  15. public:
  16. cmStateSnapshot(cmState* state = nullptr);
  17. cmStateSnapshot(cmState* state, cmStateDetail::PositionType position);
  18. const char* GetDefinition(std::string const& name) const;
  19. bool IsInitialized(std::string const& name) const;
  20. void SetDefinition(std::string const& name, std::string const& value);
  21. void RemoveDefinition(std::string const& name);
  22. std::vector<std::string> UnusedKeys() const;
  23. std::vector<std::string> ClosureKeys() const;
  24. bool RaiseScope(std::string const& var, const char* varDef);
  25. void SetListFile(std::string const& listfile);
  26. std::string GetExecutionListFile() const;
  27. std::vector<cmStateSnapshot> GetChildren();
  28. bool IsValid() const;
  29. cmStateSnapshot GetBuildsystemDirectoryParent() const;
  30. cmStateSnapshot GetCallStackParent() const;
  31. cmStateSnapshot GetCallStackBottom() const;
  32. cmStateEnums::SnapshotType GetType() const;
  33. void SetPolicy(cmPolicies::PolicyID id, cmPolicies::PolicyStatus status);
  34. cmPolicies::PolicyStatus GetPolicy(cmPolicies::PolicyID id) const;
  35. bool HasDefinedPolicyCMP0011();
  36. void PushPolicy(cmPolicies::PolicyMap const& entry, bool weak);
  37. bool PopPolicy();
  38. bool CanPopPolicyScope();
  39. cmState* GetState() const;
  40. cmStateDirectory GetDirectory() const;
  41. void SetProjectName(std::string const& name);
  42. std::string GetProjectName() const;
  43. void InitializeFromParent_ForSubdirsCommand();
  44. struct StrictWeakOrder
  45. {
  46. bool operator()(const cmStateSnapshot& lhs,
  47. const cmStateSnapshot& rhs) const;
  48. };
  49. void SetDirectoryDefinitions();
  50. void SetDefaultDefinitions();
  51. private:
  52. friend bool operator==(const cmStateSnapshot& lhs,
  53. const cmStateSnapshot& rhs);
  54. friend bool operator!=(const cmStateSnapshot& lhs,
  55. const cmStateSnapshot& rhs);
  56. friend class cmState;
  57. friend class cmStateDirectory;
  58. friend struct StrictWeakOrder;
  59. void InitializeFromParent();
  60. cmState* State;
  61. cmStateDetail::PositionType Position;
  62. };
  63. bool operator==(const cmStateSnapshot& lhs, const cmStateSnapshot& rhs);
  64. bool operator!=(const cmStateSnapshot& lhs, const cmStateSnapshot& rhs);
  65. #endif