autodoc/source/inc/adc_msg.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_ADC_MSG_HXX
  21 #define ADC_ADC_MSG_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27     // COMPONENTS
  28     // PARAMETERS
  29 namespace csv
  30 {
  31     class File;
  32 }
  33
  34
  35 namespace autodoc
  36 {
  37
  38
  39 /** Gathers, sorts and displays (mainly diagnostic) messages to the
  40     user of Autodoc.
  41 */
  42 class Messages
  43 {
  44   public:
  45     // LIFECYCLE
  46                         Messages();
  47                         ~Messages();
  48     // OPERATIONS
  49     void                WriteFile(
  50                             const String &      i_sOutputFilePath);
  51     // INQUIRY
  52
  53     // ACCESS
  54     void                Out_MissingDoc(
  55                             const String &      i_sEntity,
  56                             const String &      i_sFile,
  57                             uintt               i_nLine);
  58     void                Out_ParseError(
  59                             const String &      i_sFile,
  60                             uintt               i_nLine);
  61     void                Out_InvalidConstSymbol(
  62                             const String &      i_sText,
  63                             const String &      i_sFile,
  64                             uintt               i_nLine);
  65     void                Out_UnresolvedLink(
  66                             const String &      i_sLinkText,
  67                             const String &      i_sFile,
  68                             uintt               i_nLine);
  69     void                Out_TypeVsMemberMisuse(
  70                             const String &      i_sLinkText,
  71                             const String &      i_sFile,
  72                             uintt               i_nLine);
  73
  74     static Messages &   The_();
  75
  76   private:
  77     struct Location
  78     {
  79         String              sFile;
  80         uintt               nLine;
  81
  82                             Location(
  83                                 const String &      i_file,
  84                                 uintt               i_line)
  85                                 :   sFile(i_file),
  86                                     nLine(i_line)   {}
  87         bool                operator<(
  88                                 const Location &    i_other) const
  89                                 { int cmp = csv::compare(sFile,i_other.sFile);
  90                                   return cmp < 0
  91                                             ?   true
  92                                             :   cmp > 0
  93                                                     ?   false
  94                                                     :   nLine < i_other.nLine;
  95                                 }
  96     };
  97
  98     typedef std::map<Location,String>   MessageMap;
  99
 100     // Locals
 101     void                AddValue(
 102                             MessageMap &        o_dest,
 103                             const String &      i_sText,
 104                             const String &      i_sFile,
 105                             uintt               i_nLine );
 106     void                WriteParagraph(
 107                             csv::File &         o_out,
 108                             const MessageMap &  i_source,
 109                             const String &      i_title );
 110
 111     // DATA
 112     MessageMap          aMissingDocs;
 113     MessageMap          aParseErrors;
 114     MessageMap          aInvalidConstSymbols;
 115     MessageMap          aUnresolvedLinks;
 116     MessageMap          aTypeVsMemberMisuses;
 117 };
 118
 119
 120
 121 // IMPLEMENTATION
 122
 123
 124 }   // namespace autodoc
 125
 126 inline autodoc::Messages &
 127 TheMessages()
 128 {
 129     return autodoc::Messages::The_();
 130 }
 131
 132 #endif
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */