Source/cmMacroCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmMacroCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-07-31 10:22:18 $
   7   Version:   $Revision: 1.19 $
   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 cmMacroCommand_h
  18 #define cmMacroCommand_h
  19
  20 #include "cmCommand.h"
  21 #include "cmFunctionBlocker.h"
  22
  23 /** \class cmMacroFunctionBlocker
  24  * \brief subclass of function blocker
  25  *
  26  *
  27  */
  28 class cmMacroFunctionBlocker : public cmFunctionBlocker
  29 {
  30 public:
  31   cmMacroFunctionBlocker() {this->Depth=0;}
  32   virtual ~cmMacroFunctionBlocker() {}
  33   virtual bool IsFunctionBlocked(const cmListFileFunction&,
  34                                  cmMakefile &mf,
  35                                  cmExecutionStatus &);
  36   virtual bool ShouldRemove(const cmListFileFunction&, cmMakefile &mf);
  37
  38   std::vector<std::string> Args;
  39   std::vector<cmListFileFunction> Functions;
  40   int Depth;
  41 };
  42
  43 /** \class cmMacroCommand
  44  * \brief starts an if block
  45  *
  46  * cmMacroCommand starts an if block
  47  */
  48 class cmMacroCommand : public cmCommand
  49 {
  50 public:
  51   /**
  52    * This is a virtual constructor for the command.
  53    */
  54   virtual cmCommand* Clone()
  55     {
  56     return new cmMacroCommand;
  57     }
  58
  59   /**
  60    * This is called when the command is first encountered in
  61    * the CMakeLists.txt file.
  62    */
  63   virtual bool InitialPass(std::vector<std::string> const& args,
  64                            cmExecutionStatus &status);
  65
  66   /**
  67    * This determines if the command is invoked when in script mode.
  68    */
  69   virtual bool IsScriptable() { return true; }
  70
  71   /**
  72    * The name of the command as specified in CMakeList.txt.
  73    */
  74   virtual const char* GetName() { return "macro";}
  75
  76   /**
  77    * Succinct documentation.
  78    */
  79   virtual const char* GetTerseDocumentation()
  80     {
  81     return "Start recording a macro for later invocation as a command.";
  82     }
  83
  84   /**
  85    * More documentation.
  86    */
  87   virtual const char* GetFullDocumentation()
  88     {
  89     return
  90       "  macro(<name> [arg1 [arg2 [arg3 ...]]])\n"
  91       "    COMMAND1(ARGS ...)\n"
  92       "    COMMAND2(ARGS ...)\n"
  93       "    ...\n"
  94       "  endmacro(<name>)\n"
  95       "Define a macro named <name> that takes arguments named "
  96       "arg1 arg2 arg3 (...).  Commands listed after macro, "
  97       "but before the matching endmacro, are not invoked until the macro "
  98       "is invoked.  When it is invoked, the commands recorded in the "
  99       "macro are first modified by replacing formal parameters (${arg1}) "
 100       "with the arguments passed, and then invoked as normal commands. In "
 101       "addition to referencing the formal parameters you can reference "
 102       "the values ${ARGC} which will be set to the number of arguments "
 103       "passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} "
 104       "... which "
 105       "will have the actual values of the arguments passed in. This "
 106       "facilitates creating macros with optional arguments. Additionally "
 107       "${ARGV} holds the list of all arguments given to the macro and "
 108       "${ARGN} "
 109       "holds the list of argument past the last expected argument. "
 110       "Note that the parameters to a macro and values such as ARGN "
 111       "are not variables in the usual CMake sense. They are string "
 112       "replacements much like the c preprocessor would do with a "
 113       "macro. If you want true CMake variables you should look at "
 114       "the function command."
 115       "\n"
 116       "See the cmake_policy() command documentation for the behavior of "
 117       "policies inside macros."
 118       ;
 119     }
 120
 121   cmTypeMacro(cmMacroCommand, cmCommand);
 122 };
 123
 124
 125 #endif