Source/cmCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-03-01 20:20:35 $
   7   Version:   $Revision: 1.27 $
   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 cmCommand_h
  18 #define cmCommand_h
  19
  20 #include "cmObject.h"
  21 #include "cmListFileCache.h"
  22 #include "cmMakefile.h"
  23 #include "cmCommandArgumentsHelper.h"
  24
  25 /** \class cmCommand
  26  * \brief Superclass for all commands in CMake.
  27  *
  28  * cmCommand is the base class for all commands in CMake. A command
  29  * manifests as an entry in CMakeLists.txt and produces one or
  30  * more makefile rules. Commands are associated with a particular
  31  * makefile. This base class cmCommand defines the API for commands
  32  * to support such features as enable/disable, inheritance,
  33  * documentation, and construction.
  34  */
  35 class cmCommand : public cmObject
  36 {
  37 public:
  38   cmTypeMacro(cmCommand, cmObject);
  39
  40   /**
  41    * Construct the command. By default it is enabled with no makefile.
  42    */
  43   cmCommand()
  44     {this->Makefile = 0; this->Enabled = true;}
  45
  46   /**
  47    * Need virtual destructor to destroy real command type.
  48    */
  49   virtual ~cmCommand() {}
  50
  51   /**
  52    * Specify the makefile.
  53    */
  54   void SetMakefile(cmMakefile*m)
  55     {this->Makefile = m; }
  56   cmMakefile* GetMakefile() { return this->Makefile; }
  57
  58   /**
  59    * This is called by the cmMakefile when the command is first
  60    * encountered in the CMakeLists.txt file.  It expands the command's
  61    * arguments and then invokes the InitialPass.
  62    */
  63   virtual bool InvokeInitialPass(const std::vector<cmListFileArgument>& args,
  64                                  cmExecutionStatus &status)
  65     {
  66     std::vector<std::string> expandedArguments;
  67     this->Makefile->ExpandArguments(args, expandedArguments);
  68     return this->InitialPass(expandedArguments,status);
  69     }
  70
  71   /**
  72    * This is called when the command is first encountered in
  73    * the CMakeLists.txt file.
  74    */
  75   virtual bool InitialPass(std::vector<std::string> const& args,
  76                            cmExecutionStatus &) = 0;
  77
  78   /**
  79    * This is called at the end after all the information
  80    * specified by the command is accumulated. Most commands do
  81    * not implement this method.  At this point, reading and
  82    * writing to the cache can be done.
  83    */
  84   virtual void FinalPass() {};
  85
  86   /**
  87    * This is a virtual constructor for the command.
  88    */
  89   virtual cmCommand* Clone() = 0;
  90
  91   /**
  92    * This determines if the command is invoked when in script mode.
  93    */
  94   virtual bool IsScriptable()
  95     {
  96     return false;
  97     }
  98
  99   /**
 100    * This determines if usage of the method is discouraged or not.
 101    * This is currently only used for generating the documentation.
 102    */
 103   virtual bool IsDiscouraged()
 104     {
 105     return false;
 106     }
 107
 108   /**
 109    * The name of the command as specified in CMakeList.txt.
 110    */
 111   virtual const char* GetName() = 0;
 112
 113   /**
 114    * Succinct documentation.
 115    */
 116   virtual const char* GetTerseDocumentation() = 0;
 117
 118   /**
 119    * More documentation.
 120    */
 121   virtual const char* GetFullDocumentation() = 0;
 122
 123   /**
 124    * Enable the command.
 125    */
 126   void EnabledOn()
 127     {this->Enabled = true;}
 128
 129   /**
 130    * Disable the command.
 131    */
 132   void EnabledOff()
 133     {this->Enabled = false;}
 134
 135   /**
 136    * Query whether the command is enabled.
 137    */
 138   bool GetEnabled()
 139     {return this->Enabled;}
 140
 141   /**
 142    * Disable or enable the command.
 143    */
 144   void SetEnabled(bool enabled)
 145     {this->Enabled = enabled;}
 146
 147   /**
 148    * Return the last error string.
 149    */
 150   const char* GetError()
 151     {
 152       if(this->Error.length() == 0)
 153         {
 154         this->Error = this->GetName();
 155         this->Error += " unknown error.";
 156         }
 157       return this->Error.c_str();
 158     }
 159
 160   /**
 161    * Set the error message
 162    */
 163   void SetError(const char* e)
 164     {
 165     this->Error = this->GetName();
 166     this->Error += " ";
 167     this->Error += e;
 168     }
 169
 170 protected:
 171   cmMakefile* Makefile;
 172   cmCommandArgumentsHelper Helper;
 173
 174 private:
 175   bool Enabled;
 176   std::string Error;
 177 };
 178
 179 #endif