CMake/Source/cmConfigureFileCommand.h

118 lines
4.2 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-04-27 22:25:42 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-04-27 22:25:42 +04:00
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.
============================================================================*/
2001-05-08 02:11:16 +04:00
#ifndef cmConfigureFileCommand_h
#define cmConfigureFileCommand_h
2001-04-27 22:25:42 +04:00
#include "cmCommand.h"
2001-05-08 02:11:16 +04:00
class cmConfigureFileCommand : public cmCommand
2001-04-27 22:25:42 +04:00
{
public:
2005-06-16 22:05:22 +04:00
cmTypeMacro(cmConfigureFileCommand, cmCommand);
virtual cmCommand* Clone()
2001-04-27 22:25:42 +04:00
{
2001-05-08 02:11:16 +04:00
return new cmConfigureFileCommand;
2001-04-27 22:25:42 +04:00
}
/**
* This is called when the command is first encountered in
* the input file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2001-04-27 22:25:42 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "configure_file";}
2001-04-27 22:25:42 +04:00
2004-02-23 06:07:02 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
2004-02-23 06:07:02 +03:00
2001-04-27 22:25:42 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2001-04-27 22:25:42 +04:00
{
return "Copy a file to another location and modify its contents.";
2001-04-27 22:25:42 +04:00
}
2001-04-27 22:25:42 +04:00
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation() const
2001-04-27 22:25:42 +04:00
{
return
" configure_file(<input> <output>\n"
" [COPYONLY] [ESCAPE_QUOTES] [@ONLY] \n"
" [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])\n"
"Copies a file <input> to file <output> and substitutes variable "
"values referenced in the file content. "
"If <input> is a relative path it is evaluated with respect to "
"the current source directory. "
"The <input> must be a file, not a directory. "
"If <output> is a relative path it is evaluated with respect to "
"the current binary directory. "
"If <output> names an existing directory the input file is placed "
"in that directory with its original name. "
"\n"
"If the <input> file is modified the build system will re-run CMake "
"to re-configure the file and generate the build system again."
"\n"
"This command replaces any variables in the input file referenced as "
"${VAR} or @VAR@ with their values as determined by CMake. If a "
"variable is not defined, it will be replaced with nothing. "
2005-11-16 18:26:41 +03:00
"If COPYONLY is specified, then no variable expansion will take "
"place. If ESCAPE_QUOTES is specified then any substituted quotes "
"will be C-style escaped. "
"The file will be configured with the current values of CMake "
"variables. If @ONLY is specified, only variables "
"of the form @VAR@ will be replaced and ${VAR} will be ignored. "
"This is useful for configuring scripts that use ${VAR}."
"\n"
"Input file lines of the form \"#cmakedefine VAR ...\" "
"will be replaced with either \"#define VAR ...\" or "
"\"/* #undef VAR */\" depending on whether VAR is set in CMake to "
"any value not considered a false constant by the if() command. "
"(Content of \"...\", if any, is processed as above.) "
"Input file lines of the form \"#cmakedefine01 VAR\" "
"will be replaced with either \"#define VAR 1\" or "
"\"#define VAR 0\" similarly."
"\n"
"With NEWLINE_STYLE the line ending could be adjusted: \n"
" 'UNIX' or 'LF' for \\n, 'DOS', 'WIN32' or 'CRLF' for \\r\\n.\n"
"COPYONLY must not be used with NEWLINE_STYLE.\n";
2001-04-27 22:25:42 +04:00
}
virtual void FinalPass();
virtual bool HasFinalPass() const { return !this->Immediate; }
2001-04-27 22:25:42 +04:00
private:
int ConfigureFile();
cmNewLineStyle NewLineStyle;
2006-03-15 19:02:08 +03:00
std::string InputFile;
std::string OutputFile;
2006-03-15 19:02:08 +03:00
bool CopyOnly;
bool EscapeQuotes;
bool Immediate;
bool AtOnly;
2001-04-27 22:25:42 +04:00
};
#endif