Source/cmMathCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmMathCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.5 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmMathCommand_h
  18 #define cmMathCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmMathCommand
  23  * \brief Common string operations
  24  *
  25  */
  26 class cmMathCommand : public cmCommand
  27 {
  28 public:
  29   /**
  30    * This is a virtual constructor for the command.
  31    */
  32   virtual cmCommand* Clone()
  33     {
  34     return new cmMathCommand;
  35     }
  36
  37   /**
  38    * This is called when the command is first encountered in
  39    * the CMakeLists.txt file.
  40    */
  41   virtual bool InitialPass(std::vector<std::string> const& args,
  42                            cmExecutionStatus &status);
  43
  44   /**
  45    * This determines if the command is invoked when in script mode.
  46    */
  47   virtual bool IsScriptable() { return true; }
  48
  49   /**
  50    * The name of the command as specified in CMakeList.txt.
  51    */
  52   virtual const char* GetName() { return "math";}
  53
  54   /**
  55    * Succinct documentation.
  56    */
  57   virtual const char* GetTerseDocumentation()
  58     {
  59     return "Mathematical expressions.";
  60     }
  61
  62   /**
  63    * More documentation.
  64    */
  65   virtual const char* GetFullDocumentation()
  66     {
  67     return
  68       "  math(EXPR <output variable> <math expression>)\n"
  69       "EXPR evaluates mathematical expression and return result in the "
  70       "output variable. Example mathematical expression is "
  71       "'5 * ( 10 + 13 )'.  Supported operators are "
  72       "+ - * / % | & ^ ~ << >> * / %.  They have the same meaning "
  73       " as they do in c code.";
  74     }
  75
  76   cmTypeMacro(cmMathCommand, cmCommand);
  77 protected:
  78
  79   bool HandleExprCommand(std::vector<std::string> const& args);
  80 };
  81
  82
  83 #endif
  84