Source/cmInstallTargetsCommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmInstallTargetsCommand_h
  13 #define cmInstallTargetsCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 /** \class cmInstallTargetsCommand
  18  * \brief Specifies where to install some targets
  19  *
  20  * cmInstallTargetsCommand specifies the relative path where a list of
  21  * targets should be installed. The targets can be executables or
  22  * libraries.
  23  */
  24 class cmInstallTargetsCommand : public cmCommand
  25 {
  26 public:
  27   /**
  28    * This is a virtual constructor for the command.
  29    */
  30   virtual cmCommand* Clone()
  31     {
  32     return new cmInstallTargetsCommand;
  33     }
  34
  35   /**
  36    * This is called when the command is first encountered in
  37    * the CMakeLists.txt file.
  38    */
  39   virtual bool InitialPass(std::vector<std::string> const& args,
  40                            cmExecutionStatus &status);
  41
  42   /**
  43    * The name of the command as specified in CMakeList.txt.
  44    */
  45   virtual const char* GetName() const { return "install_targets";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation() const
  51     {
  52     return "Deprecated. Use the install(TARGETS )  command instead.";
  53     }
  54
  55   /**
  56    * More documentation.
  57    */
  58   virtual const char* GetFullDocumentation() const
  59     {
  60     return
  61       "This command has been superceded by the install command.  It "
  62       "is provided for compatibility with older CMake code.\n"
  63       "  install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
  64       "Create rules to install the listed targets into the given directory.  "
  65       "The directory <dir> is relative to the installation prefix, which "
  66       "is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY "
  67       "is specified, then on systems with special runtime files "
  68       "(Windows DLL), the files will be copied to that directory.";
  69     }
  70
  71   /** This command is kept for compatibility with older CMake versions. */
  72   virtual bool IsDiscouraged() const
  73     {
  74     return true;
  75     }
  76
  77   cmTypeMacro(cmInstallTargetsCommand, cmCommand);
  78 };
  79
  80
  81 #endif