cmMakefile.h 12 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 "cmClassFile.h"
21
#include "cmSystemTools.h"
22
#include "cmSourceGroup.h"
23

24
class cmCommand;
25
26
class cmMakefileGenerator;

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

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

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

  /**
   * Add a wrapper generator.
   */
55
  void AddCommand(cmCommand* );
56
57
58
59
60
61

  /**
   * Specify the makefile generator. This is platform/compiler
   * dependent, although the interface is through a generic
   * superclass.
   */
62
  void SetMakefileGenerator(cmMakefileGenerator*);
63
64
65
66

  /**
   * Produce the output makefile.
   */
67
68
  void GenerateMakefile();
  
69
70
71
  /**
   * Print the object state to std::cout.
   */
72
  void Print();
73
  
74
  /**
75
   * Add a custom command to the build.
76
   */
77
  void AddCustomCommand(const char* source,
78
79
80
81
82
83
84
85
86
                        const char* command,
                        const std::vector<std::string>& depends,
                        const std::vector<std::string>& outputs);

  void AddCustomCommand(const char* source,
                        const char* command,
                        const std::vector<std::string>& depends,
                        const char* output);
  
87
88
89
  /**
   * Add a define flag to the build.
   */
90
  void AddDefineFlag(const char* definition);
91
92
93
94

  /**
   * Add an executable to the build.
   */
95
  void AddExecutable(cmClassFile&);
96

97
98
99
100
101
102
103
104
105
106
  /**
   * Add a utility on which this project depends.
   */
  void AddUtility(const char*);

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

107
108
109
  /**
   * Add a link library to the build.
   */
110
  void AddLinkLibrary(const char*);
111
112
113
114

  /**
   * Add a link directory to the build.
   */
115
  void AddLinkDirectory(const char*);
116
117
118
119

  /**
   * Add a subdirectory to the build.
   */
120
  void AddSubDirectory(const char*);
121
122
123
124

  /**
   * Add an include directory to the build.
   */
125
  void AddIncludeDirectory(const char*);
126
127
128
129
130

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

  /**
   * Specify the name of the project for this build.
   */
136
  void SetProjectName(const char*);
137
138
139
140
141
142
143
144
145
146
147
148

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
149
  void SetLibraryName(const char*);
150
151
152
153

  /**
   * Add a class/source file to the build.
   */
154
  void AddClass(cmClassFile& );
155

156
157
158
159
160
  /**
   * Add a source group for consideration when adding a new source.
   */
  void AddSourceGroup(const char* name, const char* regex);
  
161
162
163
  /**
   * Add an auxiliary directory to the build.
   */
164
165
  void AddExtraDirectory(const char* dir);
  
Ken Martin's avatar
Ken Martin committed
166
167
168
169
170
171
172
173
174
175
176

  /**
   * Add an auxiliary directory to the build.
   */
  void MakeStartDirectoriesCurrent()
    {
      m_cmCurrentDirectory = m_cmStartDirectory;
      m_CurrentOutputDirectory = m_StartOutputDirectory;
    }
  
  //@{
177
  /**
Ken Martin's avatar
Ken Martin committed
178
179
180
181
182
   * 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.  
183
   */
184
185
  void SetHomeDirectory(const char* dir) 
    {
186
187
    m_cmHomeDirectory = dir;
    cmSystemTools::ConvertToUnixSlashes(m_cmHomeDirectory);
188
    this->AddDefinition("CMAKE_SOURCE_DIR", this->GetHomeDirectory());
189
190
191
    }
  const char* GetHomeDirectory() 
    {
192
    return m_cmHomeDirectory.c_str();
193
    }
Ken Martin's avatar
Ken Martin committed
194
  void SetHomeOutputDirectory(const char* lib)
195
    {
Ken Martin's avatar
Ken Martin committed
196
197
    m_HomeOutputDirectory = lib;
    cmSystemTools::ConvertToUnixSlashes(m_HomeOutputDirectory);
198
    this->AddDefinition("CMAKE_BINARY_DIR", this->GetHomeOutputDirectory());
199
    }
Ken Martin's avatar
Ken Martin committed
200
  const char* GetHomeOutputDirectory()
201
    {
Ken Martin's avatar
Ken Martin committed
202
    return m_HomeOutputDirectory.c_str();
203
    }
Ken Martin's avatar
Ken Martin committed
204
205
206
  //@}
  
  //@{
207
  /**
Ken Martin's avatar
Ken Martin committed
208
209
210
211
212
   * 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.  
213
   */
Ken Martin's avatar
Ken Martin committed
214
  void SetStartDirectory(const char* dir) 
215
    {
Ken Martin's avatar
Ken Martin committed
216
217
      m_cmStartDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmStartDirectory);
218
    }
Ken Martin's avatar
Ken Martin committed
219
  const char* GetStartDirectory() 
220
    {
Ken Martin's avatar
Ken Martin committed
221
      return m_cmStartDirectory.c_str();
222
    }
Ken Martin's avatar
Ken Martin committed
223
224
225
226
227
228
  void SetStartOutputDirectory(const char* lib)
    {
      m_StartOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_StartOutputDirectory);
    }
  const char* GetStartOutputDirectory()
