autodoc/source/exes/adc_uni/adc_msg.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include <precomp.h>
  30 #include <adc_msg.hxx>
  31
  32
  33 // NOT FULLY DEFINED SERVICES
  34 #include <cosv/file.hxx>
  35 #include <cosv/tpl/tpltools.hxx>
  36
  37
  38 namespace autodoc
  39 {
  40
  41
  42 Messages::Messages()
  43     :   aMissingDocs(),
  44         aParseErrors(),
  45         aInvalidConstSymbols(),
  46         aUnresolvedLinks(),
  47         aTypeVsMemberMisuses()
  48 {
  49 }
  50
  51 Messages::~Messages()
  52 {
  53 }
  54
  55 void
  56 Messages::WriteFile(const String & i_sOutputFilePath)
  57 {
  58     csv::File
  59         aOut(i_sOutputFilePath, csv::CFM_CREATE);
  60     aOut.open();
  61
  62     // KORR_FUTURE Enable this when appropriate:
  63     WriteParagraph( aOut,
  64                     aParseErrors,
  65                     "Incompletely Parsed Files" );
  66
  67     WriteParagraph( aOut,
  68                     aMissingDocs,
  69                     "Entities Without Documentation" );
  70
  71     WriteParagraph( aOut,
  72                     aInvalidConstSymbols,
  73                     "Incorrectly Written Const Symbols" );
  74
  75     WriteParagraph( aOut,
  76                     aUnresolvedLinks,
  77                     "Unresolved Links" );
  78
  79     WriteParagraph( aOut,
  80                     aTypeVsMemberMisuses,
  81                     "Confusion or Misuse of <Type> vs. <Member>" );
  82     aOut.close();
  83 }
  84
  85 void
  86 Messages::Out_MissingDoc(   const String &      i_sEntity,
  87                             const String &      i_sFile,
  88                             uintt               i_nLine)
  89 {
  90     AddValue( aMissingDocs,
  91               i_sEntity,
  92               i_sFile,
  93               i_nLine );
  94 }
  95
  96 void
  97 Messages::Out_ParseError(   const String &      i_sFile,
  98                             uintt               i_nLine)
  99 {
 100     aParseErrors[Location(i_sFile,i_nLine)] = String::Null_();
 101 }
 102
 103 void
 104 Messages::Out_InvalidConstSymbol( const String &      i_sText,
 105                                   const String &      i_sFile,
 106                                   uintt               i_nLine)
 107 {
 108     AddValue( aInvalidConstSymbols,
 109               i_sText,
 110               i_sFile,
 111               i_nLine );
 112 }
 113
 114 void
 115 Messages::Out_UnresolvedLink( const String &      i_sLinkText,
 116                               const String &      i_sFile,
 117                               uintt               i_nLine)
 118 {
 119     AddValue( aUnresolvedLinks,
 120               i_sLinkText,
 121               i_sFile,
 122               i_nLine );
 123 }
 124
 125 void
 126 Messages::Out_TypeVsMemberMisuse( const String &      i_sLinkText,
 127                                   const String &      i_sFile,
 128                                   uintt               i_nLine)
 129 {
 130     AddValue( aTypeVsMemberMisuses,
 131               i_sLinkText,
 132               i_sFile,
 133               i_nLine );
 134 }
 135
 136 Messages &
 137 Messages::The_()
 138 {
 139     static Messages TheMessages_;
 140     return TheMessages_;
 141 }
 142
 143 void
 144 Messages::AddValue( MessageMap &        o_dest,
 145                     const String &      i_sText,
 146                     const String &      i_sFile,
 147                     uintt               i_nLine )
 148 {
 149     String &
 150         rDest = o_dest[Location(i_sFile,i_nLine)];
 151     StreamLock
 152         slDest(2000);
 153     if (NOT rDest.empty())
 154         slDest() << rDest;
 155     slDest() << "\n    " << i_sText;
 156     rDest = slDest().c_str();
 157 }
 158
 159 void
 160 Messages::WriteParagraph( csv::File &         o_out,
 161                           const MessageMap &  i_source,
 162                           const String &      i_title )
 163 {
 164     StreamStr   aLine(2000);
 165
 166     // Write title of paragraph:
 167     aLine << i_title
 168           << "\n";
 169     o_out.write(aLine.c_str());
 170
 171     aLine.seekp(0);
 172     for (uintt i = i_title.size(); i > 0; --i)
 173     {
 174         aLine << '-';
 175     }
 176     aLine << "\n\n";
 177     o_out.write(aLine.c_str());
 178
 179     // Write Content
 180     MessageMap::const_iterator it = i_source.begin();
 181     MessageMap::const_iterator itEnd = i_source.end();
 182     for ( ; it != itEnd; ++it )
 183     {
 184         aLine.seekp(0);
 185         aLine << (*it).first.sFile;
 186         // Nobody wants to see this, if we don't know the line:
 187         if ((*it).first.nLine != 0)
 188         {
 189             aLine << ", line "
 190                   << (*it).first.nLine;
 191         }
 192         if (NOT (*it).second.empty())
 193         {
 194             aLine << ':'
 195                   << (*it).second
 196                   << "\n";
 197         }
 198         o_out.write(aLine.c_str());
 199     }
 200     o_out.write("\n\n\n");
 201 }
 202
 203 }   // namespace autodoc
 204
 205 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */