CMake/Source/cmConfigureFileCommand.h

88 lines
2.7 KiB
C
Raw Normal View History

2001-04-27 22:25:42 +04:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-04-27 22:25:42 +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-04-27 22:25:42 +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-04-27 22:25:42 +04:00
=========================================================================*/
2001-05-08 02:11:16 +04:00
#ifndef cmConfigureFileCommand_h
#define cmConfigureFileCommand_h
2001-04-27 22:25:42 +04:00
#include "cmStandardIncludes.h"
#include "cmCommand.h"
2001-05-08 02:11:16 +04:00
class cmConfigureFileCommand : public cmCommand
2001-04-27 22:25:42 +04:00
{
public:
virtual cmCommand* Clone()
{
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);
2001-04-27 22:25:42 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "CONFIGURE_FILE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Copy a file to another location and modify its contents.";
2001-04-27 22:25:42 +04:00
}
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" CONFIGURE_FILE(InputFile OutputFile\n"
" [COPYONLY] [ESCAPE_QUOTES]\n"
" [IMMEDIATE] [@ONLY])\n"
"The Input and Ouput files have to have full paths. "
"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. "
"If COPYONLY is specified, then then no variable expansion will take "
"place. If ESCAPE_QUOTES is specified in then any substitued quotes "
"will be C-style escaped. "
"If IMMEDIATE is specified, then the file will be configured with "
"the current values of CMake variables instead of waiting until the "
"end of CMakeLists processing. If @ONLY is specified, only variables "
"of the form @VAR@ will be replaces and ${VAR} will be ignored. "
"This is useful for configuring tcl scripts that use ${VAR}.";
2001-04-27 22:25:42 +04:00
}
virtual void FinalPass();
private:
void ConfigureFile();
2001-04-27 22:25:42 +04:00
std::string m_InputFile;
std::string m_OuputFile;
2001-05-08 02:11:16 +04:00
bool m_CopyOnly;
2001-06-22 19:15:18 +04:00
bool m_EscapeQuotes;
bool m_Immediate;
bool m_AtOnly;
2001-04-27 22:25:42 +04:00
};
#endif