Source/cmMessageCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmMessageCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.16 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html 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 "cmCommand.h"
  21
  22 /** \class cmMessageCommand
  23  * \brief Displays a message to the user
  24  *
  25  */
  26 class cmMessageCommand : public cmCommand
  27 {
  28 public:
  29   /**
  30    * This is a virtual constructor for the command.
  31    */
  32   virtual cmCommand* Clone()
  33     {
  34     return new cmMessageCommand;
  35     }
  36
  37   /**
  38    * This is called when the command is first encountered in
  39    * the CMakeLists.txt file.
  40    */
  41   virtual bool InitialPass(std::vector<std::string> const& args,
  42                            cmExecutionStatus &status);
  43
  44   /**
  45    * The name of the command as specified in CMakeList.txt.
  46    */
  47   virtual const char* GetName() { return "message";}
  48
  49   /**
  50    * This determines if the command is invoked when in script mode.
  51    */
  52   virtual bool IsScriptable() { return true; }
  53
  54   /**
  55    * Succinct documentation.
  56    */
  57   virtual const char* GetTerseDocumentation()
  58     {
  59     return "Display a message to the user.";
  60     }
  61
  62   /**
  63    * More documentation.
  64    */
  65   virtual const char* GetFullDocumentation()
  66     {
  67     return
  68       "  message([SEND_ERROR | STATUS | FATAL_ERROR]\n"
  69       "          \"message to display\" ...)\n"
  70       "By default the message is displayed in a pop up window (CMakeSetup), "
  71       "or in the stdout of cmake, or the error section of ccmake. "
  72       "If the first argument is "
  73       "SEND_ERROR then an error is raised, and the generate phase will "
  74       "be skipped.  If the first argument is FATAL_ERROR, all processing "
  75       "is halted. If the first argument is STATUS then the message is "
  76       "displayed in the progress line for the GUI, or with a -- in the "
  77       "command line cmake.";
  78     }
  79
  80   cmTypeMacro(cmMessageCommand, cmCommand);
  81 };
  82
  83
  84 #endif