Source/cmIncludeExternalMSProjectCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmIncludeExternalMSProjectCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-11-21 19:57:07 $
   7   Version:   $Revision: 1.9 $
   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 cmIncludeExternalMSProjectCommand_h
  18 #define cmIncludeExternalMSProjectCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmIncludeExternalMSProjectCommand
  23  * \brief Specify an external MS project file for inclusion in the workspace.
  24  *
  25  * cmIncludeExternalMSProjectCommand is used to specify an externally
  26  * generated Microsoft project file for inclusion in the default workspace
  27  * generated by CMake.
  28  */
  29 class cmIncludeExternalMSProjectCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmIncludeExternalMSProjectCommand;
  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 "include_external_msproject";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Include an external Microsoft project file in a workspace.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "  include_external_msproject(projectname location\n"
  67       "                             dep1 dep2 ...)\n"
  68       "Includes an external Microsoft project in the generated workspace "
  69       "file.  Currently does nothing on UNIX. This will create a "
  70       "target named INCLUDE_EXTERNAL_MSPROJECT_[projectname].  This can "
  71       "be used in the add_dependencies command to make things depend "
  72       "on the external project.";
  73     }
  74
  75   cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);
  76 };
  77
  78
  79
  80 #endif