Element.cpp 86 KB

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