/*========================================================================= Program: CMake - Cross-Platform Makefile Generator Module: $RCSfile: cmIfCommand.h,v $ Language: C++ Date: $Date: 2008-03-24 22:23:26 $ Version: $Revision: 1.46.2.1 $ Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. 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. =========================================================================*/ #ifndef cmIfCommand_h #define cmIfCommand_h #include "cmCommand.h" #include "cmFunctionBlocker.h" /** \class cmIfFunctionBlocker * \brief subclass of function blocker * * */ class cmIfFunctionBlocker : public cmFunctionBlocker { public: cmIfFunctionBlocker() { this->HasRun = false; this->ScopeDepth = 0; this->Executing = false;} virtual ~cmIfFunctionBlocker() {} virtual bool IsFunctionBlocked(const cmListFileFunction& lff, cmMakefile &mf, cmExecutionStatus &); virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf); virtual void ScopeEnded(cmMakefile &mf); std::vector Args; std::vector Functions; bool IsBlocking; bool HasRun; unsigned int ScopeDepth; bool Executing; }; /** \class cmIfCommand * \brief starts an if block * * cmIfCommand starts an if block */ class cmIfCommand : public cmCommand { public: /** * This is a virtual constructor for the command. */ virtual cmCommand* Clone() { return new cmIfCommand; } /** * This overrides the default InvokeInitialPass implementation. * It records the arguments before expansion. */ virtual bool InvokeInitialPass(const std::vector& args, cmExecutionStatus &); /** * This is called when the command is first encountered in * the CMakeLists.txt file. */ virtual bool InitialPass(std::vector const&, cmExecutionStatus &) { return false;}; /** * The name of the command as specified in CMakeList.txt. */ virtual const char* GetName() { return "if";} /** * Succinct documentation. */ virtual const char* GetTerseDocumentation() { return "Conditionally execute a group of commands."; } /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() { return true; } /** * More documentation. */ virtual const char* GetFullDocumentation() { return " if(expression)\n" " # then section.\n" " COMMAND1(ARGS ...)\n" " COMMAND2(ARGS ...)\n" " ...\n" " elseif(expression2)\n" " # elseif section.\n" " COMMAND1(ARGS ...)\n" " COMMAND2(ARGS ...)\n" " ...\n" " else(expression)\n" " # else section.\n" " COMMAND1(ARGS ...)\n" " COMMAND2(ARGS ...)\n" " ...\n" " endif(expression)\n" "Evaluates the given expression. If the result is true, the commands " "in the THEN section are invoked. Otherwise, the commands in the " "else section are invoked. The elseif and else sections are " "optional. You may have multiple elseif clauses. Note that " "the same expression must be given to if, and endif. Long " "expressions can be used and the order or precedence is that the " "EXISTS, COMMAND, and DEFINED operators will be evaluated first. " "Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES " "will be evaluated. Then NOT operators and finally AND, OR operators " "will be evaluated. Possible expressions are:\n" " if(variable)\n" "True if the variable's value is not empty, 0, N, NO, OFF, FALSE, " "NOTFOUND, or -NOTFOUND.\n" " if(NOT variable)\n" "True if the variable's value is empty, 0, N, NO, OFF, FALSE, " "NOTFOUND, or -NOTFOUND.\n" " if(variable1 AND variable2)\n" "True if both variables would be considered true individually.\n" " if(variable1 OR variable2)\n" "True if either variable would be considered true individually.\n" " if(COMMAND command-name)\n" "True if the given name is a command, macro or function that can be " "invoked.\n" " if(POLICY policy-id)\n" "True if the given name is an existing policy " "(of the form CMP).\n" " if(EXISTS file-name)\n" " if(EXISTS directory-name)\n" "True if the named file or directory exists. " "Behavior is well-defined only for full paths.\n" " if(file1 IS_NEWER_THAN file2)\n" "True if file1 is newer than file2 or if one of the two files " "doesn't exist. " "Behavior is well-defined only for full paths.\n" " if(IS_DIRECTORY directory-name)\n" "True if the given name is a directory. " "Behavior is well-defined only for full paths.\n" " if(IS_ABSOLUTE path)\n" "True if the given path is an absolute path.\n " " if(variable MATCHES regex)\n" " if(string MATCHES regex)\n" "True if the given string or variable's value matches the given " "regular expression.\n" " if(variable LESS number)\n" " if(string LESS number)\n" " if(variable GREATER number)\n" " if(string GREATER number)\n" " if(variable EQUAL number)\n" " if(string EQUAL number)\n" "True if the given string or variable's value is a valid number and " "the inequality or equality is true.\n" " if(variable STRLESS string)\n" " if(string STRLESS string)\n" " if(variable STRGREATER string)\n" " if(string STRGREATER string)\n" " if(variable STREQUAL string)\n" " if(string STREQUAL string)\n" "True if the given string or variable's value is lexicographically " "less (or greater, or equal) than the string on the right.\n" " if(DEFINED variable)\n" "True if the given variable is defined. It does not matter if the " "variable is true or false just if it has been set."; } // this is a shared function for both If and Else to determine if the // arguments were valid, and if so, was the response true. If there is // an error, the errorString will be set. static bool IsTrue(const std::vector &args, char** errorString, cmMakefile *mf); // Get a definition from the makefile. If it doesn't exist, // return the original string. static const char* GetVariableOrString(const char* str, const cmMakefile* mf); static const char* GetVariableOrNumber(const char* str, const cmMakefile* mf); cmTypeMacro(cmIfCommand, cmCommand); }; #endif