cmMakefile.h 18.1 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
version  
Ken Martin committed
70
  static unsigned int GetMinorVersion() { return 97;}
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,
Ken Martin's avatar
Ken Martin committed
139
                        const std::vector<std::string>& 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,
Ken Martin's avatar
Ken Martin committed
146
                        const std::vector<std::string>& 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
                         const char* command,
170
                         const char* arguments,
171
172
173
                         bool all);
  void AddUtilityCommand(const char* utilityName,
                         const char* command,
174
                         const char* arguments,
175
176
177
                         bool all,
                         const std::vector<std::string> &depends,
                         const std::vector<std::string> &outputs);
178

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

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

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

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

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

213
214
215
216
217
  /**
   * Add a subdirectory dependency.
   */
  void AddSubdirDependency(const char* subdir, const char* dependency);

218
219
220
  /**
   * Add an include directory to the build.
   */
221
  void AddIncludeDirectory(const char*);
222
223
224
225
226

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

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

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

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

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

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

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

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

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

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

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

384
385
386
387
388
389
390
391
392
  /** 
   * 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;
    }

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

  /**
   * Get a list of the build subdirectories.
   */
402
403
  const std::vector<std::string>& GetSubDirectories()
    { 
404
    return m_SubDirectories;
405
    }
406

407
408
409
  /**
   * Get the subdirectory dependencies for the given subdirectory.
   */
410
  const std::set<cmStdString>& GetSubdirDepends(const char* subdir)
411
412
413
414
    { 
    return m_SubdirDepends[subdir];
    }

415
416
417
  /**
   * Get a list of include directories in the build.
   */
418
  std::vector<std::string>& GetIncludeDirectories()
419
    { 
420
    return m_IncludeDirectories;
421
    }
422
  const std::vector<std::string>& GetIncludeDirectories() const
423
424
425
    { 
    return m_IncludeDirectories;
    }
426
427
428
429

  /**
   * Get a list of link directories in the build.
   */
430
  std::vector<std::string>& GetLinkDirectories()
431
    { 
432
    return m_LinkDirectories;
433
434
    }
  
435
436
437
  /**
   * Return a list of source files in this makefile.
   */
438
  typedef std::map<cmStdString,std::vector<cmSourceFile> > SourceMap;
439
440
441
  const SourceMap &GetSources() const {return  m_Sources;}
  SourceMap &GetSources() {return  m_Sources;}
  cmSourceFile *GetSource(const char *srclist, const char *sourceName);
442
  
443
444
445
  /**
   * Obtain a list of auxiliary source directories.
   */
446
  std::vector<std::string>& GetAuxSourceDirectories()
447
    {return m_AuxSourceDirectories;}
448

449
450
451
452
453
454
455
456
457
458
459
  //@{
  /**
   * 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;}
  //@}

460
461
  /**
   * Given a variable name, return its value (as a string).
462
463
   * If the variable is not found in this makefile instance, the
   * cache is then queried.
464
   */
465
  const char* GetDefinition(const char*) const;
466
467
468
469
470
  
  /** Test a boolean cache entry to see if it is true or false, 
   *  returns false if no entry defined.
   */
  bool IsOn(const char* name);
471

472
  /**
473
   * Get a list of preprocessor define flags.
474
   */
475
476
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
477
478
479
480
481
482
483
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
484
485
486
487
488
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
489
490
491
492
493
494

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
495
  
496
497
498
499
  ///! When the file changes cmake will be re-run from the build system.
  void AddCMakeDependFile(const char* file)
    { m_ListFiles.push_back(file);}
  
500
501
502
503
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
504
  int DumpDocumentationToFile(std::ostream&);
505

506
507
508
509
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
510
511
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
512
   */
513
514
  const char *ExpandVariablesInString(std::string& source) const;
  const char *ExpandVariablesInString(std::string& source, bool escapeQuotes) const;
515

516
517
518
519
520
521
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

522
523
524
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
525
  void ExpandVariables();  
526

Bill Hoffman's avatar
Bill Hoffman committed
527
528
529
530
531
532
533
  /** 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);
  
534
535
536
537
538
539
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

540
541
542
543
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
544
545
546
  /**
   * execute a single CMake command
   */
547
  void ExecuteCommand(std::string &name, std::vector<std::string> const& args);
Ken Martin's avatar
Ken Martin committed
548
549
  
    
550
551
protected:
  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
  SourceMap m_Sources; 
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
  
  std::map<cmStdString, StringSet >  m_SubdirDepends;
574
575
576
577
578
579
  
  // 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
580
  std::vector<std::string> m_ListFiles; // list of command files loaded
581
582
  
  
583
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
584

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

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


#endif