runtime/ConsoleClient.h

   1 /*
   2  * Copyright (C) 2014 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 ConsoleClient_h
  27 #define ConsoleClient_h
  28
  29 #include "ConsoleTypes.h"
  30 #include <wtf/Forward.h>
  31
  32 namespace Inspector {
  33 class ScriptArguments;
  34 }
  35
  36 namespace JSC {
  37
  38 class ExecState;
  39
  40 class ConsoleClient {
  41 public:
  42     virtual ~ConsoleClient() { }
  43
  44     JS_EXPORT_PRIVATE static void printConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& url, unsigned lineNumber, unsigned columnNumber);
  45     JS_EXPORT_PRIVATE static void printConsoleMessageWithArguments(MessageSource, MessageType, MessageLevel, JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  46
  47     void logWithLevel(ExecState*, RefPtr<Inspector::ScriptArguments>&&, MessageLevel);
  48     void clear(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  49     void dir(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  50     void dirXML(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  51     void table(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  52     void trace(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  53     void assertCondition(ExecState*, RefPtr<Inspector::ScriptArguments>&&, bool condition);
  54     void group(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  55     void groupCollapsed(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  56     void groupEnd(ExecState*, RefPtr<Inspector::ScriptArguments>&&);
  57
  58     virtual void messageWithTypeAndLevel(MessageType, MessageLevel, JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&) = 0;
  59     virtual void count(ExecState*, RefPtr<Inspector::ScriptArguments>&&) = 0;
  60     virtual void profile(ExecState*, const String& title) = 0;
  61     virtual void profileEnd(ExecState*, const String& title) = 0;
  62     virtual void time(ExecState*, const String& title) = 0;
  63     virtual void timeEnd(ExecState*, const String& title) = 0;
  64     virtual void timeStamp(ExecState*, RefPtr<Inspector::ScriptArguments>&&) = 0;
  65
  66 private:
  67     enum ArgumentRequirement { ArgumentRequired, ArgumentNotRequired };
  68     void internalMessageWithTypeAndLevel(MessageType, MessageLevel, JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&, ArgumentRequirement);
  69 };
  70
  71 } // namespace JSC
  72
  73 #endif // ConsoleClient_h