1/*
2 * Copyright (C) 2009 Google 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 are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef ErrorEvent_h
32#define ErrorEvent_h
33
34#include "bindings/v8/DOMWrapperWorld.h"
35#include "core/events/Event.h"
36#include "wtf/RefPtr.h"
37#include "wtf/text/WTFString.h"
38
39namespace WebCore {
40
41struct ErrorEventInit : public EventInit {
42    ErrorEventInit();
43
44    String message;
45    String filename;
46    unsigned lineno;
47    unsigned colno;
48};
49
50class ErrorEvent : public Event {
51public:
52    static PassRefPtr<ErrorEvent> create()
53    {
54        return adoptRef(new ErrorEvent);
55    }
56    static PassRefPtr<ErrorEvent> create(const String& message, const String& fileName, unsigned lineNumber, unsigned columnNumber, PassRefPtr<DOMWrapperWorld> world)
57    {
58        return adoptRef(new ErrorEvent(message, fileName, lineNumber, columnNumber, world));
59    }
60    static PassRefPtr<ErrorEvent> create(const AtomicString& type, const ErrorEventInit& initializer)
61    {
62        return adoptRef(new ErrorEvent(type, initializer));
63    }
64    static PassRefPtr<ErrorEvent> createSanitizedError(PassRefPtr<DOMWrapperWorld> world)
65    {
66        return adoptRef(new ErrorEvent("Script error.", String(), 0, 0, world));
67    }
68    virtual ~ErrorEvent();
69
70    // As 'message' is exposed to JavaScript, never return unsanitizedMessage.
71    const String& message() const { return m_sanitizedMessage; }
72    const String& filename() const { return m_fileName; }
73    unsigned lineno() const { return m_lineNumber; }
74    unsigned colno() const { return m_columnNumber; }
75
76    // 'messageForConsole' is not exposed to JavaScript, and prefers 'm_unsanitizedMessage'.
77    const String& messageForConsole() const { return !m_unsanitizedMessage.isEmpty() ? m_unsanitizedMessage : m_sanitizedMessage; }
78
79    virtual const AtomicString& interfaceName() const;
80
81    PassRefPtr<DOMWrapperWorld> world() const { return m_world; }
82
83    void setUnsanitizedMessage(const String&);
84
85private:
86    ErrorEvent();
87    ErrorEvent(const String& message, const String& fileName, unsigned lineNumber, unsigned columnNumber, PassRefPtr<DOMWrapperWorld>);
88    ErrorEvent(const AtomicString&, const ErrorEventInit&);
89
90    String m_unsanitizedMessage;
91    String m_sanitizedMessage;
92    String m_fileName;
93    unsigned m_lineNumber;
94    unsigned m_columnNumber;
95
96    RefPtr<DOMWrapperWorld> m_world;
97};
98
99} // namespace WebCore
100
101#endif // ErrorEvent_h
102