Source/WebCore/page/Console.h

   1 /*
   2  * Copyright (C) 2007 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 Console_h
  30 #define Console_h
  31
  32 #include "ConsoleTypes.h"
  33 #include "DOMWindowProperty.h"
  34 #include "ScriptCallStack.h"
  35 #include "ScriptProfile.h"
  36 #include "ScriptState.h"
  37 #include <wtf/Forward.h>
  38 #include <wtf/PassRefPtr.h>
  39 #include <wtf/RefCounted.h>
  40
  41 namespace WebCore {
  42
  43 class Frame;
  44 class MemoryInfo;
  45 class Page;
  46 class ScriptArguments;
  47 class ScriptCallStack;
  48
  49 #if ENABLE(JAVASCRIPT_DEBUGGER)
  50 typedef Vector<RefPtr<ScriptProfile> > ProfilesArray;
  51 #endif
  52
  53 class Console : public RefCounted<Console>, public DOMWindowProperty {
  54 public:
  55     static PassRefPtr<Console> create(Frame* frame) { return adoptRef(new Console(frame)); }
  56     virtual ~Console();
  57
  58     void addMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& sourceURL = String(), unsigned lineNumber = 0, PassRefPtr<ScriptCallStack> = 0);
  59     void addMessage(MessageSource, MessageType, MessageLevel, const String& message, PassRefPtr<ScriptCallStack>);
  60
  61     void debug(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  62     void error(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  63     void info(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  64     void log(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  65     void warn(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  66     void dir(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  67     void dirxml(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  68     void trace(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  69     void assertCondition(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>, bool condition);
  70     void count(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  71     void markTimeline(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  72 #if ENABLE(JAVASCRIPT_DEBUGGER)
  73     const ProfilesArray& profiles() const { return m_profiles; }
  74     void profile(const String&, ScriptState*, PassRefPtr<ScriptCallStack>);
  75     void profileEnd(const String&, ScriptState*, PassRefPtr<ScriptCallStack>);
  76 #endif
  77     void time(const String&);
  78     void timeEnd(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>, const String&);
  79     void timeStamp(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  80     void group(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  81     void groupCollapsed(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>);
  82     void groupEnd();
  83
  84     static void mute();
  85     static void unmute();
  86
  87     static bool shouldPrintExceptions();
  88     static void setShouldPrintExceptions(bool);
  89
  90     PassRefPtr<MemoryInfo> memory() const;
  91
  92 private:
  93     inline Page* page() const;
  94     void addMessage(MessageType, MessageLevel, PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack>, bool acceptNoArguments = false);
  95
  96     explicit Console(Frame*);
  97
  98 #if ENABLE(JAVASCRIPT_DEBUGGER)
  99     ProfilesArray m_profiles;
 100 #endif
 101 };
 102
 103 } // namespace WebCore
 104
 105 #endif // Console_h