Element.cpp 90 KB

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