summaryrefslogtreecommitdiffstats
path: root/Source/cmGetPropertyCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2007-06-25 14:33:25 (GMT)
committerKen Martin <ken.martin@kitware.com>2007-06-25 14:33:25 (GMT)
commite35da01febbf86fefbd048dae473eb0993016613 (patch)
tree0946d6acb68dabdb1231f675eb7ae296ef0704f1 /Source/cmGetPropertyCommand.h
parent509f1fb9cb2d23938f4f4217a7f51597fa4af18a (diff)
downloadCMake-e35da01febbf86fefbd048dae473eb0993016613.zip
CMake-e35da01febbf86fefbd048dae473eb0993016613.tar.gz
CMake-e35da01febbf86fefbd048dae473eb0993016613.tar.bz2
ENH: added cmGetPropertyCommand
Diffstat (limited to 'Source/cmGetPropertyCommand.h')
-rw-r--r--Source/cmGetPropertyCommand.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/Source/cmGetPropertyCommand.h b/Source/cmGetPropertyCommand.h
new file mode 100644
index 0000000..76b360a
--- /dev/null
+++ b/Source/cmGetPropertyCommand.h
@@ -0,0 +1,73 @@
+/*=========================================================================
+
+ 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.
+
+ 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 cmGetPropertyCommand_h
+#define cmGetPropertyCommand_h
+
+#include "cmCommand.h"
+
+class cmGetPropertyCommand : public cmCommand
+{
+public:
+ virtual cmCommand* Clone()
+ {
+ return new cmGetPropertyCommand;
+ }
+
+ /**
+ * This is called when the command is first encountered in
+ * the input file.
+ */
+ virtual bool InitialPass(std::vector<std::string> const& args);
+
+ /**
+ * This determines if the command is invoked when in script mode.
+ */
+ virtual bool IsScriptable() { return true; }
+
+ /**
+ * The name of the command as specified in CMakeList.txt.
+ */
+ virtual const char* GetName() { return "GET_PROPERTY";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation()
+ {
+ return "Get a property.";
+ }
+
+ /**
+ * Longer documentation.
+ */
+ virtual const char* GetFullDocumentation()
+ {
+ return
+ " GET_PROPERTY(VAR scope_value property)\n"
+ "Get a property from cmake. The scope_value is either GLOBAL "
+ "DIRECTORY dir_name, TARGET tgt_name, SOURCE_FILE src_name, "
+ "or TEST test_name. The resulting value is "
+ "stored in the variable VAR. If the property is not found, "
+ "CMake will report an error.";
+ }
+
+ cmTypeMacro(cmGetPropertyCommand, cmCommand);
+};
+
+
+
+#endif