Source/cmLinkDirectoriesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmLinkDirectoriesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-01-29 19:14:02 $
   7   Version:   $Revision: 1.14 $
   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 cmLinkDirectoriesCommand_h
  18 #define cmLinkDirectoriesCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmLinkDirectoriesCommand
  23  * \brief Define a list of directories containing files to link.
  24  *
  25  * cmLinkDirectoriesCommand is used to specify a list
  26  * of directories containing files to link into executable(s).
  27  * Note that the command supports the use of CMake built-in variables
  28  * such as CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
  29  */
  30 class cmLinkDirectoriesCommand : public cmCommand
  31 {
  32 public:
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmLinkDirectoriesCommand;
  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                            cmExecutionStatus &status);
  47
  48   /**
  49    * The name of the command as specified in CMakeList.txt.
  50    */
  51   virtual const char* GetName() { return "link_directories";}
  52
  53   /**
  54    * Succinct documentation.
  55    */
  56   virtual const char* GetTerseDocumentation()
  57     {
  58     return "Specify directories in which the linker will look for libraries.";
  59     }
  60
  61   /**
  62    * More documentation.
  63    */
  64   virtual const char* GetFullDocumentation()
  65     {
  66     return
  67       "  link_directories(directory1 directory2 ...)\n"
  68       "Specify the paths in which the linker should search for libraries. "
  69       "The command will apply only to targets created after it is called. "
  70       "For historical reasons, relative paths given to this command are "
  71       "passed to the linker unchanged "
  72       "(unlike many CMake commands which interpret them relative to the "
  73       "current source directory)."
  74       ;
  75     }
  76
  77   cmTypeMacro(cmLinkDirectoriesCommand, cmCommand);
  78 };
  79
  80
  81
  82 #endif