CMake/Source/cmIncludeCommand.h

92 lines
2.9 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-04-30 18:52:58 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-04-30 18:52:58 +04:00
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.
============================================================================*/
2001-04-30 18:52:58 +04:00
#ifndef cmIncludeCommand_h
#define cmIncludeCommand_h
#include "cmCommand.h"
/** \class cmIncludeCommand
* \brief cmIncludeCommand defines a list of distant
2001-04-30 18:52:58 +04:00
* files that can be "included" in the current list file.
* In almost every sense, this is identical to a C/C++
* #include command. Arguments are first expended as usual.
*/
class cmIncludeCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
2010-12-15 00:25:21 +03:00
virtual cmCommand* Clone()
2001-04-30 18:52:58 +04:00
{
return new cmIncludeCommand;
}
/**
* 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);
2001-04-30 18:52:58 +04:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
2001-04-30 18:52:58 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const {return "include";}
2010-12-15 00:25:21 +03:00
2001-04-30 18:52:58 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2001-04-30 18:52:58 +04:00
{
return "Load and run CMake code from a file or module.";
2001-04-30 18:52:58 +04:00
}
2010-12-15 00:25:21 +03:00
2001-04-30 18:52:58 +04:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
2001-04-30 18:52:58 +04:00
{
return
" include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\n"
" [NO_POLICY_SCOPE])\n"
"Load and run CMake code from the file given. "
"Variable reads and writes access the scope of the caller "
"(dynamic scoping). "
"If OPTIONAL is present, then no error "
ENH: merge CMake-CrossCompileBasic to HEAD -add a RESULT_VARIABLE to INCLUDE() -add CMAKE_TOOLCHAIN_FILE for specifiying your (potentially crosscompiling) toolchain -have TRY_RUN() complain if you try to use it in crosscompiling mode (which were compiled but cannot run on this system) -use CMAKE_EXECUTABLE_SUFFIX in TRY_RUN(), probably TRY_RUN won't be able to run the executables if they have a different suffix because they are probably crosscompiled, but nevertheless it should be able to find them -make several cmake variables presettable by the user: CMAKE_C/CXX_COMPILER, CMAKE_C/CXX_OUTPUT_EXTENSION, CMAKE_SYSTEM_NAME, CMAKE_SYSTEM_INFO_FILE -support prefix for GNU toolchains (arm-elf-gcc, arm-elf-ar, arm-elf-strip etc.) -move ranlib on OSX from the file command to a command in executed in cmake_install.cmake -add support for stripping during install in cmake_install.cmake -split out cl.cmake from Windows-cl.cmake, first (very incomplete) step to support MS crosscompiling tools -remove stdio.h from the simple C program which checks if the compiler works, since this may not exist for some embedded platforms -create a new CMakeFindBinUtils.cmake which collects the search fro ar, ranlib, strip, ld, link, install_name_tool and other tools like these -add support for CMAKE_FIND_ROOT_PATH for all FIND_XXX commands, which is a list of directories which will be prepended to all search directories, right now as a cmake variable, turning it into a global cmake property may need some more work -remove cmTestTestHandler::TryExecutable(), it's unused -split cmFileCommand::HandleInstall() into slightly smaller functions Alex
2007-05-17 21:20:44 +04:00
"is raised if the file does not exist. If RESULT_VARIABLE is given "
"the variable will be set to the full filename which "
"has been included or NOTFOUND if it failed.\n"
2005-11-16 22:11:09 +03:00
"If a module is specified instead of a file, the file with name "
"<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the "
"CMake module directory. There is one exception to this: if the file "
"which calls include() is located itself in the CMake module directory, "
"then first the CMake module directory is searched and "
"CMAKE_MODULE_PATH afterwards. See also policy CMP0017."
"\n"
"See the cmake_policy() command documentation for discussion of the "
"NO_POLICY_SCOPE option."
;
2001-04-30 18:52:58 +04:00
}
2010-12-15 00:25:21 +03:00
2001-04-30 18:52:58 +04:00
cmTypeMacro(cmIncludeCommand, cmCommand);
};
#endif