cmMakefile.h 15.2 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 "cmSourceFile.h"
46
#include "cmSystemTools.h"
47
#include "cmSourceGroup.h"
48
#include "cmTarget.h"
49
class cmFunctionBlocker;
50
class cmCommand;
51
52
class cmMakefileGenerator;

53
54
55
56
/** \class cmMakefile
 * \brief Process the input CMakeLists.txt file.
 *
 * Process and store into memory the input CMakeLists.txt file.
57
 * Each CMakeLists.txt file is parsed and the commands found there
58
59
 * are added into the build process.
 */
60
61
62
class cmMakefile
{
public:
63
64
65
  /**
   * Construct an empty makefile.
   */
66
  cmMakefile();
67
68
69
70

  /**
   * Destructor.
   */
71
  ~cmMakefile();
72
73
74
75

  /**
   * Read and parse a CMakeLists.txt file.
   */
Anonymous's avatar
Anonymous committed
76
  bool ReadListFile(const char* listfile, const char* external= 0); 
77
78
79
80

  /**
   * Add a wrapper generator.
   */
81
  void AddCommand(cmCommand* );
82

83
84
85
86
87
88
89
90
91
  /**
   * 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);
  
92
93
94
95
96
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
97
  void SetMakefileGenerator(cmMakefileGenerator*);
98
99
100
101
  
  ///! Get the current makefile generator.
  cmMakefileGenerator* GetMakefileGenerator() 
    { return m_MakefileGenerator;}
102
103
104
105

  /**
   * Produce the output makefile.
   */
106
107
  void GenerateMakefile();
  
108
109
110
  /**
   * Print the object state to std::cout.
   */
111
  void Print() const;
112
  
113
  /**
114
   * Add a custom command to the build.
115
   */
116
  void AddCustomCommand(const char* source,
117
118
                        const char* command,
                        const std::vector<std::string>& depends,
119
120
                        const std::vector<std::string>& outputs,
                        const char *target);
121
122
123
124

  void AddCustomCommand(const char* source,
                        const char* command,
                        const std::vector<std::string>& depends,
125
126
                        const char* output,
                        const char* target);
127
  
128
129
130
  /**
   * Add a define flag to the build.
   */
131
  void AddDefineFlag(const char* definition);
132
133
134
135

  /**
   * Add an executable to the build.
   */
136
  void AddExecutable(const char *exename, const std::vector<std::string> &srcs);
137

138
139
140
141
142
  /**
   * 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,
143
144
145
146
147
148
149
                         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);
150

151
  /**
Ken Martin's avatar
Ken Martin committed
152
153
154
   * Add a utility on which this project depends. A utility is an executable
   * name as would be specified to the ADD_EXECUTABLE or UTILITY_SOURCE
   * commands. It is not a full path nor does it have an extension.  
155
156
157
158
159
160
161
162
   */
  void AddUtility(const char*);

  /**
   * Add a directory in which a utility may be built.
   */
  void AddUtilityDirectory(const char*);

163
164
165
  /**
   * Get a list of link libraries in the build.
   */
166
  cmTarget::LinkLibraries& GetLinkLibraries()
167
168
169
170
    { 
    return m_LinkLibraries;
    }

171
172
173
  /**
   * Add a link library to the build.
   */
174
  void AddLinkLibrary(const char*);
175
176
177
  void AddLinkLibrary(const char*, cmTarget::LinkLibraryType type);
  void AddLinkLibraryForTarget(const char *tgt, const char*, 
                               cmTarget::LinkLibraryType type);
178
179
180
181

  /**
   * Add a link directory to the build.
   */
182
  void AddLinkDirectory(const char*);
183
184
185
186

  /**
   * Add a subdirectory to the build.
   */
187
  void AddSubDirectory(const char*);
188
189
190
191

  /**
   * Add an include directory to the build.
   */
192
  void AddIncludeDirectory(const char*);
193
194
195
196
197

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

200
201
202
203
204
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

205
206
207
  /**
   * Specify the name of the project for this build.
   */
208
  void SetProjectName(const char*);
209
210
211
212
213
214
215
216
217
218
219
220

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
221
  void AddLibrary(const char *libname, const std::vector<std::string> &srcs);
222
223
224
225

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

228
229
230
231
232
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
233
234
235
  /**
   * Add an auxiliary directory to the build.
   */
236
237
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
238
239
240
241
242
243
244
245
246
247
248

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
249
  /**
Ken Martin's avatar
Ken Martin committed
250
251
252
253
254
   * 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.  
255
   */
256
  void SetHomeDirectory(const char* dir);
257
  const char* GetHomeDirectory() const
258
    {
259
    return m_cmHomeDirectory.c_str();
260
    }
261
  void SetHomeOutputDirectory(const char* lib);
262
  const char* GetHomeOutputDirectory() const
263
    {
Ken Martin's avatar
Ken Martin committed
264
    return m_HomeOutputDirectory.c_str();
265
    }
Ken Martin's avatar
Ken Martin committed
266
267
268
  //@}
  
