inspector/ConsoleMessage.h

   1 /*
   2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
   3  * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
   4  * Copyright (C) 2009, 2010 Google Inc. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1.  Redistributions of source code must retain the above copyright
  11  *     notice, this list of conditions and the following disclaimer.
  12  * 2.  Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in the
  14  *     documentation and/or other materials provided with the distribution.
  15  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  16  *     its contributors may be used to endorse or promote products derived
  17  *     from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  20  * 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 APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  23  * 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
  26  * ON 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
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef ConsoleMessage_h
  32 #define ConsoleMessage_h
  33
  34 #if ENABLE(INSPECTOR)
  35
  36 #include "ConsoleTypes.h"
  37 #include "InspectorJSFrontendDispatchers.h"
  38 #include <wtf/Forward.h>
  39
  40 namespace JSC {
  41 class ExecState;
  42 }
  43
  44 namespace Inspector {
  45
  46 class InjectedScriptManager;
  47 class ScriptArguments;
  48 class ScriptCallStack;
  49
  50 class JS_EXPORT_PRIVATE ConsoleMessage {
  51     WTF_MAKE_NONCOPYABLE(ConsoleMessage);
  52     WTF_MAKE_FAST_ALLOCATED;
  53 public:
  54     ConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, unsigned long requestIdentifier = 0);
  55     ConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& url, unsigned line, unsigned column, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0);
  56     ConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, PassRefPtr<ScriptCallStack>, unsigned long requestIdentifier = 0);
  57     ConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, PassRefPtr<ScriptArguments>, JSC::ExecState*, unsigned long requestIdentifier = 0);
  58     ~ConsoleMessage();
  59
  60     void addToFrontend(InspectorConsoleFrontendDispatcher*, InjectedScriptManager*, bool generatePreview);
  61     void updateRepeatCountInConsole(InspectorConsoleFrontendDispatcher*);
  62
  63     MessageSource source() const { return m_source; }
  64     const String& message() const { return m_message; }
  65     MessageType type() const { return m_type; }
  66     JSC::ExecState* scriptState() const;
  67
  68     void incrementCount() { ++m_repeatCount; }
  69
  70     unsigned argumentCount() const;
  71
  72     bool isEqual(ConsoleMessage* msg) const;
  73
  74     void clear();
  75
  76 private:
  77     void autogenerateMetadata(JSC::ExecState* = nullptr);
  78
  79     MessageSource m_source;
  80     MessageType m_type;
  81     MessageLevel m_level;
  82     String m_message;
  83     RefPtr<ScriptArguments> m_arguments;
  84     RefPtr<ScriptCallStack> m_callStack;
  85     String m_url;
  86     unsigned m_line;
  87     unsigned m_column;
  88     unsigned m_repeatCount;
  89     String m_requestId;
  90 };
  91
  92 } // namespace Inspector
  93
  94 #endif // ConsoleMessage_h
  95
  96 #endif // ENABLE(INSPECTOR)