CMake/Source/cmCableDefineSetCommand.h

101 lines
2.4 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 cmCableDefineSetCommand_h
#define cmCableDefineSetCommand_h
#include "cmStandardIncludes.h"
#include "cmCableCommand.h"
/** \class cmCableDefineSetCommand
* \brief Define a command that adds a CABLE Set definition.
*
* cmCableDefineSetCommand is used to define a named CABLE Set.
* The set can be referenced in other CABLE command arguments
* with a '$' followed by the set name.
*/
class cmCableDefineSetCommand : public cmCableCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmCableDefineSetCommand;
}
/**
* 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 "CABLE_DEFINE_SET";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Define a CABLE Set.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"CABLE_DEFINE_SET(name_of_set member1 member2 ...)\n"
"Generates a Set definition in the CABLE configuration. Tags are\n"
"automatically generated. The sets are referenced in other CABLE\n"
"commands by a '$' immediately followed by the set name (ex. $SetName).";
}
cmTypeMacro(cmCableDefineSetCommand, cmCableCommand);
private:
void WriteConfiguration() const;
std::string GenerateTag(const std::string&) const;
private:
typedef std::pair<std::string, std::string> Element;
typedef std::vector<Element> Elements;
/**
* The name of the set.
*/
std::string m_SetName;
/**
* The elements to be defined in the set (before $ expansion).
*/
Elements m_Elements;
};
#endif