Element.cpp 88 KB

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