src/third_party/WebKit/Source/core/events/ErrorEvent.h

   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/core/v8/DOMWrapperWorld.h"
  35 #include "core/events/Event.h"
  36 #include "wtf/RefPtr.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 namespace blink {
  40
  41 struct ErrorEventInit : public EventInit {
  42     ErrorEventInit();
  43
  44     String message;
  45     String filename;
  46     unsigned lineno;
  47     unsigned colno;
  48 };
  49
  50 class ErrorEvent FINAL : public Event {
  51     DEFINE_WRAPPERTYPEINFO();
  52 public:
  53     static PassRefPtrWillBeRawPtr<ErrorEvent> create()
  54     {
  55         return adoptRefWillBeNoop(new ErrorEvent);
  56     }
  57     static PassRefPtrWillBeRawPtr<ErrorEvent> create(const String& message, const String& fileName, unsigned lineNumber, unsigned columnNumber, DOMWrapperWorld* world)
  58     {
  59         return adoptRefWillBeNoop(new ErrorEvent(message, fileName, lineNumber, columnNumber, world));
  60     }
  61     static PassRefPtrWillBeRawPtr<ErrorEvent> create(const AtomicString& type, const ErrorEventInit& initializer)
  62     {
  63         return adoptRefWillBeNoop(new ErrorEvent(type, initializer));
  64     }
  65     static PassRefPtrWillBeRawPtr<ErrorEvent> createSanitizedError(DOMWrapperWorld* world)
  66     {
  67         return adoptRefWillBeNoop(new ErrorEvent("Script error.", String(), 0, 0, world));
  68     }
  69     virtual ~ErrorEvent();
  70
  71     // As 'message' is exposed to JavaScript, never return unsanitizedMessage.
  72     const String& message() const { return m_sanitizedMessage; }
  73     const String& filename() const { return m_fileName; }
  74     unsigned lineno() const { return m_lineNumber; }
  75     unsigned colno() const { return m_columnNumber; }
  76
  77     // 'messageForConsole' is not exposed to JavaScript, and prefers 'm_unsanitizedMessage'.
  78     const String& messageForConsole() const { return !m_unsanitizedMessage.isEmpty() ? m_unsanitizedMessage : m_sanitizedMessage; }
  79
  80     virtual const AtomicString& interfaceName() const OVERRIDE;
  81
  82     DOMWrapperWorld* world() const { return m_world.get(); }
  83
  84     void setUnsanitizedMessage(const String&);
  85
  86     virtual void trace(Visitor*) OVERRIDE;
  87
  88 private:
  89     ErrorEvent();
  90     ErrorEvent(const String& message, const String& fileName, unsigned lineNumber, unsigned columnNumber, DOMWrapperWorld*);
  91     ErrorEvent(const AtomicString&, const ErrorEventInit&);
  92
  93     String m_unsanitizedMessage;
  94     String m_sanitizedMessage;
  95     String m_fileName;
  96     unsigned m_lineNumber;
  97     unsigned m_columnNumber;
  98
  99     RefPtr<DOMWrapperWorld> m_world;
 100 };
 101
 102 } // namespace blink
 103
 104 #endif // ErrorEvent_h