Element.cpp 90 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019-2023 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "../../Include/RmlUi/Core/Element.h"
  29. #include "../../Include/RmlUi/Core/Context.h"
  30. #include "../../Include/RmlUi/Core/Core.h"
  31. #include "../../Include/RmlUi/Core/Dictionary.h"
  32. #include "../../Include/RmlUi/Core/ElementDocument.h"
  33. #include "../../Include/RmlUi/Core/ElementInstancer.h"
  34. #include "../../Include/RmlUi/Core/ElementScroll.h"
  35. #include "../../Include/RmlUi/Core/ElementUtilities.h"
  36. #include "../../Include/RmlUi/Core/Factory.h"
  37. #include "../../Include/RmlUi/Core/Math.h"
  38. #include "../../Include/RmlUi/Core/Profiling.h"
  39. #include "../../Include/RmlUi/Core/PropertiesIteratorView.h"
  40. #include "../../Include/RmlUi/Core/PropertyDefinition.h"
  41. #include "../../Include/RmlUi/Core/PropertyIdSet.h"
  42. #include "../../Include/RmlUi/Core/StyleSheet.h"
  43. #include "../../Include/RmlUi/Core/StyleSheetSpecification.h"
  44. #include "../../Include/RmlUi/Core/TransformPrimitive.h"
  45. #include "Clock.h"
  46. #include "ComputeProperty.h"
  47. #include "DataModel.h"
  48. #include "ElementAnimation.h"
  49. #include "ElementBackgroundBorder.h"
  50. #include "ElementDefinition.h"
  51. #include "ElementEffects.h"
  52. #include "ElementMeta.h"
  53. #include "ElementStyle.h"
  54. #include "EventDispatcher.h"
  55. #include "EventSpecification.h"
  56. #include "Layout/LayoutEngine.h"
  57. #include "PluginRegistry.h"
  58. #include "Pool.h"
  59. #include "PropertiesIterator.h"
  60. #include "StyleSheetNode.h"
  61. #include "StyleSheetParser.h"
  62. #include "TransformState.h"
  63. #include "TransformUtilities.h"
  64. #include "XMLParseTools.h"
  65. #include <algorithm>
  66. #include <cmath>
  67. namespace Rml {
  68. // Determines how many levels up in the hierarchy the OnChildAdd and OnChildRemove are called (starting at the child itself)
  69. static constexpr int ChildNotifyLevels = 2;
  70. // Helper function to select scroll offset delta
  71. static float GetScrollOffsetDelta(ScrollAlignment alignment, float begin_offset, float end_offset)
  72. {
  73. switch (alignment)
  74. {
  75. case ScrollAlignment::Start: return begin_offset;
  76. case ScrollAlignment::Center: return (begin_offset + end_offset) / 2.0f;
  77. case ScrollAlignment::End: return end_offset;
  78. case ScrollAlignment::Nearest:
  79. if (begin_offset >= 0.f && end_offset <= 0.f)
  80. return 0.f; // Element is already visible, don't scroll
  81. else if (begin_offset < 0.f && end_offset < 0.f)
  82. return Math::Max(begin_offset, end_offset);
  83. else if (begin_offset > 0.f && end_offset > 0.f)
  84. return Math::Min(begin_offset, end_offset);
  85. else
  86. return 0.f; // Shouldn't happen
  87. }
  88. return 0.f;
  89. }
  90. Element::Element(const String& tag) :
  91. local_stacking_context(false), local_stacking_context_forced(false), stacking_context_dirty(false), computed_values_are_default_initialized(true),
  92. visible(true), absolute_offset_dirty(true), offset_fixed(false), relative_offset_area(BoxArea::Border), rounded_main_padding_size_dirty(true),
  93. dirty_definition(false), dirty_child_definitions(false), dirty_animation(false), dirty_transition(false), dirty_transform(false),
  94. dirty_perspective(false), tag(tag), relative_offset_base(0, 0), relative_offset_position(0, 0), absolute_offset(0, 0), scroll_offset(0, 0)
  95. {
  96. RMLUI_ASSERT(tag == StringUtilities::ToLower(tag));
  97. parent = nullptr;
  98. focus = nullptr;
  99. instancer = nullptr;
  100. owner_document = nullptr;
  101. offset_parent = nullptr;
  102. clip_area = BoxArea::Padding;
  103. baseline = 0.0f;
  104. num_non_dom_children = 0;
  105. z_index = 0;
  106. meta = ElementMetaPool::element_meta_pool->pool.AllocateAndConstruct(this);
  107. data_model = nullptr;
  108. }
  109. Element::~Element()
  110. {
  111. RMLUI_ASSERT(parent == nullptr);
  112. PluginRegistry::NotifyElementDestroy(this);
  113. // A simplified version of RemoveChild() for destruction.
  114. for (ElementPtr& child : children)
  115. {
  116. Element* child_ancestor = child.get();
  117. for (int i = 0; i <= ChildNotifyLevels && child_ancestor; i++, child_ancestor = child_ancestor->GetParentNode())
  118. child_ancestor->OnChildRemove(child.get());
  119. child->SetParent(nullptr);
  120. }
  121. children.clear();
  122. num_non_dom_children = 0;
  123. ElementMetaPool::element_meta_pool->pool.DestroyAndDeallocate(meta);
  124. }
  125. void Element::Update(float dp_ratio, Vector2f vp_dimensions)
  126. {
  127. #ifdef RMLUI_TRACY_PROFILING
  128. auto name = GetAddress(false, false);
  129. RMLUI_ZoneScoped;
  130. RMLUI_ZoneText(name.c_str(), name.size());
  131. #endif
  132. OnUpdate();
  133. HandleTransitionProperty();
  134. HandleAnimationProperty();
  135. AdvanceAnimations();
  136. meta->scroll.Update();
  137. UpdateProperties(dp_ratio, vp_dimensions);
  138. // Do en extra pass over the animations and properties if the 'animation' property was just changed.
  139. if (dirty_animation)
  140. {
  141. HandleAnimationProperty();
  142. AdvanceAnimations();
  143. UpdateProperties(dp_ratio, vp_dimensions);
  144. }
  145. meta->effects.InstanceEffects();
  146. for (size_t i = 0; i < children.size(); i++)
  147. children[i]->Update(dp_ratio, vp_dimensions);
  148. if (!animations.empty() && IsVisible(true))
  149. {
  150. if (Context* ctx = GetContext())
  151. ctx->RequestNextUpdate(0);
  152. }
  153. LayoutNode* layout_node = GetLayoutNode();
  154. layout_node->DirtyUpToClosestLayoutBoundary();
  155. }
  156. void Element::UpdateProperties(const float dp_ratio, const Vector2f vp_dimensions)
  157. {
  158. UpdateDefinition();
  159. if (meta->style.AnyPropertiesDirty())
  160. {
  161. const ComputedValues* parent_values = parent ? &parent->GetComputedValues() : nullptr;
  162. const ComputedValues* document_values = owner_document ? &owner_document->GetComputedValues() : nullptr;
  163. // Compute values and clear dirty properties
  164. PropertyIdSet dirty_properties = meta->style.ComputeValues(meta->computed_values, parent_values, document_values,
  165. computed_values_are_default_initialized, dp_ratio, vp_dimensions);
  166. computed_values_are_default_initialized = false;
  167. // Computed values are just calculated and can safely be used in OnPropertyChange.
  168. // However, new properties set during this call will not be available until the next update loop.
  169. if (!dirty_properties.Empty())
  170. OnPropertyChange(dirty_properties);
  171. }
  172. }
  173. void Element::Render()
  174. {
  175. #ifdef RMLUI_TRACY_PROFILING
  176. auto name = GetAddress(false, false);
  177. RMLUI_ZoneScoped;
  178. RMLUI_ZoneText(name.c_str(), name.size());
  179. #endif
  180. UpdateAbsoluteOffsetAndRenderBoxData();
  181. // Rebuild our stacking context if necessary.
  182. if (stacking_context_dirty)
  183. BuildLocalStackingContext();
  184. UpdateTransformState();
  185. // Apply our transform
  186. ElementUtilities::ApplyTransform(*this);
  187. meta->effects.RenderEffects(RenderStage::Enter);
  188. // Set up the clipping region for this element.
  189. if (ElementUtilities::SetClippingRegion(this))
  190. {
  191. meta->background_border.Render(this);
  192. meta->effects.RenderEffects(RenderStage::Decoration);
  193. {
  194. RMLUI_ZoneScopedNC("OnRender", 0x228B22);
  195. OnRender();
  196. }
  197. }
  198. // Render all elements in our local stacking context.
  199. for (Element* element : stacking_context)
  200. element->Render();
  201. meta->effects.RenderEffects(RenderStage::Exit);
  202. }
  203. ElementPtr Element::Clone() const
  204. {
  205. ElementPtr clone;
  206. if (instancer)
  207. {
  208. clone = instancer->InstanceElement(nullptr, GetTagName(), attributes);
  209. if (clone)
  210. clone->SetInstancer(instancer);
  211. }
  212. else
  213. clone = Factory::InstanceElement(nullptr, GetTagName(), GetTagName(), attributes);
  214. if (clone)
  215. {
  216. // Copy over the attributes. The 'style' and 'class' attributes are skipped because inline styles and class names are copied manually below.
  217. // This is necessary in case any properties or classes have been set manually, in which case the 'style' and 'class' attributes are out of
  218. // sync with the used style and active classes.
  219. ElementAttributes clone_attributes = attributes;
  220. clone_attributes.erase("style");
  221. clone_attributes.erase("class");
  222. clone->SetAttributes(clone_attributes);
  223. for (auto& id_property : GetStyle()->GetLocalStyleProperties())
  224. clone->SetProperty(id_property.first, id_property.second);
  225. clone->GetStyle()->SetClassNames(GetStyle()->GetClassNames());
  226. String inner_rml;
  227. GetInnerRML(inner_rml);
  228. clone->SetInnerRML(inner_rml);
  229. }
  230. return clone;
  231. }
  232. void Element::SetClass(const String& class_name, bool activate)
  233. {
  234. if (meta->style.SetClass(class_name, activate))
  235. DirtyDefinition(DirtyNodes::SelfAndSiblings);
  236. }
  237. bool Element::IsClassSet(const String& class_name) const
  238. {
  239. return meta->style.IsClassSet(class_name);
  240. }
  241. void Element::SetClassNames(const String& class_names)
  242. {
  243. SetAttribute("class", class_names);
  244. }
  245. String Element::GetClassNames() const
  246. {
  247. return meta->style.GetClassNames();
  248. }
  249. const StyleSheet* Element::GetStyleSheet() const
  250. {
  251. if (ElementDocument* document = GetOwnerDocument())
  252. return document->GetStyleSheet();
  253. return nullptr;
  254. }
  255. String Element::GetAddress(bool include_pseudo_classes, bool include_parents) const
  256. {
  257. // Add the tag name onto the address.
  258. String address(tag);
  259. // Add the ID if we have one.
  260. if (!id.empty())
  261. {
  262. address += "#";
  263. address += id;
  264. }
  265. String classes = meta->style.GetClassNames();
  266. if (!classes.empty())
  267. {
  268. classes = StringUtilities::Replace(classes, ' ', '.');
  269. address += ".";
  270. address += classes;
  271. }
  272. if (include_pseudo_classes)
  273. {
  274. const PseudoClassMap& pseudo_classes = meta->style.GetActivePseudoClasses();
  275. for (auto& pseudo_class : pseudo_classes)
  276. {
  277. address += ":";
  278. address += pseudo_class.first;
  279. }
  280. }
  281. if (include_parents && parent)
  282. {
  283. address += " < ";
  284. return address + parent->GetAddress(include_pseudo_classes, true);
  285. }
  286. else
  287. return address;
  288. }
  289. void Element::SetOffset(Vector2f offset, Element* _offset_parent, bool _offset_fixed, BoxArea _relative_offset_area)
  290. {
  291. _offset_fixed |= GetPosition() == Style::Position::Fixed;
  292. // If our offset has definitely changed, or any of our parenting has, then these are set and
  293. // updated based on our left / right / top / bottom properties.
  294. if (relative_offset_base != offset || offset_parent != _offset_parent || offset_fixed != _offset_fixed ||
  295. relative_offset_area != _relative_offset_area)
  296. {
  297. relative_offset_base = offset;
  298. offset_fixed = _offset_fixed;
  299. offset_parent = _offset_parent;
  300. relative_offset_area = _relative_offset_area;
  301. UpdateRelativeOffsetFromInsetConstraints();
  302. DirtyAbsoluteOffset();
  303. }
  304. // Otherwise, our offset is updated in case left / right / top / bottom will have an impact on
  305. // our final position, and our children are dirtied if they do.
  306. else
  307. {
  308. const Vector2f old_base = relative_offset_base;
  309. const Vector2f old_position = relative_offset_position;
  310. UpdateRelativeOffsetFromInsetConstraints();
  311. if (old_base != relative_offset_base || old_position != relative_offset_position)
  312. DirtyAbsoluteOffset();
  313. }
  314. }
  315. Vector2f Element::GetRelativeOffset(BoxArea area)
  316. {
  317. return relative_offset_base + relative_offset_position + GetBox().GetPosition(area) - GetBox().GetPosition(relative_offset_area);
  318. }
  319. Vector2f Element::GetAbsoluteOffset(BoxArea area)
  320. {
  321. UpdateAbsoluteOffsetAndRenderBoxData();
  322. return absolute_offset + GetBox().GetPosition(area);
  323. }
  324. void Element::UpdateAbsoluteOffsetAndRenderBoxData()
  325. {
  326. if (absolute_offset_dirty || rounded_main_padding_size_dirty)
  327. {
  328. absolute_offset_dirty = false;
  329. rounded_main_padding_size_dirty = false;
  330. Vector2f offset_from_ancestors;
  331. if (offset_parent)
  332. offset_from_ancestors = offset_parent->GetAbsoluteOffset(BoxArea::Border);
  333. if (!offset_fixed)
  334. {
  335. // Add any parent scrolling onto our position as well.
  336. if (offset_parent)
  337. offset_from_ancestors -= offset_parent->scroll_offset;
  338. // Finally, there may be relatively positioned elements between ourself and our containing block, add their relative offsets as well.
  339. for (Element* ancestor = parent; ancestor && ancestor != offset_parent; ancestor = ancestor->parent)
  340. offset_from_ancestors += ancestor->relative_offset_position;
  341. }
  342. const Vector2f relative_offset = relative_offset_base + relative_offset_position - GetBox().GetPosition(relative_offset_area);
  343. absolute_offset = relative_offset + offset_from_ancestors;
  344. // Next, we find the rounded size of the box so that elements can be placed border-to-border next to each other
  345. // without any gaps. To achieve this, we have to adjust their rounded/rendered sizes based on their position, in
  346. // such a way that the bottom-right of this element exactly matches the top-left of the next element. The order
  347. // of floating-point operations matter here, we want to replicate the operations in the layout engine as close
  348. // as possible to avoid any gaps.
  349. const Vector2f main_padding_size = main_box.GetSize(BoxArea::Padding);
  350. const Vector2f bottom_right_absolute_offset = (relative_offset + main_padding_size) + offset_from_ancestors;
  351. const Vector2f new_rounded_main_padding_size = bottom_right_absolute_offset.Round() - absolute_offset.Round();
  352. if (new_rounded_main_padding_size != rounded_main_padding_size)
  353. {
  354. rounded_main_padding_size = new_rounded_main_padding_size;
  355. meta->background_border.DirtyBackground();
  356. meta->background_border.DirtyBorder();
  357. meta->effects.DirtyEffectsData();
  358. }
  359. }
  360. }
  361. void Element::SetClipArea(BoxArea _clip_area)
  362. {
  363. clip_area = _clip_area;
  364. }
  365. BoxArea Element::GetClipArea() const
  366. {
  367. return clip_area;
  368. }
  369. void Element::SetScrollableOverflowRectangle(Vector2f _scrollable_overflow_rectangle, bool clamp_scroll_offset)
  370. {
  371. if (scrollable_overflow_rectangle != _scrollable_overflow_rectangle)
  372. {
  373. scrollable_overflow_rectangle = _scrollable_overflow_rectangle;
  374. if (clamp_scroll_offset)
  375. ClampScrollOffset();
  376. }
  377. }
  378. void Element::SetBox(const Box& box)
  379. {
  380. if (box != main_box || additional_boxes.size() > 0)
  381. {
  382. #ifdef RMLUI_DEBUG
  383. for (const BoxEdge edge : {BoxEdge::Top, BoxEdge::Right, BoxEdge::Bottom, BoxEdge::Left})
  384. {
  385. const float border_width = box.GetEdge(BoxArea::Border, edge);
  386. if (border_width != Math::Round(border_width))
  387. Log::Message(Log::LT_WARNING, "Expected integer border width but got %g px on element: %s", border_width, GetAddress().c_str());
  388. }
  389. #endif
  390. main_box = box;
  391. additional_boxes.clear();
  392. OnResize();
  393. rounded_main_padding_size_dirty = true;
  394. meta->background_border.DirtyBackground();
  395. meta->background_border.DirtyBorder();
  396. meta->effects.DirtyEffectsData();
  397. }
  398. }
  399. void Element::AddBox(const Box& box, Vector2f offset)
  400. {
  401. additional_boxes.emplace_back(PositionedBox{box, offset});
  402. OnResize();
  403. meta->background_border.DirtyBackground();
  404. meta->background_border.DirtyBorder();
  405. meta->effects.DirtyEffectsData();
  406. }
  407. const Box& Element::GetBox()
  408. {
  409. return main_box;
  410. }
  411. const Box& Element::GetBox(int index, Vector2f& offset)
  412. {
  413. offset = Vector2f(0);
  414. const int additional_box_index = index - 1;
  415. if (index < 1 || additional_box_index >= (int)additional_boxes.size())
  416. return main_box;
  417. offset = additional_boxes[additional_box_index].offset;
  418. return additional_boxes[additional_box_index].box;
  419. }
  420. RenderBox Element::GetRenderBox(BoxArea fill_area, int index)
  421. {
  422. RMLUI_ASSERTMSG(fill_area >= BoxArea::Border && fill_area <= BoxArea::Content,
  423. "Render box can only be generated with fill area of border, padding or content.");
  424. UpdateAbsoluteOffsetAndRenderBoxData();
  425. struct BoxReference {
  426. const Box& box;
  427. Vector2f padding_size;
  428. Vector2f offset;
  429. };
  430. auto GetBoxAndOffset = [this, index]() {
  431. const int additional_box_index = index - 1;
  432. if (index < 1 || additional_box_index >= (int)additional_boxes.size())
  433. return BoxReference{main_box, rounded_main_padding_size, {}};
  434. const PositionedBox& positioned_box = additional_boxes[additional_box_index];
  435. return BoxReference{positioned_box.box, positioned_box.box.GetSize(BoxArea::Padding), positioned_box.offset.Round()};
  436. };
  437. BoxReference box = GetBoxAndOffset();
  438. EdgeSizes edge_sizes = {};
  439. for (int area = (int)BoxArea::Border; area < (int)fill_area; area++)
  440. {
  441. edge_sizes[0] += box.box.GetEdge(BoxArea(area), BoxEdge::Top);
  442. edge_sizes[1] += box.box.GetEdge(BoxArea(area), BoxEdge::Right);
  443. edge_sizes[2] += box.box.GetEdge(BoxArea(area), BoxEdge::Bottom);
  444. edge_sizes[3] += box.box.GetEdge(BoxArea(area), BoxEdge::Left);
  445. }
  446. Vector2f inner_size;
  447. switch (fill_area)
  448. {
  449. case BoxArea::Border: inner_size = box.padding_size + box.box.GetFrameSize(BoxArea::Border); break;
  450. case BoxArea::Padding: inner_size = box.padding_size; break;
  451. case BoxArea::Content: inner_size = box.padding_size - box.box.GetFrameSize(BoxArea::Padding); break;
  452. case BoxArea::Margin:
  453. case BoxArea::Auto: RMLUI_ERROR;
  454. }
  455. return RenderBox{inner_size, box.offset, edge_sizes, meta->computed_values.border_radius()};
  456. }
  457. int Element::GetNumBoxes()
  458. {
  459. return 1 + (int)additional_boxes.size();
  460. }
  461. float Element::GetBaseline() const
  462. {
  463. return baseline;
  464. }
  465. bool Element::GetIntrinsicDimensions(Vector2f& /*dimensions*/, float& /*ratio*/)
  466. {
  467. return false;
  468. }
  469. bool Element::IsReplaced()
  470. {
  471. Vector2f unused_dimensions;
  472. float unused_ratio = 0.f;
  473. return GetIntrinsicDimensions(unused_dimensions, unused_ratio);
  474. }
  475. bool Element::IsPointWithinElement(const Vector2f point)
  476. {
  477. const Vector2f position = GetAbsoluteOffset(BoxArea::Border);
  478. for (int i = 0; i < GetNumBoxes(); ++i)
  479. {
  480. Vector2f box_offset;
  481. const Box& box = GetBox(i, box_offset);
  482. const Vector2f box_position = position + box_offset;
  483. const Vector2f box_dimensions = box.GetSize(BoxArea::Border);
  484. if (point.x >= box_position.x && point.x <= (box_position.x + box_dimensions.x) && point.y >= box_position.y &&
  485. point.y <= (box_position.y + box_dimensions.y))
  486. {
  487. return true;
  488. }
  489. }
  490. return false;
  491. }
  492. bool Element::IsVisible(bool include_ancestors) const
  493. {
  494. if (!include_ancestors)
  495. return visible;
  496. const Element* element = this;
  497. while (element)
  498. {
  499. if (!element->visible)
  500. return false;
  501. element = element->parent;
  502. }
  503. return true;
  504. }
  505. float Element::GetZIndex() const
  506. {
  507. return z_index;
  508. }
  509. FontFaceHandle Element::GetFontFaceHandle() const
  510. {
  511. return meta->computed_values.font_face_handle();
  512. }
  513. bool Element::SetProperty(const String& name, const String& value)
  514. {
  515. // The name may be a shorthand giving us multiple underlying properties
  516. PropertyDictionary properties;
  517. if (!StyleSheetSpecification::ParsePropertyDeclaration(properties, name, value))
  518. {
  519. Log::Message(Log::LT_WARNING, "Syntax error parsing inline property declaration '%s: %s;'.", name.c_str(), value.c_str());
  520. return false;
  521. }
  522. for (auto& property : properties.GetProperties())
  523. {
  524. if (!meta->style.SetProperty(property.first, property.second))
  525. return false;
  526. }
  527. return true;
  528. }
  529. bool Element::SetProperty(PropertyId id, const Property& property)
  530. {
  531. return meta->style.SetProperty(id, property);
  532. }
  533. void Element::RemoveProperty(const String& name)
  534. {
  535. auto property_id = StyleSheetSpecification::GetPropertyId(name);
  536. if (property_id != PropertyId::Invalid)
  537. meta->style.RemoveProperty(property_id);
  538. else
  539. {
  540. auto shorthand_id = StyleSheetSpecification::GetShorthandId(name);
  541. if (shorthand_id != ShorthandId::Invalid)
  542. {
  543. auto property_id_set = StyleSheetSpecification::GetShorthandUnderlyingProperties(shorthand_id);
  544. for (auto it = property_id_set.begin(); it != property_id_set.end(); ++it)
  545. meta->style.RemoveProperty(*it);
  546. }
  547. }
  548. }
  549. void Element::RemoveProperty(PropertyId id)
  550. {
  551. meta->style.RemoveProperty(id);
  552. }
  553. const Property* Element::GetProperty(const String& name)
  554. {
  555. return meta->style.GetProperty(StyleSheetSpecification::GetPropertyId(name));
  556. }
  557. const Property* Element::GetProperty(PropertyId id)
  558. {
  559. return meta->style.GetProperty(id);
  560. }
  561. const Property* Element::GetLocalProperty(const String& name)
  562. {
  563. return meta->style.GetLocalProperty(StyleSheetSpecification::GetPropertyId(name));
  564. }
  565. const Property* Element::GetLocalProperty(PropertyId id)
  566. {
  567. return meta->style.GetLocalProperty(id);
  568. }
  569. const PropertyMap& Element::GetLocalStyleProperties()
  570. {
  571. return meta->style.GetLocalStyleProperties();
  572. }
  573. float Element::ResolveLength(NumericValue value)
  574. {
  575. float result = 0.f;
  576. if (Any(value.unit & Unit::LENGTH))
  577. result = meta->style.ResolveNumericValue(value, 0.f);
  578. return result;
  579. }
  580. float Element::ResolveNumericValue(NumericValue value, float base_value)
  581. {
  582. float result = 0.f;
  583. if (Any(value.unit & Unit::NUMERIC))
  584. result = meta->style.ResolveNumericValue(value, base_value);
  585. return result;
  586. }
  587. Vector2f Element::GetContainingBlock()
  588. {
  589. Vector2f containing_block;
  590. if (offset_parent)
  591. {
  592. using namespace Style;
  593. Position position_property = GetPosition();
  594. const Box& parent_box = offset_parent->GetBox();
  595. if (position_property == Position::Static || position_property == Position::Relative)
  596. {
  597. containing_block = parent_box.GetSize();
  598. containing_block.x -= meta->scroll.GetScrollbarSize(ElementScroll::VERTICAL);
  599. containing_block.y -= meta->scroll.GetScrollbarSize(ElementScroll::HORIZONTAL);
  600. }
  601. else if (position_property == Position::Absolute || position_property == Position::Fixed)
  602. {
  603. containing_block = parent_box.GetSize(BoxArea::Padding);
  604. }
  605. }
  606. else if (Context* context = GetContext())
  607. {
  608. containing_block = Vector2f(context->GetDimensions());
  609. }
  610. return containing_block;
  611. }
  612. Style::Position Element::GetPosition()
  613. {
  614. return meta->computed_values.position();
  615. }
  616. Style::Float Element::GetFloat()
  617. {
  618. return meta->computed_values.float_();
  619. }
  620. Style::Display Element::GetDisplay()
  621. {
  622. return meta->computed_values.display();
  623. }
  624. float Element::GetLineHeight()
  625. {
  626. return meta->computed_values.line_height().value;
  627. }
  628. const TransformState* Element::GetTransformState() const noexcept
  629. {
  630. return transform_state.get();
  631. }
  632. bool Element::Project(Vector2f& point) const noexcept
  633. {
  634. if (!transform_state || !transform_state->GetTransform())
  635. return true;
  636. // The input point is in window coordinates. Need to find the projection of the point onto the current element plane,
  637. // taking into account the full transform applied to the element.
  638. if (const Matrix4f* inv_transform = transform_state->GetInverseTransform())
  639. {
  640. // Pick two points forming a line segment perpendicular to the window.
  641. Vector4f window_points[2] = {{point.x, point.y, -10, 1}, {point.x, point.y, 10, 1}};
  642. // Project them into the local element space.
  643. window_points[0] = *inv_transform * window_points[0];
  644. window_points[1] = *inv_transform * window_points[1];
  645. Vector3f local_points[2] = {window_points[0].PerspectiveDivide(), window_points[1].PerspectiveDivide()};
  646. // Construct a ray from the two projected points in the local space of the current element.
  647. // Find the intersection with the z=0 plane to produce our destination point.
  648. Vector3f ray = local_points[1] - local_points[0];
  649. // Only continue if we are not close to parallel with the plane.
  650. if (Math::Absolute(ray.z) > 1.0f)
  651. {
  652. // Solving the line equation p = p0 + t*ray for t, knowing that p.z = 0, produces the following.
  653. float t = -local_points[0].z / ray.z;
  654. Vector3f p = local_points[0] + ray * t;
  655. point = Vector2f(p.x, p.y);
  656. return true;
  657. }
  658. }
  659. // The transformation matrix is either singular, or the ray is parallel to the element's plane.
  660. return false;
  661. }
  662. PropertiesIteratorView Element::IterateLocalProperties() const
  663. {
  664. return PropertiesIteratorView(MakeUnique<PropertiesIterator>(meta->style.Iterate()));
  665. }
  666. void Element::SetPseudoClass(const String& pseudo_class, bool activate)
  667. {
  668. if (meta->style.SetPseudoClass(pseudo_class, activate, false))
  669. {
  670. // Include siblings in case of RCSS presence of sibling combinators '+', '~'.
  671. DirtyDefinition(DirtyNodes::SelfAndSiblings);
  672. OnPseudoClassChange(pseudo_class, activate);
  673. }
  674. }
  675. bool Element::IsPseudoClassSet(const String& pseudo_class) const
  676. {
  677. return meta->style.IsPseudoClassSet(pseudo_class);
  678. }
  679. bool Element::ArePseudoClassesSet(const StringList& pseudo_classes) const
  680. {
  681. for (const String& pseudo_class : pseudo_classes)
  682. {
  683. if (!IsPseudoClassSet(pseudo_class))
  684. return false;
  685. }
  686. return true;
  687. }
  688. StringList Element::GetActivePseudoClasses() const
  689. {
  690. const PseudoClassMap& pseudo_classes = meta->style.GetActivePseudoClasses();
  691. StringList names;
  692. names.reserve(pseudo_classes.size());
  693. for (auto& pseudo_class : pseudo_classes)
  694. {
  695. names.push_back(pseudo_class.first);
  696. }
  697. return names;
  698. }
  699. void Element::OverridePseudoClass(Element* element, const String& pseudo_class, bool activate)
  700. {
  701. RMLUI_ASSERT(element);
  702. element->GetStyle()->SetPseudoClass(pseudo_class, activate, true);
  703. }
  704. Variant* Element::GetAttribute(const String& name)
  705. {
  706. return GetIf(attributes, name);
  707. }
  708. const Variant* Element::GetAttribute(const String& name) const
  709. {
  710. return GetIf(attributes, name);
  711. }
  712. bool Element::HasAttribute(const String& name) const
  713. {
  714. return attributes.find(name) != attributes.end();
  715. }
  716. void Element::RemoveAttribute(const String& name)
  717. {
  718. auto it = attributes.find(name);
  719. if (it != attributes.end())
  720. {
  721. attributes.erase(it);
  722. ElementAttributes changed_attributes;
  723. changed_attributes.emplace(name, Variant());
  724. OnAttributeChange(changed_attributes);
  725. }
  726. }
  727. Element* Element::GetFocusLeafNode()
  728. {
  729. // If there isn't a focus, then we are the leaf.
  730. if (!focus)
  731. {
  732. return this;
  733. }
  734. // Recurse down the tree until we found the leaf focus element
  735. Element* focus_element = focus;
  736. while (focus_element->focus)
  737. focus_element = focus_element->focus;
  738. return focus_element;
  739. }
  740. Context* Element::GetContext() const
  741. {
  742. ElementDocument* document = GetOwnerDocument();
  743. if (document != nullptr)
  744. return document->GetContext();
  745. return nullptr;
  746. }
  747. RenderManager* Element::GetRenderManager() const
  748. {
  749. if (Context* context = GetContext())
  750. return &context->GetRenderManager();
  751. return nullptr;
  752. }
  753. void Element::SetAttributes(const ElementAttributes& _attributes)
  754. {
  755. attributes.reserve(attributes.size() + _attributes.size());
  756. for (auto& pair : _attributes)
  757. attributes[pair.first] = pair.second;
  758. OnAttributeChange(_attributes);
  759. }
  760. int Element::GetNumAttributes() const
  761. {
  762. return (int)attributes.size();
  763. }
  764. const String& Element::GetTagName() const
  765. {
  766. return tag;
  767. }
  768. const String& Element::GetId() const
  769. {
  770. return id;
  771. }
  772. void Element::SetId(const String& _id)
  773. {
  774. SetAttribute("id", _id);
  775. }
  776. float Element::GetAbsoluteLeft()
  777. {
  778. return GetAbsoluteOffset(BoxArea::Border).x;
  779. }
  780. float Element::GetAbsoluteTop()
  781. {
  782. return GetAbsoluteOffset(BoxArea::Border).y;
  783. }
  784. float Element::GetClientLeft()
  785. {
  786. return GetBox().GetPosition(BoxArea::Padding).x;
  787. }
  788. float Element::GetClientTop()
  789. {
  790. return GetBox().GetPosition(BoxArea::Padding).y;
  791. }
  792. float Element::GetClientWidth()
  793. {
  794. return GetBox().GetSize(BoxArea::Padding).x - meta->scroll.GetScrollbarSize(ElementScroll::VERTICAL);
  795. }
  796. float Element::GetClientHeight()
  797. {
  798. return GetBox().GetSize(BoxArea::Padding).y - meta->scroll.GetScrollbarSize(ElementScroll::HORIZONTAL);
  799. }
  800. Element* Element::GetOffsetParent()
  801. {
  802. return offset_parent;
  803. }
  804. float Element::GetOffsetLeft()
  805. {
  806. return relative_offset_base.x + relative_offset_position.x - GetBox().GetPosition(relative_offset_area).x;
  807. }
  808. float Element::GetOffsetTop()
  809. {
  810. return relative_offset_base.y + relative_offset_position.y - GetBox().GetPosition(relative_offset_area).y;
  811. }
  812. float Element::GetOffsetWidth()
  813. {
  814. return GetBox().GetSize(BoxArea::Border).x;
  815. }
  816. float Element::GetOffsetHeight()
  817. {
  818. return GetBox().GetSize(BoxArea::Border).y;
  819. }
  820. float Element::GetScrollLeft()
  821. {
  822. return scroll_offset.x;
  823. }
  824. void Element::SetScrollLeft(float scroll_left)
  825. {
  826. const float new_offset = Math::Round(Math::Clamp(scroll_left, 0.0f, GetScrollWidth() - GetClientWidth()));
  827. if (new_offset != scroll_offset.x)
  828. {
  829. scroll_offset.x = new_offset;
  830. meta->scroll.UpdateScrollbar(ElementScroll::HORIZONTAL);
  831. DirtyAbsoluteOffset();
  832. DispatchEvent(EventId::Scroll, Dictionary());
  833. }
  834. }
  835. float Element::GetScrollTop()
  836. {
  837. return scroll_offset.y;
  838. }
  839. void Element::SetScrollTop(float scroll_top)
  840. {
  841. const float new_offset = Math::Round(Math::Clamp(Math::Round(scroll_top), 0.0f, GetScrollHeight() - GetClientHeight()));
  842. if (new_offset != scroll_offset.y)
  843. {
  844. scroll_offset.y = new_offset;
  845. meta->scroll.UpdateScrollbar(ElementScroll::VERTICAL);
  846. DirtyAbsoluteOffset();
  847. DispatchEvent(EventId::Scroll, Dictionary());
  848. }
  849. }
  850. float Element::GetScrollWidth()
  851. {
  852. return Math::Max(scrollable_overflow_rectangle.x, GetClientWidth());
  853. }
  854. float Element::GetScrollHeight()
  855. {
  856. return Math::Max(scrollable_overflow_rectangle.y, GetClientHeight());
  857. }
  858. ElementStyle* Element::GetStyle() const
  859. {
  860. return &meta->style;
  861. }
  862. ElementDocument* Element::GetOwnerDocument() const
  863. {
  864. #ifdef RMLUI_DEBUG
  865. if (parent && !owner_document)
  866. {
  867. // Since we have a parent but no owner_document, then we must be a 'loose' element -- that is, constructed
  868. // outside of a document and not attached to a child of any element in the hierarchy of a document.
  869. // This check ensures that we didn't just forget to set the owner document.
  870. RMLUI_ASSERT(!parent->GetOwnerDocument());
  871. }
  872. #endif
  873. return owner_document;
  874. }
  875. Element* Element::GetParentNode() const
  876. {
  877. return parent;
  878. }
  879. Element* Element::Closest(const String& selectors) const
  880. {
  881. StyleSheetNode root_node;
  882. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  883. if (leaf_nodes.empty())
  884. {
  885. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  886. return nullptr;
  887. }
  888. Element* parent = GetParentNode();
  889. while (parent)
  890. {
  891. for (const StyleSheetNode* node : leaf_nodes)
  892. {
  893. if (node->IsApplicable(parent, this))
  894. {
  895. return parent;
  896. }
  897. }
  898. parent = parent->GetParentNode();
  899. }
  900. return nullptr;
  901. }
  902. Element* Element::GetNextSibling() const
  903. {
  904. if (parent == nullptr)
  905. return nullptr;
  906. for (size_t i = 0; i < parent->children.size() - (parent->num_non_dom_children + 1); i++)
  907. {
  908. if (parent->children[i].get() == this)
  909. return parent->children[i + 1].get();
  910. }
  911. return nullptr;
  912. }
  913. Element* Element::GetPreviousSibling() const
  914. {
  915. if (parent == nullptr)
  916. return nullptr;
  917. for (size_t i = 1; i < parent->children.size() - parent->num_non_dom_children; i++)
  918. {
  919. if (parent->children[i].get() == this)
  920. return parent->children[i - 1].get();
  921. }
  922. return nullptr;
  923. }
  924. Element* Element::GetFirstChild() const
  925. {
  926. if (GetNumChildren() > 0)
  927. return children[0].get();
  928. return nullptr;
  929. }
  930. Element* Element::GetLastChild() const
  931. {
  932. if (GetNumChildren() > 0)
  933. return (children.end() - (num_non_dom_children + 1))->get();
  934. return nullptr;
  935. }
  936. Element* Element::GetChild(int index) const
  937. {
  938. if (index < 0 || index >= (int)children.size())
  939. return nullptr;
  940. return children[index].get();
  941. }
  942. int Element::GetNumChildren(bool include_non_dom_elements) const
  943. {
  944. return (int)children.size() - (include_non_dom_elements ? 0 : num_non_dom_children);
  945. }
  946. void Element::GetInnerRML(String& content) const
  947. {
  948. for (int i = 0; i < GetNumChildren(); i++)
  949. {
  950. children[i]->GetRML(content);
  951. }
  952. }
  953. String Element::GetInnerRML() const
  954. {
  955. String result;
  956. GetInnerRML(result);
  957. return result;
  958. }
  959. void Element::SetInnerRML(const String& rml)
  960. {
  961. RMLUI_ZoneScopedC(0x6495ED);
  962. // Remove all DOM children.
  963. while ((int)children.size() > num_non_dom_children)
  964. RemoveChild(children.front().get());
  965. if (!rml.empty())
  966. Factory::InstanceElementText(this, rml);
  967. }
  968. bool Element::Focus(bool focus_visible)
  969. {
  970. // Are we allowed focus?
  971. Style::Focus focus_property = meta->computed_values.focus();
  972. if (focus_property == Style::Focus::None)
  973. return false;
  974. // Ask our context if we can switch focus.
  975. Context* context = GetContext();
  976. if (context == nullptr)
  977. return false;
  978. if (!context->OnFocusChange(this, focus_visible))
  979. return false;
  980. // Set this as the end of the focus chain.
  981. focus = nullptr;
  982. // Update the focus chain up the hierarchy.
  983. Element* element = this;
  984. while (Element* parent = element->GetParentNode())
  985. {
  986. parent->focus = element;
  987. element = parent;
  988. }
  989. return true;
  990. }
  991. void Element::Blur()
  992. {
  993. if (parent)
  994. {
  995. Context* context = GetContext();
  996. if (context == nullptr)
  997. return;
  998. if (context->GetFocusElement() == this)
  999. {
  1000. parent->Focus();
  1001. }
  1002. else if (parent->focus == this)
  1003. {
  1004. parent->focus = nullptr;
  1005. }
  1006. }
  1007. }
  1008. void Element::Click()
  1009. {
  1010. Context* context = GetContext();
  1011. if (context == nullptr)
  1012. return;
  1013. context->GenerateClickEvent(this);
  1014. }
  1015. void Element::AddEventListener(const String& event, EventListener* listener, const bool in_capture_phase)
  1016. {
  1017. const EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  1018. meta->event_dispatcher.AttachEvent(id, listener, in_capture_phase);
  1019. }
  1020. void Element::AddEventListener(const EventId id, EventListener* listener, const bool in_capture_phase)
  1021. {
  1022. meta->event_dispatcher.AttachEvent(id, listener, in_capture_phase);
  1023. }
  1024. void Element::RemoveEventListener(const String& event, EventListener* listener, bool in_capture_phase)
  1025. {
  1026. EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  1027. meta->event_dispatcher.DetachEvent(id, listener, in_capture_phase);
  1028. }
  1029. void Element::RemoveEventListener(EventId id, EventListener* listener, bool in_capture_phase)
  1030. {
  1031. meta->event_dispatcher.DetachEvent(id, listener, in_capture_phase);
  1032. }
  1033. bool Element::DispatchEvent(const String& type, const Dictionary& parameters)
  1034. {
  1035. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1036. return EventDispatcher::DispatchEvent(this, specification.id, type, parameters, specification.interruptible, specification.bubbles,
  1037. specification.default_action_phase);
  1038. }
  1039. bool Element::DispatchEvent(const String& type, const Dictionary& parameters, bool interruptible, bool bubbles)
  1040. {
  1041. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1042. return EventDispatcher::DispatchEvent(this, specification.id, type, parameters, interruptible, bubbles, specification.default_action_phase);
  1043. }
  1044. bool Element::DispatchEvent(EventId id, const Dictionary& parameters)
  1045. {
  1046. const EventSpecification& specification = EventSpecificationInterface::Get(id);
  1047. return EventDispatcher::DispatchEvent(this, specification.id, specification.type, parameters, specification.interruptible, specification.bubbles,
  1048. specification.default_action_phase);
  1049. }
  1050. void Element::ScrollIntoView(const ScrollIntoViewOptions options)
  1051. {
  1052. const Vector2f size = main_box.GetSize(BoxArea::Border);
  1053. ScrollBehavior scroll_behavior = options.behavior;
  1054. for (Element* scroll_parent = parent; scroll_parent; scroll_parent = scroll_parent->GetParentNode())
  1055. {
  1056. using Style::Overflow;
  1057. const ComputedValues& computed = scroll_parent->GetComputedValues();
  1058. const bool scrollable_box_x = (computed.overflow_x() != Overflow::Visible && computed.overflow_x() != Overflow::Hidden);
  1059. const bool scrollable_box_y = (computed.overflow_y() != Overflow::Visible && computed.overflow_y() != Overflow::Hidden);
  1060. const Vector2f parent_scroll_size = {scroll_parent->GetScrollWidth(), scroll_parent->GetScrollHeight()};
  1061. const Vector2f parent_client_size = {scroll_parent->GetClientWidth(), scroll_parent->GetClientHeight()};
  1062. if ((scrollable_box_x && parent_scroll_size.x > parent_client_size.x) || (scrollable_box_y && parent_scroll_size.y > parent_client_size.y))
  1063. {
  1064. const Vector2f relative_offset = scroll_parent->GetAbsoluteOffset(BoxArea::Border) - GetAbsoluteOffset(BoxArea::Border);
  1065. const Vector2f old_scroll_offset = {scroll_parent->GetScrollLeft(), scroll_parent->GetScrollTop()};
  1066. const Vector2f parent_client_offset = {scroll_parent->GetClientLeft(), scroll_parent->GetClientTop()};
  1067. const Vector2f delta_scroll_offset_start = parent_client_offset - relative_offset;
  1068. const Vector2f delta_scroll_offset_end = delta_scroll_offset_start + size - parent_client_size;
  1069. Vector2f scroll_delta = {
  1070. scrollable_box_x ? GetScrollOffsetDelta(options.horizontal, delta_scroll_offset_start.x, delta_scroll_offset_end.x) : 0.f,
  1071. scrollable_box_y ? GetScrollOffsetDelta(options.vertical, delta_scroll_offset_start.y, delta_scroll_offset_end.y) : 0.f,
  1072. };
  1073. scroll_parent->ScrollTo(old_scroll_offset + scroll_delta, scroll_behavior);
  1074. // Currently, only a single scrollable parent can be smooth scrolled at a time, so any other parents must be instant scrolled.
  1075. scroll_behavior = ScrollBehavior::Instant;
  1076. }
  1077. if ((scrollable_box_x || scrollable_box_y) && options.parentage == ScrollParentage::Closest)
  1078. break;
  1079. }
  1080. }
  1081. void Element::ScrollIntoView(bool align_with_top)
  1082. {
  1083. ScrollIntoViewOptions options;
  1084. options.vertical = (align_with_top ? ScrollAlignment::Start : ScrollAlignment::End);
  1085. options.horizontal = ScrollAlignment::Nearest;
  1086. ScrollIntoView(options);
  1087. }
  1088. void Element::ScrollTo(Vector2f offset, ScrollBehavior behavior)
  1089. {
  1090. if (behavior != ScrollBehavior::Instant)
  1091. {
  1092. if (Context* context = GetContext())
  1093. {
  1094. context->PerformSmoothscrollOnTarget(this, offset - scroll_offset, behavior);
  1095. return;
  1096. }
  1097. }
  1098. SetScrollLeft(offset.x);
  1099. SetScrollTop(offset.y);
  1100. }
  1101. Element* Element::AppendChild(ElementPtr child, bool dom_element)
  1102. {
  1103. RMLUI_ASSERT(child);
  1104. Element* child_ptr = child.get();
  1105. if (dom_element)
  1106. children.insert(children.end() - num_non_dom_children, std::move(child));
  1107. else
  1108. {
  1109. children.push_back(std::move(child));
  1110. num_non_dom_children++;
  1111. }
  1112. // Set parent just after inserting into children. This allows us to eg. get our previous sibling in SetParent.
  1113. child_ptr->SetParent(this);
  1114. Element* ancestor = child_ptr;
  1115. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1116. ancestor->OnChildAdd(child_ptr);
  1117. DirtyStackingContext();
  1118. // Not only does the element definition of the newly inserted element need to be dirtied, but also our own definition and implicitly all of our
  1119. // children's. This ensures correct styles being applied in the presence of tree-structural selectors such as ':first-child'.
  1120. DirtyDefinition(DirtyNodes::Self);
  1121. if (dom_element)
  1122. DirtyLayout();
  1123. return child_ptr;
  1124. }
  1125. Element* Element::InsertBefore(ElementPtr child, Element* adjacent_element)
  1126. {
  1127. RMLUI_ASSERT(child);
  1128. // Find the position in the list of children of the adjacent element. If
  1129. // it's nullptr or we can't find it, then we insert it at the end of the dom
  1130. // children, as a dom element.
  1131. size_t child_index = 0;
  1132. bool found_child = false;
  1133. if (adjacent_element)
  1134. {
  1135. for (child_index = 0; child_index < children.size(); child_index++)
  1136. {
  1137. if (children[child_index].get() == adjacent_element)
  1138. {
  1139. found_child = true;
  1140. break;
  1141. }
  1142. }
  1143. }
  1144. Element* child_ptr = nullptr;
  1145. if (found_child)
  1146. {
  1147. child_ptr = child.get();
  1148. if ((int)child_index >= GetNumChildren())
  1149. num_non_dom_children++;
  1150. else
  1151. DirtyLayout();
  1152. children.insert(children.begin() + child_index, std::move(child));
  1153. child_ptr->SetParent(this);
  1154. Element* ancestor = child_ptr;
  1155. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1156. ancestor->OnChildAdd(child_ptr);
  1157. DirtyStackingContext();
  1158. DirtyDefinition(DirtyNodes::Self);
  1159. }
  1160. else
  1161. {
  1162. child_ptr = AppendChild(std::move(child));
  1163. }
  1164. return child_ptr;
  1165. }
  1166. ElementPtr Element::ReplaceChild(ElementPtr inserted_element, Element* replaced_element)
  1167. {
  1168. RMLUI_ASSERT(inserted_element);
  1169. auto insertion_point = children.begin();
  1170. while (insertion_point != children.end() && insertion_point->get() != replaced_element)
  1171. {
  1172. ++insertion_point;
  1173. }
  1174. Element* inserted_element_ptr = inserted_element.get();
  1175. if (insertion_point == children.end())
  1176. {
  1177. AppendChild(std::move(inserted_element));
  1178. return nullptr;
  1179. }
  1180. children.insert(insertion_point, std::move(inserted_element));
  1181. inserted_element_ptr->SetParent(this);
  1182. ElementPtr result = RemoveChild(replaced_element);
  1183. Element* ancestor = inserted_element_ptr;
  1184. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1185. ancestor->OnChildAdd(inserted_element_ptr);
  1186. return result;
  1187. }
  1188. ElementPtr Element::RemoveChild(Element* child)
  1189. {
  1190. size_t child_index = 0;
  1191. for (auto itr = children.begin(); itr != children.end(); ++itr)
  1192. {
  1193. // Add the element to the delete list
  1194. if (itr->get() == child)
  1195. {
  1196. Element* ancestor = child;
  1197. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1198. ancestor->OnChildRemove(child);
  1199. if (child_index >= children.size() - num_non_dom_children)
  1200. num_non_dom_children--;
  1201. ElementPtr detached_child = std::move(*itr);
  1202. children.erase(itr);
  1203. // Remove the child element as the focused child of this element.
  1204. if (child == focus)
  1205. {
  1206. focus = nullptr;
  1207. // If this child (or a descendant of this child) is the context's currently
  1208. // focused element, set the focus to us instead.
  1209. if (Context* context = GetContext())
  1210. {
  1211. Element* focus_element = context->GetFocusElement();
  1212. while (focus_element)
  1213. {
  1214. if (focus_element == child)
  1215. {
  1216. Focus();
  1217. break;
  1218. }
  1219. focus_element = focus_element->GetParentNode();
  1220. }
  1221. }
  1222. }
  1223. detached_child->SetParent(nullptr);
  1224. DirtyLayout();
  1225. DirtyStackingContext();
  1226. DirtyDefinition(DirtyNodes::Self);
  1227. return detached_child;
  1228. }
  1229. child_index++;
  1230. }
  1231. return nullptr;
  1232. }
  1233. bool Element::HasChildNodes() const
  1234. {
  1235. return (int)children.size() > num_non_dom_children;
  1236. }
  1237. Element* Element::GetElementById(const String& id)
  1238. {
  1239. // Check for special-case tokens.
  1240. if (id == "#self")
  1241. return this;
  1242. else if (id == "#document")
  1243. return GetOwnerDocument();
  1244. else if (id == "#parent")
  1245. return this->parent;
  1246. else
  1247. {
  1248. Element* search_root = GetOwnerDocument();
  1249. if (search_root == nullptr)
  1250. search_root = this;
  1251. return ElementUtilities::GetElementById(search_root, id);
  1252. }
  1253. }
  1254. void Element::GetElementsByTagName(ElementList& elements, const String& tag)
  1255. {
  1256. return ElementUtilities::GetElementsByTagName(elements, this, tag);
  1257. }
  1258. void Element::GetElementsByClassName(ElementList& elements, const String& class_name)
  1259. {
  1260. return ElementUtilities::GetElementsByClassName(elements, this, class_name);
  1261. }
  1262. static Element* QuerySelectorMatchRecursive(const StyleSheetNodeListRaw& nodes, Element* element, Element* scope)
  1263. {
  1264. const int num_children = element->GetNumChildren();
  1265. for (int i = 0; i < num_children; i++)
  1266. {
  1267. Element* child = element->GetChild(i);
  1268. if (child->GetTagName() == "#text")
  1269. continue;
  1270. for (const StyleSheetNode* node : nodes)
  1271. {
  1272. if (node->IsApplicable(child, scope))
  1273. return child;
  1274. }
  1275. Element* matching_element = QuerySelectorMatchRecursive(nodes, child, scope);
  1276. if (matching_element)
  1277. return matching_element;
  1278. }
  1279. return nullptr;
  1280. }
  1281. static void QuerySelectorAllMatchRecursive(ElementList& matching_elements, const StyleSheetNodeListRaw& nodes, Element* element, Element* scope)
  1282. {
  1283. const int num_children = element->GetNumChildren();
  1284. for (int i = 0; i < num_children; i++)
  1285. {
  1286. Element* child = element->GetChild(i);
  1287. if (child->GetTagName() == "#text")
  1288. continue;
  1289. for (const StyleSheetNode* node : nodes)
  1290. {
  1291. if (node->IsApplicable(child, scope))
  1292. {
  1293. matching_elements.push_back(child);
  1294. break;
  1295. }
  1296. }
  1297. QuerySelectorAllMatchRecursive(matching_elements, nodes, child, scope);
  1298. }
  1299. }
  1300. Element* Element::QuerySelector(const String& selectors)
  1301. {
  1302. StyleSheetNode root_node;
  1303. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  1304. if (leaf_nodes.empty())
  1305. {
  1306. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  1307. return nullptr;
  1308. }
  1309. return QuerySelectorMatchRecursive(leaf_nodes, this, this);
  1310. }
  1311. void Element::QuerySelectorAll(ElementList& elements, const String& selectors)
  1312. {
  1313. StyleSheetNode root_node;
  1314. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  1315. if (leaf_nodes.empty())
  1316. {
  1317. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  1318. return;
  1319. }
  1320. QuerySelectorAllMatchRecursive(elements, leaf_nodes, this, this);
  1321. }
  1322. bool Element::Matches(const String& selectors)
  1323. {
  1324. StyleSheetNode root_node;
  1325. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  1326. if (leaf_nodes.empty())
  1327. {
  1328. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  1329. return false;
  1330. }
  1331. for (const StyleSheetNode* node : leaf_nodes)
  1332. {
  1333. if (node->IsApplicable(this, this))
  1334. {
  1335. return true;
  1336. }
  1337. }
  1338. return false;
  1339. }
  1340. bool Element::Contains(Element* element) const
  1341. {
  1342. while (element)
  1343. {
  1344. if (element == this)
  1345. return true;
  1346. element = element->GetParentNode();
  1347. }
  1348. return false;
  1349. }
  1350. EventDispatcher* Element::GetEventDispatcher() const
  1351. {
  1352. return &meta->event_dispatcher;
  1353. }
  1354. String Element::GetEventDispatcherSummary() const
  1355. {
  1356. return meta->event_dispatcher.ToString();
  1357. }
  1358. ElementBackgroundBorder* Element::GetElementBackgroundBorder() const
  1359. {
  1360. return &meta->background_border;
  1361. }
  1362. ElementScroll* Element::GetElementScroll() const
  1363. {
  1364. return &meta->scroll;
  1365. }
  1366. DataModel* Element::GetDataModel() const
  1367. {
  1368. return data_model;
  1369. }
  1370. LayoutNode* Element::GetLayoutNode() const
  1371. {
  1372. return &meta->layout_node;
  1373. }
  1374. void Element::SetInstancer(ElementInstancer* _instancer)
  1375. {
  1376. // Only record the first instancer being set as some instancers call other instancers to do their dirty work, in
  1377. // which case we don't want to update the lowest level instancer.
  1378. if (!instancer)
  1379. {
  1380. instancer = _instancer;
  1381. }
  1382. }
  1383. void Element::ForceLocalStackingContext()
  1384. {
  1385. local_stacking_context_forced = true;
  1386. local_stacking_context = true;
  1387. DirtyStackingContext();
  1388. }
  1389. void Element::OnUpdate() {}
  1390. void Element::OnRender() {}
  1391. void Element::OnResize() {}
  1392. void Element::OnLayout() {}
  1393. void Element::OnDpRatioChange() {}
  1394. void Element::OnStyleSheetChange() {}
  1395. void Element::OnAttributeChange(const ElementAttributes& changed_attributes)
  1396. {
  1397. for (const auto& element_attribute : changed_attributes)
  1398. {
  1399. const auto& attribute = element_attribute.first;
  1400. const auto& value = element_attribute.second;
  1401. if (attribute == "id")
  1402. {
  1403. id = value.Get<String>();
  1404. }
  1405. else if (attribute == "class")
  1406. {
  1407. meta->style.SetClassNames(value.Get<String>());
  1408. }
  1409. else if (((attribute == "colspan" || attribute == "rowspan") && meta->computed_values.display() == Style::Display::TableCell) ||
  1410. (attribute == "span" &&
  1411. (meta->computed_values.display() == Style::Display::TableColumn ||
  1412. meta->computed_values.display() == Style::Display::TableColumnGroup)))
  1413. {
  1414. DirtyLayout();
  1415. }
  1416. else if (attribute.size() > 2 && attribute[0] == 'o' && attribute[1] == 'n')
  1417. {
  1418. static constexpr bool IN_CAPTURE_PHASE = false;
  1419. auto& attribute_event_listeners = meta->attribute_event_listeners;
  1420. auto& event_dispatcher = meta->event_dispatcher;
  1421. const auto event_id = EventSpecificationInterface::GetIdOrInsert(attribute.substr(2));
  1422. const auto remove_event_listener_if_exists = [&attribute_event_listeners, &event_dispatcher, event_id]() {
  1423. const auto listener_it = attribute_event_listeners.find(event_id);
  1424. if (listener_it != attribute_event_listeners.cend())
  1425. {
  1426. event_dispatcher.DetachEvent(event_id, listener_it->second, IN_CAPTURE_PHASE);
  1427. attribute_event_listeners.erase(listener_it);
  1428. }
  1429. };
  1430. if (value.GetType() == Variant::Type::STRING)
  1431. {
  1432. remove_event_listener_if_exists();
  1433. const auto value_as_string = value.Get<String>();
  1434. auto insertion_result = attribute_event_listeners.emplace(event_id, Factory::InstanceEventListener(value_as_string, this));
  1435. if (auto* listener = insertion_result.first->second)
  1436. event_dispatcher.AttachEvent(event_id, listener, IN_CAPTURE_PHASE);
  1437. }
  1438. else if (value.GetType() == Variant::Type::NONE)
  1439. remove_event_listener_if_exists();
  1440. }
  1441. else if (attribute == "style")
  1442. {
  1443. if (value.GetType() == Variant::STRING)
  1444. {
  1445. PropertyDictionary properties;
  1446. StyleSheetParser parser;
  1447. parser.ParseProperties(properties, value.GetReference<String>());
  1448. for (const auto& name_value : properties.GetProperties())
  1449. meta->style.SetProperty(name_value.first, name_value.second);
  1450. }
  1451. else if (value.GetType() != Variant::NONE)
  1452. Log::Message(Log::LT_WARNING, "Invalid 'style' attribute, string type required. In element: %s", GetAddress().c_str());
  1453. }
  1454. else if (attribute == "lang")
  1455. {
  1456. if (value.GetType() == Variant::STRING)
  1457. meta->style.SetProperty(PropertyId::RmlUi_Language, Property(value.GetReference<String>(), Unit::STRING));
  1458. else if (value.GetType() != Variant::NONE)
  1459. Log::Message(Log::LT_WARNING, "Invalid 'lang' attribute, string type required. In element: %s", GetAddress().c_str());
  1460. }
  1461. else if (attribute == "dir")
  1462. {
  1463. if (value.GetType() == Variant::STRING)
  1464. {
  1465. const String& dir_value = value.GetReference<String>();
  1466. if (dir_value == "auto")
  1467. meta->style.SetProperty(PropertyId::RmlUi_Direction, Property(Style::Direction::Auto));
  1468. else if (dir_value == "ltr")
  1469. meta->style.SetProperty(PropertyId::RmlUi_Direction, Property(Style::Direction::Ltr));
  1470. else if (dir_value == "rtl")
  1471. meta->style.SetProperty(PropertyId::RmlUi_Direction, Property(Style::Direction::Rtl));
  1472. else
  1473. Log::Message(Log::LT_WARNING, "Invalid 'dir' attribute '%s', value must be 'auto', 'ltr', or 'rtl'. In element: %s",
  1474. dir_value.c_str(), GetAddress().c_str());
  1475. }
  1476. else if (value.GetType() != Variant::NONE)
  1477. Log::Message(Log::LT_WARNING, "Invalid 'dir' attribute, string type required. In element: %s", GetAddress().c_str());
  1478. }
  1479. }
  1480. // Any change to the attributes may affect which styles apply to the current element, in particular due to attribute selectors, ID selectors, and
  1481. // class selectors. This can further affect all siblings or descendants due to sibling or descendant combinators.
  1482. DirtyDefinition(DirtyNodes::SelfAndSiblings);
  1483. }
  1484. void Element::OnPropertyChange(const PropertyIdSet& changed_properties)
  1485. {
  1486. RMLUI_ZoneScoped;
  1487. const bool top_right_bottom_left_changed = ( //
  1488. changed_properties.Contains(PropertyId::Top) || //
  1489. changed_properties.Contains(PropertyId::Right) || //
  1490. changed_properties.Contains(PropertyId::Bottom) || //
  1491. changed_properties.Contains(PropertyId::Left) //
  1492. );
  1493. // See if the document layout needs to be updated.
  1494. // TODO
  1495. // if (!IsLayoutDirty())
  1496. {
  1497. // Force a relayout if any of the changed properties require it.
  1498. const PropertyIdSet changed_properties_forcing_layout =
  1499. (changed_properties & StyleSheetSpecification::GetRegisteredPropertiesForcingLayout());
  1500. if (!changed_properties_forcing_layout.Empty())
  1501. {
  1502. DirtyLayout();
  1503. }
  1504. else if (top_right_bottom_left_changed)
  1505. {
  1506. // Normally, the position properties only affect the position of the element and not the layout. Thus, these properties are not registered
  1507. // as affecting layout. However, when absolutely positioned elements with both left & right, or top & bottom are set to definite values,
  1508. // they affect the size of the element and thereby also the layout. This layout-dirtying condition needs to be registered manually.
  1509. using namespace Style;
  1510. const ComputedValues& computed = GetComputedValues();
  1511. const bool absolutely_positioned = (computed.position() == Position::Absolute || computed.position() == Position::Fixed);
  1512. const bool sized_width =
  1513. (computed.width().type == Width::Auto && computed.left().type != Left::Auto && computed.right().type != Right::Auto);
  1514. const bool sized_height =
  1515. (computed.height().type == Height::Auto && computed.top().type != Top::Auto && computed.bottom().type != Bottom::Auto);
  1516. if (absolutely_positioned && (sized_width || sized_height))
  1517. DirtyLayout();
  1518. }
  1519. }
  1520. // Update the position.
  1521. if (top_right_bottom_left_changed)
  1522. {
  1523. UpdateRelativeOffsetFromInsetConstraints();
  1524. DirtyAbsoluteOffset();
  1525. }
  1526. // Update the visibility.
  1527. if (changed_properties.Contains(PropertyId::Visibility) || changed_properties.Contains(PropertyId::Display))
  1528. {
  1529. bool new_visibility =
  1530. (meta->computed_values.display() != Style::Display::None && meta->computed_values.visibility() == Style::Visibility::Visible);
  1531. if (visible != new_visibility)
  1532. {
  1533. visible = new_visibility;
  1534. if (parent != nullptr)
  1535. parent->DirtyStackingContext();
  1536. if (!visible)
  1537. Blur();
  1538. }
  1539. }
  1540. const bool border_radius_changed = ( //
  1541. changed_properties.Contains(PropertyId::BorderTopLeftRadius) || //
  1542. changed_properties.Contains(PropertyId::BorderTopRightRadius) || //
  1543. changed_properties.Contains(PropertyId::BorderBottomRightRadius) || //
  1544. changed_properties.Contains(PropertyId::BorderBottomLeftRadius) //
  1545. );
  1546. const bool filter_or_mask_changed = (changed_properties.Contains(PropertyId::Filter) || changed_properties.Contains(PropertyId::BackdropFilter) ||
  1547. changed_properties.Contains(PropertyId::MaskImage));
  1548. // Update the z-index and stacking context.
  1549. if (changed_properties.Contains(PropertyId::ZIndex) || filter_or_mask_changed)
  1550. {
  1551. const Style::ZIndex z_index_property = meta->computed_values.z_index();
  1552. const float new_z_index = (z_index_property.type == Style::ZIndex::Auto ? 0.f : z_index_property.value);
  1553. const bool enable_local_stacking_context = (z_index_property.type != Style::ZIndex::Auto || local_stacking_context_forced ||
  1554. meta->computed_values.has_filter() || meta->computed_values.has_backdrop_filter() || meta->computed_values.has_mask_image());
  1555. if (z_index != new_z_index || local_stacking_context != enable_local_stacking_context)
  1556. {
  1557. z_index = new_z_index;
  1558. if (local_stacking_context != enable_local_stacking_context)
  1559. {
  1560. local_stacking_context = enable_local_stacking_context;
  1561. // If we are no longer acting as a local stacking context, then we clear the list and are all set. Otherwise, we need to rebuild our
  1562. // local stacking context.
  1563. stacking_context.clear();
  1564. stacking_context_dirty = local_stacking_context;
  1565. }
  1566. // When our z-index or local stacking context changes, then we must dirty our parent stacking context so we are re-indexed.
  1567. if (parent)
  1568. parent->DirtyStackingContext();
  1569. }
  1570. }
  1571. // Dirty the background if it's changed.
  1572. if (border_radius_changed || //
  1573. changed_properties.Contains(PropertyId::BackgroundColor) || //
  1574. changed_properties.Contains(PropertyId::Opacity) || //
  1575. changed_properties.Contains(PropertyId::ImageColor) || //
  1576. changed_properties.Contains(PropertyId::BoxShadow)) //
  1577. {
  1578. meta->background_border.DirtyBackground();
  1579. }
  1580. // Dirty the border if it's changed.
  1581. if (border_radius_changed || //
  1582. changed_properties.Contains(PropertyId::BorderTopWidth) || //
  1583. changed_properties.Contains(PropertyId::BorderRightWidth) || //
  1584. changed_properties.Contains(PropertyId::BorderBottomWidth) || //
  1585. changed_properties.Contains(PropertyId::BorderLeftWidth) || //
  1586. changed_properties.Contains(PropertyId::BorderTopColor) || //
  1587. changed_properties.Contains(PropertyId::BorderRightColor) || //
  1588. changed_properties.Contains(PropertyId::BorderBottomColor) || //
  1589. changed_properties.Contains(PropertyId::BorderLeftColor) || //
  1590. changed_properties.Contains(PropertyId::Opacity))
  1591. {
  1592. meta->background_border.DirtyBorder();
  1593. }
  1594. // Dirty the effects if they've changed.
  1595. if (border_radius_changed || filter_or_mask_changed || changed_properties.Contains(PropertyId::Decorator))
  1596. {
  1597. meta->effects.DirtyEffects();
  1598. }
  1599. // Dirty the effects data when their visual looks may have changed.
  1600. if (border_radius_changed || //
  1601. changed_properties.Contains(PropertyId::Opacity) || //
  1602. changed_properties.Contains(PropertyId::ImageColor))
  1603. {
  1604. meta->effects.DirtyEffectsData();
  1605. }
  1606. // Check for `perspective' and `perspective-origin' changes
  1607. if (changed_properties.Contains(PropertyId::Perspective) || //
  1608. changed_properties.Contains(PropertyId::PerspectiveOriginX) || //
  1609. changed_properties.Contains(PropertyId::PerspectiveOriginY))
  1610. {
  1611. DirtyTransformState(true, false);
  1612. }
  1613. // Check for `transform' and `transform-origin' changes
  1614. if (changed_properties.Contains(PropertyId::Transform) || //
  1615. changed_properties.Contains(PropertyId::TransformOriginX) || //
  1616. changed_properties.Contains(PropertyId::TransformOriginY) || //
  1617. changed_properties.Contains(PropertyId::TransformOriginZ))
  1618. {
  1619. DirtyTransformState(false, true);
  1620. }
  1621. // Check for `animation' changes
  1622. if (changed_properties.Contains(PropertyId::Animation))
  1623. {
  1624. dirty_animation = true;
  1625. }
  1626. // Check for `transition' changes
  1627. if (changed_properties.Contains(PropertyId::Transition))
  1628. {
  1629. dirty_transition = true;
  1630. }
  1631. }
  1632. void Element::OnPseudoClassChange(const String& /*pseudo_class*/, bool /*activate*/) {}
  1633. void Element::OnChildAdd(Element* /*child*/) {}
  1634. void Element::OnChildRemove(Element* /*child*/) {}
  1635. void Element::DirtyLayout()
  1636. {
  1637. GetLayoutNode()->SetDirty(DirtyLayoutType::DOM);
  1638. if (ElementDocument* document = GetOwnerDocument())
  1639. document->DirtyDocumentLayout();
  1640. }
  1641. Element* Element::GetClosestScrollableContainer()
  1642. {
  1643. using namespace Style;
  1644. Overflow overflow_x = meta->computed_values.overflow_x();
  1645. Overflow overflow_y = meta->computed_values.overflow_y();
  1646. bool scrollable_x = (overflow_x == Overflow::Auto || overflow_x == Overflow::Scroll);
  1647. bool scrollable_y = (overflow_y == Overflow::Auto || overflow_y == Overflow::Scroll);
  1648. scrollable_x = (scrollable_x && GetScrollWidth() > GetClientWidth());
  1649. scrollable_y = (scrollable_y && GetScrollHeight() > GetClientHeight());
  1650. if (scrollable_x || scrollable_y || meta->computed_values.overscroll_behavior() == OverscrollBehavior::Contain)
  1651. return this;
  1652. else if (parent)
  1653. return parent->GetClosestScrollableContainer();
  1654. return nullptr;
  1655. }
  1656. void Element::ProcessDefaultAction(Event& event)
  1657. {
  1658. if (event == EventId::Mousedown)
  1659. {
  1660. const Vector2f mouse_pos(event.GetParameter("mouse_x", 0.f), event.GetParameter("mouse_y", 0.f));
  1661. if (IsPointWithinElement(mouse_pos) && event.GetParameter("button", 0) == 0)
  1662. SetPseudoClass("active", true);
  1663. }
  1664. if (event.GetPhase() == EventPhase::Target)
  1665. {
  1666. switch (event.GetId())
  1667. {
  1668. case EventId::Mouseover: SetPseudoClass("hover", true); break;
  1669. case EventId::Mouseout: SetPseudoClass("hover", false); break;
  1670. case EventId::Focus:
  1671. SetPseudoClass("focus", true);
  1672. if (event.GetParameter("focus_visible", false))
  1673. SetPseudoClass("focus-visible", true);
  1674. break;
  1675. case EventId::Blur:
  1676. SetPseudoClass("focus", false);
  1677. SetPseudoClass("focus-visible", false);
  1678. break;
  1679. default: break;
  1680. }
  1681. }
  1682. }
  1683. const Style::ComputedValues& Element::GetComputedValues() const
  1684. {
  1685. return meta->computed_values;
  1686. }
  1687. void Element::GetRML(String& content)
  1688. {
  1689. // First we start the open tag, add the attributes then close the open tag.
  1690. // Then comes the children in order, then we add our close tag.
  1691. content += "<";
  1692. content += tag;
  1693. for (auto& pair : attributes)
  1694. {
  1695. const String& name = pair.first;
  1696. if (name == "style")
  1697. continue;
  1698. const Variant& variant = pair.second;
  1699. String value;
  1700. if (variant.GetInto(value))
  1701. {
  1702. content += ' ';
  1703. content += name;
  1704. content += "=\"";
  1705. content += value;
  1706. content += "\"";
  1707. }
  1708. }
  1709. const PropertyMap& local_properties = meta->style.GetLocalStyleProperties();
  1710. if (!local_properties.empty())
  1711. content += " style=\"";
  1712. for (const auto& pair : local_properties)
  1713. {
  1714. const PropertyId id = pair.first;
  1715. const Property& property = pair.second;
  1716. content += StyleSheetSpecification::GetPropertyName(id);
  1717. content += ": ";
  1718. content += StringUtilities::EncodeRml(property.ToString());
  1719. content += "; ";
  1720. }
  1721. if (!local_properties.empty())
  1722. content.back() = '\"';
  1723. if (HasChildNodes())
  1724. {
  1725. content += ">";
  1726. GetInnerRML(content);
  1727. content += "</";
  1728. content += tag;
  1729. content += ">";
  1730. }
  1731. else
  1732. {
  1733. content += " />";
  1734. }
  1735. }
  1736. void Element::SetOwnerDocument(ElementDocument* document)
  1737. {
  1738. if (owner_document && !document)
  1739. {
  1740. // We are detaching from the document and thereby also the context.
  1741. if (Context* context = owner_document->GetContext())
  1742. context->OnElementDetach(this);
  1743. }
  1744. // If this element is a document, then never change owner_document.
  1745. if (owner_document != this && owner_document != document)
  1746. {
  1747. owner_document = document;
  1748. for (ElementPtr& child : children)
  1749. child->SetOwnerDocument(document);
  1750. }
  1751. }
  1752. void Element::SetDataModel(DataModel* new_data_model)
  1753. {
  1754. RMLUI_ASSERTMSG(!data_model || !new_data_model, "We must either attach a new data model, or detach the old one.");
  1755. if (data_model == new_data_model)
  1756. return;
  1757. // stop descent if a nested data model is encountered
  1758. if (data_model && new_data_model && data_model != new_data_model)
  1759. return;
  1760. if (data_model)
  1761. data_model->OnElementRemove(this);
  1762. data_model = new_data_model;
  1763. if (data_model)
  1764. ElementUtilities::ApplyDataViewsControllers(this);
  1765. for (ElementPtr& child : children)
  1766. child->SetDataModel(new_data_model);
  1767. }
  1768. void Element::Release()
  1769. {
  1770. if (instancer)
  1771. instancer->ReleaseElement(this);
  1772. else
  1773. Log::Message(Log::LT_WARNING, "Leak detected: element %s not instanced via RmlUi Factory. Unable to release.", GetAddress().c_str());
  1774. }
  1775. void Element::SetParent(Element* _parent)
  1776. {
  1777. // Assumes we are already detached from the hierarchy or we are detaching now.
  1778. RMLUI_ASSERT(!parent || !_parent);
  1779. parent = _parent;
  1780. if (parent)
  1781. {
  1782. // We need to update our definition and make sure we inherit the properties of our new parent.
  1783. DirtyDefinition(DirtyNodes::Self);
  1784. meta->style.DirtyInheritedProperties();
  1785. }
  1786. // The transform state may require recalculation.
  1787. if (transform_state || (parent && parent->transform_state))
  1788. DirtyTransformState(true, true);
  1789. SetOwnerDocument(parent ? parent->GetOwnerDocument() : nullptr);
  1790. if (!parent)
  1791. {
  1792. if (data_model)
  1793. SetDataModel(nullptr);
  1794. }
  1795. else
  1796. {
  1797. auto it = attributes.find("data-model");
  1798. if (it == attributes.end())
  1799. {
  1800. SetDataModel(parent->data_model);
  1801. }
  1802. else if (Context* context = GetContext())
  1803. {
  1804. String name = it->second.Get<String>();
  1805. if (DataModel* model = context->GetDataModelPtr(name))
  1806. {
  1807. model->AttachModelRootElement(this);
  1808. SetDataModel(model);
  1809. }
  1810. else
  1811. Log::Message(Log::LT_ERROR, "Could not locate data model '%s' in element %s.", name.c_str(), GetAddress().c_str());
  1812. }
  1813. }
  1814. }
  1815. void Element::DirtyAbsoluteOffset()
  1816. {
  1817. if (!absolute_offset_dirty)
  1818. DirtyAbsoluteOffsetRecursive();
  1819. }
  1820. void Element::DirtyAbsoluteOffsetRecursive()
  1821. {
  1822. if (!absolute_offset_dirty)
  1823. {
  1824. absolute_offset_dirty = true;
  1825. if (transform_state)
  1826. DirtyTransformState(true, true);
  1827. }
  1828. for (size_t i = 0; i < children.size(); i++)
  1829. children[i]->DirtyAbsoluteOffsetRecursive();
  1830. }
  1831. void Element::UpdateRelativeOffsetFromInsetConstraints()
  1832. {
  1833. using namespace Style;
  1834. const auto& computed = meta->computed_values;
  1835. Position position_property = computed.position();
  1836. if (position_property == Position::Absolute || position_property == Position::Fixed)
  1837. {
  1838. if (offset_parent != nullptr)
  1839. {
  1840. const Box& parent_box = offset_parent->GetBox();
  1841. const Vector2f containing_block = parent_box.GetSize(BoxArea::Padding);
  1842. const Vector2f relative_offset_origin = GetBox().GetPosition(relative_offset_area);
  1843. // If the element is anchored left, then the position is offset by that resolved value.
  1844. if (computed.left().type != Left::Auto)
  1845. relative_offset_base.x = parent_box.GetEdge(BoxArea::Border, BoxEdge::Left) +
  1846. (ResolveValue(computed.left(), containing_block.x) + GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left)) + relative_offset_origin.x;
  1847. // If the element is anchored right, then the position is set first so the element's right-most edge
  1848. // (including margins) will render up against the containing box's right-most content edge, and then
  1849. // offset by the resolved value.
  1850. else if (computed.right().type != Right::Auto)
  1851. {
  1852. relative_offset_base.x = containing_block.x + parent_box.GetEdge(BoxArea::Border, BoxEdge::Left) -
  1853. (ResolveValue(computed.right(), containing_block.x) + GetBox().GetSize(BoxArea::Border).x +
  1854. GetBox().GetEdge(BoxArea::Margin, BoxEdge::Right)) +
  1855. relative_offset_origin.x;
  1856. }
  1857. // If the element is anchored top, then the position is offset by that resolved value.
  1858. if (computed.top().type != Top::Auto)
  1859. {
  1860. relative_offset_base.y = parent_box.GetEdge(BoxArea::Border, BoxEdge::Top) +
  1861. (ResolveValue(computed.top(), containing_block.y) + GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top)) + relative_offset_origin.y;
  1862. }
  1863. // If the element is anchored bottom, then the position is set first so the element's right-most edge
  1864. // (including margins) will render up against the containing box's right-most content edge, and then
  1865. // offset by the resolved value.
  1866. else if (computed.bottom().type != Bottom::Auto)
  1867. {
  1868. relative_offset_base.y = containing_block.y + parent_box.GetEdge(BoxArea::Border, BoxEdge::Top) -
  1869. (ResolveValue(computed.bottom(), containing_block.y) + GetBox().GetSize(BoxArea::Border).y +
  1870. GetBox().GetEdge(BoxArea::Margin, BoxEdge::Bottom)) +
  1871. relative_offset_origin.y;
  1872. }
  1873. }
  1874. }
  1875. else if (position_property == Position::Relative)
  1876. {
  1877. if (offset_parent != nullptr)
  1878. {
  1879. const Box& parent_box = offset_parent->GetBox();
  1880. Vector2f containing_block = parent_box.GetSize();
  1881. if (computed.left().type != Left::Auto)
  1882. relative_offset_position.x = ResolveValue(computed.left(), containing_block.x);
  1883. else if (computed.right().type != Right::Auto)
  1884. relative_offset_position.x = -1 * ResolveValue(computed.right(), containing_block.x);
  1885. else
  1886. relative_offset_position.x = 0;
  1887. if (computed.top().type != Top::Auto)
  1888. relative_offset_position.y = ResolveValue(computed.top(), containing_block.y);
  1889. else if (computed.bottom().type != Bottom::Auto)
  1890. relative_offset_position.y = -1 * ResolveValue(computed.bottom(), containing_block.y);
  1891. else
  1892. relative_offset_position.y = 0;
  1893. }
  1894. }
  1895. else
  1896. {
  1897. relative_offset_position.x = 0;
  1898. relative_offset_position.y = 0;
  1899. }
  1900. }
  1901. void Element::SetBaseline(float in_baseline)
  1902. {
  1903. baseline = in_baseline;
  1904. }
  1905. enum class RenderOrder {
  1906. StackNegative, // Local stacking context with z < 0.
  1907. Block,
  1908. TableColumnGroup,
  1909. TableColumn,
  1910. TableRowGroup,
  1911. TableRow,
  1912. TableCell,
  1913. Floating,
  1914. Inline,
  1915. Positioned, // Positioned element, or local stacking context with z == 0.
  1916. StackPositive, // Local stacking context with z > 0.
  1917. };
  1918. struct StackingContextChild {
  1919. Element* element = nullptr;
  1920. RenderOrder order = {};
  1921. };
  1922. static bool operator<(const StackingContextChild& lhs, const StackingContextChild& rhs)
  1923. {
  1924. if (int(lhs.order) == int(rhs.order))
  1925. return lhs.element->GetZIndex() < rhs.element->GetZIndex();
  1926. return int(lhs.order) < int(rhs.order);
  1927. }
  1928. // Treat all children in the range [index_begin, end) as if the parent created a new stacking context, by sorting them
  1929. // separately and then assigning their parent's paint order. However, positioned and descendants which create a new
  1930. // stacking context should be considered part of the parent stacking context. See CSS 2, Appendix E.
  1931. static void StackingContext_MakeAtomicRange(Vector<StackingContextChild>& stacking_children, size_t index_begin, RenderOrder parent_render_order)
  1932. {
  1933. std::stable_sort(stacking_children.begin() + index_begin, stacking_children.end());
  1934. for (auto it = stacking_children.begin() + index_begin; it != stacking_children.end(); ++it)
  1935. {
  1936. auto order = it->order;
  1937. if (order != RenderOrder::StackNegative && order != RenderOrder::Positioned && order != RenderOrder::StackPositive)
  1938. it->order = parent_render_order;
  1939. }
  1940. }
  1941. void Element::BuildLocalStackingContext()
  1942. {
  1943. stacking_context_dirty = false;
  1944. Vector<StackingContextChild> stacking_children;
  1945. AddChildrenToStackingContext(stacking_children);
  1946. std::stable_sort(stacking_children.begin(), stacking_children.end());
  1947. stacking_context.resize(stacking_children.size());
  1948. for (size_t i = 0; i < stacking_children.size(); i++)
  1949. stacking_context[i] = stacking_children[i].element;
  1950. }
  1951. void Element::AddChildrenToStackingContext(Vector<StackingContextChild>& stacking_children)
  1952. {
  1953. bool is_flex_container = (GetDisplay() == Style::Display::Flex);
  1954. const int num_children = (int)children.size();
  1955. for (int i = 0; i < num_children; ++i)
  1956. {
  1957. const bool is_non_dom_element = (i >= num_children - num_non_dom_children);
  1958. children[i]->AddToStackingContext(stacking_children, is_flex_container, is_non_dom_element);
  1959. }
  1960. }
  1961. void Element::AddToStackingContext(Vector<StackingContextChild>& stacking_children, bool is_flex_item, bool is_non_dom_element)
  1962. {
  1963. using Style::Display;
  1964. if (!IsVisible())
  1965. return;
  1966. const Display display = GetDisplay();
  1967. RenderOrder order = RenderOrder::Inline;
  1968. bool include_children = true;
  1969. bool render_as_atomic_unit = false;
  1970. if (local_stacking_context)
  1971. {
  1972. if (z_index > 0.f)
  1973. order = RenderOrder::StackPositive;
  1974. else if (z_index < 0.f)
  1975. order = RenderOrder::StackNegative;
  1976. else
  1977. order = RenderOrder::Positioned;
  1978. include_children = false;
  1979. }
  1980. else if (display == Display::TableRow || display == Display::TableRowGroup || display == Display::TableColumn ||
  1981. display == Display::TableColumnGroup)
  1982. {
  1983. // Handle internal display values taking priority over position and float.
  1984. switch (display)
  1985. {
  1986. case Display::TableRow: order = RenderOrder::TableRow; break;
  1987. case Display::TableRowGroup: order = RenderOrder::TableRowGroup; break;
  1988. case Display::TableColumn: order = RenderOrder::TableColumn; break;
  1989. case Display::TableColumnGroup: order = RenderOrder::TableColumnGroup; break;
  1990. default: break;
  1991. }
  1992. }
  1993. else if (GetPosition() != Style::Position::Static)
  1994. {
  1995. order = RenderOrder::Positioned;
  1996. render_as_atomic_unit = true;
  1997. }
  1998. else if (GetFloat() != Style::Float::None)
  1999. {
  2000. order = RenderOrder::Floating;
  2001. render_as_atomic_unit = true;
  2002. }
  2003. else
  2004. {
  2005. switch (display)
  2006. {
  2007. case Display::Block:
  2008. case Display::FlowRoot:
  2009. case Display::Table:
  2010. case Display::Flex:
  2011. order = RenderOrder::Block;
  2012. render_as_atomic_unit = (display == Display::Table || is_flex_item);
  2013. break;
  2014. case Display::Inline:
  2015. case Display::InlineBlock:
  2016. case Display::InlineFlex:
  2017. case Display::InlineTable:
  2018. order = RenderOrder::Inline;
  2019. render_as_atomic_unit = (display != Display::Inline || is_flex_item);
  2020. break;
  2021. case Display::TableCell:
  2022. order = RenderOrder::TableCell;
  2023. render_as_atomic_unit = true;
  2024. break;
  2025. case Display::TableRow:
  2026. case Display::TableRowGroup:
  2027. case Display::TableColumn:
  2028. case Display::TableColumnGroup:
  2029. case Display::None: RMLUI_ERROR; break; // Handled above.
  2030. }
  2031. }
  2032. if (is_non_dom_element)
  2033. render_as_atomic_unit = true;
  2034. stacking_children.push_back(StackingContextChild{this, order});
  2035. if (include_children && !children.empty())
  2036. {
  2037. const size_t index_child_begin = stacking_children.size();
  2038. AddChildrenToStackingContext(stacking_children);
  2039. if (render_as_atomic_unit)
  2040. StackingContext_MakeAtomicRange(stacking_children, index_child_begin, order);
  2041. }
  2042. }
  2043. void Element::DirtyStackingContext()
  2044. {
  2045. // Find the first ancestor that has a local stacking context, that is our stacking context parent.
  2046. Element* stacking_context_parent = this;
  2047. while (stacking_context_parent && !stacking_context_parent->local_stacking_context)
  2048. {
  2049. stacking_context_parent = stacking_context_parent->GetParentNode();
  2050. }
  2051. if (stacking_context_parent)
  2052. stacking_context_parent->stacking_context_dirty = true;
  2053. }
  2054. void Element::DirtyDefinition(DirtyNodes dirty_nodes)
  2055. {
  2056. switch (dirty_nodes)
  2057. {
  2058. case DirtyNodes::Self: dirty_definition = true; break;
  2059. case DirtyNodes::SelfAndSiblings:
  2060. dirty_definition = true;
  2061. if (parent)
  2062. parent->dirty_child_definitions = true;
  2063. break;
  2064. }
  2065. }
  2066. void Element::UpdateDefinition()
  2067. {
  2068. if (dirty_definition)
  2069. {
  2070. dirty_definition = false;
  2071. // Dirty definition implies all our descendent elements. Anything that can change the definition of this element can also change the
  2072. // definition of any descendants due to the presence of RCSS descendant or child combinators. In principle this also applies to sibling
  2073. // combinators, but those are handled during the DirtyDefinition call.
  2074. dirty_child_definitions = true;
  2075. GetStyle()->UpdateDefinition();
  2076. }
  2077. if (dirty_child_definitions)
  2078. {
  2079. dirty_child_definitions = false;
  2080. for (const ElementPtr& child : children)
  2081. child->dirty_definition = true;
  2082. }
  2083. }
  2084. bool Element::Animate(const String& property_name, const Property& target_value, float duration, Tween tween, int num_iterations,
  2085. bool alternate_direction, float delay, const Property* start_value)
  2086. {
  2087. bool result = false;
  2088. PropertyId property_id = StyleSheetSpecification::GetPropertyId(property_name);
  2089. auto it_animation = StartAnimation(property_id, start_value, num_iterations, alternate_direction, delay, false);
  2090. if (it_animation != animations.end())
  2091. {
  2092. result = it_animation->AddKey(duration, target_value, *this, tween, true);
  2093. if (!result)
  2094. animations.erase(it_animation);
  2095. }
  2096. return result;
  2097. }
  2098. bool Element::AddAnimationKey(const String& property_name, const Property& target_value, float duration, Tween tween)
  2099. {
  2100. ElementAnimation* animation = nullptr;
  2101. PropertyId property_id = StyleSheetSpecification::GetPropertyId(property_name);
  2102. for (auto& existing_animation : animations)
  2103. {
  2104. if (existing_animation.GetPropertyId() == property_id)
  2105. {
  2106. animation = &existing_animation;
  2107. break;
  2108. }
  2109. }
  2110. if (!animation)
  2111. return false;
  2112. bool result = animation->AddKey(animation->GetDuration() + duration, target_value, *this, tween, true);
  2113. return result;
  2114. }
  2115. ElementAnimationList::iterator Element::StartAnimation(PropertyId property_id, const Property* start_value, int num_iterations,
  2116. bool alternate_direction, float delay, bool initiated_by_animation_property)
  2117. {
  2118. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyId() == property_id; });
  2119. if (it != animations.end())
  2120. {
  2121. const bool allow_overwriting_animation = !initiated_by_animation_property;
  2122. if (!allow_overwriting_animation)
  2123. {
  2124. Log::Message(Log::LT_WARNING,
  2125. "Could not animate property '%s' on element: %s. "
  2126. "Please ensure that the property does not appear in multiple animations on the same element.",
  2127. StyleSheetSpecification::GetPropertyName(property_id).c_str(), GetAddress().c_str());
  2128. return it;
  2129. }
  2130. *it = ElementAnimation{};
  2131. }
  2132. else
  2133. {
  2134. animations.emplace_back();
  2135. it = animations.end() - 1;
  2136. }
  2137. Property value;
  2138. if (start_value)
  2139. {
  2140. value = *start_value;
  2141. if (!value.definition)
  2142. if (auto default_value = GetProperty(property_id))
  2143. value.definition = default_value->definition;
  2144. }
  2145. else if (auto default_value = GetProperty(property_id))
  2146. {
  2147. value = *default_value;
  2148. }
  2149. if (value.definition)
  2150. {
  2151. ElementAnimationOrigin origin = (initiated_by_animation_property ? ElementAnimationOrigin::Animation : ElementAnimationOrigin::User);
  2152. double start_time = Clock::GetElapsedTime() + (double)delay;
  2153. *it = ElementAnimation{property_id, origin, value, *this, start_time, 0.0f, num_iterations, alternate_direction};
  2154. }
  2155. if (!it->IsInitalized())
  2156. {
  2157. animations.erase(it);
  2158. it = animations.end();
  2159. }
  2160. return it;
  2161. }
  2162. bool Element::AddAnimationKeyTime(PropertyId property_id, const Property* target_value, float time, Tween tween)
  2163. {
  2164. if (!target_value)
  2165. target_value = meta->style.GetProperty(property_id);
  2166. if (!target_value)
  2167. return false;
  2168. ElementAnimation* animation = nullptr;
  2169. for (auto& existing_animation : animations)
  2170. {
  2171. if (existing_animation.GetPropertyId() == property_id)
  2172. {
  2173. animation = &existing_animation;
  2174. break;
  2175. }
  2176. }
  2177. if (!animation)
  2178. return false;
  2179. bool result = animation->AddKey(time, *target_value, *this, tween, true);
  2180. return result;
  2181. }
  2182. bool Element::StartTransition(const Transition& transition, const Property& start_value, const Property& target_value)
  2183. {
  2184. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyId() == transition.id; });
  2185. if (it != animations.end() && !it->IsTransition())
  2186. return false;
  2187. float duration = transition.duration;
  2188. double start_time = Clock::GetElapsedTime() + (double)transition.delay;
  2189. if (it == animations.end())
  2190. {
  2191. // Add transition as new animation
  2192. animations.push_back(ElementAnimation{transition.id, ElementAnimationOrigin::Transition, start_value, *this, start_time, 0.0f, 1, false});
  2193. it = (animations.end() - 1);
  2194. }
  2195. else
  2196. {
  2197. // Compress the duration based on the progress of the current animation
  2198. float f = it->GetInterpolationFactor();
  2199. f = 1.0f - (1.0f - f) * transition.reverse_adjustment_factor;
  2200. duration = duration * f;
  2201. // Replace old transition
  2202. *it = ElementAnimation{transition.id, ElementAnimationOrigin::Transition, start_value, *this, start_time, 0.0f, 1, false};
  2203. }
  2204. bool result = it->AddKey(duration, target_value, *this, transition.tween, true);
  2205. if (result)
  2206. SetProperty(transition.id, start_value);
  2207. else
  2208. animations.erase(it);
  2209. return result;
  2210. }
  2211. void Element::HandleTransitionProperty()
  2212. {
  2213. if (dirty_transition)
  2214. {
  2215. dirty_transition = false;
  2216. // Remove all transitions that are no longer in our local list
  2217. const TransitionList* keep_transitions = GetComputedValues().transition();
  2218. if (keep_transitions && keep_transitions->all)
  2219. return;
  2220. auto it_remove = animations.end();
  2221. if (!keep_transitions || keep_transitions->none)
  2222. {
  2223. // All transitions should be removed, but only touch the animations that originate from the 'transition' property.
  2224. // Move all animations to be erased in a valid state at the end of the list, and erase later.
  2225. it_remove = std::partition(animations.begin(), animations.end(),
  2226. [](const ElementAnimation& animation) -> bool { return !animation.IsTransition(); });
  2227. }
  2228. else
  2229. {
  2230. RMLUI_ASSERT(keep_transitions);
  2231. // Only remove the transitions that are not in our keep list.
  2232. const auto& keep_transitions_list = keep_transitions->transitions;
  2233. it_remove = std::partition(animations.begin(), animations.end(), [&keep_transitions_list](const ElementAnimation& animation) -> bool {
  2234. if (!animation.IsTransition())
  2235. return true;
  2236. auto it = std::find_if(keep_transitions_list.begin(), keep_transitions_list.end(),
  2237. [&animation](const Transition& transition) { return animation.GetPropertyId() == transition.id; });
  2238. bool keep_animation = (it != keep_transitions_list.end());
  2239. return keep_animation;
  2240. });
  2241. }
  2242. // We can decide what to do with cancelled transitions here.
  2243. for (auto it = it_remove; it != animations.end(); ++it)
  2244. RemoveProperty(it->GetPropertyId());
  2245. animations.erase(it_remove, animations.end());
  2246. }
  2247. }
  2248. void Element::HandleAnimationProperty()
  2249. {
  2250. // Note: We are effectively restarting all animations whenever 'dirty_animation' is set. Use the dirty flag with care,
  2251. // or find another approach which only updates actual "dirty" animations.
  2252. if (dirty_animation)
  2253. {
  2254. dirty_animation = false;
  2255. const AnimationList* animation_list = meta->computed_values.animation();
  2256. bool element_has_animations = ((animation_list && !animation_list->empty()) || !animations.empty());
  2257. const StyleSheet* stylesheet = nullptr;
  2258. if (element_has_animations)
  2259. stylesheet = GetStyleSheet();
  2260. if (stylesheet)
  2261. {
  2262. // Remove existing animations
  2263. {
  2264. // We only touch the animations that originate from the 'animation' property.
  2265. auto it_remove = std::partition(animations.begin(), animations.end(),
  2266. [](const ElementAnimation& animation) { return animation.GetOrigin() != ElementAnimationOrigin::Animation; });
  2267. // We can decide what to do with cancelled animations here.
  2268. for (auto it = it_remove; it != animations.end(); ++it)
  2269. RemoveProperty(it->GetPropertyId());
  2270. animations.erase(it_remove, animations.end());
  2271. }
  2272. // Start animations
  2273. if (animation_list)
  2274. {
  2275. for (const auto& animation : *animation_list)
  2276. {
  2277. const Keyframes* keyframes_ptr = stylesheet->GetKeyframes(animation.name);
  2278. if (keyframes_ptr && keyframes_ptr->blocks.size() >= 1 && !animation.paused)
  2279. {
  2280. auto& property_ids = keyframes_ptr->property_ids;
  2281. auto& blocks = keyframes_ptr->blocks;
  2282. bool has_from_key = (blocks[0].normalized_time == 0);
  2283. bool has_to_key = (blocks.back().normalized_time == 1);
  2284. // If the first key defines initial conditions for a given property, use those values, else, use this element's current
  2285. // values.
  2286. for (PropertyId id : property_ids)
  2287. StartAnimation(id, (has_from_key ? blocks[0].properties.GetProperty(id) : nullptr), animation.num_iterations,
  2288. animation.alternate, animation.delay, true);
  2289. // Add middle keys: Need to skip the first and last keys if they set the initial and end conditions, respectively.
  2290. for (int i = (has_from_key ? 1 : 0); i < (int)blocks.size() + (has_to_key ? -1 : 0); i++)
  2291. {
  2292. // Add properties of current key to animation
  2293. float time = blocks[i].normalized_time * animation.duration;
  2294. for (auto& property : blocks[i].properties.GetProperties())
  2295. AddAnimationKeyTime(property.first, &property.second, time, animation.tween);
  2296. }
  2297. // If the last key defines end conditions for a given property, use those values, else, use this element's current values.
  2298. float time = animation.duration;
  2299. for (PropertyId id : property_ids)
  2300. AddAnimationKeyTime(id, (has_to_key ? blocks.back().properties.GetProperty(id) : nullptr), time, animation.tween);
  2301. }
  2302. }
  2303. }
  2304. }
  2305. }
  2306. }
  2307. void Element::AdvanceAnimations()
  2308. {
  2309. if (!animations.empty())
  2310. {
  2311. double time = Clock::GetElapsedTime();
  2312. for (auto& animation : animations)
  2313. {
  2314. Property property = animation.UpdateAndGetProperty(time, *this);
  2315. if (property.unit != Unit::UNKNOWN)
  2316. SetProperty(animation.GetPropertyId(), property);
  2317. }
  2318. // Move all completed animations to the end of the list
  2319. auto it_completed =
  2320. std::partition(animations.begin(), animations.end(), [](const ElementAnimation& animation) { return !animation.IsComplete(); });
  2321. Vector<Dictionary> dictionary_list;
  2322. Vector<bool> is_transition;
  2323. dictionary_list.reserve(animations.end() - it_completed);
  2324. is_transition.reserve(animations.end() - it_completed);
  2325. for (auto it = it_completed; it != animations.end(); ++it)
  2326. {
  2327. const String& property_name = StyleSheetSpecification::GetPropertyName(it->GetPropertyId());
  2328. dictionary_list.emplace_back();
  2329. dictionary_list.back().emplace("property", Variant(property_name));
  2330. is_transition.push_back(it->IsTransition());
  2331. // Remove completed transition- and animation-initiated properties.
  2332. // Should behave like in HandleTransitionProperty() and HandleAnimationProperty() respectively.
  2333. if (it->GetOrigin() != ElementAnimationOrigin::User)
  2334. RemoveProperty(it->GetPropertyId());
  2335. }
  2336. // Need to erase elements before submitting event, as iterators might be invalidated when calling external code.
  2337. animations.erase(it_completed, animations.end());
  2338. for (size_t i = 0; i < dictionary_list.size(); i++)
  2339. DispatchEvent(is_transition[i] ? EventId::Transitionend : EventId::Animationend, dictionary_list[i]);
  2340. }
  2341. }
  2342. void Element::DirtyTransformState(bool perspective_dirty, bool transform_dirty)
  2343. {
  2344. dirty_perspective |= perspective_dirty;
  2345. dirty_transform |= transform_dirty;
  2346. }
  2347. void Element::UpdateTransformState()
  2348. {
  2349. if (!dirty_perspective && !dirty_transform)
  2350. return;
  2351. const ComputedValues& computed = meta->computed_values;
  2352. const Vector2f pos = GetAbsoluteOffset(BoxArea::Border);
  2353. const Vector2f size = GetBox().GetSize(BoxArea::Border);
  2354. bool perspective_or_transform_changed = false;
  2355. if (dirty_perspective)
  2356. {
  2357. // If perspective is set on this element, then it applies to our children. We just calculate it here,
  2358. // and let the children's transform update merge it with their transform.
  2359. bool had_perspective = (transform_state && transform_state->GetLocalPerspective());
  2360. float distance = computed.perspective();
  2361. Vector2f vanish = Vector2f(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f);
  2362. bool have_perspective = false;
  2363. if (distance > 0.0f)
  2364. {
  2365. have_perspective = true;
  2366. // Compute the vanishing point from the perspective origin
  2367. if (computed.perspective_origin_x().type == Style::PerspectiveOrigin::Percentage)
  2368. vanish.x = pos.x + computed.perspective_origin_x().value * 0.01f * size.x;
  2369. else
  2370. vanish.x = pos.x + computed.perspective_origin_x().value;
  2371. if (computed.perspective_origin_y().type == Style::PerspectiveOrigin::Percentage)
  2372. vanish.y = pos.y + computed.perspective_origin_y().value * 0.01f * size.y;
  2373. else
  2374. vanish.y = pos.y + computed.perspective_origin_y().value;
  2375. }
  2376. if (have_perspective)
  2377. {
  2378. // Equivalent to: Translate(x,y,0) * Perspective(distance) * Translate(-x,-y,0)
  2379. Matrix4f perspective = Matrix4f::FromRows( //
  2380. {1, 0, -vanish.x / distance, 0}, //
  2381. {0, 1, -vanish.y / distance, 0}, //
  2382. {0, 0, 1, 0}, //
  2383. {0, 0, -1 / distance, 1} //
  2384. );
  2385. if (!transform_state)
  2386. transform_state = MakeUnique<TransformState>();
  2387. perspective_or_transform_changed |= transform_state->SetLocalPerspective(&perspective);
  2388. }
  2389. else if (transform_state)
  2390. transform_state->SetLocalPerspective(nullptr);
  2391. perspective_or_transform_changed |= (have_perspective != had_perspective);
  2392. dirty_perspective = false;
  2393. }
  2394. if (dirty_transform)
  2395. {
  2396. // We want to find the accumulated transform given all our ancestors. It is assumed here that the parent transform is already updated,
  2397. // so that we only need to consider our local transform and combine it with our parent's transform and perspective matrices.
  2398. bool had_transform = (transform_state && transform_state->GetTransform());
  2399. bool have_transform = false;
  2400. Matrix4f transform = Matrix4f::Identity();
  2401. if (TransformPtr transform_ptr = computed.transform())
  2402. {
  2403. // First find the current element's transform
  2404. const int n = transform_ptr->GetNumPrimitives();
  2405. for (int i = 0; i < n; ++i)
  2406. {
  2407. const TransformPrimitive& primitive = transform_ptr->GetPrimitive(i);
  2408. Matrix4f matrix = TransformUtilities::ResolveTransform(primitive, *this);
  2409. transform *= matrix;
  2410. have_transform = true;
  2411. }
  2412. if (have_transform)
  2413. {
  2414. // Compute the transform origin
  2415. Vector3f transform_origin(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f, 0);
  2416. if (computed.transform_origin_x().type == Style::TransformOrigin::Percentage)
  2417. transform_origin.x = pos.x + computed.transform_origin_x().value * size.x * 0.01f;
  2418. else
  2419. transform_origin.x = pos.x + computed.transform_origin_x().value;
  2420. if (computed.transform_origin_y().type == Style::TransformOrigin::Percentage)
  2421. transform_origin.y = pos.y + computed.transform_origin_y().value * size.y * 0.01f;
  2422. else
  2423. transform_origin.y = pos.y + computed.transform_origin_y().value;
  2424. transform_origin.z = computed.transform_origin_z();
  2425. // Make the transformation apply relative to the transform origin
  2426. transform = Matrix4f::Translate(transform_origin) * transform * Matrix4f::Translate(-transform_origin);
  2427. }
  2428. // We may want to include the local offsets here, as suggested by the CSS specs, so that the local transform is applied after the offset I
  2429. // believe the motivation is. Then we would need to subtract the absolute zero-offsets during geometry submit whenever we have transforms.
  2430. }
  2431. if (parent && parent->transform_state)
  2432. {
  2433. // Apply the parent's local perspective and transform.
  2434. // @performance: If we have no local transform and no parent perspective, we can effectively just point to the parent transform instead of
  2435. // copying it.
  2436. const TransformState& parent_state = *parent->transform_state;
  2437. if (auto parent_perspective = parent_state.GetLocalPerspective())
  2438. {
  2439. transform = *parent_perspective * transform;
  2440. have_transform = true;
  2441. }
  2442. if (auto parent_transform = parent_state.GetTransform())
  2443. {
  2444. transform = *parent_transform * transform;
  2445. have_transform = true;
  2446. }
  2447. }
  2448. if (have_transform)
  2449. {
  2450. if (!transform_state)
  2451. transform_state = MakeUnique<TransformState>();
  2452. perspective_or_transform_changed |= transform_state->SetTransform(&transform);
  2453. }
  2454. else if (transform_state)
  2455. transform_state->SetTransform(nullptr);
  2456. perspective_or_transform_changed |= (had_transform != have_transform);
  2457. }
  2458. // A change in perspective or transform will require an update to children transforms as well.
  2459. if (perspective_or_transform_changed)
  2460. {
  2461. for (size_t i = 0; i < children.size(); i++)
  2462. children[i]->DirtyTransformState(false, true);
  2463. }
  2464. // No reason to keep the transform state around if transform and perspective have been removed.
  2465. if (transform_state && !transform_state->GetTransform() && !transform_state->GetLocalPerspective())
  2466. {
  2467. transform_state.reset();
  2468. }
  2469. }
  2470. void Element::OnStyleSheetChangeRecursive()
  2471. {
  2472. meta->effects.DirtyEffects();
  2473. OnStyleSheetChange();
  2474. // Now dirty all of our descendants.
  2475. const int num_children = GetNumChildren(true);
  2476. for (int i = 0; i < num_children; ++i)
  2477. GetChild(i)->OnStyleSheetChangeRecursive();
  2478. }
  2479. void Element::OnDpRatioChangeRecursive()
  2480. {
  2481. meta->effects.DirtyEffects();
  2482. GetStyle()->DirtyPropertiesWithUnits(Unit::DP_SCALABLE_LENGTH);
  2483. OnDpRatioChange();
  2484. // Now dirty all of our descendants.
  2485. const int num_children = GetNumChildren(true);
  2486. for (int i = 0; i < num_children; ++i)
  2487. GetChild(i)->OnDpRatioChangeRecursive();
  2488. }
  2489. void Element::DirtyFontFaceRecursive()
  2490. {
  2491. // Dirty the font size to force the element to update the face handle during the next Update(), and update any existing text geometry.
  2492. meta->style.DirtyProperty(PropertyId::FontSize);
  2493. meta->computed_values.font_face_handle(0);
  2494. const int num_children = GetNumChildren(true);
  2495. for (int i = 0; i < num_children; ++i)
  2496. GetChild(i)->DirtyFontFaceRecursive();
  2497. }
  2498. void Element::ClampScrollOffset()
  2499. {
  2500. const Vector2f new_scroll_offset = {
  2501. Math::Round(Math::Min(scroll_offset.x, GetScrollWidth() - GetClientWidth())),
  2502. Math::Round(Math::Min(scroll_offset.y, GetScrollHeight() - GetClientHeight())),
  2503. };
  2504. if (new_scroll_offset != scroll_offset)
  2505. {
  2506. scroll_offset = new_scroll_offset;
  2507. DirtyAbsoluteOffset();
  2508. }
  2509. // At this point the scrollbars have been resolved, both in terms of size and visibility. Update their properties
  2510. // now so that any visibility changes in particular are reflected immediately on the next render. Otherwise we risk
  2511. // that the scrollbars renders a frame late, since changes to scrollbars can happen during layouting.
  2512. meta->scroll.UpdateProperties();
  2513. }
  2514. void Element::CommitLayoutRecursive()
  2515. {
  2516. if (GetDisplay() == Style::Display::None)
  2517. return;
  2518. OnLayout();
  2519. GetLayoutNode()->ClearDirty();
  2520. // The size of the scrollable area might have changed, so clamp the scroll offset to avoid scrolling outside the
  2521. // scrollable area. During layouting, we might be changing the scrollable overflow area of the element several
  2522. // times, such as after enabling scrollbars. For this reason, we don't clamp the scroll offset during layouting, as
  2523. // that could inadvertently clamp it to a temporary size. Now that we know the final layout, including the size of
  2524. // each element's scrollable area, we can finally clamp the scroll offset.
  2525. ClampScrollOffset();
  2526. const int num_children = GetNumChildren();
  2527. for (int i = 0; i < num_children; ++i)
  2528. GetChild(i)->CommitLayoutRecursive();
  2529. }
  2530. } // namespace Rml