CMake/Source/cmSetDirectoryPropertiesCommand.h
Yury G. Kudryashov 737c49a357 Add 'const' qualifier to some cmCommand members
Use const_cast for the special case in cmFindBase where
GetFullDocumentation calls GenerateDocumentation.
2012-02-29 13:27:04 -05:00

79 lines
2.4 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 cmSetDirectoryPropertiesCommand_h
#define cmSetDirectoryPropertiesCommand_h
#include "cmCommand.h"
class cmSetDirectoryPropertiesCommand : public cmCommand
{
public:
virtual cmCommand* Clone()
{
return new cmSetDirectoryPropertiesCommand;
}
/**
* 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() const { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "set_directory_properties";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Set a property of the directory.";
}
/**
* Static entry point for use by other commands
*/
static bool RunCommand(cmMakefile *mf,
std::vector<std::string>::const_iterator ait,
std::vector<std::string>::const_iterator aitend,
std::string &errors);
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n"
"Set a property for the current directory and subdirectories. If the "
"property is not found, CMake will report an error. The properties "
"include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, "
"INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. "
"ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned "
"as a part of \"make clean\" stage.";
}
cmTypeMacro(cmSetDirectoryPropertiesCommand, cmCommand);
};
#endif