Source/cmLinkLibrariesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmLinkLibrariesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.20 $
   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 cmLinkLibrariesCommand_h
  18 #define cmLinkLibrariesCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmLinkLibrariesCommand
  23  * \brief Specify a list of libraries to link into executables.
  24  *
  25  * cmLinkLibrariesCommand is used to specify a list of libraries to link
  26  * into executable(s) or shared objects. The names of the libraries
  27  * should be those defined by the LIBRARY(library) command(s).
  28  */
  29 class cmLinkLibrariesCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmLinkLibrariesCommand;
  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                            cmExecutionStatus &status);
  46
  47   /**
  48    * The name of the command as specified in CMakeList.txt.
  49    */
  50   virtual const char* GetName() { return "link_libraries";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Deprecated. Use the target_link_libraries() command instead.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "Link libraries to all targets added later.\n"
  67       "  link_libraries(library1 <debug | optimized> library2 ...)\n"
  68       "Specify a list of libraries to be linked into "
  69       "any following targets (typically added with the add_executable "
  70       "or add_library calls).  This command is passed "
  71       "down to all subdirectories.  "
  72       "The debug and optimized strings may be used to indicate that "
  73       "the next library listed is to be used only for that specific "
  74       "type of build.";
  75     }
  76
  77   /** This command is kept for compatibility with older CMake versions. */
  78   virtual bool IsDiscouraged()
  79     {
  80     return true;
  81     }
  82
  83   cmTypeMacro(cmLinkLibrariesCommand, cmCommand);
  84 };
  85
  86
  87
  88 #endif