Source/cmMessageCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmMessageCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-03-29 15:56:07 $
   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 cmMessageCommand_h
  18 #define cmMessageCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmMessageCommand
  24  * \brief Displays a message to the user
  25  *
  26  */
  27 class cmMessageCommand : public cmCommand
  28 {
  29 public:
  30   /**
  31    * This is a virtual constructor for the command.
  32    */
  33   virtual cmCommand* Clone()
  34     {
  35     return new cmMessageCommand;
  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    * The name of the command as specified in CMakeList.txt.
  46    */
  47   virtual const char* GetName() { return "MESSAGE";}
  48
  49   /**
  50    * Succinct documentation.
  51    */
  52   virtual const char* GetTerseDocumentation()
  53     {
  54     return "Display a message to the user.";
  55     }
  56
  57   /**
  58    * More documentation.
  59    */
  60   virtual const char* GetFullDocumentation()
  61     {
  62     return
  63       "MESSAGE([SEND_ERROR] \"message to display\"...)\n"
  64       "The arguments are messages to display. If the first argument is SEND_ERROR then an error is raised.";
  65     }
  66
  67   cmTypeMacro(cmMessageCommand, cmCommand);
  68 };
  69
  70
  71 #endif