1 /*=========================================================================
3 Program: CMake - Cross-Platform Makefile Generator
4 Module: $RCSfile: cmGetCMakePropertyCommand.h,v $
6 <<<<<<< cmGetCMakePropertyCommand.h
7 Date: $Date: 2008/01/23 15:27:59 $
8 Version: $Revision: 1.8 $
10 Date: $Date: 2008-07-08 15:52:25 $
11 Version: $Revision: 1.9 $
14 Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
15 See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
17 This software is distributed WITHOUT ANY WARRANTY; without even
18 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
19 PURPOSE. See the above copyright notices for more information.
21 =========================================================================*/
22 #ifndef cmGetCMakePropertyCommand_h
23 #define cmGetCMakePropertyCommand_h
25 #include "cmCommand.h"
27 class cmGetCMakePropertyCommand
: public cmCommand
30 virtual cmCommand
* Clone()
32 return new cmGetCMakePropertyCommand
;
36 * This is called when the command is first encountered in
39 virtual bool InitialPass(std::vector
<std::string
> const& args
,
40 cmExecutionStatus
&status
);
43 * This determines if the command is invoked when in script mode.
45 virtual bool IsScriptable() { return true; }
48 * The name of the command as specified in CMakeList.txt.
50 virtual const char* GetName() { return "get_cmake_property";}
53 * Succinct documentation.
55 virtual const char* GetTerseDocumentation()
57 return "Get a property of the CMake instance.";
61 * Longer documentation.
63 virtual const char* GetFullDocumentation()
66 " get_cmake_property(VAR property)\n"
67 "Get a property from the CMake instance. The value of the "
68 "property is stored in the variable VAR. If the property is "
69 "not found, CMake will report an error. Some supported properties "
70 "include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and "
74 cmTypeMacro(cmGetCMakePropertyCommand
, cmCommand
);