1 /*============================================================================
2 CMake - Cross Platform Makefile Generator
3 Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
5 Distributed under the OSI-approved BSD License (the "License");
6 see accompanying file Copyright.txt for details.
8 This software is distributed WITHOUT ANY WARRANTY; without even the
9 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10 See the License for more information.
11 ============================================================================*/
12 #ifndef cmGetSourceFilePropertyCommand_h
13 #define cmGetSourceFilePropertyCommand_h
15 #include "cmCommand.h"
17 class cmGetSourceFilePropertyCommand : public cmCommand
20 virtual cmCommand* Clone()
22 return new cmGetSourceFilePropertyCommand;
26 * This is called when the command is first encountered in
29 virtual bool InitialPass(std::vector<std::string> const& args,
30 cmExecutionStatus &status);
33 * The name of the command as specified in CMakeList.txt.
35 virtual const char* GetName() const { return "get_source_file_property";}
38 * Succinct documentation.
40 virtual const char* GetTerseDocumentation() const
42 return "Get a property for a source file.";
46 * Longer documentation.
48 virtual const char* GetFullDocumentation() const
51 " get_source_file_property(VAR file property)\n"
52 "Get a property from a source file. The value of the property is "
53 "stored in the variable VAR. If the property is not found, VAR "
54 "will be set to \"NOTFOUND\". Use set_source_files_properties to set "
55 "property values. Source file properties usually control how the "
56 "file is built. One property that is always there is LOCATION"
58 "See also the more general get_property() command.";
61 cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand);