ElementDocument.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019-2023 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "../../Include/RmlUi/Core/ElementDocument.h"
  29. #include "../../Include/RmlUi/Core/Context.h"
  30. #include "../../Include/RmlUi/Core/ElementText.h"
  31. #include "../../Include/RmlUi/Core/Factory.h"
  32. #include "../../Include/RmlUi/Core/Profiling.h"
  33. #include "../../Include/RmlUi/Core/StreamMemory.h"
  34. #include "../../Include/RmlUi/Core/StyleSheet.h"
  35. #include "../../Include/RmlUi/Core/StyleSheetContainer.h"
  36. #include "DocumentHeader.h"
  37. #include "ElementStyle.h"
  38. #include "EventDispatcher.h"
  39. #include "Layout/LayoutEngine.h"
  40. #include "StreamFile.h"
  41. #include "StyleSheetFactory.h"
  42. #include "Template.h"
  43. #include "TemplateCache.h"
  44. #include "XMLParseTools.h"
  45. #include <limits.h>
  46. namespace Rml {
  47. enum class NavigationSearchDirection { Up, Down, Left, Right };
  48. namespace {
  49. constexpr int Infinite = INT_MAX;
  50. struct BoundingBox {
  51. static const BoundingBox Invalid;
  52. Vector2f min;
  53. Vector2f max;
  54. BoundingBox(const Vector2f& min, const Vector2f& max) : min(min), max(max) {}
  55. BoundingBox Union(const BoundingBox& bounding_box) const
  56. {
  57. return BoundingBox(Math::Min(min, bounding_box.min), Math::Max(max, bounding_box.max));
  58. }
  59. bool Intersects(const BoundingBox& box) const { return min.x <= box.max.x && max.x >= box.min.x && min.y <= box.max.y && max.y >= box.min.y; }
  60. bool IsValid() const { return min.x <= max.x && min.y <= max.y; }
  61. };
  62. const BoundingBox BoundingBox::Invalid = {Vector2f(FLT_MAX, FLT_MAX), Vector2f(-FLT_MAX, -FLT_MAX)};
  63. enum class CanFocus { Yes, No, NoAndNoChildren };
  64. CanFocus CanFocusElement(Element* element)
  65. {
  66. if (!element->IsVisible())
  67. return CanFocus::NoAndNoChildren;
  68. const ComputedValues& computed = element->GetComputedValues();
  69. if (computed.focus() == Style::Focus::None)
  70. return CanFocus::NoAndNoChildren;
  71. if (computed.tab_index() == Style::TabIndex::Auto)
  72. return CanFocus::Yes;
  73. return CanFocus::No;
  74. }
  75. bool IsScrollContainer(Element* element)
  76. {
  77. const auto& computed = element->GetComputedValues();
  78. if (computed.overflow_x() != Style::Overflow::Visible || computed.overflow_y() != Style::Overflow::Visible)
  79. return true;
  80. return false;
  81. }
  82. int GetNavigationHeuristic(const BoundingBox& source, const BoundingBox& target, NavigationSearchDirection direction)
  83. {
  84. enum Axis { Horizontal = 0, Vertical = 1 };
  85. auto CalculateHeuristic = [](Axis axis, const BoundingBox& a, const BoundingBox& b) -> int {
  86. // The heuristic is mainly the distance from the source to the target along the specified direction. In
  87. // addition, the following factor determines the penalty for being outside the projected area of the element in
  88. // the given direction, as a multiplier of the cross-axis distance between the target and projected area.
  89. static constexpr int CrossAxisFactor = 10'000;
  90. const int main_axis = int(a.min[axis] - b.max[axis]);
  91. if (main_axis < 0)
  92. return Infinite;
  93. const Axis cross = Axis((axis + 1) % 2);
  94. const int cross_axis = Math::Max(0, int(b.min[cross] - a.max[cross])) + Math::Max(0, int(a.min[cross] - b.max[cross]));
  95. return main_axis + CrossAxisFactor * cross_axis;
  96. };
  97. switch (direction)
  98. {
  99. case NavigationSearchDirection::Up: return CalculateHeuristic(Vertical, source, target);
  100. case NavigationSearchDirection::Down: return CalculateHeuristic(Vertical, target, source);
  101. case NavigationSearchDirection::Right: return CalculateHeuristic(Horizontal, target, source);
  102. case NavigationSearchDirection::Left: return CalculateHeuristic(Horizontal, source, target);
  103. }
  104. RMLUI_ERROR;
  105. return Infinite;
  106. }
  107. struct SearchNavigationResult {
  108. Element* element = nullptr;
  109. int heuristic = Infinite;
  110. };
  111. // Search all descendents to determine which element minimizes the navigation heuristic.
  112. void SearchNavigationTarget(SearchNavigationResult& best_result, Element* element, NavigationSearchDirection direction,
  113. const BoundingBox& bounding_box, Element* exclude_element)
  114. {
  115. const int num_children = element->GetNumChildren();
  116. for (int child_index = 0; child_index < num_children; child_index++)
  117. {
  118. Element* child = element->GetChild(child_index);
  119. if (child == exclude_element)
  120. continue;
  121. const CanFocus can_focus = CanFocusElement(child);
  122. if (can_focus == CanFocus::Yes)
  123. {
  124. const Vector2f position = child->GetAbsoluteOffset(BoxArea::Border);
  125. const BoundingBox target_box = {position, position + child->GetBox().GetSize(BoxArea::Border)};
  126. const int heuristic = GetNavigationHeuristic(bounding_box, target_box, direction);
  127. if (heuristic < best_result.heuristic)
  128. {
  129. best_result.element = child;
  130. best_result.heuristic = heuristic;
  131. }
  132. }
  133. else if (can_focus == CanFocus::NoAndNoChildren || IsScrollContainer(child))
  134. {
  135. continue;
  136. }
  137. SearchNavigationTarget(best_result, child, direction, bounding_box, exclude_element);
  138. }
  139. }
  140. } // namespace
  141. ElementDocument::ElementDocument(const String& tag) : Element(tag)
  142. {
  143. context = nullptr;
  144. modal = false;
  145. focusable_from_modal = false;
  146. layout_dirty = true;
  147. position_dirty = false;
  148. ForceLocalStackingContext();
  149. SetOwnerDocument(this);
  150. SetProperty(PropertyId::Position, Property(Style::Position::Absolute));
  151. }
  152. ElementDocument::~ElementDocument() {}
  153. void ElementDocument::ProcessHeader(const DocumentHeader* document_header)
  154. {
  155. RMLUI_ZoneScoped;
  156. // Store the source address that we came from
  157. source_url = document_header->source;
  158. // Construct a new header and copy the template details across
  159. DocumentHeader header;
  160. header.MergePaths(header.template_resources, document_header->template_resources, document_header->source);
  161. // Merge in any templates, note a merge may cause more templates to merge
  162. for (size_t i = 0; i < header.template_resources.size(); i++)
  163. {
  164. Template* merge_template = TemplateCache::LoadTemplate(URL(header.template_resources[i]).GetURL());
  165. if (merge_template)
  166. header.MergeHeader(*merge_template->GetHeader());
  167. else
  168. Log::Message(Log::LT_WARNING, "Template %s not found", header.template_resources[i].c_str());
  169. }
  170. // Merge the document's header last, as it is the most overriding.
  171. header.MergeHeader(*document_header);
  172. // Set the title to the document title.
  173. title = document_header->title;
  174. // If a style-sheet (or sheets) has been specified for this element, then we load them and set the combined sheet
  175. // on the element; all of its children will inherit it by default.
  176. SharedPtr<StyleSheetContainer> new_style_sheet;
  177. // Combine any inline sheets.
  178. for (const DocumentHeader::Resource& rcss : header.rcss)
  179. {
  180. if (rcss.is_inline)
  181. {
  182. auto inline_sheet = MakeShared<StyleSheetContainer>();
  183. auto stream = MakeUnique<StreamMemory>((const byte*)rcss.content.c_str(), rcss.content.size());
  184. stream->SetSourceURL(rcss.path);
  185. if (inline_sheet->LoadStyleSheetContainer(stream.get(), rcss.line))
  186. {
  187. if (new_style_sheet)
  188. new_style_sheet->MergeStyleSheetContainer(*inline_sheet);
  189. else
  190. new_style_sheet = std::move(inline_sheet);
  191. }
  192. stream.reset();
  193. }
  194. else
  195. {
  196. const StyleSheetContainer* sub_sheet = StyleSheetFactory::GetStyleSheetContainer(rcss.path);
  197. if (sub_sheet)
  198. {
  199. if (new_style_sheet)
  200. new_style_sheet->MergeStyleSheetContainer(*sub_sheet);
  201. else
  202. new_style_sheet = sub_sheet->CombineStyleSheetContainer(StyleSheetContainer());
  203. }
  204. else
  205. Log::Message(Log::LT_ERROR, "Failed to load style sheet %s.", rcss.path.c_str());
  206. }
  207. }
  208. // If a style sheet is available, set it on the document.
  209. if (new_style_sheet)
  210. SetStyleSheetContainer(std::move(new_style_sheet));
  211. // Load scripts.
  212. for (const DocumentHeader::Resource& script : header.scripts)
  213. {
  214. if (script.is_inline)
  215. {
  216. LoadInlineScript(script.content, script.path, script.line);
  217. }
  218. else
  219. {
  220. LoadExternalScript(script.path);
  221. }
  222. }
  223. // Hide this document.
  224. SetProperty(PropertyId::Visibility, Property(Style::Visibility::Hidden));
  225. const float dp_ratio = (context ? context->GetDensityIndependentPixelRatio() : 1.0f);
  226. const Vector2f vp_dimensions = (context ? Vector2f(context->GetDimensions()) : Vector2f(1.0f));
  227. // Update properties so that e.g. visibility status can be queried properly immediately.
  228. UpdateProperties(dp_ratio, vp_dimensions);
  229. }
  230. Context* ElementDocument::GetContext()
  231. {
  232. return context;
  233. }
  234. void ElementDocument::SetTitle(const String& _title)
  235. {
  236. title = _title;
  237. }
  238. const String& ElementDocument::GetTitle() const
  239. {
  240. return title;
  241. }
  242. const String& ElementDocument::GetSourceURL() const
  243. {
  244. return source_url;
  245. }
  246. const StyleSheet* ElementDocument::GetStyleSheet() const
  247. {
  248. if (style_sheet_container)
  249. return style_sheet_container->GetCompiledStyleSheet();
  250. return nullptr;
  251. }
  252. const StyleSheetContainer* ElementDocument::GetStyleSheetContainer() const
  253. {
  254. return style_sheet_container.get();
  255. }
  256. void ElementDocument::SetStyleSheetContainer(SharedPtr<StyleSheetContainer> _style_sheet_container)
  257. {
  258. RMLUI_ZoneScoped;
  259. if (style_sheet_container == _style_sheet_container)
  260. return;
  261. style_sheet_container = std::move(_style_sheet_container);
  262. DirtyMediaQueries();
  263. }
  264. void ElementDocument::ReloadStyleSheet()
  265. {
  266. if (!context)
  267. return;
  268. auto stream = MakeUnique<StreamFile>();
  269. if (!stream->Open(source_url))
  270. {
  271. Log::Message(Log::LT_WARNING, "Failed to open file to reload style sheet in document: %s", source_url.c_str());
  272. return;
  273. }
  274. Factory::ClearStyleSheetCache();
  275. Factory::ClearTemplateCache();
  276. ElementPtr temp_doc = Factory::InstanceDocumentStream(nullptr, stream.get(), context->GetDocumentsBaseTag());
  277. if (!temp_doc)
  278. {
  279. Log::Message(Log::LT_WARNING, "Failed to reload style sheet, could not instance document: %s", source_url.c_str());
  280. return;
  281. }
  282. SetStyleSheetContainer(rmlui_static_cast<ElementDocument*>(temp_doc.get())->style_sheet_container);
  283. }
  284. void ElementDocument::DirtyMediaQueries()
  285. {
  286. if (context && style_sheet_container)
  287. {
  288. const bool changed_style_sheet = style_sheet_container->UpdateCompiledStyleSheet(context);
  289. if (changed_style_sheet)
  290. {
  291. DirtyDefinition(Element::DirtyNodes::Self);
  292. OnStyleSheetChangeRecursive();
  293. }
  294. }
  295. }
  296. void ElementDocument::PullToFront()
  297. {
  298. if (context != nullptr)
  299. context->PullDocumentToFront(this);
  300. }
  301. void ElementDocument::PushToBack()
  302. {
  303. if (context != nullptr)
  304. context->PushDocumentToBack(this);
  305. }
  306. void ElementDocument::Show(ModalFlag modal_flag, FocusFlag focus_flag)
  307. {
  308. switch (modal_flag)
  309. {
  310. case ModalFlag::None: modal = false; break;
  311. case ModalFlag::Modal: modal = true; break;
  312. case ModalFlag::Keep: break;
  313. }
  314. bool focus = false;
  315. bool autofocus = false;
  316. bool focus_previous = false;
  317. switch (focus_flag)
  318. {
  319. case FocusFlag::None: break;
  320. case FocusFlag::Document: focus = true; break;
  321. case FocusFlag::Keep:
  322. focus = true;
  323. focus_previous = true;
  324. break;
  325. case FocusFlag::Auto:
  326. focus = true;
  327. autofocus = true;
  328. break;
  329. }
  330. // Set to visible and switch focus if necessary.
  331. SetProperty(PropertyId::Visibility, Property(Style::Visibility::Visible));
  332. // Update the document now, otherwise the focusing methods below do not think we are visible. This is also important
  333. // to ensure correct layout for any event handlers, such as for focused input fields to submit the proper caret
  334. // position.
  335. UpdateDocument();
  336. if (focus)
  337. {
  338. Element* focus_element = this;
  339. if (autofocus)
  340. {
  341. Element* first_element = nullptr;
  342. Element* element = FindNextTabElement(this, true);
  343. while (element && element != first_element)
  344. {
  345. if (!first_element)
  346. first_element = element;
  347. if (element->HasAttribute("autofocus"))
  348. {
  349. focus_element = element;
  350. break;
  351. }
  352. element = FindNextTabElement(element, true);
  353. }
  354. }
  355. else if (focus_previous)
  356. {
  357. focus_element = GetFocusLeafNode();
  358. }
  359. // Focus the window or element
  360. bool focused = focus_element->Focus(true);
  361. if (focused && focus_element != this)
  362. focus_element->ScrollIntoView(false);
  363. }
  364. DispatchEvent(EventId::Show, Dictionary());
  365. }
  366. void ElementDocument::Hide()
  367. {
  368. SetProperty(PropertyId::Visibility, Property(Style::Visibility::Hidden));
  369. // We should update the document now, so that the (un)focusing will get the correct visibility
  370. UpdateDocument();
  371. DispatchEvent(EventId::Hide, Dictionary());
  372. if (context)
  373. {
  374. context->UnfocusDocument(this);
  375. }
  376. }
  377. void ElementDocument::Close()
  378. {
  379. if (context != nullptr)
  380. context->UnloadDocument(this);
  381. }
  382. ElementPtr ElementDocument::CreateElement(const String& name)
  383. {
  384. return Factory::InstanceElement(nullptr, name, name, XMLAttributes());
  385. }
  386. ElementPtr ElementDocument::CreateTextNode(const String& text)
  387. {
  388. // Create the element.
  389. ElementPtr element = CreateElement("#text");
  390. if (!element)
  391. {
  392. Log::Message(Log::LT_ERROR, "Failed to create text element, instancer returned nullptr.");
  393. return nullptr;
  394. }
  395. // Cast up
  396. ElementText* element_text = rmlui_dynamic_cast<ElementText*>(element.get());
  397. if (!element_text)
  398. {
  399. Log::Message(Log::LT_ERROR, "Failed to create text element, instancer didn't return a derivative of ElementText.");
  400. return nullptr;
  401. }
  402. // Set the text
  403. element_text->SetText(text);
  404. return element;
  405. }
  406. bool ElementDocument::IsModal() const
  407. {
  408. return modal && IsVisible();
  409. }
  410. void ElementDocument::LoadInlineScript(const String& /*content*/, const String& /*source_path*/, int /*line*/) {}
  411. void ElementDocument::LoadExternalScript(const String& /*source_path*/) {}
  412. void ElementDocument::UpdateDocument()
  413. {
  414. const float dp_ratio = (context ? context->GetDensityIndependentPixelRatio() : 1.0f);
  415. const Vector2f vp_dimensions = (context ? Vector2f(context->GetDimensions()) : Vector2f(1.0f));
  416. Update(dp_ratio, vp_dimensions);
  417. UpdateLayout();
  418. UpdatePosition();
  419. }
  420. void ElementDocument::UpdateLayout()
  421. {
  422. // Note: Carefully consider when to call this function for performance reasons.
  423. // Ideally, only called once per update loop.
  424. if (layout_dirty)
  425. {
  426. RMLUI_ZoneScoped;
  427. RMLUI_ZoneText(source_url.c_str(), source_url.size());
  428. Vector2f containing_block(0, 0);
  429. if (GetParentNode() != nullptr)
  430. containing_block = GetParentNode()->GetBox().GetSize();
  431. LayoutEngine::FormatElement(this, containing_block);
  432. // Ignore dirtied layout during document formatting. Layouting must not require re-iteration.
  433. // In particular, scrollbars being enabled may set the dirty flag, but this case is already handled within the layout engine.
  434. layout_dirty = false;
  435. }
  436. }
  437. void ElementDocument::UpdatePosition()
  438. {
  439. if (position_dirty)
  440. {
  441. RMLUI_ZoneScoped;
  442. position_dirty = false;
  443. Element* root = GetParentNode();
  444. // We only position ourselves if we are a child of our context's root element. That is, we don't want to proceed
  445. // if we are unparented or an iframe document.
  446. if (!root || !context || (root != context->GetRootElement()))
  447. return;
  448. // Work out our containing block; relative offsets are calculated against it.
  449. const Vector2f containing_block = root->GetBox().GetSize();
  450. auto& computed = GetComputedValues();
  451. const Box& box = GetBox();
  452. Vector2f position;
  453. if (computed.left().type != Style::Left::Auto)
  454. position.x = ResolveValue(computed.left(), containing_block.x);
  455. else if (computed.right().type != Style::Right::Auto)
  456. position.x = containing_block.x - (box.GetSize(BoxArea::Margin).x + ResolveValue(computed.right(), containing_block.x));
  457. if (computed.top().type != Style::Top::Auto)
  458. position.y = ResolveValue(computed.top(), containing_block.y);
  459. else if (computed.bottom().type != Style::Bottom::Auto)
  460. position.y = containing_block.y - (box.GetSize(BoxArea::Margin).y + ResolveValue(computed.bottom(), containing_block.y));
  461. // Add the margin edge to the position, since inset properties (top/right/bottom/left) set the margin edge
  462. // position, while offsets use the border edge.
  463. position.x += box.GetEdge(BoxArea::Margin, BoxEdge::Left);
  464. position.y += box.GetEdge(BoxArea::Margin, BoxEdge::Top);
  465. SetOffset(position, nullptr);
  466. }
  467. }
  468. void ElementDocument::DirtyPosition()
  469. {
  470. position_dirty = true;
  471. }
  472. void ElementDocument::DirtyLayout()
  473. {
  474. layout_dirty = true;
  475. }
  476. bool ElementDocument::IsLayoutDirty()
  477. {
  478. return layout_dirty;
  479. }
  480. void ElementDocument::DirtyVwAndVhProperties()
  481. {
  482. GetStyle()->DirtyPropertiesWithUnitsRecursive(Unit::VW | Unit::VH);
  483. }
  484. void ElementDocument::OnPropertyChange(const PropertyIdSet& changed_properties)
  485. {
  486. Element::OnPropertyChange(changed_properties);
  487. // If the document's font-size has been changed, we need to dirty all rem properties.
  488. if (changed_properties.Contains(PropertyId::FontSize))
  489. GetStyle()->DirtyPropertiesWithUnitsRecursive(Unit::REM);
  490. if (changed_properties.Contains(PropertyId::Top) || //
  491. changed_properties.Contains(PropertyId::Right) || //
  492. changed_properties.Contains(PropertyId::Bottom) || //
  493. changed_properties.Contains(PropertyId::Left))
  494. DirtyPosition();
  495. }
  496. void ElementDocument::ProcessDefaultAction(Event& event)
  497. {
  498. Element::ProcessDefaultAction(event);
  499. // Process generic keyboard events for this window in bubble phase
  500. if (event == EventId::Keydown)
  501. {
  502. int key_identifier = event.GetParameter<int>("key_identifier", Input::KI_UNKNOWN);
  503. // Process TAB
  504. if (key_identifier == Input::KI_TAB)
  505. {
  506. if (Element* element = FindNextTabElement(event.GetTargetElement(), !event.GetParameter<bool>("shift_key", false)))
  507. {
  508. if (element->Focus(true))
  509. {
  510. element->ScrollIntoView(ScrollAlignment::Nearest);
  511. event.StopPropagation();
  512. }
  513. }
  514. }
  515. // Process direction keys
  516. else if (key_identifier == Input::KI_LEFT || key_identifier == Input::KI_RIGHT || key_identifier == Input::KI_UP ||
  517. key_identifier == Input::KI_DOWN)
  518. {
  519. NavigationSearchDirection direction = {};
  520. PropertyId property_id = PropertyId::NavLeft;
  521. switch (key_identifier)
  522. {
  523. case Input::KI_LEFT:
  524. direction = NavigationSearchDirection::Left;
  525. property_id = PropertyId::NavLeft;
  526. break;
  527. case Input::KI_RIGHT:
  528. direction = NavigationSearchDirection::Right;
  529. property_id = PropertyId::NavRight;
  530. break;
  531. case Input::KI_UP:
  532. direction = NavigationSearchDirection::Up;
  533. property_id = PropertyId::NavUp;
  534. break;
  535. case Input::KI_DOWN:
  536. direction = NavigationSearchDirection::Down;
  537. property_id = PropertyId::NavDown;
  538. break;
  539. }
  540. auto GetNearestFocusable = [this](Element* focus_node) -> Element* {
  541. while (focus_node)
  542. {
  543. if (CanFocusElement(focus_node) == CanFocus::Yes)
  544. break;
  545. focus_node = focus_node->GetParentNode();
  546. }
  547. return focus_node ? focus_node : this;
  548. };
  549. Element* focus_node = GetNearestFocusable(GetFocusLeafNode());
  550. if (const Property* nav_property = focus_node->GetLocalProperty(property_id))
  551. {
  552. if (Element* next = FindNextNavigationElement(focus_node, direction, *nav_property))
  553. {
  554. if (next->Focus(true))
  555. {
  556. next->ScrollIntoView(ScrollAlignment::Nearest);
  557. event.StopPropagation();
  558. }
  559. }
  560. }
  561. }
  562. // Process ENTER being pressed on a focusable object (emulate click)
  563. else if (key_identifier == Input::KI_RETURN || key_identifier == Input::KI_NUMPADENTER || key_identifier == Input::KI_SPACE)
  564. {
  565. Element* focus_node = GetFocusLeafNode();
  566. if (focus_node && focus_node->GetComputedValues().tab_index() == Style::TabIndex::Auto)
  567. {
  568. focus_node->Click();
  569. event.StopPropagation();
  570. }
  571. }
  572. }
  573. }
  574. void ElementDocument::OnResize()
  575. {
  576. DirtyPosition();
  577. }
  578. bool ElementDocument::IsFocusableFromModal() const
  579. {
  580. return focusable_from_modal && IsVisible();
  581. }
  582. void ElementDocument::SetFocusableFromModal(bool focusable)
  583. {
  584. focusable_from_modal = focusable;
  585. }
  586. Element* ElementDocument::FindNextTabElement(Element* current_element, bool forward)
  587. {
  588. // This algorithm is quite sneaky, I originally thought a depth first search would work, but it appears not. What is
  589. // required is to cut the tree in half along the nodes from current_element up the root and then either traverse the
  590. // tree in a clockwise or anticlock wise direction depending if you're searching forward or backward respectively.
  591. // If we're searching forward, check the immediate children of this node first off.
  592. if (forward)
  593. {
  594. for (int i = 0; i < current_element->GetNumChildren(); i++)
  595. if (Element* result = SearchFocusSubtree(current_element->GetChild(i), forward))
  596. return result;
  597. }
  598. // Now walk up the tree, testing either the bottom or top
  599. // of the tree, depending on whether we're going forward
  600. // or backward respectively.
  601. bool search_enabled = false;
  602. Element* document = current_element->GetOwnerDocument();
  603. Element* child = current_element;
  604. Element* parent = current_element->GetParentNode();
  605. while (child != document)
  606. {
  607. const int num_children = parent->GetNumChildren();
  608. for (int i = 0; i < num_children; i++)
  609. {
  610. // Calculate index into children
  611. const int child_index = forward ? i : (num_children - i - 1);
  612. Element* search_child = parent->GetChild(child_index);
  613. // Do a search if its enabled
  614. if (search_enabled)
  615. if (Element* result = SearchFocusSubtree(search_child, forward))
  616. return result;
  617. // Enable searching when we reach the child.
  618. if (search_child == child)
  619. search_enabled = true;
  620. }
  621. // Advance up the tree
  622. child = parent;
  623. parent = parent->GetParentNode();
  624. search_enabled = false;
  625. }
  626. // We could not find anything to focus along this direction.
  627. // If we can focus the document, then focus that now.
  628. if (current_element != document && CanFocusElement(document) == CanFocus::Yes)
  629. return document;
  630. // Otherwise, search the entire document tree. This way we will wrap around.
  631. const int num_children = document->GetNumChildren();
  632. for (int i = 0; i < num_children; i++)
  633. {
  634. const int child_index = forward ? i : (num_children - i - 1);
  635. if (Element* result = SearchFocusSubtree(document->GetChild(child_index), forward))
  636. return result;
  637. }
  638. return nullptr;
  639. }
  640. Element* ElementDocument::SearchFocusSubtree(Element* element, bool forward)
  641. {
  642. CanFocus can_focus = CanFocusElement(element);
  643. if (can_focus == CanFocus::Yes)
  644. return element;
  645. else if (can_focus == CanFocus::NoAndNoChildren)
  646. return nullptr;
  647. for (int i = 0; i < element->GetNumChildren(); i++)
  648. {
  649. int child_index = i;
  650. if (!forward)
  651. child_index = element->GetNumChildren() - i - 1;
  652. if (Element* result = SearchFocusSubtree(element->GetChild(child_index), forward))
  653. return result;
  654. }
  655. return nullptr;
  656. }
  657. Element* ElementDocument::FindNextNavigationElement(Element* current_element, NavigationSearchDirection direction, const Property& property)
  658. {
  659. switch (property.unit)
  660. {
  661. case Unit::STRING:
  662. {
  663. const PropertySource* source = property.source.get();
  664. const String value = property.Get<String>();
  665. if (value[0] != '#')
  666. {
  667. Log::Message(Log::LT_WARNING,
  668. "Invalid navigation value '%s': Expected a keyword or a string with an element id prefixed with '#'. Declared at %s:%d",
  669. value.c_str(), source ? source->path.c_str() : "", source ? source->line_number : -1);
  670. return nullptr;
  671. }
  672. const String id = String(value.begin() + 1, value.end());
  673. Element* result = GetElementById(id);
  674. if (!result)
  675. {
  676. Log::Message(Log::LT_WARNING, "Trying to navigate to element with id '%s', but could not find element. Declared at %s:%d", id.c_str(),
  677. source ? source->path.c_str() : "", source ? source->line_number : -1);
  678. }
  679. return result;
  680. }
  681. break;
  682. case Unit::KEYWORD:
  683. {
  684. const bool direction_is_horizontal = (direction == NavigationSearchDirection::Left || direction == NavigationSearchDirection::Right);
  685. const bool direction_is_vertical = (direction == NavigationSearchDirection::Up || direction == NavigationSearchDirection::Down);
  686. switch (static_cast<Style::Nav>(property.value.Get<int>()))
  687. {
  688. case Style::Nav::None: return nullptr;
  689. case Style::Nav::Auto: break;
  690. case Style::Nav::Horizontal:
  691. if (!direction_is_horizontal)
  692. return nullptr;
  693. break;
  694. case Style::Nav::Vertical:
  695. if (!direction_is_vertical)
  696. return nullptr;
  697. break;
  698. }
  699. }
  700. break;
  701. default: return nullptr;
  702. }
  703. if (current_element == this)
  704. {
  705. const bool direction_is_forward = (direction == NavigationSearchDirection::Down || direction == NavigationSearchDirection::Right);
  706. return FindNextTabElement(this, direction_is_forward);
  707. }
  708. const Vector2f position = current_element->GetAbsoluteOffset(BoxArea::Border);
  709. const BoundingBox bounding_box = {position, position + current_element->GetBox().GetSize(BoxArea::Border)};
  710. auto GetNearestScrollContainer = [this](Element* element) -> Element* {
  711. for (element = element->GetParentNode(); element; element = element->GetParentNode())
  712. {
  713. if (IsScrollContainer(element))
  714. return element;
  715. }
  716. return this;
  717. };
  718. Element* start_element = GetNearestScrollContainer(current_element);
  719. SearchNavigationResult best_result;
  720. SearchNavigationTarget(best_result, start_element, direction, bounding_box, current_element);
  721. return best_result.element;
  722. }
  723. } // namespace Rml