/* 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 https://mozilla.org/MPL/2.0/. */ use std::cell::Cell; use std::convert::TryInto; use dom_struct::dom_struct; use html5ever::{LocalName, Prefix, QualName, local_name, namespace_url, ns}; use js::rust::HandleObject; use style::str::{split_html_space_chars, str_join}; use stylo_dom::ElementState; use crate::dom::attr::Attr; use crate::dom::bindings::codegen::Bindings::CharacterDataBinding::CharacterDataMethods; use crate::dom::bindings::codegen::Bindings::HTMLOptionElementBinding::HTMLOptionElementMethods; use crate::dom::bindings::codegen::Bindings::HTMLSelectElementBinding::HTMLSelectElement_Binding::HTMLSelectElementMethods; use crate::dom::bindings::codegen::Bindings::NodeBinding::NodeMethods; use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods; use crate::dom::bindings::error::Fallible; use crate::dom::bindings::inheritance::Castable; use crate::dom::bindings::root::DomRoot; use crate::dom::bindings::str::DOMString; use crate::dom::characterdata::CharacterData; use crate::dom::document::Document; use crate::dom::element::{AttributeMutation, CustomElementCreationMode, Element, ElementCreator}; use crate::dom::htmlelement::HTMLElement; use crate::dom::htmlformelement::HTMLFormElement; use crate::dom::htmloptgroupelement::HTMLOptGroupElement; use crate::dom::htmlscriptelement::HTMLScriptElement; use crate::dom::htmlselectelement::HTMLSelectElement; use crate::dom::node::{BindContext, Node, ShadowIncluding, UnbindContext}; use crate::dom::text::Text; use crate::dom::validation::Validatable; use crate::dom::validitystate::ValidationFlags; use crate::dom::virtualmethods::VirtualMethods; use crate::dom::window::Window; use crate::script_runtime::CanGc; #[dom_struct] pub(crate) struct HTMLOptionElement { htmlelement: HTMLElement, /// selectedness: Cell, /// dirtiness: Cell, } impl HTMLOptionElement { fn new_inherited( local_name: LocalName, prefix: Option, document: &Document, ) -> HTMLOptionElement { HTMLOptionElement { htmlelement: HTMLElement::new_inherited_with_state( ElementState::ENABLED, local_name, prefix, document, ), selectedness: Cell::new(false), dirtiness: Cell::new(false), } } #[cfg_attr(crown, allow(crown::unrooted_must_root))] pub(crate) fn new( local_name: LocalName, prefix: Option, document: &Document, proto: Option, can_gc: CanGc, ) -> DomRoot { Node::reflect_node_with_proto( Box::new(HTMLOptionElement::new_inherited( local_name, prefix, document, )), document, proto, can_gc, ) } pub(crate) fn set_selectedness(&self, selected: bool) { self.selectedness.set(selected); } pub(crate) fn set_dirtiness(&self, dirtiness: bool) { self.dirtiness.set(dirtiness); } fn pick_if_selected_and_reset(&self) { if let Some(select) = self.owner_select_element() { if self.Selected() { select.pick_option(self); } select.ask_for_reset(); } } // https://html.spec.whatwg.org/multipage/#concept-option-index fn index(&self) -> i32 { let Some(owner_select) = self.owner_select_element() else { return 0; }; let Some(position) = owner_select.list_of_options().position(|n| &*n == self) else { // An option should always be in it's owner's list of options, but it's not worth a browser panic warn!("HTMLOptionElement called index_in_select at a select that did not contain it"); return 0; }; position.try_into().unwrap_or(0) } fn owner_select_element(&self) -> Option> { let parent = self.upcast::().GetParentNode()?; if parent.is::() { DomRoot::downcast::(parent.GetParentNode()?) } else { DomRoot::downcast::(parent) } } fn update_select_validity(&self, can_gc: CanGc) { if let Some(select) = self.owner_select_element() { select .validity_state() .perform_validation_and_update(ValidationFlags::all(), can_gc); } } /// /// /// Note that this is not equivalent to . pub(crate) fn displayed_label(&self) -> DOMString { // > The label of an option element is the value of the label content attribute, if there is one // > and its value is not the empty string, or, otherwise, the value of the element's text IDL attribute. let label = self .upcast::() .get_string_attribute(&local_name!("label")); if label.is_empty() { return self.Text(); } label } } // FIXME(ajeffrey): Provide a way of buffering DOMStrings other than using Strings fn collect_text(element: &Element, value: &mut String) { let svg_script = *element.namespace() == ns!(svg) && element.local_name() == &local_name!("script"); let html_script = element.is::(); if svg_script || html_script { return; } for child in element.upcast::().children() { if child.is::() { let characterdata = child.downcast::().unwrap(); value.push_str(&characterdata.Data()); } else if let Some(element_child) = child.downcast() { collect_text(element_child, value); } } } impl HTMLOptionElementMethods for HTMLOptionElement { /// fn Option( window: &Window, proto: Option, can_gc: CanGc, text: DOMString, value: Option, default_selected: bool, selected: bool, ) -> Fallible> { let element = Element::create( QualName::new(None, ns!(html), local_name!("option")), None, &window.Document(), ElementCreator::ScriptCreated, CustomElementCreationMode::Synchronous, proto, can_gc, ); let option = DomRoot::downcast::(element).unwrap(); if !text.is_empty() { option.upcast::().SetTextContent(Some(text), can_gc) } if let Some(val) = value { option.SetValue(val) } option.SetDefaultSelected(default_selected); option.set_selectedness(selected); option.update_select_validity(can_gc); Ok(option) } // https://html.spec.whatwg.org/multipage/#dom-option-disabled make_bool_getter!(Disabled, "disabled"); // https://html.spec.whatwg.org/multipage/#dom-option-disabled make_bool_setter!(SetDisabled, "disabled"); /// fn Text(&self) -> DOMString { let mut content = String::new(); collect_text(self.upcast(), &mut content); DOMString::from(str_join(split_html_space_chars(&content), " ")) } /// fn SetText(&self, value: DOMString, can_gc: CanGc) { self.upcast::().SetTextContent(Some(value), can_gc) } /// fn GetForm(&self) -> Option> { let parent = self.upcast::().GetParentNode().and_then(|p| { if p.is::() { p.upcast::().GetParentNode() } else { Some(p) } }); parent.and_then(|p| p.downcast::().and_then(|s| s.GetForm())) } /// fn Value(&self) -> DOMString { let element = self.upcast::(); let attr = &local_name!("value"); if element.has_attribute(attr) { element.get_string_attribute(attr) } else { self.Text() } } // https://html.spec.whatwg.org/multipage/#attr-option-value make_setter!(SetValue, "value"); /// fn Label(&self) -> DOMString { let element = self.upcast::(); let attr = &local_name!("label"); if element.has_attribute(attr) { element.get_string_attribute(attr) } else { self.Text() } } // https://html.spec.whatwg.org/multipage/#attr-option-label make_setter!(SetLabel, "label"); // https://html.spec.whatwg.org/multipage/#dom-option-defaultselected make_bool_getter!(DefaultSelected, "selected"); // https://html.spec.whatwg.org/multipage/#dom-option-defaultselected make_bool_setter!(SetDefaultSelected, "selected"); /// fn Selected(&self) -> bool { self.selectedness.get() } /// fn SetSelected(&self, selected: bool) { self.dirtiness.set(true); self.selectedness.set(selected); self.pick_if_selected_and_reset(); self.update_select_validity(CanGc::note()); } /// fn Index(&self) -> i32 { self.index() } } impl VirtualMethods for HTMLOptionElement { fn super_type(&self) -> Option<&dyn VirtualMethods> { Some(self.upcast::() as &dyn VirtualMethods) } fn attribute_mutated(&self, attr: &Attr, mutation: AttributeMutation, can_gc: CanGc) { self.super_type() .unwrap() .attribute_mutated(attr, mutation, can_gc); match *attr.local_name() { local_name!("disabled") => { let el = self.upcast::(); match mutation { AttributeMutation::Set(_) => { el.set_disabled_state(true); el.set_enabled_state(false); }, AttributeMutation::Removed => { el.set_disabled_state(false); el.set_enabled_state(true); el.check_parent_disabled_state_for_option(); }, } self.update_select_validity(can_gc); }, local_name!("selected") => { match mutation { AttributeMutation::Set(_) => { // https://html.spec.whatwg.org/multipage/#concept-option-selectedness if !self.dirtiness.get() { self.selectedness.set(true); } }, AttributeMutation::Removed => { // https://html.spec.whatwg.org/multipage/#concept-option-selectedness if !self.dirtiness.get() { self.selectedness.set(false); } }, } self.update_select_validity(can_gc); }, local_name!("label") => { // The label of the selected option is displayed inside the select element, so we need to repaint // when it changes if let Some(select_element) = self.owner_select_element() { select_element.update_shadow_tree(CanGc::note()); } }, _ => {}, } } fn bind_to_tree(&self, context: &BindContext, can_gc: CanGc) { if let Some(s) = self.super_type() { s.bind_to_tree(context, can_gc); } self.upcast::() .check_parent_disabled_state_for_option(); self.pick_if_selected_and_reset(); self.update_select_validity(can_gc); } fn unbind_from_tree(&self, context: &UnbindContext, can_gc: CanGc) { self.super_type().unwrap().unbind_from_tree(context, can_gc); if let Some(select) = context .parent .inclusive_ancestors(ShadowIncluding::No) .filter_map(DomRoot::downcast::) .next() { select .validity_state() .perform_validation_and_update(ValidationFlags::all(), can_gc); select.ask_for_reset(); } let node = self.upcast::(); let el = self.upcast::(); if node.GetParentNode().is_some() { el.check_parent_disabled_state_for_option(); } else { el.check_disabled_attribute(); } } }