cmMakefile.h 17.6 KB
Newer Older
1 2 3 4 5 6 7 8
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

Will Schroeder's avatar
Will Schroeder committed
9 10
  Copyright (c) 2002 Insight Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 "cmSourceFile.h"
23
#include "cmSystemTools.h"
24
#include "cmSourceGroup.h"
25
#include "cmTarget.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

33 34 35 36
/** \class cmMakefile
 * \brief Process the input CMakeLists.txt file.
 *
 * Process and store into memory the input CMakeLists.txt file.
37
 * Each CMakeLists.txt file is parsed and the commands found there
38 39
 * are added into the build process.
 */
40 41 42
class cmMakefile
{
public:
Ken Martin's avatar
Ken Martin committed
43
  /**
44
   * Return major and minor version numbers for cmake.
Ken Martin's avatar
Ken Martin committed
45
   */
Ken Martin's avatar
Ken Martin committed
46
  static unsigned int GetMajorVersion() { return 1;}
Ken Martin's avatar
Ken Martin committed
47
  static unsigned int GetMinorVersion() { return 5;}
Ken Martin's avatar
Ken Martin committed
48
  static const char *GetReleaseVersion() { return "development";}
49
  
50 51 52 53 54
  /**
   * 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.
   */
55 56
  unsigned int GetCacheMajorVersion();
  unsigned int GetCacheMinorVersion();
Ken Martin's avatar
Ken Martin committed
57
  
58 59 60
  /**
   * Construct an empty makefile.
   */
Ken Martin's avatar
Ken Martin committed
61
  cmMakefile();
62 63 64 65

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

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

73 74 75 76
  /**
   * Add a function blocker to this makefile
   */
  void AddFunctionBlocker(cmFunctionBlocker *fb)
77
    { m_FunctionBlockers.push_back(fb);}
78
  void RemoveFunctionBlocker(cmFunctionBlocker *fb)
79
    { m_FunctionBlockers.remove(fb);}
80 81
  void RemoveFunctionBlocker(const char *name, const std::vector<std::string> &args);
  
82 83 84 85 86
  /**
   * 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, 
87
                 const char *projectName, const char *targetName,
88 89
                 const std::vector<std::string> *cmakeArgs,
                 std::string *output);
90
    
91 92 93 94 95
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
Ken Martin's avatar
Ken Martin committed
96
  void SetLocalGenerator(cmLocalGenerator*);
97 98
  
  ///! Get the current makefile generator.
Ken Martin's avatar
Ken Martin committed
99 100
  cmLocalGenerator* GetLocalGenerator() 
    { return m_LocalGenerator;}
101 102

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

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

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

148 149 150 151 152
  /**
   * 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,
153
                         const char* command,
154
                         const char* arguments,
155 156 157
                         bool all);
  void AddUtilityCommand(const char* utilityName,
                         const char* command,
158
                         const char* arguments,
159 160 161
                         bool all,
                         const std::vector<std::string> &depends,
                         const std::vector<std::string> &outputs);
162

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

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

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

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

  /**
   * Add a variable definition to the build. This variable
   * can be used in CMake to refer to lists, directories, etc.
   */
191
  void AddDefinition(const char* name, const char* value);
192 193 194 195
  ///! 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);
196

197 198 199 200
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);
201 202
  ///! Add a definition to this makefile and the global cmake cache.
  void AddCacheDefinition(const char* name, bool, const char* doc);
203

204 205 206 207 208 209
  /**
   * 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);
  
210 211 212
  /**
   * Specify the name of the project for this build.
   */
213
  void SetProjectName(const char*);
214 215 216 217 218 219 220 221 222 223 224 225

  /**
   * 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
226
  void AddLibrary(const char *libname, int shared,
227
                  const std::vector<std::string> &srcs);
228 229 230 231

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

234 235 236
  /**
   * Remove a class/source file from the build.
   */
237
  //void RemoveSource(cmSourceFile& ,const char *srcListName);
238

239 240 241
  /**
   * Add a source group for consideration when adding a new source.
   */
242
  void AddSourceGroup(const char* name, const char* regex=0);
243
  
244 245 246
  /**
   * Add an auxiliary directory to the build.
   */
247 248
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
249 250 251 252 253 254 255 256 257 258 259

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
260
  /**
Ken Martin's avatar
Ken Martin committed
261 262 263 264 265
   * 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.  
266
   */
