LibWeb: Generate EventTarget bindings from IDL :^)

This commit is contained in:
Andreas Kling 2020-06-21 12:27:41 +02:00
parent a014b2930e
commit d724a12732
Notes: sideshowbarker 2024-07-19 05:29:42 +09:00
6 changed files with 29 additions and 134 deletions

View file

@ -1,77 +0,0 @@
/*
* 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.
*/
#include <AK/FlyString.h>
#include <AK/Function.h>
#include <LibJS/Interpreter.h>
#include <LibJS/Runtime/Error.h>
#include <LibJS/Runtime/Function.h>
#include <LibJS/Runtime/GlobalObject.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(JS::GlobalObject& global_object, EventTarget& impl)
: Wrapper(*global_object.object_prototype())
, m_impl(impl)
{
}
void EventTargetWrapper::initialize(JS::Interpreter& interpreter, JS::GlobalObject& global_object)
{
Wrapper::initialize(interpreter, global_object);
define_native_function("addEventListener", add_event_listener, 2);
}
EventTargetWrapper::~EventTargetWrapper()
{
}
JS_DEFINE_NATIVE_FUNCTION(EventTargetWrapper::add_event_listener)
{
auto* this_object = interpreter.this_value(global_object).to_object(interpreter, global_object);
if (!this_object)
return {};
if (interpreter.argument_count() < 2)
return interpreter.throw_exception<JS::TypeError>(JS::ErrorType::BadArgCountMany, "addEventListener", "two");
auto event_name = interpreter.argument(0).to_string(interpreter);
if (interpreter.exception())
return {};
auto callback = interpreter.argument(1);
ASSERT(callback.is_object());
ASSERT(callback.as_object().is_function());
auto& function = callback.as_function();
auto listener = adopt(*new EventListener(JS::make_handle(&function)));
static_cast<EventTargetWrapper*>(this_object)->impl().add_event_listener(event_name, move(listener));
return JS::js_undefined();
}
}
}

View file

@ -1,52 +0,0 @@
/*
* 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:
EventTargetWrapper(JS::GlobalObject&, EventTarget&);
virtual void initialize(JS::Interpreter&, JS::GlobalObject&) override;
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"; }
JS_DECLARE_NATIVE_FUNCTION(add_event_listener);
NonnullRefPtr<EventTarget> m_impl;
};
}
}

View file

@ -38,6 +38,7 @@ class Wrapper
: public JS::Object
, public Weakable<Wrapper> {
public:
virtual bool is_event_target_wrapper() const { return false; }
virtual bool is_node_wrapper() const { return false; }
virtual bool is_document_wrapper() const { return false; }
virtual bool is_element_wrapper() const { return false; }

View file

@ -6,6 +6,7 @@ set(SOURCES
Bindings/ElementWrapper.h
Bindings/EventListenerWrapper.cpp
Bindings/EventTargetWrapper.cpp
Bindings/EventTargetWrapper.h
Bindings/EventWrapper.cpp
Bindings/HTMLCanvasElementWrapper.cpp
Bindings/HTMLImageElementWrapper.cpp
@ -147,6 +148,7 @@ function(libweb_js_wrapper class)
add_custom_target(generate_${class}Wrapper.h DEPENDS Bindings/${class}Wrapper.h)
endfunction()
libweb_js_wrapper(EventTarget)
libweb_js_wrapper(Node)
libweb_js_wrapper(Document)
libweb_js_wrapper(Element)

View file

@ -237,7 +237,7 @@ OwnPtr<Interface> parse_interface(const StringView& input)
}
interface->wrapper_class = String::format("%sWrapper", interface->name.characters());
interface->wrapper_base_class = String::format("%sWrapper", interface->parent_name.characters());
interface->wrapper_base_class = String::format("%sWrapper", interface->parent_name.is_empty() ? "" : interface->parent_name.characters());
return interface;
}
@ -308,9 +308,8 @@ static void generate_header(const IDL::Interface& interface)
out() << "#include <LibWeb/Bindings/Wrapper.h>";
out() << "#include <LibWeb/DOM/" << interface.name << ".h>";
if (!wrapper_base_class.is_empty()) {
if (wrapper_base_class != "Wrapper")
out() << "#include <LibWeb/Bindings/" << wrapper_base_class << ".h>";
}
out() << "namespace Web {";
out() << "namespace Bindings {";
@ -321,7 +320,7 @@ static void generate_header(const IDL::Interface& interface)
out() << " virtual void initialize(JS::Interpreter&, JS::GlobalObject&) override;";
out() << " virtual ~" << wrapper_class << "() override;";
if (wrapper_base_class.is_empty()) {
if (wrapper_base_class == "Wrapper") {
out() << " " << interface.name << "& impl() { return *m_impl; }";
out() << " const " << interface.name << "& impl() const { return *m_impl; }";
} else {
@ -345,6 +344,10 @@ static void generate_header(const IDL::Interface& interface)
out() << " JS_DECLARE_NATIVE_SETTER(" << snake_name(attribute.name) << "_setter);";
}
if (wrapper_base_class == "Wrapper") {
out() << " NonnullRefPtr<" << interface.name << "> m_impl;";
}
out() << "};";
out() << "}";
out() << "}";
@ -361,17 +364,24 @@ void generate_implementation(const IDL::Interface& interface)
out() << "#include <LibJS/Runtime/Value.h>";
out() << "#include <LibJS/Runtime/GlobalObject.h>";
out() << "#include <LibJS/Runtime/Error.h>";
out() << "#include <LibJS/Runtime/Function.h>";
out() << "#include <LibWeb/Bindings/NodeWrapperFactory.h>";
out() << "#include <LibWeb/Bindings/" << wrapper_class << ".h>";
out() << "#include <LibWeb/DOM/Element.h>";
out() << "#include <LibWeb/DOM/HTMLElement.h>";
out() << "#include <LibWeb/DOM/EventListener.h>";
out() << "namespace Web {";
out() << "namespace Bindings {";
// Implementation: Wrapper constructor
out() << wrapper_class << "::" << wrapper_class << "(JS::GlobalObject& global_object, " << interface.name << "& impl)";
out() << " : " << wrapper_base_class << "(global_object, impl)";
if (wrapper_base_class == "Wrapper") {
out() << " : Wrapper(*global_object.object_prototype())";
out() << " , m_impl(impl)";
} else {
out() << " : " << wrapper_base_class << "(global_object, impl)";
}
out() << "{";
out() << "}";
@ -421,6 +431,12 @@ void generate_implementation(const IDL::Interface& interface)
out() << " auto " << cpp_name << " = " << js_name << js_suffix << ".to_string(interpreter);";
out() << " if (interpreter.exception())";
generate_return();
} else if (parameter.type.name == "EventListener") {
out() << " if (!" << js_name << js_suffix << ".is_function()) {";
out() << " interpreter.throw_exception<JS::TypeError>(JS::ErrorType::NotA, \"Function\");";
generate_return();
out() << " }";
out() << " auto " << cpp_name << " = adopt(*new EventListener(JS::make_handle(&" << js_name << js_suffix << ".as_function())));";
} else if (parameter.type.name == "Node") {
out() << " auto " << cpp_name << "_object = " << js_name << js_suffix << ".to_object(interpreter, global_object);";
out() << " if (interpreter.exception())";

View file

@ -0,0 +1,5 @@
interface EventTarget {
void addEventListener(DOMString type, EventListener? callback);
}