Source/cmElseCommand.h

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