267
  void SetHomeDirectory(const char* dir);
268
  const char* GetHomeDirectory() const
269
    {
270
    return m_cmHomeDirectory.c_str();
271
    }
272
  void SetHomeOutputDirectory(const char* lib);
273
  const char* GetHomeOutputDirectory() const
274
    {
Ken Martin's avatar
Ken Martin committed
275
    return m_HomeOutputDirectory.c_str();
276
    }
Ken Martin's avatar
Ken Martin committed
277 278 279
  //@}
  
  //@{
280
  /**
Ken Martin's avatar
Ken Martin committed
281 282 283 284 285
   * 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.  
286
   */
Ken Martin's avatar
Ken Martin committed
287
  void SetStartDirectory(const char* dir) 
288
    {
Ken Martin's avatar
Ken Martin committed
289 290
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
291
    }
292
  const char* GetStartDirectory() const
293
    {
Ken Martin's avatar
Ken Martin committed
294
      return m_cmStartDirectory.c_str();
295
    }
Ken Martin's avatar
Ken Martin committed
296 297 298 299
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
Ken Martin's avatar
Ken Martin committed
300
      cmSystemTools::MakeDirectory(m_StartOutputDirectory.c_str());
Ken Martin's avatar
Ken Martin committed
301
    }
302
  const char* GetStartOutputDirectory() const
303
    {
Ken Martin's avatar
Ken Martin committed
304
      return m_StartOutputDirectory.c_str();
305
    }
Ken Martin's avatar
Ken Martin committed
306
  //@}
307

Ken Martin's avatar
Ken Martin committed
308
  //@{
309
  /**
Ken Martin's avatar
Ken Martin committed
310 311 312 313 314
   * 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.  
315
   */
Ken Martin's avatar
Ken Martin committed
316
  void SetCurrentDirectory(const char* dir) 
317
    {
Ken Martin's avatar
Ken Martin committed
318 319
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
320
    }
321
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
322 323 324 325 326 327 328 329
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
330
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
331 332 333
    {
      return m_CurrentOutputDirectory.c_str();
    }
Anonymous's avatar
Anonymous committed
334 335 336 337 338 339 340 341 342

  /* 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
343
  //@}
344 345 346 347 348 349 350 351 352 353

  /** 
   * 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;
    }

354 355 356 357 358 359 360 361 362
  /** 
   * 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;
    }

363
  /**
364
   * Get the list of targets
365
   */
Ken Martin's avatar
Ken Martin committed
366
  cmTargets &GetTargets() { return m_Targets; }
367
  const cmTargets &GetTargets() const { return m_Targets; }
368 369 370 371

  /**
   * Get a list of the build subdirectories.
   */
372 373
  const std::vector<std::string>& GetSubDirectories()
    { 
374
    return m_SubDirectories;
375
    }
376 377 378 379

  /**
   * Get a list of include directories in the build.
   */
380
  std::vector<std::string>& GetIncludeDirectories()
381
    { 
382
    return m_IncludeDirectories;
383
    }
384
  const std::vector<std::string>& GetIncludeDirectories() const
385 386 387
    { 
    return m_IncludeDirectories;
    }
388

389 390 391 392 393 394
  /** 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
395
   */
396 397
  void ExpandSourceListArguments(std::vector<std::string> const& argsIn,
                                 std::vector<std::string>& argsOut,
Ken Martin's avatar
Ken Martin committed
398
                                 unsigned int startArgumentIndex);
399

400 401 402
  /** Get a cmSourceFile pointer for a given source name, if the name is
   *  not found, then a null pointer is returned.
   */
403
  cmSourceFile* GetSource(const char* sourceName) const;
404 405
  ///! Add a new cmSourceFile to the list of sources for this makefile.
  cmSourceFile* AddSource(cmSourceFile const&);
406
  
407 408 409
  /**
   * Obtain a list of auxiliary source directories.
   */
410
  std::vector<std::string>& GetAuxSourceDirectories()
411
    {return m_AuxSourceDirectories;}
412

413 414 415 416 417 418 419 420 421 422 423
  //@{
  /**
   * 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;}
  //@}

424 425
  /**
   * Given a variable name, return its value (as a string).
426 427
   * If the variable is not found in this makefile instance, the
   * cache is then queried.
428
   */
