cmMakefile.h 17.5 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) 2001 Insight Consortium
All rights reserved.
11

Will Schroeder's avatar
Will Schroeder committed
12 13
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
14

Will Schroeder's avatar
Will Schroeder committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * The name of the Insight Consortium, nor the names of any consortium members,
   nor of any contributors, may be used to endorse or promote products derived
   from this software without specific prior written permission.

  * Modified source versions must be plainly marked as such, and must not be
    misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 40 41 42

=========================================================================*/
#ifndef cmMakefile_h
#define cmMakefile_h
43

44
#include "cmStandardIncludes.h"
45
#include "cmData.h"
46
#include "cmSourceFile.h"
47
#include "cmSystemTools.h"
48
#include "cmSourceGroup.h"
49
#include "cmTarget.h"
50 51
#include "cmCacheManager.h"

52
class cmFunctionBlocker;
53
class cmCommand;
54 55
class cmMakefileGenerator;

56 57 58 59
/** \class cmMakefile
 * \brief Process the input CMakeLists.txt file.
 *
 * Process and store into memory the input CMakeLists.txt file.
60
 * Each CMakeLists.txt file is parsed and the commands found there
61 62
 * are added into the build process.
 */
63 64 65
class cmMakefile
{
public:
Ken Martin's avatar
Ken Martin committed
66
  /**
67
   * Return major and minor version numbers for cmake.
Ken Martin's avatar
Ken Martin committed
68
   */
69
  static unsigned int GetMajorVersion() { return 0;}
Ken Martin's avatar
Ken Martin committed
70
  static unsigned int GetMinorVersion() { return 7;}
71 72 73 74 75 76 77
  /**
   * 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.
   */
  static unsigned int GetCacheMajorVersion();
  static unsigned int GetCacheMinorVersion();
Ken Martin's avatar
Ken Martin committed
78
  
79 80 81
  /**
   * Construct an empty makefile.
   */
82
  cmMakefile();
83 84 85 86

  /**
   * Destructor.
   */
87
  ~cmMakefile();
88 89 90 91

  /**
   * Read and parse a CMakeLists.txt file.
   */
Anonymous's avatar
Anonymous committed
92
  bool ReadListFile(const char* listfile, const char* external= 0); 
93 94 95 96

  /**
   * Add a wrapper generator.
   */
97
  void AddCommand(cmCommand* );
98

99 100 101 102 103 104 105 106 107
  /**
   * Add a function blocker to this makefile
   */
  void AddFunctionBlocker(cmFunctionBlocker *fb)
    { m_FunctionBlockers.insert(fb);}
  void RemoveFunctionBlocker(cmFunctionBlocker *fb)
    { m_FunctionBlockers.erase(fb);}
  void RemoveFunctionBlocker(const char *name, const std::vector<std::string> &args);
  
108 109 110 111 112
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
113
  void SetMakefileGenerator(cmMakefileGenerator*);
114 115 116 117
  
  ///! Get the current makefile generator.
  cmMakefileGenerator* GetMakefileGenerator() 
    { return m_MakefileGenerator;}
118 119 120 121

  /**
   * Produce the output makefile.
   */
122
  void GenerateMakefile();
123 124 125 126 127 128
  
  /**
   * run the final pass on all commands.
   */
  void FinalPass();
  
129 130 131
  /**
   * Print the object state to std::cout.
   */
132
  void Print() const;
133
  
134
  /**
135
   * Add a custom command to the build.
136
   */
137
  void AddCustomCommand(const char* source,
138
                        const char* command,
139
                        const char* commandArgs,
140
                        const std::vector<std::string>& depends,
141 142
                        const std::vector<std::string>& outputs,
                        const char *target);
143 144 145

  void AddCustomCommand(const char* source,
                        const char* command,
146
                        const char* commandArgs,
147
                        const std::vector<std::string>& depends,
148 149
                        const char* output,
                        const char* target);
150
  
151 152 153
  /**
   * Add a define flag to the build.
   */
154
  void AddDefineFlag(const char* definition);
155 156 157 158

  /**
   * Add an executable to the build.
   */
159 160 161 162
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs);
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs, bool win32);
163

164 165 166 167 168
  /**
   * 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,
169 170 171 172 173 174 175
                         const char* command,
                         bool all);
  void AddUtilityCommand(const char* utilityName,
                         const char* command,
                         bool all,
                         const std::vector<std::string> &depends,
                         const std::vector<std::string> &outputs);
176

177 178 179
  /**
   * Get a list of link libraries in the build.
   */
180
  cmTarget::LinkLibraries& GetLinkLibraries()
181 182 183 184
    { 
    return m_LinkLibraries;
    }

