blob: 03ab94b1cb8d93719cc6c7e1c871966fcab6cc30 (
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
|
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License 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,
cmExecutionStatus &status);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "message";}
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Display a message to the user.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR]\n"
" \"message to display\" ...)\n"
"The optional keyword determines the type of message:\n"
" (none) = Important information\n"
" STATUS = Incidental information\n"
" WARNING = CMake Warning, continue processing\n"
" AUTHOR_WARNING = CMake Warning (dev), continue processing\n"
" SEND_ERROR = CMake Error, continue but skip generation\n"
" FATAL_ERROR = CMake Error, stop all processing\n"
"The CMake command-line tool displays STATUS messages on stdout "
"and all other message types on stderr. "
"The CMake GUI displays all messages in its log area. "
"The interactive dialogs (ccmake and CMakeSetup) show STATUS messages "
"one at a time on a status line and other messages in interactive "
"pop-up boxes."
"\n"
"CMake Warning and Error message text displays using a simple "
"markup language. "
"Non-indented text is formatted in line-wrapped paragraphs delimited "
"by newlines. "
"Indented text is considered pre-formatted."
;
}
cmTypeMacro(cmMessageCommand, cmCommand);
};
#endif
|
