CMake/Source/cmIncludeCommand.h

90 lines
2.6 KiB
C
Raw Normal View History

2001-04-30 18:52:58 +04:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-04-30 18:52:58 +04:00
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2001-04-30 18:52:58 +04:00
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.
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
* 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.
*/
virtual cmCommand* Clone()
{
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() { return true; }
2001-04-30 18:52:58 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "include";}
2001-04-30 18:52:58 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Read CMake listfile code from the given file.";
2001-04-30 18:52:58 +04:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" include(file1 [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
" include(module [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
"Reads CMake listfile code from the given file. Commands in the file "
"are processed immediately as if they were written in place of the "
"include command. 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 "
2004-03-28 18:47:39 +04:00
"<modulename>.cmake is searched in the CMAKE_MODULE_PATH.";
2001-04-30 18:52:58 +04:00
}
cmTypeMacro(cmIncludeCommand, cmCommand);
};
#endif