CMakeLua/Source/cmTargetLinkLibrariesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmTargetLinkLibrariesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/23 15:27:59 $
   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 cmTargetLinkLibrariesCommand_h
  18 #define cmTargetLinkLibrariesCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmTargetLinkLibrariesCommand
  23  * \brief Specify a list of libraries to link into executables.
  24  *
  25  * cmTargetLinkLibrariesCommand 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 cmTargetLinkLibrariesCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmTargetLinkLibrariesCommand;
  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 "target_link_libraries";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return
  58       "Link a target to given libraries.";
  59     }
  60
  61   /**
  62    * More documentation.
  63    */
  64   virtual const char* GetFullDocumentation()
  65     {
  66     return
  67       "  target_link_libraries(target library1\n"
  68       "                        <debug | optimized | general> library2\n"
  69       "                        ...)\n"
  70       "Specify a list of libraries to be linked into the specified target.  "
  71       "The debug and optimized strings may be used to indicate that "
  72       "the next library listed is to be used only for that specific "
  73       "type of build. general indicates it is used for all build types "
  74       "and is assumed if not specified.";
  75     }
  76
  77   cmTypeMacro(cmTargetLinkLibrariesCommand, cmCommand);
  78 private:
  79 };
  80
  81
  82
  83 #endif