1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333 |
- /*
- * Copyright (c) 2020-2021, 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/ByteBuffer.h>
- #include <AK/Debug.h>
- #include <AK/GenericLexer.h>
- #include <AK/HashMap.h>
- #include <AK/LexicalPath.h>
- #include <AK/SourceGenerator.h>
- #include <AK/StringBuilder.h>
- #include <LibCore/ArgsParser.h>
- #include <LibCore/File.h>
- #include <ctype.h>
- static String snake_name(const StringView& title_name)
- {
- StringBuilder builder;
- bool first = true;
- bool last_was_uppercase = false;
- for (auto ch : title_name) {
- if (isupper(ch)) {
- if (!first && !last_was_uppercase)
- builder.append('_');
- builder.append(tolower(ch));
- } else {
- builder.append(ch);
- }
- first = false;
- last_was_uppercase = isupper(ch);
- }
- return builder.to_string();
- }
- static String make_input_acceptable_cpp(const String& input)
- {
- if (input.is_one_of("class", "template", "for", "default", "char")) {
- StringBuilder builder;
- builder.append(input);
- builder.append('_');
- return builder.to_string();
- }
- String input_without_dashes = input;
- input_without_dashes.replace("-", "_");
- return input_without_dashes;
- }
- static void report_parsing_error(StringView message, StringView filename, StringView input, size_t offset)
- {
- // FIXME: Spaghetti code ahead.
- size_t lineno = 1;
- size_t colno = 1;
- size_t start_line = 0;
- size_t line_length = 0;
- for (size_t index = 0; index < input.length(); ++index) {
- if (offset == index)
- colno = index - start_line + 1;
- if (input[index] == '\n') {
- if (index >= offset)
- break;
- start_line = index + 1;
- line_length = 0;
- ++lineno;
- } else {
- ++line_length;
- }
- }
- StringBuilder error_message;
- error_message.appendff("{}\n", input.substring_view(start_line, line_length));
- for (size_t i = 0; i < colno - 1; ++i)
- error_message.append(' ');
- error_message.append("\033[1;31m^\n");
- error_message.appendff("{}:{}: error: {}\033[0m\n", filename, lineno, message);
- warnln("{}", error_message.string_view());
- exit(EXIT_FAILURE);
- }
- namespace IDL {
- struct Type {
- String name;
- bool nullable { false };
- };
- struct Parameter {
- Type type;
- String name;
- bool optional { false };
- };
- struct Function {
- Type return_type;
- String name;
- Vector<Parameter> parameters;
- HashMap<String, String> extended_attributes;
- size_t length() const
- {
- // FIXME: This seems to produce a length that is way over what it's supposed to be.
- // For example, getElementsByTagName has its length set to 20 when it should be 1.
- size_t length = 0;
- for (auto& parameter : parameters) {
- if (!parameter.optional)
- length++;
- }
- return length;
- }
- };
- struct Constant {
- Type type;
- String name;
- String value;
- };
- struct Attribute {
- bool readonly { false };
- Type type;
- String name;
- HashMap<String, String> extended_attributes;
- // Added for convenience after parsing
- String getter_callback_name;
- String setter_callback_name;
- };
- struct Interface {
- String name;
- String parent_name;
- Vector<Attribute> attributes;
- Vector<Constant> constants;
- Vector<Function> functions;
- // Added for convenience after parsing
- String wrapper_class;
- String wrapper_base_class;
- String fully_qualified_name;
- String constructor_class;
- String prototype_class;
- String prototype_base_class;
- };
- static OwnPtr<Interface> parse_interface(StringView filename, const StringView& input)
- {
- auto interface = make<Interface>();
- GenericLexer lexer(input);
- auto assert_specific = [&](char ch) {
- if (!lexer.consume_specific(ch))
- report_parsing_error(String::formatted("expected '{}'", ch), filename, input, lexer.tell());
- };
- auto consume_whitespace = [&] {
- bool consumed = true;
- while (consumed) {
- consumed = lexer.consume_while([](char ch) { return isspace(ch); }).length() > 0;
- if (lexer.consume_specific("//")) {
- lexer.consume_until('\n');
- consumed = true;
- }
- }
- };
- auto assert_string = [&](const StringView& expected) {
- if (!lexer.consume_specific(expected))
- report_parsing_error(String::formatted("expected '{}'", expected), filename, input, lexer.tell());
- };
- assert_string("interface");
- consume_whitespace();
- interface->name = lexer.consume_until([](auto ch) { return isspace(ch); });
- consume_whitespace();
- if (lexer.consume_specific(':')) {
- consume_whitespace();
- interface->parent_name = lexer.consume_until([](auto ch) { return isspace(ch); });
- consume_whitespace();
- }
- assert_specific('{');
- auto parse_type = [&] {
- bool unsigned_ = lexer.consume_specific("unsigned");
- if (unsigned_)
- consume_whitespace();
- auto name = lexer.consume_until([](auto ch) { return isspace(ch) || ch == '?'; });
- auto nullable = lexer.consume_specific('?');
- StringBuilder builder;
- if (unsigned_)
- builder.append("unsigned ");
- builder.append(name);
- return Type { builder.to_string(), nullable };
- };
- auto parse_attribute = [&](HashMap<String, String>& extended_attributes) {
- bool readonly = lexer.consume_specific("readonly");
- if (readonly)
- consume_whitespace();
- if (lexer.consume_specific("attribute"))
- consume_whitespace();
- auto type = parse_type();
- consume_whitespace();
- auto name = lexer.consume_until([](auto ch) { return isspace(ch) || ch == ';'; });
- consume_whitespace();
- assert_specific(';');
- Attribute attribute;
- attribute.readonly = readonly;
- attribute.type = type;
- attribute.name = name;
- attribute.getter_callback_name = String::formatted("{}_getter", snake_name(attribute.name));
- attribute.setter_callback_name = String::formatted("{}_setter", snake_name(attribute.name));
- attribute.extended_attributes = move(extended_attributes);
- interface->attributes.append(move(attribute));
- };
- auto parse_constant = [&] {
- lexer.consume_specific("const");
- consume_whitespace();
- Constant constant;
- constant.type = parse_type();
- consume_whitespace();
- constant.name = lexer.consume_until([](auto ch) { return isspace(ch) || ch == '='; });
- consume_whitespace();
- lexer.consume_specific('=');
- consume_whitespace();
- constant.value = lexer.consume_while([](auto ch) { return !isspace(ch) && ch != ';'; });
- consume_whitespace();
- assert_specific(';');
- interface->constants.append(move(constant));
- };
- auto parse_function = [&](HashMap<String, String>& extended_attributes) {
- auto return_type = parse_type();
- consume_whitespace();
- auto name = lexer.consume_until([](auto ch) { return isspace(ch) || ch == '('; });
- consume_whitespace();
- assert_specific('(');
- Vector<Parameter> parameters;
- for (;;) {
- if (lexer.consume_specific(')'))
- break;
- bool optional = lexer.consume_specific("optional");
- if (optional)
- consume_whitespace();
- auto type = parse_type();
- consume_whitespace();
- auto name = lexer.consume_until([](auto ch) { return isspace(ch) || ch == ',' || ch == ')'; });
- parameters.append({ move(type), move(name), optional });
- if (lexer.consume_specific(')'))
- break;
- assert_specific(',');
- consume_whitespace();
- }
- consume_whitespace();
- assert_specific(';');
- interface->functions.append(Function { return_type, name, move(parameters), move(extended_attributes) });
- };
- auto parse_extended_attributes = [&] {
- HashMap<String, String> extended_attributes;
- for (;;) {
- consume_whitespace();
- if (lexer.consume_specific(']'))
- break;
- auto name = lexer.consume_until([](auto ch) { return ch == ']' || ch == '=' || ch == ','; });
- if (lexer.consume_specific('=')) {
- auto value = lexer.consume_until([](auto ch) { return ch == ']' || ch == ','; });
- extended_attributes.set(name, value);
- } else {
- extended_attributes.set(name, {});
- }
- lexer.consume_specific(',');
- }
- consume_whitespace();
- return extended_attributes;
- };
- for (;;) {
- HashMap<String, String> extended_attributes;
- consume_whitespace();
- if (lexer.consume_specific('}')) {
- consume_whitespace();
- assert_specific(';');
- break;
- }
- if (lexer.consume_specific('[')) {
- extended_attributes = parse_extended_attributes();
- }
- if (lexer.next_is("const")) {
- parse_constant();
- continue;
- }
- if (lexer.next_is("readonly") || lexer.next_is("attribute")) {
- parse_attribute(extended_attributes);
- continue;
- }
- parse_function(extended_attributes);
- }
- interface->wrapper_class = String::formatted("{}Wrapper", interface->name);
- interface->wrapper_base_class = String::formatted("{}Wrapper", interface->parent_name.is_empty() ? String::empty() : interface->parent_name);
- interface->constructor_class = String::formatted("{}Constructor", interface->name);
- interface->prototype_class = String::formatted("{}Prototype", interface->name);
- interface->prototype_base_class = String::formatted("{}Prototype", interface->parent_name.is_empty() ? "Object" : interface->parent_name);
- return interface;
- }
- }
- static void generate_constructor_header(const IDL::Interface&);
- static void generate_constructor_implementation(const IDL::Interface&);
- static void generate_prototype_header(const IDL::Interface&);
- static void generate_prototype_implementation(const IDL::Interface&);
- static void generate_header(const IDL::Interface&);
- static void generate_implementation(const IDL::Interface&);
- int main(int argc, char** argv)
- {
- Core::ArgsParser args_parser;
- const char* path = nullptr;
- bool header_mode = false;
- bool implementation_mode = false;
- bool constructor_header_mode = false;
- bool constructor_implementation_mode = false;
- bool prototype_header_mode = false;
- bool prototype_implementation_mode = false;
- args_parser.add_option(header_mode, "Generate the wrapper .h file", "header", 'H');
- args_parser.add_option(implementation_mode, "Generate the wrapper .cpp file", "implementation", 'I');
- args_parser.add_option(constructor_header_mode, "Generate the constructor .h file", "constructor-header", 'C');
- args_parser.add_option(constructor_implementation_mode, "Generate the constructor .cpp file", "constructor-implementation", 'O');
- args_parser.add_option(prototype_header_mode, "Generate the prototype .h file", "prototype-header", 'P');
- args_parser.add_option(prototype_implementation_mode, "Generate the prototype .cpp file", "prototype-implementation", 'R');
- args_parser.add_positional_argument(path, "IDL file", "idl-file");
- args_parser.parse(argc, argv);
- auto file_or_error = Core::File::open(path, Core::IODevice::ReadOnly);
- if (file_or_error.is_error()) {
- fprintf(stderr, "Cannot open %s\n", path);
- return 1;
- }
- LexicalPath lexical_path(path);
- auto namespace_ = lexical_path.parts().at(lexical_path.parts().size() - 2);
- auto data = file_or_error.value()->read_all();
- auto interface = IDL::parse_interface(path, data);
- if (!interface) {
- warnln("Cannot parse {}", path);
- return 1;
- }
- if (namespace_.is_one_of("DOM", "HTML", "UIEvents", "HighResolutionTime", "NavigationTiming", "SVG", "XHR")) {
- StringBuilder builder;
- builder.append(namespace_);
- builder.append("::");
- builder.append(interface->name);
- interface->fully_qualified_name = builder.to_string();
- } else {
- interface->fully_qualified_name = interface->name;
- }
- if constexpr (debug_wrapper_generator) {
- dbgln("Attributes:");
- for (auto& attribute : interface->attributes) {
- dbgln(" {}{}{} {}",
- attribute.readonly ? "readonly " : "",
- attribute.type.name,
- attribute.type.nullable ? "?" : "",
- attribute.name);
- }
- dbgln("Functions:");
- for (auto& function : interface->functions) {
- dbgln(" {}{} {}",
- function.return_type.name,
- function.return_type.nullable ? "?" : "",
- function.name);
- for (auto& parameter : function.parameters) {
- dbgln(" {}{} {}",
- parameter.type.name,
- parameter.type.nullable ? "?" : "",
- parameter.name);
- }
- }
- }
- if (header_mode)
- generate_header(*interface);
- if (implementation_mode)
- generate_implementation(*interface);
- if (constructor_header_mode)
- generate_constructor_header(*interface);
- if (constructor_implementation_mode)
- generate_constructor_implementation(*interface);
- if (prototype_header_mode)
- generate_prototype_header(*interface);
- if (prototype_implementation_mode)
- generate_prototype_implementation(*interface);
- return 0;
- }
- static bool should_emit_wrapper_factory(const IDL::Interface& interface)
- {
- // FIXME: This is very hackish.
- if (interface.name == "Event")
- return false;
- if (interface.name == "EventTarget")
- return false;
- if (interface.name == "Node")
- return false;
- if (interface.name == "Text")
- return false;
- if (interface.name == "Document")
- return false;
- if (interface.name == "DocumentType")
- return false;
- if (interface.name.ends_with("Element"))
- return false;
- return true;
- }
- static bool is_wrappable_type(const IDL::Type& type)
- {
- if (type.name == "Node")
- return true;
- if (type.name == "Document")
- return true;
- if (type.name == "Text")
- return true;
- if (type.name == "DocumentType")
- return true;
- if (type.name.ends_with("Element"))
- return true;
- if (type.name == "ImageData")
- return true;
- return false;
- }
- static void generate_header(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.set("wrapper_base_class", interface.wrapper_base_class);
- generator.set("wrapper_class", interface.wrapper_class);
- generator.set("wrapper_class:snakecase", snake_name(interface.wrapper_class));
- generator.append(R"~~~(
- #pragma once
- #include <LibWeb/Bindings/Wrapper.h>
- // FIXME: This is very strange.
- #if __has_include(<LibWeb/DOM/@name@.h>)
- # include <LibWeb/DOM/@name@.h>
- #elif __has_include(<LibWeb/HTML/@name@.h>)
- # include <LibWeb/HTML/@name@.h>
- #elif __has_include(<LibWeb/UIEvents/@name@.h>)
- # include <LibWeb/UIEvents/@name@.h>
- #elif __has_include(<LibWeb/HighResolutionTime/@name@.h>)
- # include <LibWeb/HighResolutionTime/@name@.h>
- #elif __has_include(<LibWeb/NavigationTiming/@name@.h>)
- # include <LibWeb/NavigationTiming/@name@.h>
- #elif __has_include(<LibWeb/SVG/@name@.h>)
- # include <LibWeb/SVG/@name@.h>
- #elif __has_include(<LibWeb/XHR/@name@.h>)
- # include <LibWeb/XHR/@name@.h>
- #endif
- )~~~");
- if (interface.wrapper_base_class != "Wrapper") {
- generator.append(R"~~~(
- #include <LibWeb/Bindings/@wrapper_base_class@.h>
- )~~~");
- }
- generator.append(R"~~~(
- namespace Web::Bindings {
- class @wrapper_class@ : public @wrapper_base_class@ {
- JS_OBJECT(@wrapper_class@, @wrapper_base_class@);
- public:
- @wrapper_class@(JS::GlobalObject&, @fully_qualified_name@&);
- virtual void initialize(JS::GlobalObject&) override;
- virtual ~@wrapper_class@() override;
- )~~~");
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- @fully_qualified_name@& impl() { return *m_impl; }
- const @fully_qualified_name@& impl() const { return *m_impl; }
- )~~~");
- } else {
- generator.append(R"~~~(
- @fully_qualified_name@& impl() { return static_cast<@fully_qualified_name@&>(@wrapper_base_class@::impl()); }
- const @fully_qualified_name@& impl() const { return static_cast<const @fully_qualified_name@&>(@wrapper_base_class@::impl()); }
- )~~~");
- }
- generator.append(R"~~~(
- private:
- )~~~");
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- NonnullRefPtr<@fully_qualified_name@> m_impl;
- )~~~");
- }
- generator.append(R"~~~(
- };
- )~~~");
- if (should_emit_wrapper_factory(interface)) {
- generator.append(R"~~~(
- @wrapper_class@* wrap(JS::GlobalObject&, @fully_qualified_name@&);
- )~~~");
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_implementation(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("wrapper_class", interface.wrapper_class);
- generator.set("wrapper_base_class", interface.wrapper_base_class);
- generator.set("prototype_class", interface.prototype_class);
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.append(R"~~~(
- #include <AK/FlyString.h>
- #include <LibJS/Runtime/Array.h>
- #include <LibJS/Runtime/Error.h>
- #include <LibJS/Runtime/Function.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/Uint8ClampedArray.h>
- #include <LibJS/Runtime/Value.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/CanvasRenderingContext2DWrapper.h>
- #include <LibWeb/Bindings/CommentWrapper.h>
- #include <LibWeb/Bindings/DOMImplementationWrapper.h>
- #include <LibWeb/Bindings/DocumentFragmentWrapper.h>
- #include <LibWeb/Bindings/DocumentTypeWrapper.h>
- #include <LibWeb/Bindings/DocumentWrapper.h>
- #include <LibWeb/Bindings/EventTargetWrapperFactory.h>
- #include <LibWeb/Bindings/HTMLCanvasElementWrapper.h>
- #include <LibWeb/Bindings/HTMLHeadElementWrapper.h>
- #include <LibWeb/Bindings/HTMLImageElementWrapper.h>
- #include <LibWeb/Bindings/ImageDataWrapper.h>
- #include <LibWeb/Bindings/NodeWrapperFactory.h>
- #include <LibWeb/Bindings/TextWrapper.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #include <LibWeb/DOM/Element.h>
- #include <LibWeb/DOM/EventListener.h>
- #include <LibWeb/HTML/HTMLElement.h>
- #include <LibWeb/Origin.h>
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::DOM;
- using namespace Web::HTML;
- namespace Web::Bindings {
- )~~~");
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- @wrapper_class@::@wrapper_class@(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- : Wrapper(static_cast<WindowObject&>(global_object).ensure_web_prototype<@prototype_class@>("@name@"))
- , m_impl(impl)
- {
- }
- )~~~");
- } else {
- generator.append(R"~~~(
- @wrapper_class@::@wrapper_class@(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- : @wrapper_base_class@(global_object, impl)
- {
- set_prototype(&static_cast<WindowObject&>(global_object).ensure_web_prototype<@prototype_class@>("@name@"));
- }
- )~~~");
- }
- generator.append(R"~~~(
- void @wrapper_class@::initialize(JS::GlobalObject& global_object)
- {
- @wrapper_base_class@::initialize(global_object);
- }
- @wrapper_class@::~@wrapper_class@()
- {
- }
- )~~~");
- if (should_emit_wrapper_factory(interface)) {
- generator.append(R"~~~(
- @wrapper_class@* wrap(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- {
- return static_cast<@wrapper_class@*>(wrap_impl(global_object, impl));
- }
- )~~~");
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- static void generate_constructor_header(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.set("constructor_class", interface.constructor_class);
- generator.set("constructor_class:snakecase", snake_name(interface.constructor_class));
- generator.append(R"~~~(
- #pragma once
- #include <LibJS/Runtime/NativeFunction.h>
- namespace Web::Bindings {
- class @constructor_class@ : public JS::NativeFunction {
- JS_OBJECT(@constructor_class@, JS::NativeFunction);
- public:
- explicit @constructor_class@(JS::GlobalObject&);
- virtual void initialize(JS::GlobalObject&) override;
- virtual ~@constructor_class@() override;
- virtual JS::Value call() override;
- virtual JS::Value construct(JS::Function& new_target) override;
- private:
- virtual bool has_constructor() const override { return true; }
- };
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_constructor_implementation(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("prototype_class", interface.prototype_class);
- generator.set("wrapper_class", interface.wrapper_class);
- generator.set("constructor_class", interface.constructor_class);
- generator.set("prototype_class:snakecase", snake_name(interface.prototype_class));
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.append(R"~~~(
- #include <LibJS/Heap/Heap.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibWeb/Bindings/@constructor_class@.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #if __has_include(<LibWeb/DOM/@name@.h>)
- # include <LibWeb/DOM/@name@.h>
- #elif __has_include(<LibWeb/HTML/@name@.h>)
- # include <LibWeb/HTML/@name@.h>
- #elif __has_include(<LibWeb/UIEvents/@name@.h>)
- # include <LibWeb/UIEvents/@name@.h>
- #elif __has_include(<LibWeb/HighResolutionTime/@name@.h>)
- # include <LibWeb/HighResolutionTime/@name@.h>
- #elif __has_include(<LibWeb/NavigationTiming/@name@.h>)
- # include <LibWeb/NavigationTiming/@name@.h>
- #elif __has_include(<LibWeb/SVG/@name@.h>)
- # include <LibWeb/SVG/@name@.h>
- #elif __has_include(<LibWeb/XHR/@name@.h>)
- # include <LibWeb/XHR/@name@.h>
- #endif
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::DOM;
- using namespace Web::HTML;
- namespace Web::Bindings {
- @constructor_class@::@constructor_class@(JS::GlobalObject& global_object)
- : NativeFunction(*global_object.function_prototype())
- {
- }
- @constructor_class@::~@constructor_class@()
- {
- }
- JS::Value @constructor_class@::call()
- {
- vm().throw_exception<JS::TypeError>(global_object(), JS::ErrorType::ConstructorWithoutNew, "@name@");
- return {};
- }
- JS::Value @constructor_class@::construct(Function&)
- {
- return {};
- #if 0
- // FIXME: It would be cool to construct stuff!
- auto& window = static_cast<WindowObject&>(global_object());
- return heap().allocate<@wrapper_class@>(window, window, @fully_qualified_name@::create(window.impl()));
- #endif
- }
- void @constructor_class@::initialize(JS::GlobalObject& global_object)
- {
- auto& vm = this->vm();
- auto& window = static_cast<WindowObject&>(global_object);
- [[maybe_unused]] u8 default_attributes = JS::Attribute::Enumerable;
- NativeFunction::initialize(global_object);
- define_property(vm.names.prototype, &window.ensure_web_prototype<@prototype_class@>("@name@"), 0);
- define_property(vm.names.length, JS::Value(1), JS::Attribute::Configurable);
- )~~~");
- for (auto& constant : interface.constants) {
- auto constant_generator = generator.fork();
- constant_generator.set("constant.name", constant.name);
- constant_generator.set("constant.value", constant.value);
- constant_generator.append(R"~~~(
- define_property("@constant.name@", JS::Value((i32)@constant.value@), JS::Attribute::Enumerable);
- )~~~");
- }
- generator.append(R"~~~(
- }
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- static void generate_prototype_header(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.set("prototype_class", interface.prototype_class);
- generator.set("prototype_class:snakecase", snake_name(interface.prototype_class));
- generator.append(R"~~~(
- #pragma once
- #include <LibJS/Runtime/Object.h>
- namespace Web::Bindings {
- class @prototype_class@ : public JS::Object {
- JS_OBJECT(@prototype_class@, JS::Object);
- public:
- explicit @prototype_class@(JS::GlobalObject&);
- virtual void initialize(JS::GlobalObject&) override;
- virtual ~@prototype_class@() override;
- private:
- )~~~");
- for (auto& function : interface.functions) {
- auto function_generator = generator.fork();
- function_generator.set("function.name:snakecase", snake_name(function.name));
- function_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@function.name:snakecase@);
- )~~~");
- }
- for (auto& attribute : interface.attributes) {
- auto attribute_generator = generator.fork();
- attribute_generator.set("attribute.name:snakecase", snake_name(attribute.name));
- attribute_generator.append(R"~~~(
- JS_DECLARE_NATIVE_GETTER(@attribute.name:snakecase@_getter);
- )~~~");
- if (!attribute.readonly) {
- attribute_generator.append(R"~~~(
- JS_DECLARE_NATIVE_SETTER(@attribute.name:snakecase@_setter);
- )~~~");
- }
- }
- generator.append(R"~~~(
- };
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_prototype_implementation(const IDL::Interface& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", interface.name);
- generator.set("parent_name", interface.parent_name);
- generator.set("prototype_class", interface.prototype_class);
- generator.set("prototype_base_class", interface.prototype_base_class);
- generator.set("wrapper_class", interface.wrapper_class);
- generator.set("constructor_class", interface.constructor_class);
- generator.set("prototype_class:snakecase", snake_name(interface.prototype_class));
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.append(R"~~~(
- #include <AK/Function.h>
- #include <LibJS/Runtime/Array.h>
- #include <LibJS/Runtime/Error.h>
- #include <LibJS/Runtime/Function.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/Uint8ClampedArray.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/CanvasRenderingContext2DWrapper.h>
- #include <LibWeb/Bindings/CommentWrapper.h>
- #include <LibWeb/Bindings/DOMImplementationWrapper.h>
- #include <LibWeb/Bindings/DocumentFragmentWrapper.h>
- #include <LibWeb/Bindings/DocumentTypeWrapper.h>
- #include <LibWeb/Bindings/DocumentWrapper.h>
- #include <LibWeb/Bindings/EventTargetWrapperFactory.h>
- #include <LibWeb/Bindings/HTMLCanvasElementWrapper.h>
- #include <LibWeb/Bindings/HTMLHeadElementWrapper.h>
- #include <LibWeb/Bindings/HTMLImageElementWrapper.h>
- #include <LibWeb/Bindings/ImageDataWrapper.h>
- #include <LibWeb/Bindings/NodeWrapperFactory.h>
- #include <LibWeb/Bindings/PerformanceTimingWrapper.h>
- #include <LibWeb/Bindings/TextWrapper.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #include <LibWeb/DOM/Element.h>
- #include <LibWeb/DOM/EventListener.h>
- #include <LibWeb/DOM/Window.h>
- #include <LibWeb/HTML/HTMLElement.h>
- #include <LibWeb/NavigationTiming/PerformanceTiming.h>
- #include <LibWeb/Origin.h>
- #if __has_include(<LibWeb/Bindings/@prototype_base_class@.h>)
- # include <LibWeb/Bindings/@prototype_base_class@.h>
- #endif
- #if __has_include(<LibWeb/DOM/@name@.h>)
- # include <LibWeb/DOM/@name@.h>
- #elif __has_include(<LibWeb/HTML/@name@.h>)
- # include <LibWeb/HTML/@name@.h>
- #elif __has_include(<LibWeb/UIEvents/@name@.h>)
- # include <LibWeb/UIEvents/@name@.h>
- #elif __has_include(<LibWeb/HighResolutionTime/@name@.h>)
- # include <LibWeb/HighResolutionTime/@name@.h>
- #elif __has_include(<LibWeb/NavigationTiming/@name@.h>)
- # include <LibWeb/NavigationTiming/@name@.h>
- #elif __has_include(<LibWeb/SVG/@name@.h>)
- # include <LibWeb/SVG/@name@.h>
- #elif __has_include(<LibWeb/XHR/@name@.h>)
- # include <LibWeb/XHR/@name@.h>
- #endif
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::DOM;
- using namespace Web::HTML;
- using namespace Web::NavigationTiming;
- using namespace Web::XHR;
- namespace Web::Bindings {
- @prototype_class@::@prototype_class@(JS::GlobalObject& global_object)
- : Object(*global_object.object_prototype())
- {
- )~~~");
- if (!interface.parent_name.is_empty()) {
- generator.append(R"~~~(
- set_prototype(&static_cast<WindowObject&>(global_object).ensure_web_prototype<@prototype_base_class@>("@parent_name@"));
- )~~~");
- }
- generator.append(R"~~~(
- }
- @prototype_class@::~@prototype_class@()
- {
- }
- void @prototype_class@::initialize(JS::GlobalObject& global_object)
- {
- [[maybe_unused]] auto& vm = this->vm();
- [[maybe_unused]] u8 default_attributes = JS::Attribute::Enumerable | JS::Attribute::Configurable;
- )~~~");
- for (auto& attribute : interface.attributes) {
- auto attribute_generator = generator.fork();
- attribute_generator.set("attribute.name", attribute.name);
- attribute_generator.set("attribute.getter_callback", attribute.getter_callback_name);
- if (attribute.readonly)
- attribute_generator.set("attribute.setter_callback", "nullptr");
- else
- attribute_generator.set("attribute.setter_callback", attribute.setter_callback_name);
- attribute_generator.append(R"~~~(
- define_native_property("@attribute.name@", @attribute.getter_callback@, @attribute.setter_callback@, default_attributes);
- )~~~");
- }
- for (auto& constant : interface.constants) {
- auto constant_generator = generator.fork();
- constant_generator.set("constant.name", constant.name);
- constant_generator.set("constant.value", constant.value);
- constant_generator.append(R"~~~(
- define_property("@constant.name@", JS::Value((i32)@constant.value@), JS::Attribute::Enumerable);
- )~~~");
- }
- for (auto& function : interface.functions) {
- auto function_generator = generator.fork();
- function_generator.set("function.name", function.name);
- function_generator.set("function.name:snakecase", snake_name(function.name));
- function_generator.set("function.name:length", String::number(function.name.length()));
- function_generator.append(R"~~~(
- define_native_function("@function.name@", @function.name:snakecase@, @function.name:length@, default_attributes);
- )~~~");
- }
- generator.append(R"~~~(
- Object::initialize(global_object);
- }
- )~~~");
- if (!interface.attributes.is_empty() || !interface.functions.is_empty()) {
- generator.append(R"~~~(
- static @fully_qualified_name@* impl_from(JS::VM& vm, JS::GlobalObject& global_object)
- {
- auto* this_object = vm.this_value(global_object).to_object(global_object);
- if (!this_object)
- return {};
- )~~~");
- if (interface.name == "EventTarget") {
- generator.append(R"~~~(
- if (is<WindowObject>(this_object)) {
- return &static_cast<WindowObject*>(this_object)->impl();
- }
- )~~~");
- }
- generator.append(R"~~~(
- if (!is<@wrapper_class@>(this_object)) {
- vm.throw_exception<JS::TypeError>(global_object, JS::ErrorType::NotA, "@fully_qualified_name@");
- return nullptr;
- }
- return &static_cast<@wrapper_class@*>(this_object)->impl();
- }
- )~~~");
- }
- auto generate_to_cpp = [&](auto& parameter, auto& js_name, const auto& js_suffix, auto cpp_name, bool return_void = false, bool legacy_null_to_empty_string = false, bool optional = false) {
- auto scoped_generator = generator.fork();
- scoped_generator.set("cpp_name", cpp_name);
- scoped_generator.set("js_name", js_name);
- scoped_generator.set("js_suffix", js_suffix);
- scoped_generator.set("legacy_null_to_empty_string", legacy_null_to_empty_string ? "true" : "false");
- scoped_generator.set("parameter.type.name", parameter.type.name);
- if (return_void)
- scoped_generator.set("return_statement", "return;");
- else
- scoped_generator.set("return_statement", "return {};");
- // FIXME: Add support for optional to all types
- if (parameter.type.name == "DOMString") {
- if (!optional) {
- scoped_generator.append(R"~~~(
- auto @cpp_name@ = @js_name@@js_suffix@.to_string(global_object, @legacy_null_to_empty_string@);
- if (vm.exception())
- @return_statement@
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- String @cpp_name@;
- if (!@js_name@@js_suffix@.is_undefined()) {
- @cpp_name@ = @js_name@@js_suffix@.to_string(global_object, @legacy_null_to_empty_string@);
- if (vm.exception())
- @return_statement@
- }
- )~~~");
- }
- } else if (parameter.type.name == "EventListener") {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_function()) {
- vm.throw_exception<JS::TypeError>(global_object, JS::ErrorType::NotA, "Function");
- @return_statement@
- }
- auto @cpp_name@ = adopt(*new EventListener(JS::make_handle(&@js_name@@js_suffix@.as_function())));
- )~~~");
- } else if (is_wrappable_type(parameter.type)) {
- scoped_generator.append(R"~~~(
- auto @cpp_name@_object = @js_name@@js_suffix@.to_object(global_object);
- if (vm.exception())
- @return_statement@
- if (!is<@parameter.type.name@Wrapper>(@cpp_name@_object)) {
- vm.throw_exception<JS::TypeError>(global_object, JS::ErrorType::NotA, "@parameter.type.name@");
- @return_statement@
- }
- auto& @cpp_name@ = static_cast<@parameter.type.name@Wrapper*>(@cpp_name@_object)->impl();
- )~~~");
- } else if (parameter.type.name == "double") {
- scoped_generator.append(R"~~~(
- auto @cpp_name@ = @js_name@@js_suffix@.to_double(global_object);
- if (vm.exception())
- @return_statement@
- )~~~");
- } else if (parameter.type.name == "boolean") {
- scoped_generator.append(R"~~~(
- auto @cpp_name@ = @js_name@@js_suffix@.to_boolean();
- )~~~");
- } else if (parameter.type.name == "unsigned long") {
- scoped_generator.append(R"~~~(
- auto @cpp_name@ = @js_name@@js_suffix@.to_u32(global_object);
- if (vm.exception())
- @return_statement@
- )~~~");
- } else {
- dbgln("Unimplemented JS-to-C++ conversion: {}", parameter.type.name);
- ASSERT_NOT_REACHED();
- }
- };
- auto generate_arguments = [&](auto& parameters, auto& arguments_builder, bool return_void = false) {
- auto arguments_generator = generator.fork();
- Vector<String> parameter_names;
- size_t argument_index = 0;
- for (auto& parameter : parameters) {
- parameter_names.append(snake_name(parameter.name));
- arguments_generator.set("argument.index", String::number(argument_index));
- arguments_generator.append(R"~~~(
- auto arg@argument.index@ = vm.argument(@argument.index@);
- )~~~");
- // FIXME: Parameters can have [LegacyNullToEmptyString] attached.
- generate_to_cpp(parameter, "arg", String::number(argument_index), snake_name(parameter.name), return_void, false, parameter.optional);
- ++argument_index;
- }
- arguments_builder.join(", ", parameter_names);
- };
- auto generate_return_statement = [&](auto& return_type) {
- auto scoped_generator = generator.fork();
- scoped_generator.set("return_type", return_type.name);
- if (return_type.name == "undefined") {
- scoped_generator.append(R"~~~(
- return JS::js_undefined();
- )~~~");
- return;
- }
- if (return_type.nullable) {
- if (return_type.name == "DOMString") {
- scoped_generator.append(R"~~~(
- if (retval.is_null())
- return JS::js_null();
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- if (!retval)
- return JS::js_null();
- )~~~");
- }
- }
- if (return_type.name == "DOMString") {
- scoped_generator.append(R"~~~(
- return JS::js_string(vm, retval);
- )~~~");
- } else if (return_type.name == "ArrayFromVector") {
- // FIXME: Remove this fake type hack once it's no longer needed.
- // Basically once we have NodeList we can throw this out.
- scoped_generator.append(R"~~~(
- auto* new_array = JS::Array::create(global_object);
- for (auto& element : retval)
- new_array->indexed_properties().append(wrap(global_object, element));
- return new_array;
- )~~~");
- } else if (return_type.name == "boolean" || return_type.name == "double" || return_type.name == "long" || return_type.name == "unsigned long") {
- scoped_generator.append(R"~~~(
- return JS::Value(retval);
- )~~~");
- } else if (return_type.name == "short" || return_type.name == "unsigned short") {
- scoped_generator.append(R"~~~(
- return JS::Value((i32)retval);
- )~~~");
- } else if (return_type.name == "Uint8ClampedArray") {
- scoped_generator.append(R"~~~(
- return retval;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- return wrap(global_object, const_cast<@return_type@&>(*retval));
- )~~~");
- }
- };
- for (auto& attribute : interface.attributes) {
- auto attribute_generator = generator.fork();
- attribute_generator.set("attribute.getter_callback", attribute.getter_callback_name);
- attribute_generator.set("attribute.setter_callback", attribute.setter_callback_name);
- attribute_generator.set("attribute.name:snakecase", snake_name(attribute.name));
- if (attribute.extended_attributes.contains("Reflect")) {
- auto attribute_name = attribute.extended_attributes.get("Reflect").value();
- if (attribute_name.is_null())
- attribute_name = attribute.name;
- attribute_name = make_input_acceptable_cpp(attribute_name);
- attribute_generator.set("attribute.reflect_name", attribute_name);
- } else {
- attribute_generator.set("attribute.reflect_name", snake_name(attribute.name));
- }
- attribute_generator.append(R"~~~(
- JS_DEFINE_NATIVE_GETTER(@prototype_class@::@attribute.getter_callback@)
- {
- auto* impl = impl_from(vm, global_object);
- if (!impl)
- return {};
- )~~~");
- if (attribute.extended_attributes.contains("ReturnNullIfCrossOrigin")) {
- attribute_generator.append(R"~~~(
- if (!impl->may_access_from_origin(static_cast<WindowObject&>(global_object).origin()))
- return JS::js_null();
- )~~~");
- }
- if (attribute.extended_attributes.contains("Reflect")) {
- if (attribute.type.name != "boolean") {
- attribute_generator.append(R"~~~(
- auto retval = impl->attribute(HTML::AttributeNames::@attribute.reflect_name@);
- )~~~");
- } else {
- attribute_generator.append(R"~~~(
- auto retval = impl->has_attribute(HTML::AttributeNames::@attribute.reflect_name@);
- )~~~");
- }
- } else {
- attribute_generator.append(R"~~~(
- auto retval = impl->@attribute.name:snakecase@();
- )~~~");
- }
- generate_return_statement(attribute.type);
- attribute_generator.append(R"~~~(
- }
- )~~~");
- if (!attribute.readonly) {
- attribute_generator.append(R"~~~(
- JS_DEFINE_NATIVE_SETTER(@prototype_class@::@attribute.setter_callback@)
- {
- auto* impl = impl_from(vm, global_object);
- if (!impl)
- return;
- )~~~");
- generate_to_cpp(attribute, "value", "", "cpp_value", true, attribute.extended_attributes.contains("LegacyNullToEmptyString"));
- if (attribute.extended_attributes.contains("Reflect")) {
- if (attribute.type.name != "boolean") {
- attribute_generator.append(R"~~~(
- impl->set_attribute(HTML::AttributeNames::@attribute.reflect_name@, cpp_value);
- )~~~");
- } else {
- attribute_generator.append(R"~~~(
- if (!cpp_value)
- impl->remove_attribute(HTML::AttributeNames::@attribute.reflect_name@);
- else
- impl->set_attribute(HTML::AttributeNames::@attribute.reflect_name@, String::empty());
- )~~~");
- }
- } else {
- attribute_generator.append(R"~~~(
- impl->set_@attribute.name:snakecase@(cpp_value);
- )~~~");
- }
- attribute_generator.append(R"~~~(
- }
- )~~~");
- }
- }
- // Implementation: Functions
- for (auto& function : interface.functions) {
- auto function_generator = generator.fork();
- function_generator.set("function.name", function.name);
- function_generator.set("function.name:snakecase", snake_name(function.name));
- function_generator.set("function.nargs", String::number(function.length()));
- function_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::@function.name:snakecase@)
- {
- auto* impl = impl_from(vm, global_object);
- if (!impl)
- return {};
- )~~~");
- if (function.length() > 0) {
- if (function.length() == 1) {
- function_generator.set(".bad_arg_count", "JS::ErrorType::BadArgCountOne");
- function_generator.set(".arg_count_suffix", "");
- } else {
- function_generator.set(".bad_arg_count", "JS::ErrorType::BadArgCountMany");
- function_generator.set(".arg_count_suffix", String::formatted(", \"{}\"", function.length()));
- }
- function_generator.append(R"~~~(
- if (vm.argument_count() < @function.nargs@) {
- vm.throw_exception<JS::TypeError>(global_object, @.bad_arg_count@, "@function.name@"@.arg_count_suffix@);
- return {};
- }
- )~~~");
- }
- StringBuilder arguments_builder;
- generate_arguments(function.parameters, arguments_builder);
- function_generator.set(".arguments", arguments_builder.string_view());
- if (function.return_type.name != "undefined") {
- function_generator.append(R"~~~(
- auto retval = impl->@function.name:snakecase@(@.arguments@);
- )~~~");
- } else {
- function_generator.append(R"~~~(
- impl->@function.name:snakecase@(@.arguments@);
- )~~~");
- }
- generate_return_statement(function.return_type);
- function_generator.append(R"~~~(
- }
- )~~~");
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
|