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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: adc_msg.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: rt $ $Date: 2005-09-07 18:08:39 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef ADC_ADC_MSG_HXX
#define ADC_ADC_MSG_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
namespace csv
{
class File;
}
namespace autodoc
{
/** Gathers, sorts and displays (mainly diagnostic) messages to the
user of Autodoc.
*/
class Messages
{
public:
// LIFECYCLE
Messages();
~Messages();
// OPERATIONS
void WriteFile(
const String & i_sOutputFilePath);
// INQUIRY
// ACCESS
void Out_MissingDoc(
const String & i_sEntity,
const String & i_sFile,
uintt i_nLine);
void Out_ParseError(
const String & i_sFile,
uintt i_nLine);
void Out_InvalidConstSymbol(
const String & i_sText,
const String & i_sFile,
uintt i_nLine);
void Out_UnresolvedLink(
const String & i_sLinkText,
const String & i_sFile,
uintt i_nLine);
void Out_TypeVsMemberMisuse(
const String & i_sLinkText,
const String & i_sFile,
uintt i_nLine);
static Messages & The_();
private:
struct Location
{
String sFile;
uintt nLine;
Location(
const String & i_file,
uintt i_line)
: sFile(i_file),
nLine(i_line) {}
bool operator<(
const Location & i_other) const
{ int cmp = csv::compare(sFile,i_other.sFile);
return cmp < 0
? true
: cmp > 0
? false
: nLine < i_other.nLine;
}
};
typedef std::map<Location,String> MessageMap;
// Locals
void AddValue(
MessageMap & o_dest,
const String & i_sText,
const String & i_sFile,
uintt i_nLine );
void WriteParagraph(
csv::File & o_out,
const MessageMap & i_source,
const String & i_title,
const String & i_firstIntermediateText );
// DATA
MessageMap aMissingDocs;
MessageMap aParseErrors;
MessageMap aInvalidConstSymbols;
MessageMap aUnresolvedLinks;
MessageMap aTypeVsMemberMisuses;
};
// IMPLEMENTATION
} // namespace autodoc
inline autodoc::Messages &
TheMessages()
{
return autodoc::Messages::The_();
}
#endif
|
