Source/cmExecProgramCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmExecProgramCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-04-03 21:14:06 $
   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 cmExecProgramCommand_h
  18 #define cmExecProgramCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmExecProgramCommand
  24  * \brief Command that adds a target to the build system.
  25  *
  26  * cmExecProgramCommand adds an extra target to the build system.
  27  * This is useful when you would like to add special
  28  * targets like "install,", "clean," and so on.
  29  */
  30 class cmExecProgramCommand : public cmCommand
  31 {
  32 public:
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmExecProgramCommand;
  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()
  51     {return "EXEC_PROGRAM";}
  52
  53   /**
  54    * Succinct documentation.
  55    */
  56   virtual const char* GetTerseDocumentation()
  57     {
  58     return "Run and executable program during the processing of the CMakeList.txt file.";
  59     }
  60
  61   /**
  62    * More documentation.
  63    */
  64   virtual const char* GetFullDocumentation()
  65     {
  66     return
  67       "EXEC_PROGRAM(Executable [Directory to run in] [ARGS arguments to executable])"
  68       "The executable is run in the optionally specified Directory.  The executable "
  69       "can include arguments if it is double quoted, but it is better to use the "
  70       "optional ARGS argument to specify arguments to the program.   This is because "
  71       "cmake will then be able to escape spaces in the Executable path.";
  72     }
  73
  74   cmTypeMacro(cmExecProgramCommand, cmCommand);
  75 };
  76
  77 #endif