Ken Martin's avatar
Ken Martin committed
429
  const char* GetDefinition(const char*) const;
430 431 432 433
  
  /** Test a boolean cache entry to see if it is true or false, 
   *  returns false if no entry defined.
   */
434
  bool IsOn(const char* name) const;
435

436
  /**
437
   * Get a list of preprocessor define flags.
438
   */
439 440
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
441 442 443 444 445 446 447
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
448 449 450 451 452
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
453

454 455 456 457 458
  /**
   * Get the source group
   */
  cmSourceGroup* GetSourceGroup(const char* name); 

Anonymous's avatar
Anonymous committed
459 460 461 462 463
  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
464
  
465 466 467 468
  ///! When the file changes cmake will be re-run from the build system.
  void AddCMakeDependFile(const char* file)
    { m_ListFiles.push_back(file);}
  
469 470 471 472
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
473 474
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
475
   */
476
  const char *ExpandVariablesInString(std::string& source) const;
477 478
  const char *ExpandVariablesInString(std::string& source, bool escapeQuotes,
                                      bool atOnly = false) const;
479

480 481 482 483
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
484
  void RemoveVariablesInString(std::string& source, bool atOnly = false) const;
485

486 487 488
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
489
  void ExpandVariables();  
490

491 492 493 494 495
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);
496 497 498 499
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
500 501 502
  /**
   * execute a single CMake command
   */
Ken Martin's avatar
Ken Martin committed
503
  void ExecuteCommand(std::string const &name, std::vector<std::string> const& args);
Ken Martin's avatar
Ken Martin committed
504
  
505 506
  /** Check if a command exists. */
  bool CommandExists(const char* name) const;
Ken Martin's avatar
Ken Martin committed
507
    
508 509 510 511 512
  /**
   * Add a command to this cmake instance
   */
  void AddCommand(cmCommand* );

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

516 517 518 519
  /**
   * Set/Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
   */
Ken Martin's avatar
Ken Martin committed
520
  cmCacheManager *GetCacheManager() const;
521

522 523 524
  //! Determine wether this is a local or global build.
  bool GetLocal() const;

525
protected:
526 527 528
  // add link libraries and directories to the target
  void AddGlobalLinkInformation(const char* name, cmTarget& target);
  
529
  std::string m_Prefix;
530
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
531 532 533 534 535 536 537

  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
538
  std::string m_cmCurrentListFile;
Ken Martin's avatar
Ken Martin committed
539

540
  std::string m_ProjectName;    // project name
541 542 543

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

546
  std::vector<std::string> m_SubDirectories; // list of sub directories
547
  struct StringSet : public std::set<cmStdString>
Bill Hoffman's avatar
Bill Hoffman committed
548 549
  {
  };
550
  
551 552 553 554 555
  // 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
556
  std::vector<std::string> m_ListFiles; // list of command files loaded
557 558
  
  
559
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
560

561
  std::string m_IncludeFileRegularExpression;
562
  std::string m_ComplainFileRegularExpression;
563 564
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
565
  std::string m_DefineFlags;
566
  std::vector<cmSourceGroup> m_SourceGroups;
567
  typedef std::map<cmStdString, cmStdString> DefinitionMap;
568
  DefinitionMap m_Definitions;
569
  std::vector<cmCommand*> m_UsedCommands;
Ken Martin's avatar
Ken Martin committed
570
  cmLocalGenerator* m_LocalGenerator;
571
  bool IsFunctionBlocked(const char *name, std::vector<std::string> const& args);
572
  
573
private:
Ken Martin's avatar
Ken Martin committed
574 575 576
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
577
   */
Ken Martin's avatar
Ken Martin committed
578
  std::string GetParentListFileName(const char *listFileName);
579

580
  void ReadSources(std::ifstream& fin, bool t);
581 582
  friend class cmMakeDepend;    // make depend needs direct access 
                                // to the m_Sources array 
583
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
584
  void AddDefaultDefinitions();
585
  std::list<cmFunctionBlocker *> m_FunctionBlockers;
586
  
587
  typedef std::map<cmStdString, cmData*> DataMap;
588
  DataMap m_DataMap;
Ken Martin's avatar
Ken Martin committed
589
  bool m_Inheriting;
590 591 592 593
};


#endif