cmMakefile.h 18.6 KB
Newer Older
1 2
/*=========================================================================

3
  Program:   CMake - Cross-Platform Makefile Generator
4 5 6 7 8
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

9 10
  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
11

Will Schroeder's avatar
Will Schroeder committed
12 13 14
     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.
15 16 17 18

=========================================================================*/
#ifndef cmMakefile_h
#define cmMakefile_h
19

20
#include "cmStandardIncludes.h"
21
#include "cmData.h"
22
#include "cmSystemTools.h"
23
#include "cmSourceGroup.h"
24
#include "cmTarget.h"
25
#include "cmListFileCache.h"
26 27
#include "cmCacheManager.h"

28
class cmFunctionBlocker;
29
class cmCommand;
Ken Martin's avatar
Ken Martin committed
30
class cmLocalGenerator;
31
class cmMakeDepend;
32
class cmSourceFile;
33

34 35 36 37
/** \class cmMakefile
 * \brief Process the input CMakeLists.txt file.
 *
 * Process and store into memory the input CMakeLists.txt file.
38
 * Each CMakeLists.txt file is parsed and the commands found there
39 40
 * are added into the build process.
 */
41 42 43
class cmMakefile
{
public:
Ken Martin's avatar
Ken Martin committed
44
  /**
45
   * Return major and minor version numbers for cmake.
Ken Martin's avatar
Ken Martin committed
46
   */
Ken Martin's avatar
Ken Martin committed
47
  static unsigned int GetMajorVersion() { return 1;}
Ken Martin's avatar
Ken Martin committed
48 49
  static unsigned int GetMinorVersion() { return 7;}
  static const char *GetReleaseVersion() { return "development";}
50
  
51 52 53 54 55
  /**
   * Return the major and minor version of the cmake that
   * was used to write the currently loaded cache, note
   * this method will not work before the cache is loaded.
   */
56 57
  unsigned int GetCacheMajorVersion();
  unsigned int GetCacheMinorVersion();
Ken Martin's avatar
Ken Martin committed
58
  
59 60 61
  /**
   * Construct an empty makefile.
   */
Ken Martin's avatar
Ken Martin committed
62
  cmMakefile();
63 64 65 66

  /**
   * Destructor.
   */
Ken Martin's avatar
Ken Martin committed
67
  ~cmMakefile();
68 69 70 71

  /**
   * Read and parse a CMakeLists.txt file.
   */
Anonymous's avatar
Anonymous committed
72
  bool ReadListFile(const char* listfile, const char* external= 0); 
73

74 75 76 77
  /**
   * Add a function blocker to this makefile
   */
  void AddFunctionBlocker(cmFunctionBlocker *fb)
78
    { m_FunctionBlockers.push_back(fb);}
79
  void RemoveFunctionBlocker(cmFunctionBlocker *fb)
80
    { m_FunctionBlockers.remove(fb);}
81
  void RemoveFunctionBlocker(const cmListFileFunction& lff);
82
  
83 84 85 86 87
  /**
   * Try running cmake and building a file. This is used for dynalically
   * loaded commands, not as part of the usual build process.
   */
  int TryCompile(const char *srcdir, const char *bindir, 
88
                 const char *projectName, const char *targetName,
89 90
                 const std::vector<std::string> *cmakeArgs,
                 std::string *output);
91
    
92 93 94 95 96
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
Ken Martin's avatar
Ken Martin committed
97
  void SetLocalGenerator(cmLocalGenerator*);
98 99
  
  ///! Get the current makefile generator.
Ken Martin's avatar
Ken Martin committed
100 101
  cmLocalGenerator* GetLocalGenerator() 
    { return m_LocalGenerator;}
102 103

  /**
104 105
   * Perform FinalPass, Library dependency analysis etc before output of the
   * makefile.  
106
   */
107
  void ConfigureFinalPass();
108 109 110 111 112 113
  
