CMake/Source/cmIncludeCommand.h

87 lines
2.4 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);
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";}
/**
* 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])\n"
" INCLUDE(module [OPTIONAL])\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 "
"is raised if the file does not exist.\n"
"If module is specified instead of 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