wayland_thread.cpp 137 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431
  1. /**************************************************************************/
  2. /* wayland_thread.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "wayland_thread.h"
  31. #ifdef WAYLAND_ENABLED
  32. // FIXME: Does this cause issues with *BSDs?
  33. #include <linux/input-event-codes.h>
  34. // For the actual polling thread.
  35. #include <poll.h>
  36. // For shared memory buffer creation.
  37. #include <fcntl.h>
  38. #include <sys/mman.h>
  39. #include <unistd.h>
  40. // Fix the wl_array_for_each macro to work with C++. This is based on the
  41. // original from `wayland-util.h` in the Wayland client library.
  42. #undef wl_array_for_each
  43. #define wl_array_for_each(pos, array) \
  44. for (pos = (decltype(pos))(array)->data; (const char *)pos < ((const char *)(array)->data + (array)->size); (pos)++)
  45. #define WAYLAND_THREAD_DEBUG_LOGS_ENABLED
  46. #ifdef WAYLAND_THREAD_DEBUG_LOGS_ENABLED
  47. #define DEBUG_LOG_WAYLAND_THREAD(...) print_verbose(__VA_ARGS__)
  48. #else
  49. #define DEBUG_LOG_WAYLAND_THREAD(...)
  50. #endif
  51. // Read the content pointed by fd into a Vector<uint8_t>.
  52. Vector<uint8_t> WaylandThread::_read_fd(int fd) {
  53. // This is pretty much an arbitrary size.
  54. uint32_t chunk_size = 2048;
  55. LocalVector<uint8_t> data;
  56. data.resize(chunk_size);
  57. uint32_t bytes_read = 0;
  58. while (true) {
  59. ssize_t last_bytes_read = read(fd, data.ptr() + bytes_read, chunk_size);
  60. if (last_bytes_read < 0) {
  61. ERR_PRINT(vformat("Read error %d.", errno));
  62. data.clear();
  63. break;
  64. }
  65. if (last_bytes_read == 0) {
  66. // We're done, we've reached the EOF.
  67. DEBUG_LOG_WAYLAND_THREAD(vformat("Done reading %d bytes.", bytes_read));
  68. close(fd);
  69. data.resize(bytes_read);
  70. break;
  71. }
  72. DEBUG_LOG_WAYLAND_THREAD(vformat("Read chunk of %d bytes.", last_bytes_read));
  73. bytes_read += last_bytes_read;
  74. // Increase the buffer size by one chunk in preparation of the next read.
  75. data.resize(bytes_read + chunk_size);
  76. }
  77. return data;
  78. }
  79. // Based on the wayland book's shared memory boilerplate (PD/CC0).
  80. // See: https://wayland-book.com/surfaces/shared-memory.html
  81. int WaylandThread::_allocate_shm_file(size_t size) {
  82. int retries = 100;
  83. do {
  84. // Generate a random name.
  85. char name[] = "/wl_shm-godot-XXXXXX";
  86. for (long unsigned int i = sizeof(name) - 7; i < sizeof(name) - 1; i++) {
  87. name[i] = Math::random('A', 'Z');
  88. }
  89. // Try to open a shared memory object with that name.
  90. int fd = shm_open(name, O_RDWR | O_CREAT | O_EXCL, 0600);
  91. if (fd >= 0) {
  92. // Success, unlink its name as we just need the file descriptor.
  93. shm_unlink(name);
  94. // Resize the file to the requested length.
  95. int ret;
  96. do {
  97. ret = ftruncate(fd, size);
  98. } while (ret < 0 && errno == EINTR);
  99. if (ret < 0) {
  100. close(fd);
  101. return -1;
  102. }
  103. return fd;
  104. }
  105. retries--;
  106. } while (retries > 0 && errno == EEXIST);
  107. return -1;
  108. }
  109. // Return the content of a wl_data_offer.
  110. Vector<uint8_t> WaylandThread::_wl_data_offer_read(struct wl_display *p_display, const char *p_mime, struct wl_data_offer *p_offer) {
  111. if (!p_offer) {
  112. return Vector<uint8_t>();
  113. }
  114. int fds[2];
  115. if (pipe(fds) == 0) {
  116. wl_data_offer_receive(p_offer, p_mime, fds[1]);
  117. // Let the compositor know about the pipe.
  118. // NOTE: It's important to just flush and not roundtrip here as we would risk
  119. // running some cleanup event, like for example `wl_data_device::leave`. We're
  120. // going to wait for the message anyways as the read will probably block if
  121. // the compositor doesn't read from the other end of the pipe.
  122. wl_display_flush(p_display);
  123. // Close the write end of the pipe, which we don't need and would otherwise
  124. // just stall our next `read`s.
  125. close(fds[1]);
  126. return _read_fd(fds[0]);
  127. }
  128. return Vector<uint8_t>();
  129. }
  130. // Read the content of a wp_primary_selection_offer.
  131. Vector<uint8_t> WaylandThread::_wp_primary_selection_offer_read(struct wl_display *p_display, const char *p_mime, struct zwp_primary_selection_offer_v1 *p_offer) {
  132. if (!p_offer) {
  133. return Vector<uint8_t>();
  134. }
  135. int fds[2];
  136. if (pipe(fds) == 0) {
  137. zwp_primary_selection_offer_v1_receive(p_offer, p_mime, fds[1]);
  138. // NOTE: It's important to just flush and not roundtrip here as we would risk
  139. // running some cleanup event, like for example `wl_data_device::leave`. We're
  140. // going to wait for the message anyways as the read will probably block if
  141. // the compositor doesn't read from the other end of the pipe.
  142. wl_display_flush(p_display);
  143. // Close the write end of the pipe, which we don't need and would otherwise
  144. // just stall our next `read`s.
  145. close(fds[1]);
  146. return _read_fd(fds[0]);
  147. }
  148. return Vector<uint8_t>();
  149. }
  150. // Sets up an `InputEventKey` and returns whether it has any meaningful value.
  151. bool WaylandThread::_seat_state_configure_key_event(SeatState &p_ss, Ref<InputEventKey> p_event, xkb_keycode_t p_keycode, bool p_pressed) {
  152. // TODO: Handle keys that release multiple symbols?
  153. Key keycode = KeyMappingXKB::get_keycode(xkb_state_key_get_one_sym(p_ss.xkb_state, p_keycode));
  154. Key physical_keycode = KeyMappingXKB::get_scancode(p_keycode);
  155. KeyLocation key_location = KeyMappingXKB::get_location(p_keycode);
  156. if (physical_keycode == Key::NONE) {
  157. return false;
  158. }
  159. if (keycode == Key::NONE) {
  160. keycode = physical_keycode;
  161. }
  162. if (keycode >= Key::A + 32 && keycode <= Key::Z + 32) {
  163. keycode -= 'a' - 'A';
  164. }
  165. p_event->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  166. // Set all pressed modifiers.
  167. p_event->set_shift_pressed(p_ss.shift_pressed);
  168. p_event->set_ctrl_pressed(p_ss.ctrl_pressed);
  169. p_event->set_alt_pressed(p_ss.alt_pressed);
  170. p_event->set_meta_pressed(p_ss.meta_pressed);
  171. p_event->set_pressed(p_pressed);
  172. p_event->set_keycode(keycode);
  173. p_event->set_physical_keycode(physical_keycode);
  174. p_event->set_location(key_location);
  175. uint32_t unicode = xkb_state_key_get_utf32(p_ss.xkb_state, p_keycode);
  176. if (unicode != 0) {
  177. p_event->set_key_label(fix_key_label(unicode, keycode));
  178. } else {
  179. p_event->set_key_label(keycode);
  180. }
  181. if (p_pressed) {
  182. p_event->set_unicode(fix_unicode(unicode));
  183. }
  184. // Taken from DisplayServerX11.
  185. if (p_event->get_keycode() == Key::BACKTAB) {
  186. // Make it consistent across platforms.
  187. p_event->set_keycode(Key::TAB);
  188. p_event->set_physical_keycode(Key::TAB);
  189. p_event->set_shift_pressed(true);
  190. }
  191. return true;
  192. }
  193. void WaylandThread::_set_current_seat(struct wl_seat *p_seat) {
  194. if (p_seat == wl_seat_current) {
  195. return;
  196. }
  197. SeatState *old_state = wl_seat_get_seat_state(wl_seat_current);
  198. if (old_state) {
  199. seat_state_unlock_pointer(old_state);
  200. }
  201. SeatState *new_state = wl_seat_get_seat_state(p_seat);
  202. seat_state_unlock_pointer(new_state);
  203. wl_seat_current = p_seat;
  204. pointer_set_constraint(pointer_constraint);
  205. }
  206. // Returns whether it loaded the theme or not.
  207. bool WaylandThread::_load_cursor_theme(int p_cursor_size) {
  208. if (wl_cursor_theme) {
  209. wl_cursor_theme_destroy(wl_cursor_theme);
  210. wl_cursor_theme = nullptr;
  211. }
  212. if (cursor_theme_name.is_empty()) {
  213. cursor_theme_name = "default";
  214. }
  215. print_verbose(vformat("Loading cursor theme \"%s\" size %d.", cursor_theme_name, p_cursor_size));
  216. wl_cursor_theme = wl_cursor_theme_load(cursor_theme_name.utf8().get_data(), p_cursor_size, registry.wl_shm);
  217. ERR_FAIL_NULL_V_MSG(wl_cursor_theme, false, "Can't load any cursor theme.");
  218. static const char *cursor_names[] = {
  219. "left_ptr",
  220. "xterm",
  221. "hand2",
  222. "cross",
  223. "watch",
  224. "left_ptr_watch",
  225. "fleur",
  226. "dnd-move",
  227. "crossed_circle",
  228. "v_double_arrow",
  229. "h_double_arrow",
  230. "size_bdiag",
  231. "size_fdiag",
  232. "move",
  233. "row_resize",
  234. "col_resize",
  235. "question_arrow"
  236. };
  237. static const char *cursor_names_fallback[] = {
  238. nullptr,
  239. nullptr,
  240. "pointer",
  241. "cross",
  242. "wait",
  243. "progress",
  244. "grabbing",
  245. "hand1",
  246. "forbidden",
  247. "ns-resize",
  248. "ew-resize",
  249. "fd_double_arrow",
  250. "bd_double_arrow",
  251. "fleur",
  252. "sb_v_double_arrow",
  253. "sb_h_double_arrow",
  254. "help"
  255. };
  256. for (int i = 0; i < DisplayServer::CURSOR_MAX; i++) {
  257. struct wl_cursor *cursor = wl_cursor_theme_get_cursor(wl_cursor_theme, cursor_names[i]);
  258. if (!cursor && cursor_names_fallback[i]) {
  259. cursor = wl_cursor_theme_get_cursor(wl_cursor_theme, cursor_names_fallback[i]);
  260. }
  261. if (cursor && cursor->image_count > 0) {
  262. wl_cursors[i] = cursor;
  263. } else {
  264. wl_cursors[i] = nullptr;
  265. print_verbose("Failed loading cursor: " + String(cursor_names[i]));
  266. }
  267. }
  268. return true;
  269. }
  270. void WaylandThread::_update_scale(int p_scale) {
  271. if (p_scale <= cursor_scale) {
  272. return;
  273. }
  274. print_verbose(vformat("Bumping cursor scale to %d", p_scale));
  275. // There's some display that's bigger than the cache, let's update it.
  276. cursor_scale = p_scale;
  277. if (wl_cursor_theme == nullptr) {
  278. // Ugh. Either we're still initializing (this must've been called from the
  279. // first roundtrips) or we had some error while doing so. We'll trust that it
  280. // will be updated for us if needed.
  281. return;
  282. }
  283. int cursor_size = unscaled_cursor_size * p_scale;
  284. if (_load_cursor_theme(cursor_size)) {
  285. for (struct wl_seat *wl_seat : registry.wl_seats) {
  286. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  287. ERR_FAIL_NULL(ss);
  288. seat_state_update_cursor(ss);
  289. }
  290. }
  291. }
  292. void WaylandThread::_wl_registry_on_global(void *data, struct wl_registry *wl_registry, uint32_t name, const char *interface, uint32_t version) {
  293. RegistryState *registry = (RegistryState *)data;
  294. ERR_FAIL_NULL(registry);
  295. if (strcmp(interface, wl_shm_interface.name) == 0) {
  296. registry->wl_shm = (struct wl_shm *)wl_registry_bind(wl_registry, name, &wl_shm_interface, 1);
  297. registry->wl_shm_name = name;
  298. return;
  299. }
  300. if (strcmp(interface, zxdg_exporter_v1_interface.name) == 0) {
  301. registry->xdg_exporter = (struct zxdg_exporter_v1 *)wl_registry_bind(wl_registry, name, &zxdg_exporter_v1_interface, 1);
  302. registry->xdg_exporter_name = name;
  303. return;
  304. }
  305. if (strcmp(interface, wl_compositor_interface.name) == 0) {
  306. registry->wl_compositor = (struct wl_compositor *)wl_registry_bind(wl_registry, name, &wl_compositor_interface, CLAMP((int)version, 1, 6));
  307. registry->wl_compositor_name = name;
  308. return;
  309. }
  310. if (strcmp(interface, wl_data_device_manager_interface.name) == 0) {
  311. registry->wl_data_device_manager = (struct wl_data_device_manager *)wl_registry_bind(wl_registry, name, &wl_data_device_manager_interface, CLAMP((int)version, 1, 3));
  312. registry->wl_data_device_manager_name = name;
  313. // This global creates some seat data. Let's do that for the ones already available.
  314. for (struct wl_seat *wl_seat : registry->wl_seats) {
  315. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  316. ERR_FAIL_NULL(ss);
  317. if (ss->wl_data_device == nullptr) {
  318. ss->wl_data_device = wl_data_device_manager_get_data_device(registry->wl_data_device_manager, wl_seat);
  319. wl_data_device_add_listener(ss->wl_data_device, &wl_data_device_listener, ss);
  320. }
  321. }
  322. return;
  323. }
  324. if (strcmp(interface, wl_output_interface.name) == 0) {
  325. struct wl_output *wl_output = (struct wl_output *)wl_registry_bind(wl_registry, name, &wl_output_interface, CLAMP((int)version, 1, 4));
  326. wl_proxy_tag_godot((struct wl_proxy *)wl_output);
  327. registry->wl_outputs.push_back(wl_output);
  328. ScreenState *ss = memnew(ScreenState);
  329. ss->wl_output_name = name;
  330. ss->wayland_thread = registry->wayland_thread;
  331. wl_proxy_tag_godot((struct wl_proxy *)wl_output);
  332. wl_output_add_listener(wl_output, &wl_output_listener, ss);
  333. return;
  334. }
  335. if (strcmp(interface, wl_seat_interface.name) == 0) {
  336. struct wl_seat *wl_seat = (struct wl_seat *)wl_registry_bind(wl_registry, name, &wl_seat_interface, CLAMP((int)version, 1, 9));
  337. wl_proxy_tag_godot((struct wl_proxy *)wl_seat);
  338. SeatState *ss = memnew(SeatState);
  339. ss->wl_seat = wl_seat;
  340. ss->wl_seat_name = name;
  341. ss->registry = registry;
  342. ss->wayland_thread = registry->wayland_thread;
  343. // Some extra stuff depends on other globals. We'll initialize them if the
  344. // globals are already there, otherwise we'll have to do that once and if they
  345. // get announced.
  346. //
  347. // NOTE: Don't forget to also bind/destroy with the respective global.
  348. if (!ss->wl_data_device && registry->wl_data_device_manager) {
  349. // Clipboard & DnD.
  350. ss->wl_data_device = wl_data_device_manager_get_data_device(registry->wl_data_device_manager, wl_seat);
  351. wl_data_device_add_listener(ss->wl_data_device, &wl_data_device_listener, ss);
  352. }
  353. if (!ss->wp_primary_selection_device && registry->wp_primary_selection_device_manager) {
  354. // Primary selection.
  355. ss->wp_primary_selection_device = zwp_primary_selection_device_manager_v1_get_device(registry->wp_primary_selection_device_manager, wl_seat);
  356. zwp_primary_selection_device_v1_add_listener(ss->wp_primary_selection_device, &wp_primary_selection_device_listener, ss);
  357. }
  358. if (!ss->wp_tablet_seat && registry->wp_tablet_manager) {
  359. // Tablet.
  360. ss->wp_tablet_seat = zwp_tablet_manager_v2_get_tablet_seat(registry->wp_tablet_manager, wl_seat);
  361. zwp_tablet_seat_v2_add_listener(ss->wp_tablet_seat, &wp_tablet_seat_listener, ss);
  362. }
  363. if (!ss->wp_text_input && registry->wp_text_input_manager) {
  364. // IME.
  365. ss->wp_text_input = zwp_text_input_manager_v3_get_text_input(registry->wp_text_input_manager, wl_seat);
  366. zwp_text_input_v3_add_listener(ss->wp_text_input, &wp_text_input_listener, ss);
  367. }
  368. registry->wl_seats.push_back(wl_seat);
  369. wl_seat_add_listener(wl_seat, &wl_seat_listener, ss);
  370. if (registry->wayland_thread->wl_seat_current == nullptr) {
  371. registry->wayland_thread->_set_current_seat(wl_seat);
  372. }
  373. return;
  374. }
  375. if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
  376. registry->xdg_wm_base = (struct xdg_wm_base *)wl_registry_bind(wl_registry, name, &xdg_wm_base_interface, CLAMP((int)version, 1, 6));
  377. registry->xdg_wm_base_name = name;
  378. xdg_wm_base_add_listener(registry->xdg_wm_base, &xdg_wm_base_listener, nullptr);
  379. return;
  380. }
  381. if (strcmp(interface, wp_viewporter_interface.name) == 0) {
  382. registry->wp_viewporter = (struct wp_viewporter *)wl_registry_bind(wl_registry, name, &wp_viewporter_interface, 1);
  383. registry->wp_viewporter_name = name;
  384. }
  385. if (strcmp(interface, wp_fractional_scale_manager_v1_interface.name) == 0) {
  386. registry->wp_fractional_scale_manager = (struct wp_fractional_scale_manager_v1 *)wl_registry_bind(wl_registry, name, &wp_fractional_scale_manager_v1_interface, 1);
  387. registry->wp_fractional_scale_manager_name = name;
  388. // NOTE: We're not mapping the fractional scale object here because this is
  389. // supposed to be a "startup global". If for some reason this isn't true (who
  390. // knows), add a conditional branch for creating the add-on object.
  391. }
  392. if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
  393. registry->xdg_decoration_manager = (struct zxdg_decoration_manager_v1 *)wl_registry_bind(wl_registry, name, &zxdg_decoration_manager_v1_interface, 1);
  394. registry->xdg_decoration_manager_name = name;
  395. return;
  396. }
  397. if (strcmp(interface, xdg_system_bell_v1_interface.name) == 0) {
  398. registry->xdg_system_bell = (struct xdg_system_bell_v1 *)wl_registry_bind(wl_registry, name, &xdg_system_bell_v1_interface, 1);
  399. registry->xdg_system_bell_name = name;
  400. return;
  401. }
  402. if (strcmp(interface, xdg_activation_v1_interface.name) == 0) {
  403. registry->xdg_activation = (struct xdg_activation_v1 *)wl_registry_bind(wl_registry, name, &xdg_activation_v1_interface, 1);
  404. registry->xdg_activation_name = name;
  405. return;
  406. }
  407. if (strcmp(interface, zwp_primary_selection_device_manager_v1_interface.name) == 0) {
  408. registry->wp_primary_selection_device_manager = (struct zwp_primary_selection_device_manager_v1 *)wl_registry_bind(wl_registry, name, &zwp_primary_selection_device_manager_v1_interface, 1);
  409. // This global creates some seat data. Let's do that for the ones already available.
  410. for (struct wl_seat *wl_seat : registry->wl_seats) {
  411. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  412. ERR_FAIL_NULL(ss);
  413. if (!ss->wp_primary_selection_device && registry->wp_primary_selection_device_manager) {
  414. ss->wp_primary_selection_device = zwp_primary_selection_device_manager_v1_get_device(registry->wp_primary_selection_device_manager, wl_seat);
  415. zwp_primary_selection_device_v1_add_listener(ss->wp_primary_selection_device, &wp_primary_selection_device_listener, ss);
  416. }
  417. }
  418. }
  419. if (strcmp(interface, zwp_relative_pointer_manager_v1_interface.name) == 0) {
  420. registry->wp_relative_pointer_manager = (struct zwp_relative_pointer_manager_v1 *)wl_registry_bind(wl_registry, name, &zwp_relative_pointer_manager_v1_interface, 1);
  421. registry->wp_relative_pointer_manager_name = name;
  422. return;
  423. }
  424. if (strcmp(interface, zwp_pointer_constraints_v1_interface.name) == 0) {
  425. registry->wp_pointer_constraints = (struct zwp_pointer_constraints_v1 *)wl_registry_bind(wl_registry, name, &zwp_pointer_constraints_v1_interface, 1);
  426. registry->wp_pointer_constraints_name = name;
  427. return;
  428. }
  429. if (strcmp(interface, zwp_pointer_gestures_v1_interface.name) == 0) {
  430. registry->wp_pointer_gestures = (struct zwp_pointer_gestures_v1 *)wl_registry_bind(wl_registry, name, &zwp_pointer_gestures_v1_interface, 1);
  431. registry->wp_pointer_gestures_name = name;
  432. return;
  433. }
  434. if (strcmp(interface, zwp_idle_inhibit_manager_v1_interface.name) == 0) {
  435. registry->wp_idle_inhibit_manager = (struct zwp_idle_inhibit_manager_v1 *)wl_registry_bind(wl_registry, name, &zwp_idle_inhibit_manager_v1_interface, 1);
  436. registry->wp_idle_inhibit_manager_name = name;
  437. return;
  438. }
  439. if (strcmp(interface, zwp_tablet_manager_v2_interface.name) == 0) {
  440. registry->wp_tablet_manager = (struct zwp_tablet_manager_v2 *)wl_registry_bind(wl_registry, name, &zwp_tablet_manager_v2_interface, 1);
  441. registry->wp_tablet_manager_name = name;
  442. // This global creates some seat data. Let's do that for the ones already available.
  443. for (struct wl_seat *wl_seat : registry->wl_seats) {
  444. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  445. ERR_FAIL_NULL(ss);
  446. ss->wp_tablet_seat = zwp_tablet_manager_v2_get_tablet_seat(registry->wp_tablet_manager, wl_seat);
  447. zwp_tablet_seat_v2_add_listener(ss->wp_tablet_seat, &wp_tablet_seat_listener, ss);
  448. }
  449. return;
  450. }
  451. if (strcmp(interface, zwp_text_input_manager_v3_interface.name) == 0) {
  452. registry->wp_text_input_manager = (struct zwp_text_input_manager_v3 *)wl_registry_bind(wl_registry, name, &zwp_text_input_manager_v3_interface, 1);
  453. registry->wp_text_input_manager_name = name;
  454. // This global creates some seat data. Let's do that for the ones already available.
  455. for (struct wl_seat *wl_seat : registry->wl_seats) {
  456. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  457. ERR_FAIL_NULL(ss);
  458. ss->wp_text_input = zwp_text_input_manager_v3_get_text_input(registry->wp_text_input_manager, wl_seat);
  459. zwp_text_input_v3_add_listener(ss->wp_text_input, &wp_text_input_listener, ss);
  460. }
  461. return;
  462. }
  463. }
  464. void WaylandThread::_wl_registry_on_global_remove(void *data, struct wl_registry *wl_registry, uint32_t name) {
  465. RegistryState *registry = (RegistryState *)data;
  466. ERR_FAIL_NULL(registry);
  467. if (name == registry->wl_shm_name) {
  468. if (registry->wl_shm) {
  469. wl_shm_destroy(registry->wl_shm);
  470. registry->wl_shm = nullptr;
  471. }
  472. registry->wl_shm_name = 0;
  473. return;
  474. }
  475. if (name == registry->xdg_exporter_name) {
  476. if (registry->xdg_exporter) {
  477. zxdg_exporter_v1_destroy(registry->xdg_exporter);
  478. registry->xdg_exporter = nullptr;
  479. }
  480. registry->xdg_exporter_name = 0;
  481. return;
  482. }
  483. if (name == registry->wl_compositor_name) {
  484. if (registry->wl_compositor) {
  485. wl_compositor_destroy(registry->wl_compositor);
  486. registry->wl_compositor = nullptr;
  487. }
  488. registry->wl_compositor_name = 0;
  489. return;
  490. }
  491. if (name == registry->wl_data_device_manager_name) {
  492. if (registry->wl_data_device_manager) {
  493. wl_data_device_manager_destroy(registry->wl_data_device_manager);
  494. registry->wl_data_device_manager = nullptr;
  495. }
  496. registry->wl_data_device_manager_name = 0;
  497. // This global is used to create some seat data. Let's clean it.
  498. for (struct wl_seat *wl_seat : registry->wl_seats) {
  499. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  500. ERR_FAIL_NULL(ss);
  501. if (ss->wl_data_device) {
  502. wl_data_device_destroy(ss->wl_data_device);
  503. ss->wl_data_device = nullptr;
  504. }
  505. ss->wl_data_device = nullptr;
  506. }
  507. return;
  508. }
  509. if (name == registry->xdg_wm_base_name) {
  510. if (registry->xdg_wm_base) {
  511. xdg_wm_base_destroy(registry->xdg_wm_base);
  512. registry->xdg_wm_base = nullptr;
  513. }
  514. registry->xdg_wm_base_name = 0;
  515. return;
  516. }
  517. if (name == registry->wp_viewporter_name) {
  518. WindowState *ws = &registry->wayland_thread->main_window;
  519. if (registry->wp_viewporter) {
  520. wp_viewporter_destroy(registry->wp_viewporter);
  521. registry->wp_viewporter = nullptr;
  522. }
  523. if (ws->wp_viewport) {
  524. wp_viewport_destroy(ws->wp_viewport);
  525. ws->wp_viewport = nullptr;
  526. }
  527. registry->wp_viewporter_name = 0;
  528. return;
  529. }
  530. if (name == registry->wp_fractional_scale_manager_name) {
  531. WindowState *ws = &registry->wayland_thread->main_window;
  532. if (registry->wp_fractional_scale_manager) {
  533. wp_fractional_scale_manager_v1_destroy(registry->wp_fractional_scale_manager);
  534. registry->wp_fractional_scale_manager = nullptr;
  535. }
  536. if (ws->wp_fractional_scale) {
  537. wp_fractional_scale_v1_destroy(ws->wp_fractional_scale);
  538. ws->wp_fractional_scale = nullptr;
  539. }
  540. registry->wp_fractional_scale_manager_name = 0;
  541. }
  542. if (name == registry->xdg_decoration_manager_name) {
  543. if (registry->xdg_decoration_manager) {
  544. zxdg_decoration_manager_v1_destroy(registry->xdg_decoration_manager);
  545. registry->xdg_decoration_manager = nullptr;
  546. }
  547. registry->xdg_decoration_manager_name = 0;
  548. return;
  549. }
  550. if (name == registry->xdg_system_bell_name) {
  551. if (registry->xdg_system_bell) {
  552. xdg_system_bell_v1_destroy(registry->xdg_system_bell);
  553. registry->xdg_system_bell = nullptr;
  554. }
  555. registry->xdg_system_bell_name = 0;
  556. return;
  557. }
  558. if (name == registry->xdg_activation_name) {
  559. if (registry->xdg_activation) {
  560. xdg_activation_v1_destroy(registry->xdg_activation);
  561. registry->xdg_activation = nullptr;
  562. }
  563. registry->xdg_activation_name = 0;
  564. return;
  565. }
  566. if (name == registry->wp_primary_selection_device_manager_name) {
  567. if (registry->wp_primary_selection_device_manager) {
  568. zwp_primary_selection_device_manager_v1_destroy(registry->wp_primary_selection_device_manager);
  569. registry->wp_primary_selection_device_manager = nullptr;
  570. }
  571. registry->wp_primary_selection_device_manager_name = 0;
  572. // This global is used to create some seat data. Let's clean it.
  573. for (struct wl_seat *wl_seat : registry->wl_seats) {
  574. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  575. ERR_FAIL_NULL(ss);
  576. if (ss->wp_primary_selection_device) {
  577. zwp_primary_selection_device_v1_destroy(ss->wp_primary_selection_device);
  578. ss->wp_primary_selection_device = nullptr;
  579. }
  580. if (ss->wp_primary_selection_source) {
  581. zwp_primary_selection_source_v1_destroy(ss->wp_primary_selection_source);
  582. ss->wp_primary_selection_source = nullptr;
  583. }
  584. if (ss->wp_primary_selection_offer) {
  585. memfree(wp_primary_selection_offer_get_offer_state(ss->wp_primary_selection_offer));
  586. zwp_primary_selection_offer_v1_destroy(ss->wp_primary_selection_offer);
  587. ss->wp_primary_selection_offer = nullptr;
  588. }
  589. }
  590. return;
  591. }
  592. if (name == registry->wp_relative_pointer_manager_name) {
  593. if (registry->wp_relative_pointer_manager) {
  594. zwp_relative_pointer_manager_v1_destroy(registry->wp_relative_pointer_manager);
  595. registry->wp_relative_pointer_manager = nullptr;
  596. }
  597. registry->wp_relative_pointer_manager_name = 0;
  598. // This global is used to create some seat data. Let's clean it.
  599. for (struct wl_seat *wl_seat : registry->wl_seats) {
  600. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  601. ERR_FAIL_NULL(ss);
  602. if (ss->wp_relative_pointer) {
  603. zwp_relative_pointer_v1_destroy(ss->wp_relative_pointer);
  604. ss->wp_relative_pointer = nullptr;
  605. }
  606. }
  607. return;
  608. }
  609. if (name == registry->wp_pointer_constraints_name) {
  610. if (registry->wp_pointer_constraints) {
  611. zwp_pointer_constraints_v1_destroy(registry->wp_pointer_constraints);
  612. registry->wp_pointer_constraints = nullptr;
  613. }
  614. registry->wp_pointer_constraints_name = 0;
  615. // This global is used to create some seat data. Let's clean it.
  616. for (struct wl_seat *wl_seat : registry->wl_seats) {
  617. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  618. ERR_FAIL_NULL(ss);
  619. if (ss->wp_relative_pointer) {
  620. zwp_relative_pointer_v1_destroy(ss->wp_relative_pointer);
  621. ss->wp_relative_pointer = nullptr;
  622. }
  623. if (ss->wp_locked_pointer) {
  624. zwp_locked_pointer_v1_destroy(ss->wp_locked_pointer);
  625. ss->wp_locked_pointer = nullptr;
  626. }
  627. if (ss->wp_confined_pointer) {
  628. zwp_confined_pointer_v1_destroy(ss->wp_confined_pointer);
  629. ss->wp_confined_pointer = nullptr;
  630. }
  631. }
  632. return;
  633. }
  634. if (name == registry->wp_pointer_gestures_name) {
  635. if (registry->wp_pointer_gestures) {
  636. zwp_pointer_gestures_v1_destroy(registry->wp_pointer_gestures);
  637. }
  638. registry->wp_pointer_gestures = nullptr;
  639. registry->wp_pointer_gestures_name = 0;
  640. // This global is used to create some seat data. Let's clean it.
  641. for (struct wl_seat *wl_seat : registry->wl_seats) {
  642. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  643. ERR_FAIL_NULL(ss);
  644. if (ss->wp_pointer_gesture_pinch) {
  645. zwp_pointer_gesture_pinch_v1_destroy(ss->wp_pointer_gesture_pinch);
  646. ss->wp_pointer_gesture_pinch = nullptr;
  647. }
  648. }
  649. return;
  650. }
  651. if (name == registry->wp_idle_inhibit_manager_name) {
  652. if (registry->wp_idle_inhibit_manager) {
  653. zwp_idle_inhibit_manager_v1_destroy(registry->wp_idle_inhibit_manager);
  654. registry->wp_idle_inhibit_manager = nullptr;
  655. }
  656. registry->wp_idle_inhibit_manager_name = 0;
  657. return;
  658. }
  659. if (name == registry->wp_tablet_manager_name) {
  660. if (registry->wp_tablet_manager) {
  661. zwp_tablet_manager_v2_destroy(registry->wp_tablet_manager);
  662. registry->wp_tablet_manager = nullptr;
  663. }
  664. registry->wp_tablet_manager_name = 0;
  665. // This global is used to create some seat data. Let's clean it.
  666. for (struct wl_seat *wl_seat : registry->wl_seats) {
  667. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  668. ERR_FAIL_NULL(ss);
  669. for (struct zwp_tablet_tool_v2 *tool : ss->tablet_tools) {
  670. TabletToolState *state = wp_tablet_tool_get_state(tool);
  671. if (state) {
  672. memdelete(state);
  673. }
  674. zwp_tablet_tool_v2_destroy(tool);
  675. }
  676. ss->tablet_tools.clear();
  677. }
  678. return;
  679. }
  680. if (name == registry->wp_text_input_manager_name) {
  681. if (registry->wp_text_input_manager) {
  682. zwp_text_input_manager_v3_destroy(registry->wp_text_input_manager);
  683. registry->wp_text_input_manager = nullptr;
  684. }
  685. registry->wp_text_input_manager_name = 0;
  686. for (struct wl_seat *wl_seat : registry->wl_seats) {
  687. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  688. ERR_FAIL_NULL(ss);
  689. zwp_text_input_v3_destroy(ss->wp_text_input);
  690. ss->wp_text_input = nullptr;
  691. }
  692. return;
  693. }
  694. {
  695. // Iterate through all of the seats to find if any got removed.
  696. List<struct wl_seat *>::Element *E = registry->wl_seats.front();
  697. while (E) {
  698. struct wl_seat *wl_seat = E->get();
  699. List<struct wl_seat *>::Element *N = E->next();
  700. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  701. ERR_FAIL_NULL(ss);
  702. if (ss->wl_seat_name == name) {
  703. if (wl_seat) {
  704. wl_seat_destroy(wl_seat);
  705. }
  706. if (ss->wl_data_device) {
  707. wl_data_device_destroy(ss->wl_data_device);
  708. }
  709. if (ss->wp_tablet_seat) {
  710. zwp_tablet_seat_v2_destroy(ss->wp_tablet_seat);
  711. for (struct zwp_tablet_tool_v2 *tool : ss->tablet_tools) {
  712. TabletToolState *state = wp_tablet_tool_get_state(tool);
  713. if (state) {
  714. memdelete(state);
  715. }
  716. zwp_tablet_tool_v2_destroy(tool);
  717. }
  718. }
  719. memdelete(ss);
  720. registry->wl_seats.erase(E);
  721. return;
  722. }
  723. E = N;
  724. }
  725. }
  726. {
  727. // Iterate through all of the outputs to find if any got removed.
  728. // FIXME: This is a very bruteforce approach.
  729. List<struct wl_output *>::Element *it = registry->wl_outputs.front();
  730. while (it) {
  731. // Iterate through all of the screens to find if any got removed.
  732. struct wl_output *wl_output = it->get();
  733. ERR_FAIL_NULL(wl_output);
  734. ScreenState *ss = wl_output_get_screen_state(wl_output);
  735. if (ss->wl_output_name == name) {
  736. registry->wl_outputs.erase(it);
  737. memdelete(ss);
  738. wl_output_destroy(wl_output);
  739. return;
  740. }
  741. it = it->next();
  742. }
  743. }
  744. }
  745. void WaylandThread::_wl_surface_on_enter(void *data, struct wl_surface *wl_surface, struct wl_output *wl_output) {
  746. if (!wl_output || !wl_proxy_is_godot((struct wl_proxy *)wl_output)) {
  747. // This won't have the right data bound to it. Not worth it and would probably
  748. // just break everything.
  749. return;
  750. }
  751. WindowState *ws = (WindowState *)data;
  752. ERR_FAIL_NULL(ws);
  753. DEBUG_LOG_WAYLAND_THREAD(vformat("Window entered output %x.\n", (size_t)wl_output));
  754. ws->wl_outputs.insert(wl_output);
  755. // Workaround for buffer scaling as there's no guaranteed way of knowing the
  756. // preferred scale.
  757. // TODO: Skip this branch for newer `wl_surface`s once we add support for
  758. // `wl_surface::preferred_buffer_scale`
  759. if (ws->preferred_fractional_scale == 0) {
  760. window_state_update_size(ws, ws->rect.size.width, ws->rect.size.height);
  761. }
  762. }
  763. void WaylandThread::_frame_wl_callback_on_done(void *data, struct wl_callback *wl_callback, uint32_t callback_data) {
  764. wl_callback_destroy(wl_callback);
  765. WindowState *ws = (WindowState *)data;
  766. ERR_FAIL_NULL(ws);
  767. ERR_FAIL_NULL(ws->wayland_thread);
  768. ERR_FAIL_NULL(ws->wl_surface);
  769. ws->wayland_thread->set_frame();
  770. ws->frame_callback = wl_surface_frame(ws->wl_surface),
  771. wl_callback_add_listener(ws->frame_callback, &frame_wl_callback_listener, ws);
  772. if (ws->wl_surface && ws->buffer_scale_changed) {
  773. // NOTE: We're only now setting the buffer scale as the idea is to get this
  774. // data committed together with the new frame, all by the rendering driver.
  775. // This is important because we might otherwise set an invalid combination of
  776. // buffer size and scale (e.g. odd size and 2x scale). We're pretty much
  777. // guaranteed to get a proper buffer in the next render loop as the rescaling
  778. // method also informs the engine of a "window rect change", triggering
  779. // rendering if needed.
  780. wl_surface_set_buffer_scale(ws->wl_surface, window_state_get_preferred_buffer_scale(ws));
  781. }
  782. }
  783. void WaylandThread::_wl_surface_on_leave(void *data, struct wl_surface *wl_surface, struct wl_output *wl_output) {
  784. if (!wl_output || !wl_proxy_is_godot((struct wl_proxy *)wl_output)) {
  785. // This won't have the right data bound to it. Not worth it and would probably
  786. // just break everything.
  787. return;
  788. }
  789. WindowState *ws = (WindowState *)data;
  790. ERR_FAIL_NULL(ws);
  791. ws->wl_outputs.erase(wl_output);
  792. DEBUG_LOG_WAYLAND_THREAD(vformat("Window left output %x.\n", (size_t)wl_output));
  793. }
  794. // TODO: Add support to this event.
  795. void WaylandThread::_wl_surface_on_preferred_buffer_scale(void *data, struct wl_surface *wl_surface, int32_t factor) {
  796. }
  797. // TODO: Add support to this event.
  798. void WaylandThread::_wl_surface_on_preferred_buffer_transform(void *data, struct wl_surface *wl_surface, uint32_t transform) {
  799. }
  800. void WaylandThread::_wl_output_on_geometry(void *data, struct wl_output *wl_output, int32_t x, int32_t y, int32_t physical_width, int32_t physical_height, int32_t subpixel, const char *make, const char *model, int32_t transform) {
  801. ScreenState *ss = (ScreenState *)data;
  802. ERR_FAIL_NULL(ss);
  803. ss->pending_data.position.x = x;
  804. ss->pending_data.position.x = x;
  805. ss->pending_data.position.y = y;
  806. ss->pending_data.physical_size.width = physical_width;
  807. ss->pending_data.physical_size.height = physical_height;
  808. ss->pending_data.make.parse_utf8(make);
  809. ss->pending_data.model.parse_utf8(model);
  810. // `wl_output::done` is a version 2 addition. We'll directly update the data
  811. // for compatibility.
  812. if (wl_output_get_version(wl_output) == 1) {
  813. ss->data = ss->pending_data;
  814. }
  815. }
  816. void WaylandThread::_wl_output_on_mode(void *data, struct wl_output *wl_output, uint32_t flags, int32_t width, int32_t height, int32_t refresh) {
  817. ScreenState *ss = (ScreenState *)data;
  818. ERR_FAIL_NULL(ss);
  819. ss->pending_data.size.width = width;
  820. ss->pending_data.size.height = height;
  821. ss->pending_data.refresh_rate = refresh ? refresh / 1000.0f : -1;
  822. // `wl_output::done` is a version 2 addition. We'll directly update the data
  823. // for compatibility.
  824. if (wl_output_get_version(wl_output) == 1) {
  825. ss->data = ss->pending_data;
  826. }
  827. }
  828. // NOTE: The following `wl_output` events are only for version 2 onwards, so we
  829. // can assume that they're "atomic" (i.e. rely on the `wl_output::done` event).
  830. void WaylandThread::_wl_output_on_done(void *data, struct wl_output *wl_output) {
  831. ScreenState *ss = (ScreenState *)data;
  832. ERR_FAIL_NULL(ss);
  833. ss->data = ss->pending_data;
  834. ss->wayland_thread->_update_scale(ss->data.scale);
  835. DEBUG_LOG_WAYLAND_THREAD(vformat("Output %x done.", (size_t)wl_output));
  836. }
  837. void WaylandThread::_wl_output_on_scale(void *data, struct wl_output *wl_output, int32_t factor) {
  838. ScreenState *ss = (ScreenState *)data;
  839. ERR_FAIL_NULL(ss);
  840. ss->pending_data.scale = factor;
  841. DEBUG_LOG_WAYLAND_THREAD(vformat("Output %x scale %d", (size_t)wl_output, factor));
  842. }
  843. void WaylandThread::_wl_output_on_name(void *data, struct wl_output *wl_output, const char *name) {
  844. }
  845. void WaylandThread::_wl_output_on_description(void *data, struct wl_output *wl_output, const char *description) {
  846. }
  847. void WaylandThread::_xdg_wm_base_on_ping(void *data, struct xdg_wm_base *xdg_wm_base, uint32_t serial) {
  848. xdg_wm_base_pong(xdg_wm_base, serial);
  849. }
  850. void WaylandThread::_xdg_surface_on_configure(void *data, struct xdg_surface *xdg_surface, uint32_t serial) {
  851. xdg_surface_ack_configure(xdg_surface, serial);
  852. WindowState *ws = (WindowState *)data;
  853. ERR_FAIL_NULL(ws);
  854. DEBUG_LOG_WAYLAND_THREAD(vformat("xdg surface on configure width %d height %d", ws->rect.size.width, ws->rect.size.height));
  855. }
  856. void WaylandThread::_xdg_toplevel_on_configure(void *data, struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height, struct wl_array *states) {
  857. WindowState *ws = (WindowState *)data;
  858. ERR_FAIL_NULL(ws);
  859. // Expect the window to be in a plain state. It will get properly set if the
  860. // compositor reports otherwise below.
  861. ws->mode = DisplayServer::WINDOW_MODE_WINDOWED;
  862. ws->suspended = false;
  863. uint32_t *state = nullptr;
  864. wl_array_for_each(state, states) {
  865. switch (*state) {
  866. case XDG_TOPLEVEL_STATE_MAXIMIZED: {
  867. ws->mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
  868. } break;
  869. case XDG_TOPLEVEL_STATE_FULLSCREEN: {
  870. ws->mode = DisplayServer::WINDOW_MODE_FULLSCREEN;
  871. } break;
  872. case XDG_TOPLEVEL_STATE_SUSPENDED: {
  873. ws->suspended = true;
  874. } break;
  875. default: {
  876. // We don't care about the other states (for now).
  877. } break;
  878. }
  879. }
  880. if (width != 0 && height != 0) {
  881. window_state_update_size(ws, width, height);
  882. }
  883. DEBUG_LOG_WAYLAND_THREAD(vformat("XDG toplevel on configure width %d height %d.", width, height));
  884. }
  885. void WaylandThread::_xdg_toplevel_on_close(void *data, struct xdg_toplevel *xdg_toplevel) {
  886. WindowState *ws = (WindowState *)data;
  887. ERR_FAIL_NULL(ws);
  888. Ref<WindowEventMessage> msg;
  889. msg.instantiate();
  890. msg->event = DisplayServer::WINDOW_EVENT_CLOSE_REQUEST;
  891. ws->wayland_thread->push_message(msg);
  892. }
  893. void WaylandThread::_xdg_toplevel_on_configure_bounds(void *data, struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height) {
  894. }
  895. void WaylandThread::_xdg_toplevel_on_wm_capabilities(void *data, struct xdg_toplevel *xdg_toplevel, struct wl_array *capabilities) {
  896. WindowState *ws = (WindowState *)data;
  897. ERR_FAIL_NULL(ws);
  898. ws->can_maximize = false;
  899. ws->can_fullscreen = false;
  900. ws->can_minimize = false;
  901. uint32_t *capability = nullptr;
  902. wl_array_for_each(capability, capabilities) {
  903. switch (*capability) {
  904. case XDG_TOPLEVEL_WM_CAPABILITIES_MAXIMIZE: {
  905. ws->can_maximize = true;
  906. } break;
  907. case XDG_TOPLEVEL_WM_CAPABILITIES_FULLSCREEN: {
  908. ws->can_fullscreen = true;
  909. } break;
  910. case XDG_TOPLEVEL_WM_CAPABILITIES_MINIMIZE: {
  911. ws->can_minimize = true;
  912. } break;
  913. default: {
  914. } break;
  915. }
  916. }
  917. }
  918. void WaylandThread::_xdg_exported_on_exported(void *data, zxdg_exported_v1 *exported, const char *handle) {
  919. WindowState *ws = (WindowState *)data;
  920. ERR_FAIL_NULL(ws);
  921. ws->exported_handle = vformat("wayland:%s", String::utf8(handle));
  922. }
  923. void WaylandThread::_xdg_toplevel_decoration_on_configure(void *data, struct zxdg_toplevel_decoration_v1 *xdg_toplevel_decoration, uint32_t mode) {
  924. if (mode == ZXDG_TOPLEVEL_DECORATION_V1_MODE_CLIENT_SIDE) {
  925. #ifdef LIBDECOR_ENABLED
  926. WARN_PRINT_ONCE("Native client side decorations are not yet supported without libdecor!");
  927. #else
  928. WARN_PRINT_ONCE("Native client side decorations are not yet supported!");
  929. #endif // LIBDECOR_ENABLED
  930. }
  931. }
  932. #ifdef LIBDECOR_ENABLED
  933. void WaylandThread::libdecor_on_error(struct libdecor *context, enum libdecor_error error, const char *message) {
  934. ERR_PRINT(vformat("libdecor error %d: %s", error, message));
  935. }
  936. // NOTE: This is pretty much a reimplementation of _xdg_surface_on_configure
  937. // and _xdg_toplevel_on_configure. Libdecor really likes wrapping everything,
  938. // forcing us to do stuff like this.
  939. void WaylandThread::libdecor_frame_on_configure(struct libdecor_frame *frame, struct libdecor_configuration *configuration, void *user_data) {
  940. WindowState *ws = (WindowState *)user_data;
  941. ERR_FAIL_NULL(ws);
  942. int width = 0;
  943. int height = 0;
  944. ws->pending_libdecor_configuration = configuration;
  945. if (!libdecor_configuration_get_content_size(configuration, frame, &width, &height)) {
  946. // The configuration doesn't have a size. We'll use the one already set in the window.
  947. width = ws->rect.size.width;
  948. height = ws->rect.size.height;
  949. }
  950. ERR_FAIL_COND_MSG(width == 0 || height == 0, "Window has invalid size.");
  951. libdecor_window_state window_state = LIBDECOR_WINDOW_STATE_NONE;
  952. // Expect the window to be in a plain state. It will get properly set if the
  953. // compositor reports otherwise below.
  954. ws->mode = DisplayServer::WINDOW_MODE_WINDOWED;
  955. ws->suspended = false;
  956. if (libdecor_configuration_get_window_state(configuration, &window_state)) {
  957. if (window_state & LIBDECOR_WINDOW_STATE_MAXIMIZED) {
  958. ws->mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
  959. }
  960. if (window_state & LIBDECOR_WINDOW_STATE_FULLSCREEN) {
  961. ws->mode = DisplayServer::WINDOW_MODE_FULLSCREEN;
  962. }
  963. if (window_state & LIBDECOR_WINDOW_STATE_SUSPENDED) {
  964. ws->suspended = true;
  965. }
  966. }
  967. window_state_update_size(ws, width, height);
  968. DEBUG_LOG_WAYLAND_THREAD(vformat("libdecor frame on configure rect %s", ws->rect));
  969. }
  970. void WaylandThread::libdecor_frame_on_close(struct libdecor_frame *frame, void *user_data) {
  971. WindowState *ws = (WindowState *)user_data;
  972. ERR_FAIL_NULL(ws);
  973. Ref<WindowEventMessage> winevent_msg;
  974. winevent_msg.instantiate();
  975. winevent_msg->event = DisplayServer::WINDOW_EVENT_CLOSE_REQUEST;
  976. ws->wayland_thread->push_message(winevent_msg);
  977. DEBUG_LOG_WAYLAND_THREAD("libdecor frame on close");
  978. }
  979. void WaylandThread::libdecor_frame_on_commit(struct libdecor_frame *frame, void *user_data) {
  980. // We're skipping this as we don't really care about libdecor's commit for
  981. // atomicity reasons. See `_frame_wl_callback_on_done` for more info.
  982. DEBUG_LOG_WAYLAND_THREAD("libdecor frame on commit");
  983. }
  984. void WaylandThread::libdecor_frame_on_dismiss_popup(struct libdecor_frame *frame, const char *seat_name, void *user_data) {
  985. }
  986. #endif // LIBDECOR_ENABLED
  987. void WaylandThread::_wl_seat_on_capabilities(void *data, struct wl_seat *wl_seat, uint32_t capabilities) {
  988. SeatState *ss = (SeatState *)data;
  989. ERR_FAIL_NULL(ss);
  990. // TODO: Handle touch.
  991. // Pointer handling.
  992. if (capabilities & WL_SEAT_CAPABILITY_POINTER) {
  993. if (!ss->wl_pointer) {
  994. ss->cursor_surface = wl_compositor_create_surface(ss->registry->wl_compositor);
  995. wl_surface_commit(ss->cursor_surface);
  996. ss->wl_pointer = wl_seat_get_pointer(wl_seat);
  997. wl_pointer_add_listener(ss->wl_pointer, &wl_pointer_listener, ss);
  998. if (ss->registry->wp_relative_pointer_manager) {
  999. ss->wp_relative_pointer = zwp_relative_pointer_manager_v1_get_relative_pointer(ss->registry->wp_relative_pointer_manager, ss->wl_pointer);
  1000. zwp_relative_pointer_v1_add_listener(ss->wp_relative_pointer, &wp_relative_pointer_listener, ss);
  1001. }
  1002. if (ss->registry->wp_pointer_gestures) {
  1003. ss->wp_pointer_gesture_pinch = zwp_pointer_gestures_v1_get_pinch_gesture(ss->registry->wp_pointer_gestures, ss->wl_pointer);
  1004. zwp_pointer_gesture_pinch_v1_add_listener(ss->wp_pointer_gesture_pinch, &wp_pointer_gesture_pinch_listener, ss);
  1005. }
  1006. // TODO: Constrain new pointers if the global mouse mode is constrained.
  1007. }
  1008. } else {
  1009. if (ss->cursor_frame_callback) {
  1010. // Just in case. I got bitten by weird race-like conditions already.
  1011. wl_callback_set_user_data(ss->cursor_frame_callback, nullptr);
  1012. wl_callback_destroy(ss->cursor_frame_callback);
  1013. ss->cursor_frame_callback = nullptr;
  1014. }
  1015. if (ss->cursor_surface) {
  1016. wl_surface_destroy(ss->cursor_surface);
  1017. ss->cursor_surface = nullptr;
  1018. }
  1019. if (ss->wl_pointer) {
  1020. wl_pointer_destroy(ss->wl_pointer);
  1021. ss->wl_pointer = nullptr;
  1022. }
  1023. if (ss->wp_relative_pointer) {
  1024. zwp_relative_pointer_v1_destroy(ss->wp_relative_pointer);
  1025. ss->wp_relative_pointer = nullptr;
  1026. }
  1027. if (ss->wp_confined_pointer) {
  1028. zwp_confined_pointer_v1_destroy(ss->wp_confined_pointer);
  1029. ss->wp_confined_pointer = nullptr;
  1030. }
  1031. if (ss->wp_locked_pointer) {
  1032. zwp_locked_pointer_v1_destroy(ss->wp_locked_pointer);
  1033. ss->wp_locked_pointer = nullptr;
  1034. }
  1035. }
  1036. // Keyboard handling.
  1037. if (capabilities & WL_SEAT_CAPABILITY_KEYBOARD) {
  1038. if (!ss->wl_keyboard) {
  1039. ss->xkb_context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
  1040. ERR_FAIL_NULL(ss->xkb_context);
  1041. ss->wl_keyboard = wl_seat_get_keyboard(wl_seat);
  1042. wl_keyboard_add_listener(ss->wl_keyboard, &wl_keyboard_listener, ss);
  1043. }
  1044. } else {
  1045. if (ss->xkb_context) {
  1046. xkb_context_unref(ss->xkb_context);
  1047. ss->xkb_context = nullptr;
  1048. }
  1049. if (ss->wl_keyboard) {
  1050. wl_keyboard_destroy(ss->wl_keyboard);
  1051. ss->wl_keyboard = nullptr;
  1052. }
  1053. }
  1054. }
  1055. void WaylandThread::_wl_seat_on_name(void *data, struct wl_seat *wl_seat, const char *name) {
  1056. }
  1057. void WaylandThread::_cursor_frame_callback_on_done(void *data, struct wl_callback *wl_callback, uint32_t time_ms) {
  1058. wl_callback_destroy(wl_callback);
  1059. SeatState *ss = (SeatState *)data;
  1060. ERR_FAIL_NULL(ss);
  1061. ss->cursor_frame_callback = nullptr;
  1062. ss->cursor_time_ms = time_ms;
  1063. seat_state_update_cursor(ss);
  1064. }
  1065. void WaylandThread::_wl_pointer_on_enter(void *data, struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t surface_x, wl_fixed_t surface_y) {
  1066. if (!surface || !wl_proxy_is_godot((struct wl_proxy *)surface)) {
  1067. return;
  1068. }
  1069. DEBUG_LOG_WAYLAND_THREAD("Pointing window.");
  1070. SeatState *ss = (SeatState *)data;
  1071. ERR_FAIL_NULL(ss);
  1072. ERR_FAIL_NULL(ss->cursor_surface);
  1073. ss->pointer_enter_serial = serial;
  1074. ss->pointed_surface = surface;
  1075. ss->last_pointed_surface = surface;
  1076. seat_state_update_cursor(ss);
  1077. Ref<WindowEventMessage> msg;
  1078. msg.instantiate();
  1079. msg->event = DisplayServer::WINDOW_EVENT_MOUSE_ENTER;
  1080. ss->wayland_thread->push_message(msg);
  1081. }
  1082. void WaylandThread::_wl_pointer_on_leave(void *data, struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface) {
  1083. if (!surface || !wl_proxy_is_godot((struct wl_proxy *)surface)) {
  1084. return;
  1085. }
  1086. DEBUG_LOG_WAYLAND_THREAD("Left window.");
  1087. SeatState *ss = (SeatState *)data;
  1088. ERR_FAIL_NULL(ss);
  1089. WaylandThread *wayland_thread = ss->wayland_thread;
  1090. ERR_FAIL_NULL(wayland_thread);
  1091. ss->pointed_surface = nullptr;
  1092. ss->pointer_data_buffer.pressed_button_mask.clear();
  1093. Ref<WindowEventMessage> msg;
  1094. msg.instantiate();
  1095. msg->event = DisplayServer::WINDOW_EVENT_MOUSE_EXIT;
  1096. wayland_thread->push_message(msg);
  1097. }
  1098. void WaylandThread::_wl_pointer_on_motion(void *data, struct wl_pointer *wl_pointer, uint32_t time, wl_fixed_t surface_x, wl_fixed_t surface_y) {
  1099. SeatState *ss = (SeatState *)data;
  1100. ERR_FAIL_NULL(ss);
  1101. if (!ss->pointed_surface) {
  1102. // We're probably on a decoration or some other third-party thing.
  1103. return;
  1104. }
  1105. WindowState *ws = wl_surface_get_window_state(ss->pointed_surface);
  1106. ERR_FAIL_NULL(ws);
  1107. PointerData &pd = ss->pointer_data_buffer;
  1108. // TODO: Scale only when sending the Wayland message.
  1109. pd.position.x = wl_fixed_to_double(surface_x);
  1110. pd.position.y = wl_fixed_to_double(surface_y);
  1111. pd.position *= window_state_get_scale_factor(ws);
  1112. pd.motion_time = time;
  1113. }
  1114. void WaylandThread::_wl_pointer_on_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button, uint32_t state) {
  1115. SeatState *ss = (SeatState *)data;
  1116. ERR_FAIL_NULL(ss);
  1117. if (!ss->pointed_surface) {
  1118. // We're probably on a decoration or some other third-party thing.
  1119. return;
  1120. }
  1121. PointerData &pd = ss->pointer_data_buffer;
  1122. MouseButton button_pressed = MouseButton::NONE;
  1123. switch (button) {
  1124. case BTN_LEFT:
  1125. button_pressed = MouseButton::LEFT;
  1126. break;
  1127. case BTN_MIDDLE:
  1128. button_pressed = MouseButton::MIDDLE;
  1129. break;
  1130. case BTN_RIGHT:
  1131. button_pressed = MouseButton::RIGHT;
  1132. break;
  1133. case BTN_EXTRA:
  1134. button_pressed = MouseButton::MB_XBUTTON1;
  1135. break;
  1136. case BTN_SIDE:
  1137. button_pressed = MouseButton::MB_XBUTTON2;
  1138. break;
  1139. default: {
  1140. }
  1141. }
  1142. MouseButtonMask mask = mouse_button_to_mask(button_pressed);
  1143. if (state & WL_POINTER_BUTTON_STATE_PRESSED) {
  1144. pd.pressed_button_mask.set_flag(mask);
  1145. pd.last_button_pressed = button_pressed;
  1146. pd.double_click_begun = true;
  1147. } else {
  1148. pd.pressed_button_mask.clear_flag(mask);
  1149. }
  1150. pd.button_time = time;
  1151. pd.button_serial = serial;
  1152. }
  1153. void WaylandThread::_wl_pointer_on_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {
  1154. SeatState *ss = (SeatState *)data;
  1155. ERR_FAIL_NULL(ss);
  1156. if (!ss->pointed_surface) {
  1157. // We're probably on a decoration or some other third-party thing.
  1158. return;
  1159. }
  1160. PointerData &pd = ss->pointer_data_buffer;
  1161. switch (axis) {
  1162. case WL_POINTER_AXIS_VERTICAL_SCROLL: {
  1163. pd.scroll_vector.y = wl_fixed_to_double(value);
  1164. } break;
  1165. case WL_POINTER_AXIS_HORIZONTAL_SCROLL: {
  1166. pd.scroll_vector.x = wl_fixed_to_double(value);
  1167. } break;
  1168. }
  1169. pd.button_time = time;
  1170. }
  1171. void WaylandThread::_wl_pointer_on_frame(void *data, struct wl_pointer *wl_pointer) {
  1172. SeatState *ss = (SeatState *)data;
  1173. ERR_FAIL_NULL(ss);
  1174. if (!ss->pointed_surface) {
  1175. // We're probably on a decoration or some other third-party thing.
  1176. return;
  1177. }
  1178. WaylandThread *wayland_thread = ss->wayland_thread;
  1179. ERR_FAIL_NULL(wayland_thread);
  1180. wayland_thread->_set_current_seat(ss->wl_seat);
  1181. PointerData &old_pd = ss->pointer_data;
  1182. PointerData &pd = ss->pointer_data_buffer;
  1183. if (old_pd.motion_time != pd.motion_time || old_pd.relative_motion_time != pd.relative_motion_time) {
  1184. Ref<InputEventMouseMotion> mm;
  1185. mm.instantiate();
  1186. // Set all pressed modifiers.
  1187. mm->set_shift_pressed(ss->shift_pressed);
  1188. mm->set_ctrl_pressed(ss->ctrl_pressed);
  1189. mm->set_alt_pressed(ss->alt_pressed);
  1190. mm->set_meta_pressed(ss->meta_pressed);
  1191. mm->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1192. mm->set_button_mask(pd.pressed_button_mask);
  1193. mm->set_position(pd.position);
  1194. mm->set_global_position(pd.position);
  1195. Vector2 pos_delta = pd.position - old_pd.position;
  1196. if (old_pd.relative_motion_time != pd.relative_motion_time) {
  1197. uint32_t time_delta = pd.relative_motion_time - old_pd.relative_motion_time;
  1198. mm->set_relative(pd.relative_motion);
  1199. mm->set_velocity((Vector2)pos_delta / time_delta);
  1200. } else {
  1201. // The spec includes the possibility of having motion events without an
  1202. // associated relative motion event. If that's the case, fallback to a
  1203. // simple delta of the position. The captured mouse won't report the
  1204. // relative speed anymore though.
  1205. uint32_t time_delta = pd.motion_time - old_pd.motion_time;
  1206. mm->set_relative(pd.position - old_pd.position);
  1207. mm->set_velocity((Vector2)pos_delta / time_delta);
  1208. }
  1209. mm->set_relative_screen_position(mm->get_relative());
  1210. mm->set_screen_velocity(mm->get_velocity());
  1211. Ref<InputEventMessage> msg;
  1212. msg.instantiate();
  1213. msg->event = mm;
  1214. wayland_thread->push_message(msg);
  1215. }
  1216. if (pd.discrete_scroll_vector_120 - old_pd.discrete_scroll_vector_120 != Vector2i()) {
  1217. // This is a discrete scroll (eg. from a scroll wheel), so we'll just emit
  1218. // scroll wheel buttons.
  1219. if (pd.scroll_vector.y != 0) {
  1220. MouseButton button = pd.scroll_vector.y > 0 ? MouseButton::WHEEL_DOWN : MouseButton::WHEEL_UP;
  1221. pd.pressed_button_mask.set_flag(mouse_button_to_mask(button));
  1222. }
  1223. if (pd.scroll_vector.x != 0) {
  1224. MouseButton button = pd.scroll_vector.x > 0 ? MouseButton::WHEEL_RIGHT : MouseButton::WHEEL_LEFT;
  1225. pd.pressed_button_mask.set_flag(mouse_button_to_mask(button));
  1226. }
  1227. } else {
  1228. if (pd.scroll_vector - old_pd.scroll_vector != Vector2()) {
  1229. // This is a continuous scroll, so we'll emit a pan gesture.
  1230. Ref<InputEventPanGesture> pg;
  1231. pg.instantiate();
  1232. // Set all pressed modifiers.
  1233. pg->set_shift_pressed(ss->shift_pressed);
  1234. pg->set_ctrl_pressed(ss->ctrl_pressed);
  1235. pg->set_alt_pressed(ss->alt_pressed);
  1236. pg->set_meta_pressed(ss->meta_pressed);
  1237. pg->set_position(pd.position);
  1238. pg->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1239. pg->set_delta(pd.scroll_vector);
  1240. Ref<InputEventMessage> msg;
  1241. msg.instantiate();
  1242. msg->event = pg;
  1243. wayland_thread->push_message(msg);
  1244. }
  1245. }
  1246. if (old_pd.pressed_button_mask != pd.pressed_button_mask) {
  1247. BitField<MouseButtonMask> pressed_mask_delta = old_pd.pressed_button_mask ^ pd.pressed_button_mask;
  1248. const MouseButton buttons_to_test[] = {
  1249. MouseButton::LEFT,
  1250. MouseButton::MIDDLE,
  1251. MouseButton::RIGHT,
  1252. MouseButton::WHEEL_UP,
  1253. MouseButton::WHEEL_DOWN,
  1254. MouseButton::WHEEL_LEFT,
  1255. MouseButton::WHEEL_RIGHT,
  1256. MouseButton::MB_XBUTTON1,
  1257. MouseButton::MB_XBUTTON2,
  1258. };
  1259. for (MouseButton test_button : buttons_to_test) {
  1260. MouseButtonMask test_button_mask = mouse_button_to_mask(test_button);
  1261. if (pressed_mask_delta.has_flag(test_button_mask)) {
  1262. Ref<InputEventMouseButton> mb;
  1263. mb.instantiate();
  1264. // Set all pressed modifiers.
  1265. mb->set_shift_pressed(ss->shift_pressed);
  1266. mb->set_ctrl_pressed(ss->ctrl_pressed);
  1267. mb->set_alt_pressed(ss->alt_pressed);
  1268. mb->set_meta_pressed(ss->meta_pressed);
  1269. mb->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1270. mb->set_position(pd.position);
  1271. mb->set_global_position(pd.position);
  1272. if (test_button == MouseButton::WHEEL_UP || test_button == MouseButton::WHEEL_DOWN) {
  1273. // If this is a discrete scroll, specify how many "clicks" it did for this
  1274. // pointer frame.
  1275. mb->set_factor(Math::abs(pd.discrete_scroll_vector_120.y / (float)120));
  1276. }
  1277. if (test_button == MouseButton::WHEEL_RIGHT || test_button == MouseButton::WHEEL_LEFT) {
  1278. // If this is a discrete scroll, specify how many "clicks" it did for this
  1279. // pointer frame.
  1280. mb->set_factor(fabs(pd.discrete_scroll_vector_120.x / (float)120));
  1281. }
  1282. mb->set_button_mask(pd.pressed_button_mask);
  1283. mb->set_button_index(test_button);
  1284. mb->set_pressed(pd.pressed_button_mask.has_flag(test_button_mask));
  1285. // We have to set the last position pressed here as we can't take for
  1286. // granted what the individual events might have seen due to them not having
  1287. // a guaranteed order.
  1288. if (mb->is_pressed()) {
  1289. pd.last_pressed_position = pd.position;
  1290. }
  1291. if (old_pd.double_click_begun && mb->is_pressed() && pd.last_button_pressed == old_pd.last_button_pressed && (pd.button_time - old_pd.button_time) < 400 && Vector2(old_pd.last_pressed_position).distance_to(Vector2(pd.last_pressed_position)) < 5) {
  1292. pd.double_click_begun = false;
  1293. mb->set_double_click(true);
  1294. }
  1295. Ref<InputEventMessage> msg;
  1296. msg.instantiate();
  1297. msg->event = mb;
  1298. wayland_thread->push_message(msg);
  1299. // Send an event resetting immediately the wheel key.
  1300. // Wayland specification defines axis_stop events as optional and says to
  1301. // treat all axis events as unterminated. As such, we have to manually do
  1302. // it ourselves.
  1303. if (test_button == MouseButton::WHEEL_UP || test_button == MouseButton::WHEEL_DOWN || test_button == MouseButton::WHEEL_LEFT || test_button == MouseButton::WHEEL_RIGHT) {
  1304. // FIXME: This is ugly, I can't find a clean way to clone an InputEvent.
  1305. // This works for now, despite being horrible.
  1306. Ref<InputEventMouseButton> wh_up;
  1307. wh_up.instantiate();
  1308. wh_up->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1309. wh_up->set_position(pd.position);
  1310. wh_up->set_global_position(pd.position);
  1311. // We have to unset the button to avoid it getting stuck.
  1312. pd.pressed_button_mask.clear_flag(test_button_mask);
  1313. wh_up->set_button_mask(pd.pressed_button_mask);
  1314. wh_up->set_button_index(test_button);
  1315. wh_up->set_pressed(false);
  1316. Ref<InputEventMessage> msg_up;
  1317. msg_up.instantiate();
  1318. msg_up->event = wh_up;
  1319. wayland_thread->push_message(msg_up);
  1320. }
  1321. }
  1322. }
  1323. }
  1324. // Reset the scroll vectors as we already handled them.
  1325. pd.scroll_vector = Vector2();
  1326. pd.discrete_scroll_vector_120 = Vector2i();
  1327. // Update the data all getters read. Wayland's specification requires us to do
  1328. // this, since all pointer actions are sent in individual events.
  1329. old_pd = pd;
  1330. }
  1331. void WaylandThread::_wl_pointer_on_axis_source(void *data, struct wl_pointer *wl_pointer, uint32_t axis_source) {
  1332. SeatState *ss = (SeatState *)data;
  1333. ERR_FAIL_NULL(ss);
  1334. if (!ss->pointed_surface) {
  1335. // We're probably on a decoration or some other third-party thing.
  1336. return;
  1337. }
  1338. ss->pointer_data_buffer.scroll_type = axis_source;
  1339. }
  1340. void WaylandThread::_wl_pointer_on_axis_stop(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis) {
  1341. }
  1342. // NOTE: This event is deprecated since version 8 and superseded by
  1343. // `wl_pointer::axis_value120`. This thus converts the data to its
  1344. // fraction-of-120 format.
  1345. void WaylandThread::_wl_pointer_on_axis_discrete(void *data, struct wl_pointer *wl_pointer, uint32_t axis, int32_t discrete) {
  1346. SeatState *ss = (SeatState *)data;
  1347. ERR_FAIL_NULL(ss);
  1348. if (!ss->pointed_surface) {
  1349. // We're probably on a decoration or some other third-party thing.
  1350. return;
  1351. }
  1352. PointerData &pd = ss->pointer_data_buffer;
  1353. // NOTE: We can allow ourselves to not accumulate this data (and thus just
  1354. // assign it) as the spec guarantees only one event per axis type.
  1355. if (axis == WL_POINTER_AXIS_VERTICAL_SCROLL) {
  1356. pd.discrete_scroll_vector_120.y = discrete * 120;
  1357. }
  1358. if (axis == WL_POINTER_AXIS_VERTICAL_SCROLL) {
  1359. pd.discrete_scroll_vector_120.x = discrete * 120;
  1360. }
  1361. }
  1362. // Supersedes `wl_pointer::axis_discrete` Since version 8.
  1363. void WaylandThread::_wl_pointer_on_axis_value120(void *data, struct wl_pointer *wl_pointer, uint32_t axis, int32_t value120) {
  1364. SeatState *ss = (SeatState *)data;
  1365. ERR_FAIL_NULL(ss);
  1366. if (!ss->pointed_surface) {
  1367. // We're probably on a decoration or some other third-party thing.
  1368. return;
  1369. }
  1370. PointerData &pd = ss->pointer_data_buffer;
  1371. if (axis == WL_POINTER_AXIS_VERTICAL_SCROLL) {
  1372. pd.discrete_scroll_vector_120.y += value120;
  1373. }
  1374. if (axis == WL_POINTER_AXIS_VERTICAL_SCROLL) {
  1375. pd.discrete_scroll_vector_120.x += value120;
  1376. }
  1377. }
  1378. // TODO: Add support to this event.
  1379. void WaylandThread::_wl_pointer_on_axis_relative_direction(void *data, struct wl_pointer *wl_pointer, uint32_t axis, uint32_t direction) {
  1380. }
  1381. void WaylandThread::_wl_keyboard_on_keymap(void *data, struct wl_keyboard *wl_keyboard, uint32_t format, int32_t fd, uint32_t size) {
  1382. ERR_FAIL_COND_MSG(format != WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1, "Unsupported keymap format announced from the Wayland compositor.");
  1383. SeatState *ss = (SeatState *)data;
  1384. ERR_FAIL_NULL(ss);
  1385. if (ss->keymap_buffer) {
  1386. // We have already a mapped buffer, so we unmap it. There's no need to reset
  1387. // its pointer or size, as we're gonna set them below.
  1388. munmap((void *)ss->keymap_buffer, ss->keymap_buffer_size);
  1389. ss->keymap_buffer = nullptr;
  1390. }
  1391. ss->keymap_buffer = (const char *)mmap(nullptr, size, PROT_READ, MAP_PRIVATE, fd, 0);
  1392. ss->keymap_buffer_size = size;
  1393. xkb_keymap_unref(ss->xkb_keymap);
  1394. ss->xkb_keymap = xkb_keymap_new_from_string(ss->xkb_context, ss->keymap_buffer,
  1395. XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
  1396. xkb_state_unref(ss->xkb_state);
  1397. ss->xkb_state = xkb_state_new(ss->xkb_keymap);
  1398. }
  1399. void WaylandThread::_wl_keyboard_on_enter(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *surface, struct wl_array *keys) {
  1400. SeatState *ss = (SeatState *)data;
  1401. ERR_FAIL_NULL(ss);
  1402. WaylandThread *wayland_thread = ss->wayland_thread;
  1403. ERR_FAIL_NULL(wayland_thread);
  1404. wayland_thread->_set_current_seat(ss->wl_seat);
  1405. Ref<WindowEventMessage> msg;
  1406. msg.instantiate();
  1407. msg->event = DisplayServer::WINDOW_EVENT_FOCUS_IN;
  1408. wayland_thread->push_message(msg);
  1409. }
  1410. void WaylandThread::_wl_keyboard_on_leave(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *surface) {
  1411. SeatState *ss = (SeatState *)data;
  1412. ERR_FAIL_NULL(ss);
  1413. WaylandThread *wayland_thread = ss->wayland_thread;
  1414. ERR_FAIL_NULL(wayland_thread);
  1415. ss->repeating_keycode = XKB_KEYCODE_INVALID;
  1416. Ref<WindowEventMessage> msg;
  1417. msg.instantiate();
  1418. msg->event = DisplayServer::WINDOW_EVENT_FOCUS_OUT;
  1419. wayland_thread->push_message(msg);
  1420. }
  1421. void WaylandThread::_wl_keyboard_on_key(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t time, uint32_t key, uint32_t state) {
  1422. SeatState *ss = (SeatState *)data;
  1423. ERR_FAIL_NULL(ss);
  1424. WaylandThread *wayland_thread = ss->wayland_thread;
  1425. ERR_FAIL_NULL(wayland_thread);
  1426. // We have to add 8 to the scancode to get an XKB-compatible keycode.
  1427. xkb_keycode_t xkb_keycode = key + 8;
  1428. bool pressed = state & WL_KEYBOARD_KEY_STATE_PRESSED;
  1429. if (pressed) {
  1430. if (xkb_keymap_key_repeats(ss->xkb_keymap, xkb_keycode)) {
  1431. ss->last_repeat_start_msec = OS::get_singleton()->get_ticks_msec();
  1432. ss->repeating_keycode = xkb_keycode;
  1433. }
  1434. ss->last_key_pressed_serial = serial;
  1435. } else if (ss->repeating_keycode == xkb_keycode) {
  1436. ss->repeating_keycode = XKB_KEYCODE_INVALID;
  1437. }
  1438. Ref<InputEventKey> k;
  1439. k.instantiate();
  1440. if (!_seat_state_configure_key_event(*ss, k, xkb_keycode, pressed)) {
  1441. return;
  1442. }
  1443. Ref<InputEventMessage> msg;
  1444. msg.instantiate();
  1445. msg->event = k;
  1446. wayland_thread->push_message(msg);
  1447. }
  1448. void WaylandThread::_wl_keyboard_on_modifiers(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t mods_depressed, uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {
  1449. SeatState *ss = (SeatState *)data;
  1450. ERR_FAIL_NULL(ss);
  1451. xkb_state_update_mask(ss->xkb_state, mods_depressed, mods_latched, mods_locked, ss->current_layout_index, ss->current_layout_index, group);
  1452. ss->shift_pressed = xkb_state_mod_name_is_active(ss->xkb_state, XKB_MOD_NAME_SHIFT, XKB_STATE_MODS_DEPRESSED);
  1453. ss->ctrl_pressed = xkb_state_mod_name_is_active(ss->xkb_state, XKB_MOD_NAME_CTRL, XKB_STATE_MODS_DEPRESSED);
  1454. ss->alt_pressed = xkb_state_mod_name_is_active(ss->xkb_state, XKB_MOD_NAME_ALT, XKB_STATE_MODS_DEPRESSED);
  1455. ss->meta_pressed = xkb_state_mod_name_is_active(ss->xkb_state, XKB_MOD_NAME_LOGO, XKB_STATE_MODS_DEPRESSED);
  1456. ss->current_layout_index = group;
  1457. }
  1458. void WaylandThread::_wl_keyboard_on_repeat_info(void *data, struct wl_keyboard *wl_keyboard, int32_t rate, int32_t delay) {
  1459. SeatState *ss = (SeatState *)data;
  1460. ERR_FAIL_NULL(ss);
  1461. ss->repeat_key_delay_msec = 1000 / rate;
  1462. ss->repeat_start_delay_msec = delay;
  1463. }
  1464. // NOTE: Don't forget to `memfree` the offer's state.
  1465. void WaylandThread::_wl_data_device_on_data_offer(void *data, struct wl_data_device *wl_data_device, struct wl_data_offer *id) {
  1466. wl_proxy_tag_godot((struct wl_proxy *)id);
  1467. wl_data_offer_add_listener(id, &wl_data_offer_listener, memnew(OfferState));
  1468. }
  1469. void WaylandThread::_wl_data_device_on_enter(void *data, struct wl_data_device *wl_data_device, uint32_t serial, struct wl_surface *surface, wl_fixed_t x, wl_fixed_t y, struct wl_data_offer *id) {
  1470. SeatState *ss = (SeatState *)data;
  1471. ERR_FAIL_NULL(ss);
  1472. ss->dnd_enter_serial = serial;
  1473. ss->wl_data_offer_dnd = id;
  1474. // Godot only supports DnD file copying for now.
  1475. wl_data_offer_accept(id, serial, "text/uri-list");
  1476. wl_data_offer_set_actions(id, WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY, WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY);
  1477. }
  1478. void WaylandThread::_wl_data_device_on_leave(void *data, struct wl_data_device *wl_data_device) {
  1479. SeatState *ss = (SeatState *)data;
  1480. ERR_FAIL_NULL(ss);
  1481. if (ss->wl_data_offer_dnd) {
  1482. memdelete(wl_data_offer_get_offer_state(ss->wl_data_offer_dnd));
  1483. wl_data_offer_destroy(ss->wl_data_offer_dnd);
  1484. ss->wl_data_offer_dnd = nullptr;
  1485. }
  1486. }
  1487. void WaylandThread::_wl_data_device_on_motion(void *data, struct wl_data_device *wl_data_device, uint32_t time, wl_fixed_t x, wl_fixed_t y) {
  1488. }
  1489. void WaylandThread::_wl_data_device_on_drop(void *data, struct wl_data_device *wl_data_device) {
  1490. SeatState *ss = (SeatState *)data;
  1491. ERR_FAIL_NULL(ss);
  1492. WaylandThread *wayland_thread = ss->wayland_thread;
  1493. ERR_FAIL_NULL(wayland_thread);
  1494. OfferState *os = wl_data_offer_get_offer_state(ss->wl_data_offer_dnd);
  1495. ERR_FAIL_NULL(os);
  1496. if (os) {
  1497. Ref<DropFilesEventMessage> msg;
  1498. msg.instantiate();
  1499. Vector<uint8_t> list_data = _wl_data_offer_read(wayland_thread->wl_display, "text/uri-list", ss->wl_data_offer_dnd);
  1500. msg->files = String::utf8((const char *)list_data.ptr(), list_data.size()).split("\r\n", false);
  1501. for (int i = 0; i < msg->files.size(); i++) {
  1502. msg->files.write[i] = msg->files[i].replace("file://", "").uri_decode();
  1503. }
  1504. wayland_thread->push_message(msg);
  1505. wl_data_offer_finish(ss->wl_data_offer_dnd);
  1506. }
  1507. memdelete(wl_data_offer_get_offer_state(ss->wl_data_offer_dnd));
  1508. wl_data_offer_destroy(ss->wl_data_offer_dnd);
  1509. ss->wl_data_offer_dnd = nullptr;
  1510. }
  1511. void WaylandThread::_wl_data_device_on_selection(void *data, struct wl_data_device *wl_data_device, struct wl_data_offer *id) {
  1512. SeatState *ss = (SeatState *)data;
  1513. ERR_FAIL_NULL(ss);
  1514. if (ss->wl_data_offer_selection) {
  1515. memdelete(wl_data_offer_get_offer_state(ss->wl_data_offer_selection));
  1516. wl_data_offer_destroy(ss->wl_data_offer_selection);
  1517. }
  1518. ss->wl_data_offer_selection = id;
  1519. }
  1520. void WaylandThread::_wl_data_offer_on_offer(void *data, struct wl_data_offer *wl_data_offer, const char *mime_type) {
  1521. OfferState *os = (OfferState *)data;
  1522. ERR_FAIL_NULL(os);
  1523. if (os) {
  1524. os->mime_types.insert(String::utf8(mime_type));
  1525. }
  1526. }
  1527. void WaylandThread::_wl_data_offer_on_source_actions(void *data, struct wl_data_offer *wl_data_offer, uint32_t source_actions) {
  1528. }
  1529. void WaylandThread::_wl_data_offer_on_action(void *data, struct wl_data_offer *wl_data_offer, uint32_t dnd_action) {
  1530. }
  1531. void WaylandThread::_wl_data_source_on_target(void *data, struct wl_data_source *wl_data_source, const char *mime_type) {
  1532. }
  1533. void WaylandThread::_wl_data_source_on_send(void *data, struct wl_data_source *wl_data_source, const char *mime_type, int32_t fd) {
  1534. SeatState *ss = (SeatState *)data;
  1535. ERR_FAIL_NULL(ss);
  1536. Vector<uint8_t> *data_to_send = nullptr;
  1537. if (wl_data_source == ss->wl_data_source_selection) {
  1538. data_to_send = &ss->selection_data;
  1539. DEBUG_LOG_WAYLAND_THREAD("Clipboard: requested selection.");
  1540. }
  1541. if (data_to_send) {
  1542. ssize_t written_bytes = 0;
  1543. bool valid_mime = false;
  1544. if (strcmp(mime_type, "text/plain;charset=utf-8") == 0) {
  1545. valid_mime = true;
  1546. } else if (strcmp(mime_type, "text/plain") == 0) {
  1547. valid_mime = true;
  1548. }
  1549. if (valid_mime) {
  1550. written_bytes = write(fd, data_to_send->ptr(), data_to_send->size());
  1551. }
  1552. if (written_bytes > 0) {
  1553. DEBUG_LOG_WAYLAND_THREAD(vformat("Clipboard: sent %d bytes.", written_bytes));
  1554. } else if (written_bytes == 0) {
  1555. DEBUG_LOG_WAYLAND_THREAD("Clipboard: no bytes sent.");
  1556. } else {
  1557. ERR_PRINT(vformat("Clipboard: write error %d.", errno));
  1558. }
  1559. }
  1560. close(fd);
  1561. }
  1562. void WaylandThread::_wl_data_source_on_cancelled(void *data, struct wl_data_source *wl_data_source) {
  1563. SeatState *ss = (SeatState *)data;
  1564. ERR_FAIL_NULL(ss);
  1565. wl_data_source_destroy(wl_data_source);
  1566. if (wl_data_source == ss->wl_data_source_selection) {
  1567. ss->wl_data_source_selection = nullptr;
  1568. ss->selection_data.clear();
  1569. DEBUG_LOG_WAYLAND_THREAD("Clipboard: selection set by another program.");
  1570. return;
  1571. }
  1572. }
  1573. void WaylandThread::_wl_data_source_on_dnd_drop_performed(void *data, struct wl_data_source *wl_data_source) {
  1574. }
  1575. void WaylandThread::_wl_data_source_on_dnd_finished(void *data, struct wl_data_source *wl_data_source) {
  1576. }
  1577. void WaylandThread::_wl_data_source_on_action(void *data, struct wl_data_source *wl_data_source, uint32_t dnd_action) {
  1578. }
  1579. void WaylandThread::_wp_fractional_scale_on_preferred_scale(void *data, struct wp_fractional_scale_v1 *wp_fractional_scale_v1, uint32_t scale) {
  1580. WindowState *ws = (WindowState *)data;
  1581. ERR_FAIL_NULL(ws);
  1582. ws->preferred_fractional_scale = (double)scale / 120;
  1583. window_state_update_size(ws, ws->rect.size.width, ws->rect.size.height);
  1584. }
  1585. void WaylandThread::_wp_relative_pointer_on_relative_motion(void *data, struct zwp_relative_pointer_v1 *wp_relative_pointer, uint32_t uptime_hi, uint32_t uptime_lo, wl_fixed_t dx, wl_fixed_t dy, wl_fixed_t dx_unaccel, wl_fixed_t dy_unaccel) {
  1586. SeatState *ss = (SeatState *)data;
  1587. ERR_FAIL_NULL(ss);
  1588. if (!ss->pointed_surface) {
  1589. // We're probably on a decoration or some other third-party thing.
  1590. return;
  1591. }
  1592. PointerData &pd = ss->pointer_data_buffer;
  1593. WindowState *ws = wl_surface_get_window_state(ss->pointed_surface);
  1594. ERR_FAIL_NULL(ws);
  1595. pd.relative_motion.x = wl_fixed_to_double(dx);
  1596. pd.relative_motion.y = wl_fixed_to_double(dy);
  1597. pd.relative_motion *= window_state_get_scale_factor(ws);
  1598. pd.relative_motion_time = uptime_lo;
  1599. }
  1600. void WaylandThread::_wp_pointer_gesture_pinch_on_begin(void *data, struct zwp_pointer_gesture_pinch_v1 *wp_pointer_gesture_pinch_v1, uint32_t serial, uint32_t time, struct wl_surface *surface, uint32_t fingers) {
  1601. SeatState *ss = (SeatState *)data;
  1602. ERR_FAIL_NULL(ss);
  1603. if (fingers == 2) {
  1604. ss->old_pinch_scale = wl_fixed_from_int(1);
  1605. ss->active_gesture = Gesture::MAGNIFY;
  1606. }
  1607. }
  1608. void WaylandThread::_wp_pointer_gesture_pinch_on_update(void *data, struct zwp_pointer_gesture_pinch_v1 *wp_pointer_gesture_pinch_v1, uint32_t time, wl_fixed_t dx, wl_fixed_t dy, wl_fixed_t scale, wl_fixed_t rotation) {
  1609. SeatState *ss = (SeatState *)data;
  1610. ERR_FAIL_NULL(ss);
  1611. WaylandThread *wayland_thread = ss->wayland_thread;
  1612. ERR_FAIL_NULL(wayland_thread);
  1613. PointerData &pd = ss->pointer_data_buffer;
  1614. if (ss->active_gesture == Gesture::MAGNIFY) {
  1615. Ref<InputEventMagnifyGesture> mg;
  1616. mg.instantiate();
  1617. mg->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1618. // Set all pressed modifiers.
  1619. mg->set_shift_pressed(ss->shift_pressed);
  1620. mg->set_ctrl_pressed(ss->ctrl_pressed);
  1621. mg->set_alt_pressed(ss->alt_pressed);
  1622. mg->set_meta_pressed(ss->meta_pressed);
  1623. mg->set_position(pd.position);
  1624. wl_fixed_t scale_delta = scale - ss->old_pinch_scale;
  1625. mg->set_factor(1 + wl_fixed_to_double(scale_delta));
  1626. Ref<InputEventMessage> magnify_msg;
  1627. magnify_msg.instantiate();
  1628. magnify_msg->event = mg;
  1629. // Since Wayland allows only one gesture at a time and godot instead expects
  1630. // both of them, we'll have to create two separate input events: one for
  1631. // magnification and one for panning.
  1632. Ref<InputEventPanGesture> pg;
  1633. pg.instantiate();
  1634. pg->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1635. // Set all pressed modifiers.
  1636. pg->set_shift_pressed(ss->shift_pressed);
  1637. pg->set_ctrl_pressed(ss->ctrl_pressed);
  1638. pg->set_alt_pressed(ss->alt_pressed);
  1639. pg->set_meta_pressed(ss->meta_pressed);
  1640. pg->set_position(pd.position);
  1641. pg->set_delta(Vector2(wl_fixed_to_double(dx), wl_fixed_to_double(dy)));
  1642. Ref<InputEventMessage> pan_msg;
  1643. pan_msg.instantiate();
  1644. pan_msg->event = pg;
  1645. wayland_thread->push_message(magnify_msg);
  1646. wayland_thread->push_message(pan_msg);
  1647. ss->old_pinch_scale = scale;
  1648. }
  1649. }
  1650. void WaylandThread::_wp_pointer_gesture_pinch_on_end(void *data, struct zwp_pointer_gesture_pinch_v1 *wp_pointer_gesture_pinch_v1, uint32_t serial, uint32_t time, int32_t cancelled) {
  1651. SeatState *ss = (SeatState *)data;
  1652. ERR_FAIL_NULL(ss);
  1653. ss->active_gesture = Gesture::NONE;
  1654. }
  1655. // NOTE: Don't forget to `memfree` the offer's state.
  1656. void WaylandThread::_wp_primary_selection_device_on_data_offer(void *data, struct zwp_primary_selection_device_v1 *wp_primary_selection_device_v1, struct zwp_primary_selection_offer_v1 *offer) {
  1657. wl_proxy_tag_godot((struct wl_proxy *)offer);
  1658. zwp_primary_selection_offer_v1_add_listener(offer, &wp_primary_selection_offer_listener, memnew(OfferState));
  1659. }
  1660. void WaylandThread::_wp_primary_selection_device_on_selection(void *data, struct zwp_primary_selection_device_v1 *wp_primary_selection_device_v1, struct zwp_primary_selection_offer_v1 *id) {
  1661. SeatState *ss = (SeatState *)data;
  1662. ERR_FAIL_NULL(ss);
  1663. if (ss->wp_primary_selection_offer) {
  1664. memfree(wp_primary_selection_offer_get_offer_state(ss->wp_primary_selection_offer));
  1665. zwp_primary_selection_offer_v1_destroy(ss->wp_primary_selection_offer);
  1666. }
  1667. ss->wp_primary_selection_offer = id;
  1668. }
  1669. void WaylandThread::_wp_primary_selection_offer_on_offer(void *data, struct zwp_primary_selection_offer_v1 *wp_primary_selection_offer_v1, const char *mime_type) {
  1670. OfferState *os = (OfferState *)data;
  1671. ERR_FAIL_NULL(os);
  1672. if (os) {
  1673. os->mime_types.insert(String::utf8(mime_type));
  1674. }
  1675. }
  1676. void WaylandThread::_wp_primary_selection_source_on_send(void *data, struct zwp_primary_selection_source_v1 *wp_primary_selection_source_v1, const char *mime_type, int32_t fd) {
  1677. SeatState *ss = (SeatState *)data;
  1678. ERR_FAIL_NULL(ss);
  1679. Vector<uint8_t> *data_to_send = nullptr;
  1680. if (wp_primary_selection_source_v1 == ss->wp_primary_selection_source) {
  1681. data_to_send = &ss->primary_data;
  1682. DEBUG_LOG_WAYLAND_THREAD("Clipboard: requested primary selection.");
  1683. }
  1684. if (data_to_send) {
  1685. ssize_t written_bytes = 0;
  1686. if (strcmp(mime_type, "text/plain") == 0) {
  1687. written_bytes = write(fd, data_to_send->ptr(), data_to_send->size());
  1688. }
  1689. if (written_bytes > 0) {
  1690. DEBUG_LOG_WAYLAND_THREAD(vformat("Clipboard: sent %d bytes.", written_bytes));
  1691. } else if (written_bytes == 0) {
  1692. DEBUG_LOG_WAYLAND_THREAD("Clipboard: no bytes sent.");
  1693. } else {
  1694. ERR_PRINT(vformat("Clipboard: write error %d.", errno));
  1695. }
  1696. }
  1697. close(fd);
  1698. }
  1699. void WaylandThread::_wp_primary_selection_source_on_cancelled(void *data, struct zwp_primary_selection_source_v1 *wp_primary_selection_source_v1) {
  1700. SeatState *ss = (SeatState *)data;
  1701. ERR_FAIL_NULL(ss);
  1702. if (wp_primary_selection_source_v1 == ss->wp_primary_selection_source) {
  1703. zwp_primary_selection_source_v1_destroy(ss->wp_primary_selection_source);
  1704. ss->wp_primary_selection_source = nullptr;
  1705. ss->primary_data.clear();
  1706. DEBUG_LOG_WAYLAND_THREAD("Clipboard: primary selection set by another program.");
  1707. return;
  1708. }
  1709. }
  1710. void WaylandThread::_wp_tablet_seat_on_tablet_added(void *data, struct zwp_tablet_seat_v2 *wp_tablet_seat_v2, struct zwp_tablet_v2 *id) {
  1711. }
  1712. void WaylandThread::_wp_tablet_seat_on_tool_added(void *data, struct zwp_tablet_seat_v2 *wp_tablet_seat_v2, struct zwp_tablet_tool_v2 *id) {
  1713. SeatState *ss = (SeatState *)data;
  1714. ERR_FAIL_NULL(ss);
  1715. TabletToolState *state = memnew(TabletToolState);
  1716. state->wl_seat = ss->wl_seat;
  1717. wl_proxy_tag_godot((struct wl_proxy *)id);
  1718. zwp_tablet_tool_v2_add_listener(id, &wp_tablet_tool_listener, state);
  1719. ss->tablet_tools.push_back(id);
  1720. }
  1721. void WaylandThread::_wp_tablet_seat_on_pad_added(void *data, struct zwp_tablet_seat_v2 *wp_tablet_seat_v2, struct zwp_tablet_pad_v2 *id) {
  1722. }
  1723. void WaylandThread::_wp_tablet_tool_on_type(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t tool_type) {
  1724. TabletToolState *state = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1725. if (state && tool_type == ZWP_TABLET_TOOL_V2_TYPE_ERASER) {
  1726. state->is_eraser = true;
  1727. }
  1728. }
  1729. void WaylandThread::_wp_tablet_tool_on_hardware_serial(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t hardware_serial_hi, uint32_t hardware_serial_lo) {
  1730. }
  1731. void WaylandThread::_wp_tablet_tool_on_hardware_id_wacom(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t hardware_id_hi, uint32_t hardware_id_lo) {
  1732. }
  1733. void WaylandThread::_wp_tablet_tool_on_capability(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t capability) {
  1734. }
  1735. void WaylandThread::_wp_tablet_tool_on_done(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2) {
  1736. }
  1737. void WaylandThread::_wp_tablet_tool_on_removed(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2) {
  1738. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1739. if (!ts) {
  1740. return;
  1741. }
  1742. SeatState *ss = wl_seat_get_seat_state(ts->wl_seat);
  1743. if (!ss) {
  1744. return;
  1745. }
  1746. List<struct zwp_tablet_tool_v2 *>::Element *E = ss->tablet_tools.find(wp_tablet_tool_v2);
  1747. if (E && E->get()) {
  1748. struct zwp_tablet_tool_v2 *tool = E->get();
  1749. TabletToolState *state = wp_tablet_tool_get_state(tool);
  1750. if (state) {
  1751. memdelete(state);
  1752. }
  1753. zwp_tablet_tool_v2_destroy(tool);
  1754. ss->tablet_tools.erase(E);
  1755. }
  1756. }
  1757. void WaylandThread::_wp_tablet_tool_on_proximity_in(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t serial, struct zwp_tablet_v2 *tablet, struct wl_surface *surface) {
  1758. if (!surface || !wl_proxy_is_godot((struct wl_proxy *)surface)) {
  1759. // We're probably on a decoration or something.
  1760. return;
  1761. }
  1762. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1763. if (!ts) {
  1764. return;
  1765. }
  1766. SeatState *ss = wl_seat_get_seat_state(ts->wl_seat);
  1767. if (!ss) {
  1768. return;
  1769. }
  1770. WaylandThread *wayland_thread = ss->wayland_thread;
  1771. ERR_FAIL_NULL(wayland_thread);
  1772. ts->data_pending.proximity_serial = serial;
  1773. ts->data_pending.proximal_surface = surface;
  1774. ts->last_surface = surface;
  1775. Ref<WindowEventMessage> msg;
  1776. msg.instantiate();
  1777. msg->event = DisplayServer::WINDOW_EVENT_MOUSE_ENTER;
  1778. wayland_thread->push_message(msg);
  1779. DEBUG_LOG_WAYLAND_THREAD("Tablet tool entered window.");
  1780. }
  1781. void WaylandThread::_wp_tablet_tool_on_proximity_out(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2) {
  1782. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1783. if (!ts || !ts->data_pending.proximal_surface) {
  1784. // Not our stuff, we don't care.
  1785. return;
  1786. }
  1787. SeatState *ss = wl_seat_get_seat_state(ts->wl_seat);
  1788. if (!ss) {
  1789. return;
  1790. }
  1791. WaylandThread *wayland_thread = ss->wayland_thread;
  1792. ERR_FAIL_NULL(wayland_thread);
  1793. ts->data_pending.proximal_surface = nullptr;
  1794. Ref<WindowEventMessage> msg;
  1795. msg.instantiate();
  1796. msg->event = DisplayServer::WINDOW_EVENT_MOUSE_EXIT;
  1797. wayland_thread->push_message(msg);
  1798. DEBUG_LOG_WAYLAND_THREAD("Tablet tool left window.");
  1799. }
  1800. void WaylandThread::_wp_tablet_tool_on_down(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t serial) {
  1801. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1802. if (!ts) {
  1803. return;
  1804. }
  1805. TabletToolData &td = ts->data_pending;
  1806. td.pressed_button_mask.set_flag(mouse_button_to_mask(MouseButton::LEFT));
  1807. td.last_button_pressed = MouseButton::LEFT;
  1808. td.double_click_begun = true;
  1809. // The protocol doesn't cover this, but we can use this funky hack to make
  1810. // double clicking work.
  1811. td.button_time = OS::get_singleton()->get_ticks_msec();
  1812. }
  1813. void WaylandThread::_wp_tablet_tool_on_up(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2) {
  1814. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1815. if (!ts) {
  1816. return;
  1817. }
  1818. TabletToolData &td = ts->data_pending;
  1819. td.pressed_button_mask.clear_flag(mouse_button_to_mask(MouseButton::LEFT));
  1820. // The protocol doesn't cover this, but we can use this funky hack to make
  1821. // double clicking work.
  1822. td.button_time = OS::get_singleton()->get_ticks_msec();
  1823. }
  1824. void WaylandThread::_wp_tablet_tool_on_motion(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, wl_fixed_t x, wl_fixed_t y) {
  1825. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1826. if (!ts) {
  1827. return;
  1828. }
  1829. if (!ts->data_pending.proximal_surface) {
  1830. // We're probably on a decoration or some other third-party thing.
  1831. return;
  1832. }
  1833. WindowState *ws = wl_surface_get_window_state(ts->data_pending.proximal_surface);
  1834. ERR_FAIL_NULL(ws);
  1835. TabletToolData &td = ts->data_pending;
  1836. double scale_factor = window_state_get_scale_factor(ws);
  1837. td.position.x = wl_fixed_to_double(x);
  1838. td.position.y = wl_fixed_to_double(y);
  1839. td.position *= scale_factor;
  1840. td.motion_time = OS::get_singleton()->get_ticks_msec();
  1841. }
  1842. void WaylandThread::_wp_tablet_tool_on_pressure(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t pressure) {
  1843. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1844. if (!ts) {
  1845. return;
  1846. }
  1847. ts->data_pending.pressure = pressure;
  1848. }
  1849. void WaylandThread::_wp_tablet_tool_on_distance(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t distance) {
  1850. // Unsupported
  1851. }
  1852. void WaylandThread::_wp_tablet_tool_on_tilt(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, wl_fixed_t tilt_x, wl_fixed_t tilt_y) {
  1853. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1854. if (!ts) {
  1855. return;
  1856. }
  1857. TabletToolData &td = ts->data_pending;
  1858. td.tilt.x = wl_fixed_to_double(tilt_x);
  1859. td.tilt.y = wl_fixed_to_double(tilt_y);
  1860. }
  1861. void WaylandThread::_wp_tablet_tool_on_rotation(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, wl_fixed_t degrees) {
  1862. // Unsupported.
  1863. }
  1864. void WaylandThread::_wp_tablet_tool_on_slider(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, int32_t position) {
  1865. // Unsupported.
  1866. }
  1867. void WaylandThread::_wp_tablet_tool_on_wheel(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, wl_fixed_t degrees, int32_t clicks) {
  1868. // TODO
  1869. }
  1870. void WaylandThread::_wp_tablet_tool_on_button(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t serial, uint32_t button, uint32_t state) {
  1871. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1872. if (!ts) {
  1873. return;
  1874. }
  1875. TabletToolData &td = ts->data_pending;
  1876. MouseButton mouse_button = MouseButton::NONE;
  1877. if (button == BTN_STYLUS) {
  1878. mouse_button = MouseButton::LEFT;
  1879. }
  1880. if (button == BTN_STYLUS2) {
  1881. mouse_button = MouseButton::RIGHT;
  1882. }
  1883. if (mouse_button != MouseButton::NONE) {
  1884. MouseButtonMask mask = mouse_button_to_mask(mouse_button);
  1885. if (state == ZWP_TABLET_TOOL_V2_BUTTON_STATE_PRESSED) {
  1886. td.pressed_button_mask.set_flag(mask);
  1887. td.last_button_pressed = mouse_button;
  1888. td.double_click_begun = true;
  1889. } else {
  1890. td.pressed_button_mask.clear_flag(mask);
  1891. }
  1892. // The protocol doesn't cover this, but we can use this funky hack to make
  1893. // double clicking work.
  1894. td.button_time = OS::get_singleton()->get_ticks_msec();
  1895. }
  1896. }
  1897. void WaylandThread::_wp_tablet_tool_on_frame(void *data, struct zwp_tablet_tool_v2 *wp_tablet_tool_v2, uint32_t time) {
  1898. TabletToolState *ts = wp_tablet_tool_get_state(wp_tablet_tool_v2);
  1899. if (!ts) {
  1900. return;
  1901. }
  1902. SeatState *ss = wl_seat_get_seat_state(ts->wl_seat);
  1903. if (!ss) {
  1904. return;
  1905. }
  1906. WaylandThread *wayland_thread = ss->wayland_thread;
  1907. ERR_FAIL_NULL(wayland_thread);
  1908. TabletToolData &old_td = ts->data;
  1909. TabletToolData &td = ts->data_pending;
  1910. if (old_td.position != td.position || old_td.tilt != td.tilt || old_td.pressure != td.pressure) {
  1911. Ref<InputEventMouseMotion> mm;
  1912. mm.instantiate();
  1913. mm->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1914. // Set all pressed modifiers.
  1915. mm->set_shift_pressed(ss->shift_pressed);
  1916. mm->set_ctrl_pressed(ss->ctrl_pressed);
  1917. mm->set_alt_pressed(ss->alt_pressed);
  1918. mm->set_meta_pressed(ss->meta_pressed);
  1919. mm->set_button_mask(td.pressed_button_mask);
  1920. mm->set_position(td.position);
  1921. mm->set_global_position(td.position);
  1922. // NOTE: The Godot API expects normalized values and we store them raw,
  1923. // straight from the compositor, so we have to normalize them here.
  1924. // According to the tablet proto spec, tilt is expressed in degrees relative
  1925. // to the Z axis of the tablet, so it shouldn't go over 90 degrees either way,
  1926. // I think. We'll clamp it just in case.
  1927. td.tilt = td.tilt.clampf(-90, 90);
  1928. mm->set_tilt(td.tilt / 90);
  1929. // The tablet proto spec explicitly says that pressure is defined as a value
  1930. // between 0 to 65535.
  1931. mm->set_pressure(td.pressure / (float)65535);
  1932. mm->set_pen_inverted(ts->is_eraser);
  1933. mm->set_relative(td.position - old_td.position);
  1934. mm->set_relative_screen_position(mm->get_relative());
  1935. Vector2 pos_delta = td.position - old_td.position;
  1936. uint32_t time_delta = td.motion_time - old_td.motion_time;
  1937. mm->set_velocity((Vector2)pos_delta / time_delta);
  1938. Ref<InputEventMessage> inputev_msg;
  1939. inputev_msg.instantiate();
  1940. inputev_msg->event = mm;
  1941. wayland_thread->push_message(inputev_msg);
  1942. }
  1943. if (old_td.pressed_button_mask != td.pressed_button_mask) {
  1944. BitField<MouseButtonMask> pressed_mask_delta = BitField<MouseButtonMask>((int64_t)old_td.pressed_button_mask ^ (int64_t)td.pressed_button_mask);
  1945. for (MouseButton test_button : { MouseButton::LEFT, MouseButton::RIGHT }) {
  1946. MouseButtonMask test_button_mask = mouse_button_to_mask(test_button);
  1947. if (pressed_mask_delta.has_flag(test_button_mask)) {
  1948. Ref<InputEventMouseButton> mb;
  1949. mb.instantiate();
  1950. // Set all pressed modifiers.
  1951. mb->set_shift_pressed(ss->shift_pressed);
  1952. mb->set_ctrl_pressed(ss->ctrl_pressed);
  1953. mb->set_alt_pressed(ss->alt_pressed);
  1954. mb->set_meta_pressed(ss->meta_pressed);
  1955. mb->set_window_id(DisplayServer::MAIN_WINDOW_ID);
  1956. mb->set_position(td.position);
  1957. mb->set_global_position(td.position);
  1958. mb->set_button_mask(td.pressed_button_mask);
  1959. mb->set_button_index(test_button);
  1960. mb->set_pressed(td.pressed_button_mask.has_flag(test_button_mask));
  1961. // We have to set the last position pressed here as we can't take for
  1962. // granted what the individual events might have seen due to them not having
  1963. // a garaunteed order.
  1964. if (mb->is_pressed()) {
  1965. td.last_pressed_position = td.position;
  1966. }
  1967. if (old_td.double_click_begun && mb->is_pressed() && td.last_button_pressed == old_td.last_button_pressed && (td.button_time - old_td.button_time) < 400 && Vector2(td.last_pressed_position).distance_to(Vector2(old_td.last_pressed_position)) < 5) {
  1968. td.double_click_begun = false;
  1969. mb->set_double_click(true);
  1970. }
  1971. Ref<InputEventMessage> msg;
  1972. msg.instantiate();
  1973. msg->event = mb;
  1974. wayland_thread->push_message(msg);
  1975. }
  1976. }
  1977. }
  1978. old_td = td;
  1979. }
  1980. void WaylandThread::_wp_text_input_on_enter(void *data, struct zwp_text_input_v3 *wp_text_input_v3, struct wl_surface *surface) {
  1981. SeatState *ss = (SeatState *)data;
  1982. if (!ss) {
  1983. return;
  1984. }
  1985. ss->ime_enabled = true;
  1986. }
  1987. void WaylandThread::_wp_text_input_on_leave(void *data, struct zwp_text_input_v3 *wp_text_input_v3, struct wl_surface *surface) {
  1988. SeatState *ss = (SeatState *)data;
  1989. if (!ss) {
  1990. return;
  1991. }
  1992. ss->ime_enabled = false;
  1993. ss->ime_active = false;
  1994. ss->ime_text = String();
  1995. ss->ime_text_commit = String();
  1996. ss->ime_cursor = Vector2i();
  1997. Ref<IMEUpdateEventMessage> msg;
  1998. msg.instantiate();
  1999. msg->text = String();
  2000. msg->selection = Vector2i();
  2001. ss->wayland_thread->push_message(msg);
  2002. }
  2003. void WaylandThread::_wp_text_input_on_preedit_string(void *data, struct zwp_text_input_v3 *wp_text_input_v3, const char *text, int32_t cursor_begin, int32_t cursor_end) {
  2004. SeatState *ss = (SeatState *)data;
  2005. if (!ss) {
  2006. return;
  2007. }
  2008. ss->ime_text = String::utf8(text);
  2009. // Convert cursor positions from UTF-8 to UTF-32 offset.
  2010. int32_t cursor_begin_utf32 = 0;
  2011. int32_t cursor_end_utf32 = 0;
  2012. for (int i = 0; i < ss->ime_text.length(); i++) {
  2013. uint32_t c = ss->ime_text[i];
  2014. if (c <= 0x7f) { // 7 bits.
  2015. cursor_begin -= 1;
  2016. cursor_end -= 1;
  2017. } else if (c <= 0x7ff) { // 11 bits
  2018. cursor_begin -= 2;
  2019. cursor_end -= 2;
  2020. } else if (c <= 0xffff) { // 16 bits
  2021. cursor_begin -= 3;
  2022. cursor_end -= 3;
  2023. } else if (c <= 0x001fffff) { // 21 bits
  2024. cursor_begin -= 4;
  2025. cursor_end -= 4;
  2026. } else if (c <= 0x03ffffff) { // 26 bits
  2027. cursor_begin -= 5;
  2028. cursor_end -= 5;
  2029. } else if (c <= 0x7fffffff) { // 31 bits
  2030. cursor_begin -= 6;
  2031. cursor_end -= 6;
  2032. } else {
  2033. cursor_begin -= 1;
  2034. cursor_end -= 1;
  2035. }
  2036. if (cursor_begin == 0) {
  2037. cursor_begin_utf32 = i + 1;
  2038. }
  2039. if (cursor_end == 0) {
  2040. cursor_end_utf32 = i + 1;
  2041. }
  2042. if (cursor_begin <= 0 && cursor_end <= 0) {
  2043. break;
  2044. }
  2045. }
  2046. ss->ime_cursor = Vector2i(cursor_begin_utf32, cursor_end_utf32 - cursor_begin_utf32);
  2047. }
  2048. void WaylandThread::_wp_text_input_on_commit_string(void *data, struct zwp_text_input_v3 *wp_text_input_v3, const char *text) {
  2049. SeatState *ss = (SeatState *)data;
  2050. if (!ss) {
  2051. return;
  2052. }
  2053. ss->ime_text_commit = String::utf8(text);
  2054. }
  2055. void WaylandThread::_wp_text_input_on_delete_surrounding_text(void *data, struct zwp_text_input_v3 *wp_text_input_v3, uint32_t before_length, uint32_t after_length) {
  2056. // Not implemented.
  2057. }
  2058. void WaylandThread::_wp_text_input_on_done(void *data, struct zwp_text_input_v3 *wp_text_input_v3, uint32_t serial) {
  2059. SeatState *ss = (SeatState *)data;
  2060. if (!ss) {
  2061. return;
  2062. }
  2063. if (!ss->ime_text_commit.is_empty()) {
  2064. Ref<IMECommitEventMessage> msg;
  2065. msg.instantiate();
  2066. msg->text = ss->ime_text_commit;
  2067. ss->wayland_thread->push_message(msg);
  2068. } else if (!ss->ime_text.is_empty()) {
  2069. Ref<IMEUpdateEventMessage> msg;
  2070. msg.instantiate();
  2071. msg->text = ss->ime_text;
  2072. msg->selection = ss->ime_cursor;
  2073. ss->wayland_thread->push_message(msg);
  2074. }
  2075. ss->ime_text = String();
  2076. ss->ime_text_commit = String();
  2077. ss->ime_cursor = Vector2i();
  2078. }
  2079. void WaylandThread::_xdg_activation_token_on_done(void *data, struct xdg_activation_token_v1 *xdg_activation_token, const char *token) {
  2080. WindowState *ws = (WindowState *)data;
  2081. ERR_FAIL_NULL(ws);
  2082. ERR_FAIL_NULL(ws->wayland_thread);
  2083. ERR_FAIL_NULL(ws->wl_surface);
  2084. xdg_activation_v1_activate(ws->wayland_thread->registry.xdg_activation, token, ws->wl_surface);
  2085. xdg_activation_token_v1_destroy(xdg_activation_token);
  2086. DEBUG_LOG_WAYLAND_THREAD(vformat("Received activation token and requested window activation."));
  2087. }
  2088. // NOTE: This must be started after a valid wl_display is loaded.
  2089. void WaylandThread::_poll_events_thread(void *p_data) {
  2090. ThreadData *data = (ThreadData *)p_data;
  2091. ERR_FAIL_NULL(data);
  2092. ERR_FAIL_NULL(data->wl_display);
  2093. struct pollfd poll_fd;
  2094. poll_fd.fd = wl_display_get_fd(data->wl_display);
  2095. poll_fd.events = POLLIN | POLLHUP;
  2096. while (true) {
  2097. // Empty the event queue while it's full.
  2098. while (wl_display_prepare_read(data->wl_display) != 0) {
  2099. // We aren't using wl_display_dispatch(), instead "manually" handling events
  2100. // through wl_display_dispatch_pending so that we can use a global mutex and
  2101. // be sure that this and the main thread won't race over stuff, as long as
  2102. // the main thread locks it too.
  2103. //
  2104. // Note that the main thread can still call wl_display_roundtrip as that
  2105. // method directly handles all events, effectively bypassing this polling
  2106. // loop and thus the mutex locking, avoiding a deadlock.
  2107. MutexLock mutex_lock(data->mutex);
  2108. if (wl_display_dispatch_pending(data->wl_display) == -1) {
  2109. // Oh no. We'll check and handle any display error below.
  2110. break;
  2111. }
  2112. }
  2113. int werror = wl_display_get_error(data->wl_display);
  2114. if (werror) {
  2115. if (werror == EPROTO) {
  2116. struct wl_interface *wl_interface = nullptr;
  2117. uint32_t id = 0;
  2118. int error_code = wl_display_get_protocol_error(data->wl_display, (const struct wl_interface **)&wl_interface, &id);
  2119. CRASH_NOW_MSG(vformat("Wayland protocol error %d on interface %s@%d.", error_code, wl_interface ? wl_interface->name : "unknown", id));
  2120. } else {
  2121. CRASH_NOW_MSG(vformat("Wayland client error code %d.", werror));
  2122. }
  2123. }
  2124. wl_display_flush(data->wl_display);
  2125. // Wait for the event file descriptor to have new data.
  2126. poll(&poll_fd, 1, -1);
  2127. if (data->thread_done.is_set()) {
  2128. wl_display_cancel_read(data->wl_display);
  2129. break;
  2130. }
  2131. if (poll_fd.revents | POLLIN) {
  2132. // Load the queues with fresh new data.
  2133. wl_display_read_events(data->wl_display);
  2134. } else {
  2135. // Oh well... Stop signaling that we want to read.
  2136. wl_display_cancel_read(data->wl_display);
  2137. }
  2138. // The docs advise to redispatch unconditionally and it looks like that if we
  2139. // don't do this we can't catch protocol errors, which is bad.
  2140. MutexLock mutex_lock(data->mutex);
  2141. wl_display_dispatch_pending(data->wl_display);
  2142. }
  2143. }
  2144. struct wl_display *WaylandThread::get_wl_display() const {
  2145. return wl_display;
  2146. }
  2147. // NOTE: Stuff like libdecor can (and will) register foreign proxies which
  2148. // aren't formatted as we like. This method is needed to detect whether a proxy
  2149. // has our tag. Also, be careful! The proxy has to be manually tagged or it
  2150. // won't be recognized.
  2151. bool WaylandThread::wl_proxy_is_godot(struct wl_proxy *p_proxy) {
  2152. ERR_FAIL_NULL_V(p_proxy, false);
  2153. return wl_proxy_get_tag(p_proxy) == &proxy_tag;
  2154. }
  2155. void WaylandThread::wl_proxy_tag_godot(struct wl_proxy *p_proxy) {
  2156. ERR_FAIL_NULL(p_proxy);
  2157. wl_proxy_set_tag(p_proxy, &proxy_tag);
  2158. }
  2159. // Returns the wl_surface's `WindowState`, otherwise `nullptr`.
  2160. // NOTE: This will fail if the surface isn't tagged as ours.
  2161. WaylandThread::WindowState *WaylandThread::wl_surface_get_window_state(struct wl_surface *p_surface) {
  2162. if (p_surface && wl_proxy_is_godot((wl_proxy *)p_surface)) {
  2163. return (WindowState *)wl_surface_get_user_data(p_surface);
  2164. }
  2165. return nullptr;
  2166. }
  2167. // Returns the wl_outputs's `ScreenState`, otherwise `nullptr`.
  2168. // NOTE: This will fail if the output isn't tagged as ours.
  2169. WaylandThread::ScreenState *WaylandThread::wl_output_get_screen_state(struct wl_output *p_output) {
  2170. if (p_output && wl_proxy_is_godot((wl_proxy *)p_output)) {
  2171. return (ScreenState *)wl_output_get_user_data(p_output);
  2172. }
  2173. return nullptr;
  2174. }
  2175. // Returns the wl_seat's `SeatState`, otherwise `nullptr`.
  2176. // NOTE: This will fail if the output isn't tagged as ours.
  2177. WaylandThread::SeatState *WaylandThread::wl_seat_get_seat_state(struct wl_seat *p_seat) {
  2178. if (p_seat && wl_proxy_is_godot((wl_proxy *)p_seat)) {
  2179. return (SeatState *)wl_seat_get_user_data(p_seat);
  2180. }
  2181. return nullptr;
  2182. }
  2183. // Returns the wp_tablet_tool's `TabletToolState`, otherwise `nullptr`.
  2184. // NOTE: This will fail if the output isn't tagged as ours.
  2185. WaylandThread::TabletToolState *WaylandThread::wp_tablet_tool_get_state(struct zwp_tablet_tool_v2 *p_tool) {
  2186. if (p_tool && wl_proxy_is_godot((wl_proxy *)p_tool)) {
  2187. return (TabletToolState *)zwp_tablet_tool_v2_get_user_data(p_tool);
  2188. }
  2189. return nullptr;
  2190. }
  2191. // Returns the wl_data_offer's `OfferState`, otherwise `nullptr`.
  2192. // NOTE: This will fail if the output isn't tagged as ours.
  2193. WaylandThread::OfferState *WaylandThread::wl_data_offer_get_offer_state(struct wl_data_offer *p_offer) {
  2194. if (p_offer && wl_proxy_is_godot((wl_proxy *)p_offer)) {
  2195. return (OfferState *)wl_data_offer_get_user_data(p_offer);
  2196. }
  2197. return nullptr;
  2198. }
  2199. // Returns the wl_data_offer's `OfferState`, otherwise `nullptr`.
  2200. // NOTE: This will fail if the output isn't tagged as ours.
  2201. WaylandThread::OfferState *WaylandThread::wp_primary_selection_offer_get_offer_state(struct zwp_primary_selection_offer_v1 *p_offer) {
  2202. if (p_offer && wl_proxy_is_godot((wl_proxy *)p_offer)) {
  2203. return (OfferState *)zwp_primary_selection_offer_v1_get_user_data(p_offer);
  2204. }
  2205. return nullptr;
  2206. }
  2207. // This is implemented as a method because this is the simplest way of
  2208. // accounting for dynamic output scale changes.
  2209. int WaylandThread::window_state_get_preferred_buffer_scale(WindowState *p_ws) {
  2210. ERR_FAIL_NULL_V(p_ws, 1);
  2211. if (p_ws->preferred_fractional_scale > 0) {
  2212. // We're scaling fractionally. Per spec, the buffer scale is always 1.
  2213. return 1;
  2214. }
  2215. if (p_ws->wl_outputs.is_empty()) {
  2216. DEBUG_LOG_WAYLAND_THREAD("Window has no output associated, returning buffer scale of 1.");
  2217. return 1;
  2218. }
  2219. // TODO: Cache value?
  2220. int max_size = 1;
  2221. // ================================ IMPORTANT =================================
  2222. // NOTE: Due to a Godot limitation, we can't really rescale the whole UI yet.
  2223. // Because of this reason, all platforms have resorted to forcing the highest
  2224. // scale possible of a system on any window, despite of what screen it's onto.
  2225. // On this backend everything's already in place for dynamic window scale
  2226. // handling, but in the meantime we'll just select the biggest _global_ output.
  2227. // To restore dynamic scale selection, simply iterate over `p_ws->wl_outputs`
  2228. // instead.
  2229. for (struct wl_output *wl_output : p_ws->registry->wl_outputs) {
  2230. ScreenState *ss = wl_output_get_screen_state(wl_output);
  2231. if (ss && ss->pending_data.scale > max_size) {
  2232. // NOTE: For some mystical reason, wl_output.done is emitted _after_ windows
  2233. // get resized but the scale event gets sent _before_ that. I'm still leaning
  2234. // towards the idea that rescaling when a window gets a resolution change is a
  2235. // pretty good approach, but this means that we'll have to use the screen data
  2236. // before it's "committed".
  2237. // FIXME: Use the committed data. Somehow.
  2238. max_size = ss->pending_data.scale;
  2239. }
  2240. }
  2241. return max_size;
  2242. }
  2243. double WaylandThread::window_state_get_scale_factor(WindowState *p_ws) {
  2244. ERR_FAIL_NULL_V(p_ws, 1);
  2245. if (p_ws->fractional_scale > 0) {
  2246. // The fractional scale amount takes priority.
  2247. return p_ws->fractional_scale;
  2248. }
  2249. return p_ws->buffer_scale;
  2250. }
  2251. void WaylandThread::window_state_update_size(WindowState *p_ws, int p_width, int p_height) {
  2252. ERR_FAIL_NULL(p_ws);
  2253. int preferred_buffer_scale = window_state_get_preferred_buffer_scale(p_ws);
  2254. bool using_fractional = p_ws->preferred_fractional_scale > 0;
  2255. // If neither is true we no-op.
  2256. bool scale_changed = false;
  2257. bool size_changed = false;
  2258. if (p_ws->rect.size.width != p_width || p_ws->rect.size.height != p_height) {
  2259. p_ws->rect.size.width = p_width;
  2260. p_ws->rect.size.height = p_height;
  2261. size_changed = true;
  2262. }
  2263. if (using_fractional && p_ws->fractional_scale != p_ws->preferred_fractional_scale) {
  2264. p_ws->fractional_scale = p_ws->preferred_fractional_scale;
  2265. scale_changed = true;
  2266. }
  2267. if (p_ws->buffer_scale != preferred_buffer_scale) {
  2268. // The buffer scale is always important, even if we use frac scaling.
  2269. p_ws->buffer_scale = preferred_buffer_scale;
  2270. p_ws->buffer_scale_changed = true;
  2271. if (!using_fractional) {
  2272. // We don't bother updating everything else if it's turned on though.
  2273. scale_changed = true;
  2274. }
  2275. }
  2276. if (p_ws->wl_surface && (size_changed || scale_changed)) {
  2277. if (p_ws->wp_viewport) {
  2278. wp_viewport_set_destination(p_ws->wp_viewport, p_width, p_height);
  2279. }
  2280. if (p_ws->xdg_surface) {
  2281. xdg_surface_set_window_geometry(p_ws->xdg_surface, 0, 0, p_width, p_height);
  2282. }
  2283. }
  2284. #ifdef LIBDECOR_ENABLED
  2285. if (p_ws->libdecor_frame) {
  2286. struct libdecor_state *state = libdecor_state_new(p_width, p_height);
  2287. libdecor_frame_commit(p_ws->libdecor_frame, state, p_ws->pending_libdecor_configuration);
  2288. libdecor_state_free(state);
  2289. p_ws->pending_libdecor_configuration = nullptr;
  2290. }
  2291. #endif
  2292. if (size_changed || scale_changed) {
  2293. Size2i scaled_size = scale_vector2i(p_ws->rect.size, window_state_get_scale_factor(p_ws));
  2294. if (using_fractional) {
  2295. DEBUG_LOG_WAYLAND_THREAD(vformat("Resizing the window from %s to %s (fractional scale x%f).", p_ws->rect.size, scaled_size, p_ws->fractional_scale));
  2296. } else {
  2297. DEBUG_LOG_WAYLAND_THREAD(vformat("Resizing the window from %s to %s (buffer scale x%d).", p_ws->rect.size, scaled_size, p_ws->buffer_scale));
  2298. }
  2299. // FIXME: Actually resize the hint instead of centering it.
  2300. p_ws->wayland_thread->pointer_set_hint(scaled_size / 2);
  2301. Ref<WindowRectMessage> rect_msg;
  2302. rect_msg.instantiate();
  2303. rect_msg->rect = p_ws->rect;
  2304. rect_msg->rect.size = scaled_size;
  2305. p_ws->wayland_thread->push_message(rect_msg);
  2306. }
  2307. if (scale_changed) {
  2308. Ref<WindowEventMessage> dpi_msg;
  2309. dpi_msg.instantiate();
  2310. dpi_msg->event = DisplayServer::WINDOW_EVENT_DPI_CHANGE;
  2311. p_ws->wayland_thread->push_message(dpi_msg);
  2312. }
  2313. }
  2314. // Scales a vector according to wp_fractional_scale's rules, where coordinates
  2315. // must be scaled with away from zero half-rounding.
  2316. Vector2i WaylandThread::scale_vector2i(const Vector2i &p_vector, double p_amount) {
  2317. // This snippet is tiny, I know, but this is done a lot.
  2318. int x = round(p_vector.x * p_amount);
  2319. int y = round(p_vector.y * p_amount);
  2320. return Vector2i(x, y);
  2321. }
  2322. void WaylandThread::seat_state_unlock_pointer(SeatState *p_ss) {
  2323. ERR_FAIL_NULL(p_ss);
  2324. if (p_ss->wl_pointer == nullptr) {
  2325. return;
  2326. }
  2327. if (p_ss->wp_locked_pointer) {
  2328. zwp_locked_pointer_v1_destroy(p_ss->wp_locked_pointer);
  2329. p_ss->wp_locked_pointer = nullptr;
  2330. }
  2331. if (p_ss->wp_confined_pointer) {
  2332. zwp_confined_pointer_v1_destroy(p_ss->wp_confined_pointer);
  2333. p_ss->wp_confined_pointer = nullptr;
  2334. }
  2335. }
  2336. void WaylandThread::seat_state_lock_pointer(SeatState *p_ss) {
  2337. ERR_FAIL_NULL(p_ss);
  2338. if (p_ss->wl_pointer == nullptr) {
  2339. return;
  2340. }
  2341. if (registry.wp_pointer_constraints == nullptr) {
  2342. return;
  2343. }
  2344. if (p_ss->wp_locked_pointer == nullptr) {
  2345. struct wl_surface *locked_surface = p_ss->last_pointed_surface;
  2346. if (locked_surface == nullptr) {
  2347. locked_surface = window_get_wl_surface(DisplayServer::MAIN_WINDOW_ID);
  2348. }
  2349. ERR_FAIL_NULL(locked_surface);
  2350. p_ss->wp_locked_pointer = zwp_pointer_constraints_v1_lock_pointer(registry.wp_pointer_constraints, locked_surface, p_ss->wl_pointer, nullptr, ZWP_POINTER_CONSTRAINTS_V1_LIFETIME_PERSISTENT);
  2351. }
  2352. }
  2353. void WaylandThread::seat_state_set_hint(SeatState *p_ss, int p_x, int p_y) {
  2354. if (p_ss->wp_locked_pointer == nullptr) {
  2355. return;
  2356. }
  2357. zwp_locked_pointer_v1_set_cursor_position_hint(p_ss->wp_locked_pointer, wl_fixed_from_int(p_x), wl_fixed_from_int(p_y));
  2358. }
  2359. void WaylandThread::seat_state_confine_pointer(SeatState *p_ss) {
  2360. ERR_FAIL_NULL(p_ss);
  2361. if (p_ss->wl_pointer == nullptr) {
  2362. return;
  2363. }
  2364. if (registry.wp_pointer_constraints == nullptr) {
  2365. return;
  2366. }
  2367. if (p_ss->wp_confined_pointer == nullptr) {
  2368. struct wl_surface *confined_surface = p_ss->last_pointed_surface;
  2369. if (confined_surface == nullptr) {
  2370. confined_surface = window_get_wl_surface(DisplayServer::MAIN_WINDOW_ID);
  2371. }
  2372. ERR_FAIL_NULL(confined_surface);
  2373. p_ss->wp_confined_pointer = zwp_pointer_constraints_v1_confine_pointer(registry.wp_pointer_constraints, confined_surface, p_ss->wl_pointer, nullptr, ZWP_POINTER_CONSTRAINTS_V1_LIFETIME_PERSISTENT);
  2374. }
  2375. }
  2376. void WaylandThread::seat_state_update_cursor(SeatState *p_ss) {
  2377. ERR_FAIL_NULL(p_ss);
  2378. WaylandThread *thread = p_ss->wayland_thread;
  2379. ERR_FAIL_NULL(p_ss->wayland_thread);
  2380. if (!p_ss->wl_pointer || !p_ss->cursor_surface) {
  2381. return;
  2382. }
  2383. // NOTE: Those values are valid by default and will hide the cursor when
  2384. // unchanged.
  2385. struct wl_buffer *cursor_buffer = nullptr;
  2386. uint32_t hotspot_x = 0;
  2387. uint32_t hotspot_y = 0;
  2388. int scale = 1;
  2389. if (thread->cursor_visible) {
  2390. DisplayServer::CursorShape shape = thread->cursor_shape;
  2391. struct CustomCursor *custom_cursor = thread->custom_cursors.getptr(shape);
  2392. if (custom_cursor) {
  2393. cursor_buffer = custom_cursor->wl_buffer;
  2394. hotspot_x = custom_cursor->hotspot.x;
  2395. hotspot_y = custom_cursor->hotspot.y;
  2396. // We can't really reasonably scale custom cursors, so we'll let the
  2397. // compositor do it for us (badly).
  2398. scale = 1;
  2399. } else {
  2400. struct wl_cursor *wl_cursor = thread->wl_cursors[shape];
  2401. if (!wl_cursor) {
  2402. return;
  2403. }
  2404. int frame_idx = 0;
  2405. if (wl_cursor->image_count > 1) {
  2406. // The cursor is animated.
  2407. frame_idx = wl_cursor_frame(wl_cursor, p_ss->cursor_time_ms);
  2408. if (!p_ss->cursor_frame_callback) {
  2409. // Since it's animated, we'll re-update it the next frame.
  2410. p_ss->cursor_frame_callback = wl_surface_frame(p_ss->cursor_surface);
  2411. wl_callback_add_listener(p_ss->cursor_frame_callback, &cursor_frame_callback_listener, p_ss);
  2412. }
  2413. }
  2414. struct wl_cursor_image *wl_cursor_image = wl_cursor->images[frame_idx];
  2415. scale = thread->cursor_scale;
  2416. cursor_buffer = wl_cursor_image_get_buffer(wl_cursor_image);
  2417. // As the surface's buffer is scaled (thus the surface is smaller) and the
  2418. // hotspot must be expressed in surface-local coordinates, we need to scale
  2419. // it down accordingly.
  2420. hotspot_x = wl_cursor_image->hotspot_x / scale;
  2421. hotspot_y = wl_cursor_image->hotspot_y / scale;
  2422. }
  2423. }
  2424. wl_pointer_set_cursor(p_ss->wl_pointer, p_ss->pointer_enter_serial, p_ss->cursor_surface, hotspot_x, hotspot_y);
  2425. wl_surface_set_buffer_scale(p_ss->cursor_surface, scale);
  2426. wl_surface_attach(p_ss->cursor_surface, cursor_buffer, 0, 0);
  2427. wl_surface_damage_buffer(p_ss->cursor_surface, 0, 0, INT_MAX, INT_MAX);
  2428. wl_surface_commit(p_ss->cursor_surface);
  2429. }
  2430. void WaylandThread::seat_state_echo_keys(SeatState *p_ss) {
  2431. ERR_FAIL_NULL(p_ss);
  2432. if (p_ss->wl_keyboard == nullptr) {
  2433. return;
  2434. }
  2435. // TODO: Comment and document out properly this block of code.
  2436. // In short, this implements key repeating.
  2437. if (p_ss->repeat_key_delay_msec && p_ss->repeating_keycode != XKB_KEYCODE_INVALID) {
  2438. uint64_t current_ticks = OS::get_singleton()->get_ticks_msec();
  2439. uint64_t delayed_start_ticks = p_ss->last_repeat_start_msec + p_ss->repeat_start_delay_msec;
  2440. if (p_ss->last_repeat_msec < delayed_start_ticks) {
  2441. p_ss->last_repeat_msec = delayed_start_ticks;
  2442. }
  2443. if (current_ticks >= delayed_start_ticks) {
  2444. uint64_t ticks_delta = current_ticks - p_ss->last_repeat_msec;
  2445. int keys_amount = (ticks_delta / p_ss->repeat_key_delay_msec);
  2446. for (int i = 0; i < keys_amount; i++) {
  2447. Ref<InputEventKey> k;
  2448. k.instantiate();
  2449. if (!_seat_state_configure_key_event(*p_ss, k, p_ss->repeating_keycode, true)) {
  2450. continue;
  2451. }
  2452. k->set_echo(true);
  2453. Input::get_singleton()->parse_input_event(k);
  2454. }
  2455. p_ss->last_repeat_msec += ticks_delta - (ticks_delta % p_ss->repeat_key_delay_msec);
  2456. }
  2457. }
  2458. }
  2459. void WaylandThread::push_message(Ref<Message> message) {
  2460. messages.push_back(message);
  2461. }
  2462. bool WaylandThread::has_message() {
  2463. return messages.front() != nullptr;
  2464. }
  2465. Ref<WaylandThread::Message> WaylandThread::pop_message() {
  2466. if (messages.front() != nullptr) {
  2467. Ref<Message> msg = messages.front()->get();
  2468. messages.pop_front();
  2469. return msg;
  2470. }
  2471. // This method should only be called if `has_messages` returns true but if
  2472. // that isn't the case we'll just return an invalid `Ref`. After all, due to
  2473. // its `InputEvent`-like interface, we still have to dynamically cast and check
  2474. // the `Ref`'s validity anyways.
  2475. return Ref<Message>();
  2476. }
  2477. void WaylandThread::window_create(DisplayServer::WindowID p_window_id, int p_width, int p_height) {
  2478. // TODO: Implement multi-window support.
  2479. WindowState &ws = main_window;
  2480. ws.registry = &registry;
  2481. ws.wayland_thread = this;
  2482. ws.rect.size.width = p_width;
  2483. ws.rect.size.height = p_height;
  2484. ws.wl_surface = wl_compositor_create_surface(registry.wl_compositor);
  2485. wl_proxy_tag_godot((struct wl_proxy *)ws.wl_surface);
  2486. wl_surface_add_listener(ws.wl_surface, &wl_surface_listener, &ws);
  2487. if (registry.wp_viewporter) {
  2488. ws.wp_viewport = wp_viewporter_get_viewport(registry.wp_viewporter, ws.wl_surface);
  2489. if (registry.wp_fractional_scale_manager) {
  2490. ws.wp_fractional_scale = wp_fractional_scale_manager_v1_get_fractional_scale(registry.wp_fractional_scale_manager, ws.wl_surface);
  2491. wp_fractional_scale_v1_add_listener(ws.wp_fractional_scale, &wp_fractional_scale_listener, &ws);
  2492. }
  2493. }
  2494. bool decorated = false;
  2495. #ifdef LIBDECOR_ENABLED
  2496. if (!decorated && libdecor_context) {
  2497. ws.libdecor_frame = libdecor_decorate(libdecor_context, ws.wl_surface, (struct libdecor_frame_interface *)&libdecor_frame_interface, &ws);
  2498. libdecor_frame_map(ws.libdecor_frame);
  2499. decorated = true;
  2500. }
  2501. #endif
  2502. if (!decorated) {
  2503. // libdecor has failed loading or is disabled, we shall handle xdg_toplevel
  2504. // creation and decoration ourselves (and by decorating for now I just mean
  2505. // asking for SSDs and hoping for the best).
  2506. ws.xdg_surface = xdg_wm_base_get_xdg_surface(registry.xdg_wm_base, ws.wl_surface);
  2507. xdg_surface_add_listener(ws.xdg_surface, &xdg_surface_listener, &ws);
  2508. ws.xdg_toplevel = xdg_surface_get_toplevel(ws.xdg_surface);
  2509. xdg_toplevel_add_listener(ws.xdg_toplevel, &xdg_toplevel_listener, &ws);
  2510. if (registry.xdg_decoration_manager) {
  2511. ws.xdg_toplevel_decoration = zxdg_decoration_manager_v1_get_toplevel_decoration(registry.xdg_decoration_manager, ws.xdg_toplevel);
  2512. zxdg_toplevel_decoration_v1_add_listener(ws.xdg_toplevel_decoration, &xdg_toplevel_decoration_listener, &ws);
  2513. decorated = true;
  2514. }
  2515. }
  2516. ws.frame_callback = wl_surface_frame(ws.wl_surface);
  2517. wl_callback_add_listener(ws.frame_callback, &frame_wl_callback_listener, &ws);
  2518. if (registry.xdg_exporter) {
  2519. ws.xdg_exported = zxdg_exporter_v1_export(registry.xdg_exporter, ws.wl_surface);
  2520. zxdg_exported_v1_add_listener(ws.xdg_exported, &xdg_exported_listener, &ws);
  2521. }
  2522. wl_surface_commit(ws.wl_surface);
  2523. // Wait for the surface to be configured before continuing.
  2524. wl_display_roundtrip(wl_display);
  2525. }
  2526. struct wl_surface *WaylandThread::window_get_wl_surface(DisplayServer::WindowID p_window_id) const {
  2527. // TODO: Use window IDs for multiwindow support.
  2528. const WindowState &ws = main_window;
  2529. return ws.wl_surface;
  2530. }
  2531. void WaylandThread::beep() const {
  2532. if (registry.xdg_system_bell) {
  2533. xdg_system_bell_v1_ring(registry.xdg_system_bell, nullptr);
  2534. }
  2535. }
  2536. void WaylandThread::window_set_max_size(DisplayServer::WindowID p_window_id, const Size2i &p_size) {
  2537. // TODO: Use window IDs for multiwindow support.
  2538. WindowState &ws = main_window;
  2539. Vector2i logical_max_size = p_size / window_state_get_scale_factor(&ws);
  2540. if (ws.wl_surface && ws.xdg_toplevel) {
  2541. xdg_toplevel_set_max_size(ws.xdg_toplevel, logical_max_size.width, logical_max_size.height);
  2542. }
  2543. #ifdef LIBDECOR_ENABLED
  2544. if (ws.libdecor_frame) {
  2545. libdecor_frame_set_max_content_size(ws.libdecor_frame, logical_max_size.width, logical_max_size.height);
  2546. }
  2547. // FIXME: I'm not sure whether we have to commit the surface for this to apply.
  2548. #endif
  2549. }
  2550. void WaylandThread::window_set_min_size(DisplayServer::WindowID p_window_id, const Size2i &p_size) {
  2551. // TODO: Use window IDs for multiwindow support.
  2552. WindowState &ws = main_window;
  2553. Size2i logical_min_size = p_size / window_state_get_scale_factor(&ws);
  2554. if (ws.wl_surface && ws.xdg_toplevel) {
  2555. xdg_toplevel_set_min_size(ws.xdg_toplevel, logical_min_size.width, logical_min_size.height);
  2556. }
  2557. #ifdef LIBDECOR_ENABLED
  2558. if (ws.libdecor_frame) {
  2559. libdecor_frame_set_min_content_size(ws.libdecor_frame, logical_min_size.width, logical_min_size.height);
  2560. }
  2561. // FIXME: I'm not sure whether we have to commit the surface for this to apply.
  2562. #endif
  2563. }
  2564. bool WaylandThread::window_can_set_mode(DisplayServer::WindowID p_window_id, DisplayServer::WindowMode p_window_mode) const {
  2565. // TODO: Use window IDs for multiwindow support.
  2566. const WindowState &ws = main_window;
  2567. switch (p_window_mode) {
  2568. case DisplayServer::WINDOW_MODE_WINDOWED: {
  2569. // Looks like it's guaranteed.
  2570. return true;
  2571. };
  2572. case DisplayServer::WINDOW_MODE_MINIMIZED: {
  2573. #ifdef LIBDECOR_ENABLED
  2574. if (ws.libdecor_frame) {
  2575. return libdecor_frame_has_capability(ws.libdecor_frame, LIBDECOR_ACTION_MINIMIZE);
  2576. }
  2577. #endif // LIBDECOR_ENABLED
  2578. return ws.can_minimize;
  2579. };
  2580. case DisplayServer::WINDOW_MODE_MAXIMIZED: {
  2581. // NOTE: libdecor doesn't seem to have a maximize capability query?
  2582. // The fact that there's a fullscreen one makes me suspicious.
  2583. return ws.can_maximize;
  2584. };
  2585. case DisplayServer::WINDOW_MODE_FULLSCREEN: {
  2586. #ifdef LIBDECOR_ENABLED
  2587. if (ws.libdecor_frame) {
  2588. return libdecor_frame_has_capability(ws.libdecor_frame, LIBDECOR_ACTION_FULLSCREEN);
  2589. }
  2590. #endif // LIBDECOR_ENABLED
  2591. return ws.can_fullscreen;
  2592. };
  2593. case DisplayServer::WINDOW_MODE_EXCLUSIVE_FULLSCREEN: {
  2594. // I'm not really sure but from what I can find Wayland doesn't really have
  2595. // the concept of exclusive fullscreen.
  2596. // TODO: Discuss whether to fallback to regular fullscreen or not.
  2597. return false;
  2598. };
  2599. }
  2600. return false;
  2601. }
  2602. void WaylandThread::window_try_set_mode(DisplayServer::WindowID p_window_id, DisplayServer::WindowMode p_window_mode) {
  2603. // TODO: Use window IDs for multiwindow support.
  2604. WindowState &ws = main_window;
  2605. if (ws.mode == p_window_mode) {
  2606. return;
  2607. }
  2608. // Don't waste time with hidden windows and whatnot. Behave like it worked.
  2609. #ifdef LIBDECOR_ENABLED
  2610. if ((!ws.wl_surface || !ws.xdg_toplevel) && !ws.libdecor_frame) {
  2611. #else
  2612. if (!ws.wl_surface || !ws.xdg_toplevel) {
  2613. #endif // LIBDECOR_ENABLED
  2614. ws.mode = p_window_mode;
  2615. return;
  2616. }
  2617. // Return back to a windowed state so that we can apply what the user asked.
  2618. switch (ws.mode) {
  2619. case DisplayServer::WINDOW_MODE_WINDOWED: {
  2620. // Do nothing.
  2621. } break;
  2622. case DisplayServer::WINDOW_MODE_MINIMIZED: {
  2623. // We can't do much according to the xdg_shell protocol. I have no idea
  2624. // whether this implies that we should return or who knows what. For now
  2625. // we'll do nothing.
  2626. // TODO: Test this properly.
  2627. } break;
  2628. case DisplayServer::WINDOW_MODE_MAXIMIZED: {
  2629. // Try to unmaximize. This isn't garaunteed to work actually, so we'll have
  2630. // to check whether something changed.
  2631. if (ws.xdg_toplevel) {
  2632. xdg_toplevel_unset_maximized(ws.xdg_toplevel);
  2633. }
  2634. #ifdef LIBDECOR_ENABLED
  2635. if (ws.libdecor_frame) {
  2636. libdecor_frame_unset_maximized(ws.libdecor_frame);
  2637. }
  2638. #endif // LIBDECOR_ENABLED
  2639. } break;
  2640. case DisplayServer::WINDOW_MODE_FULLSCREEN:
  2641. case DisplayServer::WINDOW_MODE_EXCLUSIVE_FULLSCREEN: {
  2642. // Same thing as above, unset fullscreen and check later if it worked.
  2643. if (ws.xdg_toplevel) {
  2644. xdg_toplevel_unset_fullscreen(ws.xdg_toplevel);
  2645. }
  2646. #ifdef LIBDECOR_ENABLED
  2647. if (ws.libdecor_frame) {
  2648. libdecor_frame_unset_fullscreen(ws.libdecor_frame);
  2649. }
  2650. #endif // LIBDECOR_ENABLED
  2651. } break;
  2652. }
  2653. // Wait for a configure event and hope that something changed.
  2654. wl_display_roundtrip(wl_display);
  2655. if (ws.mode != DisplayServer::WINDOW_MODE_WINDOWED) {
  2656. // The compositor refused our "normalization" request. It'd be useless or
  2657. // unpredictable to attempt setting a new state. We're done.
  2658. return;
  2659. }
  2660. // Ask the compositor to set the state indicated by the new mode.
  2661. switch (p_window_mode) {
  2662. case DisplayServer::WINDOW_MODE_WINDOWED: {
  2663. // Do nothing. We're already windowed.
  2664. } break;
  2665. case DisplayServer::WINDOW_MODE_MINIMIZED: {
  2666. if (!window_can_set_mode(p_window_id, p_window_mode)) {
  2667. // Minimization is special (read below). Better not mess with it if the
  2668. // compositor explicitly announces that it doesn't support it.
  2669. break;
  2670. }
  2671. if (ws.xdg_toplevel) {
  2672. xdg_toplevel_set_minimized(ws.xdg_toplevel);
  2673. }
  2674. #ifdef LIBDECOR_ENABLED
  2675. if (ws.libdecor_frame) {
  2676. libdecor_frame_set_minimized(ws.libdecor_frame);
  2677. }
  2678. #endif // LIBDECOR_ENABLED
  2679. // We have no way to actually detect this state, so we'll have to report it
  2680. // manually to the engine (hoping that it worked). In the worst case it'll
  2681. // get reset by the next configure event.
  2682. ws.mode = DisplayServer::WINDOW_MODE_MINIMIZED;
  2683. } break;
  2684. case DisplayServer::WINDOW_MODE_MAXIMIZED: {
  2685. if (ws.xdg_toplevel) {
  2686. xdg_toplevel_set_maximized(ws.xdg_toplevel);
  2687. }
  2688. #ifdef LIBDECOR_ENABLED
  2689. if (ws.libdecor_frame) {
  2690. libdecor_frame_set_maximized(ws.libdecor_frame);
  2691. }
  2692. #endif // LIBDECOR_ENABLED
  2693. } break;
  2694. case DisplayServer::WINDOW_MODE_FULLSCREEN: {
  2695. if (ws.xdg_toplevel) {
  2696. xdg_toplevel_set_fullscreen(ws.xdg_toplevel, nullptr);
  2697. }
  2698. #ifdef LIBDECOR_ENABLED
  2699. if (ws.libdecor_frame) {
  2700. libdecor_frame_set_fullscreen(ws.libdecor_frame, nullptr);
  2701. }
  2702. #endif // LIBDECOR_ENABLED
  2703. } break;
  2704. default: {
  2705. } break;
  2706. }
  2707. }
  2708. void WaylandThread::window_set_borderless(DisplayServer::WindowID p_window_id, bool p_borderless) {
  2709. // TODO: Use window IDs for multiwindow support.
  2710. WindowState &ws = main_window;
  2711. if (ws.xdg_toplevel_decoration) {
  2712. if (p_borderless) {
  2713. // We implement borderless windows by simply asking the compositor to let
  2714. // us handle decorations (we don't).
  2715. zxdg_toplevel_decoration_v1_set_mode(ws.xdg_toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_CLIENT_SIDE);
  2716. } else {
  2717. zxdg_toplevel_decoration_v1_set_mode(ws.xdg_toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
  2718. }
  2719. }
  2720. #ifdef LIBDECOR_ENABLED
  2721. if (ws.libdecor_frame) {
  2722. bool visible_current = libdecor_frame_is_visible(ws.libdecor_frame);
  2723. bool visible_target = !p_borderless;
  2724. // NOTE: We have to do this otherwise we trip on a libdecor bug where it's
  2725. // possible to destroy the frame more than once, by setting the visibility
  2726. // to false multiple times and thus crashing.
  2727. if (visible_current != visible_target) {
  2728. print_verbose(vformat("Setting libdecor frame visibility to %d", visible_target));
  2729. libdecor_frame_set_visibility(ws.libdecor_frame, visible_target);
  2730. }
  2731. }
  2732. #endif // LIBDECOR_ENABLED
  2733. }
  2734. void WaylandThread::window_set_title(DisplayServer::WindowID p_window_id, const String &p_title) {
  2735. // TODO: Use window IDs for multiwindow support.
  2736. WindowState &ws = main_window;
  2737. #ifdef LIBDECOR_ENABLED
  2738. if (ws.libdecor_frame) {
  2739. libdecor_frame_set_title(ws.libdecor_frame, p_title.utf8());
  2740. }
  2741. #endif // LIBDECOR_ENABLE
  2742. if (ws.xdg_toplevel) {
  2743. xdg_toplevel_set_title(ws.xdg_toplevel, p_title.utf8());
  2744. }
  2745. }
  2746. void WaylandThread::window_set_app_id(DisplayServer::WindowID p_window_id, const String &p_app_id) {
  2747. // TODO: Use window IDs for multiwindow support.
  2748. WindowState &ws = main_window;
  2749. #ifdef LIBDECOR_ENABLED
  2750. if (ws.libdecor_frame) {
  2751. libdecor_frame_set_app_id(ws.libdecor_frame, p_app_id.utf8());
  2752. return;
  2753. }
  2754. #endif // LIBDECOR_ENABLED
  2755. if (ws.xdg_toplevel) {
  2756. xdg_toplevel_set_app_id(ws.xdg_toplevel, p_app_id.utf8());
  2757. return;
  2758. }
  2759. }
  2760. DisplayServer::WindowMode WaylandThread::window_get_mode(DisplayServer::WindowID p_window_id) const {
  2761. // TODO: Use window IDs for multiwindow support.
  2762. const WindowState &ws = main_window;
  2763. return ws.mode;
  2764. }
  2765. void WaylandThread::window_request_attention(DisplayServer::WindowID p_window_id) {
  2766. // TODO: Use window IDs for multiwindow support.
  2767. WindowState &ws = main_window;
  2768. if (registry.xdg_activation) {
  2769. // Window attention requests are done through the XDG activation protocol.
  2770. xdg_activation_token_v1 *xdg_activation_token = xdg_activation_v1_get_activation_token(registry.xdg_activation);
  2771. xdg_activation_token_v1_add_listener(xdg_activation_token, &xdg_activation_token_listener, &ws);
  2772. xdg_activation_token_v1_commit(xdg_activation_token);
  2773. }
  2774. }
  2775. void WaylandThread::window_set_idle_inhibition(DisplayServer::WindowID p_window_id, bool p_enable) {
  2776. // TODO: Use window IDs for multiwindow support.
  2777. WindowState &ws = main_window;
  2778. if (p_enable) {
  2779. if (ws.registry->wp_idle_inhibit_manager && !ws.wp_idle_inhibitor) {
  2780. ERR_FAIL_NULL(ws.wl_surface);
  2781. ws.wp_idle_inhibitor = zwp_idle_inhibit_manager_v1_create_inhibitor(ws.registry->wp_idle_inhibit_manager, ws.wl_surface);
  2782. }
  2783. } else {
  2784. if (ws.wp_idle_inhibitor) {
  2785. zwp_idle_inhibitor_v1_destroy(ws.wp_idle_inhibitor);
  2786. ws.wp_idle_inhibitor = nullptr;
  2787. }
  2788. }
  2789. }
  2790. bool WaylandThread::window_get_idle_inhibition(DisplayServer::WindowID p_window_id) const {
  2791. // TODO: Use window IDs for multiwindow support.
  2792. const WindowState &ws = main_window;
  2793. return ws.wp_idle_inhibitor != nullptr;
  2794. }
  2795. WaylandThread::ScreenData WaylandThread::screen_get_data(int p_screen) const {
  2796. ERR_FAIL_INDEX_V(p_screen, registry.wl_outputs.size(), ScreenData());
  2797. return wl_output_get_screen_state(registry.wl_outputs.get(p_screen))->data;
  2798. }
  2799. int WaylandThread::get_screen_count() const {
  2800. return registry.wl_outputs.size();
  2801. }
  2802. DisplayServer::WindowID WaylandThread::pointer_get_pointed_window_id() const {
  2803. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  2804. if (ss) {
  2805. WindowState *ws = wl_surface_get_window_state(ss->pointed_surface);
  2806. if (ws) {
  2807. return ws->id;
  2808. }
  2809. }
  2810. return DisplayServer::INVALID_WINDOW_ID;
  2811. }
  2812. void WaylandThread::pointer_set_constraint(PointerConstraint p_constraint) {
  2813. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  2814. if (ss) {
  2815. seat_state_unlock_pointer(ss);
  2816. if (p_constraint == PointerConstraint::LOCKED) {
  2817. seat_state_lock_pointer(ss);
  2818. } else if (p_constraint == PointerConstraint::CONFINED) {
  2819. seat_state_confine_pointer(ss);
  2820. }
  2821. }
  2822. pointer_constraint = p_constraint;
  2823. }
  2824. void WaylandThread::pointer_set_hint(const Point2i &p_hint) {
  2825. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  2826. if (!ss) {
  2827. return;
  2828. }
  2829. WindowState *ws = wl_surface_get_window_state(ss->pointed_surface);
  2830. int hint_x = 0;
  2831. int hint_y = 0;
  2832. if (ws) {
  2833. // NOTE: It looks like it's not really recommended to convert from
  2834. // "godot-space" to "wayland-space" and in general I received mixed feelings
  2835. // discussing about this. I'm not really sure about the maths behind this but,
  2836. // oh well, we're setting a cursor hint. ¯\_(ツ)_/¯
  2837. // See: https://oftc.irclog.whitequark.org/wayland/2023-08-23#1692756914-1692816818
  2838. hint_x = round(p_hint.x / window_state_get_scale_factor(ws));
  2839. hint_y = round(p_hint.y / window_state_get_scale_factor(ws));
  2840. }
  2841. if (ss) {
  2842. seat_state_set_hint(ss, hint_x, hint_y);
  2843. }
  2844. }
  2845. WaylandThread::PointerConstraint WaylandThread::pointer_get_constraint() const {
  2846. return pointer_constraint;
  2847. }
  2848. BitField<MouseButtonMask> WaylandThread::pointer_get_button_mask() const {
  2849. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  2850. if (ss) {
  2851. return ss->pointer_data.pressed_button_mask;
  2852. }
  2853. return BitField<MouseButtonMask>();
  2854. }
  2855. Error WaylandThread::init() {
  2856. #ifdef SOWRAP_ENABLED
  2857. #ifdef DEBUG_ENABLED
  2858. int dylibloader_verbose = 1;
  2859. #else
  2860. int dylibloader_verbose = 0;
  2861. #endif // DEBUG_ENABLED
  2862. if (initialize_wayland_client(dylibloader_verbose) != 0) {
  2863. WARN_PRINT("Can't load the Wayland client library.");
  2864. return ERR_CANT_CREATE;
  2865. }
  2866. if (initialize_wayland_cursor(dylibloader_verbose) != 0) {
  2867. WARN_PRINT("Can't load the Wayland cursor library.");
  2868. return ERR_CANT_CREATE;
  2869. }
  2870. if (initialize_xkbcommon(dylibloader_verbose) != 0) {
  2871. WARN_PRINT("Can't load the XKBcommon library.");
  2872. return ERR_CANT_CREATE;
  2873. }
  2874. #endif // SOWRAP_ENABLED
  2875. KeyMappingXKB::initialize();
  2876. wl_display = wl_display_connect(nullptr);
  2877. ERR_FAIL_NULL_V_MSG(wl_display, ERR_CANT_CREATE, "Can't connect to a Wayland display.");
  2878. thread_data.wl_display = wl_display;
  2879. events_thread.start(_poll_events_thread, &thread_data);
  2880. wl_registry = wl_display_get_registry(wl_display);
  2881. ERR_FAIL_NULL_V_MSG(wl_registry, ERR_UNAVAILABLE, "Can't obtain the Wayland registry global.");
  2882. registry.wayland_thread = this;
  2883. wl_registry_add_listener(wl_registry, &wl_registry_listener, &registry);
  2884. // Wait for registry to get notified from the compositor.
  2885. wl_display_roundtrip(wl_display);
  2886. ERR_FAIL_NULL_V_MSG(registry.wl_shm, ERR_UNAVAILABLE, "Can't obtain the Wayland shared memory global.");
  2887. ERR_FAIL_NULL_V_MSG(registry.wl_compositor, ERR_UNAVAILABLE, "Can't obtain the Wayland compositor global.");
  2888. ERR_FAIL_NULL_V_MSG(registry.xdg_wm_base, ERR_UNAVAILABLE, "Can't obtain the Wayland XDG shell global.");
  2889. if (!registry.xdg_decoration_manager) {
  2890. #ifdef LIBDECOR_ENABLED
  2891. WARN_PRINT("Can't obtain the XDG decoration manager. Libdecor will be used for drawing CSDs, if available.");
  2892. #else
  2893. WARN_PRINT("Can't obtain the XDG decoration manager. Decorations won't show up.");
  2894. #endif // LIBDECOR_ENABLED
  2895. }
  2896. if (!registry.xdg_activation) {
  2897. WARN_PRINT("Can't obtain the XDG activation global. Attention requesting won't work!");
  2898. }
  2899. #ifndef DBUS_ENABLED
  2900. if (!registry.wp_idle_inhibit_manager) {
  2901. WARN_PRINT("Can't obtain the idle inhibition manager. The screen might turn off even after calling screen_set_keep_on()!");
  2902. }
  2903. #endif // DBUS_ENABLED
  2904. // Wait for seat capabilities.
  2905. wl_display_roundtrip(wl_display);
  2906. #ifdef LIBDECOR_ENABLED
  2907. bool libdecor_found = true;
  2908. #ifdef SOWRAP_ENABLED
  2909. if (initialize_libdecor(dylibloader_verbose) != 0) {
  2910. libdecor_found = false;
  2911. }
  2912. #endif // SOWRAP_ENABLED
  2913. if (libdecor_found) {
  2914. libdecor_context = libdecor_new(wl_display, (struct libdecor_interface *)&libdecor_interface);
  2915. } else {
  2916. print_verbose("libdecor not found. Client-side decorations disabled.");
  2917. }
  2918. #endif // LIBDECOR_ENABLED
  2919. cursor_theme_name = OS::get_singleton()->get_environment("XCURSOR_THEME");
  2920. unscaled_cursor_size = OS::get_singleton()->get_environment("XCURSOR_SIZE").to_int();
  2921. if (unscaled_cursor_size <= 0) {
  2922. print_verbose("Detected invalid cursor size preference, defaulting to 24.");
  2923. unscaled_cursor_size = 24;
  2924. }
  2925. // NOTE: The scale is useful here as it might've been updated by _update_scale.
  2926. bool cursor_theme_loaded = _load_cursor_theme(unscaled_cursor_size * cursor_scale);
  2927. if (!cursor_theme_loaded) {
  2928. return ERR_CANT_CREATE;
  2929. }
  2930. // Update the cursor.
  2931. cursor_set_shape(DisplayServer::CURSOR_ARROW);
  2932. initialized = true;
  2933. return OK;
  2934. }
  2935. void WaylandThread::cursor_set_visible(bool p_visible) {
  2936. cursor_visible = p_visible;
  2937. for (struct wl_seat *wl_seat : registry.wl_seats) {
  2938. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  2939. ERR_FAIL_NULL(ss);
  2940. seat_state_update_cursor(ss);
  2941. }
  2942. }
  2943. void WaylandThread::cursor_set_shape(DisplayServer::CursorShape p_cursor_shape) {
  2944. cursor_shape = p_cursor_shape;
  2945. for (struct wl_seat *wl_seat : registry.wl_seats) {
  2946. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  2947. ERR_FAIL_NULL(ss);
  2948. seat_state_update_cursor(ss);
  2949. }
  2950. }
  2951. void WaylandThread::cursor_shape_set_custom_image(DisplayServer::CursorShape p_cursor_shape, Ref<Image> p_image, const Point2i &p_hotspot) {
  2952. ERR_FAIL_COND(!p_image.is_valid());
  2953. Size2i image_size = p_image->get_size();
  2954. // NOTE: The stride is the width of the image in bytes.
  2955. unsigned int image_stride = image_size.width * 4;
  2956. unsigned int data_size = image_stride * image_size.height;
  2957. // We need a shared memory object file descriptor in order to create a
  2958. // wl_buffer through wl_shm.
  2959. int fd = WaylandThread::_allocate_shm_file(data_size);
  2960. ERR_FAIL_COND(fd == -1);
  2961. CustomCursor &cursor = custom_cursors[p_cursor_shape];
  2962. cursor.hotspot = p_hotspot;
  2963. if (cursor.wl_buffer) {
  2964. // Clean up the old Wayland buffer.
  2965. wl_buffer_destroy(cursor.wl_buffer);
  2966. }
  2967. if (cursor.buffer_data) {
  2968. // Clean up the old buffer data.
  2969. munmap(cursor.buffer_data, cursor.buffer_data_size);
  2970. }
  2971. cursor.buffer_data = (uint32_t *)mmap(nullptr, data_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
  2972. cursor.buffer_data_size = data_size;
  2973. // Create the Wayland buffer.
  2974. struct wl_shm_pool *wl_shm_pool = wl_shm_create_pool(registry.wl_shm, fd, data_size);
  2975. // TODO: Make sure that WL_SHM_FORMAT_ARGB8888 format is supported. It
  2976. // technically isn't garaunteed to be supported, but I think that'd be a
  2977. // pretty unlikely thing to stumble upon.
  2978. cursor.wl_buffer = wl_shm_pool_create_buffer(wl_shm_pool, 0, image_size.width, image_size.height, image_stride, WL_SHM_FORMAT_ARGB8888);
  2979. wl_shm_pool_destroy(wl_shm_pool);
  2980. // Fill the cursor buffer with the image data.
  2981. for (unsigned int index = 0; index < (unsigned int)(image_size.width * image_size.height); index++) {
  2982. int row_index = floor(index / image_size.width);
  2983. int column_index = (index % int(image_size.width));
  2984. cursor.buffer_data[index] = p_image->get_pixel(column_index, row_index).to_argb32();
  2985. // Wayland buffers, unless specified, require associated alpha, so we'll just
  2986. // associate the alpha in-place.
  2987. uint8_t *pixel_data = (uint8_t *)&cursor.buffer_data[index];
  2988. pixel_data[0] = pixel_data[0] * pixel_data[3] / 255;
  2989. pixel_data[1] = pixel_data[1] * pixel_data[3] / 255;
  2990. pixel_data[2] = pixel_data[2] * pixel_data[3] / 255;
  2991. }
  2992. }
  2993. void WaylandThread::cursor_shape_clear_custom_image(DisplayServer::CursorShape p_cursor_shape) {
  2994. if (custom_cursors.has(p_cursor_shape)) {
  2995. CustomCursor cursor = custom_cursors[p_cursor_shape];
  2996. custom_cursors.erase(p_cursor_shape);
  2997. if (cursor.wl_buffer) {
  2998. wl_buffer_destroy(cursor.wl_buffer);
  2999. }
  3000. if (cursor.buffer_data) {
  3001. munmap(cursor.buffer_data, cursor.buffer_data_size);
  3002. }
  3003. }
  3004. }
  3005. void WaylandThread::window_set_ime_active(const bool p_active, DisplayServer::WindowID p_window_id) {
  3006. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3007. if (ss && ss->wp_text_input && ss->ime_enabled) {
  3008. if (p_active) {
  3009. ss->ime_active = true;
  3010. zwp_text_input_v3_enable(ss->wp_text_input);
  3011. zwp_text_input_v3_set_cursor_rectangle(ss->wp_text_input, ss->ime_rect.position.x, ss->ime_rect.position.y, ss->ime_rect.size.x, ss->ime_rect.size.y);
  3012. } else {
  3013. ss->ime_active = false;
  3014. ss->ime_text = String();
  3015. ss->ime_text_commit = String();
  3016. ss->ime_cursor = Vector2i();
  3017. zwp_text_input_v3_disable(ss->wp_text_input);
  3018. }
  3019. zwp_text_input_v3_commit(ss->wp_text_input);
  3020. }
  3021. }
  3022. void WaylandThread::window_set_ime_position(const Point2i &p_pos, DisplayServer::WindowID p_window_id) {
  3023. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3024. if (ss && ss->wp_text_input && ss->ime_enabled) {
  3025. ss->ime_rect = Rect2i(p_pos, Size2i(1, 10));
  3026. zwp_text_input_v3_set_cursor_rectangle(ss->wp_text_input, ss->ime_rect.position.x, ss->ime_rect.position.y, ss->ime_rect.size.x, ss->ime_rect.size.y);
  3027. zwp_text_input_v3_commit(ss->wp_text_input);
  3028. }
  3029. }
  3030. int WaylandThread::keyboard_get_layout_count() const {
  3031. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3032. if (ss && ss->xkb_keymap) {
  3033. return xkb_keymap_num_layouts(ss->xkb_keymap);
  3034. }
  3035. return 0;
  3036. }
  3037. int WaylandThread::keyboard_get_current_layout_index() const {
  3038. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3039. if (ss) {
  3040. return ss->current_layout_index;
  3041. }
  3042. return 0;
  3043. }
  3044. void WaylandThread::keyboard_set_current_layout_index(int p_index) {
  3045. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3046. if (ss) {
  3047. ss->current_layout_index = p_index;
  3048. }
  3049. }
  3050. String WaylandThread::keyboard_get_layout_name(int p_index) const {
  3051. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3052. if (ss && ss->xkb_keymap) {
  3053. String ret;
  3054. ret.parse_utf8(xkb_keymap_layout_get_name(ss->xkb_keymap, p_index));
  3055. return ret;
  3056. }
  3057. return "";
  3058. }
  3059. Key WaylandThread::keyboard_get_key_from_physical(Key p_key) const {
  3060. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3061. if (ss && ss->xkb_state) {
  3062. xkb_keycode_t xkb_keycode = KeyMappingXKB::get_xkb_keycode(p_key);
  3063. return KeyMappingXKB::get_keycode(xkb_state_key_get_one_sym(ss->xkb_state, xkb_keycode));
  3064. }
  3065. return Key::NONE;
  3066. }
  3067. void WaylandThread::keyboard_echo_keys() {
  3068. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3069. if (ss) {
  3070. seat_state_echo_keys(ss);
  3071. }
  3072. }
  3073. void WaylandThread::selection_set_text(const String &p_text) {
  3074. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3075. if (registry.wl_data_device_manager == nullptr) {
  3076. DEBUG_LOG_WAYLAND_THREAD("Couldn't set selection, wl_data_device_manager global not available.");
  3077. }
  3078. if (ss == nullptr) {
  3079. DEBUG_LOG_WAYLAND_THREAD("Couldn't set selection, current seat not set.");
  3080. return;
  3081. }
  3082. if (ss->wl_data_device == nullptr) {
  3083. DEBUG_LOG_WAYLAND_THREAD("Couldn't set selection, seat doesn't have wl_data_device.");
  3084. }
  3085. ss->selection_data = p_text.to_utf8_buffer();
  3086. if (ss->wl_data_source_selection == nullptr) {
  3087. ss->wl_data_source_selection = wl_data_device_manager_create_data_source(registry.wl_data_device_manager);
  3088. wl_data_source_add_listener(ss->wl_data_source_selection, &wl_data_source_listener, ss);
  3089. wl_data_source_offer(ss->wl_data_source_selection, "text/plain;charset=utf-8");
  3090. wl_data_source_offer(ss->wl_data_source_selection, "text/plain");
  3091. // TODO: Implement a good way of getting the latest serial from the user.
  3092. wl_data_device_set_selection(ss->wl_data_device, ss->wl_data_source_selection, MAX(ss->pointer_data.button_serial, ss->last_key_pressed_serial));
  3093. }
  3094. // Wait for the message to get to the server before continuing, otherwise the
  3095. // clipboard update might come with a delay.
  3096. wl_display_roundtrip(wl_display);
  3097. }
  3098. bool WaylandThread::selection_has_mime(const String &p_mime) const {
  3099. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3100. if (ss == nullptr) {
  3101. DEBUG_LOG_WAYLAND_THREAD("Couldn't get selection, current seat not set.");
  3102. return false;
  3103. }
  3104. OfferState *os = wl_data_offer_get_offer_state(ss->wl_data_offer_selection);
  3105. if (!os) {
  3106. return false;
  3107. }
  3108. return os->mime_types.has(p_mime);
  3109. }
  3110. Vector<uint8_t> WaylandThread::selection_get_mime(const String &p_mime) const {
  3111. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3112. if (ss == nullptr) {
  3113. DEBUG_LOG_WAYLAND_THREAD("Couldn't get selection, current seat not set.");
  3114. return Vector<uint8_t>();
  3115. }
  3116. if (ss->wl_data_source_selection) {
  3117. // We have a source so the stuff we're pasting is ours. We'll have to pass the
  3118. // data directly or we'd stall waiting for Godot (ourselves) to send us the
  3119. // data :P
  3120. OfferState *os = wl_data_offer_get_offer_state(ss->wl_data_offer_selection);
  3121. ERR_FAIL_NULL_V(os, Vector<uint8_t>());
  3122. if (os->mime_types.has(p_mime)) {
  3123. // All righty, we're offering this type. Let's just return the data as is.
  3124. return ss->selection_data;
  3125. }
  3126. // ... we don't offer that type. Oh well.
  3127. return Vector<uint8_t>();
  3128. }
  3129. return _wl_data_offer_read(wl_display, p_mime.utf8(), ss->wl_data_offer_selection);
  3130. }
  3131. bool WaylandThread::primary_has_mime(const String &p_mime) const {
  3132. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3133. if (ss == nullptr) {
  3134. DEBUG_LOG_WAYLAND_THREAD("Couldn't get selection, current seat not set.");
  3135. return false;
  3136. }
  3137. OfferState *os = wp_primary_selection_offer_get_offer_state(ss->wp_primary_selection_offer);
  3138. if (!os) {
  3139. return false;
  3140. }
  3141. return os->mime_types.has(p_mime);
  3142. }
  3143. Vector<uint8_t> WaylandThread::primary_get_mime(const String &p_mime) const {
  3144. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3145. if (ss == nullptr) {
  3146. DEBUG_LOG_WAYLAND_THREAD("Couldn't get primary, current seat not set.");
  3147. return Vector<uint8_t>();
  3148. }
  3149. if (ss->wp_primary_selection_source) {
  3150. // We have a source so the stuff we're pasting is ours. We'll have to pass the
  3151. // data directly or we'd stall waiting for Godot (ourselves) to send us the
  3152. // data :P
  3153. OfferState *os = wp_primary_selection_offer_get_offer_state(ss->wp_primary_selection_offer);
  3154. ERR_FAIL_NULL_V(os, Vector<uint8_t>());
  3155. if (os->mime_types.has(p_mime)) {
  3156. // All righty, we're offering this type. Let's just return the data as is.
  3157. return ss->selection_data;
  3158. }
  3159. // ... we don't offer that type. Oh well.
  3160. return Vector<uint8_t>();
  3161. }
  3162. return _wp_primary_selection_offer_read(wl_display, p_mime.utf8(), ss->wp_primary_selection_offer);
  3163. }
  3164. void WaylandThread::primary_set_text(const String &p_text) {
  3165. SeatState *ss = wl_seat_get_seat_state(wl_seat_current);
  3166. if (registry.wp_primary_selection_device_manager == nullptr) {
  3167. DEBUG_LOG_WAYLAND_THREAD("Couldn't set primary, protocol not available");
  3168. return;
  3169. }
  3170. if (ss == nullptr) {
  3171. DEBUG_LOG_WAYLAND_THREAD("Couldn't set primary, current seat not set.");
  3172. return;
  3173. }
  3174. ss->primary_data = p_text.to_utf8_buffer();
  3175. if (ss->wp_primary_selection_source == nullptr) {
  3176. ss->wp_primary_selection_source = zwp_primary_selection_device_manager_v1_create_source(registry.wp_primary_selection_device_manager);
  3177. zwp_primary_selection_source_v1_add_listener(ss->wp_primary_selection_source, &wp_primary_selection_source_listener, ss);
  3178. zwp_primary_selection_source_v1_offer(ss->wp_primary_selection_source, "text/plain;charset=utf-8");
  3179. zwp_primary_selection_source_v1_offer(ss->wp_primary_selection_source, "text/plain");
  3180. }
  3181. // TODO: Implement a good way of getting the latest serial from the user.
  3182. zwp_primary_selection_device_v1_set_selection(ss->wp_primary_selection_device, ss->wp_primary_selection_source, MAX(ss->pointer_data.button_serial, ss->last_key_pressed_serial));
  3183. // Wait for the message to get to the server before continuing, otherwise the
  3184. // clipboard update might come with a delay.
  3185. wl_display_roundtrip(wl_display);
  3186. }
  3187. void WaylandThread::commit_surfaces() {
  3188. wl_surface_commit(main_window.wl_surface);
  3189. }
  3190. void WaylandThread::set_frame() {
  3191. frame = true;
  3192. }
  3193. bool WaylandThread::get_reset_frame() {
  3194. bool old_frame = frame;
  3195. frame = false;
  3196. return old_frame;
  3197. }
  3198. // Dispatches events until a frame event is received, a window is reported as
  3199. // suspended or the timeout expires.
  3200. bool WaylandThread::wait_frame_suspend_ms(int p_timeout) {
  3201. if (main_window.suspended) {
  3202. // The window is suspended! The compositor is telling us _explicitly_ that we
  3203. // don't need to draw, without letting us guess through the frame event's
  3204. // timing and stuff like that. Our job here is done.
  3205. return false;
  3206. }
  3207. if (frame) {
  3208. // We already have a frame! Probably it got there while the caller locked :D
  3209. frame = false;
  3210. return true;
  3211. }
  3212. struct pollfd poll_fd;
  3213. poll_fd.fd = wl_display_get_fd(wl_display);
  3214. poll_fd.events = POLLIN | POLLHUP;
  3215. int begin_ms = OS::get_singleton()->get_ticks_msec();
  3216. int remaining_ms = p_timeout;
  3217. while (remaining_ms > 0) {
  3218. // Empty the event queue while it's full.
  3219. while (wl_display_prepare_read(wl_display) != 0) {
  3220. if (wl_display_dispatch_pending(wl_display) == -1) {
  3221. // Oh no. We'll check and handle any display error below.
  3222. break;
  3223. }
  3224. if (main_window.suspended) {
  3225. return false;
  3226. }
  3227. if (frame) {
  3228. // We had a frame event in the queue :D
  3229. frame = false;
  3230. return true;
  3231. }
  3232. }
  3233. int werror = wl_display_get_error(wl_display);
  3234. if (werror) {
  3235. if (werror == EPROTO) {
  3236. struct wl_interface *wl_interface = nullptr;
  3237. uint32_t id = 0;
  3238. int error_code = wl_display_get_protocol_error(wl_display, (const struct wl_interface **)&wl_interface, &id);
  3239. CRASH_NOW_MSG(vformat("Wayland protocol error %d on interface %s@%d.", error_code, wl_interface ? wl_interface->name : "unknown", id));
  3240. } else {
  3241. CRASH_NOW_MSG(vformat("Wayland client error code %d.", werror));
  3242. }
  3243. }
  3244. wl_display_flush(wl_display);
  3245. // Wait for the event file descriptor to have new data.
  3246. poll(&poll_fd, 1, remaining_ms);
  3247. if (poll_fd.revents | POLLIN) {
  3248. // Load the queues with fresh new data.
  3249. wl_display_read_events(wl_display);
  3250. } else {
  3251. // Oh well... Stop signaling that we want to read.
  3252. wl_display_cancel_read(wl_display);
  3253. // We've got no new events :(
  3254. // We won't even bother with checking the frame flag.
  3255. return false;
  3256. }
  3257. // Let's try dispatching now...
  3258. wl_display_dispatch_pending(wl_display);
  3259. if (main_window.suspended) {
  3260. return false;
  3261. }
  3262. if (frame) {
  3263. frame = false;
  3264. return true;
  3265. }
  3266. remaining_ms -= OS::get_singleton()->get_ticks_msec() - begin_ms;
  3267. }
  3268. DEBUG_LOG_WAYLAND_THREAD("Frame timeout.");
  3269. return false;
  3270. }
  3271. bool WaylandThread::is_suspended() const {
  3272. return main_window.suspended;
  3273. }
  3274. void WaylandThread::destroy() {
  3275. if (!initialized) {
  3276. return;
  3277. }
  3278. if (wl_display && events_thread.is_started()) {
  3279. thread_data.thread_done.set();
  3280. // By sending a roundtrip message we're unblocking the polling thread so that
  3281. // it can realize that it's done and also handle every event that's left.
  3282. wl_display_roundtrip(wl_display);
  3283. events_thread.wait_to_finish();
  3284. }
  3285. if (main_window.wp_fractional_scale) {
  3286. wp_fractional_scale_v1_destroy(main_window.wp_fractional_scale);
  3287. }
  3288. if (main_window.wp_viewport) {
  3289. wp_viewport_destroy(main_window.wp_viewport);
  3290. }
  3291. if (main_window.frame_callback) {
  3292. wl_callback_destroy(main_window.frame_callback);
  3293. }
  3294. #ifdef LIBDECOR_ENABLED
  3295. if (main_window.libdecor_frame) {
  3296. libdecor_frame_close(main_window.libdecor_frame);
  3297. }
  3298. #endif // LIBDECOR_ENABLED
  3299. if (main_window.xdg_toplevel) {
  3300. xdg_toplevel_destroy(main_window.xdg_toplevel);
  3301. }
  3302. if (main_window.xdg_surface) {
  3303. xdg_surface_destroy(main_window.xdg_surface);
  3304. }
  3305. if (main_window.wl_surface) {
  3306. wl_surface_destroy(main_window.wl_surface);
  3307. }
  3308. for (struct wl_seat *wl_seat : registry.wl_seats) {
  3309. SeatState *ss = wl_seat_get_seat_state(wl_seat);
  3310. ERR_FAIL_NULL(ss);
  3311. wl_seat_destroy(wl_seat);
  3312. xkb_context_unref(ss->xkb_context);
  3313. xkb_state_unref(ss->xkb_state);
  3314. xkb_keymap_unref(ss->xkb_keymap);
  3315. if (ss->wl_keyboard) {
  3316. wl_keyboard_destroy(ss->wl_keyboard);
  3317. }
  3318. if (ss->keymap_buffer) {
  3319. munmap((void *)ss->keymap_buffer, ss->keymap_buffer_size);
  3320. }
  3321. if (ss->wl_pointer) {
  3322. wl_pointer_destroy(ss->wl_pointer);
  3323. }
  3324. if (ss->cursor_frame_callback) {
  3325. // We don't need to set a null userdata for safety as the thread is done.
  3326. wl_callback_destroy(ss->cursor_frame_callback);
  3327. }
  3328. if (ss->cursor_surface) {
  3329. wl_surface_destroy(ss->cursor_surface);
  3330. }
  3331. if (ss->wl_data_device) {
  3332. wl_data_device_destroy(ss->wl_data_device);
  3333. }
  3334. if (ss->wp_relative_pointer) {
  3335. zwp_relative_pointer_v1_destroy(ss->wp_relative_pointer);
  3336. }
  3337. if (ss->wp_locked_pointer) {
  3338. zwp_locked_pointer_v1_destroy(ss->wp_locked_pointer);
  3339. }
  3340. if (ss->wp_confined_pointer) {
  3341. zwp_confined_pointer_v1_destroy(ss->wp_confined_pointer);
  3342. }
  3343. if (ss->wp_tablet_seat) {
  3344. zwp_tablet_seat_v2_destroy(ss->wp_tablet_seat);
  3345. }
  3346. for (struct zwp_tablet_tool_v2 *tool : ss->tablet_tools) {
  3347. TabletToolState *state = wp_tablet_tool_get_state(tool);
  3348. if (state) {
  3349. memdelete(state);
  3350. }
  3351. zwp_tablet_tool_v2_destroy(tool);
  3352. }
  3353. memdelete(ss);
  3354. }
  3355. for (struct wl_output *wl_output : registry.wl_outputs) {
  3356. ERR_FAIL_NULL(wl_output);
  3357. memdelete(wl_output_get_screen_state(wl_output));
  3358. wl_output_destroy(wl_output);
  3359. }
  3360. if (wl_cursor_theme) {
  3361. wl_cursor_theme_destroy(wl_cursor_theme);
  3362. }
  3363. if (registry.wp_idle_inhibit_manager) {
  3364. zwp_idle_inhibit_manager_v1_destroy(registry.wp_idle_inhibit_manager);
  3365. }
  3366. if (registry.wp_pointer_constraints) {
  3367. zwp_pointer_constraints_v1_destroy(registry.wp_pointer_constraints);
  3368. }
  3369. if (registry.wp_pointer_gestures) {
  3370. zwp_pointer_gestures_v1_destroy(registry.wp_pointer_gestures);
  3371. }
  3372. if (registry.wp_relative_pointer_manager) {
  3373. zwp_relative_pointer_manager_v1_destroy(registry.wp_relative_pointer_manager);
  3374. }
  3375. if (registry.xdg_activation) {
  3376. xdg_activation_v1_destroy(registry.xdg_activation);
  3377. }
  3378. if (registry.xdg_system_bell) {
  3379. xdg_system_bell_v1_destroy(registry.xdg_system_bell);
  3380. }
  3381. if (registry.xdg_decoration_manager) {
  3382. zxdg_decoration_manager_v1_destroy(registry.xdg_decoration_manager);
  3383. }
  3384. if (registry.wp_fractional_scale_manager) {
  3385. wp_fractional_scale_manager_v1_destroy(registry.wp_fractional_scale_manager);
  3386. }
  3387. if (registry.wp_viewporter) {
  3388. wp_viewporter_destroy(registry.wp_viewporter);
  3389. }
  3390. if (registry.xdg_wm_base) {
  3391. xdg_wm_base_destroy(registry.xdg_wm_base);
  3392. }
  3393. if (registry.xdg_exporter) {
  3394. zxdg_exporter_v1_destroy(registry.xdg_exporter);
  3395. }
  3396. if (registry.wl_shm) {
  3397. wl_shm_destroy(registry.wl_shm);
  3398. }
  3399. if (registry.wl_compositor) {
  3400. wl_compositor_destroy(registry.wl_compositor);
  3401. }
  3402. if (wl_registry) {
  3403. wl_registry_destroy(wl_registry);
  3404. }
  3405. if (wl_display) {
  3406. wl_display_disconnect(wl_display);
  3407. }
  3408. }
  3409. #endif // WAYLAND_ENABLED