CMake/Source/cmExecProgramCommand.h

95 lines
3.0 KiB
C
Raw Normal View History

/*=========================================================================
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.
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-05-08 02:11:16 +04:00
#ifndef cmExecProgramCommand_h
#define cmExecProgramCommand_h
#include "cmCommand.h"
2001-05-08 02:11:16 +04:00
/** \class cmExecProgramCommand
* \brief Command that adds a target to the build system.
*
2001-05-08 02:11:16 +04:00
* cmExecProgramCommand adds an extra target to the build system.
* This is useful when you would like to add special
* targets like "install,", "clean," and so on.
*/
2001-05-08 02:11:16 +04:00
class cmExecProgramCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
2001-05-08 02:11:16 +04:00
return new cmExecProgramCommand;
}
/**
* 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 "EXEC_PROGRAM";}
2004-02-23 06:07:02 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
2006-03-10 21:54:57 +03:00
return
"Run and executable program during the processing of the CMakeList.txt"
" file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" EXEC_PROGRAM(Executable [directory in which to run]\n"
" [ARGS <arguments to executable>]\n"
" [OUTPUT_VARIABLE <var>]\n"
" [RETURN_VALUE <var>])\n"
2005-11-16 18:40:16 +03:00
"The executable is run in the optionally specified directory. The "
"executable can include arguments if it is double quoted, but it is "
"better to use the optional ARGS argument to specify arguments to the "
"program. This is because cmake will then be able to escape spaces "
2005-11-16 18:40:16 +03:00
"in the executable path. An optional argument OUTPUT_VARIABLE "
"specifies a variable in which to store the output. "
2005-11-16 18:40:16 +03:00
"To capture the return value of the execution, provide a RETURN_VALUE. "
"If OUTPUT_VARIABLE is specified, then no output will go to the "
"stdout/stderr of the console running cmake.\n"
"The EXECUTE_PROCESS command is a newer more powerful version of "
"EXEC_PROGRAM, but the old command has been kept for compatibility."
;
}
2001-05-08 02:11:16 +04:00
cmTypeMacro(cmExecProgramCommand, cmCommand);
};
#endif