CMake/Source/cmLinkDirectoriesCommand.h

84 lines
2.1 KiB
C
Raw Normal View History

2001-01-11 16:04:28 +03:00
/*=========================================================================
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.
=========================================================================*/
2001-01-18 19:20:24 +03:00
#ifndef cmLinkDirectoriesCommand_h
#define cmLinkDirectoriesCommand_h
#include "cmStandardIncludes.h"
2001-01-18 19:20:24 +03:00
#include "cmCommand.h"
2001-01-18 19:20:24 +03:00
/** \class cmLinkDirectoriesCommand
2001-01-11 16:04:28 +03:00
* \brief Define a list of directories containing files to link.
*
2001-01-18 19:20:24 +03:00
* cmLinkDirectoriesCommand is used to specify a list
2001-01-11 16:04:28 +03:00
* of directories containing files to link into executable(s).
2001-01-18 19:20:24 +03:00
* Note that the command supports the use of CMake built-in variables
2001-01-11 16:04:28 +03:00
* such as CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
*/
2001-01-18 19:20:24 +03:00
class cmLinkDirectoriesCommand : 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 cmLinkDirectoriesCommand;
}
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 Invoke(std::vector<std::string>& args);
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This determines if the command gets propagated down
2001-01-11 16:04:28 +03:00
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() { return true; }
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_DIRECTORIES";}
2001-01-11 16:04:28 +03:00
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation()
{
2001-01-11 16:04:28 +03:00
return "Specify link directories.";
}
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_DIRECTORIES(directory1 directory2 ...)\n"
2001-01-12 22:35:15 +03:00
"Specify the paths to the libraries that will be linked in.\n"
2001-01-11 16:04:28 +03:00
"The directories can use built in definitions like \n"
"CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.";
}
cmTypeMacro(cmLinkDirectoriesCommand, cmCommand);
};
#endif