CMake/Source/cmGetTargetPropertyCommand.h

69 lines
2.1 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2002-12-21 19:14:47 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2002-12-21 19:14:47 +03:00
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.
============================================================================*/
2002-12-21 19:14:47 +03:00
#ifndef cmGetTargetPropertyCommand_h
#define cmGetTargetPropertyCommand_h
#include "cmCommand.h"
class cmGetTargetPropertyCommand : public cmCommand
{
public:
virtual cmCommand* Clone()
{
return new cmGetTargetPropertyCommand;
}
/**
* This is called when the command is first encountered in
* the input file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2002-12-21 19:14:47 +03:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "get_target_property";}
2002-12-21 19:14:47 +03:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Get a property from a target.";
2002-12-21 19:14:47 +03:00
}
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" get_target_property(VAR target property)\n"
"Get a property from a target. The value of the property is "
2005-11-16 20:10:37 +03:00
"stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". Use set_target_properties to set "
"property values. Properties are usually used to control how "
"a target is built, but some query the target instead. "
2005-11-16 20:11:14 +03:00
"This command can get properties for any target so far created. "
"The targets do not need to be in the current CMakeLists.txt file."
"\n"
"See also the more general get_property() command.";
2002-12-21 19:14:47 +03:00
}
cmTypeMacro(cmGetTargetPropertyCommand, cmCommand);
};
#endif