Source/cmLinkDirectoriesCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmLinkDirectoriesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:27 $
   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 cmLinkDirectoriesCommand_h
  18 #define cmLinkDirectoriesCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmLinkDirectoriesCommand
  24  * \brief Define a list of directories containing files to link.
  25  *
  26  * cmLinkDirectoriesCommand is used to specify a list
  27  * of directories containing files to link into executable(s).
  28  * Note that the command supports the use of CMake built-in variables
  29  * such as CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
  30  */
  31 class cmLinkDirectoriesCommand : public cmCommand
  32 {
  33 public:
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     return new cmLinkDirectoriesCommand;
  40     }
  41
  42   /**
  43    * This is called when the command is first encountered in
  44    * the CMakeLists.txt file.
  45    */
  46   virtual bool InitialPass(std::vector<std::string> const& args);
  47
  48   /**
  49    * This determines if the command gets propagated down
  50    * to makefiles located in subdirectories.
  51    */
  52   virtual bool IsInherited() { return true;  }
  53
  54   /**
  55    * The name of the command as specified in CMakeList.txt.
  56    */
  57   virtual const char* GetName() { return "LINK_DIRECTORIES";}
  58
  59   /**
  60    * Succinct documentation.
  61    */
  62   virtual const char* GetTerseDocumentation()
  63     {
  64     return "Specify link directories.";
  65     }
  66
  67   /**
  68    * More documentation.
  69    */
  70   virtual const char* GetFullDocumentation()
  71     {
  72     return
  73       "LINK_DIRECTORIES(directory1 directory2 ...)\n"
  74       "Specify the paths to the libraries that will be linked in.\n"
  75       "The directories can use built in definitions like \n"
  76       "CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.";
  77     }
  78
  79   cmTypeMacro(cmLinkDirectoriesCommand, cmCommand);
  80 };
  81
  82
  83
  84 #endif