LibWeb: Start working on DOM event support

This patch adds the EventTarget class and makes Node inherit from it.

You can register event listeners on an EventTarget, and when you call
dispatch_event() on it, the event listeners will get invoked.

An event listener is basically a wrapper around a JS::Function*.

This is pretty far from how DOM events should eventually work, but it's
a place to start and we'll build more on top of this. :^)
This commit is contained in:
Andreas Kling 2020-03-18 15:22:31 +01:00
parent 97674da502
commit f39e5352f0
Notes: sideshowbarker 2024-07-19 08:15:29 +09:00
17 changed files with 310 additions and 11 deletions

View File

@ -17,6 +17,12 @@ h1 {
color: #a00;
}
</style>
<script>
function foo() {
alert("It loaded!");
}
document.addEventListener("DOMContentLoaded", foo);
</script>
</head>
<body link="#44f" vlink="#c4c" background="90s-bg.png">
<h1>Welcome to the Serenity Browser!</h1>

View File

@ -40,7 +40,7 @@ public:
const Document& node() const;
private:
virtual const char* class_name() const override { return "Document"; }
virtual const char* class_name() const override { return "DocumentWrapper"; }
};
}

View File

@ -0,0 +1,24 @@
#include <LibJS/Runtime/Function.h>
#include <LibWeb/Bindings/EventListenerWrapper.h>
#include <LibWeb/DOM/EventListener.h>
namespace Web {
namespace Bindings {
EventListenerWrapper::EventListenerWrapper(EventListener& impl)
: m_impl(impl)
{
}
EventListenerWrapper::~EventListenerWrapper()
{
}
void EventListenerWrapper::visit_children(JS::Cell::Visitor& visitor)
{
Wrapper::visit_children(visitor);
visitor.visit(impl().function());
}
}
}

View File

@ -0,0 +1,50 @@
/*
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDER OR 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.
*/
#pragma once
#include <LibWeb/Bindings/Wrapper.h>
namespace Web {
namespace Bindings {
class EventListenerWrapper final : public Wrapper {
public:
explicit EventListenerWrapper(EventListener&);
virtual ~EventListenerWrapper() override;
EventListener& impl() { return *m_impl; }
const EventListener& impl() const { return *m_impl; }
private:
virtual const char* class_name() const override { return "EventListenerWrapper"; }
virtual void visit_children(JS::Cell::Visitor&) override;
NonnullRefPtr<EventListener> m_impl;
};
}
}

View File

@ -0,0 +1,33 @@
#include <AK/Function.h>
#include <LibJS/Runtime/Function.h>
#include <LibWeb/Bindings/EventListenerWrapper.h>
#include <LibWeb/Bindings/EventTargetWrapper.h>
#include <LibWeb/DOM/EventListener.h>
#include <LibWeb/DOM/EventTarget.h>
namespace Web {
namespace Bindings {
EventTargetWrapper::EventTargetWrapper(EventTarget& impl)
: m_impl(impl)
{
put_native_function("addEventListener", [](Object* this_object, const Vector<JS::Value>& arguments) {
if (arguments.size() < 2)
return JS::js_undefined();
auto event_name = arguments[0].to_string();
ASSERT(arguments[1].is_object());
ASSERT(arguments[1].as_object()->is_function());
auto listener = adopt(*new EventListener(static_cast<JS::Function*>(const_cast<Object*>(arguments[1].as_object()))));
wrap(this_object->heap(), *listener);
static_cast<EventTargetWrapper*>(this_object)->impl().add_event_listener(event_name, move(listener));
return JS::js_undefined();
});
}
EventTargetWrapper::~EventTargetWrapper()
{
}
}
}

View File

@ -0,0 +1,49 @@
/*
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDER OR 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.
*/
#pragma once
#include <LibWeb/Bindings/Wrapper.h>
namespace Web {
namespace Bindings {
class EventTargetWrapper : public Wrapper {
public:
explicit EventTargetWrapper(EventTarget&);
virtual ~EventTargetWrapper() override;
EventTarget& impl() { return *m_impl; }
const EventTarget& impl() const { return *m_impl; }
private:
virtual const char* class_name() const override { return "EventTargetWrapper"; }
NonnullRefPtr<EventTarget> m_impl;
};
}
}

View File

@ -33,7 +33,7 @@ namespace Web {
namespace Bindings {
NodeWrapper::NodeWrapper(Node& node)
: m_node(node)
: EventTargetWrapper(node)
{
put("nodeName", JS::js_string(heap(), node.tag_name()));
}
@ -42,5 +42,15 @@ NodeWrapper::~NodeWrapper()
{
}
Node& NodeWrapper::node()
{
return static_cast<Node&>(EventTargetWrapper::impl());
}
const Node& NodeWrapper::node() const
{
return static_cast<const Node&>(EventTargetWrapper::impl());
}
}
}

View File

