Source/cmIncludeDirectoryCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmIncludeDirectoryCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:26 $
   7   Version:   $Revision: 1.7 $
   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 cmIncludeDirectoryCommand_h
  18 #define cmIncludeDirectoryCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmIncludeDirectoryCommand
  24  * \brief Add include directories to the build.
  25  *
  26  * cmIncludeDirectoryCommand is used to specify directory locations
  27  * to search for included files.
  28  */
  29 class cmIncludeDirectoryCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmIncludeDirectoryCommand;
  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
  46   /**
  47    * This determines if the command gets propagated down
  48    * to makefiles located in subdirectories.
  49    */
  50   virtual bool IsInherited() {return true;}
  51
  52   /**
  53    * The name of the command as specified in CMakeList.txt.
  54    */
  55   virtual const char* GetName() { return "INCLUDE_DIRECTORIES";}
  56
  57   /**
  58    * Succinct documentation.
  59    */
  60   virtual const char* GetTerseDocumentation()
  61     {
  62     return "Add include directories to the build.";
  63     }
  64
  65   /**
  66    * More documentation.
  67    */
  68   virtual const char* GetFullDocumentation()
  69     {
  70     return
  71       "INCLUDE_DIRECTORIES([BEFORE] dir1 dir2 ...)";
  72     }
  73
  74   cmTypeMacro(cmIncludeDirectoryCommand, cmCommand);
  75 };
  76
  77
  78
  79 #endif