cmMakefile.h 16.4 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
  /**
   * Print the object state to std::cout.
   */
125
  void Print() const;
126
  
127
  /**
128
   * Add a custom command to the build.
129
   */
130
  void AddCustomCommand(const char* source,
131
                        const char* command,
132
                        const char* commandArgs,
133
                        const std::vector<std::string>& depends,
134
135
                        const std::vector<std::string>& outputs,
                        const char *target);
136
137
138

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

  /**
   * Add an executable to the build.
   */
152
153
154
155
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs);
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs, bool win32);
156

157
158
159
160
161
  /**
   * 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,
162
163
164
165
166
167
168
                         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);
169

170
171
172
  /**
   * Get a list of link libraries in the build.
   */
173
  cmTarget::LinkLibraries& GetLinkLibraries()
174
175
176
177
    { 
    return m_LinkLibraries;
    }

178
179
180
  /**
   * Add a link library to the build.
   */
181
  void AddLinkLibrary(const char*);
182
183
184
  void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  void AddLinkLibraryForTarget(const char *tgt, const char*, 
                               cmTarget::LinkLibraryType type);
185
186
187
188

  /**
   * Add a link directory to the build.
   */
189
  void AddLinkDirectory(const char*);
190
191
192
193

  /**
   * Add a subdirectory to the build.
   */
194
  void AddSubDirectory(const char*);
195
196
197
198

  /**
   * Add an include directory to the build.
   */
199
  void AddIncludeDirectory(const char*);
200
201
202
203
204

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

207
208
209
210
211
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

212
213
214
  /**
   * Specify the name of the project for this build.
   */
215
  void SetProjectName(const char*);
216
217
218
219
220
221
222
223
224
225
226
227

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
228
229
  void AddLibrary(const char *libname, bool shared,
                  const std::vector<std::string> &srcs);
230
231
232
233

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

236
237
238
239
240
  /**
   * Remove a class/source file from the build.
   */
  void RemoveSource(cmSourceFile& ,const char *srcListName);

241
242
243
244
245
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
246
247
248
  /**
   * Add an auxiliary directory to the build.
   */
249
250
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
251
252
253
254
255
256
257
258
259
260
261

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

Ken Martin's avatar
Ken Martin committed
309
  //@{
310
  /**
Ken Martin's avatar
Ken Martin committed
311
312
313
314
315
   * 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.  
316
   */
Ken Martin's avatar
Ken Martin committed
317
  void SetCurrentDirectory(const char* dir) 
318
    {
Ken Martin's avatar
Ken Martin committed
319
320
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
321
    }
322
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
323
324
325
326
327
328
329
330
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
331
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
332
333
334
    {
      return m_CurrentOutputDirectory.c_str();
    }
Anonymous's avatar
Anonymous committed
335
336
337
338
339
340
341
342
343

  /* 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
344
  //@}
345
346
347
348
349
350
351
352
353
354

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

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

364
  /**
365
   * Get the list of targets
366
   */
Ken Martin's avatar
Ken Martin committed
367
  cmTargets &GetTargets() { return m_Targets; }
368
  const cmTargets &GetTargets() const { return m_Targets; }
369
370
371
372

  /**
   * Get a list of the build subdirectories.
   */
373
374
  const std::vector<std::string>& GetSubDirectories()
    { 
375
    return m_SubDirectories;
376
    }
377
378
379
380

  /**
   * Get a list of include directories in the build.
   */
381
382
  std::vector<std::string>& GetIncludeDirectories()
    { 
383
    return m_IncludeDirectories;
384
    }
385
386
387
388
  const std::vector<std::string>& GetIncludeDirectories() const
    { 
    return m_IncludeDirectories;
    }
389
390
391
392

  /**
   * Get a list of link directories in the build.
   */
393
394
  std::vector<std::string>& GetLinkDirectories()
    { 
395
    return m_LinkDirectories;
396
397
    }
  
398
399
400
  /**
   * Return a list of source files in this makefile.
   */
401
402
403
404
  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);
405
  
406
407
408
  /**
   * Obtain a list of auxiliary source directories.
   */
409
  std::vector<std::string>& GetAuxSourceDirectories()
410
    {return m_AuxSourceDirectories;}
411

412
413
414
415
416
417
418
419
420
421
422
  //@{
  /**
   * 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;}
  //@}

423
424
  /**
   * Given a variable name, return its value (as a string).
425
   */
426
427
  const char* GetDefinition(const char*);

428
  /**
429
   * Get a list of preprocessor define flags.
430
   */
431
432
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
433
434
435
436
437
438
439
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
440
441
442
443
444
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
445
446
447
448
449
450

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
451
  
452
453
454
455
456
457
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

458
459
460
461
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
462
463
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
464
   */
465
  void ExpandVariablesInString(std::string& source) const;
466
  void ExpandVariablesInString(std::string& source, bool escapeQuotes) const;
467

468
469
470
471
472
473
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

474
475
476
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
477
  void ExpandVariables();  
478
      
Bill Hoffman's avatar
Bill Hoffman committed
479
480
481
482
483
484
485
  /** 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);
  
486
487
488
489
490
491
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

492
493
494
495
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
Ken Martin's avatar
Ken Martin committed
496
497
498
499
500
501
502
  /**
   * execute a single CMake command
   */
  void cmMakefile::ExecuteCommand(std::string &name,
                                  std::vector<std::string> &args);
  
    
503
504
protected:
  std::string m_Prefix;
505
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
506
507
508
509
510
511
512

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

515
  std::string m_ProjectName;	// project name
516
517
518

  // libraries, classes, and executables
  cmTargets m_Targets;
519
  SourceMap m_Sources; 
520

521
  std::vector<std::string> m_SubDirectories; // list of sub directories
522
523
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
Anonymous's avatar
Anonymous committed
524
  std::vector<std::string> m_ListFiles; // list of command files loaded
525
526
  
  
527
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
528

529
  std::string m_IncludeFileRegularExpression;
530
  std::string m_ComplainFileRegularExpression;
531
532
  std::vector<std::string> m_SourceFileExtensions;
  std::vector<std::string> m_HeaderFileExtensions;
533
  std::string m_DefineFlags;
534
  std::vector<cmSourceGroup> m_SourceGroups;
535
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
536
537
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
538
539
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
540
  cmMakefileGenerator* m_MakefileGenerator;
Ken Martin's avatar
Ken Martin committed
541
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args);
542
  
543
private:
Ken Martin's avatar
Ken Martin committed
544
545
546
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
547
   */
Ken Martin's avatar
Ken Martin committed
548
  std::string GetParentListFileName(const char *listFileName);
549

550
  void ReadSources(std::ifstream& fin, bool t);
551
  friend class cmMakeDepend;	// make depend needs direct access 
552
				// to the m_Sources array 
553
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
554
  void AddDefaultCommands();
555
  void AddDefaultDefinitions();
556
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
557
558
559
  
  typedef std::map<std::string, cmData*> DataMap;
  DataMap m_DataMap;
Ken Martin's avatar
Ken Martin committed
560
  bool m_Inheriting;
561
562
563
564
};


#endif