CMakeLua/Source/cmCommand.h

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