CMakeLua/Source/cmAddDependenciesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmAddDependenciesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/23 15:27:59 $
   7   Version:   $Revision: 1.10 $
   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 cmDependenciessCommand_h
  18 #define cmDependenciessCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmAddDependenciesCommand
  23  * \brief Add a dependency to a target
  24  *
  25  * cmAddDependenciesCommand adds a dependency to a target
  26  */
  27 class cmAddDependenciesCommand : public cmCommand
  28 {
  29 public:
  30   /**
  31    * This is a virtual constructor for the command.
  32    */
  33   virtual cmCommand* Clone()
  34     {
  35     return new cmAddDependenciesCommand;
  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    * The name of the command as specified in CMakeList.txt.
  47    */
  48   virtual const char* GetName() { return "add_dependencies";}
  49
  50   /**
  51    * Succinct documentation.
  52    */
  53   virtual const char* GetTerseDocumentation()
  54     {
  55     return "Add a dependency between top-level targets.";
  56     }
  57
  58   /**
  59    * More documentation.
  60    */
  61   virtual const char* GetFullDocumentation()
  62     {
  63     return
  64       "  add_dependencies(target-name depend-target1\n"
  65       "                   depend-target2 ...)\n"
  66       "Make a top-level target depend on other top-level targets.  A "
  67       "top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, "
  68       "or ADD_CUSTOM_TARGET.  Adding dependencies with this command "
  69       "can be used to make sure one target is built before another target.  "
  70       "See the DEPENDS option of ADD_CUSTOM_TARGET "
  71       "and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom "
  72       "rules.  See the OBJECT_DEPENDS option in "
  73       "SET_SOURCE_FILES_PROPERTIES to add file-level dependencies to object "
  74       "files.";
  75     }
  76
  77   cmTypeMacro(cmAddDependenciesCommand, cmCommand);
  78 };
  79
  80
  81 #endif