Source/cmAddExecutableCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmAddExecutableCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:18 $
   7   Version:   $Revision: 1.6 $
   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 cmExecutablesCommand_h
  18 #define cmExecutablesCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmExecutablesCommand
  24  * \brief Defines a list of executables to build.
  25  *
  26  * cmExecutablesCommand defines a list of executable (i.e., test)
  27  * programs to create.
  28  */
  29 class cmAddExecutableCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmAddExecutableCommand;
  38     }
  39
  40   /**
  41    * This is called when the command is first encountered in
  42    * the CMakeLists.txt file.
  43    */
  44   virtual bool InitialPass(std::vector<std::string> const& args);
  45
  46   /**
  47    * The name of the command as specified in CMakeList.txt.
  48    */
  49   virtual const char* GetName() { return "ADD_EXECUTABLE";}
  50
  51   /**
  52    * Succinct documentation.
  53    */
  54   virtual const char* GetTerseDocumentation()
  55     {
  56     return "Add an executable to the project that uses the specified srclists";
  57     }
  58
  59   /**
  60    * More documentation.
  61    */
  62   virtual const char* GetFullDocumentation()
  63     {
  64     return
  65       "ADD_EXECUTABLE(exename srclist srclist srclist ...)\n"
  66       "ADD_EXECUTABLE(exename WIN32 srclist srclist srclist ...)"
  67       "This command adds an executable target to the current directory. "
  68       "The executable will be built from the source files / source lists "
  69       "specified. The second argument to this command can be WIN32 "
  70       "which indicates that the executable (when compiled on windows) "
  71       "is a windows app (using WinMain)not a console app (using main).";
  72     }
  73
  74   cmTypeMacro(cmAddExecutableCommand, cmCommand);
  75 };
  76
  77
  78 #endif