1/*
2 * Copyright (C) 2013 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef FrameConsole_h
30#define FrameConsole_h
31
32#include "bindings/core/v8/ScriptState.h"
33#include "core/frame/ConsoleTypes.h"
34#include "platform/heap/Handle.h"
35#include "wtf/Forward.h"
36#include "wtf/PassOwnPtr.h"
37
38namespace blink {
39
40class ConsoleMessage;
41class ConsoleMessageStorage;
42class DocumentLoader;
43class ResourceResponse;
44class ScriptCallStack;
45class WorkerGlobalScopeProxy;
46
47// FrameConsole takes per-frame console messages and routes them up through the FrameHost to the ChromeClient and Inspector.
48// It's meant as an abstraction around ChromeClient calls and the way that Blink core/ can add messages to the console.
49class FrameConsole FINAL : public NoBaseWillBeGarbageCollected<FrameConsole> {
50    DECLARE_EMPTY_DESTRUCTOR_WILL_BE_REMOVED(FrameConsole);
51public:
52    static PassOwnPtrWillBeRawPtr<FrameConsole> create(LocalFrame& frame)
53    {
54        return adoptPtrWillBeNoop(new FrameConsole(frame));
55    }
56
57    void addMessage(PassRefPtrWillBeRawPtr<ConsoleMessage>);
58    void adoptWorkerMessagesAfterTermination(WorkerGlobalScopeProxy*);
59
60    void reportResourceResponseReceived(DocumentLoader*, unsigned long requestIdentifier, const ResourceResponse&);
61
62    static String formatStackTraceString(const String& originalMessage, PassRefPtrWillBeRawPtr<ScriptCallStack>);
63
64    static void mute();
65    static void unmute();
66
67    ConsoleMessageStorage* messageStorage();
68    void clearMessages();
69
70    void trace(Visitor*);
71
72private:
73    explicit FrameConsole(LocalFrame&);
74
75    LocalFrame& frame() const
76    {
77        ASSERT(m_frame);
78        return *m_frame;
79    }
80
81    RawPtrWillBeMember<LocalFrame> m_frame;
82    OwnPtrWillBeMember<ConsoleMessageStorage> m_consoleMessageStorage;
83};
84
85} // namespace blink
86
87#endif // FrameConsole_h
88