Element.cpp 74 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720
  1. /*
  2. * This source file is part of libRocket, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://www.librocket.com
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. *
  8. * Permission is hereby granted, free of charge, to any person obtaining a copy
  9. * of this software and associated documentation files (the "Software"), to deal
  10. * in the Software without restriction, including without limitation the rights
  11. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the Software is
  13. * furnished to do so, subject to the following conditions:
  14. *
  15. * The above copyright notice and this permission notice shall be included in
  16. * all copies or substantial portions of the Software.
  17. *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. * THE SOFTWARE.
  25. *
  26. */
  27. #include "precompiled.h"
  28. #include "../../Include/Rocket/Core/Element.h"
  29. #include "../../Include/Rocket/Core/Dictionary.h"
  30. #include "../../Include/Rocket/Core/TransformPrimitive.h"
  31. #include <algorithm>
  32. #include <limits>
  33. #include "Clock.h"
  34. #include "ComputeProperty.h"
  35. #include "ElementAnimation.h"
  36. #include "ElementBackground.h"
  37. #include "ElementBorder.h"
  38. #include "ElementDefinition.h"
  39. #include "ElementStyle.h"
  40. #include "EventDispatcher.h"
  41. #include "EventSpecification.h"
  42. #include "ElementDecoration.h"
  43. #include "FontFaceHandle.h"
  44. #include "LayoutEngine.h"
  45. #include "PluginRegistry.h"
  46. #include "Pool.h"
  47. #include "StyleSheetParser.h"
  48. #include "XMLParseTools.h"
  49. #include "../../Include/Rocket/Core/Core.h"
  50. namespace Rocket {
  51. namespace Core {
  52. /**
  53. STL function object for sorting elements by z-type (ie, float-types before general types, etc).
  54. @author Peter Curry
  55. */
  56. class ElementSortZOrder
  57. {
  58. public:
  59. bool operator()(const std::pair< Element*, float >& lhs, const std::pair< Element*, float >& rhs) const
  60. {
  61. return lhs.second < rhs.second;
  62. }
  63. };
  64. /**
  65. STL function object for sorting elements by z-index property.
  66. @author Peter Curry
  67. */
  68. class ElementSortZIndex
  69. {
  70. public:
  71. bool operator()(const Element* lhs, const Element* rhs) const
  72. {
  73. // Check the z-index.
  74. return lhs->GetZIndex() < rhs->GetZIndex();
  75. }
  76. };
  77. // Determines how many levels up in the hierarchy the OnChildAdd and OnChildRemove are called (starting at the child itself)
  78. static constexpr int ChildNotifyLevels = 2;
  79. struct ElementMetaChunk;
  80. static Pool< ElementMetaChunk > element_meta_chunk_pool(200, true);
  81. // Meta objects for element collected in a single struct to reduce memory allocations
  82. struct ElementMeta
  83. {
  84. ElementMeta(Element* el) : event_dispatcher(el), style(el), background(el), border(el), decoration(el), scroll(el) {}
  85. EventDispatcher event_dispatcher;
  86. ElementStyle style;
  87. ElementBackground background;
  88. ElementBorder border;
  89. ElementDecoration decoration;
  90. ElementScroll scroll;
  91. Style::ComputedValues computed_values;
  92. void* operator new(size_t size)
  93. {
  94. void* memory = element_meta_chunk_pool.AllocateObject();
  95. return memory;
  96. }
  97. void operator delete(void* chunk)
  98. {
  99. element_meta_chunk_pool.DeallocateObject((ElementMetaChunk*)chunk);
  100. }
  101. };
  102. struct alignas(ElementMeta) ElementMetaChunk
  103. {
  104. ElementMetaChunk() { memset(buffer, 0, size); }
  105. static constexpr size_t size = sizeof(ElementMeta);
  106. char buffer[size];
  107. };
  108. /// Constructs a new libRocket element.
  109. Element::Element(const String& tag) : tag(tag), relative_offset_base(0, 0), relative_offset_position(0, 0), absolute_offset(0, 0), scroll_offset(0, 0), content_offset(0, 0), content_box(0, 0),
  110. transform_state(), transform_state_perspective_dirty(true), transform_state_transform_dirty(true), transform_state_parent_transform_dirty(true), dirty_animation(false)
  111. {
  112. ROCKET_ASSERT(tag == ToLower(tag));
  113. parent = NULL;
  114. focus = NULL;
  115. instancer = NULL;
  116. owner_document = NULL;
  117. offset_fixed = false;
  118. offset_parent = NULL;
  119. offset_dirty = true;
  120. client_area = Box::PADDING;
  121. num_non_dom_children = 0;
  122. visible = true;
  123. z_index = 0;
  124. local_stacking_context = false;
  125. local_stacking_context_forced = false;
  126. stacking_context_dirty = false;
  127. structure_dirty = false;
  128. parent_structure_dirty = false;
  129. computed_values_are_default_initialized = true;
  130. box_dirty = false;
  131. font_face_handle = NULL;
  132. clipping_ignore_depth = 0;
  133. clipping_enabled = false;
  134. clipping_state_dirty = true;
  135. element_meta = new ElementMeta(this);
  136. event_dispatcher = &element_meta->event_dispatcher;
  137. style = &element_meta->style;
  138. background = &element_meta->background;
  139. border = &element_meta->border;
  140. decoration = &element_meta->decoration;
  141. scroll = &element_meta->scroll;
  142. }
  143. Element::~Element()
  144. {
  145. ROCKET_ASSERT(parent == NULL);
  146. PluginRegistry::NotifyElementDestroy(this);
  147. // Remove scrollbar elements before we delete the children!
  148. scroll->ClearScrollbars();
  149. // A simplified version of RemoveChild() for destruction.
  150. for (Element* child : children)
  151. {
  152. Element* child_ancestor = child;
  153. for (int i = 0; i <= ChildNotifyLevels && child_ancestor; i++, child_ancestor = child_ancestor->GetParentNode())
  154. child_ancestor->OnChildRemove(child);
  155. }
  156. if (deleted_children.empty())
  157. deleted_children = std::move(children);
  158. else
  159. deleted_children.insert(deleted_children.end(), children.begin(), children.end());
  160. children.clear();
  161. num_non_dom_children = 0;
  162. // Release all deleted children.
  163. ReleaseElements(deleted_children);
  164. delete element_meta;
  165. if (font_face_handle != NULL)
  166. font_face_handle->RemoveReference();
  167. if (instancer)
  168. instancer->RemoveReference();
  169. }
  170. void Element::Update(float dp_ratio)
  171. {
  172. ReleaseElements(deleted_children);
  173. OnUpdate();
  174. UpdateStructure();
  175. style->UpdateDefinition();
  176. scroll->Update();
  177. UpdateAnimation();
  178. AdvanceAnimations();
  179. if(style->AnyPropertiesDirty())
  180. {
  181. const ComputedValues* parent_values = nullptr;
  182. const ComputedValues* document_values = nullptr;
  183. if (parent)
  184. parent_values = &parent->GetComputedValues();
  185. if (auto doc = GetOwnerDocument())
  186. document_values = &doc->GetComputedValues();
  187. // Compute values and clear dirty properties
  188. auto dirty_properties = style->ComputeValues(element_meta->computed_values, parent_values, document_values, computed_values_are_default_initialized, dp_ratio);
  189. computed_values_are_default_initialized = false;
  190. // Computed values are just calculated and can safely be used in OnPropertyChange.
  191. // However, new properties set during this call will not be available until the next update loop.
  192. // Enable ROCKET_DEBUG to get a warning when this happens.
  193. if (dirty_properties.AllDirty())
  194. OnPropertyChange(StyleSheetSpecification::GetRegisteredProperties());
  195. else if(!dirty_properties.Empty())
  196. OnPropertyChange(dirty_properties.GetList());
  197. #ifdef ROCKET_DEBUG
  198. if (style->AnyPropertiesDirty())
  199. Log::Message(Log::LT_WARNING, "One or more properties were set during OnPropertyChange, these will only be evaluated on the next update call and should be avoided.");
  200. #endif
  201. }
  202. if (box_dirty)
  203. {
  204. box_dirty = false;
  205. OnResize();
  206. }
  207. UpdateTransformState();
  208. for (size_t i = 0; i < children.size(); i++)
  209. children[i]->Update(dp_ratio);
  210. }
  211. void Element::Render()
  212. {
  213. // Rebuild our stacking context if necessary.
  214. if (stacking_context_dirty)
  215. BuildLocalStackingContext();
  216. // Apply our transform
  217. ElementUtilities::ApplyTransform(*this);
  218. // Render all elements in our local stacking context that have a z-index beneath our local index of 0.
  219. size_t i = 0;
  220. for (; i < stacking_context.size() && stacking_context[i]->z_index < 0; ++i)
  221. stacking_context[i]->Render();
  222. // Set up the clipping region for this element.
  223. if (ElementUtilities::SetClippingRegion(this))
  224. {
  225. background->RenderBackground();
  226. border->RenderBorder();
  227. decoration->RenderDecorators();
  228. OnRender();
  229. }
  230. // Render the rest of the elements in the stacking context.
  231. for (; i < stacking_context.size(); ++i)
  232. stacking_context[i]->Render();
  233. // Unapply our transform
  234. ElementUtilities::UnapplyTransform(*this);
  235. }
  236. // Clones this element, returning a new, unparented element.
  237. Element* Element::Clone() const
  238. {
  239. Element* clone = NULL;
  240. if (instancer != NULL)
  241. {
  242. clone = instancer->InstanceElement(NULL, GetTagName(), attributes);
  243. if (clone != NULL)
  244. clone->SetInstancer(instancer);
  245. }
  246. else
  247. clone = Factory::InstanceElement(NULL, GetTagName(), GetTagName(), attributes);
  248. if (clone != NULL)
  249. {
  250. String inner_rml;
  251. GetInnerRML(inner_rml);
  252. clone->SetInnerRML(inner_rml);
  253. }
  254. return clone;
  255. }
  256. // Sets or removes a class on the element.
  257. void Element::SetClass(const String& class_name, bool activate)
  258. {
  259. style->SetClass(class_name, activate);
  260. }
  261. // Checks if a class is set on the element.
  262. bool Element::IsClassSet(const String& class_name) const
  263. {
  264. return style->IsClassSet(class_name);
  265. }
  266. // Specifies the entire list of classes for this element. This will replace any others specified.
  267. void Element::SetClassNames(const String& class_names)
  268. {
  269. SetAttribute("class", class_names);
  270. }
  271. /// Return the active class list
  272. String Element::GetClassNames() const
  273. {
  274. return style->GetClassNames();
  275. }
  276. // Returns the active style sheet for this element. This may be NULL.
  277. StyleSheet* Element::GetStyleSheet() const
  278. {
  279. return style->GetStyleSheet();
  280. }
  281. // Returns the element's definition, updating if necessary.
  282. const ElementDefinition* Element::GetDefinition()
  283. {
  284. return style->GetDefinition();
  285. }
  286. // Fills an String with the full address of this element.
  287. String Element::GetAddress(bool include_pseudo_classes) const
  288. {
  289. // Add the tag name onto the address.
  290. String address(tag);
  291. // Add the ID if we have one.
  292. if (!id.empty())
  293. {
  294. address += "#";
  295. address += id;
  296. }
  297. String classes = style->GetClassNames();
  298. if (!classes.empty())
  299. {
  300. classes = Replace(classes, ".", " ");
  301. address += ".";
  302. address += classes;
  303. }
  304. if (include_pseudo_classes)
  305. {
  306. const PseudoClassList& pseudo_classes = style->GetActivePseudoClasses();
  307. for (PseudoClassList::const_iterator i = pseudo_classes.begin(); i != pseudo_classes.end(); ++i)
  308. {
  309. address += ":";
  310. address += (*i);
  311. }
  312. }
  313. if (parent)
  314. {
  315. address += " < ";
  316. return address + parent->GetAddress(true);
  317. }
  318. else
  319. return address;
  320. }
  321. // Sets the position of this element, as a two-dimensional offset from another element.
  322. void Element::SetOffset(const Vector2f& offset, Element* _offset_parent, bool _offset_fixed)
  323. {
  324. _offset_fixed |= GetPosition() == Style::Position::Fixed;
  325. // If our offset has definitely changed, or any of our parenting has, then these are set and
  326. // updated based on our left / right / top / bottom properties.
  327. if (relative_offset_base != offset ||
  328. offset_parent != _offset_parent ||
  329. offset_fixed != _offset_fixed)
  330. {
  331. relative_offset_base = offset;
  332. offset_fixed = _offset_fixed;
  333. offset_parent = _offset_parent;
  334. UpdateOffset();
  335. DirtyOffset();
  336. }
  337. // Otherwise, our offset is updated in case left / right / top / bottom will have an impact on
  338. // our final position, and our children are dirtied if they do.
  339. else
  340. {
  341. Vector2f& old_base = relative_offset_base;
  342. Vector2f& old_position = relative_offset_position;
  343. UpdateOffset();
  344. if (old_base != relative_offset_base ||
  345. old_position != relative_offset_position)
  346. DirtyOffset();
  347. }
  348. }
  349. // Returns the position of the top-left corner of one of the areas of this element's primary box.
  350. Vector2f Element::GetRelativeOffset(Box::Area area)
  351. {
  352. return relative_offset_base + relative_offset_position + GetBox().GetPosition(area);
  353. }
  354. // Returns the position of the top-left corner of one of the areas of this element's primary box.
  355. Vector2f Element::GetAbsoluteOffset(Box::Area area)
  356. {
  357. if (offset_dirty)
  358. {
  359. offset_dirty = false;
  360. if (offset_parent != NULL)
  361. absolute_offset = offset_parent->GetAbsoluteOffset(Box::BORDER) + relative_offset_base + relative_offset_position;
  362. else
  363. absolute_offset = relative_offset_base + relative_offset_position;
  364. // Add any parent scrolling onto our position as well. Could cache this if required.
  365. if (!offset_fixed)
  366. {
  367. Element* scroll_parent = parent;
  368. while (scroll_parent != NULL)
  369. {
  370. absolute_offset -= (scroll_parent->scroll_offset + scroll_parent->content_offset);
  371. if (scroll_parent == offset_parent)
  372. break;
  373. else
  374. scroll_parent = scroll_parent->parent;
  375. }
  376. }
  377. }
  378. return absolute_offset + GetBox().GetPosition(area);
  379. }
  380. // Sets an alternate area to use as the client area.
  381. void Element::SetClientArea(Box::Area _client_area)
  382. {
  383. client_area = _client_area;
  384. }
  385. // Returns the area the element uses as its client area.
  386. Box::Area Element::GetClientArea() const
  387. {
  388. return client_area;
  389. }
  390. // Sets the dimensions of the element's internal content.
  391. void Element::SetContentBox(const Vector2f& _content_offset, const Vector2f& _content_box)
  392. {
  393. if (content_offset != _content_offset ||
  394. content_box != _content_box)
  395. {
  396. // Seems to be jittering a wee bit; might need to be looked at.
  397. scroll_offset.x += (content_offset.x - _content_offset.x);
  398. scroll_offset.y += (content_offset.y - _content_offset.y);
  399. content_offset = _content_offset;
  400. content_box = _content_box;
  401. scroll_offset.x = Math::Min(scroll_offset.x, GetScrollWidth() - GetClientWidth());
  402. scroll_offset.y = Math::Min(scroll_offset.y, GetScrollHeight() - GetClientHeight());
  403. DirtyOffset();
  404. }
  405. }
  406. // Sets the box describing the size of the element.
  407. void Element::SetBox(const Box& box)
  408. {
  409. if (box != main_box || additional_boxes.size() > 0)
  410. {
  411. main_box = box;
  412. additional_boxes.clear();
  413. box_dirty = true;
  414. background->DirtyBackground();
  415. border->DirtyBorder();
  416. decoration->DirtyDecorators(true);
  417. }
  418. }
  419. // Adds a box to the end of the list describing this element's geometry.
  420. void Element::AddBox(const Box& box)
  421. {
  422. additional_boxes.push_back(box);
  423. box_dirty = true;
  424. background->DirtyBackground();
  425. border->DirtyBorder();
  426. decoration->DirtyDecorators(true);
  427. }
  428. // Returns one of the boxes describing the size of the element.
  429. const Box& Element::GetBox()
  430. {
  431. return main_box;
  432. }
  433. // Returns one of the boxes describing the size of the element.
  434. const Box& Element::GetBox(int index)
  435. {
  436. if (index < 1)
  437. return main_box;
  438. int additional_box_index = index - 1;
  439. if (additional_box_index >= (int)additional_boxes.size())
  440. return main_box;
  441. return additional_boxes[additional_box_index];
  442. }
  443. // Returns the number of boxes making up this element's geometry.
  444. int Element::GetNumBoxes()
  445. {
  446. return 1 + (int)additional_boxes.size();
  447. }
  448. // Returns the baseline of the element, in pixels offset from the bottom of the element's content area.
  449. float Element::GetBaseline() const
  450. {
  451. return 0;
  452. }
  453. // Gets the intrinsic dimensions of this element, if it is of a type that has an inherent size.
  454. bool Element::GetIntrinsicDimensions(Vector2f& ROCKET_UNUSED_PARAMETER(dimensions))
  455. {
  456. ROCKET_UNUSED(dimensions);
  457. return false;
  458. }
  459. // Checks if a given point in screen coordinates lies within the bordered area of this element.
  460. bool Element::IsPointWithinElement(const Vector2f& point)
  461. {
  462. Vector2f position = GetAbsoluteOffset(Box::BORDER);
  463. for (int i = 0; i < GetNumBoxes(); ++i)
  464. {
  465. const Box& box = GetBox(i);
  466. Vector2f box_position = position + box.GetOffset();
  467. Vector2f box_dimensions = box.GetSize(Box::BORDER);
  468. if (point.x >= box_position.x &&
  469. point.x <= (box_position.x + box_dimensions.x) &&
  470. point.y >= box_position.y &&
  471. point.y <= (box_position.y + box_dimensions.y))
  472. {
  473. return true;
  474. }
  475. }
  476. return false;
  477. }
  478. // Returns the visibility of the element.
  479. bool Element::IsVisible() const
  480. {
  481. return visible;
  482. }
  483. // Returns the z-index of the element.
  484. float Element::GetZIndex() const
  485. {
  486. return z_index;
  487. }
  488. // Returns the element's font face handle.
  489. FontFaceHandle* Element::GetFontFaceHandle() const
  490. {
  491. return font_face_handle;
  492. }
  493. // Sets a local property override on the element.
  494. bool Element::SetProperty(const String& name, const String& value)
  495. {
  496. return style->SetProperty(name, value);
  497. }
  498. // Removes a local property override on the element.
  499. void Element::RemoveProperty(const String& name)
  500. {
  501. style->RemoveProperty(name);
  502. }
  503. // Sets a local property override on the element to a pre-parsed value.
  504. bool Element::SetProperty(const String& name, const Property& property)
  505. {
  506. return style->SetProperty(name, property);
  507. }
  508. // Returns one of this element's properties.
  509. const Property* Element::GetProperty(const String& name)
  510. {
  511. return style->GetProperty(name);
  512. }
  513. // Returns one of this element's properties.
  514. const Property* Element::GetLocalProperty(const String& name)
  515. {
  516. return style->GetLocalProperty(name);
  517. }
  518. const PropertyMap * Element::GetLocalProperties()
  519. {
  520. return style->GetLocalProperties();
  521. }
  522. // Resolves one of this element's style.
  523. float Element::ResolveLengthPercentage(const Property *property, float base_value)
  524. {
  525. return style->ResolveLengthPercentage(property, base_value);
  526. }
  527. Vector2f Element::GetContainingBlock()
  528. {
  529. Vector2f containing_block(0, 0);
  530. if (offset_parent != NULL)
  531. {
  532. using namespace Style;
  533. Position position_property = GetPosition();
  534. const Box& parent_box = offset_parent->GetBox();
  535. if (position_property == Position::Static || position_property == Position::Relative)
  536. {
  537. containing_block = parent_box.GetSize();
  538. }
  539. else if(position_property == Position::Absolute || position_property == Position::Fixed)
  540. {
  541. containing_block = parent_box.GetSize(Box::PADDING);
  542. }
  543. }
  544. return containing_block;
  545. }
  546. Style::Position Element::GetPosition()
  547. {
  548. return element_meta->computed_values.position;
  549. }
  550. Style::Float Element::GetFloat()
  551. {
  552. return element_meta->computed_values.float_;
  553. }
  554. Style::Display Element::GetDisplay()
  555. {
  556. return element_meta->computed_values.display;
  557. }
  558. float Element::GetLineHeight()
  559. {
  560. return element_meta->computed_values.line_height.value;
  561. }
  562. // Returns this element's TransformState
  563. const TransformState *Element::GetTransformState() const noexcept
  564. {
  565. return transform_state.get();
  566. }
  567. // Returns the TransformStates that are effective for this element.
  568. void Element::GetEffectiveTransformState(
  569. const TransformState **local_perspective,
  570. const TransformState **perspective,
  571. const TransformState **transform
  572. ) const noexcept
  573. {
  574. if (local_perspective)
  575. {
  576. *local_perspective = nullptr;
  577. }
  578. if (perspective)
  579. {
  580. *perspective = nullptr;
  581. }
  582. if (transform)
  583. {
  584. *transform = nullptr;
  585. }
  586. const Element *perspective_node = nullptr, *transform_node = nullptr;
  587. // Find the TransformState to use for unprojecting.
  588. if (transform_state.get() && transform_state->GetLocalPerspective(nullptr))
  589. {
  590. if (local_perspective)
  591. {
  592. *local_perspective = transform_state.get();
  593. }
  594. }
  595. else
  596. {
  597. const Element *node = nullptr;
  598. for (node = parent; node; node = node->parent)
  599. {
  600. if (node->transform_state.get() && node->transform_state->GetPerspective(nullptr))
  601. {
  602. if (perspective)
  603. {
  604. *perspective = node->transform_state.get();
  605. }
  606. perspective_node = node;
  607. break;
  608. }
  609. }
  610. }
  611. // Find the TransformState to use for transforming.
  612. const Element *node = nullptr;
  613. for (node = this; node; node = node->parent)
  614. {
  615. if (node->transform_state.get() && node->transform_state->GetRecursiveTransform(nullptr))
  616. {
  617. if (transform)
  618. {
  619. *transform = node->transform_state.get();
  620. }
  621. transform_node = node;
  622. break;
  623. }
  624. }
  625. }
  626. // Project a 2D point in pixel coordinates onto the element's plane.
  627. Vector2f Element::Project(const Vector2f& point) const noexcept
  628. {
  629. const Context *context = GetContext();
  630. if (!context)
  631. {
  632. return point;
  633. }
  634. const TransformState *local_perspective, *perspective, *transform;
  635. GetEffectiveTransformState(&local_perspective, &perspective, &transform);
  636. Vector2i view_pos(0, 0);
  637. Vector2i view_size = context->GetDimensions();
  638. // Compute the line segment for ray picking, one point on the near and one on the far plane.
  639. // These need to be in clip space coordinates ([-1; 1]³) so that we an unproject them.
  640. Vector3f line_segment[2] =
  641. {
  642. // When unprojected, the intersection point on the near plane
  643. Vector3f(
  644. (point.x - view_pos.x) / (0.5f * view_size.x) - 1.0f,
  645. (view_size.y - point.y - view_pos.y) / (0.5f * view_size.y) - 1.0f,
  646. -1
  647. ),
  648. // When unprojected, the intersection point on the far plane
  649. Vector3f(
  650. (point.x - view_pos.x) / (0.5f * view_size.x) - 1.0f,
  651. (view_size.y - point.y - view_pos.y) / (0.5f * view_size.y) - 1.0f,
  652. 1
  653. )
  654. };
  655. // Find the TransformState to use for unprojecting.
  656. if (local_perspective)
  657. {
  658. TransformState::LocalPerspective the_local_perspective;
  659. local_perspective->GetLocalPerspective(&the_local_perspective);
  660. line_segment[0] = the_local_perspective.Unproject(line_segment[0]);
  661. line_segment[1] = the_local_perspective.Unproject(line_segment[1]);
  662. }
  663. else if (perspective)
  664. {
  665. TransformState::Perspective the_perspective;
  666. perspective->GetPerspective(&the_perspective);
  667. line_segment[0] = the_perspective.Unproject(line_segment[0]);
  668. line_segment[1] = the_perspective.Unproject(line_segment[1]);
  669. }
  670. else
  671. {
  672. line_segment[0] = context->GetViewState().Unproject(line_segment[0]);
  673. line_segment[1] = context->GetViewState().Unproject(line_segment[1]);
  674. }
  675. // Compute three points on the context's corners to define the element's plane.
  676. // It may seem elegant to base this computation on the element's size, but
  677. // there are elements with zero length or height.
  678. Vector3f element_rect[3] =
  679. {
  680. // Top-left corner
  681. Vector3f(0, 0, 0),
  682. // Top-right corner
  683. Vector3f((float)view_size.x, 0, 0),
  684. // Bottom-left corner
  685. Vector3f(0, (float)view_size.y, 0)
  686. };
  687. // Transform by the correct matrix
  688. if (transform)
  689. {
  690. element_rect[0] = transform->Transform(element_rect[0]);
  691. element_rect[1] = transform->Transform(element_rect[1]);
  692. element_rect[2] = transform->Transform(element_rect[2]);
  693. }
  694. Vector3f u = line_segment[0] - line_segment[1];
  695. Vector3f v = element_rect[1] - element_rect[0];
  696. Vector3f w = element_rect[2] - element_rect[0];
  697. // Now compute the intersection point of the line segment and the element's rectangle.
  698. // This is based on the algorithm discussed at Wikipedia
  699. // (http://en.wikipedia.org/wiki/Line-plane_intersection).
  700. Matrix4f A = Matrix4f::FromColumns(
  701. Vector4f(u, 0),
  702. Vector4f(v, 0),
  703. Vector4f(w, 0),
  704. Vector4f(0, 0, 0, 1)
  705. );
  706. if (A.Invert())
  707. {
  708. Vector3f factors = A * (line_segment[0] - element_rect[0]);
  709. Vector3f intersection3d = element_rect[0] + v * factors[1] + w * factors[2];
  710. Vector3f projected;
  711. if (transform)
  712. {
  713. projected = transform->Untransform(intersection3d);
  714. //ROCKET_ASSERT(fabs(projected.z) < 0.0001);
  715. }
  716. else
  717. {
  718. // FIXME: Is this correct?
  719. projected = intersection3d;
  720. }
  721. return Vector2f(projected.x, projected.y);
  722. }
  723. else
  724. {
  725. // The line segment is parallel to the element's plane.
  726. // Although, mathematically, it could also lie within the plane
  727. // (yielding infinitely many intersection points), we still
  728. // return a value that's pretty sure to not match anything,
  729. // since this case has nothing to do with the user `picking'
  730. // anything.
  731. float inf = std::numeric_limits< float >::infinity();
  732. return Vector2f(-inf, -inf);
  733. }
  734. }
  735. ElementStyleIterator Element::IteratePropertiesBegin() const
  736. {
  737. return style->begin();
  738. }
  739. ElementStyleIterator Element::IteratePropertiesEnd() const
  740. {
  741. return style->end();
  742. }
  743. // Sets or removes a pseudo-class on the element.
  744. void Element::SetPseudoClass(const String& pseudo_class, bool activate)
  745. {
  746. style->SetPseudoClass(pseudo_class, activate);
  747. }
  748. // Checks if a specific pseudo-class has been set on the element.
  749. bool Element::IsPseudoClassSet(const String& pseudo_class) const
  750. {
  751. return style->IsPseudoClassSet(pseudo_class);
  752. }
  753. // Checks if a complete set of pseudo-classes are set on the element.
  754. bool Element::ArePseudoClassesSet(const PseudoClassList& pseudo_classes) const
  755. {
  756. for (PseudoClassList::const_iterator i = pseudo_classes.begin(); i != pseudo_classes.end(); ++i)
  757. {
  758. if (!IsPseudoClassSet(*i))
  759. return false;
  760. }
  761. return true;
  762. }
  763. // Gets a list of the current active pseudo classes
  764. const PseudoClassList& Element::GetActivePseudoClasses() const
  765. {
  766. return style->GetActivePseudoClasses();
  767. }
  768. /// Get the named attribute
  769. Variant* Element::GetAttribute(const String& name)
  770. {
  771. return GetIf(attributes, name);
  772. }
  773. // Checks if the element has a certain attribute.
  774. bool Element::HasAttribute(const String& name) const
  775. {
  776. return attributes.find(name) != attributes.end();
  777. }
  778. // Removes an attribute from the element
  779. void Element::RemoveAttribute(const String& name)
  780. {
  781. auto it = attributes.find(name);
  782. if (it != attributes.end())
  783. {
  784. attributes.erase(it);
  785. AttributeNameList changed_attributes;
  786. changed_attributes.insert(name);
  787. OnAttributeChange(changed_attributes);
  788. }
  789. }
  790. // Gets the outer most focus element down the tree from this node
  791. Element* Element::GetFocusLeafNode()
  792. {
  793. // If there isn't a focus, then we are the leaf.
  794. if (!focus)
  795. {
  796. return this;
  797. }
  798. // Recurse down the tree until we found the leaf focus element
  799. Element* focus_element = focus;
  800. while (focus_element->focus)
  801. focus_element = focus_element->focus;
  802. return focus_element;
  803. }
  804. // Returns the element's context.
  805. Context* Element::GetContext() const
  806. {
  807. ElementDocument* document = GetOwnerDocument();
  808. if (document != NULL)
  809. return document->GetContext();
  810. return NULL;
  811. }
  812. // Set a group of attributes
  813. void Element::SetAttributes(const ElementAttributes* _attributes)
  814. {
  815. attributes.reserve(attributes.size() + _attributes->size());
  816. for (auto& pair : *_attributes)
  817. attributes[pair.first] = pair.second;
  818. AttributeNameList changed_attributes;
  819. changed_attributes.reserve(_attributes->size());
  820. for (auto& pair : *_attributes)
  821. changed_attributes.insert(pair.first);
  822. OnAttributeChange(changed_attributes);
  823. }
  824. // Returns the number of attributes on the element.
  825. int Element::GetNumAttributes() const
  826. {
  827. return (int)attributes.size();
  828. }
  829. // Iterates over all decorators attached to the element.
  830. bool Element::IterateDecorators(int& index, PseudoClassList& pseudo_classes, String& name, Decorator*& decorator, DecoratorDataHandle& decorator_data)
  831. {
  832. return decoration->IterateDecorators(index, pseudo_classes, name, decorator, decorator_data);
  833. }
  834. // Gets the name of the element.
  835. const String& Element::GetTagName() const
  836. {
  837. return tag;
  838. }
  839. // Gets the ID of the element.
  840. const String& Element::GetId() const
  841. {
  842. return id;
  843. }
  844. // Sets the ID of the element.
  845. void Element::SetId(const String& _id)
  846. {
  847. SetAttribute("id", _id);
  848. }
  849. // Gets the horizontal offset from the context's left edge to element's left border edge.
  850. float Element::GetAbsoluteLeft()
  851. {
  852. return GetAbsoluteOffset(Box::BORDER).x;
  853. }
  854. // Gets the vertical offset from the context's top edge to element's top border edge.
  855. float Element::GetAbsoluteTop()
  856. {
  857. return GetAbsoluteOffset(Box::BORDER).y;
  858. }
  859. // Gets the width of the left border of an element.
  860. float Element::GetClientLeft()
  861. {
  862. return GetBox().GetPosition(client_area).x;
  863. }
  864. // Gets the height of the top border of an element.
  865. float Element::GetClientTop()
  866. {
  867. return GetBox().GetPosition(client_area).y;
  868. }
  869. // Gets the inner width of the element.
  870. float Element::GetClientWidth()
  871. {
  872. return GetBox().GetSize(client_area).x - scroll->GetScrollbarSize(ElementScroll::VERTICAL);
  873. }
  874. // Gets the inner height of the element.
  875. float Element::GetClientHeight()
  876. {
  877. return GetBox().GetSize(client_area).y - scroll->GetScrollbarSize(ElementScroll::HORIZONTAL);
  878. }
  879. // Returns the element from which all offset calculations are currently computed.
  880. Element* Element::GetOffsetParent()
  881. {
  882. return offset_parent;
  883. }
  884. // Gets the distance from this element's left border to its offset parent's left border.
  885. float Element::GetOffsetLeft()
  886. {
  887. return relative_offset_base.x + relative_offset_position.x;
  888. }
  889. // Gets the distance from this element's top border to its offset parent's top border.
  890. float Element::GetOffsetTop()
  891. {
  892. return relative_offset_base.y + relative_offset_position.y;
  893. }
  894. // Gets the width of the element, including the client area, padding, borders and scrollbars, but not margins.
  895. float Element::GetOffsetWidth()
  896. {
  897. return GetBox().GetSize(Box::BORDER).x;
  898. }
  899. // Gets the height of the element, including the client area, padding, borders and scrollbars, but not margins.
  900. float Element::GetOffsetHeight()
  901. {
  902. return GetBox().GetSize(Box::BORDER).y;
  903. }
  904. // Gets the left scroll offset of the element.
  905. float Element::GetScrollLeft()
  906. {
  907. return scroll_offset.x;
  908. }
  909. // Sets the left scroll offset of the element.
  910. void Element::SetScrollLeft(float scroll_left)
  911. {
  912. const float new_offset = Math::Clamp(scroll_left, 0.0f, GetScrollWidth() - GetClientWidth());
  913. if (new_offset != scroll_offset.x)
  914. {
  915. scroll_offset.x = new_offset;
  916. scroll->UpdateScrollbar(ElementScroll::HORIZONTAL);
  917. DirtyOffset();
  918. DispatchEvent(EventId::Scroll, Dictionary());
  919. }
  920. }
  921. // Gets the top scroll offset of the element.
  922. float Element::GetScrollTop()
  923. {
  924. return scroll_offset.y;
  925. }
  926. // Sets the top scroll offset of the element.
  927. void Element::SetScrollTop(float scroll_top)
  928. {
  929. const float new_offset = Math::Clamp(scroll_top, 0.0f, GetScrollHeight() - GetClientHeight());
  930. if(new_offset != scroll_offset.y)
  931. {
  932. scroll_offset.y = new_offset;
  933. scroll->UpdateScrollbar(ElementScroll::VERTICAL);
  934. DirtyOffset();
  935. DispatchEvent(EventId::Scroll, Dictionary());
  936. }
  937. }
  938. // Gets the width of the scrollable content of the element; it includes the element padding but not its margin.
  939. float Element::GetScrollWidth()
  940. {
  941. return Math::Max(content_box.x, GetClientWidth());
  942. }
  943. // Gets the height of the scrollable content of the element; it includes the element padding but not its margin.
  944. float Element::GetScrollHeight()
  945. {
  946. return Math::Max(content_box.y, GetClientHeight());
  947. }
  948. // Gets the object representing the declarations of an element's style attributes.
  949. ElementStyle* Element::GetStyle() const
  950. {
  951. return style;
  952. }
  953. // Gets the document this element belongs to.
  954. ElementDocument* Element::GetOwnerDocument() const
  955. {
  956. #ifdef ROCKET_DEBUG
  957. if (parent && !owner_document)
  958. {
  959. // Since we have a parent but no owner_document, then we must be a 'loose' element -- that is, constructed
  960. // outside of a document and not attached to a child of any element in the hierarchy of a document.
  961. // This check ensures that we didn't just forget to set the owner document.
  962. ROCKET_ASSERT(!parent->GetOwnerDocument());
  963. }
  964. #endif
  965. return owner_document;
  966. }
  967. // Gets this element's parent node.
  968. Element* Element::GetParentNode() const
  969. {
  970. return parent;
  971. }
  972. // Gets the element immediately following this one in the tree.
  973. Element* Element::GetNextSibling() const
  974. {
  975. if (parent == NULL)
  976. return NULL;
  977. for (size_t i = 0; i < parent->children.size() - (parent->num_non_dom_children + 1); i++)
  978. {
  979. if (parent->children[i] == this)
  980. return parent->children[i + 1];
  981. }
  982. return NULL;
  983. }
  984. // Gets the element immediately preceding this one in the tree.
  985. Element* Element::GetPreviousSibling() const
  986. {
  987. if (parent == NULL)
  988. return NULL;
  989. for (size_t i = 1; i < parent->children.size() - parent->num_non_dom_children; i++)
  990. {
  991. if (parent->children[i] == this)
  992. return parent->children[i - 1];
  993. }
  994. return NULL;
  995. }
  996. // Returns the first child of this element.
  997. Element* Element::GetFirstChild() const
  998. {
  999. if (GetNumChildren() > 0)
  1000. return children[0];
  1001. return NULL;
  1002. }
  1003. // Gets the last child of this element.
  1004. Element* Element::GetLastChild() const
  1005. {
  1006. if (GetNumChildren() > 0)
  1007. return *(children.end() - (num_non_dom_children + 1));
  1008. return NULL;
  1009. }
  1010. Element* Element::GetChild(int index) const
  1011. {
  1012. if (index < 0 || index >= (int) children.size())
  1013. return NULL;
  1014. return children[index];
  1015. }
  1016. int Element::GetNumChildren(bool include_non_dom_elements) const
  1017. {
  1018. return (int) children.size() - (include_non_dom_elements ? 0 : num_non_dom_children);
  1019. }
  1020. // Gets the markup and content of the element.
  1021. void Element::GetInnerRML(String& content) const
  1022. {
  1023. for (int i = 0; i < GetNumChildren(); i++)
  1024. {
  1025. children[i]->GetRML(content);
  1026. }
  1027. }
  1028. // Gets the markup and content of the element.
  1029. String Element::GetInnerRML() const {
  1030. String result;
  1031. GetInnerRML(result);
  1032. return result;
  1033. }
  1034. // Sets the markup and content of the element. All existing children will be replaced.
  1035. void Element::SetInnerRML(const String& rml)
  1036. {
  1037. // Remove all DOM children.
  1038. while ((int) children.size() > num_non_dom_children)
  1039. RemoveChild(children.front());
  1040. Factory::InstanceElementText(this, rml);
  1041. }
  1042. // Sets the current element as the focus object.
  1043. bool Element::Focus()
  1044. {
  1045. // Are we allowed focus?
  1046. Style::Focus focus_property = element_meta->computed_values.focus;
  1047. if (focus_property == Style::Focus::None)
  1048. return false;
  1049. // Ask our context if we can switch focus.
  1050. Context* context = GetContext();
  1051. if (context == NULL)
  1052. return false;
  1053. if (!context->OnFocusChange(this))
  1054. return false;
  1055. // Set this as the end of the focus chain.
  1056. focus = NULL;
  1057. // Update the focus chain up the hierarchy.
  1058. Element* element = this;
  1059. while (element->GetParentNode())
  1060. {
  1061. element->GetParentNode()->focus = element;
  1062. element = element->GetParentNode();
  1063. }
  1064. return true;
  1065. }
  1066. // Removes focus from from this element.
  1067. void Element::Blur()
  1068. {
  1069. if (parent)
  1070. {
  1071. Context* context = GetContext();
  1072. if (context == NULL)
  1073. return;
  1074. if (context->GetFocusElement() == this)
  1075. {
  1076. parent->Focus();
  1077. }
  1078. else if (parent->focus == this)
  1079. {
  1080. parent->focus = NULL;
  1081. }
  1082. }
  1083. }
  1084. // Fakes a mouse click on this element.
  1085. void Element::Click()
  1086. {
  1087. Context* context = GetContext();
  1088. if (context == NULL)
  1089. return;
  1090. context->GenerateClickEvent(this);
  1091. }
  1092. // Adds an event listener
  1093. void Element::AddEventListener(const String& event, EventListener* listener, bool in_capture_phase)
  1094. {
  1095. EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  1096. event_dispatcher->AttachEvent(id, listener, in_capture_phase);
  1097. }
  1098. // Removes an event listener from this element.
  1099. void Element::RemoveEventListener(const String& event, EventListener* listener, bool in_capture_phase)
  1100. {
  1101. EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  1102. event_dispatcher->DetachEvent(id, listener, in_capture_phase);
  1103. }
  1104. // Dispatches the specified event
  1105. bool Element::DispatchEvent(const String& type, const Dictionary& parameters)
  1106. {
  1107. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1108. return event_dispatcher->DispatchEvent(this, specification.id, type, parameters, specification.interruptible, specification.bubbles, specification.default_action_phase);
  1109. }
  1110. // Dispatches the specified event
  1111. bool Element::DispatchEvent(const String& type, const Dictionary& parameters, bool interruptible, bool bubbles)
  1112. {
  1113. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1114. return event_dispatcher->DispatchEvent(this, specification.id, type, parameters, interruptible, bubbles, specification.default_action_phase);
  1115. }
  1116. // Dispatches the specified event
  1117. bool Element::DispatchEvent(EventId id, const Dictionary& parameters)
  1118. {
  1119. const EventSpecification& specification = EventSpecificationInterface::Get(id);
  1120. return event_dispatcher->DispatchEvent(this, specification.id, specification.type, parameters, specification.interruptible, specification.bubbles, specification.default_action_phase);
  1121. }
  1122. // Scrolls the parent element's contents so that this element is visible.
  1123. void Element::ScrollIntoView(bool align_with_top)
  1124. {
  1125. Vector2f size(0, 0);
  1126. if (!align_with_top)
  1127. {
  1128. size.y = main_box.GetOffset().y +
  1129. main_box.GetSize(Box::BORDER).y;
  1130. }
  1131. Element* scroll_parent = parent;
  1132. while (scroll_parent != NULL)
  1133. {
  1134. Style::Overflow overflow_x_property = scroll_parent->GetComputedValues().overflow_x;
  1135. Style::Overflow overflow_y_property = scroll_parent->GetComputedValues().overflow_y;
  1136. if ((overflow_x_property != Style::Overflow::Visible &&
  1137. scroll_parent->GetScrollWidth() > scroll_parent->GetClientWidth()) ||
  1138. (overflow_y_property != Style::Overflow::Visible &&
  1139. scroll_parent->GetScrollHeight() > scroll_parent->GetClientHeight()))
  1140. {
  1141. Vector2f offset = scroll_parent->GetAbsoluteOffset(Box::BORDER) - GetAbsoluteOffset(Box::BORDER);
  1142. Vector2f scroll_offset(scroll_parent->GetScrollLeft(), scroll_parent->GetScrollTop());
  1143. scroll_offset -= offset;
  1144. scroll_offset.x += scroll_parent->GetClientLeft();
  1145. scroll_offset.y += scroll_parent->GetClientTop();
  1146. if (!align_with_top)
  1147. scroll_offset.y -= (scroll_parent->GetClientHeight() - size.y);
  1148. if (overflow_x_property != Style::Overflow::Visible)
  1149. scroll_parent->SetScrollLeft(scroll_offset.x);
  1150. if (overflow_y_property != Style::Overflow::Visible)
  1151. scroll_parent->SetScrollTop(scroll_offset.y);
  1152. }
  1153. scroll_parent = scroll_parent->GetParentNode();
  1154. }
  1155. }
  1156. // Appends a child to this element
  1157. void Element::AppendChild(Element* child, bool dom_element)
  1158. {
  1159. child->AddReference();
  1160. child->SetParent(this);
  1161. if (dom_element)
  1162. children.insert(children.end() - num_non_dom_children, child);
  1163. else
  1164. {
  1165. children.push_back(child);
  1166. num_non_dom_children++;
  1167. }
  1168. child->GetStyle()->DirtyDefinition();
  1169. Element* ancestor = child;
  1170. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1171. ancestor->OnChildAdd(child);
  1172. DirtyStackingContext();
  1173. DirtyStructure();
  1174. if (dom_element)
  1175. DirtyLayout();
  1176. }
  1177. // Adds a child to this element, directly after the adjacent element. Inherits
  1178. // the dom/non-dom status from the adjacent element.
  1179. void Element::InsertBefore(Element* child, Element* adjacent_element)
  1180. {
  1181. // Find the position in the list of children of the adjacent element. If
  1182. // it's NULL or we can't find it, then we insert it at the end of the dom
  1183. // children, as a dom element.
  1184. size_t child_index = 0;
  1185. bool found_child = false;
  1186. if (adjacent_element)
  1187. {
  1188. for (child_index = 0; child_index < children.size(); child_index++)
  1189. {
  1190. if (children[child_index] == adjacent_element)
  1191. {
  1192. found_child = true;
  1193. break;
  1194. }
  1195. }
  1196. }
  1197. if (found_child)
  1198. {
  1199. child->AddReference();
  1200. child->SetParent(this);
  1201. if ((int) child_index >= GetNumChildren())
  1202. num_non_dom_children++;
  1203. else
  1204. DirtyLayout();
  1205. children.insert(children.begin() + child_index, child);
  1206. child->GetStyle()->DirtyDefinition();
  1207. Element* ancestor = child;
  1208. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1209. ancestor->OnChildAdd(child);
  1210. DirtyStackingContext();
  1211. DirtyStructure();
  1212. }
  1213. else
  1214. {
  1215. AppendChild(child);
  1216. }
  1217. }
  1218. // Replaces the second node with the first node.
  1219. bool Element::ReplaceChild(Element* inserted_element, Element* replaced_element)
  1220. {
  1221. ElementList::iterator insertion_point = children.begin();
  1222. while (insertion_point != children.end() && *insertion_point != replaced_element)
  1223. {
  1224. ++insertion_point;
  1225. }
  1226. if (insertion_point == children.end())
  1227. {
  1228. AppendChild(inserted_element);
  1229. return false;
  1230. }
  1231. inserted_element->AddReference();
  1232. inserted_element->SetParent(this);
  1233. children.insert(insertion_point, inserted_element);
  1234. RemoveChild(replaced_element);
  1235. inserted_element->GetStyle()->DirtyDefinition();
  1236. Element* ancestor = inserted_element;
  1237. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1238. ancestor->OnChildAdd(inserted_element);
  1239. return true;
  1240. }
  1241. // Removes the specified child
  1242. bool Element::RemoveChild(Element* child)
  1243. {
  1244. size_t child_index = 0;
  1245. for (ElementList::iterator itr = children.begin(); itr != children.end(); ++itr)
  1246. {
  1247. // Add the element to the delete list
  1248. if ((*itr) == child)
  1249. {
  1250. // Inform the context of the element's pending removal (if we have a valid context).
  1251. Context* context = GetContext();
  1252. if (context)
  1253. context->OnElementRemove(child);
  1254. Element* ancestor = child;
  1255. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1256. ancestor->OnChildRemove(child);
  1257. if (child_index >= children.size() - num_non_dom_children)
  1258. num_non_dom_children--;
  1259. deleted_children.push_back(child);
  1260. children.erase(itr);
  1261. // Remove the child element as the focussed child of this element.
  1262. if (child == focus)
  1263. {
  1264. focus = NULL;
  1265. // If this child (or a descendant of this child) is the context's currently
  1266. // focussed element, set the focus to us instead.
  1267. Context* context = GetContext();
  1268. if (context != NULL)
  1269. {
  1270. Element* focus_element = context->GetFocusElement();
  1271. while (focus_element != NULL)
  1272. {
  1273. if (focus_element == child)
  1274. {
  1275. Focus();
  1276. break;
  1277. }
  1278. focus_element = focus_element->GetParentNode();
  1279. }
  1280. }
  1281. }
  1282. DirtyLayout();
  1283. DirtyStackingContext();
  1284. DirtyStructure();
  1285. return true;
  1286. }
  1287. child_index++;
  1288. }
  1289. return false;
  1290. }
  1291. bool Element::HasChildNodes() const
  1292. {
  1293. return (int) children.size() > num_non_dom_children;
  1294. }
  1295. Element* Element::GetElementById(const String& id)
  1296. {
  1297. // Check for special-case tokens.
  1298. if (id == "#self")
  1299. return this;
  1300. else if (id == "#document")
  1301. return GetOwnerDocument();
  1302. else if (id == "#parent")
  1303. return this->parent;
  1304. else
  1305. {
  1306. Element* search_root = GetOwnerDocument();
  1307. if (search_root == NULL)
  1308. search_root = this;
  1309. return ElementUtilities::GetElementById(search_root, id);
  1310. }
  1311. }
  1312. // Get all elements with the given tag.
  1313. void Element::GetElementsByTagName(ElementList& elements, const String& tag)
  1314. {
  1315. return ElementUtilities::GetElementsByTagName(elements, this, tag);
  1316. }
  1317. // Get all elements with the given class set on them.
  1318. void Element::GetElementsByClassName(ElementList& elements, const String& class_name)
  1319. {
  1320. return ElementUtilities::GetElementsByClassName(elements, this, class_name);
  1321. }
  1322. // Access the event dispatcher
  1323. EventDispatcher* Element::GetEventDispatcher() const
  1324. {
  1325. return event_dispatcher;
  1326. }
  1327. String Element::GetEventDispatcherSummary() const
  1328. {
  1329. return event_dispatcher->ToString();
  1330. }
  1331. // Access the element background.
  1332. ElementBackground* Element::GetElementBackground() const
  1333. {
  1334. return background;
  1335. }
  1336. // Access the element border.
  1337. ElementBorder* Element::GetElementBorder() const
  1338. {
  1339. return border;
  1340. }
  1341. // Access the element decorators
  1342. ElementDecoration* Element::GetElementDecoration() const
  1343. {
  1344. return decoration;
  1345. }
  1346. // Returns the element's scrollbar functionality.
  1347. ElementScroll* Element::GetElementScroll() const
  1348. {
  1349. return scroll;
  1350. }
  1351. int Element::GetClippingIgnoreDepth()
  1352. {
  1353. if (clipping_state_dirty)
  1354. {
  1355. IsClippingEnabled();
  1356. }
  1357. return clipping_ignore_depth;
  1358. }
  1359. bool Element::IsClippingEnabled()
  1360. {
  1361. if (clipping_state_dirty)
  1362. {
  1363. const auto& computed = GetComputedValues();
  1364. // Is clipping enabled for this element, yes unless both overlow properties are set to visible
  1365. clipping_enabled = computed.overflow_x != Style::Overflow::Visible
  1366. || computed.overflow_y != Style::Overflow::Visible;
  1367. // Get the clipping ignore depth from the clip property
  1368. clipping_ignore_depth = computed.clip.number;
  1369. clipping_state_dirty = false;
  1370. }
  1371. return clipping_enabled;
  1372. }
  1373. // Gets the render interface owned by this element's context.
  1374. RenderInterface* Element::GetRenderInterface()
  1375. {
  1376. Context* context = GetContext();
  1377. if (context != NULL)
  1378. return context->GetRenderInterface();
  1379. return Rocket::Core::GetRenderInterface();
  1380. }
  1381. void Element::SetInstancer(ElementInstancer* _instancer)
  1382. {
  1383. // Only record the first instancer being set as some instancers call other instancers to do their dirty work, in
  1384. // which case we don't want to update the lowest level instancer.
  1385. if (instancer == NULL)
  1386. {
  1387. instancer = _instancer;
  1388. instancer->AddReference();
  1389. }
  1390. }
  1391. // Forces the element to generate a local stacking context, regardless of the value of its z-index property.
  1392. void Element::ForceLocalStackingContext()
  1393. {
  1394. local_stacking_context_forced = true;
  1395. local_stacking_context = true;
  1396. DirtyStackingContext();
  1397. }
  1398. // Called during the update loop after children are rendered.
  1399. void Element::OnUpdate()
  1400. {
  1401. }
  1402. // Called during render after backgrounds, borders, decorators, but before children, are rendered.
  1403. void Element::OnRender()
  1404. {
  1405. }
  1406. void Element::OnResize()
  1407. {
  1408. }
  1409. // Called during a layout operation, when the element is being positioned and sized.
  1410. void Element::OnLayout()
  1411. {
  1412. }
  1413. // Called when attributes on the element are changed.
  1414. void Element::OnAttributeChange(const AttributeNameList& changed_attributes)
  1415. {
  1416. if (changed_attributes.find("id") != changed_attributes.end())
  1417. {
  1418. id = GetAttribute< String >("id", "");
  1419. style->DirtyDefinition();
  1420. }
  1421. if (changed_attributes.find("class") != changed_attributes.end())
  1422. {
  1423. style->SetClassNames(GetAttribute< String >("class", ""));
  1424. }
  1425. // Add any inline style declarations.
  1426. if (changed_attributes.find("style") != changed_attributes.end())
  1427. {
  1428. PropertyDictionary properties;
  1429. StyleSheetParser parser;
  1430. parser.ParseProperties(properties, GetAttribute< String >("style", ""));
  1431. Rocket::Core::PropertyMap property_map = properties.GetProperties();
  1432. for (Rocket::Core::PropertyMap::iterator i = property_map.begin(); i != property_map.end(); ++i)
  1433. {
  1434. SetProperty((*i).first, (*i).second);
  1435. }
  1436. }
  1437. }
  1438. // Called when properties on the element are changed.
  1439. void Element::OnPropertyChange(const PropertyNameList& changed_properties)
  1440. {
  1441. bool all_dirty = false;
  1442. {
  1443. auto& registered_properties = StyleSheetSpecification::GetRegisteredProperties();
  1444. if (&registered_properties == &changed_properties || registered_properties == changed_properties)
  1445. all_dirty = true;
  1446. }
  1447. if (!IsLayoutDirty())
  1448. {
  1449. if (all_dirty)
  1450. {
  1451. DirtyLayout();
  1452. }
  1453. else
  1454. {
  1455. // Force a relayout if any of the changed properties require it.
  1456. for (PropertyNameList::const_iterator i = changed_properties.begin(); i != changed_properties.end(); ++i)
  1457. {
  1458. const PropertyDefinition* property_definition = StyleSheetSpecification::GetProperty(*i);
  1459. if (property_definition)
  1460. {
  1461. if (property_definition->IsLayoutForced())
  1462. {
  1463. DirtyLayout();
  1464. break;
  1465. }
  1466. }
  1467. }
  1468. }
  1469. }
  1470. // Update the visibility.
  1471. if (all_dirty || changed_properties.find(VISIBILITY) != changed_properties.end() ||
  1472. changed_properties.find(DISPLAY) != changed_properties.end())
  1473. {
  1474. bool new_visibility = (element_meta->computed_values.display != Style::Display::None && element_meta->computed_values.visibility == Style::Visibility::Visible);
  1475. if (visible != new_visibility)
  1476. {
  1477. visible = new_visibility;
  1478. if (parent != NULL)
  1479. parent->DirtyStackingContext();
  1480. }
  1481. if (all_dirty ||
  1482. changed_properties.find(DISPLAY) != changed_properties.end())
  1483. {
  1484. if (parent != NULL)
  1485. parent->DirtyStructure();
  1486. }
  1487. }
  1488. // Fetch a new font face if it has been changed.
  1489. if (all_dirty ||
  1490. changed_properties.find(FONT_FAMILY) != changed_properties.end() ||
  1491. changed_properties.find(FONT_CHARSET) != changed_properties.end() ||
  1492. changed_properties.find(FONT_WEIGHT) != changed_properties.end() ||
  1493. changed_properties.find(FONT_STYLE) != changed_properties.end() ||
  1494. changed_properties.find(FONT_SIZE) != changed_properties.end())
  1495. {
  1496. // Fetch the new font face.
  1497. FontFaceHandle* new_font_face_handle = ElementUtilities::GetFontFaceHandle(element_meta->computed_values);
  1498. // If this is different from our current font face, then we've got to nuke
  1499. // all our characters and tell our parent that we have to be re-laid out.
  1500. if (new_font_face_handle != font_face_handle)
  1501. {
  1502. if (font_face_handle)
  1503. font_face_handle->RemoveReference();
  1504. font_face_handle = new_font_face_handle;
  1505. }
  1506. else if (new_font_face_handle != NULL)
  1507. new_font_face_handle->RemoveReference();
  1508. }
  1509. // Update the position.
  1510. if (all_dirty ||
  1511. changed_properties.find(LEFT) != changed_properties.end() ||
  1512. changed_properties.find(RIGHT) != changed_properties.end() ||
  1513. changed_properties.find(TOP) != changed_properties.end() ||
  1514. changed_properties.find(BOTTOM) != changed_properties.end())
  1515. {
  1516. // TODO: This should happen during/after layout, as the containing box is not properly defined yet
  1517. UpdateOffset();
  1518. DirtyOffset();
  1519. }
  1520. // Update the z-index.
  1521. if (all_dirty ||
  1522. changed_properties.find(Z_INDEX) != changed_properties.end())
  1523. {
  1524. Style::ZIndex z_index_property = element_meta->computed_values.z_index;
  1525. if (z_index_property.type == Style::ZIndex::Auto)
  1526. {
  1527. if (local_stacking_context &&
  1528. !local_stacking_context_forced)
  1529. {
  1530. // We're no longer acting as a stacking context.
  1531. local_stacking_context = false;
  1532. stacking_context_dirty = false;
  1533. stacking_context.clear();
  1534. }
  1535. // If our old z-index was not zero, then we must dirty our stacking context so we'll be re-indexed.
  1536. if (z_index != 0)
  1537. {
  1538. z_index = 0;
  1539. DirtyStackingContext();
  1540. }
  1541. }
  1542. else
  1543. {
  1544. float new_z_index = z_index_property.value;
  1545. if (new_z_index != z_index)
  1546. {
  1547. z_index = new_z_index;
  1548. if (parent != NULL)
  1549. parent->DirtyStackingContext();
  1550. }
  1551. if (!local_stacking_context)
  1552. {
  1553. local_stacking_context = true;
  1554. stacking_context_dirty = true;
  1555. }
  1556. }
  1557. }
  1558. // Dirty the background if it's changed.
  1559. if (all_dirty ||
  1560. changed_properties.find(BACKGROUND_COLOR) != changed_properties.end() ||
  1561. changed_properties.find(OPACITY) != changed_properties.end() ||
  1562. changed_properties.find(IMAGE_COLOR) != changed_properties.end()) {
  1563. background->DirtyBackground();
  1564. decoration->DirtyDecorators(true);
  1565. }
  1566. // Dirty the border if it's changed.
  1567. if (all_dirty ||
  1568. changed_properties.find(BORDER_TOP_WIDTH) != changed_properties.end() ||
  1569. changed_properties.find(BORDER_RIGHT_WIDTH) != changed_properties.end() ||
  1570. changed_properties.find(BORDER_BOTTOM_WIDTH) != changed_properties.end() ||
  1571. changed_properties.find(BORDER_LEFT_WIDTH) != changed_properties.end() ||
  1572. changed_properties.find(BORDER_TOP_COLOR) != changed_properties.end() ||
  1573. changed_properties.find(BORDER_RIGHT_COLOR) != changed_properties.end() ||
  1574. changed_properties.find(BORDER_BOTTOM_COLOR) != changed_properties.end() ||
  1575. changed_properties.find(BORDER_LEFT_COLOR) != changed_properties.end() ||
  1576. changed_properties.find(OPACITY) != changed_properties.end())
  1577. border->DirtyBorder();
  1578. // Check for clipping state changes
  1579. if (all_dirty ||
  1580. changed_properties.find(CLIP) != changed_properties.end() ||
  1581. changed_properties.find(OVERFLOW_X) != changed_properties.end() ||
  1582. changed_properties.find(OVERFLOW_Y) != changed_properties.end())
  1583. {
  1584. clipping_state_dirty = true;
  1585. }
  1586. // Check for `perspective' and `perspective-origin' changes
  1587. if (all_dirty ||
  1588. changed_properties.find(PERSPECTIVE) != changed_properties.end() ||
  1589. changed_properties.find(PERSPECTIVE_ORIGIN_X) != changed_properties.end() ||
  1590. changed_properties.find(PERSPECTIVE_ORIGIN_Y) != changed_properties.end())
  1591. {
  1592. DirtyTransformState(true, false, false);
  1593. }
  1594. // Check for `transform' and `transform-origin' changes
  1595. if (all_dirty ||
  1596. changed_properties.find(TRANSFORM) != changed_properties.end() ||
  1597. changed_properties.find(TRANSFORM_ORIGIN_X) != changed_properties.end() ||
  1598. changed_properties.find(TRANSFORM_ORIGIN_Y) != changed_properties.end() ||
  1599. changed_properties.find(TRANSFORM_ORIGIN_Z) != changed_properties.end())
  1600. {
  1601. DirtyTransformState(false, true, false);
  1602. }
  1603. // Check for `animation' changes
  1604. if (all_dirty || changed_properties.find(ANIMATION) != changed_properties.end())
  1605. {
  1606. DirtyAnimation();
  1607. }
  1608. }
  1609. // Called when a child node has been added somewhere in the hierarchy
  1610. void Element::OnChildAdd(Element* child)
  1611. {
  1612. }
  1613. // Called when a child node has been removed somewhere in the hierarchy
  1614. void Element::OnChildRemove(Element* child)
  1615. {
  1616. }
  1617. // Forces a re-layout of this element, and any other children required.
  1618. void Element::DirtyLayout()
  1619. {
  1620. Element* document = GetOwnerDocument();
  1621. if (document != NULL)
  1622. document->DirtyLayout();
  1623. }
  1624. // Forces a re-layout of this element, and any other children required.
  1625. bool Element::IsLayoutDirty()
  1626. {
  1627. Element* document = GetOwnerDocument();
  1628. if (document != NULL)
  1629. return document->IsLayoutDirty();
  1630. return false;
  1631. }
  1632. // Forces a reevaluation of applicable font effects.
  1633. void Element::DirtyFont()
  1634. {
  1635. for (size_t i = 0; i < children.size(); ++i)
  1636. children[i]->DirtyFont();
  1637. }
  1638. void Element::OnReferenceDeactivate()
  1639. {
  1640. if (instancer)
  1641. {
  1642. instancer->ReleaseElement(this);
  1643. }
  1644. else
  1645. {
  1646. // Hopefully we can just delete ourselves.
  1647. //delete this;
  1648. Log::Message(Log::LT_WARNING, "Leak detected: element %s not instanced via Rocket Factory. Unable to release.", GetAddress().c_str());
  1649. }
  1650. }
  1651. void Element::ProcessDefaultAction(Event& event)
  1652. {
  1653. if (event == EventId::Mousedown && IsPointWithinElement(Vector2f(event.GetParameter< float >("mouse_x", 0), event.GetParameter< float >("mouse_y", 0))) &&
  1654. event.GetParameter< int >("button", 0) == 0)
  1655. SetPseudoClass("active", true);
  1656. if (event == EventId::Mousescroll)
  1657. {
  1658. if (GetScrollHeight() > GetClientHeight())
  1659. {
  1660. Style::Overflow overflow_property = element_meta->computed_values.overflow_y;
  1661. if (overflow_property == Style::Overflow::Auto ||
  1662. overflow_property == Style::Overflow::Scroll)
  1663. {
  1664. // Stop the propagation if the current element has scrollbars.
  1665. // This prevents scrolling in parent elements, which is often unintended. If instead desired behavior is
  1666. // to scroll in parent elements when reaching top/bottom, move StopPropagation inside the next if statement.
  1667. event.StopPropagation();
  1668. const float wheel_delta = event.GetParameter< float >("wheel_delta", 0.f);
  1669. if ((wheel_delta < 0 && GetScrollTop() > 0) ||
  1670. (wheel_delta > 0 && GetScrollHeight() > GetScrollTop() + GetClientHeight()))
  1671. {
  1672. // Defined as three times the default line-height, multiplied by the dp ratio.
  1673. float default_scroll_length = 3.f * DefaultComputedValues.line_height.value;
  1674. if (const Context* context = GetContext())
  1675. default_scroll_length *= context->GetDensityIndependentPixelRatio();
  1676. SetScrollTop(GetScrollTop() + Math::RoundFloat(wheel_delta * default_scroll_length));
  1677. }
  1678. }
  1679. }
  1680. return;
  1681. }
  1682. if (event.GetPhase() == EventPhase::Target)
  1683. {
  1684. switch (event.GetId())
  1685. {
  1686. case EventId::Mouseover:
  1687. SetPseudoClass("hover", true);
  1688. break;
  1689. case EventId::Mouseout:
  1690. SetPseudoClass("hover", false);
  1691. break;
  1692. case EventId::Focus:
  1693. SetPseudoClass(FOCUS, true);
  1694. break;
  1695. case EventId::Blur:
  1696. SetPseudoClass(FOCUS, false);
  1697. break;
  1698. default:
  1699. break;
  1700. }
  1701. }
  1702. }
  1703. const Style::ComputedValues& Element::GetComputedValues() const
  1704. {
  1705. return element_meta->computed_values;
  1706. }
  1707. void Element::GetRML(String& content)
  1708. {
  1709. // First we start the open tag, add the attributes then close the open tag.
  1710. // Then comes the children in order, then we add our close tag.
  1711. content += "<";
  1712. content += tag;
  1713. for( auto& pair : attributes)
  1714. {
  1715. auto& name = pair.first;
  1716. auto& variant = pair.second;
  1717. String value;
  1718. if (variant.GetInto(value))
  1719. content += " " + name + "=\"" + value + "\"";
  1720. }
  1721. if (HasChildNodes())
  1722. {
  1723. content += ">";
  1724. GetInnerRML(content);
  1725. content += "</";
  1726. content += tag;
  1727. content += ">";
  1728. }
  1729. else
  1730. {
  1731. content += " />";
  1732. }
  1733. }
  1734. void Element::SetOwnerDocument(ElementDocument* document)
  1735. {
  1736. // If this element is a document, then never change owner_document. Otherwise, this can happen when attaching to the root element.
  1737. if(owner_document != document && owner_document != this)
  1738. {
  1739. owner_document = document;
  1740. for (Element* child : children)
  1741. child->SetOwnerDocument(document);
  1742. }
  1743. }
  1744. void Element::SetParent(Element* _parent)
  1745. {
  1746. // If there's an old parent, detach from it first.
  1747. if (parent &&
  1748. parent != _parent)
  1749. parent->RemoveChild(this);
  1750. parent = _parent;
  1751. SetOwnerDocument(parent ? parent->GetOwnerDocument() : nullptr);
  1752. }
  1753. void Element::ReleaseElements(ElementList& released_elements)
  1754. {
  1755. // Remove deleted children from this element.
  1756. while (!released_elements.empty())
  1757. {
  1758. Element* element = released_elements.back();
  1759. released_elements.pop_back();
  1760. // If this element has been added back into our list, then we remove our previous oustanding reference on it
  1761. // and continue.
  1762. if (std::find(children.begin(), children.end(), element) != children.end())
  1763. {
  1764. element->RemoveReference();
  1765. continue;
  1766. }
  1767. // Set the parent to NULL unless it's been reparented already.
  1768. if (element->GetParentNode() == this)
  1769. {
  1770. element->parent = nullptr;
  1771. element->SetOwnerDocument(nullptr);
  1772. }
  1773. element->RemoveReference();
  1774. }
  1775. }
  1776. void Element::DirtyOffset()
  1777. {
  1778. if(!offset_dirty)
  1779. {
  1780. offset_dirty = true;
  1781. if(transform_state)
  1782. DirtyTransformState(true, true, false);
  1783. // Not strictly true ... ?
  1784. for (size_t i = 0; i < children.size(); i++)
  1785. children[i]->DirtyOffset();
  1786. }
  1787. }
  1788. void Element::UpdateOffset()
  1789. {
  1790. using namespace Style;
  1791. const auto& computed = element_meta->computed_values;
  1792. Position position_property = computed.position;
  1793. if (position_property == Position::Absolute ||
  1794. position_property == Position::Fixed)
  1795. {
  1796. if (offset_parent != NULL)
  1797. {
  1798. const Box& parent_box = offset_parent->GetBox();
  1799. Vector2f containing_block = parent_box.GetSize(Box::PADDING);
  1800. // If the element is anchored left, then the position is offset by that resolved value.
  1801. if (computed.left.type != Left::Auto)
  1802. relative_offset_base.x = parent_box.GetEdge(Box::BORDER, Box::LEFT) + (ResolveValue(computed.left, containing_block.x) + GetBox().GetEdge(Box::MARGIN, Box::LEFT));
  1803. // If the element is anchored right, then the position is set first so the element's right-most edge
  1804. // (including margins) will render up against the containing box's right-most content edge, and then
  1805. // offset by the resolved value.
  1806. else if (computed.right.type != Right::Auto)
  1807. relative_offset_base.x = containing_block.x + parent_box.GetEdge(Box::BORDER, Box::LEFT) - (ResolveValue(computed.right, containing_block.x) + GetBox().GetSize(Box::BORDER).x + GetBox().GetEdge(Box::MARGIN, Box::RIGHT));
  1808. // If the element is anchored top, then the position is offset by that resolved value.
  1809. if (computed.top.type != Top::Auto)
  1810. relative_offset_base.y = parent_box.GetEdge(Box::BORDER, Box::TOP) + (ResolveValue(computed.top, containing_block.y) + GetBox().GetEdge(Box::MARGIN, Box::TOP));
  1811. // If the element is anchored bottom, then the position is set first so the element's right-most edge
  1812. // (including margins) will render up against the containing box's right-most content edge, and then
  1813. // offset by the resolved value.
  1814. else if (computed.bottom.type != Bottom::Auto)
  1815. relative_offset_base.y = containing_block.y + parent_box.GetEdge(Box::BORDER, Box::TOP) - (ResolveValue(computed.bottom, containing_block.y) + GetBox().GetSize(Box::BORDER).y + GetBox().GetEdge(Box::MARGIN, Box::BOTTOM));
  1816. }
  1817. }
  1818. else if (position_property == Position::Relative)
  1819. {
  1820. if (offset_parent != NULL)
  1821. {
  1822. const Box& parent_box = offset_parent->GetBox();
  1823. Vector2f containing_block = parent_box.GetSize();
  1824. if (computed.left.type != Left::Auto)
  1825. relative_offset_position.x = ResolveValue(computed.left, containing_block.x);
  1826. else if (computed.right.type != Right::Auto)
  1827. relative_offset_position.x = -1 * ResolveValue(computed.right, containing_block.x);
  1828. else
  1829. relative_offset_position.x = 0;
  1830. if (computed.top.type != Top::Auto)
  1831. relative_offset_position.y = ResolveValue(computed.top, containing_block.y);
  1832. else if (computed.bottom.type != Bottom::Auto)
  1833. relative_offset_position.y = -1 * ResolveValue(computed.bottom, containing_block.y);
  1834. else
  1835. relative_offset_position.y = 0;
  1836. }
  1837. }
  1838. else
  1839. {
  1840. relative_offset_position.x = 0;
  1841. relative_offset_position.y = 0;
  1842. }
  1843. }
  1844. void Element::BuildLocalStackingContext()
  1845. {
  1846. stacking_context_dirty = false;
  1847. stacking_context.clear();
  1848. BuildStackingContext(&stacking_context);
  1849. std::stable_sort(stacking_context.begin(), stacking_context.end(), ElementSortZIndex());
  1850. }
  1851. void Element::BuildStackingContext(ElementList* new_stacking_context)
  1852. {
  1853. // Build the list of ordered children. Our child list is sorted within the stacking context so stacked elements
  1854. // will render in the right order; ie, positioned elements will render on top of inline elements, which will render
  1855. // on top of floated elements, which will render on top of block elements.
  1856. std::vector< std::pair< Element*, float > > ordered_children;
  1857. for (size_t i = 0; i < children.size(); ++i)
  1858. {
  1859. Element* child = children[i];
  1860. if (!child->IsVisible())
  1861. continue;
  1862. std::pair< Element*, float > ordered_child;
  1863. ordered_child.first = child;
  1864. if (child->GetPosition() != Style::Position::Static)
  1865. ordered_child.second = 3;
  1866. else if (child->GetFloat() != Style::Float::None)
  1867. ordered_child.second = 1;
  1868. else if (child->GetDisplay() == Style::Display::Block)
  1869. ordered_child.second = 0;
  1870. else
  1871. ordered_child.second = 2;
  1872. ordered_children.push_back(ordered_child);
  1873. }
  1874. // Sort the list!
  1875. std::stable_sort(ordered_children.begin(), ordered_children.end(), ElementSortZOrder());
  1876. // Add the list of ordered children into the stacking context in order.
  1877. for (size_t i = 0; i < ordered_children.size(); ++i)
  1878. {
  1879. new_stacking_context->push_back(ordered_children[i].first);
  1880. if (!ordered_children[i].first->local_stacking_context)
  1881. ordered_children[i].first->BuildStackingContext(new_stacking_context);
  1882. }
  1883. }
  1884. void Element::DirtyStackingContext()
  1885. {
  1886. // The first ancestor of ours that doesn't have an automatic z-index is the ancestor that is establishing our local
  1887. // stacking context.
  1888. Element* stacking_context_parent = this;
  1889. while (stacking_context_parent != NULL &&
  1890. !stacking_context_parent->local_stacking_context)
  1891. stacking_context_parent = stacking_context_parent->GetParentNode();
  1892. if (stacking_context_parent != NULL)
  1893. stacking_context_parent->stacking_context_dirty = true;
  1894. }
  1895. void Element::DirtyStructure()
  1896. {
  1897. // Clear the cached owner document
  1898. structure_dirty = true;
  1899. }
  1900. void Element::DirtyParentStructure()
  1901. {
  1902. parent_structure_dirty = true;
  1903. }
  1904. void Element::UpdateStructure()
  1905. {
  1906. if (parent_structure_dirty)
  1907. {
  1908. // If children depend on structured selectors, they may need to be updated
  1909. const ElementDefinition* element_definition = GetStyle()->GetDefinition();
  1910. if (element_definition != NULL && element_definition->IsStructurallyVolatile())
  1911. {
  1912. GetStyle()->DirtyDefinition();
  1913. }
  1914. }
  1915. if (structure_dirty || parent_structure_dirty)
  1916. {
  1917. for (size_t i = 0; i < children.size(); ++i)
  1918. children[i]->DirtyParentStructure();
  1919. structure_dirty = false;
  1920. parent_structure_dirty = false;
  1921. }
  1922. }
  1923. bool Element::Animate(const String & property_name, const Property & target_value, float duration, Tween tween, int num_iterations, bool alternate_direction, float delay, const Property* start_value)
  1924. {
  1925. bool result = false;
  1926. auto it_animation = StartAnimation(property_name, start_value, num_iterations, alternate_direction, delay);
  1927. if (it_animation != animations.end())
  1928. {
  1929. result = it_animation->AddKey(duration, target_value, *this, tween, true);
  1930. if (!result)
  1931. animations.erase(it_animation);
  1932. }
  1933. return result;
  1934. }
  1935. bool Element::AddAnimationKey(const String & property_name, const Property & target_value, float duration, Tween tween)
  1936. {
  1937. ElementAnimation* animation = nullptr;
  1938. for (auto& existing_animation : animations) {
  1939. if (existing_animation.GetPropertyName() == property_name) {
  1940. animation = &existing_animation;
  1941. break;
  1942. }
  1943. }
  1944. if (!animation)
  1945. return false;
  1946. bool result = animation->AddKey(animation->GetDuration() + duration, target_value, *this, tween, true);
  1947. return result;
  1948. }
  1949. ElementAnimationList::iterator Element::StartAnimation(const String & property_name, const Property* start_value, int num_iterations, bool alternate_direction, float delay)
  1950. {
  1951. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyName() == property_name; });
  1952. if (it == animations.end())
  1953. {
  1954. animations.emplace_back();
  1955. it = animations.end() - 1;
  1956. }
  1957. Property value;
  1958. if (start_value)
  1959. {
  1960. value = *start_value;
  1961. if (!value.definition)
  1962. if(auto default_value = GetProperty(property_name))
  1963. value.definition = default_value->definition;
  1964. }
  1965. else if (auto default_value = GetProperty(property_name))
  1966. {
  1967. value = *default_value;
  1968. }
  1969. if (value.definition)
  1970. {
  1971. double start_time = Clock::GetElapsedTime() + (double)delay;
  1972. *it = ElementAnimation{ property_name, value, start_time, 0.0f, num_iterations, alternate_direction, false };
  1973. }
  1974. else
  1975. {
  1976. animations.erase(it);
  1977. it = animations.end();
  1978. }
  1979. return it;
  1980. }
  1981. bool Element::AddAnimationKeyTime(const String & property_name, const Property* target_value, float time, Tween tween)
  1982. {
  1983. if (!target_value)
  1984. target_value = GetProperty(property_name);
  1985. if (!target_value)
  1986. return false;
  1987. ElementAnimation* animation = nullptr;
  1988. for (auto& existing_animation : animations) {
  1989. if (existing_animation.GetPropertyName() == property_name) {
  1990. animation = &existing_animation;
  1991. break;
  1992. }
  1993. }
  1994. if (!animation)
  1995. return false;
  1996. bool result = animation->AddKey(time, *target_value, *this, tween, true);
  1997. return result;
  1998. }
  1999. bool Element::StartTransition(const Transition & transition, const Property& start_value, const Property & target_value)
  2000. {
  2001. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyName() == transition.name; });
  2002. if (it != animations.end() && !it->IsTransition())
  2003. return false;
  2004. float duration = transition.duration;
  2005. double start_time = Clock::GetElapsedTime() + (double)transition.delay;
  2006. if (it == animations.end())
  2007. {
  2008. // Add transition as new animation
  2009. animations.push_back(
  2010. ElementAnimation{ transition.name, start_value, start_time, 0.0f, 1, false, true }
  2011. );
  2012. it = (animations.end() - 1);
  2013. }
  2014. else
  2015. {
  2016. // Compress the duration based on the progress of the current animation
  2017. float f = it->GetInterpolationFactor();
  2018. f = 1.0f - (1.0f - f)*transition.reverse_adjustment_factor;
  2019. duration = duration * f;
  2020. // Replace old transition
  2021. *it = ElementAnimation{ transition.name, start_value, start_time, 0.0f, 1, false, true };
  2022. }
  2023. bool result = it->AddKey(duration, target_value, *this, transition.tween, true);
  2024. if (result)
  2025. SetProperty(transition.name, start_value);
  2026. else
  2027. animations.erase(it);
  2028. return result;
  2029. }
  2030. void Element::DirtyAnimation()
  2031. {
  2032. dirty_animation = true;
  2033. }
  2034. void Element::UpdateAnimation()
  2035. {
  2036. if (dirty_animation)
  2037. {
  2038. const auto& animation_list = element_meta->computed_values.animation;
  2039. StyleSheet* stylesheet = nullptr;
  2040. if (!animation_list.empty() && (stylesheet = GetStyleSheet()))
  2041. {
  2042. for (auto& animation : animation_list)
  2043. {
  2044. Keyframes* keyframes_ptr = stylesheet->GetKeyframes(animation.name);
  2045. if (keyframes_ptr && keyframes_ptr->blocks.size() >= 1 && !animation.paused)
  2046. {
  2047. auto& property_names = keyframes_ptr->property_names;
  2048. auto& blocks = keyframes_ptr->blocks;
  2049. bool has_from_key = (blocks[0].normalized_time == 0);
  2050. bool has_to_key = (blocks.back().normalized_time == 1);
  2051. // If the first key defines initial conditions for a given property, use those values, else, use this element's current values.
  2052. for (auto& property : property_names)
  2053. StartAnimation(property, (has_from_key ? blocks[0].properties.GetProperty(property) : nullptr), animation.num_iterations, animation.alternate, animation.delay);
  2054. // Need to skip the first and last keys if they set the initial and end conditions, respectively.
  2055. for (int i = (has_from_key ? 1 : 0); i < (int)blocks.size() + (has_to_key ? -1 : 0); i++)
  2056. {
  2057. // Add properties of current key to animation
  2058. float time = blocks[i].normalized_time * animation.duration;
  2059. for (auto& property : blocks[i].properties.GetProperties())
  2060. AddAnimationKeyTime(property.first, &property.second, time, animation.tween);
  2061. }
  2062. // If the last key defines end conditions for a given property, use those values, else, use this element's current values.
  2063. float time = animation.duration;
  2064. for (auto& property : property_names)
  2065. AddAnimationKeyTime(property, (has_to_key ? blocks.back().properties.GetProperty(property) : nullptr), time, animation.tween);
  2066. }
  2067. }
  2068. }
  2069. dirty_animation = false;
  2070. }
  2071. }
  2072. void Element::AdvanceAnimations()
  2073. {
  2074. if (!animations.empty())
  2075. {
  2076. double time = Clock::GetElapsedTime();
  2077. for (auto& animation : animations)
  2078. {
  2079. Property property = animation.UpdateAndGetProperty(time, *this);
  2080. if (property.unit != Property::UNKNOWN)
  2081. SetProperty(animation.GetPropertyName(), property);
  2082. }
  2083. auto it_completed = std::remove_if(animations.begin(), animations.end(), [](const ElementAnimation& animation) { return animation.IsComplete(); });
  2084. std::vector<Dictionary> dictionary_list;
  2085. std::vector<bool> is_transition;
  2086. dictionary_list.reserve(animations.end() - it_completed);
  2087. is_transition.reserve(animations.end() - it_completed);
  2088. for (auto it = it_completed; it != animations.end(); ++it)
  2089. {
  2090. dictionary_list.emplace_back();
  2091. dictionary_list.back().emplace("property", it->GetPropertyName());
  2092. is_transition.push_back(it->IsTransition());
  2093. }
  2094. // Need to erase elements before submitting event, as iterators might be invalidated when calling external code.
  2095. animations.erase(it_completed, animations.end());
  2096. for (size_t i = 0; i < dictionary_list.size(); i++)
  2097. DispatchEvent(is_transition[i] ? EventId::Transitionend : EventId::Animationend, dictionary_list[i]);
  2098. }
  2099. }
  2100. void Element::DirtyTransformState(bool perspective_changed, bool transform_changed, bool parent_transform_changed)
  2101. {
  2102. for (size_t i = 0; i < children.size(); ++i)
  2103. {
  2104. children[i]->DirtyTransformState(false, false, transform_changed || parent_transform_changed);
  2105. }
  2106. if (perspective_changed)
  2107. {
  2108. this->transform_state_perspective_dirty = true;
  2109. }
  2110. if (transform_changed)
  2111. {
  2112. this->transform_state_transform_dirty = true;
  2113. }
  2114. if (parent_transform_changed)
  2115. {
  2116. this->transform_state_parent_transform_dirty = true;
  2117. }
  2118. }
  2119. void Element::UpdateTransformState()
  2120. {
  2121. if (!(transform_state_perspective_dirty || transform_state_transform_dirty || transform_state_parent_transform_dirty))
  2122. {
  2123. return;
  2124. }
  2125. const ComputedValues& computed = element_meta->computed_values;
  2126. if (!computed.transform && computed.perspective <= 0)
  2127. {
  2128. transform_state.reset();
  2129. transform_state_perspective_dirty = false;
  2130. transform_state_transform_dirty = false;
  2131. transform_state_parent_transform_dirty = false;
  2132. return;
  2133. }
  2134. if(transform_state_perspective_dirty || transform_state_transform_dirty)
  2135. {
  2136. Context *context = GetContext();
  2137. Vector2f pos = GetAbsoluteOffset(Box::BORDER);
  2138. Vector2f size = GetBox().GetSize(Box::BORDER);
  2139. if (transform_state_perspective_dirty)
  2140. {
  2141. bool have_perspective = false;
  2142. TransformState::Perspective perspective_value;
  2143. perspective_value.vanish = Vector2f(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f);
  2144. if (computed.perspective > 0.0f)
  2145. {
  2146. have_perspective = true;
  2147. // Compute the perspective value
  2148. perspective_value.distance = computed.perspective;
  2149. // Compute the perspective origin, if necessary
  2150. if (computed.perspective_origin_x.type == Style::PerspectiveOrigin::Percentage)
  2151. perspective_value.vanish.x = pos.x + computed.perspective_origin_x.value * 0.01f * size.x;
  2152. else
  2153. perspective_value.vanish.x = pos.x + computed.perspective_origin_x.value;
  2154. if (computed.perspective_origin_y.type == Style::PerspectiveOrigin::Percentage)
  2155. perspective_value.vanish.y = pos.y + computed.perspective_origin_y.value * 0.01f * size.y;
  2156. else
  2157. perspective_value.vanish.y = pos.y + computed.perspective_origin_y.value;
  2158. }
  2159. if (have_perspective && context)
  2160. {
  2161. if (!transform_state)
  2162. transform_state.reset(new TransformState);
  2163. perspective_value.view_size = context->GetDimensions();
  2164. transform_state->SetPerspective(&perspective_value);
  2165. }
  2166. else if (transform_state)
  2167. {
  2168. transform_state->SetPerspective(nullptr);
  2169. }
  2170. transform_state_perspective_dirty = false;
  2171. }
  2172. if (transform_state_transform_dirty)
  2173. {
  2174. bool have_local_perspective = false;
  2175. TransformState::LocalPerspective local_perspective;
  2176. bool have_transform = false;
  2177. Matrix4f transform_value = Matrix4f::Identity();
  2178. Vector3f transform_origin(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f, 0);
  2179. if (computed.transform)
  2180. {
  2181. int n = computed.transform->GetNumPrimitives();
  2182. for (int i = 0; i < n; ++i)
  2183. {
  2184. const Transforms::Primitive &primitive = computed.transform->GetPrimitive(i);
  2185. if (primitive.ResolvePerspective(local_perspective.distance, *this))
  2186. {
  2187. have_local_perspective = true;
  2188. }
  2189. Matrix4f matrix;
  2190. if (primitive.ResolveTransform(matrix, *this))
  2191. {
  2192. transform_value *= matrix;
  2193. have_transform = true;
  2194. }
  2195. }
  2196. // Compute the transform origin
  2197. if (computed.transform_origin_x.type == Style::TransformOrigin::Percentage)
  2198. transform_origin.x = pos.x + computed.transform_origin_x.value * size.x * 0.01f;
  2199. else
  2200. transform_origin.x = pos.x + computed.transform_origin_x.value;
  2201. if (computed.transform_origin_y.type == Style::TransformOrigin::Percentage)
  2202. transform_origin.y = pos.y + computed.transform_origin_y.value * size.y * 0.01f;
  2203. else
  2204. transform_origin.y = pos.y + computed.transform_origin_y.value;
  2205. transform_origin.z = computed.transform_origin_z;
  2206. }
  2207. if (have_local_perspective && context)
  2208. {
  2209. if (!transform_state)
  2210. transform_state.reset(new TransformState);
  2211. local_perspective.view_size = context->GetDimensions();
  2212. transform_state->SetLocalPerspective(&local_perspective);
  2213. }
  2214. else if(transform_state)
  2215. {
  2216. transform_state->SetLocalPerspective(nullptr);
  2217. }
  2218. if (have_transform)
  2219. {
  2220. // TODO: If we're using the global projection matrix
  2221. // (perspective < 0), then scale the coordinates from
  2222. // pixel space to 3D unit space.
  2223. // Transform the Rocket context so that the computed `transform_origin'
  2224. // lies at the coordinate system origin.
  2225. transform_value =
  2226. Matrix4f::Translate(transform_origin)
  2227. * transform_value
  2228. * Matrix4f::Translate(-transform_origin);
  2229. if (!transform_state)
  2230. transform_state.reset(new TransformState);
  2231. transform_state->SetTransform(&transform_value);
  2232. }
  2233. else if (transform_state)
  2234. {
  2235. transform_state->SetTransform(nullptr);
  2236. }
  2237. transform_state_transform_dirty = false;
  2238. }
  2239. }
  2240. if (transform_state_parent_transform_dirty)
  2241. {
  2242. // We need to clean up from the top-most to the bottom-most dirt.
  2243. if (parent)
  2244. {
  2245. parent->UpdateTransformState();
  2246. }
  2247. if (transform_state)
  2248. {
  2249. // Store the parent's new full transform as our parent transform
  2250. Element *node = nullptr;
  2251. Matrix4f parent_transform;
  2252. for (node = parent; node; node = node->parent)
  2253. {
  2254. if (node->GetTransformState() && node->GetTransformState()->GetRecursiveTransform(&parent_transform))
  2255. {
  2256. transform_state->SetParentRecursiveTransform(&parent_transform);
  2257. break;
  2258. }
  2259. }
  2260. if (!node)
  2261. {
  2262. transform_state->SetParentRecursiveTransform(nullptr);
  2263. }
  2264. }
  2265. transform_state_parent_transform_dirty = false;
  2266. }
  2267. // If we neither have a local perspective, nor a perspective nor a
  2268. // transform, we don't need to keep the large TransformState object
  2269. // around. GetEffectiveTransformState() will then recursively visit
  2270. // parents in order to find a non-trivial TransformState.
  2271. if (transform_state && !transform_state->GetLocalPerspective(nullptr) && !transform_state->GetPerspective(nullptr) && !transform_state->GetTransform(nullptr))
  2272. {
  2273. transform_state.reset();
  2274. }
  2275. }
  2276. }
  2277. }