CMake/Source/cmAddDefinitionsCommand.h

81 lines
2.5 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-04-20 01:39:03 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-04-20 01:39:03 +04: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.
============================================================================*/
2001-04-20 01:39:03 +04:00
#ifndef cmAddDefinitionsCommand_h
#define cmAddDefinitionsCommand_h
#include "cmCommand.h"
/** \class cmAddDefinitionsCommand
* \brief Specify a list of compiler defines
*
2006-03-10 21:06:26 +03:00
* cmAddDefinitionsCommand specifies a list of compiler defines. These defines
* will be added to the compile command.
2001-04-20 01:39:03 +04:00
*/
class cmAddDefinitionsCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
2006-03-10 21:06:26 +03:00
virtual cmCommand* Clone()
2001-04-20 01:39:03 +04:00
{
return new cmAddDefinitionsCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2001-04-20 01:39:03 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const {return "add_definitions";}
2006-03-10 21:06:26 +03:00
2001-04-20 01:39:03 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2001-04-20 01:39:03 +04:00
{
return "Adds -D define flags to the compilation of source files.";
2001-04-20 01:39:03 +04:00
}
2006-03-10 21:06:26 +03:00
2001-04-20 01:39:03 +04:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
2001-04-20 01:39:03 +04:00
{
return
" add_definitions(-DFOO -DBAR ...)\n"
"Adds flags to the compiler command line for sources in the current "
"directory and below. This command can be used to add any flags, "
"but it was originally intended to add preprocessor definitions. "
"Flags beginning in -D or /D that look like preprocessor definitions "
"are automatically added to the COMPILE_DEFINITIONS property for "
"the current directory. Definitions with non-trivial values may be "
"left in the set of flags instead of being converted for reasons of "
"backwards compatibility. See documentation of the directory, "
"target, and source file COMPILE_DEFINITIONS properties for details "
"on adding preprocessor definitions to specific scopes and "
"configurations."
;
2001-04-20 01:39:03 +04:00
}
2006-03-10 21:06:26 +03:00
2001-04-20 01:39:03 +04:00
cmTypeMacro(cmAddDefinitionsCommand, cmCommand);
};
#endif