CMake/Source/cmUtilitySourceCommand.h

62 lines
1.8 KiB
C++

/*============================================================================
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 cmUtilitySourceCommand_h
#define cmUtilitySourceCommand_h
#include "cmCommand.h"
/** \class cmUtilitySourceCommand
* \brief A command to setup a cache entry with the location of a third-party
* utility's source.
*
* cmUtilitySourceCommand is used when a third-party utility's source is
* included in the project's source tree. It specifies the location of
* the executable's source, and any files that may be needed to confirm the
* identity of the source.
*/
class cmUtilitySourceCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmUtilitySourceCommand;
}
/**
* 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 "utility_source";}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged() const
{
return true;
}
cmTypeMacro(cmUtilitySourceCommand, cmCommand);
};
#endif