CMake/Source/cmIncludeCommand.h

81 lines
1.8 KiB
C++

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Library of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmIncludeCommand_h
#define cmIncludeCommand_h
#include "cmStandardIncludes.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 Invoke(std::vector<std::string>& args);
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() {return true;}
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Basically identical to a C #include \"somthing\" command.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"INCLUDE(file1 file2)\n";
}
cmTypeMacro(cmIncludeCommand, cmCommand);
};
#endif