e82647447c18d408590bc1eb0d0612434e580da5
[WebKit-https.git] / Source / WTF / wtf / LoggerHelper.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Logger.h>
29
30 namespace WTF {
31
32 class LoggerHelper {
33 public:
34     virtual ~LoggerHelper() = default;
35
36     virtual const Logger& logger() const = 0;
37     virtual const char* logClassName() const = 0;
38     virtual WTFLogChannel& logChannel() const = 0;
39     virtual const void* logIdentifier() const = 0;
40
41 #if !RELEASE_LOG_DISABLED
42
43 #define LOGIDENTIFIER WTF::Logger::LogSiteIdentifier(logClassName(), __func__, logIdentifier())
44
45 #define ALWAYS_LOG(...)     logger().logAlways(logChannel(), __VA_ARGS__)
46 #define ERROR_LOG(...)      logger().error(logChannel(), __VA_ARGS__)
47 #define WARNING_LOG(...)    logger().warning(logChannel(), __VA_ARGS__)
48 #define NOTICE_LOG(...)     logger().notice(logChannel(), __VA_ARGS__)
49 #define INFO_LOG(...)       logger().info(logChannel(), __VA_ARGS__)
50 #define DEBUG_LOG(...)      logger().debug(logChannel(), __VA_ARGS__)
51 #define WILL_LOG(_level_)   logger().willLog(logChannel(), _level_)
52
53     const void* childLogIdentifier(uint64_t identifier) const
54     {
55         static const int64_t parentMask = 0xffffffffffff0000l;
56         static const int64_t maskLowerWord = 0xffffl;
57         return reinterpret_cast<const void*>((reinterpret_cast<uint64_t>(logIdentifier()) & parentMask) | (identifier & maskLowerWord));
58     }
59 #else
60
61 #define LOGIDENTIFIER (WTF::nullopt)
62
63 #define ALWAYS_LOG(...)     ((void)0)
64 #define ERROR_LOG(...)      ((void)0)
65 #define ERROR_LOG(...)      ((void)0)
66 #define WARNING_LOG(...)    ((void)0)
67 #define NOTICE_LOG(...)     ((void)0)
68 #define INFO_LOG(...)       ((void)0)
69 #define DEBUG_LOG(...)      ((void)0)
70 #define WILL_LOG(_level_)   false
71
72 #endif
73     
74 };
75
76 } // namespace WTF
77
78 using WTF::LoggerHelper;
79