Source/cmIncludeExternalMSProjectCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmIncludeExternalMSProjectCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:26 $
   7   Version:   $Revision: 1.2 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmIncludeExternalMSProjectCommand
  24  * \brief Specify an external MS project file for inclusion in the workspace.
  25  *
  26  * cmIncludeExternalMSProjectCommand is used to specify an externally generated
  27  * Microsoft project file for inclusion in the default workspace generated by
  28  * CMake.
  29  */
  30 class cmIncludeExternalMSProjectCommand : public cmCommand
  31 {
  32 public:
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmIncludeExternalMSProjectCommand;
  39     }
  40
  41   /**
  42    * This is called when the command is first encountered in
  43    * the CMakeLists.txt file.
  44    */
  45   virtual bool InitialPass(std::vector<std::string> const& args);
  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 dep1 dep2 ...) Includes an external Microsoft project in the workspace file. Does nothing on UNIX currently\n";
  67     }
  68
  69   cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);
  70 };
  71
  72
  73
  74 #endif