extensions/source/logging/loghandler.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 INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGHANDLER_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGHANDLER_HXX
  22
  23 #include <com/sun/star/logging/XLogFormatter.hpp>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25 #include <com/sun/star/logging/LogRecord.hpp>
  26
  27 #include <comphelper/namedvaluecollection.hxx>
  28 #include <cppuhelper/interfacecontainer.hxx>
  29 #include <rtl/string.hxx>
  30
  31
  32 namespace logging
  33 {
  34
  35     class LogHandlerHelper
  36     {
  37     private:
  38         // <attributes>
  39         rtl_TextEncoding            m_eEncoding;
  40         sal_Int32                   m_nLevel;
  41         css::uno::Reference< css::logging::XLogFormatter >
  42                                     m_xFormatter;
  43         // <//attributes>
  44
  45         css::uno::Reference< css::uno::XComponentContext >
  46                                     m_xContext;
  47         ::osl::Mutex&               m_rMutex;
  48         ::cppu::OBroadcastHelper&   m_rBHelper;
  49         bool                        m_bInitialized;
  50
  51     public:
  52         LogHandlerHelper(
  53             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  54             ::osl::Mutex& _rMutex,
  55             ::cppu::OBroadcastHelper& _rBHelper
  56         );
  57
  58     public:
  59         void    setIsInitialized() { m_bInitialized = true; }
  60
  61         bool    getEncoding(        OUString& _out_rEncoding ) const;
  62         bool    setEncoding( const  OUString& _rEncoding     );
  63
  64         rtl_TextEncoding
  65                 getTextEncoding() const { return m_eEncoding; }
  66
  67         const css::uno::Reference< css::logging::XLogFormatter >&
  68                 getFormatter() const { return m_xFormatter; }
  69         void
  70                 setFormatter( const css::uno::Reference< css::logging::XLogFormatter >& _rxFormatter )
  71                 {
  72                     m_xFormatter = _rxFormatter;
  73                 }
  74
  75         sal_Int32
  76                 getLevel() const { return m_nLevel; }
  77         void
  78                 setLevel( const sal_Int32 _nLevel )
  79                 {
  80                     m_nLevel = _nLevel;
  81                 }
  82
  83         /** prepares implementation of an public accessible method of a log handler
  84
  85             <code>enterMethod</code> does the following things:
  86             <ul><li>It acquires the mutex given in the constructor.</li>
  87                 <li>It checks whether the component is already initialized, and throws an exception if not os.</li>
  88                 <li>It checks whether the component is already disposed, and throws an exception if not os.</li>
  89                 <li>It creates a default formatter (PlainTextFormatter), if no formatter exists at this time.</li>
  90             </ul>
  91         */
  92         void enterMethod();
  93
  94         /** formats a record for publishing it
  95
  96             The method first checks whether the records log level is greater or equal our own
  97             log level. If not, <FALSE/> is returned.
  98
  99             Second, our formatter is used to create a unicode string from the log record. If an error occurs
 100             during this, e.g. if the formatter is <NULL/> or throws an exception during formatting,
 101             <FALSE/> is returned.
 102
 103             Finally, the unicode string is encoded into a byte string, using our encoding setting. Then,
 104             <TRUE/> is returned.
 105         */
 106         bool    formatForPublishing( const css::logging::LogRecord& _rRecord, OString& _out_rEntry ) const;
 107
 108         /** retrieves our formatter's heading, encoded with our encoding
 109
 110             @return <TRUE/> in case of success, <FALSE/> if any error occurred
 111         */
 112         bool    getEncodedHead( OString& _out_rHead ) const;
 113
 114         /** retrieves our formatter's tail, encoded with our encoding
 115
 116             @return <TRUE/> in case of success, <FALSE/> if any error occurred
 117         */
 118         bool    getEncodedTail( OString& _out_rTail ) const;
 119
 120         /** initializes the instance from a collection of named settings
 121
 122             The recognized named settings are <code>Encoding</code>, <code>Formatter</code>, and <code>Level</code>,
 123             which initialize the respective attributes.
 124
 125             Settings which are recognized are remove from the given collection. This allows
 126             the caller to determine whether or not the collection contained any unsupported
 127             items, and react appropriately.
 128
 129             @throws IllegalArgumentException
 130                 if one of the values in the collection is of wrong type.
 131         */
 132         void    initFromSettings( const ::comphelper::NamedValueCollection& _rSettings );
 133     };
 134
 135
 136 } // namespace logging
 137
 138
 139 #endif // INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGHANDLER_HXX
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */