2010-02-26 Robert Kroeger <rjkroege@chromium.org>
[WebKit-https.git] / WebCore / bindings / v8 / V8LazyEventListener.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 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 V8LazyEventListener_h
32 #define V8LazyEventListener_h
33
34 #include "PlatformString.h"
35 #include "V8AbstractEventListener.h"
36 #include <v8.h>
37 #include <wtf/PassRefPtr.h>
38
39 namespace WebCore {
40
41     class Event;
42     class Frame;
43
44     // V8LazyEventListener is a wrapper for a JavaScript code string that is compiled and evaluated when an event is fired.
45     // A V8LazyEventListener is always a HTML event handler.
46     class V8LazyEventListener : public V8AbstractEventListener {
47     public:
48         static PassRefPtr<V8LazyEventListener> create(const String& functionName, bool isSVGEvent, const String& code, const String& sourceURL, int lineNumber, int columnNumber, const WorldContextHandle& worldContext)
49         {
50             return adoptRef(new V8LazyEventListener(functionName, isSVGEvent, code, sourceURL, lineNumber, columnNumber, worldContext));
51         }
52
53         virtual bool isLazy() const { return true; }
54
55     protected:
56         virtual void prepareListenerObject(ScriptExecutionContext*);
57
58     private:
59         V8LazyEventListener(const String& functionName, bool isSVGEvent, const String& code, const String sourceURL, int lineNumber, int columnNumber, const WorldContextHandle& worldContext);
60
61         virtual v8::Local<v8::Value> callListenerFunction(ScriptExecutionContext*, v8::Handle<v8::Value> jsEvent, Event*);
62
63         // Needs to return true for all event handlers implemented in JavaScript so that
64         // the SVG code does not add the event handler in both
65         // SVGUseElement::buildShadowTree and again in
66         // SVGUseElement::transferEventListenersToShadowTree
67         virtual bool wasCreatedFromMarkup() const { return true; }
68
69         String m_functionName;
70         bool m_isSVGEvent;
71         String m_code;
72         String m_sourceURL;
73         int m_lineNumber;
74         int m_columnNumber;
75     };
76
77 } // namespace WebCore
78
79 #endif // V8LazyEventListener_h