Source/cmOptionCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmOptionCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:31 $
   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 cmOptionCommand_h
  18 #define cmOptionCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmOptionCommand
  24  * \brief Provide an option to the user
  25  *
  26  * cmOptionCommand provides an option for the user to select
  27  */
  28 class cmOptionCommand : public cmCommand
  29 {
  30 public:
  31   /**
  32    * This is a virtual constructor for the command.
  33    */
  34   virtual cmCommand* Clone()
  35     {
  36     return new cmOptionCommand;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args);
  44
  45   /**
  46    * This determines if the command gets propagated down
  47    * to makefiles located in subdirectories.
  48    */
  49   virtual bool IsInherited() {return true;}
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() {return "OPTION";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "Provides an option that the user can optionally select";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "OPTION(USE_MPI \"help string decribing the option\" [initial value])\n"
  71       "Provide an option for the user to select";
  72     }
  73
  74   cmTypeMacro(cmOptionCommand, cmCommand);
  75 };
  76
  77
  78
  79 #endif