src/third_party/WebKit/Source/core/frame/FrameConsole.h

   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/v8/ScriptState.h"
  33 #include "core/frame/ConsoleTypes.h"
  34 #include "core/inspector/ScriptCallStack.h"
  35 #include "wtf/Forward.h"
  36 #include "wtf/PassOwnPtr.h"
  37
  38 namespace WebCore {
  39
  40 class FrameHost;
  41
  42 // FrameConsole takes per-frame console messages and routes them up through the FrameHost to the ChromeClient and Inspector.
  43 // It's meant as an abstraction around ChromeClient calls and the way that Blink core/ can add messages to the console.
  44 class FrameConsole FINAL {
  45 public:
  46     static PassOwnPtr<FrameConsole> create(LocalFrame& frame) { return adoptPtr(new FrameConsole(frame)); }
  47
  48     void addMessage(MessageSource, MessageLevel, const String& message);
  49     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber = 0, PassRefPtr<ScriptCallStack> = nullptr, ScriptState* = 0, unsigned long requestIdentifier = 0);
  50     void addMessage(MessageSource, MessageLevel, const String& message, PassRefPtr<ScriptCallStack>);
  51     static String formatStackTraceString(const String& originalMessage, PassRefPtr<ScriptCallStack>);
  52
  53     static void mute();
  54     static void unmute();
  55
  56 private:
  57     explicit FrameConsole(LocalFrame&);
  58
  59     LocalFrame& m_frame;
  60 };
  61
  62 } // namespace WebCore
  63
  64 #endif // FrameConsole_h