  /**
   * run the final pass on all commands.
   */
  void FinalPass();
  
114 115 116
  /**
   * Print the object state to std::cout.
   */
117
  void Print() const;
118
  
119
  /**
120
   * Add a custom command to the build.
121
   */
122
  void AddCustomCommand(const char* source,
123
                        const char* command,
Ken Martin's avatar
Ken Martin committed
124
                        const std::vector<std::string>& commandArgs,
125
                        const std::vector<std::string>& depends,
126
                        const std::vector<std::string>& outputs,
127 128
                        const char *target,
                        const char *comment = 0);
129 130 131

  void AddCustomCommand(const char* source,
                        const char* command,
Ken Martin's avatar
Ken Martin committed
132
                        const std::vector<std::string>& commandArgs,
133
                        const std::vector<std::string>& depends,
134 135
                        const char* output,
                        const char* target);
136
  
137 138 139
  /**
   * Add a define flag to the build.
   */
140
  void AddDefineFlag(const char* definition);
141 142 143 144

  /**
   * Add an executable to the build.
   */
145 146 147 148
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs);
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs, bool win32);
149

150 151 152 153 154
  /**
   * Add a utility to the build.  A utiltity target is
   * a command that is run every time a target is built.
   */
  void AddUtilityCommand(const char* utilityName,
155
                         const char* command,
156
                         const char* arguments,
157 158 159
                         bool all);
  void AddUtilityCommand(const char* utilityName,
                         const char* command,
160
                         const char* arguments,
161 162 163
                         bool all,
                         const std::vector<std::string> &depends,
                         const std::vector<std::string> &outputs);
164

165 166 167
  /**
   * Add a link library to the build.
   */
168
  void AddLinkLibrary(const char*);
169 170 171
  void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  void AddLinkLibraryForTarget(const char *tgt, const char*, 
                               cmTarget::LinkLibraryType type);
172
  void AddLinkDirectoryForTarget(const char *tgt, const char* d);
173 174 175 176

  /**
   * Add a link directory to the build.
   */
177
  void AddLinkDirectory(const char*);
178 179 180 181

  /**
   * Add a subdirectory to the build.
   */
182
  void AddSubDirectory(const char*);
183 184 185 186

  /**
   * Add an include directory to the build.
   */
187
  void AddIncludeDirectory(const char*, bool before = false);
188

189 190 191 192 193 194
  /**
   * Find a library (as in cmSystemTools) but add in compiler specific paths
   */
  std::string FindLibrary(const char* name,
                          const std::vector<std::string>& path);

195 196 197 198
  /**
   * Add a variable definition to the build. This variable
   * can be used in CMake to refer to lists, directories, etc.
   */
199
  void AddDefinition(const char* name, const char* value);
200 201 202 203
  ///! Add a definition to this makefile and the global cmake cache.
  void AddCacheDefinition(const char* name, const char* value, 
                          const char* doc,
                          cmCacheManager::CacheEntryType type);
204

205 206 207 208
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);
209 210
  ///! Add a definition to this makefile and the global cmake cache.
  void AddCacheDefinition(const char* name, bool, const char* doc);
211

212 213 214 215 216 217
  /**
   * Remove a variable definition from the build.  This is not valid
   * for cache entries, and will only affect the current makefile.
   */
  void RemoveDefinition(const char* name);
  
218 219 220
  /**
   * Specify the name of the project for this build.
   */
221
  void SetProjectName(const char*);
222 223 224 225 226 227 228 229 230 231 232 233

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
Yves Starreveld's avatar
 
Yves Starreveld committed
234
  void AddLibrary(const char *libname, int shared,
235
                  const std::vector<std::string> &srcs);
236 237 238 239

  /**
   * Add a class/source file to the build.
   */
240
  //void AddSource(cmSourceFile& ,const char *srcListName);
241

242 243 244
  /**
   * Remove a class/source file from the build.
   */
245
  //void RemoveSource(cmSourceFile& ,const char *srcListName);
246

247 248 249
  /**
   * Add a source group for consideration when adding a new source.
   */
250
  void AddSourceGroup(const char* name, const char* regex=0);
251
  
252 253 254
  /**
   * Add an auxiliary directory to the build.
   */
255 256
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
257 258 259 260 261 262 263 264

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
265 266
      this->AddDefinition("CMAKE_CURRENT_SOURCE_DIR", m_cmCurrentDirectory.c_str());
      this->AddDefinition("CMAKE_CURRENT_BINARY_DIR", m_CurrentOutputDirectory.c_str());
Ken Martin's avatar
Ken Martin committed
267 268 269
    }
  
  //@{
270
  /**
Ken Martin's avatar
Ken Martin committed
271 272 273 274 275
   * Set/Get the home directory (or output directory) in the project. The
   * home directory is the top directory of the project. It is where
   * CMakeSetup or configure was run. Remember that CMake processes
   * CMakeLists files by recursing up the tree starting at the StartDirectory
   * and going up until it reaches the HomeDirectory.  
276
   */
277
  void SetHomeDirectory(const char* dir);
278
  const char* GetHomeDirectory() const
279
    {
280
    return m_cmHomeDirectory.c_str();
281
    }
282
  void SetHomeOutputDirectory(const char* lib);
283
  const char* GetHomeOutputDirectory() const
284
    {
Ken Martin's avatar
Ken Martin committed
285
    return m_HomeOutputDirectory.c_str();
286
    }
Ken Martin's avatar
Ken Martin committed
287 288 289
  //@}
  
  //@{
290
  /**
Ken Martin's avatar
Ken Martin committed
291 292 293 294 295
   * Set/Get the start directory (or output directory). The start directory
   * is the directory of the CMakeLists.txt file that started the current
   * round of processing. Remember that CMake processes CMakeLists files by
   * recursing up the tree starting at the StartDirectory and going up until
   * it reaches the HomeDirectory.  
296
   */
Ken Martin's avatar
Ken Martin committed
297
  void SetStartDirectory(const char* dir) 
298
    {
Ken Martin's avatar
Ken Martin committed
299 300
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
301
    }
302
  const char* GetStartDirectory() const
303
    {
Ken Martin's avatar
Ken Martin committed
304
      return m_cmStartDirectory.c_str();
305
    }
Ken Martin's avatar
Ken Martin committed
306 307 308 309
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
Ken Martin's avatar
Ken Martin committed
310
      cmSystemTools::MakeDirectory(m_StartOutputDirectory.c_str());
Ken Martin's avatar
Ken Martin committed
311
    }
312
  const char* GetStartOutputDirectory() const
313
    {
Ken Martin's avatar
Ken Martin committed
314
      return m_StartOutputDirectory.c_str();
315
    }
Ken Martin's avatar
Ken Martin committed
316
  //@}
317

Ken Martin's avatar
Ken Martin committed
318
  //@{
319
  /**
Ken Martin's avatar
Ken Martin committed
320 321 322 323 324
   * Set/Get the current directory (or output directory) in the project. The
   * current directory is the directory of the CMakeLists.txt file that is
   * currently being processed. Remember that CMake processes CMakeLists
   * files by recursing up the tree starting at the StartDirectory and going
   * up until it reaches the HomeDirectory.  
325
   */
Ken Martin's avatar
Ken Martin committed
326
  void SetCurrentDirectory(const char* dir) 
327
    {
Ken Martin's avatar
Ken Martin committed
328 329
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
330
      this->AddDefinition("CMAKE_CURRENT_SOURCE_DIR", m_cmCurrentDirectory.c_str());
331
    }
332
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
333 334 335 336 337 338 339
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
340
      this->AddDefinition("CMAKE_CURRENT_BINARY_DIR", m_CurrentOutputDirectory.c_str());
Ken Martin's avatar
Ken Martin committed
341
    }
342
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
343 344 345
    {
      return m_CurrentOutputDirectory.c_str();
    }
Anonymous's avatar
Anonymous committed
346 347 348 349 350 351 352 353 354

  /* Get the current CMakeLists.txt file that is being processed.  This
   * is just used in order to be able to 'branch' from one file to a second
   * transparently */
  const char* GetCurrentListFile() const
    {
      return m_cmCurrentListFile.c_str();
    }

Ken Martin's avatar
Ken Martin committed
355
  //@}
356 357 358 359 360 361 362 363 364 365

  /** 
   * Set a regular expression that include files must match
   * in order to be considered as part of the depend information.
   */
  void SetIncludeRegularExpression(const char* regex)
    {
      m_IncludeFileRegularExpression = regex;
    }

366 367 368 369 370 371 372 373 374
  /** 
   * Set a regular expression that include files that are not found
   * must match in order to be considered a problem.
   */
  void SetComplainRegularExpression(const char* regex)
    {
      m_ComplainFileRegularExpression = regex;
    }

375
  /**
376
   * Get the list of targets
377
   */
Ken Martin's avatar
Ken Martin committed
378
  cmTargets &GetTargets() { return m_Targets; }
379
  const cmTargets &GetTargets() const { return m_Targets; }
380 381 382 383

  /**
   * Get a list of the build subdirectories.
   */
384 385
  const std::vector<std::string>& GetSubDirectories()
    { 
386
    return m_SubDirectories;
387
    }
388 389 390 391

  /**
   * Get a list of include directories in the build.
   */
392
  std::vector<std::string>& GetIncludeDirectories()
393
    { 
394
    return m_IncludeDirectories;
395
    }
396
  const std::vector<std::string>& GetIncludeDirectories() const
397 398 399
    { 
    return m_IncludeDirectories;
    }
400

401 402 403 404 405 406
  /** Expand out any arguements in the vector that have ; separated
   *  strings into multiple arguements.  A new vector is created 
   *  containing the expanded versions of all arguments in argsIn.
   * This method differes from the one in cmSystemTools in that if
   * the CmakeLists file is version 1.2 or earlier it will check for
   * source lists being used without ${} around them
407
   */
408 409
  void ExpandSourceListArguments(std::vector<std::string> const& argsIn,
                                 std::vector<std::string>& argsOut,
Ken Martin's avatar
Ken Martin committed
410
                                 unsigned int startArgumentIndex);
411

412 413 414
  /** Get a cmSourceFile pointer for a given source name, if the name is
   *  not found, then a null pointer is returned.
   */
415
  cmSourceFile* GetSource(const char* sourceName) const;
416 417
  ///! Add a new cmSourceFile to the list of sources for this makefile.
  cmSourceFile* AddSource(cmSourceFile const&);
418
  
419 420 421
  /**
   * Obtain a list of auxiliary source directories.
   */
422
  std::vector<std::string>& GetAuxSourceDirectories()
423
    {return m_AuxSourceDirectories;}
424

425 426 427 428 429 430 431 432 433 434 435
  //@{
  /**
   * Return a list of extensions associated with source and header
   * files
   */
  const std::vector<std::string>& GetSourceExtensions() const
    {return m_SourceFileExtensions;}
  const std::vector<std::string>& GetHeaderExtensions() const
    {return m_HeaderFileExtensions;}
  //@}

436 437
  /**
   * Given a variable name, return its value (as a string).
438 439
   * If the variable is not found in this makefile instance, the
   * cache is then queried.
440
   */
Ken Martin's avatar
Ken Martin committed
441
  const char* GetDefinition(const char*) const;
442 443 444 445
  
  /** Test a boolean cache entry to see if it is true or false, 
   *  returns false if no entry defined.
   */
446
  bool IsOn(const char* name) const;
447

448
  /**
449
   * Get a list of preprocessor define flags.
450
   */
451 452
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
453 454 455 456 457 458 459
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
460 461 462 463 464
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
465

466 467 468 469 470
  /**
   * Get the source group
   */
  cmSourceGroup* GetSourceGroup(const char* name); 

Anonymous's avatar
Anonymous committed
471 472 473 474 475
  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
476
  
477 478 479 480
  ///! When the file changes cmake will be re-run from the build system.
  void AddCMakeDependFile(const char* file)
    { m_ListFiles.push_back(file);}
  
481 482 483 484
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
485 486
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
487
   */
488
  const char *ExpandVariablesInString(std::string& source) const;
489 490
  const char *ExpandVariablesInString(std::string& source, bool escapeQuotes,
                                      bool atOnly = false) const;
491

492 493 494 495
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
496
  void RemoveVariablesInString(std::string& source, bool atOnly = false) const;
497

498 499 500
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
501
  void ExpandVariables();  
502

503 504 505 506 507
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);
508 509 510 511
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
512
  /**
513 514
   * Execute a single CMake command.  Returns true if the command
   * succeeded or false if it failed.
Ken Martin's avatar
Ken Martin committed
515
   */
516
  bool ExecuteCommand(const cmListFileFunction& lff);
Ken Martin's avatar
Ken Martin committed
517
  
518 519
  /** Check if a command exists. */
  bool CommandExists(const char* name) const;
Ken Martin's avatar
Ken Martin committed
520
    
521 522 523 524 525
  /**
   * Add a command to this cmake instance
   */
  void AddCommand(cmCommand* );

526 527
  ///! Enable support for the named language, if null then all languages are enabled.
  void EnableLanguage(const char* );
528

529 530 531 532
  /**
   * Set/Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
   */
Ken Martin's avatar
Ken Martin committed
533
  cmCacheManager *GetCacheManager() const;
534

535 536 537
  //! Determine wether this is a local or global build.
  bool GetLocal() const;

538 539
  ///! Display progress or status message.
  void DisplayStatus(const char*, float);
540 541 542 543 544 545 546
  
  /**
   * Expand the given list file arguments into the full set after
   * variable replacement and list expansion.
   */
  void ExpandArguments(std::vector<cmListFileArgument> const& inArgs,
                       std::vector<std::string>& outArgs);
547
protected:
548 549 550
  // add link libraries and directories to the target
  void AddGlobalLinkInformation(const char* name, cmTarget& target);
  
551
  std::string m_Prefix;
552
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
553 554 555 556 557 558 559

  std::string m_cmCurrentDirectory; 
  std::string m_CurrentOutputDirectory; 
  std::string m_cmStartDirectory; 
  std::string m_StartOutputDirectory; 
  std::string m_cmHomeDirectory; 
  std::string m_HomeOutputDirectory;
Anonymous's avatar
Anonymous committed
560
  std::string m_cmCurrentListFile;
Ken Martin's avatar
Ken Martin committed
561

562
  std::string m_ProjectName;    // project name
563 564 565

  // libraries, classes, and executables
  cmTargets m_Targets;
566
  std::vector<cmSourceFile*> m_SourceFiles;
567

568
  std::vector<std::string> m_SubDirectories; // list of sub directories
569
  struct StringSet : public std::set<cmStdString>
Bill Hoffman's avatar
Bill Hoffman committed
570 571
  {
  };
572
  
573 574 575 576 577
  // The include and link-library paths.  These may have order
  // dependency, so they must be vectors (not set).
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
  
Anonymous's avatar
Anonymous committed
578
  std::vector<std::string> m_ListFiles; // list of command files loaded
579 580
  
  
581
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
582

583
  std::string m_IncludeFileRegularExpression;
584
  std::string m_ComplainFileRegularExpression;
585 586
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
587
  std::string m_DefineFlags;
588
  std::vector<cmSourceGroup> m_SourceGroups;
589
  typedef std::map<cmStdString, cmStdString> DefinitionMap;
590
  DefinitionMap m_Definitions;
591
  std::vector<cmCommand*> m_UsedCommands;
Ken Martin's avatar
Ken Martin committed
592
  cmLocalGenerator* m_LocalGenerator;
593
  bool IsFunctionBlocked(const cmListFileFunction& lff);
594
  
595
private:
Ken Martin's avatar
Ken Martin committed
596 597 598
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
599
   */
Ken Martin's avatar
Ken Martin committed
600
  std::string GetParentListFileName(const char *listFileName);
601

602
  void ReadSources(std::ifstream& fin, bool t);
603 604
  friend class cmMakeDepend;    // make depend needs direct access 
                                // to the m_Sources array 
605
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
606
  void AddDefaultDefinitions();
607
  std::list<cmFunctionBlocker *> m_FunctionBlockers;
608
  
609
  typedef std::map<cmStdString, cmData*> DataMap;
610
  DataMap m_DataMap;
Ken Martin's avatar
Ken Martin committed
611
  bool m_Inheriting;
612 613 614 615
};


#endif