CMake/Source/cmMathCommand.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

80 lines
2.1 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 cmMathCommand_h
#define cmMathCommand_h
#include "cmCommand.h"
/** \class cmMathCommand
* \brief Common string operations
*
*/
class cmMathCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmMathCommand;
}
/**
* 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);
/**
* 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 "math";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Mathematical expressions.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" math(EXPR <output variable> <math expression>)\n"
"EXPR evaluates mathematical expression and return result in the "
"output variable. Example mathematical expression is "
"'5 * ( 10 + 13 )'. Supported operators are "
"+ - * / % | & ^ ~ << >> * / %. They have the same meaning "
" as they do in c code.";
}
cmTypeMacro(cmMathCommand, cmCommand);
protected:
bool HandleExprCommand(std::vector<std::string> const& args);
};
#endif