cmMakefile.h 14.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 "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.
   */
Ken Martin's avatar
Ken Martin committed
76
  bool ReadListFile(const char* listfile); 
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

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

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

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

134
  /**
Ken Martin's avatar
Ken Martin committed
135
136
137
   * 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.  
138
139
140
141
142
143
144
145
   */
  void AddUtility(const char*);

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

146
147
148
149
150
151
152
153
154
155
  /**
   * Get a list of link libraries in the build.
   */
  enum LinkLibraryType {GENERAL, DEBUG, OPTIMIZED};
  typedef std::vector<std::pair<std::string,LinkLibraryType> > LinkLibraries;
  LinkLibraries& GetLinkLibraries()
    { 
    return m_LinkLibraries;
    }

156
157
158
  /**
   * Add a link library to the build.
   */
159
  void AddLinkLibrary(const char*);
160
  void AddLinkLibrary(const char*, LinkLibraryType type);
161
162
163
164

  /**
   * Add a link directory to the build.
   */
165
  void AddLinkDirectory(const char*);
166
167
168
169

  /**
   * Add a subdirectory to the build.
   */
170
  void AddSubDirectory(const char*);
171
172
173
174

  /**
   * Add an include directory to the build.
   */
175
  void AddIncludeDirectory(const char*);
176
177
178
179
180

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

183
184
185
186
187
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

188
189
190
  /**
   * Specify the name of the project for this build.
   */
191
  void SetProjectName(const char*);
192
193
194
195
196
197
198
199
200
201
202
203

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
204
  void AddLibrary(const char *libname, const std::vector<std::string> &srcs);
205
206
207
208

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

211
212
213
214
215
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
216
217
218
  /**
   * Add an auxiliary directory to the build.
   */
219
220
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
221
222
223
224
225
226
227
228
229
230
231

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
232
  /**
Ken Martin's avatar
Ken Martin committed
233
234
235
236
237
   * 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.  
238
   */
239
240
  void SetHomeDirectory(const char* dir) 
    {
241
242
    m_cmHomeDirectory = dir;
    cmSystemTools::ConvertToUnixSlashes(m_cmHomeDirectory);
243
    this->AddDefinition("CMAKE_SOURCE_DIR", this->GetHomeDirectory());
244
    }
245
  const char* GetHomeDirectory() const
246
    {
247
    return m_cmHomeDirectory.c_str();
248
    }
Ken Martin's avatar
Ken Martin committed
249
  void SetHomeOutputDirectory(const char* lib)
250
    {
Ken Martin's avatar
Ken Martin committed
251
252
    m_HomeOutputDirectory = lib;
    cmSystemTools::ConvertToUnixSlashes(m_HomeOutputDirectory);
253
    this->AddDefinition("CMAKE_BINARY_DIR", this->GetHomeOutputDirectory());
254
    }
255
  const char* GetHomeOutputDirectory() const
256
    {
Ken Martin's avatar
Ken Martin committed
257
    return m_HomeOutputDirectory.c_str();
258
    }
Ken Martin's avatar
Ken Martin committed
259
260
261
  //@}
  
  //@{
262
  /**
Ken Martin's avatar
Ken Martin committed
263
264
265
266
267
   * 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.  
268
   */
Ken Martin's avatar
Ken Martin committed
269
  void SetStartDirectory(const char* dir) 
270
    {
Ken Martin's avatar
Ken Martin committed
271
272
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
273
    }
274
  const char* GetStartDirectory() const
275
    {
Ken Martin's avatar
Ken Martin committed
276
      return m_cmStartDirectory.c_str();
277
    }
Ken Martin's avatar
Ken Martin committed
278
279
280
281
282
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
    }
283
  const char* GetStartOutputDirectory() const
284
    {
Ken Martin's avatar
Ken Martin committed
285
      return m_StartOutputDirectory.c_str();
286
    }
Ken Martin's avatar
Ken Martin committed
287
  //@}
288

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

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

326
  /**
327
   * Get the list of targets
328
   */
Ken Martin's avatar
Ken Martin committed
329
  cmTargets &GetTargets() { return m_Targets; }
330
331
332
333

  /**
   * Get a list of the build subdirectories.
   */
334
335
  const std::vector<std::string>& GetSubDirectories()
    { 
336
    return m_SubDirectories;
337
    }
338
339
340
341

  /**
   * Get a list of include directories in the build.
   */
342
343
  std::vector<std::string>& GetIncludeDirectories()
    { 
344
    return m_IncludeDirectories;
345
    }
346
347
348
349

  /**
   * Get a list of link directories in the build.
   */
350
351
  std::vector<std::string>& GetLinkDirectories()
    { 
352
    return m_LinkDirectories;
353
354
    }
  
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
  /**
   * 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;
    }

371
372
373
  /**
   * Return a list of source files in this makefile.
   */
374
375
376
377
  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);
378
  
379
380
381
  /**
   * Obtain a list of auxiliary source directories.
   */
382
  std::vector<std::string>& GetAuxSourceDirectories()
383
    {return m_AuxSourceDirectories;}
384

385
386
387
388
389
  /**
   * Do not use this.
   */
  std::vector<std::string>& GetMakeVerbatim() 
    {return m_MakeVerbatim;}
390

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

396
  /**
397
   * Get a list of preprocessor define flags.
398
   */
399
400
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
401
402
403
404
405
406
407
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
408
409
410
411
412
413
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
  
414
415
416
417
418
419
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

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

  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
432
  void ExpandVariables();  
433
      
Bill Hoffman's avatar
Bill Hoffman committed
434
435
436
437
438
439
440
441
442
443
444
445
446
  /** 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);
  
  /** Generate the cache file only.  This is done
   *  by calling FindSubDirectoryCMakeListsFiles which
   *  will cause all the rules to fire, and the cache to
   *  be filled.
   */
  void GenerateCacheOnly();
447

448
449
450
451
452
453
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

454
455
protected:
  std::string m_Prefix;
456
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
457
458
459
460
461
462
463
464

  std::string m_cmCurrentDirectory; 
  std::string m_CurrentOutputDirectory; 
  std::string m_cmStartDirectory; 
  std::string m_StartOutputDirectory; 
  std::string m_cmHomeDirectory; 
  std::string m_HomeOutputDirectory;

465
  std::string m_ProjectName;	// project name
466
467
468

  // libraries, classes, and executables
  cmTargets m_Targets;
469
  SourceMap m_Sources; 
470

471
  std::vector<std::string> m_SubDirectories; // list of sub directories
472
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
473
474
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
475
476
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
477
  LinkLibraries m_LinkLibraries;
478
  std::string m_IncludeFileRegularExpression;
479
  std::string m_DefineFlags;
480
  std::vector<cmSourceGroup> m_SourceGroups;
481
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
482
483
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
484
485
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
486
  cmMakefileGenerator* m_MakefileGenerator;
487
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args) const;
488
  
489
private:
Ken Martin's avatar
Ken Martin committed
490
491
492
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
493
   */
Ken Martin's avatar
Ken Martin committed
494
  std::string GetParentListFileName(const char *listFileName);
495

496
  void ReadSources(std::ifstream& fin, bool t);
497
  friend class cmMakeDepend;	// make depend needs direct access 
498
				// to the m_Sources array 
499
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
500
  void AddDefaultCommands();
501
  void AddDefaultDefinitions();
502
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
503
504
505
506
};


#endif