CMake/Source/cmInstallFilesCommand.h

102 lines
3.1 KiB
C++

/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
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.
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.
=========================================================================*/
#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);
/**
* 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 install rules for files";
}
/**
* 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(path extension file file ...)\n"
"INSTALL_FILES(path regexp)\n"
"INSTALL_FILES(path FILES file file ...)\n"
"Create rules to install the listed files into the path. Path is\n"
"relative to the variable CMAKE_INSTALL_PREFIX. There are three forms for\n"
"this command. In the first the files can be specified explicitly. If a\n"
"file specified already has an extension, that extension will be\n"
"removed first. This is useful for providing lists of source files such\n"
"as foo.cxx when you want the corresponding foo.h to be installed. A\n"
"typical extension is .h etc... In the second form any files in the\n"
"current directory that match the regular expression will be installed.\n"
"In the third form, any files listed after the FILES keyword will be\n"
"installed explicitly from the names given. Full paths are allowed in\n"
"this form.";
}
cmTypeMacro(cmInstallFilesCommand, cmCommand);
protected:
std::string FindInstallSource(const char* name) const;
private:
std::string m_TargetName;
std::vector<std::string> m_FinalArgs;
bool m_IsFilesForm;
};
#endif