Element.cpp 82 KB

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