CMake/Source/cmConfigureFileCommand.h

95 lines
2.8 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 "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);
2001-04-27 22:25:42 +04:00
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";}
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() { return true; }
2001-04-27 22:25:42 +04:00
/**
* 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] [@ONLY])\n"
2008-01-10 06:09:19 +03:00
"The Input and Output 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. "
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 replaces and ${VAR} will be ignored. "
2005-11-15 21:30:44 +03:00
"This is useful for configuring scripts that use ${VAR}. "
2005-11-16 18:37:02 +03:00
"Any occurrences of #cmakedefine VAR will be replaced with "
2005-11-15 21:30:44 +03:00
"either #define VAR or /* #undef VAR */ depending on "
"the setting of VAR in CMake";
2001-04-27 22:25:42 +04:00
}
virtual void FinalPass();
private:
int ConfigureFile();
2006-03-15 19:02:08 +03:00
std::string InputFile;
std::string OuputFile;
bool CopyOnly;
bool EscapeQuotes;
bool Immediate;
bool AtOnly;
2001-04-27 22:25:42 +04:00
};
#endif