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