1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski #include <precomp.h>
23*b1cdbd2cSJim Jagielski #include <adc_msg.hxx>
24*b1cdbd2cSJim Jagielski
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski // NOT FULLY DEFINED SERVICES
27*b1cdbd2cSJim Jagielski #include <cosv/file.hxx>
28*b1cdbd2cSJim Jagielski #include <cosv/tpl/tpltools.hxx>
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski namespace autodoc
32*b1cdbd2cSJim Jagielski {
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski
Messages()35*b1cdbd2cSJim Jagielski Messages::Messages()
36*b1cdbd2cSJim Jagielski : aMissingDocs(),
37*b1cdbd2cSJim Jagielski aParseErrors(),
38*b1cdbd2cSJim Jagielski aInvalidConstSymbols(),
39*b1cdbd2cSJim Jagielski aUnresolvedLinks(),
40*b1cdbd2cSJim Jagielski aTypeVsMemberMisuses()
41*b1cdbd2cSJim Jagielski {
42*b1cdbd2cSJim Jagielski }
43*b1cdbd2cSJim Jagielski
~Messages()44*b1cdbd2cSJim Jagielski Messages::~Messages()
45*b1cdbd2cSJim Jagielski {
46*b1cdbd2cSJim Jagielski }
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski void
WriteFile(const String & i_sOutputFilePath)49*b1cdbd2cSJim Jagielski Messages::WriteFile(const String & i_sOutputFilePath)
50*b1cdbd2cSJim Jagielski {
51*b1cdbd2cSJim Jagielski csv::File
52*b1cdbd2cSJim Jagielski aOut(i_sOutputFilePath, csv::CFM_CREATE);
53*b1cdbd2cSJim Jagielski aOut.open();
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski // KORR_FUTURE Enable this when appropriate:
56*b1cdbd2cSJim Jagielski WriteParagraph( aOut,
57*b1cdbd2cSJim Jagielski aParseErrors,
58*b1cdbd2cSJim Jagielski "Incompletely Parsed Files",
59*b1cdbd2cSJim Jagielski "Stopped parsing at " );
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski WriteParagraph( aOut,
62*b1cdbd2cSJim Jagielski aMissingDocs,
63*b1cdbd2cSJim Jagielski "Entities Without Documentation",
64*b1cdbd2cSJim Jagielski " in " );
65*b1cdbd2cSJim Jagielski
66*b1cdbd2cSJim Jagielski WriteParagraph( aOut,
67*b1cdbd2cSJim Jagielski aInvalidConstSymbols,
68*b1cdbd2cSJim Jagielski "Incorrectly Written Const Symbols",
69*b1cdbd2cSJim Jagielski " in " );
70*b1cdbd2cSJim Jagielski
71*b1cdbd2cSJim Jagielski WriteParagraph( aOut,
72*b1cdbd2cSJim Jagielski aUnresolvedLinks,
73*b1cdbd2cSJim Jagielski "Unresolved Links",
74*b1cdbd2cSJim Jagielski " in\n " );
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski WriteParagraph( aOut,
77*b1cdbd2cSJim Jagielski aTypeVsMemberMisuses,
78*b1cdbd2cSJim Jagielski "Confusion or Misuse of <Type> vs. <Member>",
79*b1cdbd2cSJim Jagielski " in " );
80*b1cdbd2cSJim Jagielski aOut.close();
81*b1cdbd2cSJim Jagielski }
82*b1cdbd2cSJim Jagielski
83*b1cdbd2cSJim Jagielski void
Out_MissingDoc(const String & i_sEntity,const String & i_sFile,uintt i_nLine)84*b1cdbd2cSJim Jagielski Messages::Out_MissingDoc( const String & i_sEntity,
85*b1cdbd2cSJim Jagielski const String & i_sFile,
86*b1cdbd2cSJim Jagielski uintt i_nLine)
87*b1cdbd2cSJim Jagielski {
88*b1cdbd2cSJim Jagielski AddValue( aMissingDocs,
89*b1cdbd2cSJim Jagielski i_sEntity,
90*b1cdbd2cSJim Jagielski i_sFile,
91*b1cdbd2cSJim Jagielski i_nLine );
92*b1cdbd2cSJim Jagielski }
93*b1cdbd2cSJim Jagielski
94*b1cdbd2cSJim Jagielski void
Out_ParseError(const String & i_sFile,uintt i_nLine)95*b1cdbd2cSJim Jagielski Messages::Out_ParseError( const String & i_sFile,
96*b1cdbd2cSJim Jagielski uintt i_nLine)
97*b1cdbd2cSJim Jagielski {
98*b1cdbd2cSJim Jagielski aParseErrors[Location(i_sFile,i_nLine)] = String::Null_();
99*b1cdbd2cSJim Jagielski }
100*b1cdbd2cSJim Jagielski
101*b1cdbd2cSJim Jagielski void
Out_InvalidConstSymbol(const String & i_sText,const String & i_sFile,uintt i_nLine)102*b1cdbd2cSJim Jagielski Messages::Out_InvalidConstSymbol( const String & i_sText,
103*b1cdbd2cSJim Jagielski const String & i_sFile,
104*b1cdbd2cSJim Jagielski uintt i_nLine)
105*b1cdbd2cSJim Jagielski {
106*b1cdbd2cSJim Jagielski AddValue( aInvalidConstSymbols,
107*b1cdbd2cSJim Jagielski i_sText,
108*b1cdbd2cSJim Jagielski i_sFile,
109*b1cdbd2cSJim Jagielski i_nLine );
110*b1cdbd2cSJim Jagielski }
111*b1cdbd2cSJim Jagielski
112*b1cdbd2cSJim Jagielski void
Out_UnresolvedLink(const String & i_sLinkText,const String & i_sFile,uintt i_nLine)113*b1cdbd2cSJim Jagielski Messages::Out_UnresolvedLink( const String & i_sLinkText,
114*b1cdbd2cSJim Jagielski const String & i_sFile,
115*b1cdbd2cSJim Jagielski uintt i_nLine)
116*b1cdbd2cSJim Jagielski {
117*b1cdbd2cSJim Jagielski AddValue( aUnresolvedLinks,
118*b1cdbd2cSJim Jagielski i_sLinkText,
119*b1cdbd2cSJim Jagielski i_sFile,
120*b1cdbd2cSJim Jagielski i_nLine );
121*b1cdbd2cSJim Jagielski }
122*b1cdbd2cSJim Jagielski
123*b1cdbd2cSJim Jagielski void
Out_TypeVsMemberMisuse(const String & i_sLinkText,const String & i_sFile,uintt i_nLine)124*b1cdbd2cSJim Jagielski Messages::Out_TypeVsMemberMisuse( const String & i_sLinkText,
125*b1cdbd2cSJim Jagielski const String & i_sFile,
126*b1cdbd2cSJim Jagielski uintt i_nLine)
127*b1cdbd2cSJim Jagielski {
128*b1cdbd2cSJim Jagielski AddValue( aTypeVsMemberMisuses,
129*b1cdbd2cSJim Jagielski i_sLinkText,
130*b1cdbd2cSJim Jagielski i_sFile,
131*b1cdbd2cSJim Jagielski i_nLine );
132*b1cdbd2cSJim Jagielski }
133*b1cdbd2cSJim Jagielski
134*b1cdbd2cSJim Jagielski Messages &
The_()135*b1cdbd2cSJim Jagielski Messages::The_()
136*b1cdbd2cSJim Jagielski {
137*b1cdbd2cSJim Jagielski static Messages TheMessages_;
138*b1cdbd2cSJim Jagielski return TheMessages_;
139*b1cdbd2cSJim Jagielski }
140*b1cdbd2cSJim Jagielski
141*b1cdbd2cSJim Jagielski void
AddValue(MessageMap & o_dest,const String & i_sText,const String & i_sFile,uintt i_nLine)142*b1cdbd2cSJim Jagielski Messages::AddValue( MessageMap & o_dest,
143*b1cdbd2cSJim Jagielski const String & i_sText,
144*b1cdbd2cSJim Jagielski const String & i_sFile,
145*b1cdbd2cSJim Jagielski uintt i_nLine )
146*b1cdbd2cSJim Jagielski {
147*b1cdbd2cSJim Jagielski String &
148*b1cdbd2cSJim Jagielski rDest = o_dest[Location(i_sFile,i_nLine)];
149*b1cdbd2cSJim Jagielski StreamLock
150*b1cdbd2cSJim Jagielski slDest(2000);
151*b1cdbd2cSJim Jagielski if (NOT rDest.empty())
152*b1cdbd2cSJim Jagielski slDest() << rDest;
153*b1cdbd2cSJim Jagielski slDest() << "\n " << i_sText;
154*b1cdbd2cSJim Jagielski rDest = slDest().c_str();
155*b1cdbd2cSJim Jagielski }
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski void
WriteParagraph(csv::File & o_out,const MessageMap & i_source,const String & i_title,const String &)158*b1cdbd2cSJim Jagielski Messages::WriteParagraph( csv::File & o_out,
159*b1cdbd2cSJim Jagielski const MessageMap & i_source,
160*b1cdbd2cSJim Jagielski const String & i_title,
161*b1cdbd2cSJim Jagielski const String & )
162*b1cdbd2cSJim Jagielski {
163*b1cdbd2cSJim Jagielski StreamStr aLine(2000);
164*b1cdbd2cSJim Jagielski
165*b1cdbd2cSJim Jagielski // Write title of paragraph:
166*b1cdbd2cSJim Jagielski aLine << i_title
167*b1cdbd2cSJim Jagielski << "\n";
168*b1cdbd2cSJim Jagielski o_out.write(aLine.c_str());
169*b1cdbd2cSJim Jagielski
170*b1cdbd2cSJim Jagielski aLine.seekp(0);
171*b1cdbd2cSJim Jagielski for (uintt i = i_title.size(); i > 0; --i)
172*b1cdbd2cSJim Jagielski {
173*b1cdbd2cSJim Jagielski aLine << '-';
174*b1cdbd2cSJim Jagielski }
175*b1cdbd2cSJim Jagielski aLine << "\n\n";
176*b1cdbd2cSJim Jagielski o_out.write(aLine.c_str());
177*b1cdbd2cSJim Jagielski
178*b1cdbd2cSJim Jagielski // Write Content
179*b1cdbd2cSJim Jagielski MessageMap::const_iterator it = i_source.begin();
180*b1cdbd2cSJim Jagielski MessageMap::const_iterator itEnd = i_source.end();
181*b1cdbd2cSJim Jagielski for ( ; it != itEnd; ++it )
182*b1cdbd2cSJim Jagielski {
183*b1cdbd2cSJim Jagielski aLine.seekp(0);
184*b1cdbd2cSJim Jagielski aLine << (*it).first.sFile;
185*b1cdbd2cSJim Jagielski // Nobody wants to see this, if we don't know the line:
186*b1cdbd2cSJim Jagielski if ((*it).first.nLine != 0)
187*b1cdbd2cSJim Jagielski {
188*b1cdbd2cSJim Jagielski aLine << ", line "
189*b1cdbd2cSJim Jagielski << (*it).first.nLine;
190*b1cdbd2cSJim Jagielski }
191*b1cdbd2cSJim Jagielski if (NOT (*it).second.empty())
192*b1cdbd2cSJim Jagielski {
193*b1cdbd2cSJim Jagielski aLine << ':'
194*b1cdbd2cSJim Jagielski << (*it).second
195*b1cdbd2cSJim Jagielski << "\n";
196*b1cdbd2cSJim Jagielski }
197*b1cdbd2cSJim Jagielski o_out.write(aLine.c_str());
198*b1cdbd2cSJim Jagielski }
199*b1cdbd2cSJim Jagielski o_out.write("\n\n\n");
200*b1cdbd2cSJim Jagielski }
201*b1cdbd2cSJim Jagielski
202*b1cdbd2cSJim Jagielski } // namespace autodoc
203