Source/cmInstallTargetsCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmInstallTargetsCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:27 $
   7   Version:   $Revision: 1.4 $
   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 cmInstallTargetsCommand_h
  18 #define cmInstallTargetsCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmInstallTargetsCommand
  24  * \brief Specifies where to install some targets
  25  *
  26  * cmInstallTargetsCommand specifies the relative path where a list of
  27  * targets should be installed. The targets can be executables or
  28  * libraries.
  29  */
  30 class cmInstallTargetsCommand : public cmCommand
  31 {
  32 public:
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmInstallTargetsCommand;
  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() { return "INSTALL_TARGETS";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Create install rules for targets";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "INSTALL_TARGETS(path target target)\n"
  67       "Create rules to install the listed targets into the path. Path is relative to the variable PREFIX";
  68     }
  69
  70   cmTypeMacro(cmInstallTargetsCommand, cmCommand);
  71 };
  72
  73
  74 #endif