blob: 02c5c23e970578988c22e131ce77b6e76c835307 (
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
|
/*=========================================================================
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 cmMessageCommand_h
#define cmMessageCommand_h
#include "cmCommand.h"
/** \class cmMessageCommand
* \brief Displays a message to the user
*
*/
class cmMessageCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmMessageCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "message";}
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Display a message to the user.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" message([SEND_ERROR | STATUS | FATAL_ERROR]\n"
" \"message to display\" ...)\n"
"By default the message is displayed in a pop up window (CMakeSetup), "
"or in the stdout of cmake, or the error section of ccmake. "
"If the first argument is "
"SEND_ERROR then an error is raised, and the generate phase will "
"be skipped. If the first argument is FATAL_ERROR, all processing "
"is halted. If the first argument is STATUS then the message is "
"displayed in the progress line for the GUI, or with a -- in the "
"command line cmake.";
}
cmTypeMacro(cmMessageCommand, cmCommand);
};
#endif
|
