CMake/Source/cmLinkLibrariesCommand.h

89 lines
2.6 KiB
C
Raw Normal View History

2001-01-11 16:04:28 +03:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-01-11 16:04:28 +03:00
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2001-01-11 16:04:28 +03:00
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
2001-01-11 16:04:28 +03:00
=========================================================================*/
2001-01-18 19:20:24 +03:00
#ifndef cmLinkLibrariesCommand_h
#define cmLinkLibrariesCommand_h
2001-01-18 19:20:24 +03:00
#include "cmCommand.h"
2001-01-18 19:20:24 +03:00
/** \class cmLinkLibrariesCommand
2001-01-11 16:04:28 +03:00
* \brief Specify a list of libraries to link into executables.
*
2001-01-18 19:20:24 +03:00
* cmLinkLibrariesCommand is used to specify a list of libraries to link
2001-01-11 16:04:28 +03:00
* into executable(s) or shared objects. The names of the libraries
2001-01-18 19:20:24 +03:00
* should be those defined by the LIBRARY(library) command(s).
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
class cmLinkLibrariesCommand : public cmCommand
{
public:
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is a virtual constructor for the command.
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
virtual cmCommand* Clone()
{
2001-01-18 19:20:24 +03:00
return new cmLinkLibrariesCommand;
}
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is called when the command is first encountered in
2001-01-11 16:04:28 +03:00
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* The name of the command as specified in CMakeList.txt.
2001-01-11 16:04:28 +03:00
*/
virtual const char* GetName() { return "link_libraries";}
2001-01-11 16:04:28 +03:00
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the target_link_libraries() command instead.";
}
2001-01-11 16:04:28 +03:00
/**
* More documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetFullDocumentation()
{
2001-01-11 16:04:28 +03:00
return
"Link libraries to all targets added later.\n"
" link_libraries(library1 <debug | optimized> library2 ...)\n"
2001-06-27 21:14:34 +04:00
"Specify a list of libraries to be linked into "
"any following targets (typically added with the add_executable "
"or add_library calls). This command is passed "
"down to all subdirectories. "
2001-06-27 21:14:34 +04:00
"The debug and optimized strings may be used to indicate that "
"the next library listed is to be used only for that specific "
"type of build.";
}
2006-09-01 17:51:28 +04:00
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
cmTypeMacro(cmLinkLibrariesCommand, cmCommand);
};
#endif