Source/cmIncludeRegularExpressionCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmIncludeRegularExpressionCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.14 $
   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 cmIncludeRegularExpressionCommand_h
  18 #define cmIncludeRegularExpressionCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmIncludeRegularExpressionCommand
  23  * \brief Set the regular expression for following #includes.
  24  *
  25  * cmIncludeRegularExpressionCommand is used to specify the regular expression
  26  * that determines whether to follow a #include file in dependency checking.
  27  */
  28 class cmIncludeRegularExpressionCommand : public cmCommand
  29 {
  30 public:
  31   /**
  32    * This is a virtual constructor for the command.
  33    */
  34   virtual cmCommand* Clone()
  35     {
  36     return new cmIncludeRegularExpressionCommand;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args,
  44                            cmExecutionStatus &status);
  45
  46   /**
  47    * The name of the command as specified in CMakeList.txt.
  48    */
  49   virtual const char* GetName() {return "include_regular_expression";}
  50
  51   /**
  52    * Succinct documentation.
  53    */
  54   virtual const char* GetTerseDocumentation()
  55     {
  56     return "Set the regular expression used for dependency checking.";
  57     }
  58
  59   /**
  60    * More documentation.
  61    */
  62   virtual const char* GetFullDocumentation()
  63     {
  64     return
  65       "  include_regular_expression(regex_match [regex_complain])\n"
  66       "Set the regular expressions used in dependency checking.  Only files "
  67       "matching regex_match will be traced as dependencies.  Only files "
  68       "matching regex_complain will generate warnings if they cannot be "
  69       "found "
  70       "(standard header paths are not searched).  The defaults are:\n"
  71       "  regex_match    = \"^.*$\" (match everything)\n"
  72       "  regex_complain = \"^$\" (match empty string only)";
  73     }
  74
  75   cmTypeMacro(cmIncludeRegularExpressionCommand, cmCommand);
  76 };
  77
  78
  79
  80 #endif