summaryrefslogtreecommitdiff
path: root/Source/cmVariableRequiresCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmVariableRequiresCommand.h')
-rw-r--r--Source/cmVariableRequiresCommand.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h
new file mode 100644
index 000000000..91c351e60
--- /dev/null
+++ b/Source/cmVariableRequiresCommand.h
@@ -0,0 +1,82 @@
+/*============================================================================
+ 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.
+============================================================================*/
+#ifndef cmVariableRequiresCommand_h
+#define cmVariableRequiresCommand_h
+
+#include "cmCommand.h"
+
+/** \class cmVariableRequiresCommand
+ * \brief Displays a message to the user
+ *
+ */
+class cmVariableRequiresCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmVariableRequiresCommand;
+ }
+
+ /**
+ * 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 "variable_requires";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Deprecated. Use the if() command instead.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation() const
+ {
+ return
+ "Assert satisfaction of an option's required variables.\n"
+ " variable_requires(TEST_VARIABLE RESULT_VARIABLE\n"
+ " REQUIRED_VARIABLE1\n"
+ " REQUIRED_VARIABLE2 ...)\n"
+ "The first argument (TEST_VARIABLE) is the name of the variable to be "
+ "tested, if that variable is false nothing else is done. If "
+ "TEST_VARIABLE is true, then "
+ "the next argument (RESULT_VARIABLE) is a variable that is set to true "
+ "if all the required variables are set. "
+ "The rest of the arguments are variables that must be true or not "
+ "set to NOTFOUND to avoid an error. If any are not true, an error "
+ "is reported.";
+ }
+
+ /** This command is kept for compatibility with older CMake versions. */
+ virtual bool IsDiscouraged() const
+ {
+ return true;
+ }
+
+ cmTypeMacro(cmVariableRequiresCommand, cmCommand);
+};
+
+
+#endif