CMake/Source/cmIncludeDirectoryCommand.h

/*============================================================================
  CMake - Cross Platform Makefile Generator
  Copyright 2000-2009 Kitware, Inc., Insight Software Consortium

  Distributed under the OSI-approved BSD License (the "License");
  see accompanying file Copyright.txt for details.

  This software is distributed WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the License 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() const { return "include_directories";}

  /**
   * Succinct documentation.
   */
  virtual const char* GetTerseDocumentation() const
    {
    return "Add include directories to the build.";
    }

  /**
   * More documentation.
   */
  virtual const char* GetFullDocumentation() const
    {
    return
      "  include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
      "Add the given directories to those the compiler uses to search "
      "for include files.  Relative paths are interpreted as relative to "
      "the current source directory. \n"
      "The include directories are added to the directory property "
      "INCLUDE_DIRECTORIES for the current CMakeLists file. "
      "They are also added to the target property INCLUDE_DIRECTORIES "
      "for each target in the current CMakeLists file. "
      "The target property values are the ones used by the generators."
      "\n"
      "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 AFTER or BEFORE explicitly, you can select between "
      "appending and prepending, independent of the default. "
      "\n"
      "If the SYSTEM option is given, the compiler will be told the "
      "directories are meant as system include directories on some "
      "platforms (signalling this setting might achieve effects such as "
      "the compiler skipping warnings, or these fixed-install system files "
      "not being considered in dependency calculations - see compiler docs).";
    }

  cmTypeMacro(cmIncludeDirectoryCommand, cmCommand);

protected:
  // used internally
  void GetIncludes(const std::string &arg, std::vector<std::string> &incs);
  void NormalizeInclude(std::string &inc);
};



#endif