Source/cmLocalGenerator.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmLocalGenerator.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-09-15 12:53:54 $
   7   Version:   $Revision: 1.5 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmLocalGenerator_h
  18 #define cmLocalGenerator_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 class cmMakefile;
  23 class cmGlobalGenerator;
  24
  25 /** \class cmLocalGenerator
  26  * \brief Create required build files for a directory.
  27  *
  28  * Subclasses of this abstract class generate makefiles, DSP, etc for various
  29  * platforms. This class should never be constructued directly. A
  30  * GlobalGenerator will create it and invoke the appropriate commands on it.
  31  */
  32 class cmLocalGenerator
  33 {
  34 public:
  35   cmLocalGenerator();
  36   virtual ~cmLocalGenerator();
  37
  38   /**
  39    * Generate the makefile for this directory. fromTheTop indicates if this
  40    * is being invoked as part of a global Generate or specific to this
  41    * directory. The difference is that when done from the Top we might skip
  42    * some steps to save time, such as dependency generation for the
  43    * makefiles. This is done by a direct invocation from make.
  44    */
  45   virtual void Generate(bool /* fromTheTop */) {};
  46
  47   /**
  48    * Process the CMakeLists files for this directory to fill in the
  49    * m_Makefile ivar
  50    */
  51   virtual void Configure();
  52
  53   /**
  54    * Perform any final calculations prior to generation
  55    */
  56   virtual void ConfigureFinalPass();
  57
  58   ///! Get the makefile for this generator
  59   cmMakefile *GetMakefile() {
  60     return this->m_Makefile; };
  61
  62   ///! Get the GlobalGenerator this is associated with
  63   cmGlobalGenerator *GetGlobalGenerator() {
  64     return m_GlobalGenerator; };
  65
  66   ///! Set the Global Generator, done on creation by the GlobalGenerator
  67   void SetGlobalGenerator(cmGlobalGenerator *gg);
  68
  69 protected:
  70   bool m_FromTheTop;
  71   cmMakefile *m_Makefile;
  72   cmGlobalGenerator *m_GlobalGenerator;
  73 };
  74
  75 #endif