cmMakefile.h 18 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
   */
Ken Martin's avatar
Ken Martin committed
69
  static unsigned int GetMajorVersion() { return 1;}
Ken Martin's avatar
Ken Martin committed
70 71
  static unsigned int GetMinorVersion() { return 3;}
  static const char *GetReleaseVersion() { return "development";}
72
  
73 74 75 76 77 78 79
  /**
   * 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
80
  
81 82 83
  /**
   * Construct an empty makefile.
   */
84
  cmMakefile();
85 86 87 88

  /**
   * Destructor.
   */
89
  ~cmMakefile();
90 91 92 93

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

  /**
   * Add a wrapper generator.
   */
99
  void AddCommand(cmCommand* );
100

101 102 103 104 105 106 107 108 109
  /**
   * 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);
  
110 111 112 113 114
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
115
  void SetMakefileGenerator(cmMakefileGenerator*);
116 117 118 119
  
  ///! Get the current makefile generator.
  cmMakefileGenerator* GetMakefileGenerator() 
    { return m_MakefileGenerator;}
120 121 122 123

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

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

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

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

181 182 183
  /**
   * Get a list of link libraries in the build.
   */
184
  cmTarget::LinkLibraries& GetLinkLibraries()
185 186 187 188
    { 
    return m_LinkLibraries;
    }

189 190 191 192 193 194 195 196
  /**
   * Get a list of link libraries in the build.
   */
  const cmTarget::LinkLibraries& GetLinkLibraries() const
    { 
    return m_LinkLibraries;
    }

197 198 199
  /**
   * Add a link library to the build.
   */
200
  void AddLinkLibrary(const char*);
201 202 203
  void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  void AddLinkLibraryForTarget(const char *tgt, const char*, 
                               cmTarget::LinkLibraryType type);
204 205 206 207

  /**
   * Add a link directory to the build.
   */
208
  void AddLinkDirectory(const char*);
209 210 211 212

  /**
   * Add a subdirectory to the build.
   */
213
  void AddSubDirectory(const char*);
214 215 216 217

  /**
   * Add an include directory to the build.
   */
218
  void AddIncludeDirectory(const char*, bool before = false);
219 220 221 222 223

  /**
   * Add a variable definition to the build. This variable
   * can be used in CMake to refer to lists, directories, etc.
   */
224
  void AddDefinition(const char* name, const char* value);
225 226 227 228
  ///! 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);
229

230 231 232 233
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);
234 235
  ///! Add a definition to this makefile and the global cmake cache.
  void AddCacheDefinition(const char* name, bool, const char* doc);
236

237 238 239
  /**
   * Specify the name of the project for this build.
   */
240
  void SetProjectName(const char*);
241 242 243 244 245 246 247 248 249 250 251 252

  /**
   * 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
253
  void AddLibrary(const char *libname, int shared,
254
                  const std::vector<std::string> &srcs);
255 256 257 258

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

261 262 263 264 265
  /**
   * Remove a class/source file from the build.
   */
  void RemoveSource(cmSourceFile& ,const char *srcListName);

266 267 268 269 270
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
271 272 273
  /**
   * Add an auxiliary directory to the build.
   */
274 275
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
276 277 278 279 280 281 282 283 284 285 286

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

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

  /* 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
370
  //@}
371 372 373 374 375 376 377 378 379 380

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

381 382 383 384 385 386 387 388 389
  /** 
   * 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;
    }

390
  /**
391
   * Get the list of targets
392
   */
Ken Martin's avatar
Ken Martin committed
393
  cmTargets &GetTargets() { return m_Targets; }
394
  const cmTargets &GetTargets() const { return m_Targets; }
395 396 397 398

  /**
   * Get a list of the build subdirectories.
   */
399 400
  const std::vector<std::string>& GetSubDirectories()
    { 
401
    return m_SubDirectories;
402
    }
403 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
  typedef std::map<cmStdString,std::vector<cmSourceFile> > SourceMap;
428 429 430
  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*) const;
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
  ///! When the file changes cmake will be re-run from the build system.
  void AddCMakeDependFile(const char* file)
    { m_ListFiles.push_back(file);}
  
489 490 491 492
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
493
  int DumpDocumentationToFile(std::ostream&);
494

495 496 497 498
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
499 500
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
501
   */
502
  const char *ExpandVariablesInString(std::string& source) const;
503 504
  const char *ExpandVariablesInString(std::string& source, bool escapeQuotes,
                                      bool atOnly = false) const;
505

506 507 508 509
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
510
  void RemoveVariablesInString(std::string& source, bool atOnly = false) const;
511

512 513 514
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
515
  void ExpandVariables();  
516

Bill Hoffman's avatar
Bill Hoffman committed
517 518 519 520 521 522 523
  /** 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);
  
524 525 526 527 528 529
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

530 531 532 533
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
534 535 536
  /**
   * execute a single CMake command
   */
537
  void ExecuteCommand(std::string &name, std::vector<std::string> const& args);
Ken Martin's avatar
Ken Martin committed
538
  
539 540
  /** Check if a command exists. */
  bool CommandExists(const char* name) const;
Ken Martin's avatar
Ken Martin committed
541
    
542 543
protected:
  std::string m_Prefix;
544
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
545 546 547 548 549 550 551

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

554
  std::string m_ProjectName;	// project name
555 556 557

  // libraries, classes, and executables
  cmTargets m_Targets;
558
  SourceMap m_Sources; 
559

560
  std::vector<std::string> m_SubDirectories; // list of sub directories
561
  struct StringSet : public std::set<cmStdString>
Bill Hoffman's avatar
Bill Hoffman committed
562 563
  {
  };
564
  
565 566 567 568 569
  // 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
570
  std::vector<std::string> m_ListFiles; // list of command files loaded
571 572
  
  
573
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
574

575
  std::string m_IncludeFileRegularExpression;
576
  std::string m_ComplainFileRegularExpression;
577 578
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
579
  std::string m_DefineFlags;
580
  std::vector<cmSourceGroup> m_SourceGroups;
581 582
  typedef std::map<cmStdString, cmCommand*> RegisteredCommandsMap;
  typedef std::map<cmStdString, cmStdString> DefinitionMap;
583
  DefinitionMap m_Definitions;
584 585
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
586
  cmMakefileGenerator* m_MakefileGenerator;
587
  bool IsFunctionBlocked(const char *name, std::vector<std::string> const& args);
588
  
589
private:
Ken Martin's avatar
Ken Martin committed
590 591 592
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
593
   */
Ken Martin's avatar
Ken Martin committed
594
  std::string GetParentListFileName(const char *listFileName);
595

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


#endif