Logger.h revision 221a25e58e92ebc450c7eaba5f3ba8153a2308ae 
1/*
2 * Copyright (c) 2015, Intel Corporation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation and/or
13 * other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30#pragma once
31
32#include "log/ILogger.h"
33#include "log/LogWrapper.h"
34
35#include "NonCopyable.hpp"
36
37namespace core
38{
39namespace log
40{
41
42/** Application logger object (Thread unsafe)
43 * Provide contextualisable logging API.
44 * Streams can be used through Info and Warning objects returned by dedicated
45 * methods.
46 * This is the class you want to use to log in the project.
47 */
48class Logger : private utility::NonCopyable
49{
50public:
51    /** Context class is friend let the prolog by externally modified */
52    friend class Context;
53
54    /** @param[in] logger raw logger provided by client */
55    Logger(ILogger &logger) : mLogger(logger) {}
56
57    /**
58     * Retrieve wrapped information logger
59     *
60     * @return Info logger
61     */
62    details::Info info() { return details::Info(mLogger, mProlog); }
63
64    /**
65     * Retrieve wrapped warning logger
66     *
67     * @return Warning logger
68     */
69    details::Warning warning() { return details::Warning(mLogger, mProlog); }
70
71private:
72    /** Raw logger provided by client */
73    ILogger &mLogger;
74
75    /** Log prolog, owns the context indentation */
76    std::string mProlog;
77};
78
79} /** log namespace */
80} /** core namespace */
81