229
    {
Ken Martin's avatar
Ken Martin committed
230
      return m_StartOutputDirectory.c_str();
231
    }
Ken Martin's avatar
Ken Martin committed
232
  //@}
233

Ken Martin's avatar
Ken Martin committed
234
  //@{
235
  /**
Ken Martin's avatar
Ken Martin committed
236
237
238
239
240
   * 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.  
241
   */
Ken Martin's avatar
Ken Martin committed
242
  void SetCurrentDirectory(const char* dir) 
243
    {
Ken Martin's avatar
Ken Martin committed
244
245
      m_cmCurrentDirectory = dir;
      cmSystemTools::ConvertToUnixSlashes(m_cmCurrentDirectory);
246
    }
Ken Martin's avatar
Ken Martin committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
  const char* GetCurrentDirectory() 
    {
      return m_cmCurrentDirectory.c_str();
    }
  void SetCurrentOutputDirectory(const char* lib)
    {
      m_CurrentOutputDirectory = lib;
      cmSystemTools::ConvertToUnixSlashes(m_CurrentOutputDirectory);
    }
  const char* GetCurrentOutputDirectory()
    {
      return m_CurrentOutputDirectory.c_str();
    }
  //@}
261
262
263
264
265
266
267
268
269
270

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

271
  /**
Ken Martin's avatar
Ken Martin committed
272
   * Specify the name of the library that is built by this makefile.
273
   */
Ken Martin's avatar
Ken Martin committed
274
  const char* GetLibraryName()
275
    {
Ken Martin's avatar
Ken Martin committed
276
    return m_LibraryName.c_str();
277
    }
278
279
280
281

  /**
   * Get a list of the build subdirectories.
   */
282
283
  const std::vector<std::string>& GetSubDirectories()
    { 
284
    return m_SubDirectories;
285
    }
286
287
288
289
290

  /**
   * Return a boolean flag indicating whether the build generates
   * any executables.
   */
Ken Martin's avatar
Ken Martin committed
291
  bool HasExecutables();
292
293
294
295

  /**
   * Get a list of include directories in the build.
   */
296
297
  std::vector<std::string>& GetIncludeDirectories()
    { 
298
    return m_IncludeDirectories;
299
    }
300
301
302
303

  /**
   * Get a list of link directories in the build.
   */
304
305
  std::vector<std::string>& GetLinkDirectories()
    { 
306
    return m_LinkDirectories;
307
308
    }
  
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
  /**
   * 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;
    }

325
326
327
  /**
   * Get a list of link libraries in the build.
   */
328
329
  std::vector<std::string>& GetLinkLibraries()
    { 
330
    return m_LinkLibraries;
331
    }
332
333
334
335

  /**
   * Get a list of Win32 link libraries in the build.
   */
336
337
  std::vector<std::string>& GetLinkLibrariesWin32()
    { 
338
    return m_LinkLibrariesWin32;
339
340
    }
  
341
342
343
  /**
   * Get a list of Unix link libraries in the build.
   */
344
345
  std::vector<std::string>& GetLinkLibrariesUnix()
    { 
346
    return m_LinkLibrariesUnix;
347
    }
348
349
350
351
352
353
354
355
356
357

  /**
   * Return a list of source files in this makefile.
   */
  std::vector<cmClassFile>& GetClasses()
    {return  m_Classes;}

  /**
   * Obtain a list of auxiliary source directories.
   */
358
  std::vector<std::string>& GetAuxSourceDirectories()
359
    {return m_AuxSourceDirectories;}
360

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

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

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

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

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

424
425
protected:
  std::string m_Prefix;
426
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
427
428
429
430
431
432
433
434

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

435
  std::string m_LibraryName;	// library name
436
  std::string m_ProjectName;	// project name
437
438
  std::vector<cmClassFile> m_Classes; // list of classes in makefile
  std::vector<std::string> m_SubDirectories; // list of sub directories
439
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
440
441
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
442
443
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
444
445
446
  std::vector<std::string> m_LinkLibraries;
  std::vector<std::string> m_LinkLibrariesWin32;
  std::vector<std::string> m_LinkLibrariesUnix;
447
  std::string m_IncludeFileRegularExpression;
448
  std::string m_DefineFlags;
449
  std::vector<cmSourceGroup> m_SourceGroups;
450
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
451
452
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
453
454
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
455
  cmMakefileGenerator* m_MakefileGenerator;
456
457
  
private:
Ken Martin's avatar
Ken Martin committed
458
459
460
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
461
   */
Ken Martin's avatar
Ken Martin committed
462
  std::string GetParentListFileName(const char *listFileName);
463
464
465
466
467

  void ReadClasses(std::ifstream& fin, bool t);
  friend class cmMakeDepend;	// make depend needs direct access 
				// to the m_Classes array 
  void PrintStringVector(const char* s, std::vector<std::string>& v);
468
  void AddDefaultCommands();
469
  void AddDefaultDefinitions();
470
471
  
  cmSourceGroup& FindSourceGroup(const char* source);
472
473
474
475
};


#endif