script/dom/form/
validitystate.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::Cell;
6use std::fmt;
7
8use bitflags::bitflags;
9use dom_struct::dom_struct;
10use itertools::Itertools;
11use js::context::JSContext;
12use script_bindings::cell::{DomRefCell, Ref};
13use script_bindings::dom::UnrootedDom;
14use script_bindings::domstring::TracedDOMString;
15use script_bindings::reflector::{Reflector, reflect_dom_object};
16use stylo_dom::ElementState;
17
18use crate::dom::bindings::codegen::Bindings::ElementInternalsBinding::ValidityStateFlags;
19use crate::dom::bindings::codegen::Bindings::ValidityStateBinding::ValidityStateMethods;
20use crate::dom::bindings::inheritance::Castable;
21use crate::dom::bindings::root::{Dom, DomRoot};
22use crate::dom::bindings::str::DOMString;
23use crate::dom::element::Element;
24use crate::dom::html::htmlfieldsetelement::HTMLFieldSetElement;
25use crate::dom::html::htmlformelement::FormControlElementHelpers;
26use crate::dom::node::Node;
27use crate::dom::window::Window;
28
29/// <https://html.spec.whatwg.org/multipage/#validity-states>
30#[derive(Clone, Copy, JSTraceable, MallocSizeOf)]
31pub(crate) struct ValidationFlags(u32);
32
33bitflags! {
34    impl ValidationFlags: u32 {
35        const VALUE_MISSING    = 0b0000000001;
36        const TYPE_MISMATCH    = 0b0000000010;
37        const PATTERN_MISMATCH = 0b0000000100;
38        const TOO_LONG         = 0b0000001000;
39        const TOO_SHORT        = 0b0000010000;
40        const RANGE_UNDERFLOW  = 0b0000100000;
41        const RANGE_OVERFLOW   = 0b0001000000;
42        const STEP_MISMATCH    = 0b0010000000;
43        const BAD_INPUT        = 0b0100000000;
44        const CUSTOM_ERROR     = 0b1000000000;
45    }
46}
47
48impl fmt::Display for ValidationFlags {
49    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
50        let flag_to_message = [
51            (ValidationFlags::VALUE_MISSING, "Value missing"),
52            (ValidationFlags::TYPE_MISMATCH, "Type mismatch"),
53            (ValidationFlags::PATTERN_MISMATCH, "Pattern mismatch"),
54            (ValidationFlags::TOO_LONG, "Too long"),
55            (ValidationFlags::TOO_SHORT, "Too short"),
56            (ValidationFlags::RANGE_UNDERFLOW, "Range underflow"),
57            (ValidationFlags::RANGE_OVERFLOW, "Range overflow"),
58            (ValidationFlags::STEP_MISMATCH, "Step mismatch"),
59            (ValidationFlags::BAD_INPUT, "Bad input"),
60            (ValidationFlags::CUSTOM_ERROR, "Custom error"),
61        ];
62
63        flag_to_message
64            .iter()
65            .filter_map(|&(flag, flag_str)| {
66                if self.contains(flag) {
67                    Some(flag_str)
68                } else {
69                    None
70                }
71            })
72            .format(", ")
73            .fmt(formatter)
74    }
75}
76
77/// <https://html.spec.whatwg.org/multipage/#validitystate>
78#[dom_struct]
79pub(crate) struct ValidityState {
80    reflector_: Reflector,
81    element: Dom<Element>,
82    custom_error_message: DomRefCell<TracedDOMString>,
83    invalid_flags: Cell<ValidationFlags>,
84}
85
86impl ValidityState {
87    fn new_inherited(element: &Element) -> ValidityState {
88        ValidityState {
89            reflector_: Reflector::new(),
90            element: Dom::from_ref(element),
91            custom_error_message: DomRefCell::new(DOMString::new().traced()),
92            invalid_flags: Cell::new(ValidationFlags::empty()),
93        }
94    }
95
96    pub(crate) fn new(
97        cx: &mut JSContext,
98        window: &Window,
99        element: &Element,
100    ) -> DomRoot<ValidityState> {
101        reflect_dom_object(cx, Box::new(ValidityState::new_inherited(element)), window)
102    }
103
104    /// <https://html.spec.whatwg.org/multipage/#custom-validity-error-message>
105    pub(crate) fn custom_error_message(&self) -> Ref<'_, TracedDOMString> {
106        self.custom_error_message.borrow()
107    }
108
109    /// <https://html.spec.whatwg.org/multipage/#custom-validity-error-message>
110    pub(crate) fn set_custom_error_message(&self, cx: &mut JSContext, error: DOMString) {
111        *self.custom_error_message.safe_borrow_mut(cx.no_gc()) = error.traced();
112        self.perform_validation_and_update(cx, ValidationFlags::CUSTOM_ERROR);
113    }
114
115    /// Given a set of [ValidationFlags], recalculate their value by performing
116    /// validation on this [ValidityState]'s associated element. Additionally,
117    /// if [ValidationFlags::CUSTOM_ERROR] is in `update_flags` and a custom
118    /// error has been set on this [ValidityState], the state will be updated
119    /// to reflect the existance of a custom error.
120    pub(crate) fn perform_validation_and_update(
121        &self,
122        cx: &mut JSContext,
123        update_flags: ValidationFlags,
124    ) {
125        let mut invalid_flags = self.invalid_flags.get();
126        invalid_flags.remove(update_flags);
127
128        if let Some(validatable) = self.element.as_maybe_validatable() {
129            let new_flags = validatable.perform_validation(cx, update_flags);
130            invalid_flags.insert(new_flags);
131        }
132
133        // https://html.spec.whatwg.org/multipage/#suffering-from-a-custom-error
134        if update_flags.contains(ValidationFlags::CUSTOM_ERROR) &&
135            !self.custom_error_message().is_empty()
136        {
137            invalid_flags.insert(ValidationFlags::CUSTOM_ERROR);
138        }
139
140        self.invalid_flags.set(invalid_flags);
141        self.update_pseudo_classes(cx);
142    }
143
144    pub(crate) fn update_invalid_flags(&self, update_flags: ValidationFlags) {
145        self.invalid_flags.set(update_flags);
146    }
147
148    pub(crate) fn invalid_flags(&self) -> ValidationFlags {
149        self.invalid_flags.get()
150    }
151
152    pub(crate) fn update_pseudo_classes(&self, cx: &mut JSContext) {
153        if self.element.is_instance_validatable(cx.no_gc()) {
154            let is_valid = self.invalid_flags.get().is_empty();
155            self.element
156                .set_state(cx.no_gc(), ElementState::VALID, is_valid);
157            self.element
158                .set_state(cx.no_gc(), ElementState::INVALID, !is_valid);
159        } else {
160            self.element
161                .set_state(cx.no_gc(), ElementState::VALID, false);
162            self.element
163                .set_state(cx.no_gc(), ElementState::INVALID, false);
164        }
165
166        if let Some(form_control) = self.element.as_maybe_form_control() &&
167            let Some(form_owner) = form_control.form_owner()
168        {
169            form_owner.update_validity(cx);
170        }
171
172        if let Some(fieldset) = self
173            .element
174            .upcast::<Node>()
175            .ancestors_unrooted(cx.no_gc())
176            .find_map(UnrootedDom::downcast::<HTMLFieldSetElement>)
177            .map(|node| node.as_rooted())
178        {
179            fieldset.update_validity(cx);
180        }
181    }
182}
183
184impl ValidityStateMethods<crate::DomTypeHolder> for ValidityState {
185    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-valuemissing>
186    fn ValueMissing(&self) -> bool {
187        self.invalid_flags()
188            .contains(ValidationFlags::VALUE_MISSING)
189    }
190
191    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-typemismatch>
192    fn TypeMismatch(&self) -> bool {
193        self.invalid_flags()
194            .contains(ValidationFlags::TYPE_MISMATCH)
195    }
196
197    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-patternmismatch>
198    fn PatternMismatch(&self) -> bool {
199        self.invalid_flags()
200            .contains(ValidationFlags::PATTERN_MISMATCH)
201    }
202
203    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-toolong>
204    fn TooLong(&self) -> bool {
205        self.invalid_flags().contains(ValidationFlags::TOO_LONG)
206    }
207
208    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-tooshort>
209    fn TooShort(&self) -> bool {
210        self.invalid_flags().contains(ValidationFlags::TOO_SHORT)
211    }
212
213    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-rangeunderflow>
214    fn RangeUnderflow(&self) -> bool {
215        self.invalid_flags()
216            .contains(ValidationFlags::RANGE_UNDERFLOW)
217    }
218
219    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-rangeoverflow>
220    fn RangeOverflow(&self) -> bool {
221        self.invalid_flags()
222            .contains(ValidationFlags::RANGE_OVERFLOW)
223    }
224
225    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-stepmismatch>
226    fn StepMismatch(&self) -> bool {
227        self.invalid_flags()
228            .contains(ValidationFlags::STEP_MISMATCH)
229    }
230
231    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-badinput>
232    fn BadInput(&self) -> bool {
233        self.invalid_flags().contains(ValidationFlags::BAD_INPUT)
234    }
235
236    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-customerror>
237    fn CustomError(&self) -> bool {
238        self.invalid_flags().contains(ValidationFlags::CUSTOM_ERROR)
239    }
240
241    /// <https://html.spec.whatwg.org/multipage/#dom-validitystate-valid>
242    fn Valid(&self) -> bool {
243        self.invalid_flags().is_empty()
244    }
245}
246
247impl From<&ValidityStateFlags> for ValidationFlags {
248    fn from(flags: &ValidityStateFlags) -> Self {
249        let mut bits = ValidationFlags::empty();
250        if flags.valueMissing {
251            bits |= ValidationFlags::VALUE_MISSING;
252        }
253        if flags.typeMismatch {
254            bits |= ValidationFlags::TYPE_MISMATCH;
255        }
256        if flags.patternMismatch {
257            bits |= ValidationFlags::PATTERN_MISMATCH;
258        }
259        if flags.tooLong {
260            bits |= ValidationFlags::TOO_LONG;
261        }
262        if flags.tooShort {
263            bits |= ValidationFlags::TOO_SHORT;
264        }
265        if flags.rangeUnderflow {
266            bits |= ValidationFlags::RANGE_UNDERFLOW;
267        }
268        if flags.rangeOverflow {
269            bits |= ValidationFlags::RANGE_OVERFLOW;
270        }
271        if flags.stepMismatch {
272            bits |= ValidationFlags::STEP_MISMATCH;
273        }
274        if flags.badInput {
275            bits |= ValidationFlags::BAD_INPUT;
276        }
277        if flags.customError {
278            bits |= ValidationFlags::CUSTOM_ERROR;
279        }
280        bits
281    }
282}
script/dom/form/validitystate.rs

script/dom/form/
validitystate.rs
