cmMakefile.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. /*=========================================================================
  2. Program: CMake - Cross-Platform Makefile Generator
  3. Module: $RCSfile$
  4. Language: C++
  5. Date: $Date$
  6. Version: $Revision$
  7. Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
  8. See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  9. This software is distributed WITHOUT ANY WARRANTY; without even
  10. the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11. PURPOSE. See the above copyright notices for more information.
  12. =========================================================================*/
  13. #ifndef cmMakefile_h
  14. #define cmMakefile_h
  15. #include "cmCacheManager.h"
  16. #include "cmData.h"
  17. #include "cmExecutionStatus.h"
  18. #include "cmListFileCache.h"
  19. #include "cmPropertyMap.h"
  20. #include "cmSystemTools.h"
  21. #include "cmTarget.h"
  22. #if defined(CMAKE_BUILD_WITH_CMAKE)
  23. #include "cmSourceGroup.h"
  24. #endif
  25. #include <cmsys/RegularExpression.hxx>
  26. class cmFunctionBlocker;
  27. class cmCommand;
  28. class cmInstallGenerator;
  29. class cmLocalGenerator;
  30. class cmMakeDepend;
  31. class cmSourceFile;
  32. class cmTest;
  33. class cmVariableWatch;
  34. class cmake;
  35. /** \class cmMakefile
  36. * \brief Process the input CMakeLists.txt file.
  37. *
  38. * Process and store into memory the input CMakeLists.txt file.
  39. * Each CMakeLists.txt file is parsed and the commands found there
  40. * are added into the build process.
  41. */
  42. class cmMakefile
  43. {
  44. public:
  45. /**
  46. * Return the major and minor version of the cmake that
  47. * was used to write the currently loaded cache, note
  48. * this method will not work before the cache is loaded.
  49. */
  50. unsigned int GetCacheMajorVersion();
  51. unsigned int GetCacheMinorVersion();
  52. /** Return whether compatibility features needed for a version of
  53. the cache or lower should be enabled. */
  54. bool NeedCacheCompatibility(int major, int minor);
  55. /**
  56. * Construct an empty makefile.
  57. */
  58. cmMakefile();
  59. cmMakefile(const cmMakefile& mf);
  60. /**
  61. * Destructor.
  62. */
  63. ~cmMakefile();
  64. /**
  65. * Read and parse a CMakeLists.txt file.
  66. */
  67. bool ReadListFile(const char* listfile,
  68. const char* external= 0,
  69. std::string* fullPath= 0);
  70. /**
  71. * Add a function blocker to this makefile
  72. */
  73. void AddFunctionBlocker(cmFunctionBlocker *fb)
  74. { this->FunctionBlockers.push_back(fb);}
  75. void RemoveFunctionBlocker(cmFunctionBlocker *fb)
  76. { this->FunctionBlockers.remove(fb);}
  77. void RemoveFunctionBlocker(const cmListFileFunction& lff);
  78. /**
  79. * Add file to the written file list. These file should not be in the list
  80. * of dependencies because they cause infinite loops.
  81. */
  82. void AddWrittenFile(const char* file);
  83. bool HasWrittenFile(const char* file);
  84. /**
  85. * Check if there are any infinite loops
  86. */
  87. bool CheckInfiniteLoops();
  88. /**
  89. * Try running cmake and building a file. This is used for dynalically
  90. * loaded commands, not as part of the usual build process.
  91. */
  92. int TryCompile(const char *srcdir, const char *bindir,
  93. const char *projectName, const char *targetName,
  94. const std::vector<std::string> *cmakeArgs,
  95. std::string *output);
  96. /**
  97. * Specify the makefile generator. This is platform/compiler
  98. * dependent, although the interface is through a generic
  99. * superclass.
  100. */
  101. void SetLocalGenerator(cmLocalGenerator*);
  102. ///! Get the current makefile generator.
  103. cmLocalGenerator* GetLocalGenerator()
  104. { return this->LocalGenerator;}
  105. /**
  106. * Perform FinalPass, Library dependency analysis etc before output of the
  107. * makefile.
  108. */
  109. void ConfigureFinalPass();
  110. /**
  111. * run the final pass on all commands.
  112. */
  113. void FinalPass();
  114. /**
  115. * Print the object state to std::cout.
  116. */
  117. void Print();
  118. /** Add a custom command to the build. */
  119. void AddCustomCommandToTarget(const char* target,
  120. const std::vector<std::string>& depends,
  121. const cmCustomCommandLines& commandLines,
  122. cmTarget::CustomCommandType type,
  123. const char* comment, const char* workingDir,
  124. bool escapeOldStyle = true);
  125. void AddCustomCommandToOutput(const std::vector<std::string>& outputs,
  126. const std::vector<std::string>& depends,
  127. const char* main_dependency,
  128. const cmCustomCommandLines& commandLines,
  129. const char* comment, const char* workingDir,
  130. bool replace = false,
  131. bool escapeOldStyle = true);
  132. void AddCustomCommandToOutput(const char* output,
  133. const std::vector<std::string>& depends,
  134. const char* main_dependency,
  135. const cmCustomCommandLines& commandLines,
  136. const char* comment, const char* workingDir,
  137. bool replace = false,
  138. bool escapeOldStyle = true);
  139. void AddCustomCommandOldStyle(const char* target,
  140. const std::vector<std::string>& outputs,
  141. const std::vector<std::string>& depends,
  142. const char* source,
  143. const cmCustomCommandLines& commandLines,
  144. const char* comment);
  145. /**
  146. * Add a define flag to the build.
  147. */
  148. void AddDefineFlag(const char* definition);
  149. void RemoveDefineFlag(const char* definition);
  150. /** Create a new imported target with the name and type given. */
  151. cmTarget* AddImportedTarget(const char* name, cmTarget::TargetType type);
  152. cmTarget* AddNewTarget(cmTarget::TargetType type, const char* name);
  153. /**
  154. * Add an executable to the build.
  155. */
  156. cmTarget* AddExecutable(const char *exename,
  157. const std::vector<std::string> &srcs,
  158. bool excludeFromAll = false);
  159. /**
  160. * Add a utility to the build. A utiltity target is a command that
  161. * is run every time the target is built.
  162. */
  163. void AddUtilityCommand(const char* utilityName, bool excludeFromAll,
  164. const std::vector<std::string>& depends,
  165. const char* workingDirectory,
  166. const char* command,
  167. const char* arg1=0,
  168. const char* arg2=0,
  169. const char* arg3=0,
  170. const char* arg4=0);
  171. void AddUtilityCommand(const char* utilityName, bool excludeFromAll,
  172. const char* workingDirectory,
  173. const std::vector<std::string>& depends,
  174. const cmCustomCommandLines& commandLines,
  175. bool escapeOldStyle = true,
  176. const char* comment = 0);
  177. /**
  178. * Add a link library to the build.
  179. */
  180. void AddLinkLibrary(const char*);
  181. void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  182. void AddLinkLibraryForTarget(const char *tgt, const char*,
  183. cmTarget::LinkLibraryType type);
  184. void AddLinkDirectoryForTarget(const char *tgt, const char* d);
  185. /**
  186. * Add a link directory to the build.
  187. */
  188. void AddLinkDirectory(const char*);
  189. /**
  190. * Get the list of link directories
  191. */
  192. std::vector<std::string>& GetLinkDirectories()
  193. {
  194. return this->LinkDirectories;
  195. }
  196. const std::vector<std::string>& GetLinkDirectories() const
  197. {
  198. return this->LinkDirectories;
  199. }
  200. void SetLinkDirectories(const std::vector<std::string>& vec)
  201. {
  202. this->LinkDirectories = vec;
  203. }
  204. /**
  205. * Add a subdirectory to the build.
  206. */
  207. void AddSubDirectory(const char*, bool excludeFromAll=false,
  208. bool preorder = false);
  209. void AddSubDirectory(const char* fullSrcDir,const char *fullBinDir,
  210. bool excludeFromAll, bool preorder,
  211. bool immediate);
  212. /**
  213. * Configure a subdirectory
  214. */
  215. void ConfigureSubDirectory(cmLocalGenerator *);
  216. /**
  217. * Add an include directory to the build.
  218. */
  219. void AddIncludeDirectory(const char*, bool before = false);
  220. /**
  221. * Add a variable definition to the build. This variable
  222. * can be used in CMake to refer to lists, directories, etc.
  223. */
  224. void AddDefinition(const char* name, const char* value);
  225. ///! Add a definition to this makefile and the global cmake cache.
  226. void AddCacheDefinition(const char* name, const char* value,
  227. const char* doc,
  228. cmCacheManager::CacheEntryType type);
  229. /**
  230. * Add bool variable definition to the build.
  231. */
  232. void AddDefinition(const char* name, bool);
  233. ///! Add a definition to this makefile and the global cmake cache.
  234. void AddCacheDefinition(const char* name, bool, const char* doc);
  235. /**
  236. * Remove a variable definition from the build. This is not valid
  237. * for cache entries, and will only affect the current makefile.
  238. */
  239. void RemoveDefinition(const char* name);
  240. /**
  241. * Specify the name of the project for this build.
  242. */
  243. void SetProjectName(const char*);
  244. /**
  245. * Get the name of the project for this build.
  246. */
  247. const char* GetProjectName() const
  248. {
  249. return this->ProjectName.c_str();
  250. }
  251. /**
  252. * Set the name of the library.
  253. */
  254. void AddLibrary(const char *libname, cmTarget::TargetType type,
  255. const std::vector<std::string> &srcs,
  256. bool excludeFromAll = false);
  257. #if defined(CMAKE_BUILD_WITH_CMAKE)
  258. /**
  259. * Add a root source group for consideration when adding a new source.
  260. */
  261. void AddSourceGroup(const char* name, const char* regex=0);
  262. /**
  263. * Add a source group for consideration when adding a new source.
  264. * name is tokenized.
  265. */
  266. void AddSourceGroup(const std::vector<std::string>& name,
  267. const char* regex=0);
  268. #endif
  269. /**
  270. * Add an auxiliary directory to the build.
  271. */
  272. void AddExtraDirectory(const char* dir);
  273. /**
  274. * Add an auxiliary directory to the build.
  275. */
  276. void MakeStartDirectoriesCurrent()
  277. {
  278. this->AddDefinition("CMAKE_CURRENT_SOURCE_DIR",
  279. this->cmStartDirectory.c_str());
  280. this->AddDefinition("CMAKE_CURRENT_BINARY_DIR",
  281. this->StartOutputDirectory.c_str());
  282. }
  283. //@{
  284. /**
  285. * Set/Get the home directory (or output directory) in the project. The
  286. * home directory is the top directory of the project. It is where
  287. * CMakeSetup or configure was run. Remember that CMake processes
  288. * CMakeLists files by recursing up the tree starting at the StartDirectory
  289. * and going up until it reaches the HomeDirectory.
  290. */
  291. void SetHomeDirectory(const char* dir);
  292. const char* GetHomeDirectory() const
  293. {
  294. return this->cmHomeDirectory.c_str();
  295. }
  296. void SetHomeOutputDirectory(const char* lib);
  297. const char* GetHomeOutputDirectory() const
  298. {
  299. return this->HomeOutputDirectory.c_str();
  300. }
  301. //@}
  302. //@{
  303. /**
  304. * Set/Get the start directory (or output directory). The start directory
  305. * is the directory of the CMakeLists.txt file that started the current
  306. * round of processing. Remember that CMake processes CMakeLists files by
  307. * recursing up the tree starting at the StartDirectory and going up until
  308. * it reaches the HomeDirectory.
  309. */
  310. void SetStartDirectory(const char* dir)
  311. {
  312. this->cmStartDirectory = dir;
  313. cmSystemTools::ConvertToUnixSlashes(this->cmStartDirectory);
  314. this->cmStartDirectory =
  315. cmSystemTools::CollapseFullPath(this->cmStartDirectory.c_str());
  316. this->AddDefinition("CMAKE_CURRENT_SOURCE_DIR",
  317. this->cmStartDirectory.c_str());
  318. }
  319. const char* GetStartDirectory() const
  320. {
  321. return this->cmStartDirectory.c_str();
  322. }
  323. void SetStartOutputDirectory(const char* lib)
  324. {
  325. this->StartOutputDirectory = lib;
  326. cmSystemTools::ConvertToUnixSlashes(this->StartOutputDirectory);
  327. this->StartOutputDirectory =
  328. cmSystemTools::CollapseFullPath(this->StartOutputDirectory.c_str());
  329. cmSystemTools::MakeDirectory(this->StartOutputDirectory.c_str());
  330. this->AddDefinition("CMAKE_CURRENT_BINARY_DIR",
  331. this->StartOutputDirectory.c_str());
  332. }
  333. const char* GetStartOutputDirectory() const
  334. {
  335. return this->StartOutputDirectory.c_str();
  336. }
  337. //@}
  338. const char* GetCurrentDirectory() const
  339. {
  340. return this->cmStartDirectory.c_str();
  341. }
  342. const char* GetCurrentOutputDirectory() const
  343. {
  344. return this->StartOutputDirectory.c_str();
  345. }
  346. /* Get the current CMakeLists.txt file that is being processed. This
  347. * is just used in order to be able to 'branch' from one file to a second
  348. * transparently */
  349. const char* GetCurrentListFile() const
  350. {
  351. return this->cmCurrentListFile.c_str();
  352. }
  353. //@}
  354. /**
  355. * Set a regular expression that include files must match
  356. * in order to be considered as part of the depend information.
  357. */
  358. void SetIncludeRegularExpression(const char* regex)
  359. {
  360. this->IncludeFileRegularExpression = regex;
  361. }
  362. const char* GetIncludeRegularExpression()
  363. {
  364. return this->IncludeFileRegularExpression.c_str();
  365. }
  366. /**
  367. * Set a regular expression that include files that are not found
  368. * must match in order to be considered a problem.
  369. */
  370. void SetComplainRegularExpression(const char* regex)
  371. {
  372. this->ComplainFileRegularExpression = regex;
  373. }
  374. const char* GetComplainRegularExpression()
  375. {
  376. return this->ComplainFileRegularExpression.c_str();
  377. }
  378. /**
  379. * Get the list of targets
  380. */
  381. cmTargets &GetTargets() { return this->Targets; }
  382. /**
  383. * Get the list of targets, const version
  384. */
  385. const cmTargets &GetTargets() const { return this->Targets; }
  386. cmTarget* FindTarget(const char* name);
  387. /** Find a target to use in place of the given name. The target
  388. returned may be imported or built within the project. */
  389. cmTarget* FindTargetToUse(const char* name);
  390. /**
  391. * Get a list of include directories in the build.
  392. */
  393. std::vector<std::string>& GetIncludeDirectories()
  394. {
  395. return this->IncludeDirectories;
  396. }
  397. const std::vector<std::string>& GetIncludeDirectories() const
  398. {
  399. return this->IncludeDirectories;
  400. }
  401. void SetIncludeDirectories(const std::vector<std::string>& vec)
  402. {
  403. this->IncludeDirectories = vec;
  404. }
  405. /**
  406. * Mark include directories as system directories.
  407. */
  408. void AddSystemIncludeDirectory(const char* dir);
  409. bool IsSystemIncludeDirectory(const char* dir);
  410. /** Expand out any arguements in the vector that have ; separated
  411. * strings into multiple arguements. A new vector is created
  412. * containing the expanded versions of all arguments in argsIn.
  413. * This method differes from the one in cmSystemTools in that if
  414. * the CmakeLists file is version 1.2 or earlier it will check for
  415. * source lists being used without ${} around them
  416. */
  417. void ExpandSourceListArguments(std::vector<std::string> const& argsIn,
  418. std::vector<std::string>& argsOut,
  419. unsigned int startArgumentIndex);
  420. /** Get a cmSourceFile pointer for a given source name, if the name is
  421. * not found, then a null pointer is returned.
  422. */
  423. cmSourceFile* GetSource(const char* sourceName);
  424. /** Get a cmSourceFile pointer for a given source name, if the name is
  425. * not found, then create the source file and return it. generated
  426. * indicates if it is a generated file, this is used in determining
  427. * how to create the source file instance e.g. name
  428. */
  429. cmSourceFile* GetOrCreateSource(const char* sourceName,
  430. bool generated = false);
  431. /**
  432. * Obtain a list of auxiliary source directories.
  433. */
  434. std::vector<std::string>& GetAuxSourceDirectories()
  435. {return this->AuxSourceDirectories;}
  436. //@{
  437. /**
  438. * Return a list of extensions associated with source and header
  439. * files
  440. */
  441. const std::vector<std::string>& GetSourceExtensions() const
  442. {return this->SourceFileExtensions;}
  443. const std::vector<std::string>& GetHeaderExtensions() const
  444. {return this->HeaderFileExtensions;}
  445. //@}
  446. /**
  447. * Given a variable name, return its value (as a string).
  448. * If the variable is not found in this makefile instance, the
  449. * cache is then queried.
  450. */
  451. const char* GetDefinition(const char*) const;
  452. const char* GetSafeDefinition(const char*) const;
  453. const char* GetRequiredDefinition(const char* name) const;
  454. bool IsDefinitionSet(const char*) const;
  455. /**
  456. * Get the list of all variables in the current space. If argument
  457. * cacheonly is specified and is greater than 0, then only cache
  458. * variables will be listed.
  459. */
  460. std::vector<std::string> GetDefinitions(int cacheonly=0) const;
  461. /** Test a boolean cache entry to see if it is true or false,
  462. * returns false if no entry defined.
  463. */
  464. bool IsOn(const char* name) const;
  465. bool IsSet(const char* name) const;
  466. /**
  467. * Get a list of preprocessor define flags.
  468. */
  469. const char* GetDefineFlags()
  470. {return this->DefineFlags.c_str();}
  471. /**
  472. * Make sure CMake can write this file
  473. */
  474. bool CanIWriteThisFile(const char* fileName);
  475. /**
  476. * Get the vector of used command instances.
  477. */
  478. const std::vector<cmCommand*>& GetUsedCommands() const
  479. {return this->UsedCommands;}
  480. #if defined(CMAKE_BUILD_WITH_CMAKE)
  481. /**
  482. * Get the vector source groups.
  483. */
  484. const std::vector<cmSourceGroup>& GetSourceGroups() const
  485. { return this->SourceGroups; }
  486. /**
  487. * Get the source group
  488. */
  489. cmSourceGroup* GetSourceGroup(const std::vector<std::string>&name);
  490. #endif
  491. /**
  492. * Get the vector of list files on which this makefile depends
  493. */
  494. const std::vector<std::string>& GetListFiles() const
  495. { return this->ListFiles; }
  496. ///! When the file changes cmake will be re-run from the build system.
  497. void AddCMakeDependFile(const char* file)
  498. { this->ListFiles.push_back(file);}
  499. /**
  500. * Get the list file stack as a string
  501. */
  502. std::string GetListFileStack();
  503. /**
  504. * Get the vector of files created by this makefile
  505. */
  506. const std::vector<std::string>& GetOutputFiles() const
  507. { return this->OutputFiles; }
  508. void AddCMakeOutputFile(const char* file)
  509. { this->OutputFiles.push_back(file);}
  510. /**
  511. * Expand all defined variables in the string.
  512. * Defined variables come from the this->Definitions map.
  513. * They are expanded with ${var} where var is the
  514. * entry in the this->Definitions map. Also @var@ is
  515. * expanded to match autoconf style expansions.
  516. */
  517. const char *ExpandVariablesInString(std::string& source);
  518. const char *ExpandVariablesInString(std::string& source, bool escapeQuotes,
  519. bool noEscapes,
  520. bool atOnly = false,
  521. const char* filename = 0,
  522. long line = -1,
  523. bool removeEmpty = false,
  524. bool replaceAt = true);
  525. /**
  526. * Remove any remaining variables in the string. Anything with ${var} or
  527. * @var@ will be removed.
  528. */
  529. void RemoveVariablesInString(std::string& source,
  530. bool atOnly = false) const;
  531. /**
  532. * Expand variables in the makefiles ivars such as link directories etc
  533. */
  534. void ExpandVariables();
  535. /**
  536. * Replace variables and #cmakedefine lines in the given string.
  537. * See cmConfigureFileCommand for details.
  538. */
  539. void ConfigureString(const std::string& input, std::string& output,
  540. bool atOnly, bool escapeQuotes);
  541. /**
  542. * Copy file but change lines acording to ConfigureString
  543. */
  544. int ConfigureFile(const char* infile, const char* outfile,
  545. bool copyonly, bool atOnly, bool escapeQuotes);
  546. #if defined(CMAKE_BUILD_WITH_CMAKE)
  547. /**
  548. * find what source group this source is in
  549. */
  550. cmSourceGroup& FindSourceGroup(const char* source,
  551. std::vector<cmSourceGroup> &groups);
  552. #endif
  553. void RegisterData(cmData*);
  554. void RegisterData(const char*, cmData*);
  555. cmData* LookupData(const char*) const;
  556. /**
  557. * Execute a single CMake command. Returns true if the command
  558. * succeeded or false if it failed.
  559. */
  560. bool ExecuteCommand(const cmListFileFunction& lff,
  561. cmExecutionStatus &status);
  562. /** Check if a command exists. */
  563. bool CommandExists(const char* name) const;
  564. /**
  565. * Add a command to this cmake instance
  566. */
  567. void AddCommand(cmCommand* );
  568. ///! Enable support for named language, if nil then all languages are
  569. ///enabled.
  570. void EnableLanguage(std::vector<std::string>const& languages, bool optional);
  571. /**
  572. * Set/Get the name of the parent directories CMakeLists file
  573. * given a current CMakeLists file name
  574. */
  575. cmCacheManager *GetCacheManager() const;
  576. /**
  577. * Get the variable watch. This is used to determine when certain variables
  578. * are accessed.
  579. */
  580. #ifdef CMAKE_BUILD_WITH_CMAKE
  581. cmVariableWatch* GetVariableWatch() const;
  582. #endif
  583. ///! Display progress or status message.
  584. void DisplayStatus(const char*, float);
  585. /**
  586. * Expand the given list file arguments into the full set after
  587. * variable replacement and list expansion.
  588. */
  589. void ExpandArguments(std::vector<cmListFileArgument> const& inArgs,
  590. std::vector<std::string>& outArgs);
  591. /**
  592. * Get the instance
  593. */
  594. cmake *GetCMakeInstance() const;
  595. /**
  596. * Get all the source files this makefile knows about
  597. */
  598. const std::vector<cmSourceFile*> &GetSourceFiles() const
  599. {return this->SourceFiles;}
  600. std::vector<cmSourceFile*> &GetSourceFiles() {return this->SourceFiles;}
  601. /**
  602. * Is there a source file that has the provided source file as an output?
  603. * if so then return it
  604. */
  605. cmSourceFile *GetSourceFileWithOutput(const char *outName);
  606. /**
  607. * Add a macro to the list of macros. The arguments should be name of the
  608. * macro and a documentation signature of it
  609. */
  610. void AddMacro(const char* name, const char* signature);
  611. ///! Add a new cmTest to the list of tests for this makefile.
  612. cmTest* CreateTest(const char* testName);
  613. /** Get a cmTest pointer for a given test name, if the name is
  614. * not found, then a null pointer is returned.
  615. */
  616. cmTest* GetTest(const char* testName) const;
  617. const std::vector<cmTest*> *GetTests() const;
  618. std::vector<cmTest*> *GetTests();
  619. /**
  620. * Get a list of macros as a ; separated string
  621. */
  622. void GetListOfMacros(std::string& macros);
  623. /**
  624. * Return a location of a file in cmake or custom modules directory
  625. */
  626. std::string GetModulesFile(const char* name);
  627. ///! Set/Get a property of this directory
  628. void SetProperty(const char *prop, const char *value);
  629. void AppendProperty(const char *prop, const char *value);
  630. const char *GetProperty(const char *prop);
  631. const char *GetPropertyOrDefinition(const char *prop);
  632. const char *GetProperty(const char *prop, cmProperty::ScopeType scope);
  633. bool GetPropertyAsBool(const char *prop);
  634. // Get the properties
  635. cmPropertyMap &GetProperties() { return this->Properties; };
  636. typedef std::map<cmStdString, cmStdString> DefinitionMap;
  637. ///! Initialize a makefile from its parent
  638. void InitializeFromParent();
  639. ///! Set/Get the preorder flag
  640. void SetPreOrder(bool p) { this->PreOrder = p; }
  641. bool GetPreOrder() const { return this->PreOrder; }
  642. void AddInstallGenerator(cmInstallGenerator* g)
  643. { if(g) this->InstallGenerators.push_back(g); }
  644. std::vector<cmInstallGenerator*>& GetInstallGenerators()
  645. { return this->InstallGenerators; }
  646. // Define the properties
  647. static void DefineProperties(cmake *cm);
  648. // push and pop variable scopes
  649. void PushScope();
  650. void PopScope();
  651. void RaiseScope(const char *var, const char *value);
  652. protected:
  653. // add link libraries and directories to the target
  654. void AddGlobalLinkInformation(const char* name, cmTarget& target);
  655. std::string Prefix;
  656. std::vector<std::string> AuxSourceDirectories; //
  657. std::string cmStartDirectory;
  658. std::string StartOutputDirectory;
  659. std::string cmHomeDirectory;
  660. std::string HomeOutputDirectory;
  661. std::string cmCurrentListFile;
  662. std::string ProjectName; // project name
  663. // libraries, classes, and executables
  664. cmTargets Targets;
  665. std::vector<cmSourceFile*> SourceFiles;
  666. // Tests
  667. std::vector<cmTest*> Tests;
  668. // The include and link-library paths. These may have order
  669. // dependency, so they must be vectors (not set).
  670. std::vector<std::string> IncludeDirectories;
  671. std::vector<std::string> LinkDirectories;
  672. // The set of include directories that are marked as system include
  673. // directories.
  674. std::set<cmStdString> SystemIncludeDirectories;
  675. std::vector<std::string> ListFiles; // list of command files loaded
  676. std::vector<std::string> OutputFiles; // list of command files loaded
  677. cmTarget::LinkLibraryVectorType LinkLibraries;
  678. std::vector<cmInstallGenerator*> InstallGenerators;
  679. std::string IncludeFileRegularExpression;
  680. std::string ComplainFileRegularExpression;
  681. std::vector<std::string> SourceFileExtensions;
  682. std::vector<std::string> HeaderFileExtensions;
  683. std::string DefineFlags;
  684. #if defined(CMAKE_BUILD_WITH_CMAKE)
  685. std::vector<cmSourceGroup> SourceGroups;
  686. #endif
  687. std::vector<DefinitionMap> DefinitionStack;
  688. std::vector<cmCommand*> UsedCommands;
  689. cmLocalGenerator* LocalGenerator;
  690. bool IsFunctionBlocked(const cmListFileFunction& lff,
  691. cmExecutionStatus &status);
  692. private:
  693. void Initialize();
  694. bool ParseDefineFlag(std::string const& definition, bool remove);
  695. void ReadSources(std::ifstream& fin, bool t);
  696. friend class cmMakeDepend; // make depend needs direct access
  697. // to the Sources array
  698. void PrintStringVector(const char* s, const
  699. std::vector<std::pair<cmStdString, bool> >& v) const;
  700. void PrintStringVector(const char* s,
  701. const std::vector<std::string>& v) const;
  702. void AddDefaultDefinitions();
  703. std::list<cmFunctionBlocker *> FunctionBlockers;
  704. typedef std::map<cmStdString, cmData*> DataMapType;
  705. DataMapType DataMap;
  706. typedef std::map<cmStdString, cmStdString> StringStringMap;
  707. StringStringMap MacrosMap;
  708. std::map<cmStdString, bool> SubDirectoryOrder;
  709. // used in AddDefinition for performance improvement
  710. DefinitionMap::key_type TemporaryDefinitionKey;
  711. cmsys::RegularExpression cmDefineRegex;
  712. cmsys::RegularExpression cmDefine01Regex;
  713. cmsys::RegularExpression cmAtVarRegex;
  714. cmPropertyMap Properties;
  715. // should this makefile be processed before or after processing the parent
  716. bool PreOrder;
  717. // stack of list files being read
  718. std::deque<cmStdString> ListFileStack;
  719. cmTarget* FindBasicTarget(const char* name);
  720. std::vector<cmTarget*> ImportedTargetsOwned;
  721. std::map<cmStdString, cmTarget*> ImportedTargets;
  722. };
  723. #endif