185 186 187
  /**
   * Add a link library to the build.
   */
188
  void AddLinkLibrary(const char*);
189 190 191
  void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  void AddLinkLibraryForTarget(const char *tgt, const char*, 
                               cmTarget::LinkLibraryType type);
192 193 194 195

  /**
   * Add a link directory to the build.
   */
196
  void AddLinkDirectory(const char*);
197 198 199 200

  /**
   * Add a subdirectory to the build.
   */
201
  void AddSubDirectory(const char*);
202

203 204 205 206 207
  /**
   * Add a subdirectory dependency.
   */
  void AddSubdirDependency(const char* subdir, const char* dependency);

208 209 210
  /**
   * Add an include directory to the build.
   */
211
  void AddIncludeDirectory(const char*);
212 213 214 215 216

  /**
   * Add a variable definition to the build. This variable
   * can be used in CMake to refer to lists, directories, etc.
   */
217
  void AddDefinition(const char* name, const char* value);
218 219 220 221
  ///! 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);
222

223 224 225 226
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);
227 228
  ///! Add a definition to this makefile and the global cmake cache.
  void AddCacheDefinition(const char* name, bool, const char* doc);
229

230 231 232
  /**
   * Specify the name of the project for this build.
   */
233
  void SetProjectName(const char*);
234 235 236 237 238 239 240 241 242 243 244 245

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
246 247
  void AddLibrary(const char *libname, bool shared,
                  const std::vector<std::string> &srcs);
248 249 250 251

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

254 255 256 257 258
  /**
   * Remove a class/source file from the build.
   */
  void RemoveSource(cmSourceFile& ,const char *srcListName);

259 260 261 262 263
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
264 265 266
  /**
   * Add an auxiliary directory to the build.
   */
267 268
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
269 270 271 272 273 274 275 276 277 278 279

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
280
  /**
Ken Martin's avatar
Ken Martin committed
281 282 283 284 285
   * 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.  
286
   */
287
  void SetHomeDirectory(const char* dir);
288
  const char* GetHomeDirectory() const
289
    {
290
    return m_cmHomeDirectory.c_str();
291
    }
292
  void SetHomeOutputDirectory(const char* lib);
293
  const char* GetHomeOutputDirectory() const
294
    {
Ken Martin's avatar
Ken Martin committed
295
    return m_HomeOutputDirectory.c_str();
296
    }
Ken Martin's avatar
Ken Martin committed
297 298 299
  //@}
  
  //@{
300
  /**
Ken Martin's avatar
Ken Martin committed
301 302 303 304 305
   * 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.  
306
   */
Ken Martin's avatar
Ken Martin committed
307
  void SetStartDirectory(const char* dir) 
308
    {
Ken Martin's avatar
Ken Martin committed
309 310
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
311
    }
312
  const char* GetStartDirectory() const
313
    {
Ken Martin's avatar
Ken Martin committed
314
      return m_cmStartDirectory.c_str();
315
    }
Ken Martin's avatar
Ken Martin committed
316 317 318 319 320
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
    }
321
  const char* GetStartOutputDirectory() const
322
    {
Ken Martin's avatar
Ken Martin committed
323
      return m_StartOutputDirectory.c_str();
324
    }
Ken Martin's avatar
Ken Martin committed
325
  //@}
326

Ken Martin's avatar
Ken Martin committed
327
  //@{
328
  /**
Ken Martin's avatar
Ken Martin committed
329 330 331 332 333
   * 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.  
334
   */
Ken Martin's avatar
Ken Martin committed
335
  void SetCurrentDirectory(const char* dir) 
336
    {
Ken Martin's avatar
Ken Martin committed
337 338
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
339
    }
340
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
341 342 343 344 345 346 347 348
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
349
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
350 351 352
    {
      return m_CurrentOutputDirectory.c_str();
    }
Anonymous's avatar
Anonymous committed
353 354 355 356 357 358 359 360 361

  /* 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
362
  //@}
363 364 365 366 367 368 369 370 371 372

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

373 374 375 376 377 378 379 380 381
  /** 
   * 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;
    }

382
  /**
383
   * Get the list of targets
384
   */
Ken Martin's avatar
Ken Martin committed
385
  cmTargets &GetTargets() { return m_Targets; }
386
  const cmTargets &GetTargets() const { return m_Targets; }
387 388 389 390

  /**
   * Get a list of the build subdirectories.
   */
391 392
  const std::vector<std::string>& GetSubDirectories()
    { 
393
    return m_SubDirectories;
394
    }
395

396 397 398 399 400 401 402 403
  /**
   * Get the subdirectory dependencies for the given subdirectory.
   */
  const std::set<std::string>& GetSubdirDepends(const char* subdir)
    { 
    return m_SubdirDepends[subdir];
    }

