You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cmake/Source/cmIncludeDirectoryCommand.h

87 lines
2.6 KiB

/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile: cmIncludeDirectoryCommand.h,v $
Language: C++
Date: $Date: 2008-01-23 15:27:59 $
Version: $Revision: 1.16 $
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
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 cmIncludeDirectoryCommand_h
#define cmIncludeDirectoryCommand_h
#include "cmCommand.h"
/** \class cmIncludeDirectoryCommand
* \brief Add include directories to the build.
*
* cmIncludeDirectoryCommand is used to specify directory locations
* to search for included files.
*/
class cmIncludeDirectoryCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmIncludeDirectoryCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "include_directories";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Add include directories to the build.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
"Add the given directories to those searched by the compiler for "
"include files. By default the directories are appended onto "
"the current list of directories. This default behavior can be "
"changed by setting CMAKE_include_directories_BEFORE to ON. "
"By using BEFORE or AFTER you can select between appending and "
"prepending, independent from the default. "
"If the SYSTEM option is given the compiler will be told that the "
"directories are meant as system include directories on some "
"platforms.";
}
cmTypeMacro(cmIncludeDirectoryCommand, cmCommand);
protected:
// used internally
void AddDirectory(const char *arg, bool before, bool system);
};
#endif