cmMakefile.h 12.6 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
#include "cmTarget.h"
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
                        const char* command,
                        const std::vector<std::string>& depends,
80
81
                        const std::vector<std::string>& outputs,
                        const char *target);
82
83
84
85

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

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

99
  /**
Ken Martin's avatar
Ken Martin committed
100
101
102
   * 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.  
103
104
105
106
107
108
109
110
   */
  void AddUtility(const char*);

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

111
112
113
  /**
   * Add a link library to the build.
   */
114
  void AddLinkLibrary(const char*);
115
116
117
118

  /**
   * Add a link directory to the build.
   */
119
  void AddLinkDirectory(const char*);
120
121
122
123

  /**
   * Add a subdirectory to the build.
   */
124
  void AddSubDirectory(const char*);
125
126
127
128

  /**
   * Add an include directory to the build.
   */
129
  void AddIncludeDirectory(const char*);
130
131
132
133
134

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

  /**
   * Specify the name of the project for this build.
   */
140
  void SetProjectName(const char*);
141
142
143
144
145
146
147
148
149
150
151
152

  /**
   * Get the name of the project for this build.
   */
  const char* GetProjectName()
    {
    return m_ProjectName.c_str();
    }
  
  /**
   * Set the name of the library.
   */
153
  void AddLibrary(const char *libname, const std::vector<std::string> &srcs);
154
155
156
157

  /**
   * Add a class/source file to the build.
   */
158
  void AddClass(cmClassFile& ,const char *srcListName);
159

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

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

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

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

275
  /**
276
   * Get the list of targets
277
   */
278
  const cmTargets &GetTargets() { return m_Targets; }
279
280
281
282

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

  /**
   * Get a list of include directories in the build.
   */
291
292
  std::vector<std::string>& GetIncludeDirectories()
    { 
293
    return m_IncludeDirectories;
294
    }
295
296
297
298

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

320
321
322
  /**
   * Get a list of link libraries in the build.
   */
323
324
  std::vector<std::string>& GetLinkLibraries()
    { 
325
    return m_LinkLibraries;
326
    }
327
328
329
330

  /**
   * Get a list of Win32 link libraries in the build.
   */
331
332
  std::vector<std::string>& GetLinkLibrariesWin32()
    { 
333
    return m_LinkLibrariesWin32;
334
335
    }
  
336
337
338
  /**
   * Get a list of Unix link libraries in the build.
   */
339
340
  std::vector<std::string>& GetLinkLibrariesUnix()
    { 
341
    return m_LinkLibrariesUnix;
342
    }
343
344
345
346

  /**
   * Return a list of source files in this makefile.
   */
347
348
349
350
351
352
353
354
355
356
357
  typedef std::map<std::string,std::vector<cmClassFile> > ClassMap;
  ClassMap &GetClasses() {return  m_Classes;}
  cmClassFile *GetClass(const char *srclist, const char *className);
  
    
  /**
   * Return a list of classes in the passed source lists
   */
  std::vector<cmClassFile> GetClassesFromSourceLists(
    const std::vector<std::string> &srcLists);
  
358
359
360
  /**
   * Obtain a list of auxiliary source directories.
   */
361
  std::vector<std::string>& GetAuxSourceDirectories()
362
    {return m_AuxSourceDirectories;}
363

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

370
371
  /**
   * Given a variable name, return its value (as a string).
372
   */
373
374
  const char* GetDefinition(const char*);

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

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

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

427
428
429
430
431
432
  /**
   * find what source group this source is in
   */
  cmSourceGroup& FindSourceGroup(const char* source,
                                 std::vector<cmSourceGroup> &groups);

433
434
protected:
  std::string m_Prefix;
435
  std::vector<std::string> m_AuxSourceDirectories; // 
Ken Martin's avatar
Ken Martin committed
436
437
438
439
440
441
442
443

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

444
  std::string m_ProjectName;	// project name
445
446
447
448
449

  // libraries, classes, and executables
  cmTargets m_Targets;
  ClassMap m_Classes; 

450
  std::vector<std::string> m_SubDirectories; // list of sub directories
451
  std::vector<std::string> m_MakeVerbatim; // lines copied from input file
452
453
  std::vector<std::string> m_IncludeDirectories;
  std::vector<std::string> m_LinkDirectories;
454
455
  std::vector<std::string> m_Utilities;
  std::vector<std::string> m_UtilityDirectories;
456
457
458
  std::vector<std::string> m_LinkLibraries;
  std::vector<std::string> m_LinkLibrariesWin32;
  std::vector<std::string> m_LinkLibrariesUnix;
459
  std::string m_IncludeFileRegularExpression;
460
  std::string m_DefineFlags;
461
  std::vector<cmSourceGroup> m_SourceGroups;
462
  typedef std::map<std::string, cmCommand*> RegisteredCommandsMap;
463
464
  typedef std::map<std::string, std::string> DefinitionMap;
  DefinitionMap m_Definitions;
465
466
  RegisteredCommandsMap m_Commands;
  std::vector<cmCommand*> m_UsedCommands;
467
  cmMakefileGenerator* m_MakefileGenerator;
468
  
469
  
470
private:
Ken Martin's avatar
Ken Martin committed
471
472
473
  /**
   * Get the name of the parent directories CMakeLists file
   * given a current CMakeLists file name
474
   */
Ken Martin's avatar
Ken Martin committed
475
  std::string GetParentListFileName(const char *listFileName);
476
477
478
479
480

  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);
481
  void AddDefaultCommands();
482
  void AddDefaultDefinitions();
483
  
484
485
486
487
};


#endif