  //@{
269
  /**
Ken Martin's avatar
Ken Martin committed
270
271
272
273
274
   * 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.  
275
   */
Ken Martin's avatar
Ken Martin committed
276
  void SetStartDirectory(const char* dir) 
277
    {
Ken Martin's avatar
Ken Martin committed
278
279
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
280
    }
281
  const char* GetStartDirectory() const
282
    {
Ken Martin's avatar
Ken Martin committed
283
      return m_cmStartDirectory.c_str();
284
    }
Ken Martin's avatar
Ken Martin committed
285
286
287
288
289
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
    }
290
  const char* GetStartOutputDirectory() const
291
    {
Ken Martin's avatar
Ken Martin committed
292
      return m_StartOutputDirectory.c_str();
293
    }
Ken Martin's avatar
Ken Martin committed
294
  //@}
295

Ken Martin's avatar
Ken Martin committed
296
  //@{
297
  /**
Ken Martin's avatar
Ken Martin committed
298
299
300
301
302
   * 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.  
303
   */
Ken Martin's avatar
Ken Martin committed
304
  void SetCurrentDirectory(const char* dir) 
305
    {
Ken Martin's avatar
Ken Martin committed
306
307
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
308
    }
309
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
310
311
312
313
314
315
316
317
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
318
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
319
320
321
    {
      return m_CurrentOutputDirectory.c_str();
    }
Anonymous's avatar
Anonymous committed
322
323
324
325
326
327
328
329
330

  /* 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
331
  //@}
332
333
334
335
336
337
338
339
340
341

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

342
  /**
343
   * Get the list of targets
344
   */
Ken Martin's avatar
Ken Martin committed
345
  cmTargets &GetTargets() { return m_Targets; }
346
347
348
349

  /**
   * Get a list of the build subdirectories.
   */
350
351
  const std::vector<std::string>& GetSubDirectories()
    { 
352
    return m_SubDirectories;
353
    }
354
355
356
357

  /**
   * Get a list of include directories in the build.
   */
358
359
  std::vector<std::string>& GetIncludeDirectories()
    { 
360
    return m_IncludeDirectories;
361
    }
362
363
364
365

  /**
   * Get a list of link directories in the build.
   */
366
367
  std::vector<std::string>& GetLinkDirectories()
    { 
368
    return m_LinkDirectories;
369
370
    }
  
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
  /**
   * Get a list of utilities on which the project depends.
   */
  std::vector<std::string>& GetUtilities()
    { 
    return m_Utilities;
    }

  /**
   * Get a list of directories that may contain the Utilities.
   */
  std::vector<std::string>& GetUtilityDirectories()
    { 
    return m_UtilityDirectories;
    }

387
388
389
  /**
   * Return a list of source files in this makefile.
   */
390
391
392
393
  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);
394
  
395
396
397
  /**
   * Obtain a list of auxiliary source directories.
   */
398
  std::vector<std::string>& GetAuxSourceDirectories()
399
    {return m_AuxSourceDirectories;}
400

401
402
403
404
405
  /**
   * Do not use this.
   */
  std::vector<std::string>& GetMakeVerbatim() 
    {return m_MakeVerbatim;}
406

407
408
  /**
   * Given a variable name, return its value (as a string).
409
   */
410
411
  const char* GetDefinition(const char*);

412
  /**
413
   * Get a list of preprocessor define flags.
414
   */
415
416
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
417
418
419
420
421
422
423
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
424
425
426
427
428
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
429
430
431
432
433
434

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
435
  
436
437
438
439
440
441
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

442
443
444
445
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
446
447
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
448
   */
449
  void ExpandVariablesInString(std::string& source) const;
450

451
452
453
454
455
456
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

457
458
459
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
460
  void ExpandVariables();  
461
      
Bill Hoffman's avatar
Bill Hoffman committed
462
463
464
465
466
467
468
  /** 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);
  
469
470
471
472
473
474
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

475
476
protected:
  std::string m_Prefix;
477
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
478
479
480
481
482
483
484

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

487
  std::string m_ProjectName;	// project name
488
489
490

  // libraries, classes, and executables
  cmTargets m_Targets;
491
  SourceMap m_Sources; 
492

493
  std::vector<std::string> m_SubDirectories; // list of sub directories
494
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
495
496
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
497
498
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
Anonymous's avatar
Anonymous committed
499
500
  std::vector<std::string> m_ListFiles; // list of command files loaded

501
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
502

503
  std::string m_IncludeFileRegularExpression;
504
  std::string m_DefineFlags;
505
  std::vector<cmSourceGroup> m_SourceGroups;
506
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
507
508
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
509
510
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
511
  cmMakefileGenerator* m_MakefileGenerator;
512
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args) const;
513
  
514
private:
Ken Martin's avatar
Ken Martin committed
515
516
517
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
518
   */
Ken Martin's avatar
Ken Martin committed
519
  std::string GetParentListFileName(const char *listFileName);
520

521
  void ReadSources(std::ifstream& fin, bool t);
522
  friend class cmMakeDepend;	// make depend needs direct access 
523
				// to the m_Sources array 
524
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
525
  void AddDefaultCommands();
526
  void AddDefaultDefinitions();
527
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
528
529
530
531
};


#endif