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