diff options
Diffstat (limited to 'Source/cmLinkDirectoriesCommand.h')
-rw-r--r-- | Source/cmLinkDirectoriesCommand.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/Source/cmLinkDirectoriesCommand.h b/Source/cmLinkDirectoriesCommand.h new file mode 100644 index 0000000000..783c8802f1 --- /dev/null +++ b/Source/cmLinkDirectoriesCommand.h @@ -0,0 +1,81 @@ +/*========================================================================= + + Program: Insight Segmentation & Registration Toolkit + Module: $RCSfile$ + Language: C++ + Date: $Date$ + Version: $Revision$ + + + Copyright (c) 2000 National Library of Medicine + All rights reserved. + + See COPYRIGHT.txt for copyright details. + +=========================================================================*/ +#ifndef cmLinkDirectoriesCommand_h +#define cmLinkDirectoriesCommand_h + +#include "cmStandardIncludes.h" +#include "cmCommand.h" + +/** \class cmLinkDirectoriesCommand + * \brief Define a list of directories containing files to link. + * + * cmLinkDirectoriesCommand is used to specify a list + * of directories containing files to link into executable(s). + * Note that the command supports the use of CMake built-in variables + * such as CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR. + */ +class cmLinkDirectoriesCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmLinkDirectoriesCommand; + } + + /** + * This is called when the command is first encountered in + * the CMakeLists.txt file. + */ + virtual bool Invoke(std::vector<std::string>& args); + + /** + * This determines if the command gets propagated down + * to makefiles located in subdirectories. + */ + virtual bool IsInherited() { return true; } + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() { return "LINK_DIRECTORIES";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() + { + return "Specify link directories."; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() + { + return + "LINK_DIRECTORIES(directory1 directory2 ...)\n" + "Specify the paths to the libraries that will be linked in.\n" + "The directories can use built in definitions like \n" + "CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR."; + } +}; + + + +#endif |