Add a WebCore logging channel for images
[WebKit-https.git] / Source / WebCore / platform / Logging.h
1 /*
2  * Copyright (C) 2003, 2006, 2013, 2015 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 #ifndef Logging_h
27 #define Logging_h
28
29 #include <functional>
30 #include <wtf/Assertions.h>
31 #include <wtf/Forward.h>
32
33 namespace WebCore {
34
35 #if LOG_DISABLED
36
37 #define LOG_RESULT(channel, function) ((void)0)
38 #define LOG_WITH_STREAM(channel, commands) ((void)0)
39
40 #else
41
42 #ifndef LOG_CHANNEL_PREFIX
43 #define LOG_CHANNEL_PREFIX Log
44 #endif
45
46 #define WEBCORE_LOG_CHANNELS(M) \
47     M(Animations) \
48     M(Archives) \
49     M(Compositing) \
50     M(ContentFiltering) \
51     M(DisplayLists) \
52     M(DOMTimers) \
53     M(Editing) \
54     M(Events) \
55     M(FTP) \
56     M(FileAPI) \
57     M(Frames) \
58     M(Fullscreen) \
59     M(Gamepad) \
60     M(History) \
61     M(IconDatabase) \
62     M(Images) \
63     M(IndexedDB) \
64     M(Layout) \
65     M(Loading) \
66     M(Media) \
67     M(MediaSource) \
68     M(MediaSourceSamples) \
69     M(MemoryPressure) \
70     M(Network) \
71     M(NotYetImplemented) \
72     M(PageCache) \
73     M(PlatformLeaks) \
74     M(Plugins) \
75     M(PopupBlocking) \
76     M(Progress) \
77     M(RemoteInspector) \
78     M(ResourceLoading) \
79     M(SQLDatabase) \
80     M(SVG) \
81     M(Services) \
82     M(Scrolling) \
83     M(SpellingAndGrammar) \
84     M(StorageAPI) \
85     M(TextAutosizing) \
86     M(Threading) \
87     M(WebAudio) \
88     M(WebGL) \
89     M(WebReplay) \
90     M(WheelEventTestTriggers) \
91     M(ResourceLoadObserver) \
92
93 #define DECLARE_LOG_CHANNEL(name) \
94     WEBCORE_EXPORT extern WTFLogChannel JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, name);
95
96 WEBCORE_LOG_CHANNELS(DECLARE_LOG_CHANNEL)
97
98 #undef DECLARE_LOG_CHANNEL
99
100 String logLevelString();
101 bool isLogChannelEnabled(const String& name);
102 WEBCORE_EXPORT void setLogChannelToAccumulate(const String& name);
103 WEBCORE_EXPORT void initializeLoggingChannelsIfNecessary();
104 #ifndef NDEBUG
105 void registerNotifyCallback(const String& notifyID, std::function<void()> callback);
106 #endif
107
108 void logFunctionResult(WTFLogChannel*, std::function<const char*()>);
109
110 #define LOG_RESULT(channel, function) logFunctionResult(&JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), function)
111
112 #define LOG_WITH_STREAM(channel, commands) logFunctionResult(&JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), \
113     [&]() { \
114         TextStream stream(TextStream::LineMode::SingleLine); \
115         commands; \
116         return stream.release().utf8().data(); \
117     });
118
119 #endif // !LOG_DISABLED
120
121 } // namespace WebCore
122
123 #endif // Logging_h