Source/cmSubdirDependsCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmSubdirDependsCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.12 $
   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 cmSubdirDependsCommand_h
  18 #define cmSubdirDependsCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmSubdirDependsCommand
  23  * \brief Legacy command.  Do not use.
  24  *
  25  * cmSubdirDependsCommand has been left in CMake for compatability with
  26  * projects already using it.  Its functionality in supporting parallel
  27  * builds is now automatic.  The command does not do anything.
  28  */
  29 class cmSubdirDependsCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmSubdirDependsCommand;
  38     }
  39
  40   /**
  41    * This is called when the command is first encountered in
  42    * the CMakeLists.txt file.
  43    */
  44   virtual bool InitialPass(std::vector<std::string> const& args,
  45                            cmExecutionStatus &status);
  46
  47   /**
  48    * The name of the command as specified in CMakeList.txt.
  49    */
  50   virtual const char* GetName() { return "subdir_depends";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Deprecated.  Does nothing.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "  subdir_depends(subdir dep1 dep2 ...)\n"
  67       "Does not do anything.  This command used to help projects order "
  68       "parallel builds correctly.  This functionality is now automatic.";
  69     }
  70
  71   /** This command is kept for compatibility with older CMake versions. */
  72   virtual bool IsDiscouraged()
  73     {
  74     return true;
  75     }
  76
  77   cmTypeMacro(cmSubdirDependsCommand, cmCommand);
  78 };
  79
  80
  81
  82 #endif