blob: b158ca31e0fbe8589c62b995fbe567f1a9fb621f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmAddCustomCommandCommand_h
#define cmAddCustomCommandCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmAddCustomCommandCommand
* \brief
*
* cmAddCustomCommandCommand defines a new command that can
* be executed within the CMake
*
* In makefile terms this creates new target in the following form:
* OUTPUT1: SOURCE DEPENDS
* COMMAND ARGS
* OUTPUT2: SOURCE DEPENDS
* COMMAND ARGS
* ...
* Example of usage:
* ADD_CUSTOM_COMMAND(
* SOURCE ${VTK_TIFF_FAX_EXE}
* COMMAND ${VTK_TIFF_FAX_EXE}
* ARGS -c const ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c
* TARGET vtktiff
* OUTPUTS ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c
* )
* This will create custom target which will generate file tif_fax3sm.c
* using command ${VTK_TIFF_FAX_EXE}.
*/
class cmAddCustomCommandCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmAddCustomCommandCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& 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 "ADD_CUSTOM_COMMAND";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Create new command within CMake.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"ADD_CUSTOM_COMMAND([SOURCE source] [COMMAND command] TARGET target "
"[ARGS [args...]] [DEPENDS [depends...]] [OUTPUTS [outputs...]] [COMMENT comment])\n"
"This defines a new command that can be executed during the build "
"process. In makefile terms this creates a new target in the following form:<pre><code>\n"
"OUTPUT1: SOURCE DEPENDS\n"
" COMAND ARGS\n"
"OUTPUT2: SOURCE DEPENDS\n"
" COMAND ARGS\n"
" Example of usage:\n"
" ADD_CUSTOM_COMMAND(\n"
" SOURCE ${VTK_TIFF_FAX_EXE} \n"
" COMMAND ${VTK_TIFF_FAX_EXE} \n"
" ARGS -c const ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c \n"
" TARGET vtktiff \n"
" OUTPUTS ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c\n"
" )\n"
"This will create custom target which will generate file tif_fax3sm.c\n"
"using command ${VTK_TIFF_FAX_EXE}.</pre></code>";
}
cmTypeMacro(cmAddCustomCommandCommand, cmCommand);
};
#endif
|
