Source/cmInstallTargetsCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmInstallTargetsCommand.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 cmInstallTargetsCommand_h
  18 #define cmInstallTargetsCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmInstallTargetsCommand
  23  * \brief Specifies where to install some targets
  24  *
  25  * cmInstallTargetsCommand specifies the relative path where a list of
  26  * targets should be installed. The targets can be executables or
  27  * libraries.
  28  */
  29 class cmInstallTargetsCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmInstallTargetsCommand;
  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                            cmExecutionStatus &status);
  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 "Deprecated. Use the install(TARGETS )  command instead.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "This command has been superceded by the install command.  It "
  67       "is provided for compatibility with older CMake code.\n"
  68       "  install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
  69       "Create rules to install the listed targets into the given directory.  "
  70       "The directory <dir> is relative to the installation prefix, which "
  71       "is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY "
  72       "is specified, then on systems with special runtime files "
  73       "(Windows DLL), the files will be copied to that directory.";
  74     }
  75
  76   /** This command is kept for compatibility with older CMake versions. */
  77   virtual bool IsDiscouraged()
  78     {
  79     return true;
  80     }
  81
  82   cmTypeMacro(cmInstallTargetsCommand, cmCommand);
  83 };
  84
  85
  86 #endif