CMakeLua/Source/cmLinkDirectoriesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmLinkDirectoriesCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmLinkDirectoriesCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.13 $
   9 =======
  10   Date:      $Date: 2009-01-29 19:14:02 $
  11   Version:   $Revision: 1.14 $
  12 >>>>>>> 1.14
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmLinkDirectoriesCommand_h
  23 #define cmLinkDirectoriesCommand_h
  24
  25 #include "cmCommand.h"
  26
  27 /** \class cmLinkDirectoriesCommand
  28  * \brief Define a list of directories containing files to link.
  29  *
  30  * cmLinkDirectoriesCommand is used to specify a list
  31  * of directories containing files to link into executable(s).
  32  * Note that the command supports the use of CMake built-in variables
  33  * such as CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
  34  */
  35 class cmLinkDirectoriesCommand : public cmCommand
  36 {
  37 public:
  38   /**
  39    * This is a virtual constructor for the command.
  40    */
  41   virtual cmCommand* Clone()
  42     {
  43     return new cmLinkDirectoriesCommand;
  44     }
  45
  46   /**
  47    * This is called when the command is first encountered in
  48    * the CMakeLists.txt file.
  49    */
  50   virtual bool InitialPass(std::vector<std::string> const& args,
  51                            cmExecutionStatus &status);
  52
  53   /**
  54    * The name of the command as specified in CMakeList.txt.
  55    */
  56   virtual const char* GetName() { return "link_directories";}
  57
  58   /**
  59    * Succinct documentation.
  60    */
  61   virtual const char* GetTerseDocumentation()
  62     {
  63     return "Specify directories in which the linker will look for libraries.";
  64     }
  65
  66   /**
  67    * More documentation.
  68    */
  69   virtual const char* GetFullDocumentation()
  70     {
  71     return
  72       "  link_directories(directory1 directory2 ...)\n"
  73       "Specify the paths in which the linker should search for libraries. "
  74       "The command will apply only to targets created after it is called. "
  75       "For historical reasons, relative paths given to this command are "
  76       "passed to the linker unchanged "
  77       "(unlike many CMake commands which interpret them relative to the "
  78       "current source directory)."
  79       ;
  80     }
  81
  82   cmTypeMacro(cmLinkDirectoriesCommand, cmCommand);
  83 };
  84
  85
  86
  87 #endif