BUG: Fix find_* search order with path suffixes
[cmake.git] / Source / cmIncludeDirectoryCommand.h
blob1a0d9ad1407793f5246f9153e280db69012af187
1 /*=========================================================================
3 Program: CMake - Cross-Platform Makefile Generator
4 Module: $RCSfile: cmIncludeDirectoryCommand.h,v $
5 Language: C++
6 Date: $Date: 2008-01-23 15:27:59 $
7 Version: $Revision: 1.16 $
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.
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.
16 =========================================================================*/
17 #ifndef cmIncludeDirectoryCommand_h
18 #define cmIncludeDirectoryCommand_h
20 #include "cmCommand.h"
22 /** \class cmIncludeDirectoryCommand
23 * \brief Add include directories to the build.
25 * cmIncludeDirectoryCommand is used to specify directory locations
26 * to search for included files.
28 class cmIncludeDirectoryCommand : public cmCommand
30 public:
31 /**
32 * This is a virtual constructor for the command.
34 virtual cmCommand* Clone()
36 return new cmIncludeDirectoryCommand;
39 /**
40 * This is called when the command is first encountered in
41 * the CMakeLists.txt file.
43 virtual bool InitialPass(std::vector<std::string> const& args,
44 cmExecutionStatus &status);
46 /**
47 * The name of the command as specified in CMakeList.txt.
49 virtual const char* GetName() { return "include_directories";}
51 /**
52 * Succinct documentation.
54 virtual const char* GetTerseDocumentation()
56 return "Add include directories to the build.";
59 /**
60 * More documentation.
62 virtual const char* GetFullDocumentation()
64 return
65 " include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
66 "Add the given directories to those searched by the compiler for "
67 "include files. By default the directories are appended onto "
68 "the current list of directories. This default behavior can be "
69 "changed by setting CMAKE_include_directories_BEFORE to ON. "
70 "By using BEFORE or AFTER you can select between appending and "
71 "prepending, independent from the default. "
72 "If the SYSTEM option is given the compiler will be told that the "
73 "directories are meant as system include directories on some "
74 "platforms.";
77 cmTypeMacro(cmIncludeDirectoryCommand, cmCommand);
79 protected:
80 // used internally
81 void AddDirectory(const char *arg, bool before, bool system);
86 #endif