cmMakefile.h 15.1 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
68
69
70
71
72
73
74
75
  static unsigned int GetMajorVersion() { return 0;}
  static unsigned int GetMinorVersion() { return 1;}
  /**
   * 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
  void AddLibrary(const char *libname, const std::vector<std::string> &srcs);
229
230
231
232

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

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

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

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

  /* 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
338
  //@}
339
340
341
342
343
344
345
346
347
348

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

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

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

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

  /**
   * Get a list of link directories in the build.
   */
373
374
  std::vector<std::string>& GetLinkDirectories()
    { 
375
    return m_LinkDirectories;
376
377
    }
  
378
379
380
  /**
   * Return a list of source files in this makefile.
   */
381
382
383
384
  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);
385
  
386
387
388
  /**
   * Obtain a list of auxiliary source directories.
   */
389
  std::vector<std::string>& GetAuxSourceDirectories()
390
    {return m_AuxSourceDirectories;}
391

392
393
  /**
   * Given a variable name, return its value (as a string).
394
   */
395
396
  const char* GetDefinition(const char*);

397
  /**
398
   * Get a list of preprocessor define flags.
399
   */
400
401
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
402
403
404
405
406
407
408
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
409
410
411
412
413
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
Anonymous's avatar
Anonymous committed
414
415
416
417
418
419

  /**
   * Get the vector of list files on which this makefile depends
   */
  const std::vector<std::string>& GetListFiles() const
    { return m_ListFiles; }
420
  
421
422
423
424
425
426
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

427
428
429
430
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
431
432
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
433
   */
434
  void ExpandVariablesInString(std::string& source) const;
435

436
437
438
439
440
441
  /**
   * Remove any remaining variables in the string. Anything with ${var} or
   * @var@ will be removed.  
   */
  void RemoveVariablesInString(std::string& source) const;

442
443
444
  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
445
  void ExpandVariables();  
446
      
Bill Hoffman's avatar
Bill Hoffman committed
447
448
449
450
451
452
453
  /** 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);
  
454
455
456
457
458
459
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

460
461
462
463
  void RegisterData(cmData*);
  void RegisterData(const char*, cmData*);
  cmData* LookupData(const char*) const;
  
464
465
protected:
  std::string m_Prefix;
466
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
467
468
469
470
471
472
473

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

476
  std::string m_ProjectName;	// project name
477
478
479

  // libraries, classes, and executables
  cmTargets m_Targets;
480
  SourceMap m_Sources; 
481

482
  std::vector<std::string> m_SubDirectories; // list of sub directories
483
484
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
Anonymous's avatar
Anonymous committed
485
  std::vector<std::string> m_ListFiles; // list of command files loaded
486
487
  
  
488
  cmTarget::LinkLibraries m_LinkLibraries;
Anonymous's avatar
Anonymous committed
489

490
  std::string m_IncludeFileRegularExpression;
491
  std::string m_DefineFlags;
492
  std::vector<cmSourceGroup> m_SourceGroups;
493
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
494
495
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
496
497
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
498
  cmMakefileGenerator* m_MakefileGenerator;
499
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args) const;
500
  
501
private:
Ken Martin's avatar
Ken Martin committed
502
503
504
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
505
   */
Ken Martin's avatar
Ken Martin committed
506
  std::string GetParentListFileName(const char *listFileName);
507

508
  void ReadSources(std::ifstream& fin, bool t);
509
  friend class cmMakeDepend;	// make depend needs direct access 
510
				// to the m_Sources array 
511
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
512
  void AddDefaultCommands();
513
  void AddDefaultDefinitions();
514
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
515
516
517
  
  typedef std::map<std::string, cmData*> DataMap;
  DataMap m_DataMap;
518
519
520
521
};


#endif