summaryrefslogtreecommitdiff
path: root/autodoc/source/inc/adc_msg.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'autodoc/source/inc/adc_msg.hxx')
-rw-r--r--autodoc/source/inc/adc_msg.hxx144
1 files changed, 144 insertions, 0 deletions
diff --git a/autodoc/source/inc/adc_msg.hxx b/autodoc/source/inc/adc_msg.hxx
new file mode 100644
index 000000000000..8562056eea99
--- /dev/null
+++ b/autodoc/source/inc/adc_msg.hxx
@@ -0,0 +1,144 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */