Source/cmSubdirCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmSubdirCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-09-03 19:58:22 $
   7   Version:   $Revision: 1.23 $
   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 cmSubdirCommand_h
  18 #define cmSubdirCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmSubdirCommand
  23  * \brief Specify a list of subdirectories to build.
  24  *
  25  * cmSubdirCommand specifies a list of subdirectories to process
  26  * by CMake. For each subdirectory listed, CMake will descend
  27  * into that subdirectory and process any CMakeLists.txt found.
  28  */
  29 class cmSubdirCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmSubdirCommand;
  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 "subdirs";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Deprecated. Use the add_subdirectory() command instead.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "Add a list of subdirectories to the build.\n"
  67       "  subdirs(dir1 dir2 ..."
  68       "[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]\n"
  69       "          [PREORDER] )\n"
  70       "Add a list of subdirectories to the build. The add_subdirectory "
  71       "command should be used instead of subdirs although subdirs will "
  72       "still work. "
  73       "This will cause any CMakeLists.txt files in the sub directories "
  74       "to be processed by CMake.  Any directories after the PREORDER flag "
  75       "are traversed first by makefile builds, the PREORDER flag has no "
  76       "effect on IDE projects. "
  77       " Any directories after the EXCLUDE_FROM_ALL marker "
  78       "will not be included in the top level makefile or project file. "
  79       "This is useful for having CMake create makefiles or projects for "
  80       "a set of examples in a project. You would want CMake to "
  81       "generate makefiles or project files for all the examples at "
  82       "the same time, but you would not want them to show up in the "
  83       "top level project or be built each time make is run from the top.";
  84     }
  85
  86   /** This command is kept for compatibility with older CMake versions. */
  87   virtual bool IsDiscouraged()
  88     {
  89     return true;
  90     }
  91
  92   cmTypeMacro(cmSubdirCommand, cmCommand);
  93 };
  94
  95
  96
  97 #endif