CMake/Source/cmCommand.h

139 lines
2.9 KiB
C
Raw Normal View History

2001-01-18 19:20:24 +03:00
/*=========================================================================
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.
=========================================================================*/
2001-01-18 19:20:24 +03:00
#ifndef cmCommand_h
#define cmCommand_h
#include "cmStandardIncludes.h"
#include "cmMakefile.h"
2001-01-18 19:20:24 +03:00
/** \class cmCommand
* \brief Superclass for all commands in CMake.
*
2001-01-18 19:20:24 +03:00
* cmCommand is the base class for all commands in CMake. A command
* manifests as an entry in CMakeLists.txt and produces one or
* more makefile rules. Commands are associated with a particular
* makefile. This base class cmCommand defines the API for commands
* to support such features as enable/disable, inheritance,
* documentation, and construction.
*/
2001-01-18 19:20:24 +03:00
class cmCommand
{
public:
/**
2001-01-18 19:20:24 +03:00
* Construct the command. By default it is enabled with no makefile.
*/
2001-01-18 19:20:24 +03:00
cmCommand()
{m_Makefile = 0; m_Enabled = true;}
/**
* Specify the makefile.
*/
void SetMakefile(cmMakefile*m)
{m_Makefile = m; }
/**
2001-01-18 19:20:24 +03:00
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool Invoke(std::vector<std::string>& args) = 0;
/**
* This is called at the end after all the information
2001-01-18 19:20:24 +03:00
* specified by the command is accumulated. Most commands do
* not implement this method.
*/
2001-01-18 19:20:24 +03:00
virtual void FinalPass() {};
/**
2001-01-18 19:20:24 +03:00
* This is called to let the command check the cache.
*/
virtual void LoadCache() {}
/**
2001-01-18 19:20:24 +03:00
* This is a virtual constructor for the command.
*/
2001-01-18 19:20:24 +03:00
virtual cmCommand* Clone() = 0;
/**
2001-01-18 19:20:24 +03:00
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{
return false;
}
/**
2001-01-18 19:20:24 +03:00
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() = 0;
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation() = 0;
/**
* More documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetFullDocumentation() = 0;
/**
2001-01-18 19:20:24 +03:00
* Enable the command.
*/
void EnabledOn()
{m_Enabled = true;}
/**
2001-01-18 19:20:24 +03:00
* Disable the command.
*/
void EnabledOff()
{m_Enabled = false;}
/**
2001-01-18 19:20:24 +03:00
* Query whether the command is enabled.
*/
bool GetEnabled()
{return m_Enabled;}
2001-01-18 19:20:24 +03:00
/**
* Disable or enable the command.
*/
void SetEnabled(bool enabled)
{m_Enabled = enabled;}
/**
* Return the last error string.
*/
const char* GetError()
{return m_Error.c_str();}
protected:
void SetError(const char* e)
{
m_Error = this->GetName();
m_Error += " ";
m_Error += e;
}
cmMakefile* m_Makefile;
private:
bool m_Enabled;
std::string m_Error;
};
#endif