Source/cmCMakeMinimumRequired.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmCMakeMinimumRequired_h
  13 #define cmCMakeMinimumRequired_h
  14
  15 #include "cmCommand.h"
  16
  17 /** \class cmCMakeMinimumRequired
  18  * \brief cmake_minimum_required command
  19  *
  20  * cmCMakeMinimumRequired implements the cmake_minimum_required CMake command
  21  */
  22 class cmCMakeMinimumRequired : public cmCommand
  23 {
  24 public:
  25   /**
  26    * This is a virtual constructor for the command.
  27    */
  28   virtual cmCommand* Clone()
  29     {
  30     return new cmCMakeMinimumRequired;
  31     }
  32
  33   /**
  34    * This is called when the command is first encountered in
  35    * the CMakeLists.txt file.
  36    */
  37   virtual bool InitialPass(std::vector<std::string> const& args,
  38                            cmExecutionStatus &status);
  39
  40   /**
  41    * This determines if the command is invoked when in script mode.
  42    */
  43   virtual bool IsScriptable() const { return true; }
  44
  45   /**
  46    * The name of the command as specified in CMakeList.txt.
  47    */
  48   virtual const char* GetName() const {return "cmake_minimum_required";}
  49
  50   /**
  51    * Succinct documentation.
  52    */
  53   virtual const char* GetTerseDocumentation() const
  54     {
  55     return "Set the minimum required version of cmake for a project.";
  56     }
  57
  58   /**
  59    * More documentation.
  60    */
  61   virtual const char* GetFullDocumentation() const
  62     {
  63     return
  64       "  cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]]\n"
  65       "                         [FATAL_ERROR])\n"
  66       "If the current version of CMake is lower than that required "
  67       "it will stop processing the project and report an error.  "
  68       "When a version higher than 2.4 is specified the command implicitly "
  69       "invokes\n"
  70       "  cmake_policy(VERSION major[.minor[.patch[.tweak]]])\n"
  71       "which sets the cmake policy version level to the version specified.  "
  72       "When version 2.4 or lower is given the command implicitly invokes\n"
  73       "  cmake_policy(VERSION 2.4)\n"
  74       "which enables compatibility features for CMake 2.4 and lower.\n"
  75       "The FATAL_ERROR option is accepted but ignored by CMake 2.6 "
  76       "and higher.  "
  77       "It should be specified so CMake versions 2.4 and lower fail with an "
  78       "error instead of just a warning.";
  79     }
  80
  81   cmTypeMacro(cmCMakeMinimumRequired, cmCommand);
  82
  83 private:
  84   std::vector<std::string> UnknownArguments;
  85   bool EnforceUnknownArguments();
  86 };
  87
  88
  89
  90 #endif