Source/cmSubdirCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmSubdirCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:35 $
   7   Version:   $Revision: 1.7 $
   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 cmSubdirCommand_h
  18 #define cmSubdirCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmSubdirCommand
  24  * \brief Specify a list of subdirectories to build.
  25  *
  26  * cmSubdirCommand specifies a list of subdirectories to process
  27  * by CMake. For each subdirectory listed, CMake will descend
  28  * into that subdirectory and process any CMakeLists.txt found.
  29  */
  30 class cmSubdirCommand : public cmCommand
  31 {
  32 public:
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmSubdirCommand;
  39     }
  40
  41   /**
  42    * This is called when the command is first encountered in
  43    * the CMakeLists.txt file.
  44    */
  45   virtual bool InitialPass(std::vector<std::string> const& args);
  46
  47   /**
  48    * The name of the command as specified in CMakeList.txt.
  49    */
  50   virtual const char* GetName() { return "SUBDIRS";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Add a list of subdirectories to the build.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "SUBDIRS(dir1 dir2 ...)\n"
  67       "Add a list of subdirectories to the build. "
  68       "This will cause any CMakeLists.txt files in the sub directories "
  69       "to be processed by CMake.";
  70     }
  71
  72   cmTypeMacro(cmSubdirCommand, cmCommand);
  73 };
  74
  75
  76
  77 #endif