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
class cmMakefileGenerator;
55
class cmMakeDepend;
56

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
485
  
486
487
488
489
  ///! When the file changes cmake will be re-run from the build system.
  void AddCMakeDependFile(const char* file)
    { m_ListFiles.push_back(file);}
  
490
491
492
493
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
494
  int DumpDocumentationToFile(std::ostream&);
495

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

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

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

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

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

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

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

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

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

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

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


#endif