WebCore/page/Console.cpp - WebKit - Git at Google

 /*
  * Copyright (C) 2007 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
  *     notice, this list of conditions and the following disclaimer in the
  *     documentation and/or other materials provided with the distribution.
  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  *     its contributors may be used to endorse or promote products derived
  *     from this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "config.h"
 #include "Console.h"

 #include "ChromeClient.h"
 #include "CString.h"
 #include "Frame.h"
 #include "FrameLoader.h"
 #include "FrameTree.h"
 #include "InspectorController.h"
 #include "Page.h"
 #include "PageGroup.h"
 #include "PlatformString.h"

 #if ENABLE(JAVASCRIPT_DEBUGGER)
 #include <profiler/Profiler.h>
 #endif

 #include "ScriptCallStack.h"
 #include <stdio.h>

 namespace WebCore {

 Console::Console(Frame* frame)
     : m_frame(frame)
 {
 }

 Frame* Console::frame() const
 {
     return m_frame;
 }

 void Console::disconnectFrame()
 {
     m_frame = 0;
 }

 static void printSourceURLAndLine(const String& sourceURL, unsigned lineNumber)
 {
     if (!sourceURL.isEmpty()) {
         if (lineNumber > 0)
             printf("%s:%d: ", sourceURL.utf8().data(), lineNumber);
         else
             printf("%s: ", sourceURL.utf8().data());
     }
 }

 static bool getFirstArgumentAsString(ScriptState* scriptState, const ScriptCallFrame& callFrame, String& result, bool checkForNullOrUndefined = false)
 {
     if (!callFrame.argumentCount())
         return false;

     const ScriptValue& value = callFrame.argumentAt(0);
     if (checkForNullOrUndefined && (value.isNull() || value.isUndefined()))
         return false;

     result = value.toString(scriptState);
     return true;
 }

 static void printMessageSourceAndLevelPrefix(MessageSource source, MessageLevel level)
 {
     const char* sourceString;
     switch (source) {
         case HTMLMessageSource:
             sourceString = "HTML";
             break;
         case WMLMessageSource:
             sourceString = "WML";
             break;
         case XMLMessageSource:
             sourceString = "XML";
             break;
         case JSMessageSource:
             sourceString = "JS";
             break;
         case CSSMessageSource:
             sourceString = "CSS";
             break;
         case OtherMessageSource:
             sourceString = "OTHER";
             break;
         default:
             ASSERT_NOT_REACHED();
             sourceString = "UNKNOWN";
             break;
     }

     const char* levelString;
     switch (level) {
         case TipMessageLevel:
             levelString = "TIP";
             break;
         case LogMessageLevel:
             levelString = "LOG";
             break;
         case WarningMessageLevel:
             levelString = "WARN";
             break;
         case ErrorMessageLevel:
             levelString = "ERROR";
             break;
         case ObjectMessageLevel:
             levelString = "OBJECT";
             break;
         case TraceMessageLevel:
             levelString = "TRACE";
             break;
         case StartGroupMessageLevel:
             levelString = "START GROUP";
             break;
         case EndGroupMessageLevel:
             levelString = "END GROUP";
             break;
         default:
             ASSERT_NOT_REACHED();
             levelString = "UNKNOWN";
             break;
     }

     printf("%s %s:", sourceString, levelString);
 }

 void Console::addMessage(MessageSource source, MessageLevel level, const String& message, unsigned lineNumber, const String& sourceURL)
 {
     Page* page = this->page();
     if (!page)
         return;

     if (source == JSMessageSource || source == WMLMessageSource)
         page->chrome()->client()->addMessageToConsole(source, level, message, lineNumber, sourceURL);

     page->inspectorController()->addMessageToConsole(source, level, message, lineNumber, sourceURL);

     if (!Console::shouldPrintExceptions())
         return;

     printSourceURLAndLine(sourceURL, lineNumber);
     printMessageSourceAndLevelPrefix(source, level);

     printf(" %s\n", message.utf8().data());
 }

 void Console::addMessage(MessageLevel level, ScriptCallStack* callStack, bool acceptNoArguments) {
     Page* page = this->page();
     if (!page)
         return;

     const ScriptCallFrame& lastCaller = callStack->at(0);

     if (!acceptNoArguments && !lastCaller.argumentCount())
         return;

     String message;
     if (getFirstArgumentAsString(callStack->state(), lastCaller, message))
         page->chrome()->client()->addMessageToConsole(JSMessageSource, level, message, lastCaller.lineNumber(), lastCaller.sourceURL().prettyURL());

     page->inspectorController()->addMessageToConsole(JSMessageSource, level, callStack);

     if (!Console::shouldPrintExceptions())
         return;

     printSourceURLAndLine(lastCaller.sourceURL().prettyURL(), 0);
     printMessageSourceAndLevelPrefix(JSMessageSource, level);

     for (unsigned i = 0; i < lastCaller.argumentCount(); ++i) {
         String argAsString;
         if (lastCaller.argumentAt(i).getString(argAsString))
             printf(" %s", argAsString.utf8().data());
     }
     printf("\n");
 }

 void Console::debug(ScriptCallStack* callStack)
 {
     // In Firebug, console.debug has the same behavior as console.log. So we'll do the same.
     log(callStack);
 }

 void Console::error(ScriptCallStack* callStack)
 {
     addMessage(ErrorMessageLevel, callStack);
 }

 void Console::info(ScriptCallStack* callStack)
 {
     log(callStack);
 }

 void Console::log(ScriptCallStack* callStack)
 {
     addMessage(LogMessageLevel, callStack);
 }

 void Console::dir(ScriptCallStack* callStack)
 {
     addMessage(ObjectMessageLevel, callStack);
 }

 void Console::dirxml(ScriptCallStack* callStack)
 {
     // The standard behavior of our console.log will print the DOM tree for nodes.
     log(callStack);
 }

 void Console::trace(ScriptCallStack* callStack)
 {
     addMessage(TraceMessageLevel, callStack, true);

     if (!shouldPrintExceptions())
         return;

     printf("Stack Trace\n");
     for (unsigned i = 0; i < callStack->size(); ++i) {
         String functionName = String(callStack->at(i).functionName());
         printf("\t%s\n", functionName.utf8().data());
     }
 }

 void Console::assertCondition(bool condition, ScriptCallStack* callStack)
 {
     if (condition)
         return;

     // FIXME: <https://bugs.webkit.org/show_bug.cgi?id=19135> It would be nice to prefix assertion failures with a message like "Assertion failed: ".
     addMessage(ErrorMessageLevel, callStack, true);
 }

 void Console::count(ScriptCallStack* callStack)
 {
     Page* page = this->page();
     if (!page)
         return;

     const ScriptCallFrame& lastCaller = callStack->at(0);
     // Follow Firebug's behavior of counting with null and undefined title in
     // the same bucket as no argument
     String title;
     getFirstArgumentAsString(callStack->state(), lastCaller, title);

     page->inspectorController()->count(title, lastCaller.lineNumber(), lastCaller.sourceURL().string());
 }

 #if ENABLE(JAVASCRIPT_DEBUGGER)

 void Console::profile(const JSC::UString& title, ScriptCallStack* callStack)
 {
     Page* page = this->page();
     if (!page)
         return;

     // FIXME: log a console message when profiling is disabled.
     if (!page->inspectorController()->profilerEnabled())
         return;

     if (title.isNull()) {   // no title so give it the next user initiated profile title.
         page->inspectorController()->startUserInitiatedProfiling(0);
         return;
     }

     JSC::Profiler::profiler()->startProfiling(callStack->state(), title);
 }

 void Console::profileEnd(const JSC::UString& title, ScriptCallStack* callStack)
 {
     Page* page = this->page();
     if (!page)
         return;

     if (!page->inspectorController()->profilerEnabled())
         return;

     RefPtr<JSC::Profile> profile = JSC::Profiler::profiler()->stopProfiling(callStack->state(), title);
     if (!profile)
         return;

     m_profiles.append(profile);

     if (Page* page = this->page()) {
         const ScriptCallFrame& lastCaller = callStack->at(0);
         page->inspectorController()->addProfile(profile, lastCaller.lineNumber(), lastCaller.sourceURL());
     }
 }

 #endif

 void Console::time(const String& title)
 {
     Page* page = this->page();
     if (!page)
         return;

     // Follow Firebug's behavior of requiring a title that is not null or
     // undefined for timing functions
     if (title.isNull())
         return;

     page->inspectorController()->startTiming(title);
 }

 void Console::timeEnd(const String& title, ScriptCallStack* callStack)
 {
     Page* page = this->page();
     if (!page)
         return;

     // Follow Firebug's behavior of requiring a title that is not null or
     // undefined for timing functions
     if (title.isNull())
         return;

     double elapsed;
     if (!page->inspectorController()->stopTiming(title, elapsed))
         return;

     String message = title + String::format(": %.0fms", elapsed);

     const ScriptCallFrame& lastCaller = callStack->at(0);
     page->inspectorController()->addMessageToConsole(JSMessageSource, LogMessageLevel, message, lastCaller.lineNumber(), lastCaller.sourceURL().string());
 }

 void Console::group(ScriptCallStack* callStack)
 {
     Page* page = this->page();
     if (!page)
         return;

     page->inspectorController()->startGroup(JSMessageSource, callStack);
 }

 void Console::groupEnd()
 {
     Page* page = this->page();
     if (!page)
         return;

     page->inspectorController()->endGroup(JSMessageSource, 0, String());
 }

 void Console::warn(ScriptCallStack* callStack)
 {
     addMessage(WarningMessageLevel, callStack);
 }

 static bool printExceptions = false;

 bool Console::shouldPrintExceptions()
 {
     return printExceptions;
 }

 void Console::setShouldPrintExceptions(bool print)
 {
     printExceptions = print;
 }

 Page* Console::page() const
 {
     if (!m_frame)
         return 0;
     return m_frame->page();
 }

 } // namespace WebCore
	/*
	* Copyright (C) 2007 Apple Inc. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	* 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
	* its contributors may be used to endorse or promote products derived
	* from this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "config.h"
	#include "Console.h"

	#include "ChromeClient.h"
	#include "CString.h"
	#include "Frame.h"
	#include "FrameLoader.h"
	#include "FrameTree.h"
	#include "InspectorController.h"
	#include "Page.h"
	#include "PageGroup.h"
	#include "PlatformString.h"

	#if ENABLE(JAVASCRIPT_DEBUGGER)
	#include <profiler/Profiler.h>
	#endif

	#include "ScriptCallStack.h"
	#include <stdio.h>

	namespace WebCore {

	Console::Console(Frame* frame)
	: m_frame(frame)
	{
	}

	Frame* Console::frame() const
	{
	return m_frame;
	}

	void Console::disconnectFrame()
	{
	m_frame = 0;
	}

	static void printSourceURLAndLine(const String& sourceURL, unsigned lineNumber)
	{
	if (!sourceURL.isEmpty()) {
	if (lineNumber > 0)
	printf("%s:%d: ", sourceURL.utf8().data(), lineNumber);
	else
	printf("%s: ", sourceURL.utf8().data());
	}
	}

	static bool getFirstArgumentAsString(ScriptState* scriptState, const ScriptCallFrame& callFrame, String& result, bool checkForNullOrUndefined = false)
	{
	if (!callFrame.argumentCount())
	return false;

	const ScriptValue& value = callFrame.argumentAt(0);
	if (checkForNullOrUndefined && (value.isNull() \|\| value.isUndefined()))
	return false;

	result = value.toString(scriptState);
	return true;
	}

	static void printMessageSourceAndLevelPrefix(MessageSource source, MessageLevel level)
	{
	const char* sourceString;
	switch (source) {
	case HTMLMessageSource:
	sourceString = "HTML";
	break;
	case WMLMessageSource:
	sourceString = "WML";
	break;
	case XMLMessageSource:
	sourceString = "XML";
	break;
	case JSMessageSource:
	sourceString = "JS";
	break;
	case CSSMessageSource:
	sourceString = "CSS";
	break;
	case OtherMessageSource:
	sourceString = "OTHER";
	break;
	default:
	ASSERT_NOT_REACHED();
	sourceString = "UNKNOWN";
	break;
	}

	const char* levelString;
	switch (level) {
	case TipMessageLevel:
	levelString = "TIP";
	break;
	case LogMessageLevel:
	levelString = "LOG";
	break;
	case WarningMessageLevel:
	levelString = "WARN";
	break;
	case ErrorMessageLevel:
	levelString = "ERROR";
	break;
	case ObjectMessageLevel:
	levelString = "OBJECT";
	break;
	case TraceMessageLevel:
	levelString = "TRACE";
	break;
	case StartGroupMessageLevel:
	levelString = "START GROUP";
	break;
	case EndGroupMessageLevel:
	levelString = "END GROUP";
	break;
	default:
	ASSERT_NOT_REACHED();
	levelString = "UNKNOWN";
	break;
	}

	printf("%s %s:", sourceString, levelString);
	}

	void Console::addMessage(MessageSource source, MessageLevel level, const String& message, unsigned lineNumber, const String& sourceURL)
	{
	Page* page = this->page();
	if (!page)
	return;

	if (source == JSMessageSource \|\| source == WMLMessageSource)
	page->chrome()->client()->addMessageToConsole(source, level, message, lineNumber, sourceURL);

	page->inspectorController()->addMessageToConsole(source, level, message, lineNumber, sourceURL);

	if (!Console::shouldPrintExceptions())
	return;

	printSourceURLAndLine(sourceURL, lineNumber);
	printMessageSourceAndLevelPrefix(source, level);

	printf(" %s\n", message.utf8().data());
	}

	void Console::addMessage(MessageLevel level, ScriptCallStack* callStack, bool acceptNoArguments) {
	Page* page = this->page();
	if (!page)
	return;

	const ScriptCallFrame& lastCaller = callStack->at(0);

	if (!acceptNoArguments && !lastCaller.argumentCount())
	return;

	String message;
	if (getFirstArgumentAsString(callStack->state(), lastCaller, message))
	page->chrome()->client()->addMessageToConsole(JSMessageSource, level, message, lastCaller.lineNumber(), lastCaller.sourceURL().prettyURL());

	page->inspectorController()->addMessageToConsole(JSMessageSource, level, callStack);

	if (!Console::shouldPrintExceptions())
	return;

	printSourceURLAndLine(lastCaller.sourceURL().prettyURL(), 0);
	printMessageSourceAndLevelPrefix(JSMessageSource, level);

	for (unsigned i = 0; i < lastCaller.argumentCount(); ++i) {
	String argAsString;
	if (lastCaller.argumentAt(i).getString(argAsString))
	printf(" %s", argAsString.utf8().data());
	}
	printf("\n");
	}

	void Console::debug(ScriptCallStack* callStack)
	{
	// In Firebug, console.debug has the same behavior as console.log. So we'll do the same.
	log(callStack);
	}

	void Console::error(ScriptCallStack* callStack)
	{
	addMessage(ErrorMessageLevel, callStack);
	}

	void Console::info(ScriptCallStack* callStack)
	{
	log(callStack);
	}

	void Console::log(ScriptCallStack* callStack)
	{
	addMessage(LogMessageLevel, callStack);
	}

	void Console::dir(ScriptCallStack* callStack)
	{
	addMessage(ObjectMessageLevel, callStack);
	}

	void Console::dirxml(ScriptCallStack* callStack)
	{
	// The standard behavior of our console.log will print the DOM tree for nodes.
	log(callStack);
	}

	void Console::trace(ScriptCallStack* callStack)
	{
	addMessage(TraceMessageLevel, callStack, true);

	if (!shouldPrintExceptions())
	return;

	printf("Stack Trace\n");
	for (unsigned i = 0; i < callStack->size(); ++i) {
	String functionName = String(callStack->at(i).functionName());
	printf("\t%s\n", functionName.utf8().data());
	}
	}

	void Console::assertCondition(bool condition, ScriptCallStack* callStack)
	{
	if (condition)
	return;

	// FIXME: <https://bugs.webkit.org/show_bug.cgi?id=19135> It would be nice to prefix assertion failures with a message like "Assertion failed: ".
	addMessage(ErrorMessageLevel, callStack, true);
	}

	void Console::count(ScriptCallStack* callStack)
	{
	Page* page = this->page();
	if (!page)
	return;

	const ScriptCallFrame& lastCaller = callStack->at(0);
	// Follow Firebug's behavior of counting with null and undefined title in
	// the same bucket as no argument
	String title;
	getFirstArgumentAsString(callStack->state(), lastCaller, title);

	page->inspectorController()->count(title, lastCaller.lineNumber(), lastCaller.sourceURL().string());
	}

	#if ENABLE(JAVASCRIPT_DEBUGGER)

	void Console::profile(const JSC::UString& title, ScriptCallStack* callStack)
	{
	Page* page = this->page();
	if (!page)
	return;

	// FIXME: log a console message when profiling is disabled.
	if (!page->inspectorController()->profilerEnabled())
	return;

	if (title.isNull()) { // no title so give it the next user initiated profile title.
	page->inspectorController()->startUserInitiatedProfiling(0);
	return;
	}

	JSC::Profiler::profiler()->startProfiling(callStack->state(), title);
	}

	void Console::profileEnd(const JSC::UString& title, ScriptCallStack* callStack)
	{
	Page* page = this->page();
	if (!page)
	return;

	if (!page->inspectorController()->profilerEnabled())
	return;

	RefPtr<JSC::Profile> profile = JSC::Profiler::profiler()->stopProfiling(callStack->state(), title);
	if (!profile)
	return;

	m_profiles.append(profile);

	if (Page* page = this->page()) {
	const ScriptCallFrame& lastCaller = callStack->at(0);
	page->inspectorController()->addProfile(profile, lastCaller.lineNumber(), lastCaller.sourceURL());
	}
	}

	#endif

	void Console::time(const String& title)
	{
	Page* page = this->page();
	if (!page)
	return;

	// Follow Firebug's behavior of requiring a title that is not null or
	// undefined for timing functions
	if (title.isNull())
	return;

	page->inspectorController()->startTiming(title);
	}

	void Console::timeEnd(const String& title, ScriptCallStack* callStack)
	{
	Page* page = this->page();
	if (!page)
	return;

	// Follow Firebug's behavior of requiring a title that is not null or
	// undefined for timing functions
	if (title.isNull())
	return;

	double elapsed;
	if (!page->inspectorController()->stopTiming(title, elapsed))
	return;

	String message = title + String::format(": %.0fms", elapsed);

	const ScriptCallFrame& lastCaller = callStack->at(0);
	page->inspectorController()->addMessageToConsole(JSMessageSource, LogMessageLevel, message, lastCaller.lineNumber(), lastCaller.sourceURL().string());
	}

	void Console::group(ScriptCallStack* callStack)
	{
	Page* page = this->page();
	if (!page)
	return;

	page->inspectorController()->startGroup(JSMessageSource, callStack);
	}

	void Console::groupEnd()
	{
	Page* page = this->page();
	if (!page)
	return;

	page->inspectorController()->endGroup(JSMessageSource, 0, String());
	}

	void Console::warn(ScriptCallStack* callStack)
	{
	addMessage(WarningMessageLevel, callStack);
	}

	static bool printExceptions = false;

	bool Console::shouldPrintExceptions()
	{
	return printExceptions;
	}

	void Console::setShouldPrintExceptions(bool print)
	{
	printExceptions = print;
	}

	Page* Console::page() const
	{
	if (!m_frame)
	return 0;
	return m_frame->page();
	}

	} // namespace WebCore