Node.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742
  1. /*
  2. * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Badge.h>
  8. #include <AK/FlyString.h>
  9. #include <AK/JsonObjectSerializer.h>
  10. #include <AK/RefPtr.h>
  11. #include <AK/TypeCasts.h>
  12. #include <AK/Vector.h>
  13. #include <LibWeb/DOM/AccessibilityTreeNode.h>
  14. #include <LibWeb/DOM/EventTarget.h>
  15. #include <LibWeb/DOM/Slottable.h>
  16. #include <LibWeb/DOMParsing/XMLSerializer.h>
  17. #include <LibWeb/WebIDL/ExceptionOr.h>
  18. namespace Web::DOM {
  19. enum class NodeType : u16 {
  20. INVALID = 0,
  21. ELEMENT_NODE = 1,
  22. ATTRIBUTE_NODE = 2,
  23. TEXT_NODE = 3,
  24. CDATA_SECTION_NODE = 4,
  25. ENTITY_REFERENCE_NODE = 5,
  26. ENTITY_NODE = 6,
  27. PROCESSING_INSTRUCTION_NODE = 7,
  28. COMMENT_NODE = 8,
  29. DOCUMENT_NODE = 9,
  30. DOCUMENT_TYPE_NODE = 10,
  31. DOCUMENT_FRAGMENT_NODE = 11,
  32. NOTATION_NODE = 12
  33. };
  34. enum class NameOrDescription {
  35. Name,
  36. Description
  37. };
  38. struct GetRootNodeOptions {
  39. bool composed { false };
  40. };
  41. enum class FragmentSerializationMode {
  42. Inner,
  43. Outer,
  44. };
  45. class Node : public EventTarget {
  46. WEB_PLATFORM_OBJECT(Node, EventTarget);
  47. public:
  48. ParentNode* parent_or_shadow_host();
  49. ParentNode const* parent_or_shadow_host() const { return const_cast<Node*>(this)->parent_or_shadow_host(); }
  50. Element* parent_or_shadow_host_element();
  51. Element const* parent_or_shadow_host_element() const { return const_cast<Node*>(this)->parent_or_shadow_host_element(); }
  52. virtual ~Node();
  53. NodeType type() const { return m_type; }
  54. bool is_element() const { return type() == NodeType::ELEMENT_NODE; }
  55. bool is_text() const { return type() == NodeType::TEXT_NODE; }
  56. bool is_document() const { return type() == NodeType::DOCUMENT_NODE; }
  57. bool is_document_type() const { return type() == NodeType::DOCUMENT_TYPE_NODE; }
  58. bool is_comment() const { return type() == NodeType::COMMENT_NODE; }
  59. bool is_character_data() const { return type() == NodeType::TEXT_NODE || type() == NodeType::COMMENT_NODE; }
  60. bool is_document_fragment() const { return type() == NodeType::DOCUMENT_FRAGMENT_NODE; }
  61. bool is_parent_node() const { return is_element() || is_document() || is_document_fragment(); }
  62. bool is_slottable() const { return is_element() || is_text() || is_cdata_section(); }
  63. bool is_attribute() const { return type() == NodeType::ATTRIBUTE_NODE; }
  64. bool is_cdata_section() const { return type() == NodeType::CDATA_SECTION_NODE; }
  65. virtual bool is_shadow_root() const { return false; }
  66. virtual bool requires_svg_container() const { return false; }
  67. virtual bool is_svg_container() const { return false; }
  68. virtual bool is_svg_element() const { return false; }
  69. virtual bool is_svg_graphics_element() const { return false; }
  70. virtual bool is_svg_script_element() const { return false; }
  71. virtual bool is_svg_svg_element() const { return false; }
  72. virtual bool is_svg_use_element() const { return false; }
  73. bool in_a_document_tree() const;
  74. // NOTE: This is intended for the JS bindings.
  75. u16 node_type() const { return (u16)m_type; }
  76. virtual bool is_editable() const;
  77. virtual bool is_dom_node() const final { return true; }
  78. virtual bool is_html_element() const { return false; }
  79. virtual bool is_html_html_element() const { return false; }
  80. virtual bool is_html_anchor_element() const { return false; }
  81. virtual bool is_html_base_element() const { return false; }
  82. virtual bool is_html_body_element() const { return false; }
  83. virtual bool is_html_input_element() const { return false; }
  84. virtual bool is_html_progress_element() const { return false; }
  85. virtual bool is_html_script_element() const { return false; }
  86. virtual bool is_html_template_element() const { return false; }
  87. virtual bool is_html_table_element() const { return false; }
  88. virtual bool is_html_table_section_element() const { return false; }
  89. virtual bool is_html_table_row_element() const { return false; }
  90. virtual bool is_html_table_cell_element() const { return false; }
  91. virtual bool is_html_br_element() const { return false; }
  92. virtual bool is_html_button_element() const { return false; }
  93. virtual bool is_html_slot_element() const { return false; }
  94. virtual bool is_html_embed_element() const { return false; }
  95. virtual bool is_html_object_element() const { return false; }
  96. virtual bool is_html_form_element() const { return false; }
  97. virtual bool is_html_image_element() const { return false; }
  98. virtual bool is_navigable_container() const { return false; }
  99. virtual bool is_lazy_loading() const { return false; }
  100. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> pre_insert(JS::NonnullGCPtr<Node>, JS::GCPtr<Node>);
  101. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> pre_remove(JS::NonnullGCPtr<Node>);
  102. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> append_child(JS::NonnullGCPtr<Node>);
  103. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> remove_child(JS::NonnullGCPtr<Node>);
  104. void insert_before(JS::NonnullGCPtr<Node> node, JS::GCPtr<Node> child, bool suppress_observers = false);
  105. void remove(bool suppress_observers = false);
  106. void remove_all_children(bool suppress_observers = false);
  107. enum DocumentPosition : u16 {
  108. DOCUMENT_POSITION_EQUAL = 0,
  109. DOCUMENT_POSITION_DISCONNECTED = 1,
  110. DOCUMENT_POSITION_PRECEDING = 2,
  111. DOCUMENT_POSITION_FOLLOWING = 4,
  112. DOCUMENT_POSITION_CONTAINS = 8,
  113. DOCUMENT_POSITION_CONTAINED_BY = 16,
  114. DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 32,
  115. };
  116. u16 compare_document_position(JS::GCPtr<Node> other);
  117. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> replace_child(JS::NonnullGCPtr<Node> node, JS::NonnullGCPtr<Node> child);
  118. JS::NonnullGCPtr<Node> clone_node(Document* document = nullptr, bool clone_children = false);
  119. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> clone_node_binding(bool deep);
  120. // NOTE: This is intended for the JS bindings.
  121. bool has_child_nodes() const { return has_children(); }
  122. JS::NonnullGCPtr<NodeList> child_nodes();
  123. Vector<JS::Handle<Node>> children_as_vector() const;
  124. virtual FlyString node_name() const = 0;
  125. String base_uri() const;
  126. String descendant_text_content() const;
  127. Optional<String> text_content() const;
  128. void set_text_content(Optional<String> const&);
  129. Optional<String> node_value() const;
  130. void set_node_value(Optional<String> const&);
  131. JS::GCPtr<HTML::Navigable> navigable() const;
  132. Document& document() { return *m_document; }
  133. Document const& document() const { return *m_document; }
  134. JS::GCPtr<Document> owner_document() const;
  135. const HTML::HTMLAnchorElement* enclosing_link_element() const;
  136. const HTML::HTMLElement* enclosing_html_element() const;
  137. const HTML::HTMLElement* enclosing_html_element_with_attribute(FlyString const&) const;
  138. String child_text_content() const;
  139. Node& root();
  140. Node const& root() const
  141. {
  142. return const_cast<Node*>(this)->root();
  143. }
  144. Node& shadow_including_root();
  145. Node const& shadow_including_root() const
  146. {
  147. return const_cast<Node*>(this)->shadow_including_root();
  148. }
  149. bool is_connected() const;
  150. [[nodiscard]] bool is_browsing_context_connected() const;
  151. Node* parent_node() { return parent(); }
  152. Node const* parent_node() const { return parent(); }
  153. Element* parent_element();
  154. Element const* parent_element() const;
  155. virtual void inserted();
  156. virtual void removed_from(Node*);
  157. virtual void children_changed() { }
  158. virtual void adopted_from(Document&) { }
  159. virtual void cloned(Node&, bool) {};
  160. Layout::Node const* layout_node() const { return m_layout_node; }
  161. Layout::Node* layout_node() { return m_layout_node; }
  162. Painting::PaintableBox const* paintable_box() const;
  163. Painting::PaintableBox* paintable_box();
  164. Painting::Paintable const* paintable() const;
  165. Painting::Paintable* paintable();
  166. void set_paintable(JS::GCPtr<Painting::Paintable>);
  167. void set_layout_node(Badge<Layout::Node>, JS::NonnullGCPtr<Layout::Node>);
  168. void detach_layout_node(Badge<Layout::TreeBuilder>);
  169. virtual bool is_child_allowed(Node const&) const { return true; }
  170. bool needs_style_update() const { return m_needs_style_update; }
  171. void set_needs_style_update(bool);
  172. bool child_needs_style_update() const { return m_child_needs_style_update; }
  173. void set_child_needs_style_update(bool b) { m_child_needs_style_update = b; }
  174. void invalidate_style();
  175. void set_document(Badge<Document>, Document&);
  176. virtual EventTarget* get_parent(Event const&) override;
  177. template<typename T>
  178. bool fast_is() const = delete;
  179. WebIDL::ExceptionOr<void> ensure_pre_insertion_validity(JS::NonnullGCPtr<Node> node, JS::GCPtr<Node> child) const;
  180. bool is_host_including_inclusive_ancestor_of(Node const&) const;
  181. bool is_scripting_enabled() const;
  182. bool is_scripting_disabled() const;
  183. bool contains(JS::GCPtr<Node>) const;
  184. // Used for dumping the DOM Tree
  185. void serialize_tree_as_json(JsonObjectSerializer<StringBuilder>&) const;
  186. bool is_shadow_including_descendant_of(Node const&) const;
  187. bool is_shadow_including_inclusive_descendant_of(Node const&) const;
  188. bool is_shadow_including_ancestor_of(Node const&) const;
  189. bool is_shadow_including_inclusive_ancestor_of(Node const&) const;
  190. i32 unique_id() const { return m_unique_id; }
  191. static Node* from_unique_id(i32);
  192. WebIDL::ExceptionOr<String> serialize_fragment(DOMParsing::RequireWellFormed, FragmentSerializationMode = FragmentSerializationMode::Inner) const;
  193. void replace_all(JS::GCPtr<Node>);
  194. void string_replace_all(String const&);
  195. bool is_same_node(Node const*) const;
  196. bool is_equal_node(Node const*) const;
  197. JS::NonnullGCPtr<Node> get_root_node(GetRootNodeOptions const& options = {});
  198. bool is_uninteresting_whitespace_node() const;
  199. String debug_description() const;
  200. size_t length() const;
  201. auto& registered_observer_list() { return m_registered_observer_list; }
  202. auto const& registered_observer_list() const { return m_registered_observer_list; }
  203. void add_registered_observer(RegisteredObserver&);
  204. void queue_mutation_record(FlyString const& type, Optional<FlyString> const& attribute_name, Optional<FlyString> const& attribute_namespace, Optional<String> const& old_value, Vector<JS::Handle<Node>> added_nodes, Vector<JS::Handle<Node>> removed_nodes, Node* previous_sibling, Node* next_sibling) const;
  205. // https://dom.spec.whatwg.org/#concept-shadow-including-inclusive-descendant
  206. template<typename Callback>
  207. IterationDecision for_each_shadow_including_inclusive_descendant(Callback);
  208. // https://dom.spec.whatwg.org/#concept-shadow-including-descendant
  209. template<typename Callback>
  210. IterationDecision for_each_shadow_including_descendant(Callback);
  211. Slottable as_slottable();
  212. Node* parent() { return m_parent.ptr(); }
  213. Node const* parent() const { return m_parent.ptr(); }
  214. bool has_children() const { return m_first_child; }
  215. Node* next_sibling() { return m_next_sibling.ptr(); }
  216. Node* previous_sibling() { return m_previous_sibling.ptr(); }
  217. Node* first_child() { return m_first_child.ptr(); }
  218. Node* last_child() { return m_last_child.ptr(); }
  219. Node const* next_sibling() const { return m_next_sibling.ptr(); }
  220. Node const* previous_sibling() const { return m_previous_sibling.ptr(); }
  221. Node const* first_child() const { return m_first_child.ptr(); }
  222. Node const* last_child() const { return m_last_child.ptr(); }
  223. size_t child_count() const
  224. {
  225. size_t count = 0;
  226. for (auto* child = first_child(); child; child = child->next_sibling())
  227. ++count;
  228. return count;
  229. }
  230. Node* child_at_index(int index)
  231. {
  232. int count = 0;
  233. for (auto* child = first_child(); child; child = child->next_sibling()) {
  234. if (count == index)
  235. return child;
  236. ++count;
  237. }
  238. return nullptr;
  239. }
  240. Node const* child_at_index(int index) const
  241. {
  242. return const_cast<Node*>(this)->child_at_index(index);
  243. }
  244. // https://dom.spec.whatwg.org/#concept-tree-index
  245. size_t index() const
  246. {
  247. // The index of an object is its number of preceding siblings, or 0 if it has none.
  248. size_t index = 0;
  249. for (auto* node = previous_sibling(); node; node = node->previous_sibling())
  250. ++index;
  251. return index;
  252. }
  253. Optional<size_t> index_of_child(Node const& search_child)
  254. {
  255. VERIFY(search_child.parent() == this);
  256. size_t index = 0;
  257. auto* child = first_child();
  258. VERIFY(child);
  259. do {
  260. if (child == &search_child)
  261. return index;
  262. index++;
  263. } while (child && (child = child->next_sibling()));
  264. return {};
  265. }
  266. template<typename ChildType>
  267. Optional<size_t> index_of_child(Node const& search_child)
  268. {
  269. VERIFY(search_child.parent() == this);
  270. size_t index = 0;
  271. auto* child = first_child();
  272. VERIFY(child);
  273. do {
  274. if (!is<ChildType>(child))
  275. continue;
  276. if (child == &search_child)
  277. return index;
  278. index++;
  279. } while (child && (child = child->next_sibling()));
  280. return {};
  281. }
  282. bool is_ancestor_of(Node const&) const;
  283. bool is_inclusive_ancestor_of(Node const&) const;
  284. bool is_descendant_of(Node const&) const;
  285. bool is_inclusive_descendant_of(Node const&) const;
  286. bool is_following(Node const&) const;
  287. Node* next_in_pre_order()
  288. {
  289. if (first_child())
  290. return first_child();
  291. Node* node;
  292. if (!(node = next_sibling())) {
  293. node = parent();
  294. while (node && !node->next_sibling())
  295. node = node->parent();
  296. if (node)
  297. node = node->next_sibling();
  298. }
  299. return node;
  300. }
  301. Node* next_in_pre_order(Node const* stay_within)
  302. {
  303. if (first_child())
  304. return first_child();
  305. Node* node = static_cast<Node*>(this);
  306. Node* next = nullptr;
  307. while (!(next = node->next_sibling())) {
  308. node = node->parent();
  309. if (!node || node == stay_within)
  310. return nullptr;
  311. }
  312. return next;
  313. }
  314. Node const* next_in_pre_order() const
  315. {
  316. return const_cast<Node*>(this)->next_in_pre_order();
  317. }
  318. Node const* next_in_pre_order(Node const* stay_within) const
  319. {
  320. return const_cast<Node*>(this)->next_in_pre_order(stay_within);
  321. }
  322. Node* previous_in_pre_order()
  323. {
  324. if (auto* node = previous_sibling()) {
  325. while (node->last_child())
  326. node = node->last_child();
  327. return node;
  328. }
  329. return parent();
  330. }
  331. Node const* previous_in_pre_order() const
  332. {
  333. return const_cast<Node*>(this)->previous_in_pre_order();
  334. }
  335. bool is_before(Node const& other) const
  336. {
  337. if (this == &other)
  338. return false;
  339. for (auto* node = this; node; node = node->next_in_pre_order()) {
  340. if (node == &other)
  341. return true;
  342. }
  343. return false;
  344. }
  345. // https://dom.spec.whatwg.org/#concept-tree-preceding (Object A is 'typename U' and Object B is 'this')
  346. template<typename U>
  347. bool has_preceding_node_of_type_in_tree_order() const
  348. {
  349. for (auto* node = previous_in_pre_order(); node; node = node->previous_in_pre_order()) {
  350. if (is<U>(node))
  351. return true;
  352. }
  353. return false;
  354. }
  355. // https://dom.spec.whatwg.org/#concept-tree-following (Object A is 'typename U' and Object B is 'this')
  356. template<typename U>
  357. bool has_following_node_of_type_in_tree_order() const
  358. {
  359. for (auto* node = next_in_pre_order(); node; node = node->next_in_pre_order()) {
  360. if (is<U>(node))
  361. return true;
  362. }
  363. return false;
  364. }
  365. template<typename Callback>
  366. IterationDecision for_each_in_inclusive_subtree(Callback callback) const
  367. {
  368. if (callback(static_cast<Node const&>(*this)) == IterationDecision::Break)
  369. return IterationDecision::Break;
  370. for (auto* child = first_child(); child; child = child->next_sibling()) {
  371. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  372. return IterationDecision::Break;
  373. }
  374. return IterationDecision::Continue;
  375. }
  376. template<typename Callback>
  377. IterationDecision for_each_in_inclusive_subtree(Callback callback)
  378. {
  379. if (callback(static_cast<Node&>(*this)) == IterationDecision::Break)
  380. return IterationDecision::Break;
  381. for (auto* child = first_child(); child; child = child->next_sibling()) {
  382. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  383. return IterationDecision::Break;
  384. }
  385. return IterationDecision::Continue;
  386. }
  387. template<typename U, typename Callback>
  388. IterationDecision for_each_in_inclusive_subtree_of_type(Callback callback)
  389. {
  390. if (is<U>(static_cast<Node&>(*this))) {
  391. if (callback(static_cast<U&>(*this)) == IterationDecision::Break)
  392. return IterationDecision::Break;
  393. }
  394. for (auto* child = first_child(); child; child = child->next_sibling()) {
  395. if (child->template for_each_in_inclusive_subtree_of_type<U>(callback) == IterationDecision::Break)
  396. return IterationDecision::Break;
  397. }
  398. return IterationDecision::Continue;
  399. }
  400. template<typename U, typename Callback>
  401. IterationDecision for_each_in_inclusive_subtree_of_type(Callback callback) const
  402. {
  403. if (is<U>(static_cast<Node const&>(*this))) {
  404. if (callback(static_cast<U const&>(*this)) == IterationDecision::Break)
  405. return IterationDecision::Break;
  406. }
  407. for (auto* child = first_child(); child; child = child->next_sibling()) {
  408. if (child->template for_each_in_inclusive_subtree_of_type<U>(callback) == IterationDecision::Break)
  409. return IterationDecision::Break;
  410. }
  411. return IterationDecision::Continue;
  412. }
  413. template<typename Callback>
  414. IterationDecision for_each_in_subtree(Callback callback) const
  415. {
  416. for (auto* child = first_child(); child; child = child->next_sibling()) {
  417. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  418. return IterationDecision::Break;
  419. }
  420. return IterationDecision::Continue;
  421. }
  422. template<typename Callback>
  423. IterationDecision for_each_in_subtree(Callback callback)
  424. {
  425. for (auto* child = first_child(); child; child = child->next_sibling()) {
  426. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  427. return IterationDecision::Break;
  428. }
  429. return IterationDecision::Continue;
  430. }
  431. template<typename U, typename Callback>
  432. IterationDecision for_each_in_subtree_of_type(Callback callback)
  433. {
  434. for (auto* child = first_child(); child; child = child->next_sibling()) {
  435. if (child->template for_each_in_inclusive_subtree_of_type<U>(callback) == IterationDecision::Break)
  436. return IterationDecision::Break;
  437. }
  438. return IterationDecision::Continue;
  439. }
  440. template<typename U, typename Callback>
  441. IterationDecision for_each_in_subtree_of_type(Callback callback) const
  442. {
  443. for (auto* child = first_child(); child; child = child->next_sibling()) {
  444. if (child->template for_each_in_inclusive_subtree_of_type<U>(callback) == IterationDecision::Break)
  445. return IterationDecision::Break;
  446. }
  447. return IterationDecision::Continue;
  448. }
  449. template<typename Callback>
  450. void for_each_child(Callback callback) const
  451. {
  452. return const_cast<Node*>(this)->template for_each_child(move(callback));
  453. }
  454. template<typename Callback>
  455. void for_each_child(Callback callback)
  456. {
  457. for (auto* node = first_child(); node; node = node->next_sibling()) {
  458. if (callback(*node) == IterationDecision::Break)
  459. return;
  460. }
  461. }
  462. template<typename U, typename Callback>
  463. void for_each_child_of_type(Callback callback)
  464. {
  465. for (auto* node = first_child(); node; node = node->next_sibling()) {
  466. if (is<U>(node)) {
  467. if (callback(verify_cast<U>(*node)) == IterationDecision::Break)
  468. return;
  469. }
  470. }
  471. }
  472. template<typename U, typename Callback>
  473. void for_each_child_of_type(Callback callback) const
  474. {
  475. return const_cast<Node*>(this)->template for_each_child_of_type<U>(move(callback));
  476. }
  477. template<typename U>
  478. U const* next_sibling_of_type() const
  479. {
  480. return const_cast<Node*>(this)->template next_sibling_of_type<U>();
  481. }
  482. template<typename U>
  483. inline U* next_sibling_of_type()
  484. {
  485. for (auto* sibling = next_sibling(); sibling; sibling = sibling->next_sibling()) {
  486. if (is<U>(*sibling))
  487. return &verify_cast<U>(*sibling);
  488. }
  489. return nullptr;
  490. }
  491. template<typename U>
  492. U const* previous_sibling_of_type() const
  493. {
  494. return const_cast<Node*>(this)->template previous_sibling_of_type<U>();
  495. }
  496. template<typename U>
  497. U* previous_sibling_of_type()
  498. {
  499. for (auto* sibling = previous_sibling(); sibling; sibling = sibling->previous_sibling()) {
  500. if (is<U>(*sibling))
  501. return &verify_cast<U>(*sibling);
  502. }
  503. return nullptr;
  504. }
  505. template<typename U>
  506. U const* first_child_of_type() const
  507. {
  508. return const_cast<Node*>(this)->template first_child_of_type<U>();
  509. }
  510. template<typename U>
  511. U const* last_child_of_type() const
  512. {
  513. return const_cast<Node*>(this)->template last_child_of_type<U>();
  514. }
  515. template<typename U>
  516. U* first_child_of_type()
  517. {
  518. for (auto* child = first_child(); child; child = child->next_sibling()) {
  519. if (is<U>(*child))
  520. return &verify_cast<U>(*child);
  521. }
  522. return nullptr;
  523. }
  524. template<typename U>
  525. U* last_child_of_type()
  526. {
  527. for (auto* child = last_child(); child; child = child->previous_sibling()) {
  528. if (is<U>(*child))
  529. return &verify_cast<U>(*child);
  530. }
  531. return nullptr;
  532. }
  533. template<typename U>
  534. bool has_child_of_type() const
  535. {
  536. return first_child_of_type<U>() != nullptr;
  537. }
  538. template<typename U>
  539. U const* first_ancestor_of_type() const
  540. {
  541. return const_cast<Node*>(this)->template first_ancestor_of_type<U>();
  542. }
  543. template<typename U>
  544. U* first_ancestor_of_type()
  545. {
  546. for (auto* ancestor = parent(); ancestor; ancestor = ancestor->parent()) {
  547. if (is<U>(*ancestor))
  548. return &verify_cast<U>(*ancestor);
  549. }
  550. return nullptr;
  551. }
  552. template<typename U>
  553. U const* shadow_including_first_ancestor_of_type() const
  554. {
  555. return const_cast<Node*>(this)->template shadow_including_first_ancestor_of_type<U>();
  556. }
  557. template<typename U>
  558. U* shadow_including_first_ancestor_of_type();
  559. bool is_parent_of(Node const& other) const
  560. {
  561. for (auto* child = first_child(); child; child = child->next_sibling()) {
  562. if (&other == child)
  563. return true;
  564. }
  565. return false;
  566. }
  567. ErrorOr<String> accessible_name(Document const&) const;
  568. ErrorOr<String> accessible_description(Document const&) const;
  569. protected:
  570. Node(JS::Realm&, Document&, NodeType);
  571. Node(Document&, NodeType);
  572. virtual void visit_edges(Cell::Visitor&) override;
  573. virtual void finalize() override;
  574. JS::GCPtr<Document> m_document;
  575. JS::GCPtr<Layout::Node> m_layout_node;
  576. JS::GCPtr<Painting::Paintable> m_paintable;
  577. NodeType m_type { NodeType::INVALID };
  578. bool m_needs_style_update { false };
  579. bool m_child_needs_style_update { false };
  580. i32 m_unique_id {};
  581. // https://dom.spec.whatwg.org/#registered-observer-list
  582. // "Nodes have a strong reference to registered observers in their registered observer list." https://dom.spec.whatwg.org/#garbage-collection
  583. OwnPtr<Vector<JS::NonnullGCPtr<RegisteredObserver>>> m_registered_observer_list;
  584. void build_accessibility_tree(AccessibilityTreeNode& parent);
  585. ErrorOr<String> name_or_description(NameOrDescription, Document const&, HashTable<i32>&) const;
  586. private:
  587. void queue_tree_mutation_record(Vector<JS::Handle<Node>> added_nodes, Vector<JS::Handle<Node>> removed_nodes, Node* previous_sibling, Node* next_sibling);
  588. void insert_before_impl(JS::NonnullGCPtr<Node>, JS::GCPtr<Node> child);
  589. void append_child_impl(JS::NonnullGCPtr<Node>);
  590. void remove_child_impl(JS::NonnullGCPtr<Node>);
  591. static Optional<StringView> first_valid_id(StringView, Document const&);
  592. static ErrorOr<void> append_without_space(StringBuilder, StringView const&);
  593. static ErrorOr<void> append_with_space(StringBuilder, StringView const&);
  594. static ErrorOr<void> prepend_without_space(StringBuilder, StringView const&);
  595. static ErrorOr<void> prepend_with_space(StringBuilder, StringView const&);
  596. JS::GCPtr<Node> m_parent;
  597. JS::GCPtr<Node> m_first_child;
  598. JS::GCPtr<Node> m_last_child;
  599. JS::GCPtr<Node> m_next_sibling;
  600. JS::GCPtr<Node> m_previous_sibling;
  601. JS::GCPtr<NodeList> m_child_nodes;
  602. };
  603. }
  604. template<>
  605. inline bool JS::Object::fast_is<Web::DOM::Node>() const { return is_dom_node(); }