Node.h 26 KB

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