cmMakefile.h 16.9 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
class cmFunctionBlocker;
51
class cmCommand;
52
53
class cmMakefileGenerator;

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

  /**
   * Destructor.
   */
85
  ~cmMakefile();
86
87
88
89

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

  /**
   * Add a wrapper generator.
   */
95
  void AddCommand(cmCommand* );
96

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

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

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

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

162
163
164
165
166
  /**
   * 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,
167
168
169
170
171
172
173
                         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);
174

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

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

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

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

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

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

  /**
   * Add a variable definition to the build. This variable
   * can be used in CMake to refer to lists, directories, etc.
   */
215
  void AddDefinition(const char* name, const char* value);
216

217
218
219
220
221
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

222
223
224
  /**
   * Specify the name of the project for this build.
   */
225
  void SetProjectName(const char*);
226
227
228
229
230
231
232
233
234
235
236
237

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
238
239
  void AddLibrary(const char *libname, bool shared,
                  const std::vector<std::string> &srcs);
240
241
242
243

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

246
247
248
249
250
  /**
   * Remove a class/source file from the build.
   */
  void RemoveSource(cmSourceFile& ,const char *srcListName);

251
252
253
254
255
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
256
257
258
  /**
   * Add an auxiliary directory to the build.
   */
259
260
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
261
262
263
264
265
266
267
268
269
270
271

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

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

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

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

365
366
367
368
369
370
371
372
373
  /** 
   * 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;
    }

374
  /**
375
   * Get the list of targets
376
   */
Ken Martin's avatar
Ken Martin committed
377
  cmTargets &GetTargets() { return m_Targets; }
378
  const cmTargets &GetTargets() const { return m_Targets; }
379
380
381
382

  /**
   * Get a list of the build subdirectories.
   */
383
384
  const std::vector<std::string>& GetSubDirectories()
    { 
385
    return m_SubDirectories;
386
    }
387

388
389
390
391
392
393
394
395
  /**
   * Get the subdirectory dependencies for the given subdirectory.
   */
  const std::set<std::string>& GetSubdirDepends(const char* subdir)
    { 
    return m_SubdirDepends[subdir];
    }

396
397
398
  /**
   * Get a list of include directories in the build.
   */
399
  std::vector<std::string>& GetIncludeDirectories()
400
    { 
401
    return m_IncludeDirectories;
402
    }
403
  const std::vector<std::string>& GetIncludeDirectories() const
404
405
406
    { 
    return m_IncludeDirectories;
    }
407
408
409
410

  /**
   * Get a list of link directories in the build.
   */
411
  std::vector<std::string>& GetLinkDirectories()
412
    { 
413
    return m_LinkDirectories;
414
415
    }
  
416
417
418
  /**
   * Return a list of source files in this makefile.
   */
419
420
421
422
  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);
423
  
424
425
426
  /**
   * Obtain a list of auxiliary source directories.
   */
427
  std::vector<std::string>& GetAuxSourceDirectories()
428
    {return m_AuxSourceDirectories;}
429

430
431
432
433
434
435
436
437
438
439
440
  //@{
  /**
   * 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;}
  //@}

441
442
  /**
   * Given a variable name, return its value (as a string).
443
   */
444
445
  const char* GetDefinition(const char*);

446
  /**
447
   * Get a list of preprocessor define flags.
448
   */
449
450
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
451
452
453
454
455
456
457
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
458
459
460
461
462
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
463
464
465
466
467
468

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
469
  
470
471
472
473
474
475
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

476
477
478
479
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
480
481
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
482
   */
483
  void ExpandVariablesInString(std::string& source) const;
484
  void ExpandVariablesInString(std::string& source, bool escapeQuotes) const;
485

486
487
488
489
490
491
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

492
493
494
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
495
  void ExpandVariables();  
496

Bill Hoffman's avatar
Bill Hoffman committed
497
498
499
500
501
502
503
  /** 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);
  
504
505
506
507
508
509
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

510
511
512
513
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
514
515
516
  /**
   * execute a single CMake command
   */
Ken Martin's avatar
Ken Martin committed
517
  void ExecuteCommand(std::string &name, std::vector<std::string> &args);
Ken Martin's avatar
Ken Martin committed
518
519
  
    
520
521
protected:
  std::string m_Prefix;
522
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
523
524
525
526
527
528
529

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

532
  std::string m_ProjectName;	// project name
533
534
535

  // libraries, classes, and executables
  cmTargets m_Targets;
536
  SourceMap m_Sources; 
537

538
  std::vector<std::string> m_SubDirectories; // list of sub directories
539
  std::map<std::string, std::set<std::string> >  m_SubdirDepends;
540
541
542
543
544
545
  
  // 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
546
  std::vector<std::string> m_ListFiles; // list of command files loaded
547
548
  
  
549
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
550

551
  std::string m_IncludeFileRegularExpression;
552
  std::string m_ComplainFileRegularExpression;
553
554
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
555
  std::string m_DefineFlags;
556
  std::vector<cmSourceGroup> m_SourceGroups;
557
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
558
559
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
560
561
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
562
  cmMakefileGenerator* m_MakefileGenerator;
Ken Martin's avatar
Ken Martin committed
563
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args);
564
  
565
private:
Ken Martin's avatar
Ken Martin committed
566
567
568
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
569
   */
Ken Martin's avatar
Ken Martin committed
570
  std::string GetParentListFileName(const char *listFileName);
571

572
  void ReadSources(std::ifstream& fin, bool t);
573
  friend class cmMakeDepend;	// make depend needs direct access 
574
				// to the m_Sources array 
575
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
576
  void AddDefaultCommands();
577
  void AddDefaultDefinitions();
578
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
579
580
581
  
  typedef std::map<std::string, cmData*> DataMap;
  DataMap m_DataMap;
Ken Martin's avatar
Ken Martin committed
582
  bool m_Inheriting;
583
584
585
586
};


#endif