123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819 |
- /*
- * Copyright (c) 2020-2021, Andreas Kling <kling@serenityos.org>
- * Copyright (c) 2021, Linus Groh <linusg@serenityos.org>
- * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
- * Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
- #include "IDLTypes.h"
- #include <AK/LexicalPath.h>
- #include <AK/Queue.h>
- #include <AK/QuickSort.h>
- Vector<StringView> s_header_search_paths;
- namespace IDL {
- static bool is_wrappable_type(Type const& type)
- {
- if (type.name == "EventTarget")
- return true;
- 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"sv))
- return true;
- if (type.name.ends_with("Event"sv))
- return true;
- if (type.name == "ImageData")
- return true;
- if (type.name == "Window")
- return true;
- if (type.name == "Range")
- return true;
- if (type.name == "Selection")
- return true;
- if (type.name == "Attribute")
- return true;
- if (type.name == "NamedNodeMap")
- return true;
- if (type.name == "TextMetrics")
- return true;
- if (type.name == "AbortSignal")
- return true;
- if (type.name == "CanvasRenderingContext2D")
- return true;
- if (type.name == "WebGLRenderingContext")
- return true;
- if (type.name == "URLSearchParams")
- return true;
- if (type.name == "Blob")
- return true;
- if (type.name == "Path2D")
- return true;
- return false;
- }
- static StringView sequence_storage_type_to_cpp_storage_type_name(SequenceStorageType sequence_storage_type)
- {
- switch (sequence_storage_type) {
- case SequenceStorageType::Vector:
- return "Vector"sv;
- case SequenceStorageType::MarkedVector:
- return "JS::MarkedVector"sv;
- default:
- VERIFY_NOT_REACHED();
- }
- }
- CppType idl_type_name_to_cpp_type(Type const& type, Interface const& interface)
- {
- if (is_wrappable_type(type)) {
- if (type.nullable)
- return { .name = String::formatted("RefPtr<{}>", type.name), .sequence_storage_type = SequenceStorageType::Vector };
- return { .name = String::formatted("NonnullRefPtr<{}>", type.name), .sequence_storage_type = SequenceStorageType::Vector };
- }
- if (type.is_string())
- return { .name = "String", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "double" && !type.nullable)
- return { .name = "double", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "float" && !type.nullable)
- return { .name = "float", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "boolean" && !type.nullable)
- return { .name = "bool", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "unsigned long" && !type.nullable)
- return { .name = "u32", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "unsigned short" && !type.nullable)
- return { .name = "u16", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "long long" && !type.nullable)
- return { .name = "i64", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "unsigned long long" && !type.nullable)
- return { .name = "u64", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "long" && !type.nullable)
- return { .name = "i32", .sequence_storage_type = SequenceStorageType::Vector };
- if (type.name == "any")
- return { .name = "JS::Value", .sequence_storage_type = SequenceStorageType::MarkedVector };
- if (type.name == "BufferSource")
- return { .name = "JS::Handle<JS::Object>", .sequence_storage_type = SequenceStorageType::MarkedVector };
- if (type.name == "sequence") {
- auto& parameterized_type = verify_cast<ParameterizedType>(type);
- auto& sequence_type = parameterized_type.parameters.first();
- auto sequence_cpp_type = idl_type_name_to_cpp_type(sequence_type, interface);
- auto storage_type_name = sequence_storage_type_to_cpp_storage_type_name(sequence_cpp_type.sequence_storage_type);
- if (sequence_cpp_type.sequence_storage_type == SequenceStorageType::MarkedVector)
- return { .name = storage_type_name, .sequence_storage_type = SequenceStorageType::Vector };
- return { .name = String::formatted("{}<{}>", storage_type_name, sequence_cpp_type.name), .sequence_storage_type = SequenceStorageType::Vector };
- }
- if (type.name == "record") {
- auto& parameterized_type = verify_cast<ParameterizedType>(type);
- auto& record_key_type = parameterized_type.parameters[0];
- auto& record_value_type = parameterized_type.parameters[1];
- auto record_key_cpp_type = idl_type_name_to_cpp_type(record_key_type, interface);
- auto record_value_cpp_type = idl_type_name_to_cpp_type(record_value_type, interface);
- return { .name = String::formatted("OrderedHashMap<{}, {}>", record_key_cpp_type.name, record_value_cpp_type.name), .sequence_storage_type = SequenceStorageType::Vector };
- }
- if (is<UnionType>(type)) {
- auto& union_type = verify_cast<UnionType>(type);
- return { .name = union_type.to_variant(interface), .sequence_storage_type = SequenceStorageType::Vector };
- }
- if (!type.nullable) {
- for (auto& dictionary : interface.dictionaries) {
- if (type.name == dictionary.key)
- return { .name = type.name, .sequence_storage_type = SequenceStorageType::Vector };
- }
- }
- dbgln("Unimplemented type for idl_type_name_to_cpp_type: {}{}", type.name, type.nullable ? "?" : "");
- TODO();
- }
- static String make_input_acceptable_cpp(String const& input)
- {
- if (input.is_one_of("class", "template", "for", "default", "char", "namespace", "delete")) {
- StringBuilder builder;
- builder.append(input);
- builder.append('_');
- return builder.to_string();
- }
- return input.replace("-"sv, "_"sv, ReplaceMode::All);
- }
- static void generate_include_for_wrapper(auto& generator, auto& wrapper_name)
- {
- auto wrapper_generator = generator.fork();
- wrapper_generator.set("wrapper_class", wrapper_name);
- // FIXME: These may or may not exist, because REASONS.
- wrapper_generator.append(R"~~~(
- #if __has_include(<LibWeb/Bindings/@wrapper_class@.h>)
- # include <LibWeb/Bindings/@wrapper_class@.h>
- #endif
- #if __has_include(<LibWeb/Bindings/@wrapper_class@Factory.h>)
- # include <LibWeb/Bindings/@wrapper_class@Factory.h>
- #endif
- )~~~");
- }
- static void generate_include_for_iterator(auto& generator, auto& iterator_path, auto& iterator_name)
- {
- auto iterator_generator = generator.fork();
- iterator_generator.set("iterator_class.path", iterator_path);
- iterator_generator.set("iterator_class.name", iterator_name);
- // FIXME: These may or may not exist, because REASONS.
- iterator_generator.append(R"~~~(
- //#if __has_include(<LibWeb/@iterator_class.path@.h>)
- # include <LibWeb/@iterator_class.path@.h>
- //#endif
- #if __has_include(<LibWeb/@iterator_class.path@Factory.h>)
- # include <LibWeb/@iterator_class.path@Factory.h>
- #endif
- #if __has_include(<LibWeb/Bindings/@iterator_class.name@Wrapper.h>)
- # include <LibWeb/Bindings/@iterator_class.name@Wrapper.h>
- #endif
- #if __has_include(<LibWeb/Bindings/@iterator_class.name@WrapperFactory.h>)
- # include <LibWeb/Bindings/@iterator_class.name@WrapperFactory.h>
- #endif
- )~~~");
- }
- static void generate_include_for(auto& generator, auto& path)
- {
- auto forked_generator = generator.fork();
- auto path_string = path;
- for (auto& search_path : s_header_search_paths) {
- if (!path.starts_with(search_path))
- continue;
- auto relative_path = LexicalPath::relative_path(path, search_path);
- if (relative_path.length() < path_string.length())
- path_string = relative_path;
- }
- LexicalPath include_path { path_string };
- forked_generator.set("include.path", String::formatted("{}/{}.h", include_path.dirname(), include_path.title()));
- forked_generator.append(R"~~~(
- #include <@include.path@>
- )~~~");
- }
- static void emit_includes_for_all_imports(auto& interface, auto& generator, bool is_iterator = false)
- {
- Queue<RemoveCVReference<decltype(interface)> const*> interfaces;
- HashTable<String> paths_imported;
- interfaces.enqueue(&interface);
- while (!interfaces.is_empty()) {
- auto interface = interfaces.dequeue();
- if (paths_imported.contains(interface->module_own_path))
- continue;
- paths_imported.set(interface->module_own_path);
- for (auto& imported_interface : interface->imported_modules) {
- if (!paths_imported.contains(imported_interface.module_own_path))
- interfaces.enqueue(&imported_interface);
- }
- if (!interface->will_generate_code())
- continue;
- generate_include_for(generator, interface->module_own_path);
- if (is_iterator) {
- auto iterator_name = String::formatted("{}Iterator", interface->name);
- auto iterator_path = String::formatted("{}Iterator", interface->fully_qualified_name.replace("::"sv, "/"sv, ReplaceMode::All));
- generate_include_for_iterator(generator, iterator_path, iterator_name);
- }
- if (interface->wrapper_class != "Wrapper")
- generate_include_for_wrapper(generator, interface->wrapper_class);
- }
- }
- static bool should_emit_wrapper_factory(IDL::Interface const& 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"sv))
- return false;
- if (interface.name.starts_with("CSS"sv) && interface.name.ends_with("Rule"sv))
- return false;
- return true;
- }
- template<typename ParameterType>
- static void generate_to_cpp(SourceGenerator& generator, ParameterType& parameter, String const& js_name, String const& js_suffix, String const& cpp_name, IDL::Interface const& interface, bool legacy_null_to_empty_string = false, bool optional = false, Optional<String> optional_default_value = {}, bool variadic = false, size_t recursion_depth = 0)
- {
- auto scoped_generator = generator.fork();
- auto acceptable_cpp_name = make_input_acceptable_cpp(cpp_name);
- scoped_generator.set("cpp_name", acceptable_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 (parameter.type->name == "Window")
- scoped_generator.set("wrapper_name", "WindowObject");
- else
- scoped_generator.set("wrapper_name", String::formatted("{}Wrapper", parameter.type->name));
- if (optional_default_value.has_value())
- scoped_generator.set("parameter.optional_default_value", *optional_default_value);
- // FIXME: Add support for optional, variadic, nullable and default values to all types
- if (parameter.type->is_string()) {
- if (variadic) {
- scoped_generator.append(R"~~~(
- Vector<String> @cpp_name@;
- @cpp_name@.ensure_capacity(vm.argument_count() - @js_suffix@);
- for (size_t i = @js_suffix@; i < vm.argument_count(); ++i) {
- auto to_string_result = TRY(vm.argument(i).to_string(global_object));
- @cpp_name@.append(move(to_string_result));
- }
- )~~~");
- } else if (!optional) {
- if (!parameter.type->nullable) {
- scoped_generator.append(R"~~~(
- String @cpp_name@;
- if (@js_name@@js_suffix@.is_null() && @legacy_null_to_empty_string@) {
- @cpp_name@ = String::empty();
- } else {
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_string(global_object));
- }
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- String @cpp_name@;
- if (!@js_name@@js_suffix@.is_nullish())
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_string(global_object));
- )~~~");
- }
- } else {
- scoped_generator.append(R"~~~(
- String @cpp_name@;
- if (!@js_name@@js_suffix@.is_undefined()) {
- if (@js_name@@js_suffix@.is_null() && @legacy_null_to_empty_string@)
- @cpp_name@ = String::empty();
- else
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_string(global_object));
- })~~~");
- if (optional_default_value.has_value() && (!parameter.type->nullable || optional_default_value.value() != "null")) {
- scoped_generator.append(R"~~~( else {
- @cpp_name@ = @parameter.optional_default_value@;
- }
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- )~~~");
- }
- }
- } else if (parameter.type->name.is_one_of("EventListener", "NodeFilter")) {
- // FIXME: Replace this with support for callback interfaces. https://heycam.github.io/webidl/#idl-callback-interface
- if (parameter.type->name == "EventListener")
- scoped_generator.set("cpp_type", "IDLEventListener");
- else
- scoped_generator.set("cpp_type", parameter.type->name);
- if (parameter.type->nullable) {
- scoped_generator.append(R"~~~(
- RefPtr<@cpp_type@> @cpp_name@;
- if (!@js_name@@js_suffix@.is_nullish()) {
- if (!@js_name@@js_suffix@.is_object())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObject, @js_name@@js_suffix@.to_string_without_side_effects());
- CallbackType callback_type(JS::make_handle(&@js_name@@js_suffix@.as_object()), HTML::incumbent_settings_object());
- @cpp_name@ = adopt_ref(*new @cpp_type@(move(callback_type)));
- }
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObject, @js_name@@js_suffix@.to_string_without_side_effects());
- CallbackType callback_type(JS::make_handle(&@js_name@@js_suffix@.as_object()), HTML::incumbent_settings_object());
- auto @cpp_name@ = adopt_ref(*new @cpp_type@(move(callback_type)));
- )~~~");
- }
- } else if (IDL::is_wrappable_type(*parameter.type)) {
- if (!parameter.type->nullable) {
- if (!optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object() || !is<@wrapper_name@>(@js_name@@js_suffix@.as_object()))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@parameter.type.name@");
- auto& @cpp_name@ = static_cast<@wrapper_name@&>(@js_name@@js_suffix@.as_object()).impl();
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<NonnullRefPtr<@parameter.type.name@>> @cpp_name@;
- if (!@js_name@@js_suffix@.is_undefined()) {
- if (!@js_name@@js_suffix@.is_object() || !is<@wrapper_name@>(@js_name@@js_suffix@.as_object()))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@parameter.type.name@");
- @cpp_name@ = static_cast<@wrapper_name@&>(@js_name@@js_suffix@.as_object()).impl();
- }
- )~~~");
- }
- } else {
- scoped_generator.append(R"~~~(
- @parameter.type.name@* @cpp_name@ = nullptr;
- if (!@js_name@@js_suffix@.is_nullish()) {
- if (!@js_name@@js_suffix@.is_object() || !is<@wrapper_name@>(@js_name@@js_suffix@.as_object()))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@parameter.type.name@");
- @cpp_name@ = &static_cast<@wrapper_name@&>(@js_name@@js_suffix@.as_object()).impl();
- }
- )~~~");
- }
- } else if (parameter.type->name == "double" || parameter.type->name == "float") {
- if (!optional) {
- scoped_generator.append(R"~~~(
- @parameter.type.name@ @cpp_name@ = TRY(@js_name@@js_suffix@.to_double(global_object));
- )~~~");
- } else {
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- @parameter.type.name@ @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<@parameter.type.name@> @cpp_name@;
- )~~~");
- }
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_double(global_object));
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- )~~~");
- }
- }
- } else if (parameter.type->name == "boolean") {
- if (!optional || optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- bool @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<bool> @cpp_name@;
- )~~~");
- }
- if (optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- )~~~");
- }
- scoped_generator.append(R"~~~(
- @cpp_name@ = @js_name@@js_suffix@.to_boolean();
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@;
- )~~~");
- }
- } else if (parameter.type->name == "unsigned long") {
- if (!optional || optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- u32 @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<u32> @cpp_name@;
- )~~~");
- }
- if (optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- )~~~");
- }
- scoped_generator.append(R"~~~(
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_u32(global_object));
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@UL;
- )~~~");
- }
- } else if (parameter.type->name == "unsigned short") {
- if (!optional || optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- u16 @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<u16> @cpp_name@;
- )~~~");
- }
- if (optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- )~~~");
- }
- scoped_generator.append(R"~~~(
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_u16(global_object));
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@;
- )~~~");
- }
- } else if (parameter.type->name == "long") {
- if (!optional || optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- i32 @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<i32> @cpp_name@;
- )~~~");
- }
- if (optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- )~~~");
- }
- scoped_generator.append(R"~~~(
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_i32(global_object));
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@L;
- )~~~");
- }
- } else if (parameter.type->name == "long long") {
- if (!optional || optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- i64 @cpp_name@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- Optional<i64> @cpp_name@;
- )~~~");
- }
- if (optional) {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined())
- )~~~");
- }
- scoped_generator.append(R"~~~(
- @cpp_name@ = TRY(@js_name@@js_suffix@.to_bigint_int64(global_object));
- )~~~");
- if (optional_default_value.has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = @parameter.optional_default_value@L;
- )~~~");
- }
- } else if (parameter.type->name == "Promise") {
- // NOTE: It's not clear to me where the implicit wrapping of non-Promise values in a resolved
- // Promise is defined in the spec; https://webidl.spec.whatwg.org/#idl-promise doesn't say
- // anything of this sort. Both Gecko and Blink do it, however, so I'm sure it's correct.
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object() || !is<JS::Promise>(@js_name@@js_suffix@.as_object())) {
- auto* new_promise = JS::Promise::create(global_object);
- new_promise->fulfill(@js_name@@js_suffix@);
- @js_name@@js_suffix@ = new_promise;
- }
- auto @cpp_name@ = JS::make_handle(&static_cast<JS::Promise&>(@js_name@@js_suffix@.as_object()));
- )~~~");
- } else if (parameter.type->name == "BufferSource") {
- scoped_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object() || !(is<JS::TypedArrayBase>(@js_name@@js_suffix@.as_object()) || is<JS::ArrayBuffer>(@js_name@@js_suffix@.as_object()) || is<JS::DataView>(@js_name@@js_suffix@.as_object())))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@parameter.type.name@");
- // TODO: Should we make this a Variant?
- auto @cpp_name@ = JS::make_handle(&@js_name@@js_suffix@.as_object());
- )~~~");
- } else if (parameter.type->name == "any") {
- if (!optional) {
- scoped_generator.append(R"~~~(
- auto @cpp_name@ = @js_name@@js_suffix@;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- JS::Value @cpp_name@ = JS::js_undefined();
- if (!@js_name@@js_suffix@.is_undefined())
- @cpp_name@ = @js_name@@js_suffix@;
- )~~~");
- if (optional_default_value.has_value()) {
- if (optional_default_value == "null") {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = JS::js_null();
- )~~~");
- } else if (optional_default_value->to_int().has_value() || optional_default_value->to_uint().has_value()) {
- scoped_generator.append(R"~~~(
- else
- @cpp_name@ = JS::Value(@parameter.optional_default_value@);
- )~~~");
- } else {
- TODO();
- }
- }
- }
- } else if (interface.enumerations.contains(parameter.type->name)) {
- auto enum_generator = scoped_generator.fork();
- auto& enumeration = interface.enumerations.find(parameter.type->name)->value;
- StringView enum_member_name;
- if (optional_default_value.has_value()) {
- VERIFY(optional_default_value->length() >= 2 && (*optional_default_value)[0] == '"' && (*optional_default_value)[optional_default_value->length() - 1] == '"');
- enum_member_name = optional_default_value->substring_view(1, optional_default_value->length() - 2);
- } else {
- enum_member_name = enumeration.first_member;
- }
- auto default_value_cpp_name = enumeration.translated_cpp_names.get(enum_member_name);
- VERIFY(default_value_cpp_name.has_value());
- enum_generator.set("enum.default.cpp_value", *default_value_cpp_name);
- enum_generator.set("js_name.as_string", String::formatted("{}{}_string", enum_generator.get("js_name"sv), enum_generator.get("js_suffix"sv)));
- enum_generator.append(R"~~~(
- @parameter.type.name@ @cpp_name@ { @parameter.type.name@::@enum.default.cpp_value@ };
- )~~~");
- if (optional) {
- enum_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined()) {
- )~~~");
- }
- enum_generator.append(R"~~~(
- auto @js_name.as_string@ = TRY(@js_name@@js_suffix@.to_string(global_object));
- )~~~");
- auto first = true;
- for (auto& it : enumeration.translated_cpp_names) {
- enum_generator.set("enum.alt.name", it.key);
- enum_generator.set("enum.alt.value", it.value);
- enum_generator.set("else", first ? "" : "else ");
- first = false;
- enum_generator.append(R"~~~(
- @else@if (@js_name.as_string@ == "@enum.alt.name@"sv)
- @cpp_name@ = @parameter.type.name@::@enum.alt.value@;
- )~~~");
- }
- // NOTE: Attribute setters return undefined instead of throwing when the string doesn't match an enum value.
- if constexpr (!IsSame<Attribute, RemoveConst<ParameterType>>) {
- enum_generator.append(R"~~~(
- @else@
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::InvalidEnumerationValue, @js_name.as_string@, "@parameter.type.name@");
- )~~~");
- } else {
- enum_generator.append(R"~~~(
- @else@
- return JS::js_undefined();
- )~~~");
- }
- if (optional) {
- enum_generator.append(R"~~~(
- }
- )~~~");
- }
- } else if (interface.dictionaries.contains(parameter.type->name)) {
- if (optional_default_value.has_value() && optional_default_value != "{}")
- TODO();
- auto dictionary_generator = scoped_generator.fork();
- dictionary_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_nullish() && !@js_name@@js_suffix@.is_object())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@parameter.type.name@");
- @parameter.type.name@ @cpp_name@ {};
- )~~~");
- auto* current_dictionary = &interface.dictionaries.find(parameter.type->name)->value;
- while (true) {
- for (auto& member : current_dictionary->members) {
- dictionary_generator.set("member_key", member.name);
- auto member_js_name = make_input_acceptable_cpp(member.name.to_snakecase());
- dictionary_generator.set("member_name", member_js_name);
- dictionary_generator.append(R"~~~(
- JS::Value @member_name@;
- if (@js_name@@js_suffix@.is_nullish()) {
- @member_name@ = JS::js_undefined();
- } else {
- @member_name@ = TRY(@js_name@@js_suffix@.as_object().get("@member_key@"));
- }
- )~~~");
- if (member.required) {
- dictionary_generator.append(R"~~~(
- if (@member_name@.is_undefined())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::MissingRequiredProperty, "@member_key@");
- )~~~");
- }
- auto member_value_name = String::formatted("{}_value", member_js_name);
- dictionary_generator.set("member_value_name", member_value_name);
- generate_to_cpp(dictionary_generator, member, member_js_name, "", member_value_name, interface, member.extended_attributes.contains("LegacyNullToEmptyString"), !member.required, member.default_value);
- dictionary_generator.append(R"~~~(
- @cpp_name@.@member_name@ = @member_value_name@;
- )~~~");
- }
- if (current_dictionary->parent_name.is_null())
- break;
- VERIFY(interface.dictionaries.contains(current_dictionary->parent_name));
- current_dictionary = &interface.dictionaries.find(current_dictionary->parent_name)->value;
- }
- } else if (interface.callback_functions.contains(parameter.type->name)) {
- // https://webidl.spec.whatwg.org/#es-callback-function
- auto callback_function_generator = scoped_generator.fork();
- auto& callback_function = interface.callback_functions.find(parameter.type->name)->value;
- // An ECMAScript value V is converted to an IDL callback function type value by running the following algorithm:
- // 1. If the result of calling IsCallable(V) is false and the conversion to an IDL value is not being performed due to V being assigned to an attribute whose type is a nullable callback function that is annotated with [LegacyTreatNonObjectAsNull], then throw a TypeError.
- if (!callback_function.is_legacy_treat_non_object_as_null) {
- callback_function_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_function())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAFunction, @js_name@@js_suffix@.to_string_without_side_effects());
- )~~~");
- }
- // 2. Return the IDL callback function type value that represents a reference to the same object that V represents, with the incumbent settings object as the callback context.
- if (callback_function.is_legacy_treat_non_object_as_null) {
- callback_function_generator.append(R"~~~(
- Optional<Bindings::CallbackType> @cpp_name@;
- if (@js_name@@js_suffix@.is_object())
- @cpp_name@ = Bindings::CallbackType { JS::make_handle(&@js_name@@js_suffix@.as_object()), HTML::incumbent_settings_object() };
- )~~~");
- } else {
- callback_function_generator.append(R"~~~(
- auto @cpp_name@ = Bindings::CallbackType { JS::make_handle(&@js_name@@js_suffix@.as_object()), HTML::incumbent_settings_object() };
- )~~~");
- }
- } else if (parameter.type->name == "sequence") {
- // https://webidl.spec.whatwg.org/#es-sequence
- auto sequence_generator = scoped_generator.fork();
- auto& parameterized_type = verify_cast<IDL::ParameterizedType>(*parameter.type);
- sequence_generator.set("recursion_depth", String::number(recursion_depth));
- // An ECMAScript value V is converted to an IDL sequence<T> value as follows:
- // 1. If Type(V) is not Object, throw a TypeError.
- // 2. Let method be ? GetMethod(V, @@iterator).
- // 3. If method is undefined, throw a TypeError.
- // 4. Return the result of creating a sequence from V and method.
- if (optional) {
- auto sequence_cpp_type = idl_type_name_to_cpp_type(parameterized_type.parameters.first(), interface);
- sequence_generator.set("sequence.type", sequence_cpp_type.name);
- sequence_generator.set("sequence.storage_type", sequence_storage_type_to_cpp_storage_type_name(sequence_cpp_type.sequence_storage_type));
- if (!optional_default_value.has_value()) {
- if (sequence_cpp_type.sequence_storage_type == IDL::SequenceStorageType::Vector) {
- sequence_generator.append(R"~~~(
- Optional<@sequence.storage_type@<@sequence.type@>> @cpp_name@;
- )~~~");
- } else {
- sequence_generator.append(R"~~~(
- Optional<@sequence.storage_type@> @cpp_name@;
- )~~~");
- }
- } else {
- if (optional_default_value != "[]")
- TODO();
- if (sequence_cpp_type.sequence_storage_type == IDL::SequenceStorageType::Vector) {
- sequence_generator.append(R"~~~(
- @sequence.storage_type@<@sequence.type@> @cpp_name@;
- )~~~");
- } else {
- sequence_generator.append(R"~~~(
- @sequence.storage_type@ @cpp_name@ { global_object.heap() };
- )~~~");
- }
- }
- sequence_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_undefined()) {
- )~~~");
- }
- sequence_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObject, @js_name@@js_suffix@.to_string_without_side_effects());
- auto* iterator_method@recursion_depth@ = TRY(@js_name@@js_suffix@.get_method(global_object, *vm.well_known_symbol_iterator()));
- if (!iterator_method@recursion_depth@)
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotIterable, @js_name@@js_suffix@.to_string_without_side_effects());
- )~~~");
- parameterized_type.generate_sequence_from_iterable(sequence_generator, String::formatted("{}{}", acceptable_cpp_name, optional ? "_non_optional" : ""), String::formatted("{}{}", js_name, js_suffix), String::formatted("iterator_method{}", recursion_depth), interface, recursion_depth + 1);
- if (optional) {
- sequence_generator.append(R"~~~(
- @cpp_name@ = move(@cpp_name@_non_optional);
- }
- )~~~");
- }
- } else if (parameter.type->name == "record") {
- // https://webidl.spec.whatwg.org/#es-record
- auto record_generator = scoped_generator.fork();
- auto& parameterized_type = verify_cast<IDL::ParameterizedType>(*parameter.type);
- record_generator.set("recursion_depth", String::number(recursion_depth));
- // A record can only have two types: key type and value type.
- VERIFY(parameterized_type.parameters.size() == 2);
- // A record only allows the key to be a string.
- VERIFY(parameterized_type.parameters[0].is_string());
- // An ECMAScript value O is converted to an IDL record<K, V> value as follows:
- // 1. If Type(O) is not Object, throw a TypeError.
- // 2. Let result be a new empty instance of record<K, V>.
- // 3. Let keys be ? O.[[OwnPropertyKeys]]().
- // 4. For each key of keys:
- // 1. Let desc be ? O.[[GetOwnProperty]](key).
- // 2. If desc is not undefined and desc.[[Enumerable]] is true:
- // 1. Let typedKey be key converted to an IDL value of type K.
- // 2. Let value be ? Get(O, key).
- // 3. Let typedValue be value converted to an IDL value of type V.
- // 4. Set result[typedKey] to typedValue.
- // 5. Return result.
- auto record_cpp_type = IDL::idl_type_name_to_cpp_type(parameterized_type, interface);
- record_generator.set("record.type", record_cpp_type.name);
- // If this is a recursive call to generate_to_cpp, assume that the caller has already handled converting the JS value to an object for us.
- // This affects record types in unions for example.
- if (recursion_depth == 0) {
- record_generator.append(R"~~~(
- if (!@js_name@@js_suffix@.is_object())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObject, @js_name@@js_suffix@.to_string_without_side_effects());
- auto& @js_name@@js_suffix@_object = @js_name@@js_suffix@.as_object();
- )~~~");
- }
- record_generator.append(R"~~~(
- @record.type@ @cpp_name@;
- auto record_keys@recursion_depth@ = TRY(@js_name@@js_suffix@_object.internal_own_property_keys());
- for (auto& key@recursion_depth@ : record_keys@recursion_depth@) {
- auto property_key@recursion_depth@ = MUST(JS::PropertyKey::from_value(global_object, key@recursion_depth@));
- auto descriptor@recursion_depth@ = TRY(@js_name@@js_suffix@_object.internal_get_own_property(property_key@recursion_depth@));
- if (!descriptor@recursion_depth@.has_value() || !descriptor@recursion_depth@->enumerable.has_value() || !descriptor@recursion_depth@->enumerable.value())
- continue;
- )~~~");
- IDL::Parameter key_parameter { .type = parameterized_type.parameters[0], .name = acceptable_cpp_name, .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(record_generator, key_parameter, "key", String::number(recursion_depth), String::formatted("typed_key{}", recursion_depth), interface, false, false, {}, false, recursion_depth + 1);
- record_generator.append(R"~~~(
- auto value@recursion_depth@ = TRY(@js_name@@js_suffix@_object.get(property_key@recursion_depth@));
- )~~~");
- // FIXME: Record value types should be TypeWithExtendedAttributes, which would allow us to get [LegacyNullToEmptyString] here.
- IDL::Parameter value_parameter { .type = parameterized_type.parameters[1], .name = acceptable_cpp_name, .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(record_generator, value_parameter, "value", String::number(recursion_depth), String::formatted("typed_value{}", recursion_depth), interface, false, false, {}, false, recursion_depth + 1);
- record_generator.append(R"~~~(
- @cpp_name@.set(typed_key@recursion_depth@, typed_value@recursion_depth@);
- }
- )~~~");
- } else if (is<IDL::UnionType>(*parameter.type)) {
- // https://webidl.spec.whatwg.org/#es-union
- auto union_generator = scoped_generator.fork();
- auto& union_type = verify_cast<IDL::UnionType>(*parameter.type);
- union_generator.set("union_type", union_type.to_variant(interface));
- union_generator.set("recursion_depth", String::number(recursion_depth));
- // NOTE: This is handled out here as we need the dictionary conversion code for the {} optional default value.
- // 3. Let types be the flattened member types of the union type.
- auto types = union_type.flattened_member_types();
- RefPtr<Type> dictionary_type;
- for (auto& dictionary : interface.dictionaries) {
- for (auto& type : types) {
- if (type.name == dictionary.key) {
- dictionary_type = type;
- break;
- }
- }
- if (dictionary_type)
- break;
- }
- if (dictionary_type) {
- auto dictionary_generator = union_generator.fork();
- dictionary_generator.set("dictionary.type", dictionary_type->name);
- // The lambda must take the JS::Value to convert as a parameter instead of capturing it in order to support union types being variadic.
- dictionary_generator.append(R"~~~(
- auto @js_name@@js_suffix@_to_dictionary = [&global_object, &vm](JS::Value @js_name@@js_suffix@) -> JS::ThrowCompletionOr<@dictionary.type@> {
- )~~~");
- IDL::Parameter dictionary_parameter { .type = *dictionary_type, .name = acceptable_cpp_name, .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(dictionary_generator, dictionary_parameter, js_name, js_suffix, "dictionary_union_type"sv, interface, false, false, {}, false, recursion_depth + 1);
- dictionary_generator.append(R"~~~(
- return dictionary_union_type;
- };
- )~~~");
- }
- // A lambda is used because Variants without "Empty" can't easily be default initialized.
- // Plus, this would require the user of union types to always accept a Variant with an Empty type.
- // Additionally, it handles the case of unconditionally throwing a TypeError at the end if none of the types match.
- // This is because we cannot unconditionally throw in generate_to_cpp as generate_to_cpp is supposed to assign to a variable and then continue.
- // Note that all the other types only throw on a condition.
- // The lambda must take the JS::Value to convert as a parameter instead of capturing it in order to support union types being variadic.
- StringBuilder to_variant_captures;
- to_variant_captures.append("&global_object, &vm"sv);
- if (dictionary_type)
- to_variant_captures.append(String::formatted(", &{}{}_to_dictionary", js_name, js_suffix));
- union_generator.set("to_variant_captures", to_variant_captures.to_string());
- union_generator.append(R"~~~(
- auto @js_name@@js_suffix@_to_variant = [@to_variant_captures@](JS::Value @js_name@@js_suffix@) -> JS::ThrowCompletionOr<@union_type@> {
- // These might be unused.
- (void)global_object;
- (void)vm;
- )~~~");
- // 1. If the union type includes undefined and V is undefined, then return the unique undefined value.
- if (union_type.includes_undefined()) {
- scoped_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_undefined())
- return Empty {};
- )~~~");
- }
- // FIXME: 2. If the union type includes a nullable type and V is null or undefined, then return the IDL value null.
- if (union_type.includes_nullable_type()) {
- TODO();
- } else if (dictionary_type) {
- // 4. If V is null or undefined, then
- // 4.1 If types includes a dictionary type, then return the result of converting V to that dictionary type.
- union_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_nullish())
- return @union_type@ { TRY(@js_name@@js_suffix@_to_dictionary(@js_name@@js_suffix@)) };
- )~~~");
- }
- bool includes_object = false;
- for (auto& type : types) {
- if (type.name == "object") {
- includes_object = true;
- break;
- }
- }
- // FIXME: Don't generate this if the union type doesn't include any object types.
- union_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_object()) {
- [[maybe_unused]] auto& @js_name@@js_suffix@_object = @js_name@@js_suffix@.as_object();
- )~~~");
- bool includes_wrappable_type = false;
- for (auto& type : types) {
- if (IDL::is_wrappable_type(type)) {
- includes_wrappable_type = true;
- break;
- }
- }
- if (includes_wrappable_type) {
- // 5. If V is a platform object, then:
- union_generator.append(R"~~~(
- if (is<Wrapper>(@js_name@@js_suffix@_object)) {
- )~~~");
- // 1. If types includes an interface type that V implements, then return the IDL value that is a reference to the object V.
- for (auto& type : types) {
- if (!IDL::is_wrappable_type(type))
- continue;
- auto union_platform_object_type_generator = union_generator.fork();
- union_platform_object_type_generator.set("platform_object_type", String::formatted("{}Wrapper", type.name));
- auto cpp_type = IDL::idl_type_name_to_cpp_type(type, interface);
- union_platform_object_type_generator.set("refptr_type", cpp_type.name);
- union_platform_object_type_generator.append(R"~~~(
- if (is<@platform_object_type@>(@js_name@@js_suffix@_object))
- return @refptr_type@ { static_cast<@platform_object_type@&>(@js_name@@js_suffix@_object).impl() };
- )~~~");
- }
- // 2. If types includes object, then return the IDL value that is a reference to the object V.
- if (includes_object) {
- union_generator.append(R"~~~(
- return @js_name@@js_suffix@_object;
- )~~~");
- }
- union_generator.append(R"~~~(
- }
- )~~~");
- }
- // 6. If Type(V) is Object and V has an [[ArrayBufferData]] internal slot, then
- // 1. If types includes ArrayBuffer, then return the result of converting V to ArrayBuffer.
- for (auto& type : types) {
- if (type.name == "BufferSource") {
- union_generator.append(R"~~~(
- if (is<JS::ArrayBuffer>(@js_name@@js_suffix@_object))
- return JS::make_handle(@js_name@@js_suffix@_object);
- )~~~");
- }
- }
- // 2. If types includes object, then return the IDL value that is a reference to the object V.
- if (includes_object) {
- union_generator.append(R"~~~(
- return @js_name@@js_suffix@_object;
- )~~~");
- }
- // FIXME: 7. If Type(V) is Object and V has a [[DataView]] internal slot, then:
- // 1. If types includes DataView, then return the result of converting V to DataView.
- // 2. If types includes object, then return the IDL value that is a reference to the object V.
- // FIXME: 8. If Type(V) is Object and V has a [[TypedArrayName]] internal slot, then:
- // 1. If types includes a typed array type whose name is the value of V’s [[TypedArrayName]] internal slot, then return the result of converting V to that type.
- // 2. If types includes object, then return the IDL value that is a reference to the object V.
- // FIXME: 9. If IsCallable(V) is true, then:
- // 1. If types includes a callback function type, then return the result of converting V to that callback function type.
- // 2. If types includes object, then return the IDL value that is a reference to the object V.
- // 10. If Type(V) is Object, then:
- // 1. If types includes a sequence type, then:
- RefPtr<IDL::ParameterizedType> sequence_type;
- for (auto& type : types) {
- if (type.name == "sequence") {
- sequence_type = verify_cast<IDL::ParameterizedType>(type);
- break;
- }
- }
- if (sequence_type) {
- // 1. Let method be ? GetMethod(V, @@iterator).
- union_generator.append(R"~~~(
- auto* method = TRY(@js_name@@js_suffix@.get_method(global_object, *vm.well_known_symbol_iterator()));
- )~~~");
- // 2. If method is not undefined, return the result of creating a sequence of that type from V and method.
- union_generator.append(R"~~~(
- if (method) {
- )~~~");
- sequence_type->generate_sequence_from_iterable(union_generator, acceptable_cpp_name, String::formatted("{}{}", js_name, js_suffix), "method", interface, recursion_depth + 1);
- union_generator.append(R"~~~(
- return @cpp_name@;
- }
- )~~~");
- }
- // FIXME: 2. If types includes a frozen array type, then
- // 1. Let method be ? GetMethod(V, @@iterator).
- // 2. If method is not undefined, return the result of creating a frozen array of that type from V and method.
- // 3. If types includes a dictionary type, then return the result of converting V to that dictionary type.
- if (dictionary_type) {
- union_generator.append(R"~~~(
- return @union_type@ { TRY(@js_name@@js_suffix@_to_dictionary(@js_name@@js_suffix@)) };
- )~~~");
- }
- // 4. If types includes a record type, then return the result of converting V to that record type.
- RefPtr<IDL::ParameterizedType> record_type;
- for (auto& type : types) {
- if (type.name == "record") {
- record_type = verify_cast<IDL::ParameterizedType>(type);
- break;
- }
- }
- if (record_type) {
- IDL::Parameter record_parameter { .type = *record_type, .name = acceptable_cpp_name, .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(union_generator, record_parameter, js_name, js_suffix, "record_union_type"sv, interface, false, false, {}, false, recursion_depth + 1);
- union_generator.append(R"~~~(
- return record_union_type;
- )~~~");
- }
- // FIXME: 5. If types includes a callback interface type, then return the result of converting V to that callback interface type.
- // 6. If types includes object, then return the IDL value that is a reference to the object V.
- if (includes_object) {
- union_generator.append(R"~~~(
- return @js_name@@js_suffix@_object;
- )~~~");
- }
- // End of is_object.
- union_generator.append(R"~~~(
- }
- )~~~");
- // 11. If Type(V) is Boolean, then:
- // 1. If types includes boolean, then return the result of converting V to boolean.
- bool includes_boolean = false;
- for (auto& type : types) {
- if (type.name == "boolean") {
- includes_boolean = true;
- break;
- }
- }
- if (includes_boolean) {
- union_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_boolean())
- return @union_type@ { @js_name@@js_suffix@.as_bool() };
- )~~~");
- }
- RefPtr<IDL::Type> numeric_type;
- for (auto& type : types) {
- if (type.is_numeric()) {
- numeric_type = type;
- break;
- }
- }
- // 12. If Type(V) is Number, then:
- // 1. If types includes a numeric type, then return the result of converting V to that numeric type.
- if (numeric_type) {
- union_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_number()) {
- )~~~");
- // NOTE: generate_to_cpp doesn't use the parameter name.
- // NOTE: generate_to_cpp will use to_{u32,etc.} which uses to_number internally and will thus use TRY, but it cannot throw as we know we are dealing with a number.
- IDL::Parameter parameter { .type = *numeric_type, .name = String::empty(), .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(union_generator, parameter, js_name, js_suffix, String::formatted("{}{}_number", js_name, js_suffix), interface, false, false, {}, false, recursion_depth + 1);
- union_generator.append(R"~~~(
- return @js_name@@js_suffix@_number;
- }
- )~~~");
- }
- // 13. If Type(V) is BigInt, then:
- // 1. If types includes bigint, then return the result of converting V to bigint
- bool includes_bigint = false;
- for (auto& type : types) {
- if (type.name == "bigint") {
- includes_bigint = true;
- break;
- }
- }
- if (includes_bigint) {
- union_generator.append(R"~~~(
- if (@js_name@@js_suffix@.is_bigint())
- return @js_name@@js_suffix@.as_bigint();
- )~~~");
- }
- bool includes_string = false;
- for (auto& type : types) {
- if (type.is_string()) {
- includes_string = true;
- break;
- }
- }
- if (includes_string) {
- // 14. If types includes a string type, then return the result of converting V to that type.
- // NOTE: Currently all string types are converted to String.
- union_generator.append(R"~~~(
- return TRY(@js_name@@js_suffix@.to_string(global_object));
- )~~~");
- } else if (numeric_type && includes_bigint) {
- // 15. If types includes a numeric type and bigint, then return the result of converting V to either that numeric type or bigint.
- // https://webidl.spec.whatwg.org/#converted-to-a-numeric-type-or-bigint
- // NOTE: This algorithm is only used here.
- // An ECMAScript value V is converted to an IDL numeric type T or bigint value by running the following algorithm:
- // 1. Let x be ? ToNumeric(V).
- // 2. If Type(x) is BigInt, then
- // 1. Return the IDL bigint value that represents the same numeric value as x.
- // 3. Assert: Type(x) is Number.
- // 4. Return the result of converting x to T.
- auto union_numeric_type_generator = union_generator.fork();
- auto cpp_type = IDL::idl_type_name_to_cpp_type(*numeric_type, interface);
- union_numeric_type_generator.set("numeric_type", cpp_type.name);
- union_numeric_type_generator.append(R"~~~(
- auto x = TRY(@js_name@@js_suffix@.to_numeric(global_object));
- if (x.is_bigint())
- return x.as_bigint();
- VERIFY(x.is_number());
- )~~~");
- // NOTE: generate_to_cpp doesn't use the parameter name.
- // NOTE: generate_to_cpp will use to_{u32,etc.} which uses to_number internally and will thus use TRY, but it cannot throw as we know we are dealing with a number.
- IDL::Parameter parameter { .type = *numeric_type, .name = String::empty(), .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(union_numeric_type_generator, parameter, "x", String::empty(), "x_number", interface, false, false, {}, false, recursion_depth + 1);
- union_numeric_type_generator.append(R"~~~(
- return x_number;
- )~~~");
- } else if (numeric_type) {
- // 16. If types includes a numeric type, then return the result of converting V to that numeric type.
- // NOTE: generate_to_cpp doesn't use the parameter name.
- // NOTE: generate_to_cpp will use to_{u32,etc.} which uses to_number internally and will thus use TRY, but it cannot throw as we know we are dealing with a number.
- IDL::Parameter parameter { .type = *numeric_type, .name = String::empty(), .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(union_generator, parameter, js_name, js_suffix, String::formatted("{}{}_number", js_name, js_suffix), interface, false, false, {}, false, recursion_depth + 1);
- union_generator.append(R"~~~(
- return @js_name@@js_suffix@_number;
- )~~~");
- } else if (includes_boolean) {
- // 17. If types includes boolean, then return the result of converting V to boolean.
- union_generator.append(R"~~~(
- return @union_type@ { @js_name@@js_suffix@.to_boolean() };
- )~~~");
- } else if (includes_bigint) {
- // 18. If types includes bigint, then return the result of converting V to bigint.
- union_generator.append(R"~~~(
- return TRY(@js_name@@js_suffix@.to_bigint(global_object));
- )~~~");
- } else {
- // 19. Throw a TypeError.
- // FIXME: Replace the error message with something more descriptive.
- union_generator.append(R"~~~(
- return vm.throw_completion<JS::TypeError>(global_object, "No union types matched");
- )~~~");
- }
- // Close the lambda and then perform the conversion.
- union_generator.append(R"~~~(
- };
- )~~~");
- if (!variadic) {
- if (!optional) {
- union_generator.append(R"~~~(
- @union_type@ @cpp_name@ = TRY(@js_name@@js_suffix@_to_variant(@js_name@@js_suffix@));
- )~~~");
- } else {
- if (!optional_default_value.has_value() || optional_default_value == "null"sv) {
- union_generator.append(R"~~~(
- Optional<@union_type@> @cpp_name@;
- if (!@js_name@@js_suffix@.is_undefined())
- @cpp_name@ = TRY(@js_name@@js_suffix@_to_variant(@js_name@@js_suffix@));
- )~~~");
- } else {
- if (optional_default_value == "\"\"") {
- union_generator.append(R"~~~(
- @union_type@ @cpp_name@ = @js_name@@js_suffix@.is_undefined() ? String::empty() : TRY(@js_name@@js_suffix@_to_variant(@js_name@@js_suffix@));
- )~~~");
- } else if (optional_default_value == "{}") {
- VERIFY(dictionary_type);
- union_generator.append(R"~~~(
- @union_type@ @cpp_name@ = @js_name@@js_suffix@.is_undefined() ? TRY(@js_name@@js_suffix@_to_dictionary(@js_name@@js_suffix@)) : TRY(@js_name@@js_suffix@_to_variant(@js_name@@js_suffix@));
- )~~~");
- } else if (optional_default_value->to_int().has_value() || optional_default_value->to_uint().has_value()) {
- union_generator.append(R"~~~(
- @union_type@ @cpp_name@ = @js_name@@js_suffix@.is_undefined() ? @parameter.optional_default_value@ : TRY(@js_name@@js_suffix@_to_variant(@js_name@@js_suffix@));
- )~~~");
- } else {
- TODO();
- }
- }
- }
- } else {
- union_generator.append(R"~~~(
- Vector<@union_type@> @cpp_name@;
- @cpp_name@.ensure_capacity(vm.argument_count() - @js_suffix@);
- for (size_t i = @js_suffix@; i < vm.argument_count(); ++i) {
- auto result = TRY(@js_name@@js_suffix@_to_variant(vm.argument(i)));
- @cpp_name@.append(move(result));
- }
- )~~~");
- }
- } else {
- dbgln("Unimplemented JS-to-C++ conversion: {}", parameter.type->name);
- VERIFY_NOT_REACHED();
- }
- }
- static void generate_argument_count_check(SourceGenerator& generator, String const& function_name, size_t argument_count)
- {
- if (argument_count == 0)
- return;
- auto argument_count_check_generator = generator.fork();
- argument_count_check_generator.set("function.name", function_name);
- argument_count_check_generator.set("function.nargs", String::number(argument_count));
- if (argument_count == 1) {
- argument_count_check_generator.set(".bad_arg_count", "JS::ErrorType::BadArgCountOne");
- argument_count_check_generator.set(".arg_count_suffix", "");
- } else {
- argument_count_check_generator.set(".bad_arg_count", "JS::ErrorType::BadArgCountMany");
- argument_count_check_generator.set(".arg_count_suffix", String::formatted(", \"{}\"", argument_count));
- }
- argument_count_check_generator.append(R"~~~(
- if (vm.argument_count() < @function.nargs@)
- return vm.throw_completion<JS::TypeError>(global_object, @.bad_arg_count@, "@function.name@"@.arg_count_suffix@);
- )~~~");
- }
- static void generate_arguments(SourceGenerator& generator, Vector<IDL::Parameter> const& parameters, StringBuilder& arguments_builder, IDL::Interface const& interface)
- {
- auto arguments_generator = generator.fork();
- Vector<String> parameter_names;
- size_t argument_index = 0;
- for (auto& parameter : parameters) {
- parameter_names.append(make_input_acceptable_cpp(parameter.name.to_snakecase()));
- if (!parameter.variadic) {
- arguments_generator.set("argument.index", String::number(argument_index));
- arguments_generator.append(R"~~~(
- auto arg@argument.index@ = vm.argument(@argument.index@);
- )~~~");
- }
- bool legacy_null_to_empty_string = parameter.extended_attributes.contains("LegacyNullToEmptyString");
- generate_to_cpp(generator, parameter, "arg", String::number(argument_index), parameter.name.to_snakecase(), interface, legacy_null_to_empty_string, parameter.optional, parameter.optional_default_value, parameter.variadic, 0);
- ++argument_index;
- }
- arguments_builder.join(", "sv, parameter_names);
- }
- // https://webidl.spec.whatwg.org/#create-sequence-from-iterable
- void IDL::ParameterizedType::generate_sequence_from_iterable(SourceGenerator& generator, String const& cpp_name, String const& iterable_cpp_name, String const& iterator_method_cpp_name, IDL::Interface const& interface, size_t recursion_depth) const
- {
- auto sequence_generator = generator.fork();
- sequence_generator.set("cpp_name", cpp_name);
- sequence_generator.set("iterable_cpp_name", iterable_cpp_name);
- sequence_generator.set("iterator_method_cpp_name", iterator_method_cpp_name);
- sequence_generator.set("recursion_depth", String::number(recursion_depth));
- auto sequence_cpp_type = idl_type_name_to_cpp_type(parameters.first(), interface);
- sequence_generator.set("sequence.type", sequence_cpp_type.name);
- sequence_generator.set("sequence.storage_type", sequence_storage_type_to_cpp_storage_type_name(sequence_cpp_type.sequence_storage_type));
- // To create an IDL value of type sequence<T> given an iterable iterable and an iterator getter method, perform the following steps:
- // 1. Let iter be ? GetIterator(iterable, sync, method).
- // 2. Initialize i to be 0.
- // 3. Repeat
- // 1. Let next be ? IteratorStep(iter).
- // 2. If next is false, then return an IDL sequence value of type sequence<T> of length i, where the value of the element at index j is Sj.
- // 3. Let nextItem be ? IteratorValue(next).
- // 4. Initialize Si to the result of converting nextItem to an IDL value of type T.
- // 5. Set i to i + 1.
- sequence_generator.append(R"~~~(
- auto iterator@recursion_depth@ = TRY(JS::get_iterator(global_object, @iterable_cpp_name@, JS::IteratorHint::Sync, @iterator_method_cpp_name@));
- )~~~");
- if (sequence_cpp_type.sequence_storage_type == SequenceStorageType::Vector) {
- sequence_generator.append(R"~~~(
- @sequence.storage_type@<@sequence.type@> @cpp_name@;
- )~~~");
- } else {
- sequence_generator.append(R"~~~(
- @sequence.storage_type@ @cpp_name@ { global_object.heap() };
- )~~~");
- }
- sequence_generator.append(R"~~~(
- for (;;) {
- auto* next@recursion_depth@ = TRY(JS::iterator_step(global_object, iterator@recursion_depth@));
- if (!next@recursion_depth@)
- break;
- auto next_item@recursion_depth@ = TRY(JS::iterator_value(global_object, *next@recursion_depth@));
- )~~~");
- // FIXME: Sequences types should be TypeWithExtendedAttributes, which would allow us to get [LegacyNullToEmptyString] here.
- IDL::Parameter parameter { .type = parameters.first(), .name = iterable_cpp_name, .optional_default_value = {}, .extended_attributes = {} };
- generate_to_cpp(sequence_generator, parameter, "next_item", String::number(recursion_depth), String::formatted("sequence_item{}", recursion_depth), interface, false, false, {}, false, recursion_depth);
- sequence_generator.append(R"~~~(
- @cpp_name@.append(sequence_item@recursion_depth@);
- }
- )~~~");
- }
- enum class WrappingReference {
- No,
- Yes,
- };
- static void generate_wrap_statement(SourceGenerator& generator, String const& value, IDL::Type const& type, IDL::Interface const& interface, StringView result_expression, WrappingReference wrapping_reference = WrappingReference::No, size_t recursion_depth = 0)
- {
- auto scoped_generator = generator.fork();
- scoped_generator.set("value", value);
- scoped_generator.set("type", type.name);
- scoped_generator.set("result_expression", result_expression);
- scoped_generator.set("recursion_depth", String::number(recursion_depth));
- if (type.name == "undefined") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::js_undefined();
- )~~~");
- return;
- }
- if (type.nullable && !is<UnionType>(type)) {
- if (type.is_string()) {
- scoped_generator.append(R"~~~(
- if (@value@.is_null()) {
- @result_expression@ JS::js_null();
- } else {
- )~~~");
- } else if (type.name == "sequence") {
- scoped_generator.append(R"~~~(
- if (!@value@.has_value()) {
- @result_expression@ JS::js_null();
- } else {
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- if (!@value@) {
- @result_expression@ JS::js_null();
- } else {
- )~~~");
- }
- }
- if (type.is_string()) {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::js_string(vm, @value@);
- )~~~");
- } else if (type.name == "sequence") {
- // https://webidl.spec.whatwg.org/#es-sequence
- auto& sequence_generic_type = verify_cast<IDL::ParameterizedType>(type);
- scoped_generator.append(R"~~~(
- auto* new_array@recursion_depth@ = MUST(JS::Array::create(global_object, 0));
- )~~~");
- if (!type.nullable) {
- scoped_generator.append(R"~~~(
- for (size_t i@recursion_depth@ = 0; i@recursion_depth@ < @value@.size(); ++i@recursion_depth@) {
- auto& element@recursion_depth@ = @value@.at(i@recursion_depth@);
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- auto& @value@_non_optional = @value@.value();
- for (size_t i@recursion_depth@ = 0; i@recursion_depth@ < @value@_non_optional.size(); ++i@recursion_depth@) {
- auto& element@recursion_depth@ = @value@_non_optional.at(i@recursion_depth@);
- )~~~");
- }
- generate_wrap_statement(scoped_generator, String::formatted("element{}", recursion_depth), sequence_generic_type.parameters.first(), interface, String::formatted("auto wrapped_element{} =", recursion_depth), WrappingReference::Yes, recursion_depth + 1);
- scoped_generator.append(R"~~~(
- auto property_index@recursion_depth@ = JS::PropertyKey { i@recursion_depth@ };
- MUST(new_array@recursion_depth@->create_data_property(property_index@recursion_depth@, wrapped_element@recursion_depth@));
- }
- @result_expression@ new_array@recursion_depth@;
- )~~~");
- } else if (type.name == "boolean" || type.name == "double" || type.name == "float") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value(@value@);
- )~~~");
- } else if (type.name == "short" || type.name == "long" || type.name == "unsigned short") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value((i32)@value@);
- )~~~");
- } else if (type.name == "unsigned long") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value((u32)@value@);
- )~~~");
- } else if (type.name == "long long") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value((double)@value@);
- )~~~");
- } else if (type.name == "unsigned long long") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value((double)@value@);
- )~~~");
- } else if (type.name == "Location" || type.name == "Promise" || type.name == "Uint8Array" || type.name == "Uint8ClampedArray" || type.name == "any") {
- scoped_generator.append(R"~~~(
- @result_expression@ @value@;
- )~~~");
- } else if (is<IDL::UnionType>(type)) {
- auto& union_type = verify_cast<IDL::UnionType>(type);
- auto union_types = union_type.flattened_member_types();
- auto union_generator = scoped_generator.fork();
- union_generator.append(R"~~~(
- @result_expression@ @value@.visit(
- )~~~");
- for (size_t current_union_type_index = 0; current_union_type_index < union_types.size(); ++current_union_type_index) {
- auto& current_union_type = union_types.at(current_union_type_index);
- auto cpp_type = IDL::idl_type_name_to_cpp_type(current_union_type, interface);
- union_generator.set("current_type", cpp_type.name);
- union_generator.append(R"~~~(
- [&vm, &global_object](@current_type@ const& visited_union_value@recursion_depth@) -> JS::Value {
- // These may be unused.
- (void)vm;
- (void)global_object;
- )~~~");
- // NOTE: While we are using const&, the underlying type for wrappable types in unions is (Nonnull)RefPtr, which are not references.
- generate_wrap_statement(union_generator, String::formatted("visited_union_value{}", recursion_depth), current_union_type, interface, "return"sv, WrappingReference::No, recursion_depth + 1);
- // End of current visit lambda.
- // The last lambda cannot have a trailing comma on the closing brace, unless the type is nullable, where an extra lambda will be generated for the Empty case.
- if (current_union_type_index != union_types.size() - 1 || type.nullable) {
- union_generator.append(R"~~~(
- },
- )~~~");
- } else {
- union_generator.append(R"~~~(
- }
- )~~~");
- }
- }
- if (type.nullable) {
- union_generator.append(R"~~~(
- [](Empty) -> JS::Value {
- return JS::js_null();
- }
- )~~~");
- }
- // End of visit.
- union_generator.append(R"~~~(
- );
- )~~~");
- } else if (interface.enumerations.contains(type.name)) {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::js_string(global_object.heap(), Bindings::idl_enum_to_string(@value@));
- )~~~");
- } else if (interface.callback_functions.contains(type.name)) {
- // https://webidl.spec.whatwg.org/#es-callback-function
- auto& callback_function = interface.callback_functions.find(type.name)->value;
- // The result of converting an IDL callback function type value to an ECMAScript value is a reference to the same object that the IDL callback function type value represents.
- if (callback_function.is_legacy_treat_non_object_as_null && !type.nullable) {
- scoped_generator.append(R"~~~(
- if (!@value@) {
- @result_expression@ JS::js_null();
- } else {
- VERIFY(!@value@->callback.is_null());
- @result_expression@ @value@->callback.cell();
- }
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- VERIFY(!@value@->callback.is_null());
- @result_expression@ @value@->callback.cell();
- )~~~");
- }
- } else if (interface.dictionaries.contains(type.name)) {
- // https://webidl.spec.whatwg.org/#es-dictionary
- auto dictionary_generator = scoped_generator.fork();
- dictionary_generator.append(R"~~~(
- auto* dictionary_object@recursion_depth@ = JS::Object::create(global_object, global_object.object_prototype());
- )~~~");
- auto* current_dictionary = &interface.dictionaries.find(type.name)->value;
- while (true) {
- for (auto& member : current_dictionary->members) {
- dictionary_generator.set("member_key", member.name);
- auto member_key_js_name = String::formatted("{}{}", make_input_acceptable_cpp(member.name.to_snakecase()), recursion_depth);
- dictionary_generator.set("member_name", member_key_js_name);
- auto member_value_js_name = String::formatted("{}_value", member_key_js_name);
- dictionary_generator.set("member_value", member_value_js_name);
- auto wrapped_value_name = String::formatted("auto wrapped_{}", member_value_js_name);
- dictionary_generator.set("wrapped_value_name", wrapped_value_name);
- generate_wrap_statement(dictionary_generator, String::formatted("{}.{}", value, member.name), member.type, interface, wrapped_value_name, WrappingReference::No, recursion_depth + 1);
- dictionary_generator.append(R"~~~(
- MUST(dictionary_object@recursion_depth@->create_data_property("@member_key@", @wrapped_value_name@));
- )~~~");
- }
- if (current_dictionary->parent_name.is_null())
- break;
- VERIFY(interface.dictionaries.contains(current_dictionary->parent_name));
- current_dictionary = &interface.dictionaries.find(current_dictionary->parent_name)->value;
- }
- dictionary_generator.append(R"~~~(
- @result_expression@ dictionary_object@recursion_depth@;
- )~~~");
- } else if (type.name == "object") {
- scoped_generator.append(R"~~~(
- @result_expression@ JS::Value(const_cast<JS::Object*>(@value@));
- )~~~");
- } else {
- if (wrapping_reference == WrappingReference::No) {
- scoped_generator.append(R"~~~(
- @result_expression@ wrap(global_object, const_cast<@type@&>(*@value@));
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- @result_expression@ wrap(global_object, const_cast<@type@&>(@value@));
- )~~~");
- }
- }
- if (type.nullable && !is<UnionType>(type)) {
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- }
- enum class StaticFunction {
- No,
- Yes,
- };
- static void generate_return_statement(SourceGenerator& generator, IDL::Type const& return_type, IDL::Interface const& interface)
- {
- return generate_wrap_statement(generator, "retval", return_type, interface, "return"sv);
- }
- static void generate_variable_statement(SourceGenerator& generator, String const& variable_name, IDL::Type const& value_type, String const& value_name, IDL::Interface const& interface)
- {
- auto variable_generator = generator.fork();
- variable_generator.set("variable_name", variable_name);
- variable_generator.append(R"~~~(
- JS::Value @variable_name@;
- )~~~");
- return generate_wrap_statement(generator, value_name, value_type, interface, String::formatted("{} = ", variable_name));
- }
- static void generate_function(SourceGenerator& generator, IDL::Function const& function, StaticFunction is_static_function, String const& class_name, String const& interface_fully_qualified_name, IDL::Interface const& interface)
- {
- auto function_generator = generator.fork();
- function_generator.set("class_name", class_name);
- function_generator.set("interface_fully_qualified_name", interface_fully_qualified_name);
- function_generator.set("function.name", function.name);
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(function.name.to_snakecase()));
- function_generator.set("overload_suffix", function.is_overloaded ? String::number(function.overload_index) : String::empty());
- if (function.extended_attributes.contains("ImplementedAs")) {
- auto implemented_as = function.extended_attributes.get("ImplementedAs").value();
- function_generator.set("function.cpp_name", implemented_as);
- } else {
- function_generator.set("function.cpp_name", make_input_acceptable_cpp(function.name.to_snakecase()));
- }
- function_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@class_name@::@function.name:snakecase@@overload_suffix@)
- {
- )~~~");
- if (is_static_function == StaticFunction::No) {
- function_generator.append(R"~~~(
- auto* impl = TRY(impl_from(vm, global_object));
- )~~~");
- }
- // Optimization: overloaded functions' arguments count is checked by the overload arbiter
- if (!function.is_overloaded)
- generate_argument_count_check(generator, function.name, function.length());
- StringBuilder arguments_builder;
- generate_arguments(generator, function.parameters, arguments_builder, interface);
- function_generator.set(".arguments", arguments_builder.string_view());
- if (is_static_function == StaticFunction::No) {
- function_generator.append(R"~~~(
- [[maybe_unused]] auto retval = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl->@function.cpp_name@(@.arguments@); }));
- )~~~");
- } else {
- function_generator.append(R"~~~(
- [[maybe_unused]] auto retval = TRY(throw_dom_exception_if_needed(global_object, [&] { return @interface_fully_qualified_name@::@function.cpp_name@(@.arguments@); }));
- )~~~");
- }
- generate_return_statement(generator, *function.return_type, interface);
- function_generator.append(R"~~~(
- }
- )~~~");
- }
- // FIXME: This is extremely ad-hoc, implement the WebIDL overload resolution algorithm instead
- static Optional<String> generate_arguments_match_check_for_count(Vector<IDL::Parameter> const& parameters, size_t argument_count)
- {
- Vector<String> conditions;
- for (auto i = 0u; i < argument_count; ++i) {
- auto const& parameter = parameters[i];
- if (parameter.type->is_string() || parameter.type->is_primitive())
- continue;
- auto argument = String::formatted("arg{}", i);
- StringBuilder condition;
- condition.append('(');
- if (parameter.type->nullable)
- condition.appendff("{}.is_nullish() || ", argument);
- else if (parameter.optional)
- condition.appendff("{}.is_undefined() || ", argument);
- condition.appendff("{}.is_object()", argument);
- condition.append(')');
- conditions.append(condition.build());
- }
- if (conditions.is_empty())
- return {};
- return String::formatted("({})", String::join(" && "sv, conditions));
- }
- static String generate_arguments_match_check(Function const& function)
- {
- Vector<String> options;
- for (size_t i = 0; i < function.parameters.size(); ++i) {
- if (!function.parameters[i].optional && !function.parameters[i].variadic)
- continue;
- auto match_check = generate_arguments_match_check_for_count(function.parameters, i);
- if (match_check.has_value())
- options.append(match_check.release_value());
- }
- if (!function.parameters.is_empty() && !function.parameters.last().variadic) {
- auto match_check = generate_arguments_match_check_for_count(function.parameters, function.parameters.size());
- if (match_check.has_value())
- options.append(match_check.release_value());
- }
- return String::join(" || "sv, options);
- }
- static void generate_overload_arbiter(SourceGenerator& generator, auto const& overload_set, String const& class_name)
- {
- auto function_generator = generator.fork();
- function_generator.set("class_name", class_name);
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(overload_set.key.to_snakecase()));
- function_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@class_name@::@function.name:snakecase@)
- {
- )~~~");
- auto minimum_argument_count = get_shortest_function_length(overload_set.value);
- generate_argument_count_check(function_generator, overload_set.key, minimum_argument_count);
- auto overloaded_functions = overload_set.value;
- quick_sort(overloaded_functions, [](auto const& a, auto const& b) { return a.length() < b.length(); });
- auto fetched_arguments = 0u;
- for (auto i = 0u; i < overloaded_functions.size(); ++i) {
- auto const& overloaded_function = overloaded_functions[i];
- auto argument_count = overloaded_function.parameters.size();
- function_generator.set("argument_count", String::number(argument_count));
- auto arguments_match_check = generate_arguments_match_check(overloaded_function);
- function_generator.set("arguments_match_check", arguments_match_check);
- function_generator.set("overload_suffix", String::number(i));
- if (argument_count > fetched_arguments) {
- for (auto j = fetched_arguments; j < argument_count; ++j) {
- function_generator.set("argument.index", String::number(j));
- function_generator.append(R"~~~(
- [[maybe_unused]] auto arg@argument.index@ = vm.argument(@argument.index@);
- )~~~");
- }
- fetched_arguments = argument_count;
- }
- auto is_last = i == overloaded_functions.size() - 1;
- if (!is_last) {
- function_generator.append(R"~~~(
- if (vm.argument_count() == @argument_count@) {
- )~~~");
- }
- if (arguments_match_check.is_empty()) {
- function_generator.append(R"~~~(
- return @function.name:snakecase@@overload_suffix@(vm, global_object);
- )~~~");
- } else {
- function_generator.append(R"~~~(
- if (@arguments_match_check@)
- return @function.name:snakecase@@overload_suffix@(vm, global_object);
- )~~~");
- }
- if (!is_last) {
- function_generator.append(R"~~~(
- }
- )~~~");
- }
- }
- function_generator.append(R"~~~(
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::OverloadResolutionFailed);
- }
- )~~~");
- }
- void generate_header(IDL::Interface const& interface)
- {
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.append(R"~~~(
- #pragma once
- #include <LibWeb/Bindings/Wrapper.h>
- )~~~");
- for (auto& path : interface.required_imported_paths)
- generate_include_for(generator, path);
- 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", interface.wrapper_class.to_snakecase());
- if (interface.wrapper_base_class != "Wrapper")
- generate_include_for_wrapper(generator, interface.wrapper_base_class);
- generator.append(R"~~~(
- namespace Web::Bindings {
- class @wrapper_class@ : public @wrapper_base_class@ {
- JS_OBJECT(@name@, @wrapper_base_class@);
- public:
- static @wrapper_class@* create(JS::GlobalObject&, @fully_qualified_name@&);
- @wrapper_class@(JS::Realm&, @fully_qualified_name@&);
- virtual void initialize(JS::Realm&) override;
- virtual ~@wrapper_class@() override;
- )~~~");
- if (interface.extended_attributes.contains("CustomGet")) {
- generator.append(R"~~~(
- virtual JS::ThrowCompletionOr<JS::Value> internal_get(JS::PropertyKey const&, JS::Value receiver) const override;
- )~~~");
- }
- if (interface.extended_attributes.contains("CustomSet")) {
- generator.append(R"~~~(
- virtual JS::ThrowCompletionOr<bool> internal_set(JS::PropertyKey const&, JS::Value, JS::Value receiver) override;
- )~~~");
- }
- if (interface.extended_attributes.contains("CustomHasProperty")) {
- generator.append(R"~~~(
- virtual JS::ThrowCompletionOr<bool> internal_has_property(JS::PropertyKey const&) const override;
- )~~~");
- }
- if (interface.extended_attributes.contains("CustomVisit")) {
- generator.append(R"~~~(
- virtual void visit_edges(JS::Cell::Visitor&) override;
- )~~~");
- }
- if (interface.is_legacy_platform_object()) {
- generator.append(R"~~~(
- virtual JS::ThrowCompletionOr<Optional<JS::PropertyDescriptor>> internal_get_own_property(JS::PropertyKey const&) const override;
- virtual JS::ThrowCompletionOr<bool> internal_set(JS::PropertyKey const&, JS::Value, JS::Value) override;
- virtual JS::ThrowCompletionOr<bool> internal_define_own_property(JS::PropertyKey const&, JS::PropertyDescriptor const&) override;
- virtual JS::ThrowCompletionOr<bool> internal_delete(JS::PropertyKey const&) override;
- virtual JS::ThrowCompletionOr<bool> internal_prevent_extensions() override;
- virtual JS::ThrowCompletionOr<JS::MarkedVector<JS::Value>> internal_own_property_keys() const override;
- )~~~");
- }
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- @fully_qualified_name@& impl() { return *m_impl; }
- @fully_qualified_name@ const& impl() const { return *m_impl; }
- )~~~");
- } else {
- generator.append(R"~~~(
- @fully_qualified_name@& impl() { return static_cast<@fully_qualified_name@&>(@wrapper_base_class@::impl()); }
- @fully_qualified_name@ const& impl() const { return static_cast<@fully_qualified_name@ const&>(@wrapper_base_class@::impl()); }
- )~~~");
- }
- generator.append(R"~~~(
- private:
- )~~~");
- if (interface.is_legacy_platform_object()) {
- generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> is_named_property_exposed_on_object(JS::PropertyKey const&) const;
- JS::ThrowCompletionOr<Optional<JS::PropertyDescriptor>> legacy_platform_object_get_own_property_for_get_own_property_slot(JS::PropertyKey const&) const;
- JS::ThrowCompletionOr<Optional<JS::PropertyDescriptor>> legacy_platform_object_get_own_property_for_set_slot(JS::PropertyKey const&) const;
- )~~~");
- }
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- NonnullRefPtr<@fully_qualified_name@> m_impl;
- )~~~");
- }
- generator.append(R"~~~(
- };
- )~~~");
- for (auto& it : interface.enumerations) {
- if (!it.value.is_original_definition)
- continue;
- auto enum_generator = generator.fork();
- enum_generator.set("enum.type.name", it.key);
- enum_generator.append(R"~~~(
- enum class @enum.type.name@ {
- )~~~");
- for (auto& entry : it.value.translated_cpp_names) {
- enum_generator.set("enum.entry", entry.value);
- enum_generator.append(R"~~~(
- @enum.entry@,
- )~~~");
- }
- enum_generator.append(R"~~~(
- };
- inline String idl_enum_to_string(@enum.type.name@ value) {
- switch(value) {
- )~~~");
- for (auto& entry : it.value.translated_cpp_names) {
- enum_generator.set("enum.entry", entry.value);
- enum_generator.set("enum.string", entry.key);
- enum_generator.append(R"~~~(
- case @enum.type.name@::@enum.entry@: return "@enum.string@";
- )~~~");
- }
- enum_generator.append(R"~~~(
- default: return "<unknown>";
- };
- }
- )~~~");
- }
- 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(IDL::Interface const& 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/FunctionObject.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/TypedArray.h>
- #include <LibJS/Runtime/Value.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/ExceptionOrUtils.h>
- #include <LibWeb/Bindings/NodeWrapper.h>
- #include <LibWeb/Bindings/WindowObject.h>
- )~~~");
- emit_includes_for_all_imports(interface, generator);
- generator.append(R"~~~(
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::CSS;
- using namespace Web::DOM;
- using namespace Web::DOMParsing;
- using namespace Web::Fetch;
- using namespace Web::FileAPI;
- using namespace Web::Geometry;
- using namespace Web::HTML;
- using namespace Web::IntersectionObserver;
- using namespace Web::RequestIdleCallback;
- using namespace Web::ResizeObserver;
- using namespace Web::Selection;
- using namespace Web::WebGL;
- namespace Web::Bindings {
- @wrapper_class@* @wrapper_class@::create(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- {
- auto& realm = *global_object.associated_realm();
- return global_object.heap().allocate<@wrapper_class@>(global_object, realm, impl);
- }
- )~~~");
- if (interface.wrapper_base_class == "Wrapper") {
- generator.append(R"~~~(
- @wrapper_class@::@wrapper_class@(JS::Realm& realm, @fully_qualified_name@& impl)
- : Wrapper(static_cast<WindowObject&>(realm.global_object()).ensure_web_prototype<@prototype_class@>("@name@"))
- , m_impl(impl)
- {
- }
- )~~~");
- } else {
- generator.append(R"~~~(
- @wrapper_class@::@wrapper_class@(JS::Realm& realm, @fully_qualified_name@& impl)
- : @wrapper_base_class@(realm, impl)
- {
- set_prototype(&static_cast<WindowObject&>(realm.global_object()).ensure_web_prototype<@prototype_class@>("@name@"));
- }
- )~~~");
- }
- generator.append(R"~~~(
- void @wrapper_class@::initialize(JS::Realm& realm)
- {
- @wrapper_base_class@::initialize(realm);
- auto& vm = this->vm();
- define_direct_property(*vm.well_known_symbol_to_string_tag(), JS::js_string(vm, "@name@"), JS::Attribute::Configurable);
- }
- @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));
- }
- )~~~");
- }
- if (interface.extended_attributes.contains("CustomVisit")) {
- generator.append(R"~~~(
- void @wrapper_class@::visit_edges(JS::Cell::Visitor& visitor)
- {
- @wrapper_base_class@::visit_edges(visitor);
- impl().visit_edges(visitor);
- }
- )~~~");
- }
- if (interface.is_legacy_platform_object()) {
- auto scoped_generator = generator.fork();
- scoped_generator.set("class_name", interface.wrapper_class);
- scoped_generator.set("fully_qualified_name", interface.fully_qualified_name);
- // FIXME: This is a hack to avoid duplicating/refactoring a lot of code.
- scoped_generator.append(R"~~~(
- static JS::Value wrap_for_legacy_platform_object_get_own_property(JS::GlobalObject& global_object, [[maybe_unused]] auto& retval)
- {
- [[maybe_unused]] auto& vm = global_object.vm();
- )~~~");
- if (interface.named_property_getter.has_value()) {
- generate_return_statement(scoped_generator, *interface.named_property_getter->return_type, interface);
- } else {
- VERIFY(interface.indexed_property_getter.has_value());
- generate_return_statement(scoped_generator, *interface.indexed_property_getter->return_type, interface);
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- if (interface.supports_named_properties()) {
- // https://webidl.spec.whatwg.org/#dfn-named-property-visibility
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> @class_name@::is_named_property_exposed_on_object(JS::PropertyKey const& property_key) const
- {
- [[maybe_unused]] auto& vm = this->vm();
- // The spec doesn't say anything about the type of the property name here.
- // Numbers can be converted to a string, which is fine and what other engines do.
- // However, since a symbol cannot be converted to a string, it cannot be a supported property name. Return early if it's a symbol.
- if (property_key.is_symbol())
- return false;
- // 1. If P is not a supported property name of O, then return false.
- // NOTE: This is in it's own variable to enforce the type.
- // FIXME: Can this throw?
- Vector<String> supported_property_names = impl().supported_property_names();
- auto property_key_string = property_key.to_string();
- if (!supported_property_names.contains_slow(property_key_string))
- return false;
- // 2. If O has an own property named P, then return false.
- // NOTE: This has to be done manually instead of using Object::has_own_property, as that would use the overridden internal_get_own_property.
- auto own_property_named_p = MUST(Object::internal_get_own_property(property_key));
- if (own_property_named_p.has_value())
- return false;
- )~~~");
- if (interface.extended_attributes.contains("LegacyOverrideBuiltIns")) {
- scoped_generator.append(R"~~~(
- // 3. If O implements an interface that has the [LegacyOverrideBuiltIns] extended attribute, then return true.
- return true;
- }
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- // NOTE: Step 3 is not here as the interface doesn't have the LegacyOverrideBuiltIns extended attribute.
- // 4. Let prototype be O.[[GetPrototypeOf]]().
- auto* prototype = TRY(internal_get_prototype_of());
- // 5. While prototype is not null:
- while (prototype) {
- // FIXME: 1. If prototype is not a named properties object, and prototype has an own property named P, then return false.
- // (It currently does not check for named property objects)
- bool prototype_has_own_property_named_p = TRY(prototype->has_own_property(property_key));
- if (prototype_has_own_property_named_p)
- return false;
- // 2. Set prototype to prototype.[[GetPrototypeOf]]().
- prototype = TRY(prototype->internal_get_prototype_of());
- }
- // 6. Return true.
- return true;
- }
- )~~~");
- }
- }
- enum class IgnoreNamedProps {
- No,
- Yes,
- };
- auto generate_legacy_platform_object_get_own_property_function = [&](IgnoreNamedProps ignore_named_props, String const& for_which_internal_method) {
- // https://webidl.spec.whatwg.org/#LegacyPlatformObjectGetOwnProperty
- auto get_own_property_generator = scoped_generator.fork();
- get_own_property_generator.set("internal_method"sv, for_which_internal_method);
- get_own_property_generator.append(R"~~~(
- JS::ThrowCompletionOr<Optional<JS::PropertyDescriptor>> @class_name@::legacy_platform_object_get_own_property_for_@internal_method@_slot(JS::PropertyKey const& property_name) const
- {
- )~~~");
- get_own_property_generator.append(R"~~~(
- [[maybe_unused]] auto& global_object = this->global_object();
- )~~~");
- // 1. If O supports indexed properties...
- if (interface.supports_indexed_properties()) {
- // ...and P is an array index, then:
- get_own_property_generator.append(R"~~~(
- if (property_name.is_number()) {
- // 1. Let index be the result of calling ToUint32(P).
- u32 index = property_name.as_number();
- // 2. If index is a supported property index, then:
- // FIXME: Can this throw?
- if (impl().is_supported_property_index(index)) {
- )~~~");
- // 1. Let operation be the operation used to declare the indexed property getter. (NOTE: Not necessary)
- // 2. Let value be an uninitialized variable. (NOTE: Not necessary)
- // 3. If operation was defined without an identifier, then set value to the result of performing the steps listed in the interface description to determine the value of an indexed property with index as the index.
- if (interface.indexed_property_getter->name.is_empty()) {
- get_own_property_generator.append(R"~~~(
- auto value = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().determine_value_of_indexed_property(index); }));
- )~~~");
- }
- // 4. Otherwise, operation was defined with an identifier. Set value to the result of performing the method steps of operation with O as this and « index » as the argument values.
- else {
- auto function_scoped_generator = get_own_property_generator.fork();
- function_scoped_generator.set("function.cpp_name", make_input_acceptable_cpp(interface.indexed_property_getter->name.to_snakecase()));
- function_scoped_generator.append(R"~~~(
- auto value = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().@function.cpp_name@(index); }));
- )~~~");
- }
- get_own_property_generator.append(R"~~~(
- // 5. Let desc be a newly created Property Descriptor with no fields.
- JS::PropertyDescriptor descriptor;
- // 6. Set desc.[[Value]] to the result of converting value to an ECMAScript value.
- descriptor.value = wrap_for_legacy_platform_object_get_own_property(global_object, value);
- )~~~");
- // 7. If O implements an interface with an indexed property setter, then set desc.[[Writable]] to true, otherwise set it to false.
- if (interface.indexed_property_setter.has_value()) {
- get_own_property_generator.append(R"~~~(
- descriptor.writable = true;
- )~~~");
- } else {
- get_own_property_generator.append(R"~~~(
- descriptor.writable = false;
- )~~~");
- }
- get_own_property_generator.append(R"~~~(
- // 8. Set desc.[[Enumerable]] and desc.[[Configurable]] to true.
- descriptor.enumerable = true;
- descriptor.configurable = true;
- // 9. Return desc.
- return descriptor;
- }
- // 3. Set ignoreNamedProps to true.
- // NOTE: To reduce complexity of WrapperGenerator, this just returns early instead of keeping track of another variable.
- return TRY(Object::internal_get_own_property(property_name));
- }
- )~~~");
- }
- // 2. If O supports named properties and ignoreNamedProps is false, then:
- if (interface.supports_named_properties() && ignore_named_props == IgnoreNamedProps::No) {
- get_own_property_generator.append(R"~~~(
- // 1. If the result of running the named property visibility algorithm with property name P and object O is true, then:
- if (TRY(is_named_property_exposed_on_object(property_name))) {
- // FIXME: It's unfortunate that this is done twice, once in is_named_property_exposed_on_object and here.
- auto property_name_string = property_name.to_string();
- )~~~");
- // 1. Let operation be the operation used to declare the named property getter. (NOTE: Not necessary)
- // 2. Let value be an uninitialized variable. (NOTE: Not necessary)
- // 3. If operation was defined without an identifier, then set value to the result of performing the steps listed in the interface description to determine the value of a named property with P as the name.
- if (interface.named_property_getter->name.is_empty()) {
- get_own_property_generator.append(R"~~~(
- auto value = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().determine_value_of_named_property(property_name_string); }));
- )~~~");
- }
- // 4. Otherwise, operation was defined with an identifier. Set value to the result of performing the method steps of operation with O as this and « index » as the argument values.
- else {
- auto function_scoped_generator = get_own_property_generator.fork();
- function_scoped_generator.set("function.cpp_name", make_input_acceptable_cpp(interface.named_property_getter->name.to_snakecase()));
- function_scoped_generator.append(R"~~~(
- auto value = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().@function.cpp_name@(property_name_string); }));
- )~~~");
- }
- get_own_property_generator.append(R"~~~(
- // 5. Let desc be a newly created Property Descriptor with no fields.
- JS::PropertyDescriptor descriptor;
- // 6. Set desc.[[Value]] to the result of converting value to an ECMAScript value.
- descriptor.value = wrap_for_legacy_platform_object_get_own_property(global_object, value);
- )~~~");
- // 7. If O implements an interface with a named property setter, then set desc.[[Writable]] to true, otherwise set it to false.
- if (interface.named_property_setter.has_value()) {
- get_own_property_generator.append(R"~~~(
- descriptor.writable = true;
- )~~~");
- } else {
- get_own_property_generator.append(R"~~~(
- descriptor.writable = false;
- )~~~");
- }
- // 8. If O implements an interface with the [LegacyUnenumerableNamedProperties] extended attribute, then set desc.[[Enumerable]] to false, otherwise set it to true.
- if (interface.extended_attributes.contains("LegacyUnenumerableNamedProperties")) {
- get_own_property_generator.append(R"~~~(
- descriptor.enumerable = false;
- )~~~");
- } else {
- get_own_property_generator.append(R"~~~(
- descriptor.enumerable = true;
- )~~~");
- }
- get_own_property_generator.append(R"~~~(
- // 9. Set desc.[[Configurable]] to true.
- descriptor.configurable = true;
- // 10. Return desc.
- return descriptor;
- }
- )~~~");
- }
- // 3. Return OrdinaryGetOwnProperty(O, P).
- get_own_property_generator.append(R"~~~(
- return TRY(Object::internal_get_own_property(property_name));
- }
- )~~~");
- };
- // Step 1 of [[GetOwnProperty]]: Return LegacyPlatformObjectGetOwnProperty(O, P, false).
- generate_legacy_platform_object_get_own_property_function(IgnoreNamedProps::No, "get_own_property");
- // Step 2 of [[Set]]: Let ownDesc be LegacyPlatformObjectGetOwnProperty(O, P, true).
- generate_legacy_platform_object_get_own_property_function(IgnoreNamedProps::Yes, "set");
- if (interface.named_property_setter.has_value()) {
- // https://webidl.spec.whatwg.org/#invoke-named-setter
- // NOTE: All users of invoke_named_property_setter check that JS::PropertyKey is a String before calling it.
- // FIXME: It's not necessary to determine "creating" if the named property setter specifies an identifier.
- // Try avoiding it somehow, e.g. by enforcing supported_property_names doesn't have side effects so it can be skipped.
- scoped_generator.append(R"~~~(
- static JS::ThrowCompletionOr<void> invoke_named_property_setter(JS::GlobalObject& global_object, @fully_qualified_name@& impl, String const& property_name, JS::Value value)
- {
- // 1. Let creating be true if P is not a supported property name, and false otherwise.
- // NOTE: This is in it's own variable to enforce the type.
- // FIXME: Can this throw?
- Vector<String> supported_property_names = impl.supported_property_names();
- [[maybe_unused]] bool creating = !supported_property_names.contains_slow(property_name);
- )~~~");
- // 2. Let operation be the operation used to declare the named property setter. (NOTE: Not necessary)
- // 3. Let T be the type of the second argument of operation. (NOTE: Not necessary)
- // 4. Let value be the result of converting V to an IDL value of type T.
- // NOTE: This takes the last parameter as it's enforced that there's only two parameters.
- generate_to_cpp(scoped_generator, interface.named_property_setter->parameters.last(), "value", "", "converted_value", interface);
- // 5. If operation was defined without an identifier, then:
- if (interface.named_property_setter->name.is_empty()) {
- scoped_generator.append(R"~~~(
- if (creating) {
- // 5.1. If creating is true, then perform the steps listed in the interface description to set the value of a new named property with P as the name and value as the value.
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.set_value_of_new_named_property(property_name, converted_value); }));
- } else {
- // 5.2 Otherwise, creating is false. Perform the steps listed in the interface description to set the value of an existing named property with P as the name and value as the value.
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.set_value_of_existing_named_property(property_name, converted_value); }));
- }
- )~~~");
- } else {
- // 6. Otherwise, operation was defined with an identifier.
- // Perform the method steps of operation with O as this and « P, value » as the argument values.
- auto function_scoped_generator = scoped_generator.fork();
- function_scoped_generator.set("function.cpp_name", make_input_acceptable_cpp(interface.named_property_setter->name.to_snakecase()));
- function_scoped_generator.append(R"~~~(
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.@function.cpp_name@(property_name, converted_value); }));
- )~~~");
- }
- scoped_generator.append(R"~~~(
- return {};
- }
- )~~~");
- }
- if (interface.indexed_property_setter.has_value()) {
- // https://webidl.spec.whatwg.org/#invoke-indexed-setter
- // NOTE: All users of invoke_indexed_property_setter check if property name is an IDL array index before calling it.
- // FIXME: It's not necessary to determine "creating" if the indexed property setter specifies an identifier.
- // Try avoiding it somehow, e.g. by enforcing supported_property_indices doesn't have side effects so it can be skipped.
- scoped_generator.append(R"~~~(
- static JS::ThrowCompletionOr<void> invoke_indexed_property_setter(JS::GlobalObject& global_object, @fully_qualified_name@& impl, JS::PropertyKey const& property_name, JS::Value value)
- {
- // 1. Let index be the result of calling ToUint32(P).
- u32 index = property_name.as_number();
- // 2. Let creating be true if index is not a supported property index, and false otherwise.
- // FIXME: Can this throw?
- [[maybe_unused]] bool creating = !impl.is_supported_property_index(index);
- )~~~");
- // 3. Let operation be the operation used to declare the named property setter. (NOTE: Not necessary)
- // 4. Let T be the type of the second argument of operation. (NOTE: Not necessary)
- // 5. Let value be the result of converting V to an IDL value of type T.
- // NOTE: This takes the last parameter as it's enforced that there's only two parameters.
- generate_to_cpp(scoped_generator, interface.named_property_setter->parameters.last(), "value", "", "converted_value", interface);
- // 6. If operation was defined without an identifier, then:
- if (interface.indexed_property_setter->name.is_empty()) {
- scoped_generator.append(R"~~~(
- if (creating) {
- // 6.1 If creating is true, then perform the steps listed in the interface description to set the value of a new indexed property with index as the index and value as the value.
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.set_value_of_new_indexed_property(index, converted_value); }));
- } else {
- // 6.2 Otherwise, creating is false. Perform the steps listed in the interface description to set the value of an existing indexed property with index as the index and value as the value.
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.set_value_of_existing_indexed_property(index, converted_value); }));
- }
- )~~~");
- } else {
- // 7. Otherwise, operation was defined with an identifier.
- // Perform the method steps of operation with O as this and « index, value » as the argument values.
- auto function_scoped_generator = scoped_generator.fork();
- function_scoped_generator.set("function.cpp_name", make_input_acceptable_cpp(interface.indexed_property_setter->name.to_snakecase()));
- function_scoped_generator.append(R"~~~(
- TRY(throw_dom_exception_if_needed(global_object, [&] { impl.@function.cpp_name@(index, converted_value); }));
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- // == Internal Slot Generation ==
- // 3.9.1. [[GetOwnProperty]], https://webidl.spec.whatwg.org/#legacy-platform-object-getownproperty
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<Optional<JS::PropertyDescriptor>> @class_name@::internal_get_own_property(JS::PropertyKey const& property_name) const
- {
- // 1. Return LegacyPlatformObjectGetOwnProperty(O, P, false).
- return TRY(legacy_platform_object_get_own_property_for_get_own_property_slot(property_name));
- }
- )~~~");
- // 3.9.2. [[Set]], https://webidl.spec.whatwg.org/#legacy-platform-object-set
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> @class_name@::internal_set(JS::PropertyKey const& property_name, JS::Value value, JS::Value receiver)
- {
- [[maybe_unused]] auto& global_object = this->global_object();
- )~~~");
- // The step 1 if statement will be empty if the interface has no setters, so don't generate the if statement if there's no setters.
- if (interface.named_property_setter.has_value() || interface.indexed_property_setter.has_value()) {
- scoped_generator.append(R"~~~(
- // 1. If O and Receiver are the same object, then:
- if (JS::same_value(this, receiver)) {
- )~~~");
- // 1. If O implements an interface with an indexed property setter...
- if (interface.indexed_property_setter.has_value()) {
- // ...and P is an array index, then:
- scoped_generator.append(R"~~~(
- if (property_name.is_number()) {
- // 1. Invoke the indexed property setter on O with P and V.
- TRY(invoke_indexed_property_setter(global_object, impl(), property_name, value));
- // 2. Return true.
- return true;
- }
- )~~~");
- }
- // 2. If O implements an interface with a named property setter...
- if (interface.named_property_setter.has_value()) {
- // ... and Type(P) is String, then:
- scoped_generator.append(R"~~~(
- if (property_name.is_string()) {
- // 1. Invoke the named property setter on O with P and V.
- TRY(invoke_named_property_setter(global_object, impl(), property_name.as_string(), value));
- // 2. Return true.
- return true;
- }
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- scoped_generator.append(R"~~~(
- // 2. Let ownDesc be LegacyPlatformObjectGetOwnProperty(O, P, true).
- auto own_descriptor = TRY(legacy_platform_object_get_own_property_for_set_slot(property_name));
- // 3. Perform ? OrdinarySetWithOwnDescriptor(O, P, V, Receiver, ownDesc).
- // NOTE: The spec says "perform" instead of "return", meaning nothing will be returned on this path according to the spec, which isn't possible to do.
- // Let's treat it as though it says "return" instead of "perform".
- return ordinary_set_with_own_descriptor(property_name, value, receiver, own_descriptor);
- }
- )~~~");
- // 3.9.3. [[DefineOwnProperty]], https://webidl.spec.whatwg.org/#legacy-platform-object-defineownproperty
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> @class_name@::internal_define_own_property(JS::PropertyKey const& property_name, JS::PropertyDescriptor const& property_descriptor)
- {
- [[maybe_unused]] auto& vm = this->vm();
- [[maybe_unused]] auto& global_object = this->global_object();
- )~~~");
- // 1. If O supports indexed properties...
- if (interface.supports_indexed_properties()) {
- // ...and P is an array index, then:
- scoped_generator.append(R"~~~(
- if (property_name.is_number()) {
- // 1. If the result of calling IsDataDescriptor(Desc) is false, then return false.
- if (!property_descriptor.is_data_descriptor())
- return false;
- )~~~");
- // 2. If O does not implement an interface with an indexed property setter, then return false.
- if (!interface.indexed_property_setter.has_value()) {
- scoped_generator.append(R"~~~(
- return false;
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- // 3. Invoke the indexed property setter on O with P and Desc.[[Value]].
- TRY(invoke_indexed_property_setter(global_object, impl(), property_name, *property_descriptor.value));
- // 4. Return true.
- return true;
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- // 2. If O supports named properties, O does not implement an interface with the [Global] extended attribute,
- if (interface.supports_named_properties() && !interface.extended_attributes.contains("Global")) {
- // Type(P) is String,
- // FIXME: and P is not an unforgeable property name of O, then:
- // FIXME: It's not necessary to determine "creating" if the named property setter specifies an identifier.
- // Try avoiding it somehow, e.g. by enforcing supported_property_names doesn't have side effects so it can be skipped.
- scoped_generator.append(R"~~~(
- if (property_name.is_string()) {
- auto& property_name_as_string = property_name.as_string();
- // 1. Let creating be true if P is not a supported property name, and false otherwise.
- // NOTE: This is in it's own variable to enforce the type.
- // FIXME: Can this throw?
- Vector<String> supported_property_names = impl().supported_property_names();
- [[maybe_unused]] bool creating = !supported_property_names.contains_slow(property_name_as_string);
- )~~~");
- // 2. If O implements an interface with the [LegacyOverrideBuiltIns] extended attribute or O does not have an own property named P, then:
- if (!interface.extended_attributes.contains("LegacyOverrideBuiltIns")) {
- scoped_generator.append(R"~~~(
- // NOTE: This has to be done manually instead of using Object::has_own_property, as that would use the overridden internal_get_own_property.
- auto own_property_named_p = TRY(Object::internal_get_own_property(property_name));
- if (!own_property_named_p.has_value()))~~~");
- }
- // A scope is created regardless of the fact that the interface may have [LegacyOverrideBuiltIns] specified to prevent code duplication.
- scoped_generator.append(R"~~~(
- {
- )~~~");
- // 1. If creating is false and O does not implement an interface with a named property setter, then return false.
- if (!interface.named_property_setter.has_value()) {
- scoped_generator.append(R"~~~(
- if (!creating)
- return false;
- )~~~");
- } else {
- // 2. If O implements an interface with a named property setter, then:
- scoped_generator.append(R"~~~(
- // 1. If the result of calling IsDataDescriptor(Desc) is false, then return false.
- if (!property_descriptor.is_data_descriptor())
- return false;
- // 2. Invoke the named property setter on O with P and Desc.[[Value]].
- TRY(invoke_named_property_setter(global_object, impl(), property_name_as_string, *property_descriptor.value));
- // 3. Return true.
- return true;
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- // 3. If O does not implement an interface with the [Global] extended attribute, then set Desc.[[Configurable]] to true.
- if (!interface.extended_attributes.contains("Global")) {
- scoped_generator.append(R"~~~(
- // property_descriptor is a const&, thus we need to create a copy here to set [[Configurable]]
- JS::PropertyDescriptor descriptor_copy(property_descriptor);
- descriptor_copy.configurable = true;
- // 4. Return OrdinaryDefineOwnProperty(O, P, Desc).
- return Object::internal_define_own_property(property_name, descriptor_copy);
- )~~~");
- } else {
- scoped_generator.append(R"~~~(
- // 4. Return OrdinaryDefineOwnProperty(O, P, Desc).
- return Object::internal_define_own_property(property_name, property_descriptor);
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- // 3.9.4. [[Delete]], https://webidl.spec.whatwg.org/#legacy-platform-object-delete
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> @class_name@::internal_delete(JS::PropertyKey const& property_name)
- {
- [[maybe_unused]] auto& global_object = this->global_object();
- )~~~");
- // 1. If O supports indexed properties...
- if (interface.supports_indexed_properties()) {
- // ...and P is an array index, then:
- scoped_generator.append(R"~~~(
- if (property_name.is_number()) {
- // 1. Let index be the result of calling ToUint32(P).
- u32 index = property_name.as_number();
- // 2. If index is not a supported property index, then return true.
- // FIXME: Can this throw?
- if (!impl().is_supported_property_index(index))
- return true;
- // 3. Return false.
- return false;
- }
- )~~~");
- }
- // 2. If O supports named properties, O does not implement an interface with the [Global] extended attribute...
- if (interface.supports_named_properties() && !interface.extended_attributes.contains("Global")) {
- // ...and the result of calling the named property visibility algorithm with property name P and object O is true, then:
- scoped_generator.append(R"~~~(
- if (TRY(is_named_property_exposed_on_object(property_name))) {
- )~~~");
- // 1. If O does not implement an interface with a named property deleter, then return false.
- if (!interface.named_property_deleter.has_value()) {
- scoped_generator.append(R"~~~(
- return false;
- )~~~");
- } else {
- // 2. Let operation be the operation used to declare the named property deleter. (NOTE: Not necessary)
- scoped_generator.append(R"~~~(
- // FIXME: It's unfortunate that this is done twice, once in is_named_property_exposed_on_object and here.
- auto property_name_string = property_name.to_string();
- )~~~");
- // 3. If operation was defined without an identifier, then:
- if (interface.named_property_deleter->name.is_empty()) {
- scoped_generator.append(R"~~~(
- // 1. Perform the steps listed in the interface description to delete an existing named property with P as the name.
- bool succeeded = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().delete_existing_named_property(property_name_string); }));
- // 2. If the steps indicated that the deletion failed, then return false.
- if (!succeeded)
- return false;
- )~~~");
- } else {
- // 4. Otherwise, operation was defined with an identifier:
- auto function_scoped_generator = scoped_generator.fork();
- function_scoped_generator.set("function.cpp_name", make_input_acceptable_cpp(interface.named_property_deleter->name.to_snakecase()));
- function_scoped_generator.append(R"~~~(
- // 1. Perform method steps of operation with O as this and « P » as the argument values.
- [[maybe_unused]] auto result = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl().@function.cpp_name@(property_name_string); }));
- )~~~");
- // 2. If operation was declared with a return type of boolean and the steps returned false, then return false.
- if (interface.named_property_deleter->return_type->name == "boolean") {
- function_scoped_generator.append(R"~~~(
- if (!result)
- return false;
- )~~~");
- }
- }
- scoped_generator.append(R"~~~(
- // 5. Return true.
- return true;
- )~~~");
- }
- scoped_generator.append(R"~~~(
- }
- )~~~");
- }
- scoped_generator.append(R"~~~(
- // 3. If O has an own property with name P, then:
- auto own_property_named_p_descriptor = TRY(Object::internal_get_own_property(property_name));
- if (own_property_named_p_descriptor.has_value()) {
- // 1. If the property is not configurable, then return false.
- // 2. Otherwise, remove the property from O.
- if (*own_property_named_p_descriptor->configurable)
- storage_delete(property_name);
- else
- return false;
- }
- // 4. Return true.
- return true;
- }
- )~~~");
- // 3.9.5. [[PreventExtensions]], https://webidl.spec.whatwg.org/#legacy-platform-object-preventextensions
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<bool> @class_name@::internal_prevent_extensions()
- {
- // 1. Return false.
- return false;
- }
- )~~~");
- // 3.9.6. [[OwnPropertyKeys]], https://webidl.spec.whatwg.org/#legacy-platform-object-ownpropertykeys
- scoped_generator.append(R"~~~(
- JS::ThrowCompletionOr<JS::MarkedVector<JS::Value>> @class_name@::internal_own_property_keys() const
- {
- auto& vm = this->vm();
- // 1. Let keys be a new empty list of ECMAScript String and Symbol values.
- JS::MarkedVector<JS::Value> keys { heap() };
- )~~~");
- // 2. If O supports indexed properties, then for each index of O’s supported property indices, in ascending numerical order, append ! ToString(index) to keys.
- if (interface.supports_indexed_properties()) {
- scoped_generator.append(R"~~~(
- for (u64 index = 0; index <= NumericLimits<u32>::max(); ++index) {
- if (impl().is_supported_property_index(index))
- keys.append(js_string(vm, String::number(index)));
- else
- break;
- }
- )~~~");
- }
- // 3. If O supports named properties, then for each P of O’s supported property names that is visible according to the named property visibility algorithm, append P to keys.
- if (interface.supports_named_properties()) {
- scoped_generator.append(R"~~~(
- for (auto& named_property : impl().supported_property_names()) {
- if (TRY(is_named_property_exposed_on_object(named_property)))
- keys.append(js_string(vm, named_property));
- }
- )~~~");
- }
- scoped_generator.append(R"~~~(
- // 4. For each P of O’s own property keys that is a String, in ascending chronological order of property creation, append P to keys.
- for (auto& it : shape().property_table_ordered()) {
- if (it.key.is_string())
- keys.append(it.key.to_value(vm));
- }
- // 5. For each P of O’s own property keys that is a Symbol, in ascending chronological order of property creation, append P to keys.
- for (auto& it : shape().property_table_ordered()) {
- if (it.key.is_symbol())
- keys.append(it.key.to_value(vm));
- }
- // FIXME: 6. Assert: keys has no duplicate items.
- // 7. Return keys.
- return { move(keys) };
- }
- )~~~");
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_constructor_header(IDL::Interface const& 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", interface.constructor_class.to_snakecase());
- 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::Realm&);
- virtual void initialize(JS::Realm&) override;
- virtual ~@constructor_class@() override;
- virtual JS::ThrowCompletionOr<JS::Value> call() override;
- virtual JS::ThrowCompletionOr<JS::Object*> construct(JS::FunctionObject& new_target) override;
- private:
- virtual bool has_constructor() const override { return true; }
- )~~~");
- for (auto const& overload_set : interface.static_overload_sets) {
- auto function_generator = generator.fork();
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(overload_set.key.to_snakecase()));
- function_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@function.name:snakecase@);
- )~~~");
- if (overload_set.value.size() > 1) {
- for (auto i = 0u; i < overload_set.value.size(); ++i) {
- function_generator.set("overload_suffix", String::number(i));
- function_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@function.name:snakecase@@overload_suffix@);
- )~~~");
- }
- }
- }
- generator.append(R"~~~(
- };
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_constructor_implementation(IDL::Interface const& 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", interface.prototype_class.to_snakecase());
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- generator.append(R"~~~(
- #include <LibJS/Heap/Heap.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/IteratorOperations.h>
- #include <LibJS/Runtime/ArrayBuffer.h>
- #include <LibWeb/Bindings/@constructor_class@.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/CSSRuleWrapperFactory.h>
- #include <LibWeb/Bindings/EventTargetWrapperFactory.h>
- #include <LibWeb/Bindings/EventWrapperFactory.h>
- #include <LibWeb/Bindings/ExceptionOrUtils.h>
- #include <LibWeb/Bindings/NodeWrapper.h>
- #include <LibWeb/Bindings/NodeWrapperFactory.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #if __has_include(<LibWeb/Crypto/@name@.h>)
- # include <LibWeb/Crypto/@name@.h>
- #elif __has_include(<LibWeb/CSS/@name@.h>)
- # include <LibWeb/CSS/@name@.h>
- #elif __has_include(<LibWeb/DOM/@name@.h>)
- # include <LibWeb/DOM/@name@.h>
- #elif __has_include(<LibWeb/Encoding/@name@.h>)
- # include <LibWeb/Encoding/@name@.h>
- #elif __has_include(<LibWeb/Fetch/@name@.h>)
- # include <LibWeb/Fetch/@name@.h>
- #elif __has_include(<LibWeb/FileAPI/@name@.h>)
- # include <LibWeb/FileAPI/@name@.h>
- #elif __has_include(<LibWeb/Geometry/@name@.h>)
- # include <LibWeb/Geometry/@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/IntersectionObserver/@name@.h>)
- # include <LibWeb/IntersectionObserver/@name@.h>
- #elif __has_include(<LibWeb/NavigationTiming/@name@.h>)
- # include <LibWeb/NavigationTiming/@name@.h>
- #elif __has_include(<LibWeb/RequestIdleCallback/@name@.h>)
- # include <LibWeb/RequestIdleCallback/@name@.h>
- #elif __has_include(<LibWeb/ResizeObserver/@name@.h>)
- # include <LibWeb/ResizeObserver/@name@.h>
- #elif __has_include(<LibWeb/SVG/@name@.h>)
- # include <LibWeb/SVG/@name@.h>
- #elif __has_include(<LibWeb/Selection/@name@.h>)
- # include <LibWeb/Selection/@name@.h>
- #elif __has_include(<LibWeb/WebSockets/@name@.h>)
- # include <LibWeb/WebSockets/@name@.h>
- #elif __has_include(<LibWeb/XHR/@name@.h>)
- # include <LibWeb/XHR/@name@.h>
- #elif __has_include(<LibWeb/URL/@name@.h>)
- # include <LibWeb/URL/@name@.h>
- #endif
- )~~~");
- for (auto& path : interface.required_imported_paths)
- generate_include_for(generator, path);
- emit_includes_for_all_imports(interface, generator, interface.pair_iterator_types.has_value());
- generator.append(R"~~~(
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::CSS;
- using namespace Web::DOM;
- using namespace Web::DOMParsing;
- using namespace Web::Fetch;
- using namespace Web::FileAPI;
- using namespace Web::Geometry;
- using namespace Web::HTML;
- using namespace Web::IntersectionObserver;
- using namespace Web::RequestIdleCallback;
- using namespace Web::ResizeObserver;
- using namespace Web::Selection;
- using namespace Web::UIEvents;
- using namespace Web::XHR;
- using namespace Web::WebGL;
- namespace Web::Bindings {
- @constructor_class@::@constructor_class@(JS::Realm& realm)
- : NativeFunction(*realm.global_object().function_prototype())
- {
- }
- @constructor_class@::~@constructor_class@()
- {
- }
- JS::ThrowCompletionOr<JS::Value> @constructor_class@::call()
- {
- return vm().throw_completion<JS::TypeError>(global_object(), JS::ErrorType::ConstructorWithoutNew, "@name@");
- }
- JS::ThrowCompletionOr<JS::Object*> @constructor_class@::construct(FunctionObject&)
- {
- )~~~");
- if (interface.constructors.is_empty()) {
- // No constructor
- generator.set("constructor.length", "0");
- generator.append(R"~~~(
- return vm().throw_completion<JS::TypeError>(global_object(), JS::ErrorType::NotAConstructor, "@name@");
- )~~~");
- } else if (interface.constructors.size() == 1) {
- // Single constructor
- auto& constructor = interface.constructors[0];
- generator.set("constructor.length", String::number(constructor.length()));
- generator.append(R"~~~(
- [[maybe_unused]] auto& vm = this->vm();
- [[maybe_unused]] auto& global_object = this->global_object();
- auto& window = static_cast<WindowObject&>(global_object);
- )~~~");
- if (!constructor.parameters.is_empty()) {
- generate_argument_count_check(generator, constructor.name, constructor.length());
- StringBuilder arguments_builder;
- generate_arguments(generator, constructor.parameters, arguments_builder, interface);
- generator.set(".constructor_arguments", arguments_builder.string_view());
- generator.append(R"~~~(
- auto impl = TRY(throw_dom_exception_if_needed(global_object, [&] { return @fully_qualified_name@::create_with_global_object(window, @.constructor_arguments@); }));
- )~~~");
- } else {
- generator.append(R"~~~(
- auto impl = TRY(throw_dom_exception_if_needed(global_object, [&] { return @fully_qualified_name@::create_with_global_object(window); }));
- )~~~");
- }
- generator.append(R"~~~(
- return wrap(global_object, *impl);
- )~~~");
- } else {
- // Multiple constructor overloads - can't do that yet.
- TODO();
- }
- generator.append(R"~~~(
- }
- void @constructor_class@::initialize(JS::Realm& realm)
- {
- auto& vm = this->vm();
- auto& window = static_cast<WindowObject&>(realm.global_object());
- [[maybe_unused]] u8 default_attributes = JS::Attribute::Enumerable;
- NativeFunction::initialize(realm);
- define_direct_property(vm.names.prototype, &window.ensure_web_prototype<@prototype_class@>("@name@"), 0);
- define_direct_property(vm.names.length, JS::Value(@constructor.length@), JS::Attribute::Configurable);
- )~~~");
- for (auto& constant : interface.constants) {
- auto constant_generator = generator.fork();
- constant_generator.set("constant.name", constant.name);
- generate_wrap_statement(constant_generator, constant.value, constant.type, interface, String::formatted("auto constant_{}_value =", constant.name));
- constant_generator.append(R"~~~(
- define_direct_property("@constant.name@", constant_@constant.name@_value, JS::Attribute::Enumerable);
- )~~~");
- }
- // https://webidl.spec.whatwg.org/#es-operations
- for (auto const& overload_set : interface.static_overload_sets) {
- auto function_generator = generator.fork();
- function_generator.set("function.name", overload_set.key);
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(overload_set.key.to_snakecase()));
- function_generator.set("function.length", String::number(get_shortest_function_length(overload_set.value)));
- function_generator.append(R"~~~(
- define_native_function("@function.name@", @function.name:snakecase@, @function.length@, default_attributes);
- )~~~");
- }
- generator.append(R"~~~(
- }
- )~~~");
- // Implementation: Static Functions
- for (auto& function : interface.static_functions)
- generate_function(generator, function, StaticFunction::Yes, interface.constructor_class, interface.fully_qualified_name, interface);
- for (auto const& overload_set : interface.static_overload_sets) {
- if (overload_set.value.size() == 1)
- continue;
- generate_overload_arbiter(generator, overload_set, interface.constructor_class);
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_prototype_header(IDL::Interface const& 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", interface.prototype_class.to_snakecase());
- 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::Realm&);
- virtual void initialize(JS::Realm&) override;
- virtual ~@prototype_class@() override;
- private:
- )~~~");
- for (auto const& overload_set : interface.overload_sets) {
- auto function_generator = generator.fork();
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(overload_set.key.to_snakecase()));
- function_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@function.name:snakecase@);
- )~~~");
- if (overload_set.value.size() > 1) {
- for (auto i = 0u; i < overload_set.value.size(); ++i) {
- function_generator.set("overload_suffix", String::number(i));
- function_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@function.name:snakecase@@overload_suffix@);
- )~~~");
- }
- }
- }
- if (interface.has_stringifier) {
- auto stringifier_generator = generator.fork();
- stringifier_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(to_string);
- )~~~");
- }
- if (interface.pair_iterator_types.has_value()) {
- auto iterator_generator = generator.fork();
- iterator_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(entries);
- JS_DECLARE_NATIVE_FUNCTION(for_each);
- JS_DECLARE_NATIVE_FUNCTION(keys);
- JS_DECLARE_NATIVE_FUNCTION(values);
- )~~~");
- }
- for (auto& attribute : interface.attributes) {
- auto attribute_generator = generator.fork();
- attribute_generator.set("attribute.name:snakecase", attribute.name.to_snakecase());
- attribute_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@attribute.name:snakecase@_getter);
- )~~~");
- if (!attribute.readonly) {
- attribute_generator.append(R"~~~(
- JS_DECLARE_NATIVE_FUNCTION(@attribute.name:snakecase@_setter);
- )~~~");
- }
- }
- generator.append(R"~~~(
- };
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_prototype_implementation(IDL::Interface const& 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", interface.prototype_class.to_snakecase());
- generator.set("fully_qualified_name", interface.fully_qualified_name);
- if (interface.pair_iterator_types.has_value()) {
- generator.set("iterator_name", String::formatted("{}Iterator", interface.name));
- generator.set("iterator_wrapper_class", String::formatted("{}IteratorWrapper", interface.name));
- }
- generator.append(R"~~~(
- #include <AK/Function.h>
- #include <LibJS/Runtime/Array.h>
- #include <LibJS/Runtime/DataView.h>
- #include <LibJS/Runtime/Error.h>
- #include <LibJS/Runtime/FunctionObject.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/IteratorOperations.h>
- #include <LibJS/Runtime/TypedArray.h>
- #include <LibJS/Runtime/Value.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/EventWrapper.h>
- #include <LibWeb/Bindings/EventWrapperFactory.h>
- #include <LibWeb/Bindings/ExceptionOrUtils.h>
- #include <LibWeb/Bindings/LocationObject.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #include <LibWeb/Bindings/WorkerLocationWrapper.h>
- #include <LibWeb/Bindings/WorkerNavigatorWrapper.h>
- #include <LibWeb/Bindings/WorkerWrapper.h>
- #include <LibWeb/DOM/Element.h>
- #include <LibWeb/DOM/Event.h>
- #include <LibWeb/DOM/IDLEventListener.h>
- #include <LibWeb/DOM/NodeFilter.h>
- #include <LibWeb/DOM/Range.h>
- #include <LibWeb/HTML/Origin.h>
- #include <LibWeb/HTML/Scripting/Environments.h>
- #include <LibWeb/HTML/Window.h>
- #if __has_include(<LibWeb/Bindings/@prototype_base_class@.h>)
- # include <LibWeb/Bindings/@prototype_base_class@.h>
- #endif
- )~~~");
- for (auto& path : interface.required_imported_paths)
- generate_include_for(generator, path);
- emit_includes_for_all_imports(interface, generator, interface.pair_iterator_types.has_value());
- generator.append(R"~~~(
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::Crypto;
- using namespace Web::CSS;
- using namespace Web::DOM;
- using namespace Web::DOMParsing;
- using namespace Web::Fetch;
- using namespace Web::FileAPI;
- using namespace Web::Geometry;
- using namespace Web::HTML;
- using namespace Web::IntersectionObserver;
- using namespace Web::NavigationTiming;
- using namespace Web::RequestIdleCallback;
- using namespace Web::ResizeObserver;
- using namespace Web::Selection;
- using namespace Web::SVG;
- using namespace Web::URL;
- using namespace Web::WebSockets;
- using namespace Web::XHR;
- using namespace Web::WebGL;
- namespace Web::Bindings {
- @prototype_class@::@prototype_class@([[maybe_unused]] JS::Realm& realm))~~~");
- if (interface.name == "DOMException") {
- // https://webidl.spec.whatwg.org/#es-DOMException-specialness
- // Object.getPrototypeOf(DOMException.prototype) === Error.prototype
- generator.append(R"~~~(
- : Object(*realm.global_object().error_prototype())
- )~~~");
- } else if (!interface.parent_name.is_empty()) {
- generator.append(R"~~~(
- : Object(static_cast<WindowObject&>(realm.global_object()).ensure_web_prototype<@prototype_base_class@>("@parent_name@"))
- )~~~");
- } else {
- generator.append(R"~~~(
- : Object(*realm.global_object().object_prototype())
- )~~~");
- }
- // FIXME: Currently almost everything gets default_attributes but it should be configurable per attribute.
- // See the spec links for details
- generator.append(R"~~~(
- {
- }
- @prototype_class@::~@prototype_class@()
- {
- }
- void @prototype_class@::initialize(JS::Realm& realm)
- {
- [[maybe_unused]] auto& vm = this->vm();
- [[maybe_unused]] u8 default_attributes = JS::Attribute::Enumerable | JS::Attribute::Configurable | JS::Attribute::Writable;
- )~~~");
- if (interface.has_unscopable_member) {
- generator.append(R"~~~(
- auto* unscopable_object = JS::Object::create(realm.global_object(), nullptr);
- )~~~");
- }
- // https://webidl.spec.whatwg.org/#es-attributes
- 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);
- if (attribute.extended_attributes.contains("Unscopable")) {
- attribute_generator.append(R"~~~(
- MUST(unscopable_object->create_data_property("@attribute.name@", JS::Value(true)));
- )~~~");
- }
- attribute_generator.append(R"~~~(
- define_native_accessor("@attribute.name@", @attribute.getter_callback@, @attribute.setter_callback@, default_attributes);
- )~~~");
- }
- // https://webidl.spec.whatwg.org/#es-constants
- for (auto& constant : interface.constants) {
- // FIXME: Do constants need to be added to the unscopable list?
- auto constant_generator = generator.fork();
- constant_generator.set("constant.name", constant.name);
- generate_wrap_statement(constant_generator, constant.value, constant.type, interface, String::formatted("auto constant_{}_value =", constant.name));
- constant_generator.append(R"~~~(
- define_direct_property("@constant.name@", constant_@constant.name@_value, JS::Attribute::Enumerable);
- )~~~");
- }
- // https://webidl.spec.whatwg.org/#es-operations
- for (auto const& overload_set : interface.overload_sets) {
- auto function_generator = generator.fork();
- function_generator.set("function.name", overload_set.key);
- function_generator.set("function.name:snakecase", make_input_acceptable_cpp(overload_set.key.to_snakecase()));
- function_generator.set("function.length", String::number(get_shortest_function_length(overload_set.value)));
- // FIXME: What if only some of the overloads are Unscopable?
- if (any_of(overload_set.value, [](auto const& function) { return function.extended_attributes.contains("Unscopable"); })) {
- function_generator.append(R"~~~(
- MUST(unscopable_object->create_data_property("@function.name@", JS::Value(true)));
- )~~~");
- }
- function_generator.append(R"~~~(
- define_native_function("@function.name@", @function.name:snakecase@, @function.length@, default_attributes);
- )~~~");
- }
- if (interface.has_stringifier) {
- // FIXME: Do stringifiers need to be added to the unscopable list?
- auto stringifier_generator = generator.fork();
- stringifier_generator.append(R"~~~(
- define_native_function("toString", to_string, 0, default_attributes);
- )~~~");
- }
- // https://webidl.spec.whatwg.org/#define-the-iteration-methods
- // This applies to this if block and the following if block.
- if (interface.indexed_property_getter.has_value()) {
- auto iterator_generator = generator.fork();
- iterator_generator.append(R"~~~(
- define_direct_property(*vm.well_known_symbol_iterator(), realm.global_object().array_prototype()->get_without_side_effects(vm.names.values), JS::Attribute::Configurable | JS::Attribute::Writable);
- )~~~");
- if (interface.value_iterator_type.has_value()) {
- iterator_generator.append(R"~~~(
- define_direct_property(vm.names.entries, realm.global_object().array_prototype()->get_without_side_effects(vm.names.entries), default_attributes);
- define_direct_property(vm.names.keys, realm.global_object().array_prototype()->get_without_side_effects(vm.names.keys), default_attributes);
- define_direct_property(vm.names.values, realm.global_object().array_prototype()->get_without_side_effects(vm.names.values), default_attributes);
- define_direct_property(vm.names.forEach, realm.global_object().array_prototype()->get_without_side_effects(vm.names.forEach), default_attributes);
- )~~~");
- }
- }
- if (interface.pair_iterator_types.has_value()) {
- // FIXME: Do pair iterators need to be added to the unscopable list?
- auto iterator_generator = generator.fork();
- iterator_generator.append(R"~~~(
- define_native_function(vm.names.entries, entries, 0, default_attributes);
- define_native_function(vm.names.forEach, for_each, 1, default_attributes);
- define_native_function(vm.names.keys, keys, 0, default_attributes);
- define_native_function(vm.names.values, values, 0, default_attributes);
- define_direct_property(*vm.well_known_symbol_iterator(), get_without_side_effects(vm.names.entries), JS::Attribute::Configurable | JS::Attribute::Writable);
- )~~~");
- }
- if (interface.has_unscopable_member) {
- generator.append(R"~~~(
- define_direct_property(*vm.well_known_symbol_unscopables(), unscopable_object, JS::Attribute::Configurable);
- )~~~");
- }
- generator.append(R"~~~(
- Object::initialize(realm);
- }
- )~~~");
- if (!interface.attributes.is_empty() || !interface.functions.is_empty() || interface.has_stringifier) {
- generator.append(R"~~~(
- static JS::ThrowCompletionOr<@fully_qualified_name@*> impl_from(JS::VM& vm, JS::GlobalObject& global_object)
- {
- auto this_value = vm.this_value(global_object);
- JS::Object* this_object = nullptr;
- if (this_value.is_nullish())
- this_object = &vm.current_realm()->global_object();
- else
- this_object = TRY(this_value.to_object(global_object));
- )~~~");
- 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))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@fully_qualified_name@");
- return &static_cast<@wrapper_class@*>(this_object)->impl();
- }
- )~~~");
- }
- 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);
- if (attribute.extended_attributes.contains("ImplementedAs")) {
- auto implemented_as = attribute.extended_attributes.get("ImplementedAs").value();
- attribute_generator.set("attribute.cpp_name", implemented_as);
- } else {
- attribute_generator.set("attribute.cpp_name", attribute.name.to_snakecase());
- }
- 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", attribute.name.to_snakecase());
- }
- attribute_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::@attribute.getter_callback@)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- )~~~");
- 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 = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl->@attribute.cpp_name@(); }));
- )~~~");
- }
- generate_return_statement(generator, *attribute.type, interface);
- attribute_generator.append(R"~~~(
- }
- )~~~");
- if (!attribute.readonly) {
- attribute_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::@attribute.setter_callback@)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- auto value = vm.argument(0);
- )~~~");
- generate_to_cpp(generator, attribute, "value", "", "cpp_value", interface, 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"~~~(
- TRY(throw_dom_exception_if_needed(global_object, [&] { return impl->set_@attribute.cpp_name@(cpp_value); }));
- )~~~");
- }
- attribute_generator.append(R"~~~(
- return JS::js_undefined();
- }
- )~~~");
- }
- }
- // Implementation: Functions
- for (auto& function : interface.functions)
- generate_function(generator, function, StaticFunction::No, interface.prototype_class, interface.fully_qualified_name, interface);
- for (auto const& overload_set : interface.overload_sets) {
- if (overload_set.value.size() == 1)
- continue;
- generate_overload_arbiter(generator, overload_set, interface.prototype_class);
- }
- if (interface.has_stringifier) {
- auto stringifier_generator = generator.fork();
- stringifier_generator.set("class_name", interface.prototype_class);
- if (interface.stringifier_attribute.has_value())
- stringifier_generator.set("attribute.cpp_getter_name", interface.stringifier_attribute->to_snakecase());
- stringifier_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@class_name@::to_string)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- )~~~");
- if (interface.stringifier_attribute.has_value()) {
- stringifier_generator.append(R"~~~(
- auto retval = impl->@attribute.cpp_getter_name@();
- )~~~");
- } else {
- stringifier_generator.append(R"~~~(
- auto retval = TRY(throw_dom_exception_if_needed(global_object, [&] { return impl->to_string(); }));
- )~~~");
- }
- stringifier_generator.append(R"~~~(
- return JS::js_string(vm, move(retval));
- }
- )~~~");
- }
- if (interface.pair_iterator_types.has_value()) {
- auto iterator_generator = generator.fork();
- iterator_generator.append(R"~~~(
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::entries)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- return wrap(global_object, @iterator_name@::create(*impl, Object::PropertyKind::KeyAndValue));
- }
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::for_each)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- auto callback = vm.argument(0);
- if (!callback.is_function())
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAFunction, callback.to_string_without_side_effects());
- auto this_value = vm.this_value(global_object);
- TRY(impl->for_each([&](auto key, auto value) -> JS::ThrowCompletionOr<void> {
- )~~~");
- generate_variable_statement(iterator_generator, "wrapped_key", interface.pair_iterator_types->get<0>(), "key", interface);
- generate_variable_statement(iterator_generator, "wrapped_value", interface.pair_iterator_types->get<1>(), "value", interface);
- iterator_generator.append(R"~~~(
- TRY(call(global_object, callback.as_function(), vm.argument(1), wrapped_value, wrapped_key, this_value));
- return {};
- }));
- return JS::js_undefined();
- }
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::keys)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- return wrap(global_object, @iterator_name@::create(*impl, Object::PropertyKind::Key));
- }
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::values)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- return wrap(global_object, @iterator_name@::create(*impl, Object::PropertyKind::Value));
- }
- )~~~");
- }
- generator.append(R"~~~(
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_iterator_header(IDL::Interface const& interface)
- {
- VERIFY(interface.pair_iterator_types.has_value());
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", String::formatted("{}Iterator", interface.name));
- generator.set("fully_qualified_name", String::formatted("{}Iterator", interface.fully_qualified_name));
- generator.set("wrapper_class", String::formatted("{}IteratorWrapper", interface.name));
- generator.append(R"~~~(
- #pragma once
- #include <LibWeb/Bindings/Wrapper.h>
- namespace Web::Bindings {
- class @wrapper_class@ : public Wrapper {
- JS_OBJECT(@name@, Wrapper);
- public:
- static @wrapper_class@* create(JS::GlobalObject&, @fully_qualified_name@&);
- @wrapper_class@(JS::Realm&, @fully_qualified_name@&);
- virtual void initialize(JS::Realm&) override;
- virtual ~@wrapper_class@() override;
- @fully_qualified_name@& impl() { return *m_impl; }
- @fully_qualified_name@ const& impl() const { return *m_impl; }
- private:
- virtual void visit_edges(Cell::Visitor&) override; // The Iterator implementation has to visit the wrapper it's iterating
- NonnullRefPtr<@fully_qualified_name@> m_impl;
- };
- @wrapper_class@* wrap(JS::GlobalObject&, @fully_qualified_name@&);
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_iterator_implementation(IDL::Interface const& interface)
- {
- VERIFY(interface.pair_iterator_types.has_value());
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", String::formatted("{}Iterator", interface.name));
- generator.set("fully_qualified_name", String::formatted("{}Iterator", interface.fully_qualified_name));
- generator.set("prototype_class", String::formatted("{}IteratorPrototype", interface.name));
- generator.set("wrapper_class", String::formatted("{}IteratorWrapper", interface.name));
- generator.append(R"~~~(
- #include <AK/FlyString.h>
- #include <LibJS/Runtime/Array.h>
- #include <LibJS/Runtime/Error.h>
- #include <LibJS/Runtime/FunctionObject.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/TypedArray.h>
- #include <LibJS/Runtime/Value.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/@wrapper_class@.h>
- #include <LibWeb/Bindings/IDLAbstractOperations.h>
- #include <LibWeb/Bindings/WindowObject.h>
- )~~~");
- for (auto& path : interface.required_imported_paths)
- generate_include_for(generator, path);
- emit_includes_for_all_imports(interface, generator, true);
- generator.append(R"~~~(
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::CSS;
- using namespace Web::DOM;
- using namespace Web::DOMParsing;
- using namespace Web::Fetch;
- using namespace Web::FileAPI;
- using namespace Web::Geometry;
- using namespace Web::HTML;
- using namespace Web::IntersectionObserver;
- using namespace Web::RequestIdleCallback;
- using namespace Web::ResizeObserver;
- using namespace Web::Selection;
- using namespace Web::WebGL;
- namespace Web::Bindings {
- @wrapper_class@* @wrapper_class@::create(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- {
- auto& realm = *global_object.associated_realm();
- return global_object.heap().allocate<@wrapper_class@>(global_object, realm, impl);
- }
- @wrapper_class@::@wrapper_class@(JS::Realm& realm, @fully_qualified_name@& impl)
- : Wrapper(static_cast<WindowObject&>(realm.global_object()).ensure_web_prototype<@prototype_class@>("@name@"))
- , m_impl(impl)
- {
- }
- void @wrapper_class@::initialize(JS::Realm& realm)
- {
- Wrapper::initialize(realm);
- }
- @wrapper_class@::~@wrapper_class@()
- {
- }
- void @wrapper_class@::visit_edges(Cell::Visitor& visitor)
- {
- Wrapper::visit_edges(visitor);
- impl().visit_edges(visitor);
- }
- @wrapper_class@* wrap(JS::GlobalObject& global_object, @fully_qualified_name@& impl)
- {
- return static_cast<@wrapper_class@*>(wrap_impl(global_object, impl));
- }
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_iterator_prototype_header(IDL::Interface const& interface)
- {
- VERIFY(interface.pair_iterator_types.has_value());
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("prototype_class", String::formatted("{}IteratorPrototype", interface.name));
- 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::Realm&);
- virtual void initialize(JS::Realm&) override;
- virtual ~@prototype_class@() override;
- private:
- JS_DECLARE_NATIVE_FUNCTION(next);
- };
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- void generate_iterator_prototype_implementation(IDL::Interface const& interface)
- {
- VERIFY(interface.pair_iterator_types.has_value());
- StringBuilder builder;
- SourceGenerator generator { builder };
- generator.set("name", String::formatted("{}Iterator", interface.name));
- generator.set("prototype_class", String::formatted("{}IteratorPrototype", interface.name));
- generator.set("wrapper_class", String::formatted("{}IteratorWrapper", interface.name));
- generator.set("fully_qualified_name", String::formatted("{}Iterator", interface.fully_qualified_name));
- generator.set("possible_include_path", String::formatted("{}Iterator", interface.name.replace("::"sv, "/"sv, ReplaceMode::All)));
- generator.append(R"~~~(
- #include <AK/Function.h>
- #include <LibJS/Runtime/Array.h>
- #include <LibJS/Runtime/Error.h>
- #include <LibJS/Runtime/FunctionObject.h>
- #include <LibJS/Runtime/GlobalObject.h>
- #include <LibJS/Runtime/TypedArray.h>
- #include <LibWeb/Bindings/@prototype_class@.h>
- #include <LibWeb/Bindings/ExceptionOrUtils.h>
- #include <LibWeb/Bindings/WindowObject.h>
- #if __has_include(<LibWeb/@possible_include_path@.h>)
- # include <LibWeb/@possible_include_path@.h>
- #endif
- )~~~");
- emit_includes_for_all_imports(interface, generator, true);
- generator.append(R"~~~(
- // FIXME: This is a total hack until we can figure out the namespace for a given type somehow.
- using namespace Web::CSS;
- using namespace Web::DOM;
- using namespace Web::DOMParsing;
- using namespace Web::Fetch;
- using namespace Web::FileAPI;
- using namespace Web::Geometry;
- using namespace Web::HTML;
- using namespace Web::IntersectionObserver;
- using namespace Web::NavigationTiming;
- using namespace Web::RequestIdleCallback;
- using namespace Web::ResizeObserver;
- using namespace Web::Selection;
- using namespace Web::XHR;
- using namespace Web::URL;
- using namespace Web::WebGL;
- namespace Web::Bindings {
- @prototype_class@::@prototype_class@(JS::Realm& realm)
- : Object(*realm.global_object().iterator_prototype())
- {
- }
- @prototype_class@::~@prototype_class@()
- {
- }
- void @prototype_class@::initialize(JS::Realm& realm)
- {
- auto& vm = this->vm();
- Object::initialize(realm);
- define_native_function(vm.names.next, next, 0, JS::Attribute::Writable | JS::Attribute::Enumerable | JS::Attribute::Configurable);
- define_direct_property(*vm.well_known_symbol_to_string_tag(), js_string(vm, "Iterator"), JS::Attribute::Configurable);
- }
- static JS::ThrowCompletionOr<@fully_qualified_name@*> impl_from(JS::VM& vm, JS::GlobalObject& global_object)
- {
- auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
- if (!is<@wrapper_class@>(this_object))
- return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "@fully_qualified_name@");
- return &static_cast<@wrapper_class@*>(this_object)->impl();
- }
- JS_DEFINE_NATIVE_FUNCTION(@prototype_class@::next)
- {
- auto* impl = TRY(impl_from(vm, global_object));
- return TRY(throw_dom_exception_if_needed(global_object, [&] { return impl->next(); }));
- }
- } // namespace Web::Bindings
- )~~~");
- outln("{}", generator.as_string_view());
- }
- }
|