cmStateDirectory.cxx 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  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 "cmStateDirectory.h"
  4. #include <algorithm>
  5. #include <assert.h>
  6. #include <iterator>
  7. #include <utility>
  8. #include "cmProperty.h"
  9. #include "cmPropertyMap.h"
  10. #include "cmState.h"
  11. #include "cmStatePrivate.h"
  12. #include "cmStateTypes.h"
  13. #include "cmSystemTools.h"
  14. static std::string const kBINARY_DIR = "BINARY_DIR";
  15. static std::string const kBUILDSYSTEM_TARGETS = "BUILDSYSTEM_TARGETS";
  16. static std::string const kSOURCE_DIR = "SOURCE_DIR";
  17. static std::string const kSUBDIRECTORIES = "SUBDIRECTORIES";
  18. void cmStateDirectory::ComputeRelativePathTopSource()
  19. {
  20. // Relative path conversion inside the source tree is not used to
  21. // construct relative paths passed to build tools so it is safe to use
  22. // even when the source is a network path.
  23. cmStateSnapshot snapshot = this->Snapshot_;
  24. std::vector<cmStateSnapshot> snapshots;
  25. snapshots.push_back(snapshot);
  26. while (true) {
  27. snapshot = snapshot.GetBuildsystemDirectoryParent();
  28. if (snapshot.IsValid()) {
  29. snapshots.push_back(snapshot);
  30. } else {
  31. break;
  32. }
  33. }
  34. std::string result = snapshots.front().GetDirectory().GetCurrentSource();
  35. for (std::vector<cmStateSnapshot>::const_iterator it = snapshots.begin() + 1;
  36. it != snapshots.end(); ++it) {
  37. std::string currentSource = it->GetDirectory().GetCurrentSource();
  38. if (cmSystemTools::IsSubDirectory(result, currentSource)) {
  39. result = currentSource;
  40. }
  41. }
  42. this->DirectoryState->RelativePathTopSource = result;
  43. }
  44. void cmStateDirectory::ComputeRelativePathTopBinary()
  45. {
  46. cmStateSnapshot snapshot = this->Snapshot_;
  47. std::vector<cmStateSnapshot> snapshots;
  48. snapshots.push_back(snapshot);
  49. while (true) {
  50. snapshot = snapshot.GetBuildsystemDirectoryParent();
  51. if (snapshot.IsValid()) {
  52. snapshots.push_back(snapshot);
  53. } else {
  54. break;
  55. }
  56. }
  57. std::string result = snapshots.front().GetDirectory().GetCurrentBinary();
  58. for (std::vector<cmStateSnapshot>::const_iterator it = snapshots.begin() + 1;
  59. it != snapshots.end(); ++it) {
  60. std::string currentBinary = it->GetDirectory().GetCurrentBinary();
  61. if (cmSystemTools::IsSubDirectory(result, currentBinary)) {
  62. result = currentBinary;
  63. }
  64. }
  65. // The current working directory on Windows cannot be a network
  66. // path. Therefore relative paths cannot work when the binary tree
  67. // is a network path.
  68. if (result.size() < 2 || result.substr(0, 2) != "//") {
  69. this->DirectoryState->RelativePathTopBinary = result;
  70. } else {
  71. this->DirectoryState->RelativePathTopBinary.clear();
  72. }
  73. }
  74. const char* cmStateDirectory::GetCurrentSource() const
  75. {
  76. return this->DirectoryState->Location.c_str();
  77. }
  78. void cmStateDirectory::SetCurrentSource(std::string const& dir)
  79. {
  80. std::string& loc = this->DirectoryState->Location;
  81. loc = dir;
  82. cmSystemTools::ConvertToUnixSlashes(loc);
  83. loc = cmSystemTools::CollapseFullPath(loc);
  84. this->ComputeRelativePathTopSource();
  85. this->Snapshot_.SetDefinition("CMAKE_CURRENT_SOURCE_DIR", loc);
  86. }
  87. const char* cmStateDirectory::GetCurrentBinary() const
  88. {
  89. return this->DirectoryState->OutputLocation.c_str();
  90. }
  91. void cmStateDirectory::SetCurrentBinary(std::string const& dir)
  92. {
  93. std::string& loc = this->DirectoryState->OutputLocation;
  94. loc = dir;
  95. cmSystemTools::ConvertToUnixSlashes(loc);
  96. loc = cmSystemTools::CollapseFullPath(loc);
  97. this->ComputeRelativePathTopBinary();
  98. this->Snapshot_.SetDefinition("CMAKE_CURRENT_BINARY_DIR", loc);
  99. }
  100. const char* cmStateDirectory::GetRelativePathTopSource() const
  101. {
  102. return this->DirectoryState->RelativePathTopSource.c_str();
  103. }
  104. const char* cmStateDirectory::GetRelativePathTopBinary() const
  105. {
  106. return this->DirectoryState->RelativePathTopBinary.c_str();
  107. }
  108. void cmStateDirectory::SetRelativePathTopSource(const char* dir)
  109. {
  110. this->DirectoryState->RelativePathTopSource = dir;
  111. }
  112. void cmStateDirectory::SetRelativePathTopBinary(const char* dir)
  113. {
  114. this->DirectoryState->RelativePathTopBinary = dir;
  115. }
  116. cmStateDirectory::cmStateDirectory(
  117. cmLinkedTree<cmStateDetail::BuildsystemDirectoryStateType>::iterator iter,
  118. const cmStateSnapshot& snapshot)
  119. : DirectoryState(iter)
  120. , Snapshot_(snapshot)
  121. {
  122. }
  123. template <typename T, typename U>
  124. cmStringRange GetPropertyContent(T const& content, U contentEndPosition)
  125. {
  126. std::vector<std::string>::const_iterator end =
  127. content.begin() + contentEndPosition;
  128. std::vector<std::string>::const_reverse_iterator rbegin =
  129. cmMakeReverseIterator(end);
  130. rbegin = std::find(rbegin, content.rend(), cmPropertySentinal);
  131. return cmMakeRange(rbegin.base(), end);
  132. }
  133. template <typename T, typename U, typename V>
  134. cmBacktraceRange GetPropertyBacktraces(T const& content, U const& backtraces,
  135. V contentEndPosition)
  136. {
  137. std::vector<std::string>::const_iterator entryEnd =
  138. content.begin() + contentEndPosition;
  139. std::vector<std::string>::const_reverse_iterator rbegin =
  140. cmMakeReverseIterator(entryEnd);
  141. rbegin = std::find(rbegin, content.rend(), cmPropertySentinal);
  142. std::vector<cmListFileBacktrace>::const_iterator it =
  143. backtraces.begin() + std::distance(content.begin(), rbegin.base());
  144. std::vector<cmListFileBacktrace>::const_iterator end = backtraces.end();
  145. return cmMakeRange(it, end);
  146. }
  147. template <typename T, typename U, typename V>
  148. void AppendEntry(T& content, U& backtraces, V& endContentPosition,
  149. const std::string& value, const cmListFileBacktrace& lfbt)
  150. {
  151. if (value.empty()) {
  152. return;
  153. }
  154. assert(endContentPosition == content.size());
  155. content.push_back(value);
  156. backtraces.push_back(lfbt);
  157. endContentPosition = content.size();
  158. }
  159. template <typename T, typename U, typename V>
  160. void SetContent(T& content, U& backtraces, V& endContentPosition,
  161. const std::string& vec, const cmListFileBacktrace& lfbt)
  162. {
  163. assert(endContentPosition == content.size());
  164. content.resize(content.size() + 2);
  165. backtraces.resize(backtraces.size() + 2);
  166. content.back() = vec;
  167. backtraces.back() = lfbt;
  168. endContentPosition = content.size();
  169. }
  170. template <typename T, typename U, typename V>
  171. void ClearContent(T& content, U& backtraces, V& endContentPosition)
  172. {
  173. assert(endContentPosition == content.size());
  174. content.resize(content.size() + 1);
  175. backtraces.resize(backtraces.size() + 1);
  176. endContentPosition = content.size();
  177. }
  178. cmStringRange cmStateDirectory::GetIncludeDirectoriesEntries() const
  179. {
  180. return GetPropertyContent(
  181. this->DirectoryState->IncludeDirectories,
  182. this->Snapshot_.Position->IncludeDirectoryPosition);
  183. }
  184. cmBacktraceRange cmStateDirectory::GetIncludeDirectoriesEntryBacktraces() const
  185. {
  186. return GetPropertyBacktraces(
  187. this->DirectoryState->IncludeDirectories,
  188. this->DirectoryState->IncludeDirectoryBacktraces,
  189. this->Snapshot_.Position->IncludeDirectoryPosition);
  190. }
  191. void cmStateDirectory::AppendIncludeDirectoriesEntry(
  192. const std::string& vec, const cmListFileBacktrace& lfbt)
  193. {
  194. AppendEntry(this->DirectoryState->IncludeDirectories,
  195. this->DirectoryState->IncludeDirectoryBacktraces,
  196. this->Snapshot_.Position->IncludeDirectoryPosition, vec, lfbt);
  197. }
  198. void cmStateDirectory::PrependIncludeDirectoriesEntry(
  199. const std::string& vec, const cmListFileBacktrace& lfbt)
  200. {
  201. std::vector<std::string>::iterator entryEnd =
  202. this->DirectoryState->IncludeDirectories.begin() +
  203. this->Snapshot_.Position->IncludeDirectoryPosition;
  204. std::vector<std::string>::reverse_iterator rend =
  205. this->DirectoryState->IncludeDirectories.rend();
  206. std::vector<std::string>::reverse_iterator rbegin =
  207. cmMakeReverseIterator(entryEnd);
  208. rbegin = std::find(rbegin, rend, cmPropertySentinal);
  209. std::vector<std::string>::iterator entryIt = rbegin.base();
  210. std::vector<std::string>::iterator entryBegin =
  211. this->DirectoryState->IncludeDirectories.begin();
  212. std::vector<cmListFileBacktrace>::iterator btIt =
  213. this->DirectoryState->IncludeDirectoryBacktraces.begin() +
  214. std::distance(entryBegin, entryIt);
  215. this->DirectoryState->IncludeDirectories.insert(entryIt, vec);
  216. this->DirectoryState->IncludeDirectoryBacktraces.insert(btIt, lfbt);
  217. this->Snapshot_.Position->IncludeDirectoryPosition =
  218. this->DirectoryState->IncludeDirectories.size();
  219. }
  220. void cmStateDirectory::SetIncludeDirectories(const std::string& vec,
  221. const cmListFileBacktrace& lfbt)
  222. {
  223. SetContent(this->DirectoryState->IncludeDirectories,
  224. this->DirectoryState->IncludeDirectoryBacktraces,
  225. this->Snapshot_.Position->IncludeDirectoryPosition, vec, lfbt);
  226. }
  227. void cmStateDirectory::ClearIncludeDirectories()
  228. {
  229. ClearContent(this->DirectoryState->IncludeDirectories,
  230. this->DirectoryState->IncludeDirectoryBacktraces,
  231. this->Snapshot_.Position->IncludeDirectoryPosition);
  232. }
  233. cmStringRange cmStateDirectory::GetCompileDefinitionsEntries() const
  234. {
  235. return GetPropertyContent(
  236. this->DirectoryState->CompileDefinitions,
  237. this->Snapshot_.Position->CompileDefinitionsPosition);
  238. }
  239. cmBacktraceRange cmStateDirectory::GetCompileDefinitionsEntryBacktraces() const
  240. {
  241. return GetPropertyBacktraces(
  242. this->DirectoryState->CompileDefinitions,
  243. this->DirectoryState->CompileDefinitionsBacktraces,
  244. this->Snapshot_.Position->CompileDefinitionsPosition);
  245. }
  246. void cmStateDirectory::AppendCompileDefinitionsEntry(
  247. const std::string& vec, const cmListFileBacktrace& lfbt)
  248. {
  249. AppendEntry(this->DirectoryState->CompileDefinitions,
  250. this->DirectoryState->CompileDefinitionsBacktraces,
  251. this->Snapshot_.Position->CompileDefinitionsPosition, vec, lfbt);
  252. }
  253. void cmStateDirectory::SetCompileDefinitions(const std::string& vec,
  254. const cmListFileBacktrace& lfbt)
  255. {
  256. SetContent(this->DirectoryState->CompileDefinitions,
  257. this->DirectoryState->CompileDefinitionsBacktraces,
  258. this->Snapshot_.Position->CompileDefinitionsPosition, vec, lfbt);
  259. }
  260. void cmStateDirectory::ClearCompileDefinitions()
  261. {
  262. ClearContent(this->DirectoryState->CompileDefinitions,
  263. this->DirectoryState->CompileDefinitionsBacktraces,
  264. this->Snapshot_.Position->CompileDefinitionsPosition);
  265. }
  266. cmStringRange cmStateDirectory::GetCompileOptionsEntries() const
  267. {
  268. return GetPropertyContent(this->DirectoryState->CompileOptions,
  269. this->Snapshot_.Position->CompileOptionsPosition);
  270. }
  271. cmBacktraceRange cmStateDirectory::GetCompileOptionsEntryBacktraces() const
  272. {
  273. return GetPropertyBacktraces(
  274. this->DirectoryState->CompileOptions,
  275. this->DirectoryState->CompileOptionsBacktraces,
  276. this->Snapshot_.Position->CompileOptionsPosition);
  277. }
  278. void cmStateDirectory::AppendCompileOptionsEntry(
  279. const std::string& vec, const cmListFileBacktrace& lfbt)
  280. {
  281. AppendEntry(this->DirectoryState->CompileOptions,
  282. this->DirectoryState->CompileOptionsBacktraces,
  283. this->Snapshot_.Position->CompileOptionsPosition, vec, lfbt);
  284. }
  285. void cmStateDirectory::SetCompileOptions(const std::string& vec,
  286. const cmListFileBacktrace& lfbt)
  287. {
  288. SetContent(this->DirectoryState->CompileOptions,
  289. this->DirectoryState->CompileOptionsBacktraces,
  290. this->Snapshot_.Position->CompileOptionsPosition, vec, lfbt);
  291. }
  292. void cmStateDirectory::ClearCompileOptions()
  293. {
  294. ClearContent(this->DirectoryState->CompileOptions,
  295. this->DirectoryState->CompileOptionsBacktraces,
  296. this->Snapshot_.Position->CompileOptionsPosition);
  297. }
  298. void cmStateDirectory::SetProperty(const std::string& prop, const char* value,
  299. cmListFileBacktrace const& lfbt)
  300. {
  301. if (prop == "INCLUDE_DIRECTORIES") {
  302. if (!value) {
  303. this->ClearIncludeDirectories();
  304. return;
  305. }
  306. this->SetIncludeDirectories(value, lfbt);
  307. return;
  308. }
  309. if (prop == "COMPILE_OPTIONS") {
  310. if (!value) {
  311. this->ClearCompileOptions();
  312. return;
  313. }
  314. this->SetCompileOptions(value, lfbt);
  315. return;
  316. }
  317. if (prop == "COMPILE_DEFINITIONS") {
  318. if (!value) {
  319. this->ClearCompileDefinitions();
  320. return;
  321. }
  322. this->SetCompileDefinitions(value, lfbt);
  323. return;
  324. }
  325. this->DirectoryState->Properties.SetProperty(prop, value);
  326. }
  327. void cmStateDirectory::AppendProperty(const std::string& prop,
  328. const char* value, bool asString,
  329. cmListFileBacktrace const& lfbt)
  330. {
  331. if (prop == "INCLUDE_DIRECTORIES") {
  332. this->AppendIncludeDirectoriesEntry(value, lfbt);
  333. return;
  334. }
  335. if (prop == "COMPILE_OPTIONS") {
  336. this->AppendCompileOptionsEntry(value, lfbt);
  337. return;
  338. }
  339. if (prop == "COMPILE_DEFINITIONS") {
  340. this->AppendCompileDefinitionsEntry(value, lfbt);
  341. return;
  342. }
  343. this->DirectoryState->Properties.AppendProperty(prop, value, asString);
  344. }
  345. const char* cmStateDirectory::GetProperty(const std::string& prop) const
  346. {
  347. const bool chain =
  348. this->Snapshot_.State->IsPropertyChained(prop, cmProperty::DIRECTORY);
  349. return this->GetProperty(prop, chain);
  350. }
  351. const char* cmStateDirectory::GetProperty(const std::string& prop,
  352. bool chain) const
  353. {
  354. static std::string output;
  355. output.clear();
  356. if (prop == "PARENT_DIRECTORY") {
  357. cmStateSnapshot parent = this->Snapshot_.GetBuildsystemDirectoryParent();
  358. if (parent.IsValid()) {
  359. return parent.GetDirectory().GetCurrentSource();
  360. }
  361. return "";
  362. }
  363. if (prop == kBINARY_DIR) {
  364. output = this->GetCurrentBinary();
  365. return output.c_str();
  366. }
  367. if (prop == kSOURCE_DIR) {
  368. output = this->GetCurrentSource();
  369. return output.c_str();
  370. }
  371. if (prop == kSUBDIRECTORIES) {
  372. std::vector<std::string> child_dirs;
  373. std::vector<cmStateSnapshot> const& children =
  374. this->DirectoryState->Children;
  375. child_dirs.reserve(children.size());
  376. for (cmStateSnapshot const& ci : children) {
  377. child_dirs.push_back(ci.GetDirectory().GetCurrentSource());
  378. }
  379. output = cmJoin(child_dirs, ";");
  380. return output.c_str();
  381. }
  382. if (prop == kBUILDSYSTEM_TARGETS) {
  383. output = cmJoin(this->DirectoryState->NormalTargetNames, ";");
  384. return output.c_str();
  385. }
  386. if (prop == "LISTFILE_STACK") {
  387. std::vector<std::string> listFiles;
  388. cmStateSnapshot snp = this->Snapshot_;
  389. while (snp.IsValid()) {
  390. listFiles.push_back(snp.GetExecutionListFile());
  391. snp = snp.GetCallStackParent();
  392. }
  393. std::reverse(listFiles.begin(), listFiles.end());
  394. output = cmJoin(listFiles, ";");
  395. return output.c_str();
  396. }
  397. if (prop == "CACHE_VARIABLES") {
  398. output = cmJoin(this->Snapshot_.State->GetCacheEntryKeys(), ";");
  399. return output.c_str();
  400. }
  401. if (prop == "VARIABLES") {
  402. std::vector<std::string> res = this->Snapshot_.ClosureKeys();
  403. std::vector<std::string> cacheKeys =
  404. this->Snapshot_.State->GetCacheEntryKeys();
  405. res.insert(res.end(), cacheKeys.begin(), cacheKeys.end());
  406. std::sort(res.begin(), res.end());
  407. output = cmJoin(res, ";");
  408. return output.c_str();
  409. }
  410. if (prop == "INCLUDE_DIRECTORIES") {
  411. output = cmJoin(this->GetIncludeDirectoriesEntries(), ";");
  412. return output.c_str();
  413. }
  414. if (prop == "COMPILE_OPTIONS") {
  415. output = cmJoin(this->GetCompileOptionsEntries(), ";");
  416. return output.c_str();
  417. }
  418. if (prop == "COMPILE_DEFINITIONS") {
  419. output = cmJoin(this->GetCompileDefinitionsEntries(), ";");
  420. return output.c_str();
  421. }
  422. const char* retVal = this->DirectoryState->Properties.GetPropertyValue(prop);
  423. if (!retVal && chain) {
  424. cmStateSnapshot parentSnapshot =
  425. this->Snapshot_.GetBuildsystemDirectoryParent();
  426. if (parentSnapshot.IsValid()) {
  427. return parentSnapshot.GetDirectory().GetProperty(prop, chain);
  428. }
  429. return this->Snapshot_.State->GetGlobalProperty(prop);
  430. }
  431. return retVal;
  432. }
  433. bool cmStateDirectory::GetPropertyAsBool(const std::string& prop) const
  434. {
  435. return cmSystemTools::IsOn(this->GetProperty(prop));
  436. }
  437. std::vector<std::string> cmStateDirectory::GetPropertyKeys() const
  438. {
  439. std::vector<std::string> keys;
  440. keys.reserve(this->DirectoryState->Properties.size());
  441. for (auto const& it : this->DirectoryState->Properties) {
  442. keys.push_back(it.first);
  443. }
  444. return keys;
  445. }
  446. void cmStateDirectory::AddNormalTargetName(std::string const& name)
  447. {
  448. this->DirectoryState->NormalTargetNames.push_back(name);
  449. }