@ -26,23 +26,21 @@
#pragma once
#include <LibWeb/Bindings/Wrapper.h>
#include <LibWeb/Bindings/EventTargetWrapper.h>
namespace Web {
namespace Bindings {
class NodeWrapper : public Wrapper {
class NodeWrapper : public EventTargetWrapper {
public:
explicit NodeWrapper(Node&);
virtual ~NodeWrapper() override;
Node& node() { return *m_node; }
const Node& node() const { return *m_node; }
Node& node();
const Node& node() const;
private:
virtual const char* class_name() const override { return "Node"; }
NonnullRefPtr<Node> m_node;
virtual const char* class_name() const override { return "NodeWrapper"; }
};
}

View File

View File

@ -0,0 +1,26 @@
#pragma once
#include <AK/RefCounted.h>
#include <LibJS/Forward.h>
#include <LibWeb/Bindings/Wrappable.h>
namespace Web {
class EventListener
: public RefCounted<EventListener>
, public Bindings::Wrappable {
public:
using WrapperType = Bindings::EventListenerWrapper;
explicit EventListener(JS::Function* function)
: m_function(function)
{
}
JS::Function* function() { return m_function; }
private:
JS::Function* m_function { nullptr };
};
}

View File

@ -0,0 +1,19 @@
#include <LibWeb/DOM/EventListener.h>
#include <LibWeb/DOM/EventTarget.h>
namespace Web {
EventTarget::EventTarget()
{
}
EventTarget::~EventTarget()
{
}
void EventTarget::add_event_listener(String event_name, NonnullRefPtr<EventListener> listener)
{
m_listeners.append({ move(event_name), move(listener) });
}
}

View File

@ -0,0 +1,41 @@
#pragma once
#include <AK/Noncopyable.h>
#include <AK/String.h>
#include <AK/Vector.h>
#include <LibWeb/Forward.h>
namespace Web {
class EventTarget {
AK_MAKE_NONCOPYABLE(EventTarget);
AK_MAKE_NONMOVABLE(EventTarget);
public:
virtual ~EventTarget();
void ref() { ref_event_target(); }
void unref() { unref_event_target(); }
void add_event_listener(String event_name, NonnullRefPtr<EventListener>);
virtual void dispatch_event(String event_name) = 0;
struct EventListenerRegistration {
String event_name;
NonnullRefPtr<EventListener> listener;
};
const Vector<EventListenerRegistration>& listeners() const { return m_listeners; }
protected:
EventTarget();
virtual void ref_event_target() = 0;
virtual void unref_event_target() = 0;
private:
Vector<EventListenerRegistration> m_listeners;
};
}

View File

@ -25,8 +25,14 @@
*/
#include <AK/StringBuilder.h>
#include <LibJS/AST.h>
#include <LibJS/Interpreter.h>
#include <LibJS/Runtime/Function.h>
#include <LibJS/Runtime/ScriptFunction.h>
#include <LibWeb/Bindings/NodeWrapper.h>
#include <LibWeb/CSS/StyleResolver.h>
#include <LibWeb/DOM/Element.h>
#include <LibWeb/DOM/EventListener.h>
#include <LibWeb/DOM/HTMLAnchorElement.h>
#include <LibWeb/DOM/Node.h>
#include <LibWeb/Layout/LayoutBlock.h>
@ -117,4 +123,21 @@ bool Node::is_link() const
return enclosing_link->has_attribute("href");
}
void Node::dispatch_event(String event_name)
{
for (auto& listener : listeners()) {
if (listener.event_name == event_name) {
auto* function = const_cast<EventListener&>(*listener.listener).function();
static_cast<const JS::ScriptFunction*>(function)->body().dump(0);
auto* this_value = wrap(function->heap(), *this);
dbg() << "calling event listener with this=" << this_value;
document().interpreter().call(function, this_value, {});
}
}
// FIXME: This is a hack. We should follow the real rules of event bubbling.
if (parent())
parent()->dispatch_event(move(event_name));
}
}

View File

@ -31,6 +31,7 @@
#include <AK/String.h>
#include <AK/Vector.h>
#include <LibWeb/Bindings/Wrappable.h>
#include <LibWeb/DOM/EventTarget.h>
#include <LibWeb/TreeNode.h>
namespace Web {
@ -56,10 +57,19 @@ class StyleProperties;
class Node
: public TreeNode<Node>
, public EventTarget
, public Bindings::Wrappable {
public:
using WrapperType = Bindings::NodeWrapper;
using TreeNode<Node>::ref;
using TreeNode<Node>::unref;
// ^EventTarget
virtual void ref_event_target() final { ref(); }
virtual void unref_event_target() final { unref(); }
virtual void dispatch_event(String event_name) final;
virtual ~Node();
NodeType type() const { return m_type; }

View File

@ -30,6 +30,8 @@ namespace Web {
class Document;
class Element;
class EventListener;
class EventTarget;
class Frame;
class HtmlView;
class Node;
@ -37,6 +39,8 @@ class Node;
namespace Bindings {
class DocumentWrapper;
class EventListenerWrapper;
class EventTargetWrapper;
class NodeWrapper;
class Wrappable;
class Wrapper;

View File

@ -1,7 +1,9 @@
LIBWEB_OBJS = \
Bindings/Wrappable.o \
Bindings/NodeWrapper.o \
Bindings/DocumentWrapper.o \
Bindings/EventListenerWrapper.o \
Bindings/EventTargetWrapper.o \
Bindings/NodeWrapper.o \
Bindings/Wrappable.o \
CSS/DefaultStyleSheetSource.o \
CSS/PropertyID.o \
CSS/Selector.o \
@ -18,6 +20,8 @@ LIBWEB_OBJS = \
DOM/DocumentType.o \
DOM/Element.o \
DOM/ElementFactory.o \
DOM/EventListener.o \
DOM/EventTarget.o \
DOM/HTMLAnchorElement.o \
DOM/HTMLBRElement.o \
DOM/HTMLBlinkElement.o \

View File

@ -378,6 +378,8 @@ RefPtr<Document> parse_html_document(const StringView& html, const URL& url)
};
fire_insertion_callbacks(document);
document->dispatch_event("DOMContentLoaded");
return document;
}