404 405 406
  /**
   * Get a list of include directories in the build.
   */
407
  std::vector<std::string>& GetIncludeDirectories()
408
    { 
409
    return m_IncludeDirectories;
410
    }
411
  const std::vector<std::string>& GetIncludeDirectories() const
412 413 414
    { 
    return m_IncludeDirectories;
    }
415 416 417 418

  /**
   * Get a list of link directories in the build.
   */
419
  std::vector<std::string>& GetLinkDirectories()
420
    { 
421
    return m_LinkDirectories;
422 423
    }
  
424 425 426
  /**
   * Return a list of source files in this makefile.
   */
427 428 429 430
  typedef std::map<std::string,std::vector<cmSourceFile> > SourceMap;
  const SourceMap &GetSources() const {return  m_Sources;}
  SourceMap &GetSources() {return  m_Sources;}
  cmSourceFile *GetSource(const char *srclist, const char *sourceName);
431
  
432 433 434
  /**
   * Obtain a list of auxiliary source directories.
   */
435
  std::vector<std::string>& GetAuxSourceDirectories()
436
    {return m_AuxSourceDirectories;}
437

438 439 440 441 442 443 444 445 446 447 448
  //@{
  /**
   * 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;}
  //@}

449 450
  /**
   * Given a variable name, return its value (as a string).
451 452
   * If the variable is not found in this makefile instance, the
   * cache is then queried.
453
   */
454
  const char* GetDefinition(const char*);
455 456 457 458 459
  
  /** Test a boolean cache entry to see if it is true or false, 
   *  returns false if no entry defined.
   */
  bool IsOn(const char* name);
460

461
  /**
462
   * Get a list of preprocessor define flags.
463
   */
464 465
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
466 467 468 469 470 471 472
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
473 474 475 476 477
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
478 479 480 481 482 483

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
484
  
485 486 487 488 489 490
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

491 492 493 494
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
495 496
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
497
   */
498
  void ExpandVariablesInString(std::string& source) const;
499
  void ExpandVariablesInString(std::string& source, bool escapeQuotes) const;
500

501 502 503 504 505 506
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

507 508 509
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
510
  void ExpandVariables();  
511

Bill Hoffman's avatar
Bill Hoffman committed
512 513 514 515 516 517 518
  /** Recursivly read and create a cmMakefile object for
   *  all CMakeLists.txt files in the GetSubDirectories list.
   *  Once the file is found, it ReadListFile is called on
   *  the cmMakefile created for it.
   */
  void FindSubDirectoryCMakeListsFiles(std::vector<cmMakefile*>& makefiles);
  
519 520 521 522 523 524
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

525 526 527 528
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
529 530 531
  /**
   * execute a single CMake command
   */
Ken Martin's avatar
Ken Martin committed
532
  void ExecuteCommand(std::string &name, std::vector<std::string> &args);
Ken Martin's avatar
Ken Martin committed
533 534
  
    
535 536
protected:
  std::string m_Prefix;
537
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
538 539 540 541 542 543 544

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

547
  std::string m_ProjectName;	// project name
548 549 550

  // libraries, classes, and executables
  cmTargets m_Targets;
551
  SourceMap m_Sources; 
552

553
  std::vector<std::string> m_SubDirectories; // list of sub directories
554
  std::map<std::string, std::set<std::string> >  m_SubdirDepends;
555 556 557 558 559 560
  
  // 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
561
  std::vector<std::string> m_ListFiles; // list of command files loaded
562 563
  
  
564
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
565

566
  std::string m_IncludeFileRegularExpression;
567
  std::string m_ComplainFileRegularExpression;
568 569
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
570
  std::string m_DefineFlags;
571
  std::vector<cmSourceGroup> m_SourceGroups;
572
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
573 574
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
575 576
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
577
  cmMakefileGenerator* m_MakefileGenerator;
Ken Martin's avatar
Ken Martin committed
578
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args);
579
  
580
private:
Ken Martin's avatar
Ken Martin committed
581 582 583
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
584
   */
Ken Martin's avatar
Ken Martin committed
585
  std::string GetParentListFileName(const char *listFileName);
586

587
  void ReadSources(std::ifstream& fin, bool t);
588
  friend class cmMakeDepend;	// make depend needs direct access 
589
				// to the m_Sources array 
590
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
591
  void AddDefaultCommands();
592
  void AddDefaultDefinitions();
593
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
594 595 596
  
  typedef std::map<std::string, cmData*> DataMap;
  DataMap m_DataMap;
Ken Martin's avatar
Ken Martin committed
597
  bool m_Inheriting;
598 599 600 601
};


#endif