123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485 |
- /*
- * Copyright (c) 2022, Andrew Kaster <akaster@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
- #include <AK/DeprecatedString.h>
- #include <AK/LexicalPath.h>
- #include <AK/SourceGenerator.h>
- #include <AK/StringBuilder.h>
- #include <LibCore/ArgsParser.h>
- #include <LibCore/Stream.h>
- #include <LibIDL/IDLParser.h>
- #include <LibIDL/Types.h>
- #include <LibMain/Main.h>
- static ErrorOr<void> add_to_interface_sets(IDL::Interface&, Vector<IDL::Interface&>& intrinsics, Vector<IDL::Interface&>& window_exposed, Vector<IDL::Interface&>& dedicated_worker_exposed, Vector<IDL::Interface&>& shared_worker_exposed);
- static DeprecatedString s_error_string;
- struct LegacyConstructor {
- DeprecatedString name;
- DeprecatedString constructor_class;
- };
- static void consume_whitespace(GenericLexer& lexer)
- {
- bool consumed = true;
- while (consumed) {
- consumed = lexer.consume_while(is_ascii_space).length() > 0;
- if (lexer.consume_specific("//")) {
- lexer.consume_until('\n');
- lexer.ignore();
- consumed = true;
- }
- }
- }
- static Optional<LegacyConstructor> const& lookup_legacy_constructor(IDL::Interface& interface)
- {
- static HashMap<StringView, Optional<LegacyConstructor>> s_legacy_constructors;
- if (auto cache = s_legacy_constructors.get(interface.name); cache.has_value())
- return cache.value();
- auto attribute = interface.extended_attributes.get("LegacyFactoryFunction"sv);
- if (!attribute.has_value()) {
- s_legacy_constructors.set(interface.name, {});
- return s_legacy_constructors.get(interface.name).value();
- }
- GenericLexer function_lexer(attribute.value());
- consume_whitespace(function_lexer);
- auto name = function_lexer.consume_until([](auto ch) { return is_ascii_space(ch) || ch == '('; });
- auto constructor_class = DeprecatedString::formatted("{}Constructor", name);
- s_legacy_constructors.set(interface.name, LegacyConstructor { name, move(constructor_class) });
- return s_legacy_constructors.get(interface.name).value();
- }
- static ErrorOr<void> generate_forwarding_header(StringView output_path, Vector<IDL::Interface&>& exposed_interfaces)
- {
- StringBuilder builder;
- SourceGenerator generator(builder);
- generator.append(R"~~~(
- #pragma once
- namespace Web::Bindings {
- )~~~");
- auto add_interface = [](SourceGenerator& gen, StringView prototype_class, StringView constructor_class, Optional<LegacyConstructor> const& legacy_constructor) {
- gen.set("prototype_class", prototype_class);
- gen.set("constructor_class", constructor_class);
- gen.append(R"~~~(
- class @prototype_class@;
- class @constructor_class@;)~~~");
- if (legacy_constructor.has_value()) {
- gen.set("legacy_constructor_class", legacy_constructor->constructor_class);
- gen.append(R"~~~(
- class @legacy_constructor_class@;)~~~");
- }
- };
- for (auto& interface : exposed_interfaces) {
- auto gen = generator.fork();
- add_interface(gen, interface.prototype_class, interface.constructor_class, lookup_legacy_constructor(interface));
- }
- // FIXME: Special case window. We should convert Window and Location to use IDL.
- {
- auto gen = generator.fork();
- add_interface(gen, "WindowPrototype"sv, "WindowConstructor"sv, {});
- add_interface(gen, "LocationPrototype"sv, "LocationConstructor"sv, {});
- }
- // FIXME: Special case WebAssembly. We should convert WASM to use IDL.
- {
- auto gen = generator.fork();
- add_interface(gen, "WebAssemblyMemoryPrototype"sv, "WebAssemblyMemoryConstructor"sv, {});
- add_interface(gen, "WebAssemblyInstancePrototype"sv, "WebAssemblyInstanceConstructor"sv, {});
- add_interface(gen, "WebAssemblyModulePrototype"sv, "WebAssemblyModuleConstructor"sv, {});
- add_interface(gen, "WebAssemblyTablePrototype"sv, "WebAssemblyTableConstructor"sv, {});
- }
- generator.append(R"~~~(
- }
- )~~~");
- auto generated_forward_path = LexicalPath(output_path).append("Forward.h"sv).string();
- auto generated_forward_file = TRY(Core::Stream::File::open(generated_forward_path, Core::Stream::OpenMode::Write));
- TRY(generated_forward_file->write(generator.as_string_view().bytes()));
- return {};
- }
- static ErrorOr<void> generate_intrinsic_definitions(StringView output_path, Vector<IDL::Interface&>& exposed_interfaces)
- {
- StringBuilder builder;
- SourceGenerator generator(builder);
- generator.append(R"~~~(
- #include <LibJS/Heap/DeferGC.h>
- #include <LibJS/Runtime/Object.h>
- #include <LibWeb/Bindings/Intrinsics.h>)~~~");
- for (auto& interface : exposed_interfaces) {
- auto gen = generator.fork();
- gen.set("prototype_class", interface.prototype_class);
- gen.set("constructor_class", interface.constructor_class);
- gen.append(R"~~~(
- #include <LibWeb/Bindings/@constructor_class@.h>
- #include <LibWeb/Bindings/@prototype_class@.h>)~~~");
- if (auto const& legacy_constructor = lookup_legacy_constructor(interface); legacy_constructor.has_value()) {
- gen.set("legacy_constructor_class", legacy_constructor->constructor_class);
- gen.append(R"~~~(
- #include <LibWeb/Bindings/@legacy_constructor_class@.h>)~~~");
- }
- }
- // FIXME: Special case window. We should convert Window and Location to use IDL.
- generator.append(R"~~~(
- #include <LibWeb/Bindings/WindowConstructor.h>
- #include <LibWeb/Bindings/WindowPrototype.h>
- #include <LibWeb/Bindings/LocationConstructor.h>
- #include <LibWeb/Bindings/LocationPrototype.h>)~~~");
- // FIXME: Special case WebAssembly. We should convert WASM to use IDL.
- generator.append(R"~~~(
- #include <LibWeb/WebAssembly/WebAssemblyMemoryConstructor.h>
- #include <LibWeb/WebAssembly/WebAssemblyMemoryPrototype.h>
- #include <LibWeb/WebAssembly/WebAssemblyInstanceConstructor.h>
- #include <LibWeb/WebAssembly/WebAssemblyInstanceObjectPrototype.h>
- #include <LibWeb/WebAssembly/WebAssemblyModuleConstructor.h>
- #include <LibWeb/WebAssembly/WebAssemblyModulePrototype.h>
- #include <LibWeb/WebAssembly/WebAssemblyTableConstructor.h>
- #include <LibWeb/WebAssembly/WebAssemblyTablePrototype.h>)~~~");
- generator.append(R"~~~(
- namespace Web::Bindings {
- )~~~");
- auto add_interface = [&](SourceGenerator& gen, StringView name, StringView prototype_class, StringView constructor_class, Optional<LegacyConstructor> const& legacy_constructor) {
- gen.set("interface_name", name);
- gen.set("prototype_class", prototype_class);
- gen.set("constructor_class", constructor_class);
- gen.append(R"~~~(
- template<>
- void Intrinsics::create_web_prototype_and_constructor<@prototype_class@>(JS::Realm& realm)
- {
- auto& vm = realm.vm();
- auto prototype = heap().allocate<@prototype_class@>(realm, realm);
- m_prototypes.set("@interface_name@"sv, prototype);
- auto constructor = heap().allocate<@constructor_class@>(realm, realm);
- m_constructors.set("@interface_name@"sv, constructor);
- prototype->define_direct_property(vm.names.constructor, constructor.ptr(), JS::Attribute::Writable | JS::Attribute::Configurable);
- constructor->define_direct_property(vm.names.name, JS::PrimitiveString::create(vm, "@interface_name@"sv), JS::Attribute::Configurable);
- )~~~");
- if (legacy_constructor.has_value()) {
- gen.set("legacy_interface_name", legacy_constructor->name);
- gen.set("legacy_constructor_class", legacy_constructor->constructor_class);
- gen.append(R"~~~(
- auto legacy_constructor = heap().allocate<@legacy_constructor_class@>(realm, realm);
- m_constructors.set("@legacy_interface_name@"sv, legacy_constructor);
- legacy_constructor->define_direct_property(vm.names.name, JS::PrimitiveString::create(vm, "@legacy_interface_name@"sv), JS::Attribute::Configurable);)~~~");
- }
- gen.append(R"~~~(
- }
- )~~~");
- };
- for (auto& interface : exposed_interfaces) {
- auto gen = generator.fork();
- add_interface(gen, interface.name, interface.prototype_class, interface.constructor_class, lookup_legacy_constructor(interface));
- }
- // FIXME: Special case window. We should convert Window and Location to use IDL
- {
- auto gen = generator.fork();
- add_interface(gen, "Window"sv, "WindowPrototype"sv, "WindowConstructor"sv, {});
- add_interface(gen, "Location"sv, "LocationPrototype"sv, "LocationConstructor"sv, {});
- }
- // FIXME: Special case WebAssembly. We should convert WASM to use IDL.
- {
- auto gen = generator.fork();
- add_interface(gen, "WebAssembly.Memory"sv, "WebAssemblyMemoryPrototype"sv, "WebAssemblyMemoryConstructor"sv, {});
- add_interface(gen, "WebAssembly.Instance"sv, "WebAssemblyInstancePrototype"sv, "WebAssemblyInstanceConstructor"sv, {});
- add_interface(gen, "WebAssembly.Module"sv, "WebAssemblyModulePrototype"sv, "WebAssemblyModuleConstructor"sv, {});
- add_interface(gen, "WebAssembly.Table"sv, "WebAssemblyTablePrototype"sv, "WebAssemblyTableConstructor"sv, {});
- }
- generator.append(R"~~~(
- }
- )~~~");
- auto generated_intrinsics_path = LexicalPath(output_path).append("IntrinsicDefinitions.cpp"sv).string();
- auto generated_intrinsics_file = TRY(Core::Stream::File::open(generated_intrinsics_path, Core::Stream::OpenMode::Write));
- TRY(generated_intrinsics_file->write(generator.as_string_view().bytes()));
- return {};
- }
- static ErrorOr<void> generate_exposed_interface_header(StringView class_name, StringView output_path)
- {
- StringBuilder builder;
- SourceGenerator generator(builder);
- generator.set("global_object_snake_name", DeprecatedString(class_name).to_snakecase());
- generator.append(R"~~~(
- #pragma once
- #include <LibJS/Forward.h>
- namespace Web::Bindings {
- void add_@global_object_snake_name@_exposed_interfaces(JS::Object&);
- }
- )~~~");
- auto generated_header_path = LexicalPath(output_path).append(DeprecatedString::formatted("{}ExposedInterfaces.h", class_name)).string();
- auto generated_header_file = TRY(Core::Stream::File::open(generated_header_path, Core::Stream::OpenMode::Write));
- TRY(generated_header_file->write(generator.as_string_view().bytes()));
- return {};
- }
- static ErrorOr<void> generate_exposed_interface_implementation(StringView class_name, StringView output_path, Vector<IDL::Interface&>& exposed_interfaces)
- {
- StringBuilder builder;
- SourceGenerator generator(builder);
- generator.set("global_object_name", class_name);
- generator.set("global_object_snake_name", DeprecatedString(class_name).to_snakecase());
- generator.append(R"~~~(
- #include <LibJS/Runtime/Object.h>
- #include <LibWeb/Bindings/Intrinsics.h>
- #include <LibWeb/Bindings/@global_object_name@ExposedInterfaces.h>
- )~~~");
- for (auto& interface : exposed_interfaces) {
- auto gen = generator.fork();
- gen.set("prototype_class", interface.prototype_class);
- gen.set("constructor_class", interface.constructor_class);
- gen.append(R"~~~(#include <LibWeb/Bindings/@constructor_class@.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- )~~~");
- if (auto const& legacy_constructor = lookup_legacy_constructor(interface); legacy_constructor.has_value()) {
- gen.set("legacy_constructor_class", legacy_constructor->constructor_class);
- gen.append(R"~~~(#include <LibWeb/Bindings/@legacy_constructor_class@.h>
- )~~~");
- }
- }
- // FIXME: Special case window. We should convert Window and Location to use IDL
- if (class_name == "Window"sv) {
- generator.append(R"~~~(#include <LibWeb/Bindings/WindowConstructor.h>
- #include <LibWeb/Bindings/WindowPrototype.h>
- #include <LibWeb/Bindings/LocationConstructor.h>
- #include <LibWeb/Bindings/LocationPrototype.h>
- )~~~");
- }
- generator.append(R"~~~(
- namespace Web::Bindings {
- void add_@global_object_snake_name@_exposed_interfaces(JS::Object& global)
- {
- static constexpr u8 attr = JS::Attribute::Writable | JS::Attribute::Configurable;
- )~~~");
- auto add_interface = [](SourceGenerator& gen, StringView name, StringView prototype_class) {
- gen.set("interface_name", name);
- gen.set("prototype_class", prototype_class);
- gen.append(R"~~~(
- global.define_intrinsic_accessor("@interface_name@", attr, [](auto& realm) -> JS::Value { return &ensure_web_constructor<@prototype_class@>(realm, "@interface_name@"sv); });)~~~"); };
- for (auto& interface : exposed_interfaces) {
- auto gen = generator.fork();
- add_interface(gen, interface.name, interface.prototype_class);
- }
- // FIXME: Special case window. We should convert Window and Location to use IDL
- if (class_name == "Window"sv) {
- auto gen = generator.fork();
- add_interface(gen, "Window"sv, "WindowPrototype"sv);
- add_interface(gen, "Location"sv, "LocationPrototype"sv);
- }
- generator.append(R"~~~(
- }
- }
- )~~~");
- auto generated_implementation_path = LexicalPath(output_path).append(DeprecatedString::formatted("{}ExposedInterfaces.cpp", class_name)).string();
- auto generated_implementation_file = TRY(Core::Stream::File::open(generated_implementation_path, Core::Stream::OpenMode::Write));
- TRY(generated_implementation_file->write(generator.as_string_view().bytes()));
- return {};
- }
- ErrorOr<int> serenity_main(Main::Arguments arguments)
- {
- Core::ArgsParser args_parser;
- StringView output_path;
- StringView base_path;
- Vector<DeprecatedString> paths;
- args_parser.add_option(output_path, "Path to output generated files into", "output-path", 'o', "output-path");
- args_parser.add_option(base_path, "Path to root of IDL file tree", "base-path", 'b', "base-path");
- args_parser.add_positional_argument(paths, "Paths of every IDL file that could be Exposed", "paths");
- args_parser.parse(arguments);
- VERIFY(!paths.is_empty());
- VERIFY(!base_path.is_empty());
- const LexicalPath lexical_base(base_path);
- // Read in all IDL files, we must own the storage for all of these for the lifetime of the program
- Vector<DeprecatedString> file_contents;
- for (DeprecatedString const& path : paths) {
- auto file_or_error = Core::Stream::File::open(path, Core::Stream::OpenMode::Read);
- if (file_or_error.is_error()) {
- s_error_string = DeprecatedString::formatted("Unable to open file {}", path);
- return Error::from_string_view(s_error_string);
- }
- auto file = file_or_error.release_value();
- auto string = MUST(file->read_until_eof());
- file_contents.append(DeprecatedString(ReadonlyBytes(string)));
- }
- VERIFY(paths.size() == file_contents.size());
- Vector<IDL::Parser> parsers;
- Vector<IDL::Interface&> intrinsics;
- Vector<IDL::Interface&> window_exposed;
- Vector<IDL::Interface&> dedicated_worker_exposed;
- Vector<IDL::Interface&> shared_worker_exposed;
- // TODO: service_worker_exposed
- for (size_t i = 0; i < paths.size(); ++i) {
- IDL::Parser parser(paths[i], file_contents[i], lexical_base.string());
- TRY(add_to_interface_sets(parser.parse(), intrinsics, window_exposed, dedicated_worker_exposed, shared_worker_exposed));
- parsers.append(move(parser));
- }
- TRY(generate_forwarding_header(output_path, intrinsics));
- TRY(generate_intrinsic_definitions(output_path, intrinsics));
- TRY(generate_exposed_interface_header("Window"sv, output_path));
- TRY(generate_exposed_interface_header("DedicatedWorker"sv, output_path));
- TRY(generate_exposed_interface_header("SharedWorker"sv, output_path));
- // TODO: ServiceWorkerExposed.h
- TRY(generate_exposed_interface_implementation("Window"sv, output_path, window_exposed));
- TRY(generate_exposed_interface_implementation("DedicatedWorker"sv, output_path, dedicated_worker_exposed));
- TRY(generate_exposed_interface_implementation("SharedWorker"sv, output_path, shared_worker_exposed));
- // TODO: ServiceWorkerExposed.cpp
- return 0;
- }
- enum ExposedTo {
- Nobody = 0x0,
- DedicatedWorker = 0x1,
- SharedWorker = 0x2,
- ServiceWorker = 0x4,
- AudioWorklet = 0x8,
- Window = 0x10,
- AllWorkers = 0xF, // FIXME: Is "AudioWorklet" a Worker? We'll assume it is for now
- All = 0x1F,
- };
- AK_ENUM_BITWISE_OPERATORS(ExposedTo);
- static ErrorOr<ExposedTo> parse_exposure_set(IDL::Interface& interface)
- {
- // NOTE: This roughly follows the definitions of https://webidl.spec.whatwg.org/#Exposed
- // It does not remotely interpret all the abstract operations therein though.
- auto maybe_exposed = interface.extended_attributes.get("Exposed");
- if (!maybe_exposed.has_value()) {
- s_error_string = DeprecatedString::formatted("Interface {} is missing extended attribute Exposed", interface.name);
- return Error::from_string_view(s_error_string);
- }
- auto exposed = maybe_exposed.value().trim_whitespace();
- if (exposed == "*"sv)
- return ExposedTo::All;
- if (exposed == "Window"sv)
- return ExposedTo::Window;
- if (exposed == "Worker"sv)
- return ExposedTo::AllWorkers;
- if (exposed == "AudioWorklet"sv)
- return ExposedTo::AudioWorklet;
- if (exposed[0] == '(') {
- ExposedTo whom = Nobody;
- for (StringView candidate : exposed.substring_view(1, exposed.length() - 1).split_view(',')) {
- candidate = candidate.trim_whitespace();
- if (candidate == "Window"sv) {
- whom |= ExposedTo::Window;
- } else if (candidate == "Worker"sv) {
- whom |= ExposedTo::AllWorkers;
- } else if (candidate == "DedicatedWorker"sv) {
- whom |= ExposedTo::DedicatedWorker;
- } else if (candidate == "SharedWorker"sv) {
- whom |= ExposedTo::SharedWorker;
- } else if (candidate == "ServiceWorker"sv) {
- whom |= ExposedTo::ServiceWorker;
- } else if (candidate == "AudioWorklet"sv) {
- whom |= ExposedTo::AudioWorklet;
- } else {
- s_error_string = DeprecatedString::formatted("Unknown Exposed attribute candidate {} in {} in {}", candidate, exposed, interface.name);
- return Error::from_string_view(s_error_string);
- }
- }
- if (whom == ExposedTo::Nobody) {
- s_error_string = DeprecatedString::formatted("Unknown Exposed attribute {} in {}", exposed, interface.name);
- return Error::from_string_view(s_error_string);
- }
- return whom;
- }
- s_error_string = DeprecatedString::formatted("Unknown Exposed attribute {} in {}", exposed, interface.name);
- return Error::from_string_view(s_error_string);
- }
- ErrorOr<void> add_to_interface_sets(IDL::Interface& interface, Vector<IDL::Interface&>& intrinsics, Vector<IDL::Interface&>& window_exposed, Vector<IDL::Interface&>& dedicated_worker_exposed, Vector<IDL::Interface&>& shared_worker_exposed)
- {
- // TODO: Add service worker exposed and audio worklet exposed
- auto whom = TRY(parse_exposure_set(interface));
- VERIFY(whom != ExposedTo::Nobody);
- if ((whom & ExposedTo::Window) || (whom & ExposedTo::DedicatedWorker) || (whom & ExposedTo::SharedWorker))
- intrinsics.append(interface);
- if (whom & ExposedTo::Window)
- window_exposed.append(interface);
- if (whom & ExposedTo::DedicatedWorker)
- dedicated_worker_exposed.append(interface);
- if (whom & ExposedTo::SharedWorker)
- shared_worker_exposed.append(interface);
- return {};
- }
|