CMakeLua/Source/cmIncludeExternalMSProjectCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmIncludeExternalMSProjectCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmIncludeExternalMSProjectCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.8 $
   9 =======
  10   Date:      $Date: 2008-11-21 19:57:07 $
  11   Version:   $Revision: 1.9 $
  12 >>>>>>> 1.9
  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 cmIncludeExternalMSProjectCommand_h
  23 #define cmIncludeExternalMSProjectCommand_h
  24
  25 #include "cmCommand.h"
  26
  27 /** \class cmIncludeExternalMSProjectCommand
  28  * \brief Specify an external MS project file for inclusion in the workspace.
  29  *
  30  * cmIncludeExternalMSProjectCommand is used to specify an externally
  31  * generated Microsoft project file for inclusion in the default workspace
  32  * generated by CMake.
  33  */
  34 class cmIncludeExternalMSProjectCommand : public cmCommand
  35 {
  36 public:
  37   /**
  38    * This is a virtual constructor for the command.
  39    */
  40   virtual cmCommand* Clone()
  41     {
  42     return new cmIncludeExternalMSProjectCommand;
  43     }
  44
  45   /**
  46    * This is called when the command is first encountered in
  47    * the CMakeLists.txt file.
  48    */
  49   virtual bool InitialPass(std::vector<std::string> const& args,
  50                            cmExecutionStatus &status);
  51
  52   /**
  53    * The name of the command as specified in CMakeList.txt.
  54    */
  55   virtual const char* GetName() {return "include_external_msproject";}
  56
  57   /**
  58    * Succinct documentation.
  59    */
  60   virtual const char* GetTerseDocumentation()
  61     {
  62     return "Include an external Microsoft project file in a workspace.";
  63     }
  64
  65   /**
  66    * More documentation.
  67    */
  68   virtual const char* GetFullDocumentation()
  69     {
  70     return
  71       "  include_external_msproject(projectname location\n"
  72       "                             dep1 dep2 ...)\n"
  73       "Includes an external Microsoft project in the generated workspace "
  74       "file.  Currently does nothing on UNIX. This will create a "
  75       "target named INCLUDE_EXTERNAL_MSPROJECT_[projectname].  This can "
  76       "be used in the add_dependencies command to make things depend "
  77       "on the external project.";
  78     }
  79
  80   cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);
  81 };
  82
  83
  84
  85 #endif