cmMakefile.h 15.5 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:
64
65
66
  /**
   * Construct an empty makefile.
   */
67
  cmMakefile();
68
69
70
71

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

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

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

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

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

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

  /**
   * Add an executable to the build.
   */
137
138
139
140
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs);
  void AddExecutable(const char *exename, 
                     const std::vector<std::string> &srcs, bool win32);
141

142
143
144
145
146
  /**
   * 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,
147
148
149
150
151
152
153
                         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);
154

155
  /**
Ken Martin's avatar
Ken Martin committed
156
157
158
   * 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.  
159
160
161
162
163
164
165
166
   */
  void AddUtility(const char*);

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

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

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

  /**
   * Add a link directory to the build.
   */
186
  void AddLinkDirectory(const char*);
187
188
189
190

  /**
   * Add a subdirectory to the build.
   */
191
  void AddSubDirectory(const char*);
192
193
194
195

  /**
   * Add an include directory to the build.
   */
196
  void AddIncludeDirectory(const char*);
197
198
199
200
201

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

204
205
206
207
208
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

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

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

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

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

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

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

  /* 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
335
  //@}
336
337
338
339
340
341
342
343
344
345

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

346
  /**
347
   * Get the list of targets
348
   */
Ken Martin's avatar
Ken Martin committed
349
  cmTargets &GetTargets() { return m_Targets; }
350
351
352
353

  /**
   * Get a list of the build subdirectories.
   */
354
355
  const std::vector<std::string>& GetSubDirectories()
    { 
356
    return m_SubDirectories;
357
    }
358
359
360
361

  /**
   * Get a list of include directories in the build.
   */
362
363
  std::vector<std::string>& GetIncludeDirectories()
    { 
364
    return m_IncludeDirectories;
365
    }
366
367
368
369

  /**
   * Get a list of link directories in the build.
   */
370
371
  std::vector<std::string>& GetLinkDirectories()
    { 
372
    return m_LinkDirectories;
373
374
    }
  
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
  /**
   * 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;
    }

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

405
406
407
408
409
  /**
   * Do not use this.
   */
  std::vector<std::string>& GetMakeVerbatim() 
    {return m_MakeVerbatim;}
410

411
412
  /**
   * Given a variable name, return its value (as a string).
413
   */
414
415
  const char* GetDefinition(const char*);

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

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

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

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

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

479
480
481
482
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
483
484
protected:
  std::string m_Prefix;
485
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
486
487
488
489
490
491
492

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

495
  std::string m_ProjectName;	// project name
496
497
498

  // libraries, classes, and executables
  cmTargets m_Targets;
499
  SourceMap m_Sources; 
500

501
  std::vector<std::string> m_SubDirectories; // list of sub directories
502
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
503
504
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
505
506
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
Anonymous's avatar
Anonymous committed
507
508
  std::vector<std::string> m_ListFiles; // list of command files loaded

509
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
510

511
  std::string m_IncludeFileRegularExpression;
512
  std::string m_DefineFlags;
513
  std::vector<cmSourceGroup> m_SourceGroups;
514
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
515
516
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
517
518
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
519
  cmMakefileGenerator* m_MakefileGenerator;
520
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args) const;
521
  
522
private:
Ken Martin's avatar
Ken Martin committed
523
524
525
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
526
   */
Ken Martin's avatar
Ken Martin committed
527
  std::string GetParentListFileName(const char *listFileName);
528

529
  void ReadSources(std::ifstream& fin, bool t);
530
  friend class cmMakeDepend;	// make depend needs direct access 
531
				// to the m_Sources array 
532
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
533
  void AddDefaultCommands();
534
  void AddDefaultDefinitions();
535
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
536
537
538
  
  typedef std::map<std::string, cmData*> DataMap;
  DataMap m_DataMap;
539
540
541
542
};


#endif