blob: 921c45584c07d4d241971fbedf35a8757b0d5ad5 (
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
|
/*=========================================================================
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 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() { return "utility_source";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Specify the source tree of a third-party utility.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" utility_source(cache_entry executable_name\n"
" path_to_source [file1 file2 ...])\n"
"When a third-party utility's source is included in the distribution, "
"this command specifies its location and name. The cache entry will "
"not be set unless the path_to_source and all listed files exist. It "
"is assumed that the source tree of the utility will have been built "
"before it is needed.\n"
"When cross compiling CMake will print a warning if a utility_source() "
"command is executed, because in many cases it is used to build an "
"executable which is executed later on. This doesn't work when "
"cross compiling, since the executable can run only on their target "
"platform. So in this case the cache entry has to be adjusted manually "
"so it points to an executable which is runnable on the build host.";
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
cmTypeMacro(cmUtilitySourceCommand, cmCommand);
};
#endif
|
