CMake/Source/cmInstallFilesCommand.h

106 lines
3.2 KiB
C
Raw Normal View History

2001-05-23 19:31:43 +04:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-05-23 19:31:43 +04: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-05-23 19:31:43 +04: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-05-23 19:31:43 +04:00
=========================================================================*/
#ifndef cmInstallFilesCommand_h
#define cmInstallFilesCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmInstallFilesCommand
* \brief Specifies where to install some files
*
* cmInstallFilesCommand specifies the relative path where a list of
* files should be installed.
*/
class cmInstallFilesCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmInstallFilesCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-05-23 19:31:43 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL_FILES";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Create UNIX install rules for files.";
2001-05-23 19:31:43 +04:00
}
/**
* This is called at the end after all the information
* specified by the command is accumulated. Most commands do
* not implement this method. At this point, reading and
* writing to the cache can be done.
*/
virtual void FinalPass();
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" INSTALL_FILES(<dir> extension file file ...)\n"
"Create rules to install the listed files with the given extension "
"into the given directory. "
"Only files existing in the current source tree or its corresponding "
"location in the binary tree may be listed. "
"If a file specified already has an extension, that extension will be "
"removed first. This is useful for providing lists of source files such "
"as foo.cxx when you want the corresponding foo.h to be installed. A"
"typical extension is '.h'.\n"
" INSTALL_FILES(<dir> regexp)\n"
"Any files in the current source directory that match the regular "
"expression will be installed.\n"
" INSTALL_FILES(<dir> FILES file file ...)\n"
"Any files listed after the FILES keyword will be "
"installed explicitly from the names given. Full paths are allowed in "
"this form.\n"
"The directory <dir> is relative to the installation prefix, which "
"is stored in the variable CMAKE_INSTALL_PREFIX.";
2001-05-23 19:31:43 +04:00
}
cmTypeMacro(cmInstallFilesCommand, cmCommand);
protected:
std::string FindInstallSource(const char* name) const;
2001-05-23 19:31:43 +04:00
private:
std::string m_TargetName;
2001-05-23 19:31:43 +04:00
std::vector<std::string> m_FinalArgs;
bool m_IsFilesForm;
2001-05-23 19:31:43 +04:00
};
#endif