cmMakefile.h 12.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) 2000 National Library of Medicine
  All rights reserved.

  See COPYRIGHT.txt for copyright details.

=========================================================================*/
#ifndef cmMakefile_h
#define cmMakefile_h
18

19
#include "cmStandardIncludes.h"
20
#include "cmSourceFile.h"
21
#include "cmSystemTools.h"
22
#include "cmSourceGroup.h"
23
#include "cmTarget.h"
24
class cmFunctionBlocker;
25
class cmCommand;
26
27
class cmMakefileGenerator;

28
29
30
31
/** \class cmMakefile
 * \brief Process the input CMakeLists.txt file.
 *
 * Process and store into memory the input CMakeLists.txt file.
32
 * Each CMakeLists.txt file is parsed and the commands found there
33
34
 * are added into the build process.
 */
35
36
37
class cmMakefile
{
public:
38
39
40
  /**
   * Construct an empty makefile.
   */
41
  cmMakefile();
42
43
44
45

  /**
   * Destructor.
   */
46
  ~cmMakefile();
47
48
49
50

  /**
   * Read and parse a CMakeLists.txt file.
   */
Ken Martin's avatar
Ken Martin committed
51
  bool ReadListFile(const char* listfile); 
52
53
54
55

  /**
   * Add a wrapper generator.
   */
56
  void AddCommand(cmCommand* );
57

58
59
60
61
62
63
64
65
66
  /**
   * 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);
  
67
68
69
70
71
  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
72
  void SetMakefileGenerator(cmMakefileGenerator*);
73
74
75
76

  /**
   * Produce the output makefile.
   */
77
78
  void GenerateMakefile();
  
79
80
81
  /**
   * Print the object state to std::cout.
   */
82
  void Print() const;
83
  
84
  /**
85
   * Add a custom command to the build.
86
   */
87
  void AddCustomCommand(const char* source,
88
89
                        const char* command,
                        const std::vector<std::string>& depends,
90
91
                        const std::vector<std::string>& outputs,
                        const char *target);
92
93
94
95

  void AddCustomCommand(const char* source,
                        const char* command,
                        const std::vector<std::string>& depends,
96
97
                        const char* output,
                        const char* target);
98
  
99
100
101
  /**
   * Add a define flag to the build.
   */
102
  void AddDefineFlag(const char* definition);
103
104
105
106

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

109
  /**
Ken Martin's avatar
Ken Martin committed
110
111
112
   * 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.  
113
114
115
116
117
118
119
120
   */
  void AddUtility(const char*);

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

121
122
123
124
125
126
127
128
129
130
  /**
   * 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;
    }

131
132
133
  /**
   * Add a link library to the build.
   */
134
  void AddLinkLibrary(const char*);
135
  void AddLinkLibrary(const char*, LinkLibraryType type);
136
137
138
139

  /**
   * Add a link directory to the build.
   */
140
  void AddLinkDirectory(const char*);
141
142
143
144

  /**
   * Add a subdirectory to the build.
   */
145
  void AddSubDirectory(const char*);
146
147
148
149

  /**
   * Add an include directory to the build.
   */
150
  void AddIncludeDirectory(const char*);
151
152
153
154
155

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

158
159
160
161
162
  /**
   * Add bool variable definition to the build. 
   */
  void AddDefinition(const char* name, bool);

163
164
165
  /**
   * Specify the name of the project for this build.
   */
166
  void SetProjectName(const char*);
167
168
169
170
171
172
173
174
175
176
177
178

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
179
  void AddLibrary(const char *libname, const std::vector<std::string> &srcs);
180
181
182
183

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

186
187
188
189
190
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
191
192
193
  /**
   * Add an auxiliary directory to the build.
   */
194
195
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
196
197
198
199
200
201
202
203
204
205
206

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
207
  /**
Ken Martin's avatar
Ken Martin committed
208
209
210
211
212
   * 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.  
213
   */
214
215
  void SetHomeDirectory(const char* dir) 
    {
216
217
    m_cmHomeDirectory = dir;
    cmSystemTools::ConvertToUnixSlashes(m_cmHomeDirectory);
218
    this->AddDefinition("CMAKE_SOURCE_DIR", this->GetHomeDirectory());
219
    }
220
  const char* GetHomeDirectory() const
221
    {
222
    return m_cmHomeDirectory.c_str();
223
    }
Ken Martin's avatar
Ken Martin committed
224
  void SetHomeOutputDirectory(const char* lib)
225
    {
Ken Martin's avatar
Ken Martin committed
226
227
    m_HomeOutputDirectory = lib;
    cmSystemTools::ConvertToUnixSlashes(m_HomeOutputDirectory);
228
    this->AddDefinition("CMAKE_BINARY_DIR", this->GetHomeOutputDirectory());
229
    }
230
  const char* GetHomeOutputDirectory() const
231
    {
Ken Martin's avatar
Ken Martin committed
232
    return m_HomeOutputDirectory.c_str();
233
    }
Ken Martin's avatar
Ken Martin committed
234
235
236
  //@}
  
  //@{
237
  /**
Ken Martin's avatar
Ken Martin committed
238
239
240
241
242
   * 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.  
243
   */
Ken Martin's avatar
Ken Martin committed
244
  void SetStartDirectory(const char* dir) 
245
    {
Ken Martin's avatar
Ken Martin committed
246
247
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
248
    }
249
  const char* GetStartDirectory() const
250
    {
Ken Martin's avatar
Ken Martin committed
251
      return m_cmStartDirectory.c_str();
252
    }
Ken Martin's avatar
Ken Martin committed
253
254
255
256
257
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
    }
258
  const char* GetStartOutputDirectory() const
259
    {
Ken Martin's avatar
Ken Martin committed
260
      return m_StartOutputDirectory.c_str();
261
    }
Ken Martin's avatar
Ken Martin committed
262
  //@}
263

Ken Martin's avatar
Ken Martin committed
264
  //@{
265
  /**
Ken Martin's avatar
Ken Martin committed
266
267
268
269
270
   * 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.  
271
   */
Ken Martin's avatar
Ken Martin committed
272
  void SetCurrentDirectory(const char* dir) 
273
    {
Ken Martin's avatar
Ken Martin committed
274
275
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
276
    }
277
  const char* GetCurrentDirectory() const 
Ken Martin's avatar
Ken Martin committed
278
279
280
281
282
283
284
285
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
286
  const char* GetCurrentOutputDirectory() const
Ken Martin's avatar
Ken Martin committed
287
288
289
290
    {
      return m_CurrentOutputDirectory.c_str();
    }
  //@}
291
292
293
294
295
296
297
298
299
300

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

301
  /**
302
   * Get the list of targets
303
   */
Ken Martin's avatar
Ken Martin committed
304
  cmTargets &GetTargets() { return m_Targets; }
305
306
307
308

  /**
   * Get a list of the build subdirectories.
   */
309
310
  const std::vector<std::string>& GetSubDirectories()
    { 
311
    return m_SubDirectories;
312
    }
313
314
315
316

  /**
   * Get a list of include directories in the build.
   */
317
318
  std::vector<std::string>& GetIncludeDirectories()
    { 
319
    return m_IncludeDirectories;
320
    }
321
322
323
324

  /**
   * Get a list of link directories in the build.
   */
325
326
  std::vector<std::string>& GetLinkDirectories()
    { 
327
    return m_LinkDirectories;
328
329
    }
  
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
  /**
   * 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;
    }

346
347
348
  /**
   * Return a list of source files in this makefile.
   */
349
350
351
352
  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);
353
  
354
355
356
  /**
   * Obtain a list of auxiliary source directories.
   */
357
  std::vector<std::string>& GetAuxSourceDirectories()
358
    {return m_AuxSourceDirectories;}
359

360
361
362
363
364
  /**
   * Do not use this.
   */
  std::vector<std::string>& GetMakeVerbatim() 
    {return m_MakeVerbatim;}
365

366
367
  /**
   * Given a variable name, return its value (as a string).
368
   */
369
370
  const char* GetDefinition(const char*);

371
  /**
372
   * Get a list of preprocessor define flags.
373
   */
374
375
  const char* GetDefineFlags()
    {return m_DefineFlags.c_str();}
376
377
378
379
380
381
382
  
  /**
   * Get the vector of used command instances.
   */
  const std::vector<cmCommand*>& GetUsedCommands() const
    {return m_UsedCommands;}
  
383
384
385
386
387
388
  /**
   * Get the vector source groups.
   */
  const std::vector<cmSourceGroup>& GetSourceGroups() const
    { return m_SourceGroups; }
  
389
390
391
392
393
394
  /**
   * Dump documentation to a file. If 0 is returned, the
   * operation failed.
   */
  int DumpDocumentationToFile(const char *fileName);

395
396
397
398
  /**
   * Expand all defined varibles in the string.  
   * Defined varibles come from the m_Definitions map.
   * They are expanded with ${var} where var is the
399
400
   * entry in the m_Definitions map.  Also @var@ is
   * expanded to match autoconf style expansions.
401
   */
402
  void ExpandVariablesInString(std::string& source) const;
403
404
405
406

  /**
   * Expand variables in the makefiles ivars such as link directories etc
   */
407
  void ExpandVariables();  
408
      
Bill Hoffman's avatar
Bill Hoffman committed
409
410
411
412
413
414
415
416
417
418
419
420
421
  /** 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();
422

423
424
425
426
427
428
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

429
430
protected:
  std::string m_Prefix;
431
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
432
433
434
435
436
437
438
439

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

440
  std::string m_ProjectName;	// project name
441
442
443

  // libraries, classes, and executables
  cmTargets m_Targets;
444
  SourceMap m_Sources; 
445

446
  std::vector<std::string> m_SubDirectories; // list of sub directories
447
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
448
449
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
450
451
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
452
  LinkLibraries m_LinkLibraries;
453
  std::string m_IncludeFileRegularExpression;
454
  std::string m_DefineFlags;
455
  std::vector<cmSourceGroup> m_SourceGroups;
456
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
457
458
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
459
460
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
461
  cmMakefileGenerator* m_MakefileGenerator;
462
  bool IsFunctionBlocked(const char *name, std::vector<std::string> &args) const;
463
  
464
private:
Ken Martin's avatar
Ken Martin committed
465
466
467
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
468
   */
Ken Martin's avatar
Ken Martin committed
469
  std::string GetParentListFileName(const char *listFileName);
470

471
  void ReadSources(std::ifstream& fin, bool t);
472
  friend class cmMakeDepend;	// make depend needs direct access 
473
				// to the m_Sources array 
474
  void PrintStringVector(const char* s, const std::vector<std::string>& v) const;
475
  void AddDefaultCommands();
476
  void AddDefaultDefinitions();
477
  std::set<cmFunctionBlocker *> m_FunctionBlockers;
478
479
480
481
};


#endif