1
/*=========================================================================
3
Program: Insight Segmentation & Registration Toolkit
4
Module: $RCSfile: cmAddCustomTargetCommand.h,v $
6
Date: $Date: 2001/09/20 19:08:13 $
7
Version: $Revision: 1.5 $
9
Copyright (c) 2001 Insight Consortium
12
Redistribution and use in source and binary forms, with or without
13
modification, are permitted provided that the following conditions are met:
15
* Redistributions of source code must retain the above copyright notice,
16
this list of conditions and the following disclaimer.
18
* Redistributions in binary form must reproduce the above copyright notice,
19
this list of conditions and the following disclaimer in the documentation
20
and/or other materials provided with the distribution.
22
* The name of the Insight Consortium, nor the names of any consortium members,
23
nor of any contributors, may be used to endorse or promote products derived
24
from this software without specific prior written permission.
26
* Modified source versions must be plainly marked as such, and must not be
27
misrepresented as being the original software.
29
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS''
30
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
33
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
36
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
37
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
=========================================================================*/
41
#ifndef cmAddCustomTargetCommand_h
42
#define cmAddCustomTargetCommand_h
44
#include "cmStandardIncludes.h"
45
#include "cmCommand.h"
47
/** \class cmAddCustomTargetCommand
48
* \brief Command that adds a target to the build system.
50
* cmAddCustomTargetCommand adds an extra target to the build system.
51
* This is useful when you would like to add special
52
* targets like "install,", "clean," and so on.
54
class cmAddCustomTargetCommand : public cmCommand
58
* This is a virtual constructor for the command.
60
virtual cmCommand* Clone()
62
return new cmAddCustomTargetCommand;
66
* This is called when the command is first encountered in
67
* the CMakeLists.txt file.
69
virtual bool InitialPass(std::vector<std::string> const& args);
72
* The name of the command as specified in CMakeList.txt.
74
virtual const char* GetName()
75
{return "ADD_CUSTOM_TARGET";}
78
* Succinct documentation.
80
virtual const char* GetTerseDocumentation()
82
return "Add an extra target to the build system that "
83
"does not produce output, so it"
84
" is run each time the target is built.";
90
virtual const char* GetFullDocumentation()
93
"ADD_CUSTOM_TARGET(Name [ALL] command arg arg arg ...)\n"
94
"The ALL option is optional. If it is specified it indicates that this target should be added to the Build all target.";
97
cmTypeMacro(cmAddCustomTargetCommand, cmCommand);