/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ use crate::dom::activation::{ActivationSource, synthetic_click_activation}; use crate::dom::attr::Attr; use crate::dom::bindings::codegen::Bindings::ElementBinding::ElementMethods; use crate::dom::bindings::codegen::Bindings::EventHandlerBinding::EventHandlerNonNull; use crate::dom::bindings::codegen::Bindings::HTMLElementBinding; use crate::dom::bindings::codegen::Bindings::HTMLElementBinding::HTMLElementMethods; use crate::dom::bindings::codegen::Bindings::NodeBinding::NodeBinding::NodeMethods; use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods; use crate::dom::bindings::error::{Error, ErrorResult}; use crate::dom::bindings::inheritance::{ElementTypeId, HTMLElementTypeId, NodeTypeId}; use crate::dom::bindings::inheritance::Castable; use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom, RootedReference}; use crate::dom::bindings::str::DOMString; use crate::dom::cssstyledeclaration::{CSSModificationAccess, CSSStyleDeclaration, CSSStyleOwner}; use crate::dom::document::{Document, FocusType}; use crate::dom::documentfragment::DocumentFragment; use crate::dom::domstringmap::DOMStringMap; use crate::dom::element::{AttributeMutation, Element}; use crate::dom::eventtarget::EventTarget; use crate::dom::htmlbodyelement::HTMLBodyElement; use crate::dom::htmlbrelement::HTMLBRElement; use crate::dom::htmlframesetelement::HTMLFrameSetElement; use crate::dom::htmlhtmlelement::HTMLHtmlElement; use crate::dom::htmlinputelement::{HTMLInputElement, InputType}; use crate::dom::htmllabelelement::HTMLLabelElement; use crate::dom::node::{Node, NodeFlags}; use crate::dom::node::{document_from_node, window_from_node}; use crate::dom::nodelist::NodeList; use crate::dom::text::Text; use crate::dom::virtualmethods::VirtualMethods; use dom_struct::dom_struct; use html5ever::{LocalName, Prefix}; use script_layout_interface::message::QueryMsg; use std::collections::HashSet; use std::default::Default; use std::rc::Rc; use style::attr::AttrValue; use style::element_state::*; #[dom_struct] pub struct HTMLElement { element: Element, style_decl: MutNullableDom, dataset: MutNullableDom, } impl HTMLElement { pub fn new_inherited( tag_name: LocalName, prefix: Option, document: &Document, ) -> HTMLElement { HTMLElement::new_inherited_with_state(ElementState::empty(), tag_name, prefix, document) } pub fn new_inherited_with_state( state: ElementState, tag_name: LocalName, prefix: Option, document: &Document, ) -> HTMLElement { HTMLElement { element: Element::new_inherited_with_state( state, tag_name, ns!(html), prefix, document, ), style_decl: Default::default(), dataset: Default::default(), } } #[allow(unrooted_must_root)] pub fn new( local_name: LocalName, prefix: Option, document: &Document, ) -> DomRoot { Node::reflect_node( Box::new(HTMLElement::new_inherited(local_name, prefix, document)), document, HTMLElementBinding::Wrap, ) } fn is_body_or_frameset(&self) -> bool { let eventtarget = self.upcast::(); eventtarget.is::() || eventtarget.is::() } fn update_sequentially_focusable_status(&self) { let element = self.upcast::(); let node = self.upcast::(); if element.has_attribute(&local_name!("tabindex")) { node.set_flag(NodeFlags::SEQUENTIALLY_FOCUSABLE, true); } else { match node.type_id() { NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLButtonElement, )) | NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLSelectElement, )) | NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLIFrameElement, )) | NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLTextAreaElement, )) => node.set_flag(NodeFlags::SEQUENTIALLY_FOCUSABLE, true), NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLLinkElement, )) | NodeTypeId::Element(ElementTypeId::HTMLElement( HTMLElementTypeId::HTMLAnchorElement, )) => { if element.has_attribute(&local_name!("href")) { node.set_flag(NodeFlags::SEQUENTIALLY_FOCUSABLE, true); } }, _ => { if let Some(attr) = element.get_attribute(&ns!(), &local_name!("draggable")) { let value = attr.value(); let is_true = match *value { AttrValue::String(ref string) => string == "true", _ => false, }; node.set_flag(NodeFlags::SEQUENTIALLY_FOCUSABLE, is_true); } else { node.set_flag(NodeFlags::SEQUENTIALLY_FOCUSABLE, false); } //TODO set SEQUENTIALLY_FOCUSABLE flag if editing host //TODO set SEQUENTIALLY_FOCUSABLE flag if "sorting interface th elements" }, } } } } impl HTMLElementMethods for HTMLElement { // https://html.spec.whatwg.org/multipage/#the-style-attribute fn Style(&self) -> DomRoot { self.style_decl.or_init(|| { let global = window_from_node(self); CSSStyleDeclaration::new( &global, CSSStyleOwner::Element(Dom::from_ref(self.upcast())), None, CSSModificationAccess::ReadWrite, ) }) } // https://html.spec.whatwg.org/multipage/#attr-title make_getter!(Title, "title"); // https://html.spec.whatwg.org/multipage/#attr-title make_setter!(SetTitle, "title"); // https://html.spec.whatwg.org/multipage/#attr-lang make_getter!(Lang, "lang"); // https://html.spec.whatwg.org/multipage/#attr-lang make_setter!(SetLang, "lang"); // https://html.spec.whatwg.org/multipage/#dom-hidden make_bool_getter!(Hidden, "hidden"); // https://html.spec.whatwg.org/multipage/#dom-hidden make_bool_setter!(SetHidden, "hidden"); // https://html.spec.whatwg.org/multipage/#globaleventhandlers global_event_handlers!(NoOnload); // https://html.spec.whatwg.org/multipage/#documentandelementeventhandlers document_and_element_event_handlers!(); // https://html.spec.whatwg.org/multipage/#dom-dataset fn Dataset(&self) -> DomRoot { self.dataset.or_init(|| DOMStringMap::new(self)) } // https://html.spec.whatwg.org/multipage/#handler-onload fn GetOnload(&self) -> Option> { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().GetOnload() } else { None } } else { self.upcast::() .get_event_handler_common("load") } } // https://html.spec.whatwg.org/multipage/#handler-onload fn SetOnload(&self, listener: Option>) { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().SetOnload(listener) } } else { self.upcast::() .set_event_handler_common("load", listener) } } // https://html.spec.whatwg.org/multipage/#handler-onresize fn GetOnresize(&self) -> Option> { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().GetOnload() } else { None } } else { self.upcast::() .get_event_handler_common("resize") } } // https://html.spec.whatwg.org/multipage/#handler-onresize fn SetOnresize(&self, listener: Option>) { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().SetOnresize(listener); } } else { self.upcast::() .set_event_handler_common("resize", listener) } } // https://html.spec.whatwg.org/multipage/#handler-onblur fn GetOnblur(&self) -> Option> { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().GetOnblur() } else { None } } else { self.upcast::() .get_event_handler_common("blur") } } // https://html.spec.whatwg.org/multipage/#handler-onblur fn SetOnblur(&self, listener: Option>) { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().SetOnblur(listener) } } else { self.upcast::() .set_event_handler_common("blur", listener) } } // https://html.spec.whatwg.org/multipage/#handler-onfocus fn GetOnfocus(&self) -> Option> { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().GetOnfocus() } else { None } } else { self.upcast::() .get_event_handler_common("focus") } } // https://html.spec.whatwg.org/multipage/#handler-onfocus fn SetOnfocus(&self, listener: Option>) { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().SetOnfocus(listener) } } else { self.upcast::() .set_event_handler_common("focus", listener) } } // https://html.spec.whatwg.org/multipage/#handler-onscroll fn GetOnscroll(&self) -> Option> { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().GetOnscroll() } else { None } } else { self.upcast::() .get_event_handler_common("scroll") } } // https://html.spec.whatwg.org/multipage/#handler-onscroll fn SetOnscroll(&self, listener: Option>) { if self.is_body_or_frameset() { let document = document_from_node(self); if document.has_browsing_context() { document.window().SetOnscroll(listener) } } else { self.upcast::() .set_event_handler_common("scroll", listener) } } // https://html.spec.whatwg.org/multipage/#attr-itemtype fn Itemtypes(&self) -> Option> { let atoms = self .element .get_tokenlist_attribute(&local_name!("itemtype")); if atoms.is_empty() { return None; } let mut item_attr_values = HashSet::new(); for attr_value in &atoms { item_attr_values.insert(DOMString::from(String::from(attr_value.trim()))); } Some(item_attr_values.into_iter().collect()) } // https://html.spec.whatwg.org/multipage/#names:-the-itemprop-attribute fn PropertyNames(&self) -> Option> { let atoms = self .element .get_tokenlist_attribute(&local_name!("itemprop")); if atoms.is_empty() { return None; } let mut item_attr_values = HashSet::new(); for attr_value in &atoms { item_attr_values.insert(DOMString::from(String::from(attr_value.trim()))); } Some(item_attr_values.into_iter().collect()) } // https://html.spec.whatwg.org/multipage/#dom-click fn Click(&self) { if !self.upcast::().disabled_state() { synthetic_click_activation( self.upcast::(), false, false, false, false, ActivationSource::FromClick, ) } } // https://html.spec.whatwg.org/multipage/#dom-focus fn Focus(&self) { // TODO: Mark the element as locked for focus and run the focusing steps. // https://html.spec.whatwg.org/multipage/#focusing-steps let document = document_from_node(self); document.begin_focus_transaction(); document.request_focus(self.upcast()); document.commit_focus_transaction(FocusType::Element); } // https://html.spec.whatwg.org/multipage/#dom-blur fn Blur(&self) { // TODO: Run the unfocusing steps. if !self.upcast::().focus_state() { return; } // https://html.spec.whatwg.org/multipage/#unfocusing-steps let document = document_from_node(self); document.begin_focus_transaction(); // If `request_focus` is not called, focus will be set to None. document.commit_focus_transaction(FocusType::Element); } // https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsetparent fn GetOffsetParent(&self) -> Option> { if self.is::() || self.is::() { return None; } let node = self.upcast::(); let window = window_from_node(self); let (element, _) = window.offset_parent_query(node.to_trusted_node_address()); element } // https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsettop fn OffsetTop(&self) -> i32 { if self.is::() { return 0; } let node = self.upcast::(); let window = window_from_node(self); let (_, rect) = window.offset_parent_query(node.to_trusted_node_address()); rect.origin.y.to_nearest_px() } // https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsetleft fn OffsetLeft(&self) -> i32 { if self.is::() { return 0; } let node = self.upcast::(); let window = window_from_node(self); let (_, rect) = window.offset_parent_query(node.to_trusted_node_address()); rect.origin.x.to_nearest_px() } // https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsetwidth fn OffsetWidth(&self) -> i32 { let node = self.upcast::(); let window = window_from_node(self); let (_, rect) = window.offset_parent_query(node.to_trusted_node_address()); rect.size.width.to_nearest_px() } // https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsetheight fn OffsetHeight(&self) -> i32 { let node = self.upcast::(); let window = window_from_node(self); let (_, rect) = window.offset_parent_query(node.to_trusted_node_address()); rect.size.height.to_nearest_px() } // https://html.spec.whatwg.org/multipage/#the-innertext-idl-attribute fn InnerText(&self) -> DOMString { let node = self.upcast::(); let window = window_from_node(node); let element = self.upcast::(); // Step 1. let element_not_rendered = !node.is_in_doc() || !element.has_css_layout_box(); if element_not_rendered { return node.GetTextContent().unwrap(); } window.layout_reflow(QueryMsg::ElementInnerTextQuery( node.to_trusted_node_address(), )); DOMString::from(window.layout().element_inner_text()) } // https://html.spec.whatwg.org/multipage/#the-innertext-idl-attribute fn SetInnerText(&self, input: DOMString) { // Step 1. let document = document_from_node(self); // Step 2. let fragment = DocumentFragment::new(&document); // Step 3. The given value is already named 'input'. // Step 4. let mut position = input.chars().peekable(); // Step 5. let mut text = String::new(); // Step 6. while let Some(ch) = position.next() { match ch { '\u{000A}' | '\u{000D}' => { if ch == '\u{000D}' && position.peek() == Some(&'\u{000A}') { // a \r\n pair should only generate one
, // so just skip the \r. position.next(); } if !text.is_empty() { append_text_node_to_fragment(&document, &fragment, text); text = String::new(); } let br = HTMLBRElement::new(local_name!("br"), None, &document); fragment.upcast::().AppendChild(&br.upcast()).unwrap(); }, _ => { text.push(ch); }, } } if !text.is_empty() { append_text_node_to_fragment(&document, &fragment, text); } // Step 7. Node::replace_all(Some(fragment.upcast()), self.upcast::()); } } fn append_text_node_to_fragment(document: &Document, fragment: &DocumentFragment, text: String) { let text = Text::new(DOMString::from(text), document); fragment .upcast::() .AppendChild(&text.upcast()) .unwrap(); } // https://html.spec.whatwg.org/multipage/#attr-data-* static DATA_PREFIX: &str = "data-"; static DATA_HYPHEN_SEPARATOR: char = '\x2d'; fn is_ascii_uppercase(c: char) -> bool { 'A' <= c && c <= 'Z' } fn is_ascii_lowercase(c: char) -> bool { 'a' <= c && c <= 'w' } fn to_snake_case(name: DOMString) -> DOMString { let mut attr_name = String::with_capacity(name.len() + DATA_PREFIX.len()); attr_name.push_str(DATA_PREFIX); for ch in name.chars() { if is_ascii_uppercase(ch) { attr_name.push(DATA_HYPHEN_SEPARATOR); attr_name.push(ch.to_ascii_lowercase()); } else { attr_name.push(ch); } } DOMString::from(attr_name) } // https://html.spec.whatwg.org/multipage/#attr-data-* // if this attribute is in snake case with a data- prefix, // this function returns a name converted to camel case // without the data prefix. fn to_camel_case(name: &str) -> Option { if !name.starts_with(DATA_PREFIX) { return None; } let name = &name[5..]; let has_uppercase = name.chars().any(|curr_char| is_ascii_uppercase(curr_char)); if has_uppercase { return None; } let mut result = String::with_capacity(name.len().saturating_sub(DATA_PREFIX.len())); let mut name_chars = name.chars(); while let Some(curr_char) = name_chars.next() { //check for hyphen followed by character if curr_char == DATA_HYPHEN_SEPARATOR { if let Some(next_char) = name_chars.next() { if is_ascii_lowercase(next_char) { result.push(next_char.to_ascii_uppercase()); } else { result.push(curr_char); result.push(next_char); } } else { result.push(curr_char); } } else { result.push(curr_char); } } Some(DOMString::from(result)) } impl HTMLElement { pub fn set_custom_attr(&self, name: DOMString, value: DOMString) -> ErrorResult { if name .chars() .skip_while(|&ch| ch != '\u{2d}') .nth(1) .map_or(false, |ch| ch >= 'a' && ch <= 'z') { return Err(Error::Syntax); } self.upcast::() .set_custom_attribute(to_snake_case(name), value) } pub fn get_custom_attr(&self, local_name: DOMString) -> Option { // FIXME(ajeffrey): Convert directly from DOMString to LocalName let local_name = LocalName::from(to_snake_case(local_name)); self.upcast::() .get_attribute(&ns!(), &local_name) .map(|attr| { DOMString::from(&**attr.value()) // FIXME(ajeffrey): Convert directly from AttrValue to DOMString }) } pub fn delete_custom_attr(&self, local_name: DOMString) { // FIXME(ajeffrey): Convert directly from DOMString to LocalName let local_name = LocalName::from(to_snake_case(local_name)); self.upcast::() .remove_attribute(&ns!(), &local_name); } // https://html.spec.whatwg.org/multipage/#category-label pub fn is_labelable_element(&self) -> bool { // Note: HTMLKeygenElement is omitted because Servo doesn't currently implement it match self.upcast::().type_id() { NodeTypeId::Element(ElementTypeId::HTMLElement(type_id)) => match type_id { HTMLElementTypeId::HTMLInputElement => { self.downcast::().unwrap().input_type() != InputType::Hidden }, HTMLElementTypeId::HTMLButtonElement | HTMLElementTypeId::HTMLMeterElement | HTMLElementTypeId::HTMLOutputElement | HTMLElementTypeId::HTMLProgressElement | HTMLElementTypeId::HTMLSelectElement | HTMLElementTypeId::HTMLTextAreaElement => true, _ => false, }, _ => false, } } // https://html.spec.whatwg.org/multipage/#category-listed pub fn is_listed_element(&self) -> bool { // Servo does not implement HTMLKeygenElement // https://github.com/servo/servo/issues/2782 if self.upcast::().local_name() == &local_name!("keygen") { return true; } match self.upcast::().type_id() { NodeTypeId::Element(ElementTypeId::HTMLElement(type_id)) => match type_id { HTMLElementTypeId::HTMLButtonElement | HTMLElementTypeId::HTMLFieldSetElement | HTMLElementTypeId::HTMLInputElement | HTMLElementTypeId::HTMLObjectElement | HTMLElementTypeId::HTMLOutputElement | HTMLElementTypeId::HTMLSelectElement | HTMLElementTypeId::HTMLTextAreaElement => true, _ => false, }, _ => false, } } pub fn supported_prop_names_custom_attr(&self) -> Vec { let element = self.upcast::(); element .attrs() .iter() .filter_map(|attr| { let raw_name = attr.local_name(); to_camel_case(&raw_name) }).collect() } // https://html.spec.whatwg.org/multipage/#dom-lfe-labels pub fn labels(&self) -> DomRoot { debug_assert!(self.is_labelable_element()); let element = self.upcast::(); let window = window_from_node(element); // Traverse ancestors for implicitly associated