219 lines
10 KiB
C++
219 lines
10 KiB
C++
/*============================================================================
|
|
CMake - Cross Platform Makefile Generator
|
|
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
|
|
|
|
Distributed under the OSI-approved BSD License (the "License");
|
|
see accompanying file Copyright.txt for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
See the License for more information.
|
|
============================================================================*/
|
|
#ifndef cmFileCommand_h
|
|
#define cmFileCommand_h
|
|
|
|
#include "cmCommand.h"
|
|
|
|
struct cmFileInstaller;
|
|
|
|
/** \class cmFileCommand
|
|
* \brief Command for manipulation of files
|
|
*
|
|
*/
|
|
class cmFileCommand : public cmCommand
|
|
{
|
|
public:
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
return new cmFileCommand;
|
|
}
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool InitialPass(std::vector<std::string> const& args,
|
|
cmExecutionStatus &status);
|
|
|
|
/**
|
|
* This determines if the command is invoked when in script mode.
|
|
*/
|
|
virtual bool IsScriptable() { return true; }
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "file";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "File manipulation command.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" file(WRITE filename \"message to write\"... )\n"
|
|
" file(APPEND filename \"message to write\"... )\n"
|
|
" file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])\n"
|
|
" file(STRINGS filename variable [LIMIT_COUNT num]\n"
|
|
" [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]\n"
|
|
" [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]\n"
|
|
" [NEWLINE_CONSUME] [REGEX regex]\n"
|
|
" [NO_HEX_CONVERSION])\n"
|
|
" file(GLOB variable [RELATIVE path] [globbing expressions]...)\n"
|
|
" file(GLOB_RECURSE variable [RELATIVE path] \n"
|
|
" [FOLLOW_SYMLINKS] [globbing expressions]...)\n"
|
|
" file(RENAME <oldname> <newname>)\n"
|
|
" file(REMOVE [file1 ...])\n"
|
|
" file(REMOVE_RECURSE [file1 ...])\n"
|
|
" file(MAKE_DIRECTORY [directory1 directory2 ...])\n"
|
|
" file(RELATIVE_PATH variable directory file)\n"
|
|
" file(TO_CMAKE_PATH path result)\n"
|
|
" file(TO_NATIVE_PATH path result)\n"
|
|
" file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log])\n"
|
|
"WRITE will write a message into a file called 'filename'. It "
|
|
"overwrites the file if it already exists, and creates the file "
|
|
"if it does not exist.\n"
|
|
"APPEND will write a message into a file same as WRITE, except "
|
|
"it will append it to the end of the file\n"
|
|
"READ will read the content of a file and store it into the "
|
|
"variable. It will start at the given offset and read up to numBytes. "
|
|
"If the argument HEX is given, the binary data will be converted to "
|
|
"hexadecimal representation and this will be stored in the variable.\n"
|
|
"STRINGS will parse a list of ASCII strings from a file and "
|
|
"store it in a variable. Binary data in the file are ignored. Carriage "
|
|
"return (CR) characters are ignored. It works also for Intel Hex and "
|
|
"Motorola S-record files, which are automatically converted to binary "
|
|
"format when reading them. Disable this using NO_HEX_CONVERSION.\n"
|
|
"LIMIT_COUNT sets the maximum number of strings to return. "
|
|
"LIMIT_INPUT sets the maximum number of bytes to read from "
|
|
"the input file. "
|
|
"LIMIT_OUTPUT sets the maximum number of bytes to store in the "
|
|
"output variable. "
|
|
"LENGTH_MINIMUM sets the minimum length of a string to return. "
|
|
"Shorter strings are ignored. "
|
|
"LENGTH_MAXIMUM sets the maximum length of a string to return. Longer "
|
|
"strings are split into strings no longer than the maximum length. "
|
|
"NEWLINE_CONSUME allows newlines to be included in strings instead "
|
|
"of terminating them.\n"
|
|
"REGEX specifies a regular expression that a string must match to be "
|
|
"returned. Typical usage \n"
|
|
" file(STRINGS myfile.txt myfile)\n"
|
|
"stores a list in the variable \"myfile\" in which each item is "
|
|
"a line from the input file.\n"
|
|
"GLOB will generate a list of all files that match the globbing "
|
|
"expressions and store it into the variable. Globbing expressions "
|
|
"are similar to regular expressions, but much simpler. If RELATIVE "
|
|
"flag is specified for an expression, the results will be returned "
|
|
"as a relative path to the given path.\n"
|
|
"Examples of globbing expressions include:\n"
|
|
" *.cxx - match all files with extension cxx\n"
|
|
" *.vt? - match all files with extension vta,...,vtz\n"
|
|
" f[3-5].txt - match files f3.txt, f4.txt, f5.txt\n"
|
|
"GLOB_RECURSE will generate a list similar to the regular GLOB, except "
|
|
"it will traverse all the subdirectories of the matched directory and "
|
|
"match the files. Subdirectories that are symlinks are only traversed "
|
|
"if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. "
|
|
"See cmake --help-policy CMP0009 for more information.\n"
|
|
"Examples of recursive globbing include:\n"
|
|
" /dir/*.py - match all python files in /dir and subdirectories\n"
|
|
"MAKE_DIRECTORY will create the given directories, also if their parent "
|
|
"directories don't exist yet\n"
|
|
"RENAME moves a file or directory within a filesystem, "
|
|
"replacing the destination atomically."
|
|
"\n"
|
|
"REMOVE will remove the given files, also in subdirectories\n"
|
|
"REMOVE_RECURSE will remove the given files and directories, also "
|
|
"non-empty directories\n"
|
|
"RELATIVE_PATH will determine relative path from directory to the given"
|
|
" file.\n"
|
|
"TO_CMAKE_PATH will convert path into a cmake style path with unix /. "
|
|
" The input can be a single path or a system path like \"$ENV{PATH}\". "
|
|
" Note the double quotes around the ENV call TO_CMAKE_PATH only takes "
|
|
" one argument.\n"
|
|
"TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from "
|
|
" a cmake style path into the native path style \\ for windows and / "
|
|
"for UNIX.\n"
|
|
"DOWNLOAD will download the given URL to the given file. "
|
|
"If LOG var is specified a log of the download will be put in var. "
|
|
"If STATUS var is specified the status of the operation will"
|
|
" be put in var. The status is returned in a list of length 2. "
|
|
"The first element is the numeric return value for the operation, "
|
|
"and the second element is a string value for the error. A 0 "
|
|
"numeric error means no error in the operation. "
|
|
"If TIMEOUT time is specified, the operation will "
|
|
"timeout after time seconds, time should be specified as an integer."
|
|
"\n"
|
|
"The file() command also provides COPY and INSTALL signatures:\n"
|
|
" file(<COPY|INSTALL> files... DESTINATION <dir>\n"
|
|
" [FILE_PERMISSIONS permissions...]\n"
|
|
" [DIRECTORY_PERMISSIONS permissions...]\n"
|
|
" [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]\n"
|
|
" [FILES_MATCHING]\n"
|
|
" [[PATTERN <pattern> | REGEX <regex>]\n"
|
|
" [EXCLUDE] [PERMISSIONS permissions...]] [...])\n"
|
|
"The COPY signature copies files, directories, and symlinks to a "
|
|
"destination folder. "
|
|
"Relative input paths are evaluated with respect to the current "
|
|
"source directory, and a relative destination is evaluated with "
|
|
"respect to the current build directory. "
|
|
"Copying preserves input file timestamps, and optimizes out a file "
|
|
"if it exists at the destination with the same timestamp. "
|
|
"Copying preserves input permissions unless explicit permissions or "
|
|
"NO_SOURCE_PERMISSIONS are given (default is USE_SOURCE_PERMISSIONS). "
|
|
"See the install(DIRECTORY) command for documentation of permissions, "
|
|
"PATTERN, REGEX, and EXCLUDE options. "
|
|
"\n"
|
|
"The INSTALL signature differs slightly from COPY: "
|
|
"it prints status messages, and NO_SOURCE_PERMISSIONS is default. "
|
|
"Installation scripts generated by the install() command use this "
|
|
"signature (with some undocumented options for internal use)."
|
|
// Undocumented INSTALL options:
|
|
// - RENAME <name>
|
|
// - OPTIONAL
|
|
// - FILES keyword to re-enter files... list
|
|
// - PERMISSIONS before REGEX is alias for FILE_PERMISSIONS
|
|
// - DIR_PERMISSIONS is alias for DIRECTORY_PERMISSIONS
|
|
// - TYPE <FILE|DIRECTORY|EXECUTABLE|PROGRAM|
|
|
// STATIC_LIBRARY|SHARED_LIBRARY|MODULE>
|
|
// - COMPONENTS, CONFIGURATIONS, PROPERTIES (ignored for compat)
|
|
;
|
|
}
|
|
|
|
cmTypeMacro(cmFileCommand, cmCommand);
|
|
|
|
protected:
|
|
bool HandleRename(std::vector<std::string> const& args);
|
|
bool HandleRemove(std::vector<std::string> const& args, bool recurse);
|
|
bool HandleWriteCommand(std::vector<std::string> const& args, bool append);
|
|
bool HandleReadCommand(std::vector<std::string> const& args);
|
|
bool HandleStringsCommand(std::vector<std::string> const& args);
|
|
bool HandleGlobCommand(std::vector<std::string> const& args, bool recurse);
|
|
bool HandleMakeDirectoryCommand(std::vector<std::string> const& args);
|
|
|
|
bool HandleRelativePathCommand(std::vector<std::string> const& args);
|
|
bool HandleCMakePathCommand(std::vector<std::string> const& args,
|
|
bool nativePath);
|
|
bool HandleRPathChangeCommand(std::vector<std::string> const& args);
|
|
bool HandleRPathCheckCommand(std::vector<std::string> const& args);
|
|
bool HandleRPathRemoveCommand(std::vector<std::string> const& args);
|
|
bool HandleDifferentCommand(std::vector<std::string> const& args);
|
|
|
|
bool HandleCopyCommand(std::vector<std::string> const& args);
|
|
bool HandleInstallCommand(std::vector<std::string> const& args);
|
|
bool HandleDownloadCommand(std::vector<std::string> const& args);
|
|
};
|
|
|
|
|
|
#endif
|