diff options
Diffstat (limited to 'Source/cmExecProgramCommand.h')
-rw-r--r-- | Source/cmExecProgramCommand.h | 89 |
1 files changed, 20 insertions, 69 deletions
diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h index f752501fa..6463c4db5 100644 --- a/Source/cmExecProgramCommand.h +++ b/Source/cmExecProgramCommand.h @@ -1,18 +1,17 @@ -/*============================================================================ - 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. -============================================================================*/ +/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying + file Copyright.txt or https://cmake.org/licensing for details. */ #ifndef cmExecProgramCommand_h #define cmExecProgramCommand_h +#include "cmConfigure.h" + +#include <string> +#include <vector> + #include "cmCommand.h" +#include "cmProcessOutput.h" + +class cmExecutionStatus; /** \class cmExecProgramCommand * \brief Command that adds a target to the build system. @@ -24,72 +23,24 @@ class cmExecProgramCommand : public cmCommand { public: + typedef cmProcessOutput::Encoding Encoding; /** * This is a virtual constructor for the command. */ - virtual cmCommand* Clone() - { - return new cmExecProgramCommand; - } + cmCommand* Clone() CM_OVERRIDE { 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, - cmExecutionStatus &status); - - /** - * The name of the command as specified in CMakeList.txt. - */ - virtual const char* GetName() const - {return "exec_program";} - - /** - * This determines if the command is invoked when in script mode. - */ - virtual bool IsScriptable() const { return true; } - - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Deprecated. Use the execute_process() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Run an executable program during the processing of the CMakeList.txt" - " file.\n" - " exec_program(Executable [directory in which to run]\n" - " [ARGS <arguments to executable>]\n" - " [OUTPUT_VARIABLE <var>]\n" - " [RETURN_VALUE <var>])\n" - "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 " - "in the executable path. An optional argument OUTPUT_VARIABLE " - "specifies a variable in which to store the output. " - "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" - ; - } - - /** This command is kept for compatibility with older CMake versions. */ - virtual bool IsDiscouraged() const - { - return true; - } - - cmTypeMacro(cmExecProgramCommand, cmCommand); + bool InitialPass(std::vector<std::string> const& args, + cmExecutionStatus& status) CM_OVERRIDE; + +private: + static bool RunCommand(const char* command, std::string& output, int& retVal, + const char* directory = CM_NULLPTR, + bool verbose = true, + Encoding encoding = cmProcessOutput::Auto); }; #endif |