Source/cmInstallProgramsCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmInstallProgramsCommand.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 cmInstallProgramsCommand_h
  18 #define cmInstallProgramsCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmInstallProgramsCommand
  24  * \brief Specifies where to install some programs
  25  *
  26  * cmInstallProgramsCommand specifies the relative path where a list of
  27  * programs should be installed.
  28  */
  29 class cmInstallProgramsCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmInstallProgramsCommand;
  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 "INSTALL_PROGRAMS";}
  50
  51   /**
  52    * Succinct documentation.
  53    */
  54   virtual const char* GetTerseDocumentation()
  55     {
  56     return "Create install rules for programs";
  57     }
  58
  59   /**
  60    * This is called at the end after all the information
  61    * specified by the command is accumulated. Most commands do
  62    * not implement this method.  At this point, reading and
  63    * writing to the cache can be done.
  64    */
  65   virtual void FinalPass();
  66
  67   /**
  68    * More documentation.
  69    */
  70   virtual const char* GetFullDocumentation()
  71     {
  72     return
  73       "INSTALL_PROGRAMS(path file file ...)\n"
  74       "INSTALL_PROGRAMS(path regexp)\n"
  75       "Create rules to install the listed programs into the path. Path is relative to the variable CMAKE_INSTALL_PREFIX. There are two forms for this command. In the first the programs can be specified explicitly.  In the second form any program in the current directory that match the regular expression will be installed.";
  76     }
  77
  78   cmTypeMacro(cmInstallProgramsCommand, cmCommand);
  79
  80  private:
  81   std::string m_TargetName;
  82   std::vector<std::string> m_FinalArgs;
  83 };
  84
  85
  86 #endif