cmOrderDirectories.h 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  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 cmOrderDirectories_h
  4. #define cmOrderDirectories_h
  5. #include "cmConfigure.h" // IWYU pragma: keep
  6. #include "cmsys/RegularExpression.hxx"
  7. #include <map>
  8. #include <set>
  9. #include <string>
  10. #include <utility>
  11. #include <vector>
  12. class cmGeneratorTarget;
  13. class cmGlobalGenerator;
  14. class cmOrderDirectoriesConstraint;
  15. /** \class cmOrderDirectories
  16. * \brief Compute a safe runtime path order for a set of shared libraries.
  17. */
  18. class cmOrderDirectories
  19. {
  20. public:
  21. cmOrderDirectories(cmGlobalGenerator* gg, cmGeneratorTarget const* target,
  22. const char* purpose);
  23. ~cmOrderDirectories();
  24. void AddRuntimeLibrary(std::string const& fullPath,
  25. const char* soname = nullptr);
  26. void AddLinkLibrary(std::string const& fullPath);
  27. void AddUserDirectories(std::vector<std::string> const& extra);
  28. void AddLanguageDirectories(std::vector<std::string> const& dirs);
  29. void SetImplicitDirectories(std::set<std::string> const& implicitDirs);
  30. void SetLinkExtensionInfo(std::vector<std::string> const& linkExtensions,
  31. std::string const& removeExtRegex);
  32. std::vector<std::string> const& GetOrderedDirectories();
  33. private:
  34. cmGlobalGenerator* GlobalGenerator;
  35. cmGeneratorTarget const* Target;
  36. std::string Purpose;
  37. std::vector<std::string> OrderedDirectories;
  38. std::vector<cmOrderDirectoriesConstraint*> ConstraintEntries;
  39. std::vector<cmOrderDirectoriesConstraint*> ImplicitDirEntries;
  40. std::vector<std::string> UserDirectories;
  41. std::vector<std::string> LanguageDirectories;
  42. cmsys::RegularExpression RemoveLibraryExtension;
  43. std::vector<std::string> LinkExtensions;
  44. std::set<std::string> ImplicitDirectories;
  45. std::set<std::string> EmmittedConstraintSOName;
  46. std::set<std::string> EmmittedConstraintLibrary;
  47. std::vector<std::string> OriginalDirectories;
  48. std::map<std::string, int> DirectoryIndex;
  49. std::vector<int> DirectoryVisited;
  50. void CollectOriginalDirectories();
  51. int AddOriginalDirectory(std::string const& dir);
  52. void AddOriginalDirectories(std::vector<std::string> const& dirs);
  53. void FindConflicts();
  54. void FindImplicitConflicts();
  55. void OrderDirectories();
  56. void VisitDirectory(unsigned int i);
  57. void DiagnoseCycle();
  58. int WalkId;
  59. bool CycleDiagnosed;
  60. bool Computed;
  61. // Adjacency-list representation of runtime path ordering graph.
  62. // This maps from directory to those that must come *before* it.
  63. // Each entry that must come before is a pair. The first element is
  64. // the index of the directory that must come first. The second
  65. // element is the index of the runtime library that added the
  66. // constraint.
  67. typedef std::pair<int, int> ConflictPair;
  68. struct ConflictList : public std::vector<ConflictPair>
  69. {
  70. };
  71. std::vector<ConflictList> ConflictGraph;
  72. // Compare directories after resolving symlinks.
  73. bool IsSameDirectory(std::string const& l, std::string const& r);
  74. bool IsImplicitDirectory(std::string const& dir);
  75. std::string const& GetRealPath(std::string const& dir);
  76. std::map<std::string, std::string> RealPaths;
  77. friend class cmOrderDirectoriesConstraint;
  78. friend class cmOrderDirectoriesConstraintLibrary;
  79. };
  80. #endif