Source/cmCMakeMinimumRequired.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCMakeMinimumRequired.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-01-04 09:12:52 $
   7   Version:   $Revision: 1.16 $
   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 cmCMakeMinimumRequired_h
  18 #define cmCMakeMinimumRequired_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmCMakeMinimumRequired
  23  * \brief Build a CMAKE variable
  24  *
  25  * cmCMakeMinimumRequired sets a variable to a value with expansion.
  26  */
  27 class cmCMakeMinimumRequired : public cmCommand
  28 {
  29 public:
  30   /**
  31    * This is a virtual constructor for the command.
  32    */
  33   virtual cmCommand* Clone()
  34     {
  35     return new cmCMakeMinimumRequired;
  36     }
  37
  38   /**
  39    * This is called when the command is first encountered in
  40    * the CMakeLists.txt file.
  41    */
  42   virtual bool InitialPass(std::vector<std::string> const& args,
  43                            cmExecutionStatus &status);
  44
  45   /**
  46    * This determines if the command is invoked when in script mode.
  47    */
  48   virtual bool IsScriptable() { return true; }
  49
  50   /**
  51    * The name of the command as specified in CMakeList.txt.
  52    */
  53   virtual const char* GetName() {return "cmake_minimum_required";}
  54
  55   /**
  56    * Succinct documentation.
  57    */
  58   virtual const char* GetTerseDocumentation()
  59     {
  60     return "Set the minimum required version of cmake for a project.";
  61     }
  62
  63   /**
  64    * More documentation.
  65    */
  66   virtual const char* GetFullDocumentation()
  67     {
  68     return
  69       "  cmake_minimum_required(VERSION major[.minor[.patch]]\n"
  70       "                         [FATAL_ERROR])\n"
  71       "If the current version of CMake is lower than that required "
  72       "it will stop processing the project and report an error.  "
  73       "When a version higher than 2.4 is specified the command implicitly "
  74       "invokes\n"
  75       "  cmake_policy(VERSION major[.minor[.patch]])\n"
  76       "which sets the cmake policy version level to the version specified.  "
  77       "When version 2.4 or lower is given the command implicitly invokes\n"
  78       "  cmake_policy(VERSION 2.4)\n"
  79       "which enables compatibility features for CMake 2.4 and lower.\n"
  80       "The FATAL_ERROR option is accepted but ignored by CMake 2.6 "
  81       "and higher.  "
  82       "It should be specified so CMake versions 2.4 and lower fail with an "
  83       "error instead of just a warning.";
  84     }
  85
  86   cmTypeMacro(cmCMakeMinimumRequired, cmCommand);
  87
  88 private:
  89   std::vector<std::string> UnknownArguments;
  90   bool EnforceUnknownArguments();
  91 };
  92
  93
  94
  95 #endif