CMake/Source/cmGetDirectoryPropertyCommand.h
Brad King 96afb12087 Convert CMake to OSI-approved BSD License
This converts the CMake license to a pure 3-clause OSI-approved BSD
License.  We drop the previous license clause requiring modified
versions to be plainly marked.  We also update the CMake copyright to
cover the full development time range.
2009-09-28 11:43:28 -04:00

78 lines
2.3 KiB
C++

/*============================================================================
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 cmGetDirectoryPropertyCommand_h
#define cmGetDirectoryPropertyCommand_h
#include "cmCommand.h"
class cmGetDirectoryPropertyCommand : public cmCommand
{
public:
virtual cmCommand* Clone()
{
return new cmGetDirectoryPropertyCommand;
}
/**
* This is called when the command is first encountered in
* the input file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* 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_directory_property";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Get a property of DIRECTORY scope.";
}
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)\n"
"Store a property of directory scope in the named variable. "
"If the property is not defined the empty-string is returned. "
"The DIRECTORY argument specifies another directory from which "
"to retrieve the property value. "
"The specified directory must have already been traversed by "
"CMake."
"\n"
" get_directory_property(<variable> [DIRECTORY <dir>]\n"
" DEFINITION <var-name>)\n"
"Get a variable definition from a directory. "
"This form is useful to get a variable definition from another "
"directory."
;
}
cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand);
};
#endif