CMake/Source/cmIncludeRegularExpressionC...

90 lines
2.6 KiB
C
Raw Normal View History

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
2002-01-21 23:30:43 +03:00
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmIncludeRegularExpressionCommand_h
#define cmIncludeRegularExpressionCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmIncludeRegularExpressionCommand
* \brief Set the regular expression for following #includes.
*
* cmIncludeRegularExpressionCommand is used to specify the regular expression
* used by cmMakeDepend to determine whether to follow a #include file in
* dependency checking.
*/
class cmIncludeRegularExpressionCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmIncludeRegularExpressionCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE_REGULAR_EXPRESSION";}
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{
return true;
}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Set the regular expression used for dependency checking.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain])\n"
"Set the regular expressions used in dependency checking. Only files\n"
"matching regex_match will be traced as dependencies. Only files\n"
"matching regex_complain will generate warnings if they cannot be found\n"
"(standard header paths are not searched). The defaults are:\n"
" regex_match = \"^.*$\" (match everything)\n"
" regex_complain = \"^$\" (match empty string only)\n";
}
cmTypeMacro(cmIncludeRegularExpressionCommand, cmCommand);
};
#endif